ZOHOCRMSDK2_0_docgo 6.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (374) hide show
  1. checksums.yaml +7 -0
  2. data/src/ZOHOCRMSDK2_0_docgo.rb +370 -0
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +285 -0
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +194 -0
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +238 -0
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +35 -0
  7. data/src/com/zoho/api/authenticator/token.rb +12 -0
  8. data/src/com/zoho/api/logger/sdk_logger.rb +64 -0
  9. data/src/com/zoho/crm/api/attachments/action_handler.rb +12 -0
  10. data/src/com/zoho/crm/api/attachments/action_response.rb +12 -0
  11. data/src/com/zoho/crm/api/attachments/action_wrapper.rb +65 -0
  12. data/src/com/zoho/crm/api/attachments/api_exception.rb +127 -0
  13. data/src/com/zoho/crm/api/attachments/attachment.rb +369 -0
  14. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +198 -0
  15. data/src/com/zoho/crm/api/attachments/file_body_wrapper.rb +66 -0
  16. data/src/com/zoho/crm/api/attachments/response_handler.rb +12 -0
  17. data/src/com/zoho/crm/api/attachments/response_wrapper.rb +85 -0
  18. data/src/com/zoho/crm/api/attachments/success_response.rb +123 -0
  19. data/src/com/zoho/crm/api/blue_print/action_response.rb +12 -0
  20. data/src/com/zoho/crm/api/blue_print/api_exception.rb +125 -0
  21. data/src/com/zoho/crm/api/blue_print/blue_print.rb +121 -0
  22. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +69 -0
  23. data/src/com/zoho/crm/api/blue_print/body_wrapper.rb +63 -0
  24. data/src/com/zoho/crm/api/blue_print/next_transition.rb +82 -0
  25. data/src/com/zoho/crm/api/blue_print/process_info.rb +253 -0
  26. data/src/com/zoho/crm/api/blue_print/response_handler.rb +12 -0
  27. data/src/com/zoho/crm/api/blue_print/response_wrapper.rb +65 -0
  28. data/src/com/zoho/crm/api/blue_print/success_response.rb +123 -0
  29. data/src/com/zoho/crm/api/blue_print/transition.rb +255 -0
  30. data/src/com/zoho/crm/api/blue_print/validation_error.rb +82 -0
  31. data/src/com/zoho/crm/api/bulk_read/action_handler.rb +12 -0
  32. data/src/com/zoho/crm/api/bulk_read/action_response.rb +12 -0
  33. data/src/com/zoho/crm/api/bulk_read/action_wrapper.rb +84 -0
  34. data/src/com/zoho/crm/api/bulk_read/api_exception.rb +127 -0
  35. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +76 -0
  36. data/src/com/zoho/crm/api/bulk_read/call_back.rb +83 -0
  37. data/src/com/zoho/crm/api/bulk_read/criteria.rb +137 -0
  38. data/src/com/zoho/crm/api/bulk_read/file_body_wrapper.rb +66 -0
  39. data/src/com/zoho/crm/api/bulk_read/job_detail.rb +198 -0
  40. data/src/com/zoho/crm/api/bulk_read/query.rb +139 -0
  41. data/src/com/zoho/crm/api/bulk_read/request_wrapper.rb +102 -0
  42. data/src/com/zoho/crm/api/bulk_read/response_handler.rb +12 -0
  43. data/src/com/zoho/crm/api/bulk_read/response_wrapper.rb +65 -0
  44. data/src/com/zoho/crm/api/bulk_read/result.rb +139 -0
  45. data/src/com/zoho/crm/api/bulk_read/success_response.rb +123 -0
  46. data/src/com/zoho/crm/api/bulk_write/action_response.rb +12 -0
  47. data/src/com/zoho/crm/api/bulk_write/api_exception.rb +241 -0
  48. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +114 -0
  49. data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb +218 -0
  50. data/src/com/zoho/crm/api/bulk_write/call_back.rb +83 -0
  51. data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +158 -0
  52. data/src/com/zoho/crm/api/bulk_write/file.rb +159 -0
  53. data/src/com/zoho/crm/api/bulk_write/file_body_wrapper.rb +66 -0
  54. data/src/com/zoho/crm/api/bulk_write/request_wrapper.rb +121 -0
  55. data/src/com/zoho/crm/api/bulk_write/resource.rb +197 -0
  56. data/src/com/zoho/crm/api/bulk_write/response_handler.rb +12 -0
  57. data/src/com/zoho/crm/api/bulk_write/response_wrapper.rb +12 -0
  58. data/src/com/zoho/crm/api/bulk_write/result.rb +63 -0
  59. data/src/com/zoho/crm/api/bulk_write/success_response.rb +123 -0
  60. data/src/com/zoho/crm/api/contact_roles/action_handler.rb +12 -0
  61. data/src/com/zoho/crm/api/contact_roles/action_response.rb +12 -0
  62. data/src/com/zoho/crm/api/contact_roles/action_wrapper.rb +65 -0
  63. data/src/com/zoho/crm/api/contact_roles/api_exception.rb +131 -0
  64. data/src/com/zoho/crm/api/contact_roles/body_wrapper.rb +63 -0
  65. data/src/com/zoho/crm/api/contact_roles/contact_role.rb +101 -0
  66. data/src/com/zoho/crm/api/contact_roles/contact_role_wrapper.rb +63 -0
  67. data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +270 -0
  68. data/src/com/zoho/crm/api/contact_roles/record_action_handler.rb +12 -0
  69. data/src/com/zoho/crm/api/contact_roles/record_action_wrapper.rb +65 -0
  70. data/src/com/zoho/crm/api/contact_roles/record_body_wrapper.rb +63 -0
  71. data/src/com/zoho/crm/api/contact_roles/record_response_handler.rb +12 -0
  72. data/src/com/zoho/crm/api/contact_roles/record_response_wrapper.rb +86 -0
  73. data/src/com/zoho/crm/api/contact_roles/response_handler.rb +12 -0
  74. data/src/com/zoho/crm/api/contact_roles/response_wrapper.rb +65 -0
  75. data/src/com/zoho/crm/api/contact_roles/success_response.rb +123 -0
  76. data/src/com/zoho/crm/api/currencies/action_handler.rb +12 -0
  77. data/src/com/zoho/crm/api/currencies/action_response.rb +12 -0
  78. data/src/com/zoho/crm/api/currencies/action_wrapper.rb +65 -0
  79. data/src/com/zoho/crm/api/currencies/api_exception.rb +129 -0
  80. data/src/com/zoho/crm/api/currencies/base_currency_action_handler.rb +12 -0
  81. data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb +65 -0
  82. data/src/com/zoho/crm/api/currencies/base_currency_wrapper.rb +63 -0
  83. data/src/com/zoho/crm/api/currencies/body_wrapper.rb +63 -0
  84. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +151 -0
  85. data/src/com/zoho/crm/api/currencies/currency.rb +292 -0
  86. data/src/com/zoho/crm/api/currencies/format.rb +102 -0
  87. data/src/com/zoho/crm/api/currencies/response_handler.rb +12 -0
  88. data/src/com/zoho/crm/api/currencies/response_wrapper.rb +65 -0
  89. data/src/com/zoho/crm/api/currencies/success_response.rb +123 -0
  90. data/src/com/zoho/crm/api/custom_views/api_exception.rb +123 -0
  91. data/src/com/zoho/crm/api/custom_views/criteria.rb +137 -0
  92. data/src/com/zoho/crm/api/custom_views/custom_view.rb +329 -0
  93. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +75 -0
  94. data/src/com/zoho/crm/api/custom_views/info.rb +158 -0
  95. data/src/com/zoho/crm/api/custom_views/range.rb +82 -0
  96. data/src/com/zoho/crm/api/custom_views/response_handler.rb +12 -0
  97. data/src/com/zoho/crm/api/custom_views/response_wrapper.rb +84 -0
  98. data/src/com/zoho/crm/api/custom_views/shared_details.rb +120 -0
  99. data/src/com/zoho/crm/api/custom_views/translation.rb +120 -0
  100. data/src/com/zoho/crm/api/dc/au_datacenter.rb +21 -0
  101. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +21 -0
  102. data/src/com/zoho/crm/api/dc/datacenter.rb +23 -0
  103. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +21 -0
  104. data/src/com/zoho/crm/api/dc/in_datacenter.rb +21 -0
  105. data/src/com/zoho/crm/api/dc/jp_datacenter.rb +21 -0
  106. data/src/com/zoho/crm/api/dc/us_datacenter.rb +21 -0
  107. data/src/com/zoho/crm/api/exception/sdk_exception.rb +49 -0
  108. data/src/com/zoho/crm/api/fields/api_exception.rb +123 -0
  109. data/src/com/zoho/crm/api/fields/association_details.rb +82 -0
  110. data/src/com/zoho/crm/api/fields/auto_number.rb +101 -0
  111. data/src/com/zoho/crm/api/fields/crypt.rb +158 -0
  112. data/src/com/zoho/crm/api/fields/currency.rb +82 -0
  113. data/src/com/zoho/crm/api/fields/field.rb +958 -0
  114. data/src/com/zoho/crm/api/fields/fields_operations.rb +71 -0
  115. data/src/com/zoho/crm/api/fields/formula.rb +82 -0
  116. data/src/com/zoho/crm/api/fields/lookup_field.rb +82 -0
  117. data/src/com/zoho/crm/api/fields/module.rb +159 -0
  118. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +158 -0
  119. data/src/com/zoho/crm/api/fields/pick_list_value.rb +177 -0
  120. data/src/com/zoho/crm/api/fields/private.rb +101 -0
  121. data/src/com/zoho/crm/api/fields/related_details.rb +139 -0
  122. data/src/com/zoho/crm/api/fields/response_handler.rb +12 -0
  123. data/src/com/zoho/crm/api/fields/response_wrapper.rb +65 -0
  124. data/src/com/zoho/crm/api/fields/tool_tip.rb +82 -0
  125. data/src/com/zoho/crm/api/fields/unique.rb +63 -0
  126. data/src/com/zoho/crm/api/fields/view_type.rb +120 -0
  127. data/src/com/zoho/crm/api/files/action_handler.rb +12 -0
  128. data/src/com/zoho/crm/api/files/action_response.rb +12 -0
  129. data/src/com/zoho/crm/api/files/action_wrapper.rb +65 -0
  130. data/src/com/zoho/crm/api/files/api_exception.rb +127 -0
  131. data/src/com/zoho/crm/api/files/body_wrapper.rb +64 -0
  132. data/src/com/zoho/crm/api/files/file_body_wrapper.rb +66 -0
  133. data/src/com/zoho/crm/api/files/file_operations.rb +75 -0
  134. data/src/com/zoho/crm/api/files/response_handler.rb +12 -0
  135. data/src/com/zoho/crm/api/files/success_response.rb +123 -0
  136. data/src/com/zoho/crm/api/header.rb +12 -0
  137. data/src/com/zoho/crm/api/header_map.rb +57 -0
  138. data/src/com/zoho/crm/api/initializer.rb +255 -0
  139. data/src/com/zoho/crm/api/layouts/api_exception.rb +123 -0
  140. data/src/com/zoho/crm/api/layouts/layout.rb +274 -0
  141. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +61 -0
  142. data/src/com/zoho/crm/api/layouts/properties.rb +102 -0
  143. data/src/com/zoho/crm/api/layouts/response_handler.rb +12 -0
  144. data/src/com/zoho/crm/api/layouts/response_wrapper.rb +65 -0
  145. data/src/com/zoho/crm/api/layouts/section.rb +235 -0
  146. data/src/com/zoho/crm/api/modules/action_handler.rb +12 -0
  147. data/src/com/zoho/crm/api/modules/action_response.rb +12 -0
  148. data/src/com/zoho/crm/api/modules/action_wrapper.rb +65 -0
  149. data/src/com/zoho/crm/api/modules/api_exception.rb +127 -0
  150. data/src/com/zoho/crm/api/modules/argument.rb +82 -0
  151. data/src/com/zoho/crm/api/modules/body_wrapper.rb +63 -0
  152. data/src/com/zoho/crm/api/modules/module.rb +884 -0
  153. data/src/com/zoho/crm/api/modules/modules_operations.rb +109 -0
  154. data/src/com/zoho/crm/api/modules/related_list_properties.rb +101 -0
  155. data/src/com/zoho/crm/api/modules/response_handler.rb +12 -0
  156. data/src/com/zoho/crm/api/modules/response_wrapper.rb +65 -0
  157. data/src/com/zoho/crm/api/modules/success_response.rb +123 -0
  158. data/src/com/zoho/crm/api/modules/territory.rb +101 -0
  159. data/src/com/zoho/crm/api/notes/action_handler.rb +12 -0
  160. data/src/com/zoho/crm/api/notes/action_response.rb +12 -0
  161. data/src/com/zoho/crm/api/notes/action_wrapper.rb +65 -0
  162. data/src/com/zoho/crm/api/notes/api_exception.rb +127 -0
  163. data/src/com/zoho/crm/api/notes/body_wrapper.rb +63 -0
  164. data/src/com/zoho/crm/api/notes/info.rb +120 -0
  165. data/src/com/zoho/crm/api/notes/note.rb +351 -0
  166. data/src/com/zoho/crm/api/notes/notes_operations.rb +214 -0
  167. data/src/com/zoho/crm/api/notes/response_handler.rb +12 -0
  168. data/src/com/zoho/crm/api/notes/response_wrapper.rb +84 -0
  169. data/src/com/zoho/crm/api/notes/success_response.rb +123 -0
  170. data/src/com/zoho/crm/api/notification/action_handler.rb +12 -0
  171. data/src/com/zoho/crm/api/notification/action_response.rb +12 -0
  172. data/src/com/zoho/crm/api/notification/action_wrapper.rb +65 -0
  173. data/src/com/zoho/crm/api/notification/api_exception.rb +127 -0
  174. data/src/com/zoho/crm/api/notification/body_wrapper.rb +63 -0
  175. data/src/com/zoho/crm/api/notification/info.rb +120 -0
  176. data/src/com/zoho/crm/api/notification/notification.rb +253 -0
  177. data/src/com/zoho/crm/api/notification/notification_operations.rb +160 -0
  178. data/src/com/zoho/crm/api/notification/response_handler.rb +12 -0
  179. data/src/com/zoho/crm/api/notification/response_wrapper.rb +84 -0
  180. data/src/com/zoho/crm/api/notification/success_response.rb +123 -0
  181. data/src/com/zoho/crm/api/org/action_response.rb +12 -0
  182. data/src/com/zoho/crm/api/org/api_exception.rb +125 -0
  183. data/src/com/zoho/crm/api/org/file_body_wrapper.rb +64 -0
  184. data/src/com/zoho/crm/api/org/license_details.rb +158 -0
  185. data/src/com/zoho/crm/api/org/org.rb +633 -0
  186. data/src/com/zoho/crm/api/org/org_operations.rb +49 -0
  187. data/src/com/zoho/crm/api/org/response_handler.rb +12 -0
  188. data/src/com/zoho/crm/api/org/response_wrapper.rb +65 -0
  189. data/src/com/zoho/crm/api/org/success_response.rb +123 -0
  190. data/src/com/zoho/crm/api/param.rb +12 -0
  191. data/src/com/zoho/crm/api/parameter_map.rb +56 -0
  192. data/src/com/zoho/crm/api/profiles/api_exception.rb +123 -0
  193. data/src/com/zoho/crm/api/profiles/category.rb +101 -0
  194. data/src/com/zoho/crm/api/profiles/permission_detail.rb +139 -0
  195. data/src/com/zoho/crm/api/profiles/profile.rb +292 -0
  196. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +61 -0
  197. data/src/com/zoho/crm/api/profiles/response_handler.rb +12 -0
  198. data/src/com/zoho/crm/api/profiles/response_wrapper.rb +65 -0
  199. data/src/com/zoho/crm/api/profiles/section.rb +82 -0
  200. data/src/com/zoho/crm/api/query/api_exception.rb +123 -0
  201. data/src/com/zoho/crm/api/query/body_wrapper.rb +63 -0
  202. data/src/com/zoho/crm/api/query/query_operations.rb +36 -0
  203. data/src/com/zoho/crm/api/query/response_handler.rb +12 -0
  204. data/src/com/zoho/crm/api/query/response_wrapper.rb +86 -0
  205. data/src/com/zoho/crm/api/record/action_handler.rb +12 -0
  206. data/src/com/zoho/crm/api/record/action_response.rb +12 -0
  207. data/src/com/zoho/crm/api/record/action_wrapper.rb +65 -0
  208. data/src/com/zoho/crm/api/record/api_exception.rb +145 -0
  209. data/src/com/zoho/crm/api/record/apply_feature_execution.rb +63 -0
  210. data/src/com/zoho/crm/api/record/body_wrapper.rb +177 -0
  211. data/src/com/zoho/crm/api/record/carry_over_tags.rb +101 -0
  212. data/src/com/zoho/crm/api/record/comment.rb +120 -0
  213. data/src/com/zoho/crm/api/record/consent.rb +187 -0
  214. data/src/com/zoho/crm/api/record/convert_action_handler.rb +12 -0
  215. data/src/com/zoho/crm/api/record/convert_action_response.rb +12 -0
  216. data/src/com/zoho/crm/api/record/convert_action_wrapper.rb +65 -0
  217. data/src/com/zoho/crm/api/record/convert_body_wrapper.rb +63 -0
  218. data/src/com/zoho/crm/api/record/criteria.rb +137 -0
  219. data/src/com/zoho/crm/api/record/deleted_record.rb +159 -0
  220. data/src/com/zoho/crm/api/record/deleted_records_handler.rb +12 -0
  221. data/src/com/zoho/crm/api/record/deleted_records_wrapper.rb +84 -0
  222. data/src/com/zoho/crm/api/record/download_handler.rb +12 -0
  223. data/src/com/zoho/crm/api/record/field.rb +2111 -0
  224. data/src/com/zoho/crm/api/record/file_body_wrapper.rb +68 -0
  225. data/src/com/zoho/crm/api/record/file_details.rb +329 -0
  226. data/src/com/zoho/crm/api/record/file_handler.rb +12 -0
  227. data/src/com/zoho/crm/api/record/info.rb +120 -0
  228. data/src/com/zoho/crm/api/record/inventory_line_items.rb +237 -0
  229. data/src/com/zoho/crm/api/record/lead_converter.rb +196 -0
  230. data/src/com/zoho/crm/api/record/line_item_product.rb +67 -0
  231. data/src/com/zoho/crm/api/record/line_tax.rb +120 -0
  232. data/src/com/zoho/crm/api/record/mass_update.rb +142 -0
  233. data/src/com/zoho/crm/api/record/mass_update_action_handler.rb +12 -0
  234. data/src/com/zoho/crm/api/record/mass_update_action_response.rb +12 -0
  235. data/src/com/zoho/crm/api/record/mass_update_action_wrapper.rb +65 -0
  236. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +158 -0
  237. data/src/com/zoho/crm/api/record/mass_update_response.rb +12 -0
  238. data/src/com/zoho/crm/api/record/mass_update_response_handler.rb +12 -0
  239. data/src/com/zoho/crm/api/record/mass_update_response_wrapper.rb +65 -0
  240. data/src/com/zoho/crm/api/record/mass_update_success_response.rb +123 -0
  241. data/src/com/zoho/crm/api/record/options.rb +12 -0
  242. data/src/com/zoho/crm/api/record/participants.rb +118 -0
  243. data/src/com/zoho/crm/api/record/pricing_details.rb +67 -0
  244. data/src/com/zoho/crm/api/record/record.rb +194 -0
  245. data/src/com/zoho/crm/api/record/record_operations.rb +961 -0
  246. data/src/com/zoho/crm/api/record/recurring_activity.rb +63 -0
  247. data/src/com/zoho/crm/api/record/remind_at.rb +63 -0
  248. data/src/com/zoho/crm/api/record/reminder.rb +82 -0
  249. data/src/com/zoho/crm/api/record/response_handler.rb +12 -0
  250. data/src/com/zoho/crm/api/record/response_wrapper.rb +84 -0
  251. data/src/com/zoho/crm/api/record/success_response.rb +163 -0
  252. data/src/com/zoho/crm/api/record/successful_convert.rb +103 -0
  253. data/src/com/zoho/crm/api/record/territory.rb +82 -0
  254. data/src/com/zoho/crm/api/related_lists/api_exception.rb +123 -0
  255. data/src/com/zoho/crm/api/related_lists/related_list.rb +253 -0
  256. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +61 -0
  257. data/src/com/zoho/crm/api/related_lists/response_handler.rb +12 -0
  258. data/src/com/zoho/crm/api/related_lists/response_wrapper.rb +65 -0
  259. data/src/com/zoho/crm/api/related_records/action_handler.rb +12 -0
  260. data/src/com/zoho/crm/api/related_records/action_response.rb +12 -0
  261. data/src/com/zoho/crm/api/related_records/action_wrapper.rb +65 -0
  262. data/src/com/zoho/crm/api/related_records/api_exception.rb +127 -0
  263. data/src/com/zoho/crm/api/related_records/body_wrapper.rb +64 -0
  264. data/src/com/zoho/crm/api/related_records/file_body_wrapper.rb +66 -0
  265. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +524 -0
  266. data/src/com/zoho/crm/api/related_records/response_handler.rb +12 -0
  267. data/src/com/zoho/crm/api/related_records/response_wrapper.rb +86 -0
  268. data/src/com/zoho/crm/api/related_records/success_response.rb +123 -0
  269. data/src/com/zoho/crm/api/request_proxy.rb +17 -0
  270. data/src/com/zoho/crm/api/roles/api_exception.rb +123 -0
  271. data/src/com/zoho/crm/api/roles/response_handler.rb +12 -0
  272. data/src/com/zoho/crm/api/roles/response_wrapper.rb +65 -0
  273. data/src/com/zoho/crm/api/roles/role.rb +197 -0
  274. data/src/com/zoho/crm/api/roles/roles_operations.rb +47 -0
  275. data/src/com/zoho/crm/api/sdk_config.rb +15 -0
  276. data/src/com/zoho/crm/api/share_records/action_handler.rb +12 -0
  277. data/src/com/zoho/crm/api/share_records/action_response.rb +12 -0
  278. data/src/com/zoho/crm/api/share_records/action_wrapper.rb +65 -0
  279. data/src/com/zoho/crm/api/share_records/api_exception.rb +131 -0
  280. data/src/com/zoho/crm/api/share_records/body_wrapper.rb +63 -0
  281. data/src/com/zoho/crm/api/share_records/delete_action_handler.rb +12 -0
  282. data/src/com/zoho/crm/api/share_records/delete_action_response.rb +12 -0
  283. data/src/com/zoho/crm/api/share_records/delete_action_wrapper.rb +65 -0
  284. data/src/com/zoho/crm/api/share_records/response_handler.rb +12 -0
  285. data/src/com/zoho/crm/api/share_records/response_wrapper.rb +85 -0
  286. data/src/com/zoho/crm/api/share_records/share_record.rb +159 -0
  287. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +130 -0
  288. data/src/com/zoho/crm/api/share_records/shared_through.rb +102 -0
  289. data/src/com/zoho/crm/api/share_records/success_response.rb +125 -0
  290. data/src/com/zoho/crm/api/tags/action_handler.rb +12 -0
  291. data/src/com/zoho/crm/api/tags/action_response.rb +12 -0
  292. data/src/com/zoho/crm/api/tags/action_wrapper.rb +65 -0
  293. data/src/com/zoho/crm/api/tags/api_exception.rb +133 -0
  294. data/src/com/zoho/crm/api/tags/body_wrapper.rb +63 -0
  295. data/src/com/zoho/crm/api/tags/conflict_wrapper.rb +63 -0
  296. data/src/com/zoho/crm/api/tags/count_handler.rb +12 -0
  297. data/src/com/zoho/crm/api/tags/count_wrapper.rb +65 -0
  298. data/src/com/zoho/crm/api/tags/info.rb +82 -0
  299. data/src/com/zoho/crm/api/tags/merge_wrapper.rb +63 -0
  300. data/src/com/zoho/crm/api/tags/record_action_handler.rb +12 -0
  301. data/src/com/zoho/crm/api/tags/record_action_response.rb +12 -0
  302. data/src/com/zoho/crm/api/tags/record_action_wrapper.rb +122 -0
  303. data/src/com/zoho/crm/api/tags/response_handler.rb +12 -0
  304. data/src/com/zoho/crm/api/tags/response_wrapper.rb +84 -0
  305. data/src/com/zoho/crm/api/tags/success_response.rb +125 -0
  306. data/src/com/zoho/crm/api/tags/tag.rb +159 -0
  307. data/src/com/zoho/crm/api/tags/tags_operations.rb +382 -0
  308. data/src/com/zoho/crm/api/taxes/action_handler.rb +12 -0
  309. data/src/com/zoho/crm/api/taxes/action_response.rb +12 -0
  310. data/src/com/zoho/crm/api/taxes/action_wrapper.rb +65 -0
  311. data/src/com/zoho/crm/api/taxes/api_exception.rb +127 -0
  312. data/src/com/zoho/crm/api/taxes/body_wrapper.rb +63 -0
  313. data/src/com/zoho/crm/api/taxes/preference.rb +82 -0
  314. data/src/com/zoho/crm/api/taxes/response_handler.rb +12 -0
  315. data/src/com/zoho/crm/api/taxes/response_wrapper.rb +84 -0
  316. data/src/com/zoho/crm/api/taxes/success_response.rb +123 -0
  317. data/src/com/zoho/crm/api/taxes/tax.rb +139 -0
  318. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +132 -0
  319. data/src/com/zoho/crm/api/territories/api_exception.rb +123 -0
  320. data/src/com/zoho/crm/api/territories/response_handler.rb +12 -0
  321. data/src/com/zoho/crm/api/territories/response_wrapper.rb +65 -0
  322. data/src/com/zoho/crm/api/territories/territories_operations.rb +47 -0
  323. data/src/com/zoho/crm/api/territories/territory.rb +236 -0
  324. data/src/com/zoho/crm/api/user_signature.rb +29 -0
  325. data/src/com/zoho/crm/api/users/action_handler.rb +12 -0
  326. data/src/com/zoho/crm/api/users/action_response.rb +12 -0
  327. data/src/com/zoho/crm/api/users/action_wrapper.rb +65 -0
  328. data/src/com/zoho/crm/api/users/api_exception.rb +127 -0
  329. data/src/com/zoho/crm/api/users/body_wrapper.rb +63 -0
  330. data/src/com/zoho/crm/api/users/customize_info.rb +158 -0
  331. data/src/com/zoho/crm/api/users/info.rb +120 -0
  332. data/src/com/zoho/crm/api/users/request_wrapper.rb +63 -0
  333. data/src/com/zoho/crm/api/users/response_handler.rb +12 -0
  334. data/src/com/zoho/crm/api/users/response_wrapper.rb +84 -0
  335. data/src/com/zoho/crm/api/users/shift.rb +82 -0
  336. data/src/com/zoho/crm/api/users/success_response.rb +123 -0
  337. data/src/com/zoho/crm/api/users/tab_theme.rb +82 -0
  338. data/src/com/zoho/crm/api/users/territory.rb +101 -0
  339. data/src/com/zoho/crm/api/users/theme.rb +158 -0
  340. data/src/com/zoho/crm/api/users/user.rb +698 -0
  341. data/src/com/zoho/crm/api/users/users_operations.rb +177 -0
  342. data/src/com/zoho/crm/api/util/api_http_connector.rb +114 -0
  343. data/src/com/zoho/crm/api/util/api_response.rb +18 -0
  344. data/src/com/zoho/crm/api/util/choice.rb +11 -0
  345. data/src/com/zoho/crm/api/util/common_api_handler.rb +241 -0
  346. data/src/com/zoho/crm/api/util/constants.rb +646 -0
  347. data/src/com/zoho/crm/api/util/converter.rb +238 -0
  348. data/src/com/zoho/crm/api/util/data_type_converter.rb +170 -0
  349. data/src/com/zoho/crm/api/util/downloader.rb +86 -0
  350. data/src/com/zoho/crm/api/util/form_data_converter.rb +159 -0
  351. data/src/com/zoho/crm/api/util/header_param_validator.rb +57 -0
  352. data/src/com/zoho/crm/api/util/json_converter.rb +729 -0
  353. data/src/com/zoho/crm/api/util/model.rb +7 -0
  354. data/src/com/zoho/crm/api/util/module_fields_handler.rb +80 -0
  355. data/src/com/zoho/crm/api/util/stream_wrapper.rb +39 -0
  356. data/src/com/zoho/crm/api/util/utility.rb +871 -0
  357. data/src/com/zoho/crm/api/variable_groups/api_exception.rb +123 -0
  358. data/src/com/zoho/crm/api/variable_groups/response_handler.rb +12 -0
  359. data/src/com/zoho/crm/api/variable_groups/response_wrapper.rb +65 -0
  360. data/src/com/zoho/crm/api/variable_groups/variable_group.rb +139 -0
  361. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +65 -0
  362. data/src/com/zoho/crm/api/variables/action_handler.rb +12 -0
  363. data/src/com/zoho/crm/api/variables/action_response.rb +12 -0
  364. data/src/com/zoho/crm/api/variables/action_wrapper.rb +65 -0
  365. data/src/com/zoho/crm/api/variables/api_exception.rb +127 -0
  366. data/src/com/zoho/crm/api/variables/body_wrapper.rb +63 -0
  367. data/src/com/zoho/crm/api/variables/response_handler.rb +12 -0
  368. data/src/com/zoho/crm/api/variables/response_wrapper.rb +65 -0
  369. data/src/com/zoho/crm/api/variables/success_response.rb +123 -0
  370. data/src/com/zoho/crm/api/variables/variable.rb +175 -0
  371. data/src/com/zoho/crm/api/variables/variables_operations.rb +234 -0
  372. data/src/resources/JSONDetails.json +1 -0
  373. data/src/version.rb +3 -0
  374. metadata +500 -0
