ZOHOCRMSDK2_0_docgo 6.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/src/ZOHOCRMSDK2_0_docgo.rb +370 -0
- data/src/com/zoho/api/authenticator/oauth_token.rb +285 -0
- data/src/com/zoho/api/authenticator/store/db_store.rb +194 -0
- data/src/com/zoho/api/authenticator/store/file_store.rb +238 -0
- data/src/com/zoho/api/authenticator/store/token_store.rb +35 -0
- data/src/com/zoho/api/authenticator/token.rb +12 -0
- data/src/com/zoho/api/logger/sdk_logger.rb +64 -0
- data/src/com/zoho/crm/api/attachments/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/attachments/action_response.rb +12 -0
- data/src/com/zoho/crm/api/attachments/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/attachments/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/attachments/attachment.rb +369 -0
- data/src/com/zoho/crm/api/attachments/attachments_operations.rb +198 -0
- data/src/com/zoho/crm/api/attachments/file_body_wrapper.rb +66 -0
- data/src/com/zoho/crm/api/attachments/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/attachments/response_wrapper.rb +85 -0
- data/src/com/zoho/crm/api/attachments/success_response.rb +123 -0
- data/src/com/zoho/crm/api/blue_print/action_response.rb +12 -0
- data/src/com/zoho/crm/api/blue_print/api_exception.rb +125 -0
- data/src/com/zoho/crm/api/blue_print/blue_print.rb +121 -0
- data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +69 -0
- data/src/com/zoho/crm/api/blue_print/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/blue_print/next_transition.rb +82 -0
- data/src/com/zoho/crm/api/blue_print/process_info.rb +253 -0
- data/src/com/zoho/crm/api/blue_print/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/blue_print/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/blue_print/success_response.rb +123 -0
- data/src/com/zoho/crm/api/blue_print/transition.rb +255 -0
- data/src/com/zoho/crm/api/blue_print/validation_error.rb +82 -0
- data/src/com/zoho/crm/api/bulk_read/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/bulk_read/action_response.rb +12 -0
- data/src/com/zoho/crm/api/bulk_read/action_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/bulk_read/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +76 -0
- data/src/com/zoho/crm/api/bulk_read/call_back.rb +83 -0
- data/src/com/zoho/crm/api/bulk_read/criteria.rb +137 -0
- data/src/com/zoho/crm/api/bulk_read/file_body_wrapper.rb +66 -0
- data/src/com/zoho/crm/api/bulk_read/job_detail.rb +198 -0
- data/src/com/zoho/crm/api/bulk_read/query.rb +139 -0
- data/src/com/zoho/crm/api/bulk_read/request_wrapper.rb +102 -0
- data/src/com/zoho/crm/api/bulk_read/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/bulk_read/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/bulk_read/result.rb +139 -0
- data/src/com/zoho/crm/api/bulk_read/success_response.rb +123 -0
- data/src/com/zoho/crm/api/bulk_write/action_response.rb +12 -0
- data/src/com/zoho/crm/api/bulk_write/api_exception.rb +241 -0
- data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +114 -0
- data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb +218 -0
- data/src/com/zoho/crm/api/bulk_write/call_back.rb +83 -0
- data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +158 -0
- data/src/com/zoho/crm/api/bulk_write/file.rb +159 -0
- data/src/com/zoho/crm/api/bulk_write/file_body_wrapper.rb +66 -0
- data/src/com/zoho/crm/api/bulk_write/request_wrapper.rb +121 -0
- data/src/com/zoho/crm/api/bulk_write/resource.rb +197 -0
- data/src/com/zoho/crm/api/bulk_write/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/bulk_write/response_wrapper.rb +12 -0
- data/src/com/zoho/crm/api/bulk_write/result.rb +63 -0
- data/src/com/zoho/crm/api/bulk_write/success_response.rb +123 -0
- data/src/com/zoho/crm/api/contact_roles/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/contact_roles/action_response.rb +12 -0
- data/src/com/zoho/crm/api/contact_roles/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/contact_roles/api_exception.rb +131 -0
- data/src/com/zoho/crm/api/contact_roles/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/contact_roles/contact_role.rb +101 -0
- data/src/com/zoho/crm/api/contact_roles/contact_role_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +270 -0
- data/src/com/zoho/crm/api/contact_roles/record_action_handler.rb +12 -0
- data/src/com/zoho/crm/api/contact_roles/record_action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/contact_roles/record_body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/contact_roles/record_response_handler.rb +12 -0
- data/src/com/zoho/crm/api/contact_roles/record_response_wrapper.rb +86 -0
- data/src/com/zoho/crm/api/contact_roles/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/contact_roles/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/contact_roles/success_response.rb +123 -0
- data/src/com/zoho/crm/api/currencies/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/currencies/action_response.rb +12 -0
- data/src/com/zoho/crm/api/currencies/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/currencies/api_exception.rb +129 -0
- data/src/com/zoho/crm/api/currencies/base_currency_action_handler.rb +12 -0
- data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/currencies/base_currency_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/currencies/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/currencies/currencies_operations.rb +151 -0
- data/src/com/zoho/crm/api/currencies/currency.rb +292 -0
- data/src/com/zoho/crm/api/currencies/format.rb +102 -0
- data/src/com/zoho/crm/api/currencies/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/currencies/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/currencies/success_response.rb +123 -0
- data/src/com/zoho/crm/api/custom_views/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/custom_views/criteria.rb +137 -0
- data/src/com/zoho/crm/api/custom_views/custom_view.rb +329 -0
- data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +75 -0
- data/src/com/zoho/crm/api/custom_views/info.rb +158 -0
- data/src/com/zoho/crm/api/custom_views/range.rb +82 -0
- data/src/com/zoho/crm/api/custom_views/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/custom_views/response_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/custom_views/shared_details.rb +120 -0
- data/src/com/zoho/crm/api/custom_views/translation.rb +120 -0
- data/src/com/zoho/crm/api/dc/au_datacenter.rb +21 -0
- data/src/com/zoho/crm/api/dc/cn_datacenter.rb +21 -0
- data/src/com/zoho/crm/api/dc/datacenter.rb +23 -0
- data/src/com/zoho/crm/api/dc/eu_datacenter.rb +21 -0
- data/src/com/zoho/crm/api/dc/in_datacenter.rb +21 -0
- data/src/com/zoho/crm/api/dc/jp_datacenter.rb +21 -0
- data/src/com/zoho/crm/api/dc/us_datacenter.rb +21 -0
- data/src/com/zoho/crm/api/exception/sdk_exception.rb +49 -0
- data/src/com/zoho/crm/api/fields/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/fields/association_details.rb +82 -0
- data/src/com/zoho/crm/api/fields/auto_number.rb +101 -0
- data/src/com/zoho/crm/api/fields/crypt.rb +158 -0
- data/src/com/zoho/crm/api/fields/currency.rb +82 -0
- data/src/com/zoho/crm/api/fields/field.rb +958 -0
- data/src/com/zoho/crm/api/fields/fields_operations.rb +71 -0
- data/src/com/zoho/crm/api/fields/formula.rb +82 -0
- data/src/com/zoho/crm/api/fields/lookup_field.rb +82 -0
- data/src/com/zoho/crm/api/fields/module.rb +159 -0
- data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +158 -0
- data/src/com/zoho/crm/api/fields/pick_list_value.rb +177 -0
- data/src/com/zoho/crm/api/fields/private.rb +101 -0
- data/src/com/zoho/crm/api/fields/related_details.rb +139 -0
- data/src/com/zoho/crm/api/fields/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/fields/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/fields/tool_tip.rb +82 -0
- data/src/com/zoho/crm/api/fields/unique.rb +63 -0
- data/src/com/zoho/crm/api/fields/view_type.rb +120 -0
- data/src/com/zoho/crm/api/files/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/files/action_response.rb +12 -0
- data/src/com/zoho/crm/api/files/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/files/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/files/body_wrapper.rb +64 -0
- data/src/com/zoho/crm/api/files/file_body_wrapper.rb +66 -0
- data/src/com/zoho/crm/api/files/file_operations.rb +75 -0
- data/src/com/zoho/crm/api/files/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/files/success_response.rb +123 -0
- data/src/com/zoho/crm/api/header.rb +12 -0
- data/src/com/zoho/crm/api/header_map.rb +57 -0
- data/src/com/zoho/crm/api/initializer.rb +255 -0
- data/src/com/zoho/crm/api/layouts/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/layouts/layout.rb +274 -0
- data/src/com/zoho/crm/api/layouts/layouts_operations.rb +61 -0
- data/src/com/zoho/crm/api/layouts/properties.rb +102 -0
- data/src/com/zoho/crm/api/layouts/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/layouts/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/layouts/section.rb +235 -0
- data/src/com/zoho/crm/api/modules/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/modules/action_response.rb +12 -0
- data/src/com/zoho/crm/api/modules/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/modules/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/modules/argument.rb +82 -0
- data/src/com/zoho/crm/api/modules/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/modules/module.rb +884 -0
- data/src/com/zoho/crm/api/modules/modules_operations.rb +109 -0
- data/src/com/zoho/crm/api/modules/related_list_properties.rb +101 -0
- data/src/com/zoho/crm/api/modules/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/modules/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/modules/success_response.rb +123 -0
- data/src/com/zoho/crm/api/modules/territory.rb +101 -0
- data/src/com/zoho/crm/api/notes/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/notes/action_response.rb +12 -0
- data/src/com/zoho/crm/api/notes/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/notes/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/notes/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/notes/info.rb +120 -0
- data/src/com/zoho/crm/api/notes/note.rb +351 -0
- data/src/com/zoho/crm/api/notes/notes_operations.rb +214 -0
- data/src/com/zoho/crm/api/notes/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/notes/response_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/notes/success_response.rb +123 -0
- data/src/com/zoho/crm/api/notification/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/notification/action_response.rb +12 -0
- data/src/com/zoho/crm/api/notification/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/notification/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/notification/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/notification/info.rb +120 -0
- data/src/com/zoho/crm/api/notification/notification.rb +253 -0
- data/src/com/zoho/crm/api/notification/notification_operations.rb +160 -0
- data/src/com/zoho/crm/api/notification/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/notification/response_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/notification/success_response.rb +123 -0
- data/src/com/zoho/crm/api/org/action_response.rb +12 -0
- data/src/com/zoho/crm/api/org/api_exception.rb +125 -0
- data/src/com/zoho/crm/api/org/file_body_wrapper.rb +64 -0
- data/src/com/zoho/crm/api/org/license_details.rb +158 -0
- data/src/com/zoho/crm/api/org/org.rb +633 -0
- data/src/com/zoho/crm/api/org/org_operations.rb +49 -0
- data/src/com/zoho/crm/api/org/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/org/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/org/success_response.rb +123 -0
- data/src/com/zoho/crm/api/param.rb +12 -0
- data/src/com/zoho/crm/api/parameter_map.rb +56 -0
- data/src/com/zoho/crm/api/profiles/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/profiles/category.rb +101 -0
- data/src/com/zoho/crm/api/profiles/permission_detail.rb +139 -0
- data/src/com/zoho/crm/api/profiles/profile.rb +292 -0
- data/src/com/zoho/crm/api/profiles/profiles_operations.rb +61 -0
- data/src/com/zoho/crm/api/profiles/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/profiles/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/profiles/section.rb +82 -0
- data/src/com/zoho/crm/api/query/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/query/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/query/query_operations.rb +36 -0
- data/src/com/zoho/crm/api/query/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/query/response_wrapper.rb +86 -0
- data/src/com/zoho/crm/api/record/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/record/action_response.rb +12 -0
- data/src/com/zoho/crm/api/record/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/record/api_exception.rb +145 -0
- data/src/com/zoho/crm/api/record/apply_feature_execution.rb +63 -0
- data/src/com/zoho/crm/api/record/body_wrapper.rb +177 -0
- data/src/com/zoho/crm/api/record/carry_over_tags.rb +101 -0
- data/src/com/zoho/crm/api/record/comment.rb +120 -0
- data/src/com/zoho/crm/api/record/consent.rb +187 -0
- data/src/com/zoho/crm/api/record/convert_action_handler.rb +12 -0
- data/src/com/zoho/crm/api/record/convert_action_response.rb +12 -0
- data/src/com/zoho/crm/api/record/convert_action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/record/convert_body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/record/criteria.rb +137 -0
- data/src/com/zoho/crm/api/record/deleted_record.rb +159 -0
- data/src/com/zoho/crm/api/record/deleted_records_handler.rb +12 -0
- data/src/com/zoho/crm/api/record/deleted_records_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/record/download_handler.rb +12 -0
- data/src/com/zoho/crm/api/record/field.rb +2111 -0
- data/src/com/zoho/crm/api/record/file_body_wrapper.rb +68 -0
- data/src/com/zoho/crm/api/record/file_details.rb +329 -0
- data/src/com/zoho/crm/api/record/file_handler.rb +12 -0
- data/src/com/zoho/crm/api/record/info.rb +120 -0
- data/src/com/zoho/crm/api/record/inventory_line_items.rb +237 -0
- data/src/com/zoho/crm/api/record/lead_converter.rb +196 -0
- data/src/com/zoho/crm/api/record/line_item_product.rb +67 -0
- data/src/com/zoho/crm/api/record/line_tax.rb +120 -0
- data/src/com/zoho/crm/api/record/mass_update.rb +142 -0
- data/src/com/zoho/crm/api/record/mass_update_action_handler.rb +12 -0
- data/src/com/zoho/crm/api/record/mass_update_action_response.rb +12 -0
- data/src/com/zoho/crm/api/record/mass_update_action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +158 -0
- data/src/com/zoho/crm/api/record/mass_update_response.rb +12 -0
- data/src/com/zoho/crm/api/record/mass_update_response_handler.rb +12 -0
- data/src/com/zoho/crm/api/record/mass_update_response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/record/mass_update_success_response.rb +123 -0
- data/src/com/zoho/crm/api/record/options.rb +12 -0
- data/src/com/zoho/crm/api/record/participants.rb +118 -0
- data/src/com/zoho/crm/api/record/pricing_details.rb +67 -0
- data/src/com/zoho/crm/api/record/record.rb +194 -0
- data/src/com/zoho/crm/api/record/record_operations.rb +961 -0
- data/src/com/zoho/crm/api/record/recurring_activity.rb +63 -0
- data/src/com/zoho/crm/api/record/remind_at.rb +63 -0
- data/src/com/zoho/crm/api/record/reminder.rb +82 -0
- data/src/com/zoho/crm/api/record/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/record/response_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/record/success_response.rb +163 -0
- data/src/com/zoho/crm/api/record/successful_convert.rb +103 -0
- data/src/com/zoho/crm/api/record/territory.rb +82 -0
- data/src/com/zoho/crm/api/related_lists/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/related_lists/related_list.rb +253 -0
- data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +61 -0
- data/src/com/zoho/crm/api/related_lists/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/related_lists/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/related_records/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/related_records/action_response.rb +12 -0
- data/src/com/zoho/crm/api/related_records/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/related_records/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/related_records/body_wrapper.rb +64 -0
- data/src/com/zoho/crm/api/related_records/file_body_wrapper.rb +66 -0
- data/src/com/zoho/crm/api/related_records/related_records_operations.rb +524 -0
- data/src/com/zoho/crm/api/related_records/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/related_records/response_wrapper.rb +86 -0
- data/src/com/zoho/crm/api/related_records/success_response.rb +123 -0
- data/src/com/zoho/crm/api/request_proxy.rb +17 -0
- data/src/com/zoho/crm/api/roles/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/roles/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/roles/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/roles/role.rb +197 -0
- data/src/com/zoho/crm/api/roles/roles_operations.rb +47 -0
- data/src/com/zoho/crm/api/sdk_config.rb +15 -0
- data/src/com/zoho/crm/api/share_records/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/share_records/action_response.rb +12 -0
- data/src/com/zoho/crm/api/share_records/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/share_records/api_exception.rb +131 -0
- data/src/com/zoho/crm/api/share_records/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/share_records/delete_action_handler.rb +12 -0
- data/src/com/zoho/crm/api/share_records/delete_action_response.rb +12 -0
- data/src/com/zoho/crm/api/share_records/delete_action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/share_records/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/share_records/response_wrapper.rb +85 -0
- data/src/com/zoho/crm/api/share_records/share_record.rb +159 -0
- data/src/com/zoho/crm/api/share_records/share_records_operations.rb +130 -0
- data/src/com/zoho/crm/api/share_records/shared_through.rb +102 -0
- data/src/com/zoho/crm/api/share_records/success_response.rb +125 -0
- data/src/com/zoho/crm/api/tags/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/tags/action_response.rb +12 -0
- data/src/com/zoho/crm/api/tags/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/tags/api_exception.rb +133 -0
- data/src/com/zoho/crm/api/tags/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/tags/conflict_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/tags/count_handler.rb +12 -0
- data/src/com/zoho/crm/api/tags/count_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/tags/info.rb +82 -0
- data/src/com/zoho/crm/api/tags/merge_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/tags/record_action_handler.rb +12 -0
- data/src/com/zoho/crm/api/tags/record_action_response.rb +12 -0
- data/src/com/zoho/crm/api/tags/record_action_wrapper.rb +122 -0
- data/src/com/zoho/crm/api/tags/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/tags/response_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/tags/success_response.rb +125 -0
- data/src/com/zoho/crm/api/tags/tag.rb +159 -0
- data/src/com/zoho/crm/api/tags/tags_operations.rb +382 -0
- data/src/com/zoho/crm/api/taxes/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/taxes/action_response.rb +12 -0
- data/src/com/zoho/crm/api/taxes/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/taxes/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/taxes/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/taxes/preference.rb +82 -0
- data/src/com/zoho/crm/api/taxes/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/taxes/response_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/taxes/success_response.rb +123 -0
- data/src/com/zoho/crm/api/taxes/tax.rb +139 -0
- data/src/com/zoho/crm/api/taxes/taxes_operations.rb +132 -0
- data/src/com/zoho/crm/api/territories/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/territories/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/territories/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/territories/territories_operations.rb +47 -0
- data/src/com/zoho/crm/api/territories/territory.rb +236 -0
- data/src/com/zoho/crm/api/user_signature.rb +29 -0
- data/src/com/zoho/crm/api/users/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/users/action_response.rb +12 -0
- data/src/com/zoho/crm/api/users/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/users/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/users/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/users/customize_info.rb +158 -0
- data/src/com/zoho/crm/api/users/info.rb +120 -0
- data/src/com/zoho/crm/api/users/request_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/users/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/users/response_wrapper.rb +84 -0
- data/src/com/zoho/crm/api/users/shift.rb +82 -0
- data/src/com/zoho/crm/api/users/success_response.rb +123 -0
- data/src/com/zoho/crm/api/users/tab_theme.rb +82 -0
- data/src/com/zoho/crm/api/users/territory.rb +101 -0
- data/src/com/zoho/crm/api/users/theme.rb +158 -0
- data/src/com/zoho/crm/api/users/user.rb +698 -0
- data/src/com/zoho/crm/api/users/users_operations.rb +177 -0
- data/src/com/zoho/crm/api/util/api_http_connector.rb +114 -0
- data/src/com/zoho/crm/api/util/api_response.rb +18 -0
- data/src/com/zoho/crm/api/util/choice.rb +11 -0
- data/src/com/zoho/crm/api/util/common_api_handler.rb +241 -0
- data/src/com/zoho/crm/api/util/constants.rb +646 -0
- data/src/com/zoho/crm/api/util/converter.rb +238 -0
- data/src/com/zoho/crm/api/util/data_type_converter.rb +170 -0
- data/src/com/zoho/crm/api/util/downloader.rb +86 -0
- data/src/com/zoho/crm/api/util/form_data_converter.rb +159 -0
- data/src/com/zoho/crm/api/util/header_param_validator.rb +57 -0
- data/src/com/zoho/crm/api/util/json_converter.rb +729 -0
- data/src/com/zoho/crm/api/util/model.rb +7 -0
- data/src/com/zoho/crm/api/util/module_fields_handler.rb +80 -0
- data/src/com/zoho/crm/api/util/stream_wrapper.rb +39 -0
- data/src/com/zoho/crm/api/util/utility.rb +871 -0
- data/src/com/zoho/crm/api/variable_groups/api_exception.rb +123 -0
- data/src/com/zoho/crm/api/variable_groups/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/variable_groups/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/variable_groups/variable_group.rb +139 -0
- data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +65 -0
- data/src/com/zoho/crm/api/variables/action_handler.rb +12 -0
- data/src/com/zoho/crm/api/variables/action_response.rb +12 -0
- data/src/com/zoho/crm/api/variables/action_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/variables/api_exception.rb +127 -0
- data/src/com/zoho/crm/api/variables/body_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/variables/response_handler.rb +12 -0
- data/src/com/zoho/crm/api/variables/response_wrapper.rb +65 -0
- data/src/com/zoho/crm/api/variables/success_response.rb +123 -0
- data/src/com/zoho/crm/api/variables/variable.rb +175 -0
- data/src/com/zoho/crm/api/variables/variables_operations.rb +234 -0
- data/src/resources/JSONDetails.json +1 -0
- data/src/version.rb +3 -0
- metadata +500 -0
@@ -0,0 +1,57 @@
|
|
1
|
+
# This class represents the HTTP header name and value.
|
2
|
+
require_relative 'util/data_type_converter'
|
3
|
+
require_relative 'exception/sdk_exception'
|
4
|
+
require_relative 'util/header_param_validator'
|
5
|
+
|
6
|
+
module ZOHOCRMSDK
|
7
|
+
class HeaderMap
|
8
|
+
attr_accessor :header_hash
|
9
|
+
|
10
|
+
def initialize
|
11
|
+
@header_hash = {}
|
12
|
+
end
|
13
|
+
|
14
|
+
# This method is to add header name and value.
|
15
|
+
# @param header [Header] A Header class instance.
|
16
|
+
# @param value [Object] An object containing the header value.
|
17
|
+
def add(header, value)
|
18
|
+
unless header.is_a? Header
|
19
|
+
raise SDKException.new(Constants::HEADER_NULL_ERROR, Constants::HEADER_INSTANCE_NULL_ERROR)
|
20
|
+
end
|
21
|
+
|
22
|
+
header_name = header.name
|
23
|
+
|
24
|
+
if header_name.nil?
|
25
|
+
raise SDKException.new(Constants::HEADER_NAME_NULL_ERROR, Constants::HEADER_NAME_NULL_ERROR_MESSAGE)
|
26
|
+
end
|
27
|
+
|
28
|
+
if value.nil?
|
29
|
+
raise SDKException.new(Constants::HEADER_NULL_ERROR, header_name + Constants::NULL_VALUE_ERROR_MESSAGE)
|
30
|
+
end
|
31
|
+
|
32
|
+
header_value = nil
|
33
|
+
|
34
|
+
if header.class_name.nil?
|
35
|
+
begin
|
36
|
+
header_value = value.to_s
|
37
|
+
rescue StandardError
|
38
|
+
header_value = value
|
39
|
+
end
|
40
|
+
else
|
41
|
+
header_param_validator = Util::HeaderParamValidator.new
|
42
|
+
header_value = header_param_validator.validate(header, value)
|
43
|
+
end
|
44
|
+
|
45
|
+
header_value = header_value.to_s
|
46
|
+
if (@header_hash.key? header_name) && !@header_hash[header_name].nil?
|
47
|
+
existing_header_value = @header_hash[header_name]
|
48
|
+
|
49
|
+
existing_header_value = existing_header_value + ',' + header_value
|
50
|
+
|
51
|
+
@header_hash[header_name] = existing_header_value
|
52
|
+
else
|
53
|
+
@header_hash[header_name] = header_value
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
@@ -0,0 +1,255 @@
|
|
1
|
+
=begin
|
2
|
+
Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED
|
3
|
+
All rights reserved.
|
4
|
+
|
5
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
you may not use this file except in compliance with the License.
|
7
|
+
You may obtain a copy of the License at
|
8
|
+
|
9
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
|
11
|
+
Unless required by applicable law or agreed to in writing, software
|
12
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
See the License for the specific language governing permissions and
|
15
|
+
limitations under the License.
|
16
|
+
=end
|
17
|
+
|
18
|
+
require 'uri'
|
19
|
+
require 'net/http'
|
20
|
+
require 'cgi'
|
21
|
+
require 'json'
|
22
|
+
require_relative '../../api/logger/sdk_logger'
|
23
|
+
require_relative 'util/constants'
|
24
|
+
|
25
|
+
module ZOHOCRMSDK
|
26
|
+
# This class to initialize Zoho CRM SDK.
|
27
|
+
class Initializer
|
28
|
+
attr_accessor :json_details,:user, :environment, :store, :token, :initializer, :local, :sdk_config, :resources_path, :request_proxy, :api_version
|
29
|
+
@@json_details = nil
|
30
|
+
|
31
|
+
Thread.current['initi'] = nil
|
32
|
+
|
33
|
+
def self.json_details
|
34
|
+
@@json_details
|
35
|
+
end
|
36
|
+
|
37
|
+
def self.initialize(user:, environment:, token:, store: nil, sdk_config: nil, resources_path: nil, log: nil, request_proxy: nil, api_version: 2)
|
38
|
+
error = {}
|
39
|
+
|
40
|
+
require_relative 'user_signature'
|
41
|
+
|
42
|
+
unless user.is_a?(UserSignature)
|
43
|
+
error[Constants::ERROR_HASH_FIELD] = 'user'
|
44
|
+
|
45
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
|
46
|
+
|
47
|
+
raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
|
48
|
+
|
49
|
+
end
|
50
|
+
|
51
|
+
require_relative '../../crm/api/dc/datacenter'
|
52
|
+
|
53
|
+
unless environment.is_a? (DC::DataCenter::Environment)
|
54
|
+
error[Constants::ERROR_HASH_FIELD] = 'environment'
|
55
|
+
|
56
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
|
57
|
+
|
58
|
+
raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
|
59
|
+
|
60
|
+
end
|
61
|
+
|
62
|
+
require_relative '../../api/authenticator/token'
|
63
|
+
|
64
|
+
unless token.is_a?(Authenticator::Token)
|
65
|
+
error[Constants::ERROR_HASH_FIELD] = 'token'
|
66
|
+
|
67
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
|
68
|
+
|
69
|
+
raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
|
70
|
+
|
71
|
+
end
|
72
|
+
|
73
|
+
require_relative '../../api/authenticator/store/token_store'
|
74
|
+
|
75
|
+
if !store.nil? && !store.is_a?(Store::TokenStore)
|
76
|
+
error[Constants::ERROR_HASH_FIELD] = 'store'
|
77
|
+
|
78
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = Store::TokenStore
|
79
|
+
|
80
|
+
raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::STORE_ERROR_MESSAGE, error, nil)
|
81
|
+
|
82
|
+
end
|
83
|
+
|
84
|
+
require_relative 'sdk_config'
|
85
|
+
|
86
|
+
if !sdk_config.nil? && !sdk_config.is_a?(SDKConfig)
|
87
|
+
error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
|
88
|
+
|
89
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
|
90
|
+
|
91
|
+
raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
|
92
|
+
|
93
|
+
end
|
94
|
+
|
95
|
+
if !request_proxy.nil? && !request_proxy.is_a?(RequestProxy)
|
96
|
+
raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::REQUEST_PROXY_ERROR, nil, nil)
|
97
|
+
end
|
98
|
+
|
99
|
+
if store.nil?
|
100
|
+
require_relative '../../api/authenticator/store/file_store'
|
101
|
+
|
102
|
+
store = Store::FileStore.new(File.join(Dir.pwd, Constants::TOKEN_FILE))
|
103
|
+
|
104
|
+
end
|
105
|
+
|
106
|
+
if sdk_config.nil?
|
107
|
+
sdk_config = SDKConfig.new()
|
108
|
+
end
|
109
|
+
|
110
|
+
if resources_path.nil?
|
111
|
+
resources_path = Dir.pwd
|
112
|
+
end
|
113
|
+
|
114
|
+
if !File.directory?(resources_path)
|
115
|
+
raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_INVALID_ERROR_MESSAGE, nil, nil)
|
116
|
+
end
|
117
|
+
|
118
|
+
# Unless otherwise passed in, logging will be to filesystem using the WEBrick::BasicLog logger
|
119
|
+
log = SDKLog::Log.initialize(level: Levels::INFO, path: File.join(Dir.pwd, Constants::LOG_FILE_NAME)) if log.nil?
|
120
|
+
|
121
|
+
SDKLog::SDKLogger.initialize(log)
|
122
|
+
|
123
|
+
@@initializer = Initializer.new
|
124
|
+
|
125
|
+
@@initializer.user = user
|
126
|
+
|
127
|
+
@@initializer.environment = environment
|
128
|
+
|
129
|
+
@@initializer.sdk_config = sdk_config
|
130
|
+
|
131
|
+
@@initializer.token = token
|
132
|
+
|
133
|
+
@@initializer.store = store
|
134
|
+
|
135
|
+
@@initializer.resources_path = resources_path
|
136
|
+
|
137
|
+
@@initializer.request_proxy = request_proxy
|
138
|
+
|
139
|
+
@@initializer.api_version = api_version
|
140
|
+
|
141
|
+
@@json_details = get_JSONDetails
|
142
|
+
|
143
|
+
SDKLog::SDKLogger.info(Constants::INITIALIZATION_SUCCESSFUL + @@initializer.to_s)
|
144
|
+
rescue SDKException => e
|
145
|
+
raise e
|
146
|
+
rescue StandardError => e
|
147
|
+
raise SDKException.new(nil, Constants::INITIALIZATION_ERROR, nil, e)
|
148
|
+
end
|
149
|
+
|
150
|
+
def self.get_JSONDetails
|
151
|
+
if @@json_details.nil? || @@json_details.length == 0
|
152
|
+
return JSON.parse(File.open(File.join(File.dirname(File.expand_path(__FILE__)), '../../../../' + Constants::JSON_DETAILS_FILE_PATH)).read)
|
153
|
+
end
|
154
|
+
@@json_details
|
155
|
+
rescue StandardError => e
|
156
|
+
raise SDKException.new(nil, Constants::EXCEPTION_JSONDETAILS, nil, e)
|
157
|
+
end
|
158
|
+
|
159
|
+
def self.get_initializer
|
160
|
+
return Thread.current['initi'] unless Thread.current['initi'].nil?
|
161
|
+
|
162
|
+
@@initializer
|
163
|
+
end
|
164
|
+
|
165
|
+
def self.switch_user(user:nil, environment:nil, token:nil, sdk_config:nil, request_proxy: nil)
|
166
|
+
|
167
|
+
if @@initializer.nil?
|
168
|
+
raise SDKException.new(Constants::SDK_UNINITIALIZATION_ERROR, Constants::SDK_UNINITIALIZATION_MESSAGE)
|
169
|
+
end
|
170
|
+
|
171
|
+
require_relative 'user_signature'
|
172
|
+
|
173
|
+
if !user.nil? and !user.is_a?(UserSignature)
|
174
|
+
error[Constants::ERROR_HASH_FIELD] = 'user'
|
175
|
+
|
176
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
|
177
|
+
|
178
|
+
raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
|
179
|
+
|
180
|
+
end
|
181
|
+
|
182
|
+
require_relative '../../crm/api/dc/datacenter'
|
183
|
+
|
184
|
+
if !environment.nil? and !environment.is_a?(DC::DataCenter::Environment)
|
185
|
+
error[Constants::ERROR_HASH_FIELD] = 'environment'
|
186
|
+
|
187
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
|
188
|
+
|
189
|
+
raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
|
190
|
+
|
191
|
+
end
|
192
|
+
|
193
|
+
require_relative '../../api/authenticator/token'
|
194
|
+
|
195
|
+
if !token.nil? and !token.is_a?(Authenticator::Token)
|
196
|
+
error[Constants::ERROR_HASH_FIELD] = 'token'
|
197
|
+
|
198
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
|
199
|
+
|
200
|
+
raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
|
201
|
+
|
202
|
+
end
|
203
|
+
|
204
|
+
require_relative 'request_proxy'
|
205
|
+
|
206
|
+
if !request_proxy.nil? and !request_proxy.is_a?(RequestProxy)
|
207
|
+
error[Constants::ERROR_HASH_FIELD] = 'request_proxy'
|
208
|
+
|
209
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = RequestProxy
|
210
|
+
|
211
|
+
raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::REQUEST_PROXY_ERROR_MESSAGE, error, nil)
|
212
|
+
|
213
|
+
end
|
214
|
+
|
215
|
+
require_relative 'sdk_config'
|
216
|
+
|
217
|
+
if !sdk_config.nil? and !sdk_config.is_a?(SDKConfig)
|
218
|
+
error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
|
219
|
+
|
220
|
+
error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
|
221
|
+
|
222
|
+
raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
|
223
|
+
|
224
|
+
end
|
225
|
+
|
226
|
+
initializer = Initializer.new
|
227
|
+
|
228
|
+
previous_initializer = Initializer.get_initializer
|
229
|
+
|
230
|
+
initializer.user = user.nil? ? previous_initializer.user : user
|
231
|
+
|
232
|
+
initializer.environment = environment.nil? ? previous_initializer.environment : environment
|
233
|
+
|
234
|
+
initializer.sdk_config = sdk_config.nil? ? previous_initializer.sdk_config : sdk_config
|
235
|
+
|
236
|
+
initializer.token = token.nil? ? previous_initializer.token : token
|
237
|
+
|
238
|
+
initializer.store = @@initializer.store
|
239
|
+
|
240
|
+
initializer.resources_path = @@initializer.resources_path
|
241
|
+
|
242
|
+
initializer.request_proxy = request_proxy
|
243
|
+
|
244
|
+
initializer.api_version = @@initializer.api_version
|
245
|
+
|
246
|
+
Thread.current['initi'] = initializer
|
247
|
+
|
248
|
+
SDKLog::SDKLogger.info(Constants::INITIALIZATION_SWITCHED + initializer.to_s)
|
249
|
+
end
|
250
|
+
|
251
|
+
def to_s
|
252
|
+
Constants::FOR_EMAIL_ID + Initializer.get_initializer.user.email + Constants::IN_ENVIRONMENT + Initializer.get_initializer.environment.url + '.'
|
253
|
+
end
|
254
|
+
end
|
255
|
+
end
|
@@ -0,0 +1,123 @@
|
|
1
|
+
require_relative '../util/choice'
|
2
|
+
require_relative '../util/model'
|
3
|
+
|
4
|
+
module ZOHOCRMSDK
|
5
|
+
module Layouts
|
6
|
+
require_relative 'response_handler'
|
7
|
+
class APIException
|
8
|
+
include Util::Model
|
9
|
+
include ResponseHandler
|
10
|
+
|
11
|
+
# Creates an instance of APIException
|
12
|
+
def initialize
|
13
|
+
@status = nil
|
14
|
+
@code = nil
|
15
|
+
@message = nil
|
16
|
+
@details = nil
|
17
|
+
@key_modified = Hash.new
|
18
|
+
end
|
19
|
+
|
20
|
+
# The method to get the status
|
21
|
+
# @return An instance of Util::Choice
|
22
|
+
|
23
|
+
def status
|
24
|
+
@status
|
25
|
+
end
|
26
|
+
|
27
|
+
# The method to set the value to status
|
28
|
+
# @param status [Util::Choice] An instance of Util::Choice
|
29
|
+
|
30
|
+
def status=(status)
|
31
|
+
if status!=nil and !status.is_a? Util::Choice
|
32
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
|
33
|
+
end
|
34
|
+
@status = status
|
35
|
+
@key_modified['status'] = 1
|
36
|
+
end
|
37
|
+
|
38
|
+
# The method to get the code
|
39
|
+
# @return An instance of Util::Choice
|
40
|
+
|
41
|
+
def code
|
42
|
+
@code
|
43
|
+
end
|
44
|
+
|
45
|
+
# The method to set the value to code
|
46
|
+
# @param code [Util::Choice] An instance of Util::Choice
|
47
|
+
|
48
|
+
def code=(code)
|
49
|
+
if code!=nil and !code.is_a? Util::Choice
|
50
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
|
51
|
+
end
|
52
|
+
@code = code
|
53
|
+
@key_modified['code'] = 1
|
54
|
+
end
|
55
|
+
|
56
|
+
# The method to get the message
|
57
|
+
# @return An instance of Util::Choice
|
58
|
+
|
59
|
+
def message
|
60
|
+
@message
|
61
|
+
end
|
62
|
+
|
63
|
+
# The method to set the value to message
|
64
|
+
# @param message [Util::Choice] An instance of Util::Choice
|
65
|
+
|
66
|
+
def message=(message)
|
67
|
+
if message!=nil and !message.is_a? Util::Choice
|
68
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
|
69
|
+
end
|
70
|
+
@message = message
|
71
|
+
@key_modified['message'] = 1
|
72
|
+
end
|
73
|
+
|
74
|
+
# The method to get the details
|
75
|
+
# @return An instance of Hash
|
76
|
+
|
77
|
+
def details
|
78
|
+
@details
|
79
|
+
end
|
80
|
+
|
81
|
+
# The method to set the value to details
|
82
|
+
# @param details [Hash] An instance of Hash
|
83
|
+
|
84
|
+
def details=(details)
|
85
|
+
if details!=nil and !details.is_a? Hash
|
86
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
|
87
|
+
end
|
88
|
+
@details = details
|
89
|
+
@key_modified['details'] = 1
|
90
|
+
end
|
91
|
+
|
92
|
+
# The method to check if the user has modified the given key
|
93
|
+
# @param key [String] A String
|
94
|
+
# @return A Integer value
|
95
|
+
|
96
|
+
def is_key_modified(key)
|
97
|
+
if key!=nil and !key.is_a? String
|
98
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
|
99
|
+
end
|
100
|
+
if @key_modified.key?(key)
|
101
|
+
return @key_modified[key]
|
102
|
+
end
|
103
|
+
|
104
|
+
nil
|
105
|
+
end
|
106
|
+
|
107
|
+
# The method to mark the given key as modified
|
108
|
+
# @param key [String] A String
|
109
|
+
# @param modification [Integer] A Integer
|
110
|
+
|
111
|
+
def set_key_modified(key, modification)
|
112
|
+
if key!=nil and !key.is_a? String
|
113
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
|
114
|
+
end
|
115
|
+
if modification!=nil and !modification.is_a? Integer
|
116
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
|
117
|
+
end
|
118
|
+
@key_modified[key] = modification
|
119
|
+
end
|
120
|
+
|
121
|
+
end
|
122
|
+
end
|
123
|
+
end
|
@@ -0,0 +1,274 @@
|
|
1
|
+
require_relative '../profiles/profile'
|
2
|
+
require_relative '../users/user'
|
3
|
+
require_relative '../util/model'
|
4
|
+
|
5
|
+
module ZOHOCRMSDK
|
6
|
+
module Layouts
|
7
|
+
class Layout
|
8
|
+
include Util::Model
|
9
|
+
|
10
|
+
# Creates an instance of Layout
|
11
|
+
def initialize
|
12
|
+
@created_time = nil
|
13
|
+
@convert_mapping = nil
|
14
|
+
@modified_time = nil
|
15
|
+
@visible = nil
|
16
|
+
@created_for = nil
|
17
|
+
@name = nil
|
18
|
+
@modified_by = nil
|
19
|
+
@profiles = nil
|
20
|
+
@id = nil
|
21
|
+
@created_by = nil
|
22
|
+
@sections = nil
|
23
|
+
@status = nil
|
24
|
+
@key_modified = Hash.new
|
25
|
+
end
|
26
|
+
|
27
|
+
# The method to get the created_time
|
28
|
+
# @return An instance of DateTime
|
29
|
+
|
30
|
+
def created_time
|
31
|
+
@created_time
|
32
|
+
end
|
33
|
+
|
34
|
+
# The method to set the value to created_time
|
35
|
+
# @param created_time [DateTime] An instance of DateTime
|
36
|
+
|
37
|
+
def created_time=(created_time)
|
38
|
+
if created_time!=nil and !created_time.is_a? DateTime
|
39
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
|
40
|
+
end
|
41
|
+
@created_time = created_time
|
42
|
+
@key_modified['created_time'] = 1
|
43
|
+
end
|
44
|
+
|
45
|
+
# The method to get the convert_mapping
|
46
|
+
# @return An instance of Hash
|
47
|
+
|
48
|
+
def convert_mapping
|
49
|
+
@convert_mapping
|
50
|
+
end
|
51
|
+
|
52
|
+
# The method to set the value to convert_mapping
|
53
|
+
# @param convert_mapping [Hash] An instance of Hash
|
54
|
+
|
55
|
+
def convert_mapping=(convert_mapping)
|
56
|
+
if convert_mapping!=nil and !convert_mapping.is_a? Hash
|
57
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: Hash', nil, nil)
|
58
|
+
end
|
59
|
+
@convert_mapping = convert_mapping
|
60
|
+
@key_modified['convert_mapping'] = 1
|
61
|
+
end
|
62
|
+
|
63
|
+
# The method to get the modified_time
|
64
|
+
# @return An instance of DateTime
|
65
|
+
|
66
|
+
def modified_time
|
67
|
+
@modified_time
|
68
|
+
end
|
69
|
+
|
70
|
+
# The method to set the value to modified_time
|
71
|
+
# @param modified_time [DateTime] An instance of DateTime
|
72
|
+
|
73
|
+
def modified_time=(modified_time)
|
74
|
+
if modified_time!=nil and !modified_time.is_a? DateTime
|
75
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
|
76
|
+
end
|
77
|
+
@modified_time = modified_time
|
78
|
+
@key_modified['modified_time'] = 1
|
79
|
+
end
|
80
|
+
|
81
|
+
# The method to get the visible
|
82
|
+
# @return A Boolean value
|
83
|
+
|
84
|
+
def visible
|
85
|
+
@visible
|
86
|
+
end
|
87
|
+
|
88
|
+
# The method to set the value to visible
|
89
|
+
# @param visible [Boolean] A Boolean
|
90
|
+
|
91
|
+
def visible=(visible)
|
92
|
+
if visible!=nil and ! [true, false].include?visible
|
93
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: Boolean', nil, nil)
|
94
|
+
end
|
95
|
+
@visible = visible
|
96
|
+
@key_modified['visible'] = 1
|
97
|
+
end
|
98
|
+
|
99
|
+
# The method to get the created_for
|
100
|
+
# @return An instance of Users::User
|
101
|
+
|
102
|
+
def created_for
|
103
|
+
@created_for
|
104
|
+
end
|
105
|
+
|
106
|
+
# The method to set the value to created_for
|
107
|
+
# @param created_for [Users::User] An instance of Users::User
|
108
|
+
|
109
|
+
def created_for=(created_for)
|
110
|
+
if created_for!=nil and !created_for.is_a? Users::User
|
111
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_for EXPECTED TYPE: User', nil, nil)
|
112
|
+
end
|
113
|
+
@created_for = created_for
|
114
|
+
@key_modified['created_for'] = 1
|
115
|
+
end
|
116
|
+
|
117
|
+
# The method to get the name
|
118
|
+
# @return A String value
|
119
|
+
|
120
|
+
def name
|
121
|
+
@name
|
122
|
+
end
|
123
|
+
|
124
|
+
# The method to set the value to name
|
125
|
+
# @param name [String] A String
|
126
|
+
|
127
|
+
def name=(name)
|
128
|
+
if name!=nil and !name.is_a? String
|
129
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
|
130
|
+
end
|
131
|
+
@name = name
|
132
|
+
@key_modified['name'] = 1
|
133
|
+
end
|
134
|
+
|
135
|
+
# The method to get the modified_by
|
136
|
+
# @return An instance of Users::User
|
137
|
+
|
138
|
+
def modified_by
|
139
|
+
@modified_by
|
140
|
+
end
|
141
|
+
|
142
|
+
# The method to set the value to modified_by
|
143
|
+
# @param modified_by [Users::User] An instance of Users::User
|
144
|
+
|
145
|
+
def modified_by=(modified_by)
|
146
|
+
if modified_by!=nil and !modified_by.is_a? Users::User
|
147
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
|
148
|
+
end
|
149
|
+
@modified_by = modified_by
|
150
|
+
@key_modified['modified_by'] = 1
|
151
|
+
end
|
152
|
+
|
153
|
+
# The method to get the profiles
|
154
|
+
# @return An instance of Array
|
155
|
+
|
156
|
+
def profiles
|
157
|
+
@profiles
|
158
|
+
end
|
159
|
+
|
160
|
+
# The method to set the value to profiles
|
161
|
+
# @param profiles [Array] An instance of Array
|
162
|
+
|
163
|
+
def profiles=(profiles)
|
164
|
+
if profiles!=nil and !profiles.is_a? Array
|
165
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: Array', nil, nil)
|
166
|
+
end
|
167
|
+
@profiles = profiles
|
168
|
+
@key_modified['profiles'] = 1
|
169
|
+
end
|
170
|
+
|
171
|
+
# The method to get the id
|
172
|
+
# @return A Integer value
|
173
|
+
|
174
|
+
def id
|
175
|
+
@id
|
176
|
+
end
|
177
|
+
|
178
|
+
# The method to set the value to id
|
179
|
+
# @param id [Integer] A Integer
|
180
|
+
|
181
|
+
def id=(id)
|
182
|
+
if id!=nil and !id.is_a? Integer
|
183
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
|
184
|
+
end
|
185
|
+
@id = id
|
186
|
+
@key_modified['id'] = 1
|
187
|
+
end
|
188
|
+
|
189
|
+
# The method to get the created_by
|
190
|
+
# @return An instance of Users::User
|
191
|
+
|
192
|
+
def created_by
|
193
|
+
@created_by
|
194
|
+
end
|
195
|
+
|
196
|
+
# The method to set the value to created_by
|
197
|
+
# @param created_by [Users::User] An instance of Users::User
|
198
|
+
|
199
|
+
def created_by=(created_by)
|
200
|
+
if created_by!=nil and !created_by.is_a? Users::User
|
201
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
|
202
|
+
end
|
203
|
+
@created_by = created_by
|
204
|
+
@key_modified['created_by'] = 1
|
205
|
+
end
|
206
|
+
|
207
|
+
# The method to get the sections
|
208
|
+
# @return An instance of Array
|
209
|
+
|
210
|
+
def sections
|
211
|
+
@sections
|
212
|
+
end
|
213
|
+
|
214
|
+
# The method to set the value to sections
|
215
|
+
# @param sections [Array] An instance of Array
|
216
|
+
|
217
|
+
def sections=(sections)
|
218
|
+
if sections!=nil and !sections.is_a? Array
|
219
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sections EXPECTED TYPE: Array', nil, nil)
|
220
|
+
end
|
221
|
+
@sections = sections
|
222
|
+
@key_modified['sections'] = 1
|
223
|
+
end
|
224
|
+
|
225
|
+
# The method to get the status
|
226
|
+
# @return A Integer value
|
227
|
+
|
228
|
+
def status
|
229
|
+
@status
|
230
|
+
end
|
231
|
+
|
232
|
+
# The method to set the value to status
|
233
|
+
# @param status [Integer] A Integer
|
234
|
+
|
235
|
+
def status=(status)
|
236
|
+
if status!=nil and !status.is_a? Integer
|
237
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Integer', nil, nil)
|
238
|
+
end
|
239
|
+
@status = status
|
240
|
+
@key_modified['status'] = 1
|
241
|
+
end
|
242
|
+
|
243
|
+
# The method to check if the user has modified the given key
|
244
|
+
# @param key [String] A String
|
245
|
+
# @return A Integer value
|
246
|
+
|
247
|
+
def is_key_modified(key)
|
248
|
+
if key!=nil and !key.is_a? String
|
249
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
|
250
|
+
end
|
251
|
+
if @key_modified.key?(key)
|
252
|
+
return @key_modified[key]
|
253
|
+
end
|
254
|
+
|
255
|
+
nil
|
256
|
+
end
|
257
|
+
|
258
|
+
# The method to mark the given key as modified
|
259
|
+
# @param key [String] A String
|
260
|
+
# @param modification [Integer] A Integer
|
261
|
+
|
262
|
+
def set_key_modified(key, modification)
|
263
|
+
if key!=nil and !key.is_a? String
|
264
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
|
265
|
+
end
|
266
|
+
if modification!=nil and !modification.is_a? Integer
|
267
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
|
268
|
+
end
|
269
|
+
@key_modified[key] = modification
|
270
|
+
end
|
271
|
+
|
272
|
+
end
|
273
|
+
end
|
274
|
+
end
|