@@ -0,0 +1,61 @@
1
+ require_relative '../param'
2
+ require_relative '../exception/sdk_exception'
3
+ require_relative '../util/api_response'
4
+ require_relative '../util/common_api_handler'
5
+ require_relative '../util/constants'
6
+
7
+ module ZOHOCRMSDK
8
+ module Layouts
9
+ class LayoutsOperations
10
+
11
+ # Creates an instance of LayoutsOperations with the given parameters
12
+ # @param module_1 [String] A String
13
+ def initialize(module_1=nil)
14
+ if module_1!=nil and !module_1.is_a? String
15
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
16
+ end
17
+ @module_1 = module_1
18
+ end
19
+
20
+ # The method to get layouts
21
+ # @return An instance of APIResponse
22
+ # @raise SDKException
23
+ def get_layouts
24
+ handler_instance = Handler::CommonAPIHandler.new
25
+ api_path = "/crm/v#{Initializer.get_initializer.api_version}/settings/layouts"
26
+ handler_instance.api_path = api_path
27
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
28
+ handler_instance.category_method = 'READ'
29
+ handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.Layouts.GetLayoutsParam'), @module_1)
30
+ require_relative 'response_handler'
31
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
32
+ end
33
+
34
+ # The method to get layout
35
+ # @param id [Integer] A Integer
36
+ # @return An instance of APIResponse
37
+ # @raise SDKException
38
+ def get_layout(id)
39
+ if !id.is_a? Integer
40
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
41
+ end
42
+ handler_instance = Handler::CommonAPIHandler.new
43
+ api_path = "/crm/v#{Initializer.get_initializer.api_version}/settings/layouts/"
44
+ api_path = api_path + id.to_s
45
+ handler_instance.api_path = api_path
46
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
47
+ handler_instance.category_method = 'READ'
48
+ handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.Layouts.GetLayoutParam'), @module_1)
49
+ require_relative 'response_handler'
50
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
51
+ end
52
+
53
+ class GetLayoutsParam
54
+ end
55
+
56
+ class GetLayoutParam
57
+ end
58
+
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,102 @@
1
+ require_relative '../fields/tool_tip'
2
+ require_relative '../util/model'
3
+
4
+ module ZOHOCRMSDK
5
+ module Layouts
6
+ class Properties
7
+ include Util::Model
8
+
9
+ # Creates an instance of Properties
10
+ def initialize
11
+ @reorder_rows = nil
12
+ @tooltip = nil
13
+ @maximum_rows = nil
14
+ @key_modified = Hash.new
15
+ end
16
+
17
+ # The method to get the reorder_rows
18
+ # @return A Boolean value
19
+
20
+ def reorder_rows
21
+ @reorder_rows
22
+ end
23
+
24
+ # The method to set the value to reorder_rows
25
+ # @param reorder_rows [Boolean] A Boolean
26
+
27
+ def reorder_rows=(reorder_rows)
28
+ if reorder_rows!=nil and ! [true, false].include?reorder_rows
29
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: reorder_rows EXPECTED TYPE: Boolean', nil, nil)
30
+ end
31
+ @reorder_rows = reorder_rows
32
+ @key_modified['reorder_rows'] = 1
33
+ end
34
+
35
+ # The method to get the tooltip
36
+ # @return An instance of Fields::ToolTip
37
+
38
+ def tooltip
39
+ @tooltip
40
+ end
41
+
42
+ # The method to set the value to tooltip
43
+ # @param tooltip [Fields::ToolTip] An instance of Fields::ToolTip
44
+
45
+ def tooltip=(tooltip)
46
+ if tooltip!=nil and !tooltip.is_a? Fields::ToolTip
47
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: ToolTip', nil, nil)
48
+ end
49
+ @tooltip = tooltip
50
+ @key_modified['tooltip'] = 1
51
+ end
52
+
53
+ # The method to get the maximum_rows
54
+ # @return A Integer value
55
+
56
+ def maximum_rows
57
+ @maximum_rows
58
+ end
59
+
60
+ # The method to set the value to maximum_rows
61
+ # @param maximum_rows [Integer] A Integer
62
+
63
+ def maximum_rows=(maximum_rows)
64
+ if maximum_rows!=nil and !maximum_rows.is_a? Integer
65
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: maximum_rows EXPECTED TYPE: Integer', nil, nil)
66
+ end
67
+ @maximum_rows = maximum_rows
68
+ @key_modified['maximum_rows'] = 1
69
+ end
70
+
71
+ # The method to check if the user has modified the given key
72
+ # @param key [String] A String
73
+ # @return A Integer value
74
+
75
+ def is_key_modified(key)
76
+ if key!=nil and !key.is_a? String
77
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
78
+ end
79
+ if @key_modified.key?(key)
80
+ return @key_modified[key]
81
+ end
82
+
83
+ nil
84
+ end
85
+
86
+ # The method to mark the given key as modified
87
+ # @param key [String] A String
88
+ # @param modification [Integer] A Integer
89
+
90
+ def set_key_modified(key, modification)
91
+ if key!=nil and !key.is_a? String
92
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
93
+ end
94
+ if modification!=nil and !modification.is_a? Integer
95
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
96
+ end
97
+ @key_modified[key] = modification
98
+ end
99
+
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,12 @@
1
+ module ZOHOCRMSDK
2
+ module Layouts
3
+ module ResponseHandler
4
+
5
+ # Creates an instance of ResponseHandler
6
+ def initialize
7
+ end
8
+
9
+
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,65 @@
1
+ require_relative '../util/model'
2
+
3
+ module ZOHOCRMSDK
4
+ module Layouts
5
+ require_relative 'response_handler'
6
+ class ResponseWrapper
7
+ include Util::Model
8
+ include ResponseHandler
9
+
10
+ # Creates an instance of ResponseWrapper
11
+ def initialize
12
+ @layouts = nil
13
+ @key_modified = Hash.new
14
+ end
15
+
16
+ # The method to get the layouts
17
+ # @return An instance of Array
18
+
19
+ def layouts
20
+ @layouts
21
+ end
22
+
23
+ # The method to set the value to layouts
24
+ # @param layouts [Array] An instance of Array
25
+
26
+ def layouts=(layouts)
27
+ if layouts!=nil and !layouts.is_a? Array
28
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: Array', nil, nil)
29
+ end
30
+ @layouts = layouts
31
+ @key_modified['layouts'] = 1
32
+ end
33
+
34
+ # The method to check if the user has modified the given key
35
+ # @param key [String] A String
36
+ # @return A Integer value
37
+
38
+ def is_key_modified(key)
39
+ if key!=nil and !key.is_a? String
40
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
41
+ end
42
+ if @key_modified.key?(key)
43
+ return @key_modified[key]
44
+ end
45
+
46
+ nil
47
+ end
48
+
49
+ # The method to mark the given key as modified
50
+ # @param key [String] A String
51
+ # @param modification [Integer] A Integer
52
+
53
+ def set_key_modified(key, modification)
54
+ if key!=nil and !key.is_a? String
55
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
56
+ end
57
+ if modification!=nil and !modification.is_a? Integer
58
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
59
+ end
60
+ @key_modified[key] = modification
61
+ end
62
+
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,235 @@
1
+ require_relative '../fields/field'
2
+ require_relative '../util/model'
3
+
4
+ module ZOHOCRMSDK
5
+ module Layouts
6
+ class Section
7
+ include Util::Model
8
+
9
+ # Creates an instance of Section
10
+ def initialize
11
+ @display_label = nil
12
+ @sequence_number = nil
13
+ @issubformsection = nil
14
+ @tab_traversal = nil
15
+ @api_name = nil
16
+ @column_count = nil
17
+ @name = nil
18
+ @generated_type = nil
19
+ @fields = nil
20
+ @properties = nil
21
+ @key_modified = Hash.new
22
+ end
23
+
24
+ # The method to get the display_label
25
+ # @return A String value
26
+
27
+ def display_label
28
+ @display_label
29
+ end
30
+
31
+ # The method to set the value to display_label
32
+ # @param display_label [String] A String
33
+
34
+ def display_label=(display_label)
35
+ if display_label!=nil and !display_label.is_a? String
36
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
37
+ end
38
+ @display_label = display_label
39
+ @key_modified['display_label'] = 1
40
+ end
41
+
42
+ # The method to get the sequence_number
43
+ # @return A Integer value
44
+
45
+ def sequence_number
46
+ @sequence_number
47
+ end
48
+
49
+ # The method to set the value to sequence_number
50
+ # @param sequence_number [Integer] A Integer
51
+
52
+ def sequence_number=(sequence_number)
53
+ if sequence_number!=nil and !sequence_number.is_a? Integer
54
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: Integer', nil, nil)
55
+ end
56
+ @sequence_number = sequence_number
57
+ @key_modified['sequence_number'] = 1
58
+ end
59
+
60
+ # The method to get the issubformsection
61
+ # @return A Boolean value
62
+
63
+ def issubformsection
64
+ @issubformsection
65
+ end
66
+
67
+ # The method to set the value to issubformsection
68
+ # @param issubformsection [Boolean] A Boolean
69
+
70
+ def issubformsection=(issubformsection)
71
+ if issubformsection!=nil and ! [true, false].include?issubformsection
72
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: issubformsection EXPECTED TYPE: Boolean', nil, nil)
73
+ end
74
+ @issubformsection = issubformsection
75
+ @key_modified['isSubformSection'] = 1
76
+ end
77
+
78
+ # The method to get the tab_traversal
79
+ # @return A Integer value
80
+
81
+ def tab_traversal
82
+ @tab_traversal
83
+ end
84
+
85
+ # The method to set the value to tab_traversal
86
+ # @param tab_traversal [Integer] A Integer
87
+
88
+ def tab_traversal=(tab_traversal)
89
+ if tab_traversal!=nil and !tab_traversal.is_a? Integer
90
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tab_traversal EXPECTED TYPE: Integer', nil, nil)
91
+ end
92
+ @tab_traversal = tab_traversal
93
+ @key_modified['tab_traversal'] = 1
94
+ end
95
+
96
+ # The method to get the api_name
97
+ # @return A String value
98
+
99
+ def api_name
100
+ @api_name
101
+ end
102
+
103
+ # The method to set the value to api_name
104
+ # @param api_name [String] A String
105
+
106
+ def api_name=(api_name)
107
+ if api_name!=nil and !api_name.is_a? String
108
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
109
+ end
110
+ @api_name = api_name
111
+ @key_modified['api_name'] = 1
112
+ end
113
+
114
+ # The method to get the column_count
115
+ # @return A Integer value
116
+
117
+ def column_count
118
+ @column_count
119
+ end
120
+
121
+ # The method to set the value to column_count
122
+ # @param column_count [Integer] A Integer
123
+
124
+ def column_count=(column_count)
125
+ if column_count!=nil and !column_count.is_a? Integer
126
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column_count EXPECTED TYPE: Integer', nil, nil)
127
+ end
128
+ @column_count = column_count
129
+ @key_modified['column_count'] = 1
130
+ end
131
+
132
+ # The method to get the name
133
+ # @return A String value
134
+
135
+ def name
136
+ @name
137
+ end
138
+
139
+ # The method to set the value to name
140
+ # @param name [String] A String
141
+
142
+ def name=(name)
143
+ if name!=nil and !name.is_a? String
144
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
145
+ end
146
+ @name = name
147
+ @key_modified['name'] = 1
148
+ end
149
+
150
+ # The method to get the generated_type
151
+ # @return A String value
152
+
153
+ def generated_type
154
+ @generated_type
155
+ end
156
+
157
+ # The method to set the value to generated_type
158
+ # @param generated_type [String] A String
159
+
160
+ def generated_type=(generated_type)
161
+ if generated_type!=nil and !generated_type.is_a? String
162
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: generated_type EXPECTED TYPE: String', nil, nil)
163
+ end
164
+ @generated_type = generated_type
165
+ @key_modified['generated_type'] = 1
166
+ end
167
+
168
+ # The method to get the fields
169
+ # @return An instance of Array
170
+
171
+ def fields
172
+ @fields
173
+ end
174
+
175
+ # The method to set the value to fields
176
+ # @param fields [Array] An instance of Array
177
+
178
+ def fields=(fields)
179
+ if fields!=nil and !fields.is_a? Array
180
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: Array', nil, nil)
181
+ end
182
+ @fields = fields
183
+ @key_modified['fields'] = 1
184
+ end
185
+
186
+ # The method to get the properties
187
+ # @return An instance of Properties
188
+
189
+ def properties
190
+ @properties
191
+ end
192
+
193
+ # The method to set the value to properties
194
+ # @param properties [Properties] An instance of Properties
195
+
196
+ def properties=(properties)
197
+ if properties!=nil and !properties.is_a? Properties
198
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: Properties', nil, nil)
199
+ end
200
+ @properties = properties
201
+ @key_modified['properties'] = 1
202
+ end
203
+
204
+ # The method to check if the user has modified the given key
205
+ # @param key [String] A String
206
+ # @return A Integer value
207
+
208
+ def is_key_modified(key)
209
+ if key!=nil and !key.is_a? String
210
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
211
+ end
212
+ if @key_modified.key?(key)
213
+ return @key_modified[key]
214
+ end
215
+
216
+ nil
217
+ end
218
+
219
+ # The method to mark the given key as modified
220
+ # @param key [String] A String
221
+ # @param modification [Integer] A Integer
222
+
223
+ def set_key_modified(key, modification)
224
+ if key!=nil and !key.is_a? String
225
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
226
+ end
227
+ if modification!=nil and !modification.is_a? Integer
228
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
229
+ end
230
+ @key_modified[key] = modification
231
+ end
232
+
233
+ end
234
+ end
235
+ end
@@ -0,0 +1,12 @@
1
+ module ZOHOCRMSDK
2
+ module Modules
3
+ module ActionHandler
4
+
5
+ # Creates an instance of ActionHandler
6
+ def initialize
7
+ end
8
+
9
+
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,12 @@
1
+ module ZOHOCRMSDK
2
+ module Modules
3
+ module ActionResponse
4
+
5
+ # Creates an instance of ActionResponse
6
+ def initialize
7
+ end
8
+
9
+
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,65 @@
1
+ require_relative '../util/model'
2
+
3
+ module ZOHOCRMSDK
4
+ module Modules
5
+ require_relative 'action_handler'
6
+ class ActionWrapper
7
+ include Util::Model
8
+ include ActionHandler
9
+
10
+ # Creates an instance of ActionWrapper
11
+ def initialize
12
+ @modules = nil
13
+ @key_modified = Hash.new
14
+ end
15
+
16
+ # The method to get the modules
17
+ # @return An instance of Array
18
+
19
+ def modules
20
+ @modules
21
+ end
22
+
23
+ # The method to set the value to modules
24
+ # @param modules [Array] An instance of Array
25
+
26
+ def modules=(modules)
27
+ if modules!=nil and !modules.is_a? Array
28
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: Array', nil, nil)
29
+ end
30
+ @modules = modules
31
+ @key_modified['modules'] = 1
32
+ end
33
+
34
+ # The method to check if the user has modified the given key
35
+ # @param key [String] A String
36
+ # @return A Integer value
37
+
38
+ def is_key_modified(key)
39
+ if key!=nil and !key.is_a? String
40
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
41
+ end
42
+ if @key_modified.key?(key)
43
+ return @key_modified[key]
44
+ end
45
+
46
+ nil
47
+ end
48
+
49
+ # The method to mark the given key as modified
50
+ # @param key [String] A String
51
+ # @param modification [Integer] A Integer
52
+
53
+ def set_key_modified(key, modification)
54
+ if key!=nil and !key.is_a? String
55
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
56
+ end
57
+ if modification!=nil and !modification.is_a? Integer
58
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
59
+ end
60
+ @key_modified[key] = modification
61
+ end
62
+
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,127 @@
1
+ require_relative '../util/choice'
2
+ require_relative '../util/model'
3
+
4
+ module ZOHOCRMSDK
5
+ module Modules
6
+ require_relative 'response_handler'
7
+ require_relative 'action_response'
8
+ require_relative 'action_handler'
9
+ class APIException
10
+ include Util::Model
11
+ include ResponseHandler
12
+ include ActionResponse
13
+ include ActionHandler
14
+
15
+ # Creates an instance of APIException
16
+ def initialize
17
+ @status = nil
18
+ @code = nil
19
+ @message = nil
20
+ @details = nil
21
+ @key_modified = Hash.new
22
+ end
23
+
24
+ # The method to get the status
25
+ # @return An instance of Util::Choice
26
+
27
+ def status
28
+ @status
29
+ end
30
+
31
+ # The method to set the value to status
32
+ # @param status [Util::Choice] An instance of Util::Choice
33
+
34
+ def status=(status)
35
+ if status!=nil and !status.is_a? Util::Choice
36
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
37
+ end
38
+ @status = status
39
+ @key_modified['status'] = 1
40
+ end
41
+
42
+ # The method to get the code
43
+ # @return An instance of Util::Choice
44
+
45
+ def code
46
+ @code
47
+ end
48
+
49
+ # The method to set the value to code
50
+ # @param code [Util::Choice] An instance of Util::Choice
51
+
52
+ def code=(code)
53
+ if code!=nil and !code.is_a? Util::Choice
54
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
55
+ end
56
+ @code = code
57
+ @key_modified['code'] = 1
58
+ end
59
+
60
+ # The method to get the message
61
+ # @return An instance of Util::Choice
62
+
63
+ def message
64
+ @message
65
+ end
66
+
67
+ # The method to set the value to message
68
+ # @param message [Util::Choice] An instance of Util::Choice
69
+
70
+ def message=(message)
71
+ if message!=nil and !message.is_a? Util::Choice
72
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
73
+ end
74
+ @message = message
75
+ @key_modified['message'] = 1
76
+ end
77
+
78
+ # The method to get the details
79
+ # @return An instance of Hash
80
+
81
+ def details
82
+ @details
83
+ end
84
+
85
+ # The method to set the value to details
86
+ # @param details [Hash] An instance of Hash
87
+
88
+ def details=(details)
89
+ if details!=nil and !details.is_a? Hash
90
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
91
+ end
92
+ @details = details
93
+ @key_modified['details'] = 1
94
+ end
95
+
96
+ # The method to check if the user has modified the given key
97
+ # @param key [String] A String
98
+ # @return A Integer value
99
+
100
+ def is_key_modified(key)
101
+ if key!=nil and !key.is_a? String
102
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
103
+ end
104
+ if @key_modified.key?(key)
105
+ return @key_modified[key]
106
+ end
107
+
108
+ nil
109
+ end
110
+
111
+ # The method to mark the given key as modified
112
+ # @param key [String] A String
113
+ # @param modification [Integer] A Integer
114
+
115
+ def set_key_modified(key, modification)
116
+ if key!=nil and !key.is_a? String
117
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
118
+ end
119
+ if modification!=nil and !modification.is_a? Integer
120
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
121
+ end
122
+ @key_modified[key] = modification
123
+ end
124
+
125
+ end
126
+ end
127
+ end