ZOHOCRMSDK2_1 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (457) hide show
  1. checksums.yaml +7 -0
  2. data/src/ZOHOCRMSDK2_1.rb +453 -0
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +285 -0
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +193 -0
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +239 -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 +80 -0
  9. data/src/com/zoho/crm/api/assignment_rules/api_exception.rb +123 -0
  10. data/src/com/zoho/crm/api/assignment_rules/assignment_rule.rb +217 -0
  11. data/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.rb +63 -0
  12. data/src/com/zoho/crm/api/assignment_rules/default_user.rb +82 -0
  13. data/src/com/zoho/crm/api/assignment_rules/response_handler.rb +12 -0
  14. data/src/com/zoho/crm/api/assignment_rules/response_wrapper.rb +65 -0
  15. data/src/com/zoho/crm/api/attachments/action_handler.rb +12 -0
  16. data/src/com/zoho/crm/api/attachments/action_response.rb +12 -0
  17. data/src/com/zoho/crm/api/attachments/action_wrapper.rb +65 -0
  18. data/src/com/zoho/crm/api/attachments/api_exception.rb +127 -0
  19. data/src/com/zoho/crm/api/attachments/attachment.rb +407 -0
  20. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +198 -0
  21. data/src/com/zoho/crm/api/attachments/file_body_wrapper.rb +66 -0
  22. data/src/com/zoho/crm/api/attachments/response_handler.rb +12 -0
  23. data/src/com/zoho/crm/api/attachments/response_wrapper.rb +85 -0
  24. data/src/com/zoho/crm/api/attachments/success_response.rb +123 -0
  25. data/src/com/zoho/crm/api/blue_print/action_response.rb +12 -0
  26. data/src/com/zoho/crm/api/blue_print/api_exception.rb +125 -0
  27. data/src/com/zoho/crm/api/blue_print/blue_print.rb +121 -0
  28. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +69 -0
  29. data/src/com/zoho/crm/api/blue_print/body_wrapper.rb +63 -0
  30. data/src/com/zoho/crm/api/blue_print/escalation.rb +82 -0
  31. data/src/com/zoho/crm/api/blue_print/field.rb +1129 -0
  32. data/src/com/zoho/crm/api/blue_print/next_transition.rb +120 -0
  33. data/src/com/zoho/crm/api/blue_print/process_info.rb +253 -0
  34. data/src/com/zoho/crm/api/blue_print/response_handler.rb +12 -0
  35. data/src/com/zoho/crm/api/blue_print/response_wrapper.rb +65 -0
  36. data/src/com/zoho/crm/api/blue_print/success_response.rb +123 -0
  37. data/src/com/zoho/crm/api/blue_print/transition.rb +273 -0
  38. data/src/com/zoho/crm/api/blue_print/validation_error.rb +139 -0
  39. data/src/com/zoho/crm/api/bulk_read/action_handler.rb +12 -0
  40. data/src/com/zoho/crm/api/bulk_read/action_response.rb +12 -0
  41. data/src/com/zoho/crm/api/bulk_read/action_wrapper.rb +84 -0
  42. data/src/com/zoho/crm/api/bulk_read/api_exception.rb +127 -0
  43. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +76 -0
  44. data/src/com/zoho/crm/api/bulk_read/call_back.rb +83 -0
  45. data/src/com/zoho/crm/api/bulk_read/criteria.rb +157 -0
  46. data/src/com/zoho/crm/api/bulk_read/file_body_wrapper.rb +66 -0
  47. data/src/com/zoho/crm/api/bulk_read/job_detail.rb +198 -0
  48. data/src/com/zoho/crm/api/bulk_read/query.rb +140 -0
  49. data/src/com/zoho/crm/api/bulk_read/request_wrapper.rb +102 -0
  50. data/src/com/zoho/crm/api/bulk_read/response_handler.rb +12 -0
  51. data/src/com/zoho/crm/api/bulk_read/response_wrapper.rb +65 -0
  52. data/src/com/zoho/crm/api/bulk_read/result.rb +139 -0
  53. data/src/com/zoho/crm/api/bulk_read/success_response.rb +123 -0
  54. data/src/com/zoho/crm/api/bulk_write/action_response.rb +12 -0
  55. data/src/com/zoho/crm/api/bulk_write/api_exception.rb +241 -0
  56. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +114 -0
  57. data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb +218 -0
  58. data/src/com/zoho/crm/api/bulk_write/call_back.rb +83 -0
  59. data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +158 -0
  60. data/src/com/zoho/crm/api/bulk_write/file.rb +159 -0
  61. data/src/com/zoho/crm/api/bulk_write/file_body_wrapper.rb +66 -0
  62. data/src/com/zoho/crm/api/bulk_write/request_wrapper.rb +121 -0
  63. data/src/com/zoho/crm/api/bulk_write/resource.rb +217 -0
  64. data/src/com/zoho/crm/api/bulk_write/response_handler.rb +12 -0
  65. data/src/com/zoho/crm/api/bulk_write/response_wrapper.rb +12 -0
  66. data/src/com/zoho/crm/api/bulk_write/result.rb +63 -0
  67. data/src/com/zoho/crm/api/bulk_write/success_response.rb +123 -0
  68. data/src/com/zoho/crm/api/contact_roles/action_handler.rb +12 -0
  69. data/src/com/zoho/crm/api/contact_roles/action_response.rb +12 -0
  70. data/src/com/zoho/crm/api/contact_roles/action_wrapper.rb +65 -0
  71. data/src/com/zoho/crm/api/contact_roles/api_exception.rb +131 -0
  72. data/src/com/zoho/crm/api/contact_roles/body_wrapper.rb +63 -0
  73. data/src/com/zoho/crm/api/contact_roles/contact_role.rb +101 -0
  74. data/src/com/zoho/crm/api/contact_roles/contact_role_wrapper.rb +63 -0
  75. data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +281 -0
  76. data/src/com/zoho/crm/api/contact_roles/record_action_handler.rb +12 -0
  77. data/src/com/zoho/crm/api/contact_roles/record_action_wrapper.rb +65 -0
  78. data/src/com/zoho/crm/api/contact_roles/record_body_wrapper.rb +63 -0
  79. data/src/com/zoho/crm/api/contact_roles/record_response_handler.rb +12 -0
  80. data/src/com/zoho/crm/api/contact_roles/record_response_wrapper.rb +86 -0
  81. data/src/com/zoho/crm/api/contact_roles/response_handler.rb +12 -0
  82. data/src/com/zoho/crm/api/contact_roles/response_wrapper.rb +65 -0
  83. data/src/com/zoho/crm/api/contact_roles/success_response.rb +123 -0
  84. data/src/com/zoho/crm/api/currencies/action_handler.rb +12 -0
  85. data/src/com/zoho/crm/api/currencies/action_response.rb +12 -0
  86. data/src/com/zoho/crm/api/currencies/action_wrapper.rb +65 -0
  87. data/src/com/zoho/crm/api/currencies/api_exception.rb +129 -0
  88. data/src/com/zoho/crm/api/currencies/base_currency_action_handler.rb +12 -0
  89. data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb +65 -0
  90. data/src/com/zoho/crm/api/currencies/base_currency_wrapper.rb +63 -0
  91. data/src/com/zoho/crm/api/currencies/body_wrapper.rb +63 -0
  92. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +158 -0
  93. data/src/com/zoho/crm/api/currencies/currency.rb +292 -0
  94. data/src/com/zoho/crm/api/currencies/format.rb +102 -0
  95. data/src/com/zoho/crm/api/currencies/response_handler.rb +12 -0
  96. data/src/com/zoho/crm/api/currencies/response_wrapper.rb +65 -0
  97. data/src/com/zoho/crm/api/currencies/success_response.rb +123 -0
  98. data/src/com/zoho/crm/api/custom_views/api_exception.rb +123 -0
  99. data/src/com/zoho/crm/api/custom_views/criteria.rb +138 -0
  100. data/src/com/zoho/crm/api/custom_views/custom_view.rb +407 -0
  101. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +77 -0
  102. data/src/com/zoho/crm/api/custom_views/info.rb +158 -0
  103. data/src/com/zoho/crm/api/custom_views/range.rb +82 -0
  104. data/src/com/zoho/crm/api/custom_views/response_handler.rb +12 -0
  105. data/src/com/zoho/crm/api/custom_views/response_wrapper.rb +84 -0
  106. data/src/com/zoho/crm/api/custom_views/shared_to.rb +120 -0
  107. data/src/com/zoho/crm/api/custom_views/translation.rb +120 -0
  108. data/src/com/zoho/crm/api/dc/au_datacenter.rb +21 -0
  109. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +21 -0
  110. data/src/com/zoho/crm/api/dc/datacenter.rb +23 -0
  111. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +21 -0
  112. data/src/com/zoho/crm/api/dc/in_datacenter.rb +21 -0
  113. data/src/com/zoho/crm/api/dc/us_datacenter.rb +21 -0
  114. data/src/com/zoho/crm/api/email_templates/api_exception.rb +123 -0
  115. data/src/com/zoho/crm/api/email_templates/attachment.rb +120 -0
  116. data/src/com/zoho/crm/api/email_templates/email_template.rb +392 -0
  117. data/src/com/zoho/crm/api/email_templates/email_templates_operations.rb +63 -0
  118. data/src/com/zoho/crm/api/email_templates/response_handler.rb +12 -0
  119. data/src/com/zoho/crm/api/email_templates/response_wrapper.rb +85 -0
  120. data/src/com/zoho/crm/api/exception/sdk_exception.rb +49 -0
  121. data/src/com/zoho/crm/api/field_attachments/api_exception.rb +123 -0
  122. data/src/com/zoho/crm/api/field_attachments/body_wrapper.rb +64 -0
  123. data/src/com/zoho/crm/api/field_attachments/field_attachments_operations.rb +54 -0
  124. data/src/com/zoho/crm/api/field_attachments/file_body_wrapper.rb +66 -0
  125. data/src/com/zoho/crm/api/field_attachments/response_handler.rb +12 -0
  126. data/src/com/zoho/crm/api/fields/api_exception.rb +123 -0
  127. data/src/com/zoho/crm/api/fields/association_details.rb +82 -0
  128. data/src/com/zoho/crm/api/fields/auto_number.rb +101 -0
  129. data/src/com/zoho/crm/api/fields/crypt.rb +158 -0
  130. data/src/com/zoho/crm/api/fields/currency.rb +82 -0
  131. data/src/com/zoho/crm/api/fields/external.rb +101 -0
  132. data/src/com/zoho/crm/api/fields/field.rb +1131 -0
  133. data/src/com/zoho/crm/api/fields/fields_operations.rb +73 -0
  134. data/src/com/zoho/crm/api/fields/formula.rb +82 -0
  135. data/src/com/zoho/crm/api/fields/history_tracking.rb +82 -0
  136. data/src/com/zoho/crm/api/fields/lookup_field.rb +82 -0
  137. data/src/com/zoho/crm/api/fields/maps.rb +82 -0
  138. data/src/com/zoho/crm/api/fields/module.rb +159 -0
  139. data/src/com/zoho/crm/api/fields/multi_module_lookup.rb +101 -0
  140. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +177 -0
  141. data/src/com/zoho/crm/api/fields/multi_user_lookup.rb +177 -0
  142. data/src/com/zoho/crm/api/fields/pick_list_value.rb +253 -0
  143. data/src/com/zoho/crm/api/fields/private.rb +101 -0
  144. data/src/com/zoho/crm/api/fields/related_details.rb +158 -0
  145. data/src/com/zoho/crm/api/fields/response_handler.rb +12 -0
  146. data/src/com/zoho/crm/api/fields/response_wrapper.rb +65 -0
  147. data/src/com/zoho/crm/api/fields/tool_tip.rb +82 -0
  148. data/src/com/zoho/crm/api/fields/unique.rb +63 -0
  149. data/src/com/zoho/crm/api/fields/view_type.rb +120 -0
  150. data/src/com/zoho/crm/api/files/action_handler.rb +12 -0
  151. data/src/com/zoho/crm/api/files/action_response.rb +12 -0
  152. data/src/com/zoho/crm/api/files/action_wrapper.rb +65 -0
  153. data/src/com/zoho/crm/api/files/api_exception.rb +127 -0
  154. data/src/com/zoho/crm/api/files/body_wrapper.rb +64 -0
  155. data/src/com/zoho/crm/api/files/file_body_wrapper.rb +66 -0
  156. data/src/com/zoho/crm/api/files/file_operations.rb +77 -0
  157. data/src/com/zoho/crm/api/files/response_handler.rb +12 -0
  158. data/src/com/zoho/crm/api/files/success_response.rb +123 -0
  159. data/src/com/zoho/crm/api/header.rb +12 -0
  160. data/src/com/zoho/crm/api/header_map.rb +57 -0
  161. data/src/com/zoho/crm/api/initializer.rb +232 -0
  162. data/src/com/zoho/crm/api/inventory_templates/api_exception.rb +123 -0
  163. data/src/com/zoho/crm/api/inventory_templates/inventory_template.rb +354 -0
  164. data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb +87 -0
  165. data/src/com/zoho/crm/api/inventory_templates/response_handler.rb +12 -0
  166. data/src/com/zoho/crm/api/inventory_templates/response_wrapper.rb +85 -0
  167. data/src/com/zoho/crm/api/layouts/api_exception.rb +123 -0
  168. data/src/com/zoho/crm/api/layouts/layout.rb +312 -0
  169. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +63 -0
  170. data/src/com/zoho/crm/api/layouts/properties.rb +102 -0
  171. data/src/com/zoho/crm/api/layouts/response_handler.rb +12 -0
  172. data/src/com/zoho/crm/api/layouts/response_wrapper.rb +65 -0
  173. data/src/com/zoho/crm/api/layouts/section.rb +254 -0
  174. data/src/com/zoho/crm/api/modules/action_handler.rb +12 -0
  175. data/src/com/zoho/crm/api/modules/action_response.rb +12 -0
  176. data/src/com/zoho/crm/api/modules/action_wrapper.rb +65 -0
  177. data/src/com/zoho/crm/api/modules/api_exception.rb +127 -0
  178. data/src/com/zoho/crm/api/modules/argument.rb +82 -0
  179. data/src/com/zoho/crm/api/modules/body_wrapper.rb +63 -0
  180. data/src/com/zoho/crm/api/modules/module.rb +941 -0
  181. data/src/com/zoho/crm/api/modules/modules_operations.rb +113 -0
  182. data/src/com/zoho/crm/api/modules/related_list_properties.rb +101 -0
  183. data/src/com/zoho/crm/api/modules/response_handler.rb +12 -0
  184. data/src/com/zoho/crm/api/modules/response_wrapper.rb +65 -0
  185. data/src/com/zoho/crm/api/modules/success_response.rb +123 -0
  186. data/src/com/zoho/crm/api/modules/territory.rb +101 -0
  187. data/src/com/zoho/crm/api/notes/action_handler.rb +12 -0
  188. data/src/com/zoho/crm/api/notes/action_response.rb +12 -0
  189. data/src/com/zoho/crm/api/notes/action_wrapper.rb +65 -0
  190. data/src/com/zoho/crm/api/notes/api_exception.rb +127 -0
  191. data/src/com/zoho/crm/api/notes/body_wrapper.rb +63 -0
  192. data/src/com/zoho/crm/api/notes/info.rb +120 -0
  193. data/src/com/zoho/crm/api/notes/note.rb +370 -0
  194. data/src/com/zoho/crm/api/notes/notes_operations.rb +229 -0
  195. data/src/com/zoho/crm/api/notes/response_handler.rb +12 -0
  196. data/src/com/zoho/crm/api/notes/response_wrapper.rb +84 -0
  197. data/src/com/zoho/crm/api/notes/success_response.rb +123 -0
  198. data/src/com/zoho/crm/api/notification/action_handler.rb +12 -0
  199. data/src/com/zoho/crm/api/notification/action_response.rb +12 -0
  200. data/src/com/zoho/crm/api/notification/action_wrapper.rb +65 -0
  201. data/src/com/zoho/crm/api/notification/api_exception.rb +127 -0
  202. data/src/com/zoho/crm/api/notification/body_wrapper.rb +63 -0
  203. data/src/com/zoho/crm/api/notification/info.rb +120 -0
  204. data/src/com/zoho/crm/api/notification/notification.rb +253 -0
  205. data/src/com/zoho/crm/api/notification/notification_operations.rb +166 -0
  206. data/src/com/zoho/crm/api/notification/response_handler.rb +12 -0
  207. data/src/com/zoho/crm/api/notification/response_wrapper.rb +84 -0
  208. data/src/com/zoho/crm/api/notification/success_response.rb +123 -0
  209. data/src/com/zoho/crm/api/org/action_response.rb +12 -0
  210. data/src/com/zoho/crm/api/org/api_exception.rb +125 -0
  211. data/src/com/zoho/crm/api/org/file_body_wrapper.rb +64 -0
  212. data/src/com/zoho/crm/api/org/hierarchy_preference.rb +63 -0
  213. data/src/com/zoho/crm/api/org/license_details.rb +158 -0
  214. data/src/com/zoho/crm/api/org/org.rb +671 -0
  215. data/src/com/zoho/crm/api/org/org_operations.rb +51 -0
  216. data/src/com/zoho/crm/api/org/response_handler.rb +12 -0
  217. data/src/com/zoho/crm/api/org/response_wrapper.rb +65 -0
  218. data/src/com/zoho/crm/api/org/success_response.rb +123 -0
  219. data/src/com/zoho/crm/api/param.rb +12 -0
  220. data/src/com/zoho/crm/api/parameter_map.rb +56 -0
  221. data/src/com/zoho/crm/api/pipeline/action_handler.rb +12 -0
  222. data/src/com/zoho/crm/api/pipeline/action_response.rb +12 -0
  223. data/src/com/zoho/crm/api/pipeline/action_wrapper.rb +65 -0
  224. data/src/com/zoho/crm/api/pipeline/api_exception.rb +131 -0
  225. data/src/com/zoho/crm/api/pipeline/body_wrapper.rb +63 -0
  226. data/src/com/zoho/crm/api/pipeline/forecast_category.rb +82 -0
  227. data/src/com/zoho/crm/api/pipeline/pick_list_value.rb +177 -0
  228. data/src/com/zoho/crm/api/pipeline/pipeline.rb +215 -0
  229. data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb +167 -0
  230. data/src/com/zoho/crm/api/pipeline/response_handler.rb +12 -0
  231. data/src/com/zoho/crm/api/pipeline/response_wrapper.rb +65 -0
  232. data/src/com/zoho/crm/api/pipeline/stage.rb +82 -0
  233. data/src/com/zoho/crm/api/pipeline/success_response.rb +125 -0
  234. data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb +12 -0
  235. data/src/com/zoho/crm/api/pipeline/transfer_action_response.rb +12 -0
  236. data/src/com/zoho/crm/api/pipeline/transfer_action_wrapper.rb +65 -0
  237. data/src/com/zoho/crm/api/pipeline/transfer_and_delete_wrapper.rb +63 -0
  238. data/src/com/zoho/crm/api/pipeline/transfer_pipe_line.rb +82 -0
  239. data/src/com/zoho/crm/api/profiles/api_exception.rb +123 -0
  240. data/src/com/zoho/crm/api/profiles/category.rb +120 -0
  241. data/src/com/zoho/crm/api/profiles/default_view.rb +101 -0
  242. data/src/com/zoho/crm/api/profiles/permission_detail.rb +139 -0
  243. data/src/com/zoho/crm/api/profiles/profile.rb +330 -0
  244. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +63 -0
  245. data/src/com/zoho/crm/api/profiles/response_handler.rb +12 -0
  246. data/src/com/zoho/crm/api/profiles/response_wrapper.rb +65 -0
  247. data/src/com/zoho/crm/api/profiles/section.rb +82 -0
  248. data/src/com/zoho/crm/api/query/api_exception.rb +123 -0
  249. data/src/com/zoho/crm/api/query/body_wrapper.rb +63 -0
  250. data/src/com/zoho/crm/api/query/query_operations.rb +37 -0
  251. data/src/com/zoho/crm/api/query/response_handler.rb +12 -0
  252. data/src/com/zoho/crm/api/query/response_wrapper.rb +86 -0
  253. data/src/com/zoho/crm/api/record/action_handler.rb +12 -0
  254. data/src/com/zoho/crm/api/record/action_response.rb +12 -0
  255. data/src/com/zoho/crm/api/record/action_wrapper.rb +65 -0
  256. data/src/com/zoho/crm/api/record/api_exception.rb +147 -0
  257. data/src/com/zoho/crm/api/record/body_wrapper.rb +158 -0
  258. data/src/com/zoho/crm/api/record/carry_over_tags.rb +101 -0
  259. data/src/com/zoho/crm/api/record/comment.rb +120 -0
  260. data/src/com/zoho/crm/api/record/consent.rb +187 -0
  261. data/src/com/zoho/crm/api/record/convert_action_handler.rb +12 -0
  262. data/src/com/zoho/crm/api/record/convert_action_response.rb +12 -0
  263. data/src/com/zoho/crm/api/record/convert_action_wrapper.rb +65 -0
  264. data/src/com/zoho/crm/api/record/convert_body_wrapper.rb +63 -0
  265. data/src/com/zoho/crm/api/record/count_handler.rb +12 -0
  266. data/src/com/zoho/crm/api/record/count_wrapper.rb +65 -0
  267. data/src/com/zoho/crm/api/record/criteria.rb +137 -0
  268. data/src/com/zoho/crm/api/record/deleted_record.rb +159 -0
  269. data/src/com/zoho/crm/api/record/deleted_records_handler.rb +12 -0
  270. data/src/com/zoho/crm/api/record/deleted_records_wrapper.rb +84 -0
  271. data/src/com/zoho/crm/api/record/download_handler.rb +12 -0
  272. data/src/com/zoho/crm/api/record/field.rb +2111 -0
  273. data/src/com/zoho/crm/api/record/file_body_wrapper.rb +68 -0
  274. data/src/com/zoho/crm/api/record/file_details.rb +329 -0
  275. data/src/com/zoho/crm/api/record/file_handler.rb +12 -0
  276. data/src/com/zoho/crm/api/record/image_upload.rb +215 -0
  277. data/src/com/zoho/crm/api/record/info.rb +120 -0
  278. data/src/com/zoho/crm/api/record/lead_converter.rb +196 -0
  279. data/src/com/zoho/crm/api/record/line_item_product.rb +67 -0
  280. data/src/com/zoho/crm/api/record/line_tax.rb +139 -0
  281. data/src/com/zoho/crm/api/record/mass_update.rb +142 -0
  282. data/src/com/zoho/crm/api/record/mass_update_action_handler.rb +12 -0
  283. data/src/com/zoho/crm/api/record/mass_update_action_response.rb +12 -0
  284. data/src/com/zoho/crm/api/record/mass_update_action_wrapper.rb +65 -0
  285. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +158 -0
  286. data/src/com/zoho/crm/api/record/mass_update_response.rb +12 -0
  287. data/src/com/zoho/crm/api/record/mass_update_response_handler.rb +12 -0
  288. data/src/com/zoho/crm/api/record/mass_update_response_wrapper.rb +65 -0
  289. data/src/com/zoho/crm/api/record/mass_update_success_response.rb +123 -0
  290. data/src/com/zoho/crm/api/record/mass_update_territory.rb +82 -0
  291. data/src/com/zoho/crm/api/record/multi_select_lookup.rb +101 -0
  292. data/src/com/zoho/crm/api/record/multi_select_picklist.rb +82 -0
  293. data/src/com/zoho/crm/api/record/options.rb +12 -0
  294. data/src/com/zoho/crm/api/record/participants.rb +118 -0
  295. data/src/com/zoho/crm/api/record/price_book.rb +33 -0
  296. data/src/com/zoho/crm/api/record/pricing_details.rb +67 -0
  297. data/src/com/zoho/crm/api/record/record.rb +194 -0
  298. data/src/com/zoho/crm/api/record/record_operations.rb +1132 -0
  299. data/src/com/zoho/crm/api/record/recurring_activity.rb +63 -0
  300. data/src/com/zoho/crm/api/record/remind_at.rb +63 -0
  301. data/src/com/zoho/crm/api/record/reminder.rb +82 -0
  302. data/src/com/zoho/crm/api/record/response_handler.rb +12 -0
  303. data/src/com/zoho/crm/api/record/response_wrapper.rb +84 -0
  304. data/src/com/zoho/crm/api/record/success_response.rb +163 -0
  305. data/src/com/zoho/crm/api/record/successful_convert.rb +103 -0
  306. data/src/com/zoho/crm/api/record/tax.rb +82 -0
  307. data/src/com/zoho/crm/api/record/territory.rb +140 -0
  308. data/src/com/zoho/crm/api/record/widget.rb +82 -0
  309. data/src/com/zoho/crm/api/record/wizard.rb +82 -0
  310. data/src/com/zoho/crm/api/related_lists/api_exception.rb +123 -0
  311. data/src/com/zoho/crm/api/related_lists/related_list.rb +253 -0
  312. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +63 -0
  313. data/src/com/zoho/crm/api/related_lists/response_handler.rb +12 -0
  314. data/src/com/zoho/crm/api/related_lists/response_wrapper.rb +65 -0
  315. data/src/com/zoho/crm/api/related_records/action_handler.rb +12 -0
  316. data/src/com/zoho/crm/api/related_records/action_response.rb +12 -0
  317. data/src/com/zoho/crm/api/related_records/action_wrapper.rb +65 -0
  318. data/src/com/zoho/crm/api/related_records/api_exception.rb +127 -0
  319. data/src/com/zoho/crm/api/related_records/body_wrapper.rb +64 -0
  320. data/src/com/zoho/crm/api/related_records/file_body_wrapper.rb +66 -0
  321. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +524 -0
  322. data/src/com/zoho/crm/api/related_records/response_handler.rb +12 -0
  323. data/src/com/zoho/crm/api/related_records/response_wrapper.rb +86 -0
  324. data/src/com/zoho/crm/api/related_records/success_response.rb +123 -0
  325. data/src/com/zoho/crm/api/request_proxy.rb +17 -0
  326. data/src/com/zoho/crm/api/roles/api_exception.rb +123 -0
  327. data/src/com/zoho/crm/api/roles/response_handler.rb +12 -0
  328. data/src/com/zoho/crm/api/roles/response_wrapper.rb +65 -0
  329. data/src/com/zoho/crm/api/roles/role.rb +197 -0
  330. data/src/com/zoho/crm/api/roles/roles_operations.rb +49 -0
  331. data/src/com/zoho/crm/api/sdk_config.rb +15 -0
  332. data/src/com/zoho/crm/api/send_mail/action_handler.rb +12 -0
  333. data/src/com/zoho/crm/api/send_mail/action_response.rb +12 -0
  334. data/src/com/zoho/crm/api/send_mail/action_wrapper.rb +65 -0
  335. data/src/com/zoho/crm/api/send_mail/api_exception.rb +127 -0
  336. data/src/com/zoho/crm/api/send_mail/body_wrapper.rb +63 -0
  337. data/src/com/zoho/crm/api/send_mail/data_subject_request.rb +82 -0
  338. data/src/com/zoho/crm/api/send_mail/inventory_details.rb +102 -0
  339. data/src/com/zoho/crm/api/send_mail/mail.rb +425 -0
  340. data/src/com/zoho/crm/api/send_mail/response_handler.rb +12 -0
  341. data/src/com/zoho/crm/api/send_mail/response_wrapper.rb +65 -0
  342. data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb +63 -0
  343. data/src/com/zoho/crm/api/send_mail/success_response.rb +123 -0
  344. data/src/com/zoho/crm/api/send_mail/template.rb +12 -0
  345. data/src/com/zoho/crm/api/send_mail/user_address.rb +139 -0
  346. data/src/com/zoho/crm/api/share_records/action_handler.rb +12 -0
  347. data/src/com/zoho/crm/api/share_records/action_response.rb +12 -0
  348. data/src/com/zoho/crm/api/share_records/action_wrapper.rb +65 -0
  349. data/src/com/zoho/crm/api/share_records/api_exception.rb +131 -0
  350. data/src/com/zoho/crm/api/share_records/body_wrapper.rb +63 -0
  351. data/src/com/zoho/crm/api/share_records/delete_action_handler.rb +12 -0
  352. data/src/com/zoho/crm/api/share_records/delete_action_response.rb +12 -0
  353. data/src/com/zoho/crm/api/share_records/delete_action_wrapper.rb +65 -0
  354. data/src/com/zoho/crm/api/share_records/response_handler.rb +12 -0
  355. data/src/com/zoho/crm/api/share_records/response_wrapper.rb +85 -0
  356. data/src/com/zoho/crm/api/share_records/share_record.rb +159 -0
  357. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +130 -0
  358. data/src/com/zoho/crm/api/share_records/shared_through.rb +102 -0
  359. data/src/com/zoho/crm/api/share_records/success_response.rb +125 -0
  360. data/src/com/zoho/crm/api/tags/action_handler.rb +12 -0
  361. data/src/com/zoho/crm/api/tags/action_response.rb +12 -0
  362. data/src/com/zoho/crm/api/tags/action_wrapper.rb +65 -0
  363. data/src/com/zoho/crm/api/tags/api_exception.rb +133 -0
  364. data/src/com/zoho/crm/api/tags/body_wrapper.rb +63 -0
  365. data/src/com/zoho/crm/api/tags/conflict_wrapper.rb +63 -0
  366. data/src/com/zoho/crm/api/tags/count_handler.rb +12 -0
  367. data/src/com/zoho/crm/api/tags/count_wrapper.rb +65 -0
  368. data/src/com/zoho/crm/api/tags/info.rb +82 -0
  369. data/src/com/zoho/crm/api/tags/merge_wrapper.rb +63 -0
  370. data/src/com/zoho/crm/api/tags/record_action_handler.rb +12 -0
  371. data/src/com/zoho/crm/api/tags/record_action_response.rb +12 -0
  372. data/src/com/zoho/crm/api/tags/record_action_wrapper.rb +122 -0
  373. data/src/com/zoho/crm/api/tags/response_handler.rb +12 -0
  374. data/src/com/zoho/crm/api/tags/response_wrapper.rb +84 -0
  375. data/src/com/zoho/crm/api/tags/success_response.rb +125 -0
  376. data/src/com/zoho/crm/api/tags/tag.rb +178 -0
  377. data/src/com/zoho/crm/api/tags/tags_operations.rb +389 -0
  378. data/src/com/zoho/crm/api/taxes/action_handler.rb +12 -0
  379. data/src/com/zoho/crm/api/taxes/action_response.rb +12 -0
  380. data/src/com/zoho/crm/api/taxes/action_wrapper.rb +65 -0
  381. data/src/com/zoho/crm/api/taxes/api_exception.rb +127 -0
  382. data/src/com/zoho/crm/api/taxes/body_wrapper.rb +63 -0
  383. data/src/com/zoho/crm/api/taxes/preference.rb +82 -0
  384. data/src/com/zoho/crm/api/taxes/response_handler.rb +12 -0
  385. data/src/com/zoho/crm/api/taxes/response_wrapper.rb +84 -0
  386. data/src/com/zoho/crm/api/taxes/success_response.rb +123 -0
  387. data/src/com/zoho/crm/api/taxes/tax.rb +139 -0
  388. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +138 -0
  389. data/src/com/zoho/crm/api/territories/api_exception.rb +123 -0
  390. data/src/com/zoho/crm/api/territories/response_handler.rb +12 -0
  391. data/src/com/zoho/crm/api/territories/response_wrapper.rb +85 -0
  392. data/src/com/zoho/crm/api/territories/territories_operations.rb +49 -0
  393. data/src/com/zoho/crm/api/territories/territory.rb +274 -0
  394. data/src/com/zoho/crm/api/user_signature.rb +29 -0
  395. data/src/com/zoho/crm/api/users/action_handler.rb +12 -0
  396. data/src/com/zoho/crm/api/users/action_response.rb +12 -0
  397. data/src/com/zoho/crm/api/users/action_wrapper.rb +65 -0
  398. data/src/com/zoho/crm/api/users/api_exception.rb +127 -0
  399. data/src/com/zoho/crm/api/users/body_wrapper.rb +63 -0
  400. data/src/com/zoho/crm/api/users/customize_info.rb +158 -0
  401. data/src/com/zoho/crm/api/users/info.rb +120 -0
  402. data/src/com/zoho/crm/api/users/request_wrapper.rb +63 -0
  403. data/src/com/zoho/crm/api/users/response_handler.rb +12 -0
  404. data/src/com/zoho/crm/api/users/response_wrapper.rb +84 -0
  405. data/src/com/zoho/crm/api/users/shift.rb +82 -0
  406. data/src/com/zoho/crm/api/users/success_response.rb +123 -0
  407. data/src/com/zoho/crm/api/users/tab_theme.rb +82 -0
  408. data/src/com/zoho/crm/api/users/territory.rb +101 -0
  409. data/src/com/zoho/crm/api/users/theme.rb +158 -0
  410. data/src/com/zoho/crm/api/users/user.rb +749 -0
  411. data/src/com/zoho/crm/api/users/users_operations.rb +183 -0
  412. data/src/com/zoho/crm/api/util/api_http_connector.rb +114 -0
  413. data/src/com/zoho/crm/api/util/api_response.rb +18 -0
  414. data/src/com/zoho/crm/api/util/choice.rb +11 -0
  415. data/src/com/zoho/crm/api/util/common_api_handler.rb +241 -0
  416. data/src/com/zoho/crm/api/util/constants.rb +676 -0
  417. data/src/com/zoho/crm/api/util/converter.rb +238 -0
  418. data/src/com/zoho/crm/api/util/data_type_converter.rb +170 -0
  419. data/src/com/zoho/crm/api/util/downloader.rb +86 -0
  420. data/src/com/zoho/crm/api/util/form_data_converter.rb +159 -0
  421. data/src/com/zoho/crm/api/util/header_param_validator.rb +57 -0
  422. data/src/com/zoho/crm/api/util/json_converter.rb +731 -0
  423. data/src/com/zoho/crm/api/util/model.rb +7 -0
  424. data/src/com/zoho/crm/api/util/module_fields_handler.rb +80 -0
  425. data/src/com/zoho/crm/api/util/stream_wrapper.rb +39 -0
  426. data/src/com/zoho/crm/api/util/utility.rb +927 -0
  427. data/src/com/zoho/crm/api/variable_groups/api_exception.rb +123 -0
  428. data/src/com/zoho/crm/api/variable_groups/response_handler.rb +12 -0
  429. data/src/com/zoho/crm/api/variable_groups/response_wrapper.rb +65 -0
  430. data/src/com/zoho/crm/api/variable_groups/variable_group.rb +139 -0
  431. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +68 -0
  432. data/src/com/zoho/crm/api/variables/action_handler.rb +12 -0
  433. data/src/com/zoho/crm/api/variables/action_response.rb +12 -0
  434. data/src/com/zoho/crm/api/variables/action_wrapper.rb +65 -0
  435. data/src/com/zoho/crm/api/variables/api_exception.rb +127 -0
  436. data/src/com/zoho/crm/api/variables/body_wrapper.rb +63 -0
  437. data/src/com/zoho/crm/api/variables/response_handler.rb +12 -0
  438. data/src/com/zoho/crm/api/variables/response_wrapper.rb +65 -0
  439. data/src/com/zoho/crm/api/variables/success_response.rb +123 -0
  440. data/src/com/zoho/crm/api/variables/variable.rb +194 -0
  441. data/src/com/zoho/crm/api/variables/variables_operations.rb +243 -0
  442. data/src/com/zoho/crm/api/wizards/api_exception.rb +123 -0
  443. data/src/com/zoho/crm/api/wizards/button.rb +254 -0
  444. data/src/com/zoho/crm/api/wizards/chart_data.rb +120 -0
  445. data/src/com/zoho/crm/api/wizards/connection.rb +82 -0
  446. data/src/com/zoho/crm/api/wizards/container.rb +121 -0
  447. data/src/com/zoho/crm/api/wizards/node.rb +120 -0
  448. data/src/com/zoho/crm/api/wizards/response_handler.rb +12 -0
  449. data/src/com/zoho/crm/api/wizards/response_wrapper.rb +65 -0
  450. data/src/com/zoho/crm/api/wizards/screen.rb +101 -0
  451. data/src/com/zoho/crm/api/wizards/segment.rb +178 -0
  452. data/src/com/zoho/crm/api/wizards/transition.rb +82 -0
  453. data/src/com/zoho/crm/api/wizards/wizard.rb +275 -0
  454. data/src/com/zoho/crm/api/wizards/wizards_operations.rb +63 -0
  455. data/src/resources/JSONDetails.json +1 -0
  456. data/src/version.rb +3 -0
  457. metadata +597 -0
@@ -0,0 +1,1132 @@
1
+ require_relative '../header'
2
+ require_relative '../header_map'
3
+ require_relative '../param'
4
+ require_relative '../parameter_map'
5
+ require_relative '../exception/sdk_exception'
6
+ require_relative '../util/api_response'
7
+ require_relative '../util/common_api_handler'
8
+ require_relative '../util/utility'
9
+ require_relative '../util/constants'
10
+
11
+ module ZOHOCRMSDK
12
+ module Record
13
+ class RecordOperations
14
+
15
+ # Creates an instance of RecordOperations
16
+ def initialize
17
+ end
18
+
19
+ # The method to get record
20
+ # @param id [Integer] A Integer
21
+ # @param module_api_name [String] A String
22
+ # @param param_instance [ParameterMap] An instance of ParameterMap
23
+ # @param header_instance [HeaderMap] An instance of HeaderMap
24
+ # @return An instance of APIResponse
25
+ # @raise SDKException
26
+ def get_record(id, module_api_name, param_instance=nil, header_instance=nil)
27
+ if !id.is_a? Integer
28
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
29
+ end
30
+ if !module_api_name.is_a? String
31
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
32
+ end
33
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
34
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
35
+ end
36
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
37
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
38
+ end
39
+ handler_instance = Handler::CommonAPIHandler.new
40
+ api_path = ''
41
+ api_path = api_path + '/crm/v2.1/'
42
+ api_path = api_path + module_api_name.to_s
43
+ api_path = api_path + '/'
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.param = param_instance
49
+ handler_instance.header = header_instance
50
+ handler_instance.module_api_name = module_api_name
51
+ Util::Utility.get_fields(module_api_name, handler_instance)
52
+ require_relative 'response_handler'
53
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
54
+ end
55
+
56
+ # The method to update record
57
+ # @param id [Integer] A Integer
58
+ # @param module_api_name [String] A String
59
+ # @param request [BodyWrapper] An instance of BodyWrapper
60
+ # @param header_instance [HeaderMap] An instance of HeaderMap
61
+ # @return An instance of APIResponse
62
+ # @raise SDKException
63
+ def update_record(id, module_api_name, request, header_instance=nil)
64
+ if !id.is_a? Integer
65
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
66
+ end
67
+ if !module_api_name.is_a? String
68
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
69
+ end
70
+ if request!=nil and !request.is_a? BodyWrapper
71
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
72
+ end
73
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
74
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
75
+ end
76
+ handler_instance = Handler::CommonAPIHandler.new
77
+ api_path = ''
78
+ api_path = api_path + '/crm/v2.1/'
79
+ api_path = api_path + module_api_name.to_s
80
+ api_path = api_path + '/'
81
+ api_path = api_path + id.to_s
82
+ handler_instance.api_path = api_path
83
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
84
+ handler_instance.category_method = 'UPDATE'
85
+ handler_instance.content_type = 'application/json'
86
+ handler_instance.request = request
87
+ handler_instance.header = header_instance
88
+ handler_instance.module_api_name = module_api_name
89
+ Util::Utility.get_fields(module_api_name, handler_instance)
90
+ require_relative 'action_handler'
91
+ handler_instance.api_call(ActionHandler.name, 'application/json')
92
+ end
93
+
94
+ # The method to delete record
95
+ # @param id [Integer] A Integer
96
+ # @param module_api_name [String] A String
97
+ # @param param_instance [ParameterMap] An instance of ParameterMap
98
+ # @param header_instance [HeaderMap] An instance of HeaderMap
99
+ # @return An instance of APIResponse
100
+ # @raise SDKException
101
+ def delete_record(id, module_api_name, param_instance=nil, header_instance=nil)
102
+ if !id.is_a? Integer
103
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
104
+ end
105
+ if !module_api_name.is_a? String
106
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
107
+ end
108
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
109
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
110
+ end
111
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
112
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
113
+ end
114
+ handler_instance = Handler::CommonAPIHandler.new
115
+ api_path = ''
116
+ api_path = api_path + '/crm/v2.1/'
117
+ api_path = api_path + module_api_name.to_s
118
+ api_path = api_path + '/'
119
+ api_path = api_path + id.to_s
120
+ handler_instance.api_path = api_path
121
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
122
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
123
+ handler_instance.param = param_instance
124
+ handler_instance.header = header_instance
125
+ Util::Utility.get_fields(module_api_name, handler_instance)
126
+ require_relative 'action_handler'
127
+ handler_instance.api_call(ActionHandler.name, 'application/json')
128
+ end
129
+
130
+ # The method to get records
131
+ # @param module_api_name [String] A String
132
+ # @param param_instance [ParameterMap] An instance of ParameterMap
133
+ # @param header_instance [HeaderMap] An instance of HeaderMap
134
+ # @return An instance of APIResponse
135
+ # @raise SDKException
136
+ def get_records(module_api_name, param_instance=nil, header_instance=nil)
137
+ if !module_api_name.is_a? String
138
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
139
+ end
140
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
141
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
142
+ end
143
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
144
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
145
+ end
146
+ handler_instance = Handler::CommonAPIHandler.new
147
+ api_path = ''
148
+ api_path = api_path + '/crm/v2.1/'
149
+ api_path = api_path + module_api_name.to_s
150
+ handler_instance.api_path = api_path
151
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
152
+ handler_instance.category_method = 'READ'
153
+ handler_instance.param = param_instance
154
+ handler_instance.header = header_instance
155
+ handler_instance.module_api_name = module_api_name
156
+ Util::Utility.get_fields(module_api_name, handler_instance)
157
+ require_relative 'response_handler'
158
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
159
+ end
160
+
161
+ # The method to create records
162
+ # @param module_api_name [String] A String
163
+ # @param request [BodyWrapper] An instance of BodyWrapper
164
+ # @param header_instance [HeaderMap] An instance of HeaderMap
165
+ # @return An instance of APIResponse
166
+ # @raise SDKException
167
+ def create_records(module_api_name, request, header_instance=nil)
168
+ if !module_api_name.is_a? String
169
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
170
+ end
171
+ if request!=nil and !request.is_a? BodyWrapper
172
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
173
+ end
174
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
175
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
176
+ end
177
+ handler_instance = Handler::CommonAPIHandler.new
178
+ api_path = ''
179
+ api_path = api_path + '/crm/v2.1/'
180
+ api_path = api_path + module_api_name.to_s
181
+ handler_instance.api_path = api_path
182
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
183
+ handler_instance.category_method = 'CREATE'
184
+ handler_instance.content_type = 'application/json'
185
+ handler_instance.request = request
186
+ handler_instance.header = header_instance
187
+ handler_instance.module_api_name = module_api_name
188
+ Util::Utility.get_fields(module_api_name, handler_instance)
189
+ require_relative 'action_handler'
190
+ handler_instance.api_call(ActionHandler.name, 'application/json')
191
+ end
192
+
193
+ # The method to update records
194
+ # @param module_api_name [String] A String
195
+ # @param request [BodyWrapper] An instance of BodyWrapper
196
+ # @param header_instance [HeaderMap] An instance of HeaderMap
197
+ # @return An instance of APIResponse
198
+ # @raise SDKException
199
+ def update_records(module_api_name, request, header_instance=nil)
200
+ if !module_api_name.is_a? String
201
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
202
+ end
203
+ if request!=nil and !request.is_a? BodyWrapper
204
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
205
+ end
206
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
207
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
208
+ end
209
+ handler_instance = Handler::CommonAPIHandler.new
210
+ api_path = ''
211
+ api_path = api_path + '/crm/v2.1/'
212
+ api_path = api_path + module_api_name.to_s
213
+ handler_instance.api_path = api_path
214
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
215
+ handler_instance.category_method = 'UPDATE'
216
+ handler_instance.content_type = 'application/json'
217
+ handler_instance.request = request
218
+ handler_instance.header = header_instance
219
+ handler_instance.module_api_name = module_api_name
220
+ Util::Utility.get_fields(module_api_name, handler_instance)
221
+ require_relative 'action_handler'
222
+ handler_instance.api_call(ActionHandler.name, 'application/json')
223
+ end
224
+
225
+ # The method to delete records
226
+ # @param module_api_name [String] A String
227
+ # @param param_instance [ParameterMap] An instance of ParameterMap
228
+ # @param header_instance [HeaderMap] An instance of HeaderMap
229
+ # @return An instance of APIResponse
230
+ # @raise SDKException
231
+ def delete_records(module_api_name, param_instance=nil, header_instance=nil)
232
+ if !module_api_name.is_a? String
233
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
234
+ end
235
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
236
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
237
+ end
238
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
239
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
240
+ end
241
+ handler_instance = Handler::CommonAPIHandler.new
242
+ api_path = ''
243
+ api_path = api_path + '/crm/v2.1/'
244
+ api_path = api_path + module_api_name.to_s
245
+ handler_instance.api_path = api_path
246
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
247
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
248
+ handler_instance.param = param_instance
249
+ handler_instance.header = header_instance
250
+ Util::Utility.get_fields(module_api_name, handler_instance)
251
+ require_relative 'action_handler'
252
+ handler_instance.api_call(ActionHandler.name, 'application/json')
253
+ end
254
+
255
+ # The method to upsert records
256
+ # @param module_api_name [String] A String
257
+ # @param request [BodyWrapper] An instance of BodyWrapper
258
+ # @param header_instance [HeaderMap] An instance of HeaderMap
259
+ # @return An instance of APIResponse
260
+ # @raise SDKException
261
+ def upsert_records(module_api_name, request, header_instance=nil)
262
+ if !module_api_name.is_a? String
263
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
264
+ end
265
+ if request!=nil and !request.is_a? BodyWrapper
266
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
267
+ end
268
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
269
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
270
+ end
271
+ handler_instance = Handler::CommonAPIHandler.new
272
+ api_path = ''
273
+ api_path = api_path + '/crm/v2.1/'
274
+ api_path = api_path + module_api_name.to_s
275
+ api_path = api_path + '/upsert'
276
+ handler_instance.api_path = api_path
277
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
278
+ handler_instance.category_method = 'ACTION'
279
+ handler_instance.content_type = 'application/json'
280
+ handler_instance.request = request
281
+ handler_instance.header = header_instance
282
+ handler_instance.module_api_name = module_api_name
283
+ Util::Utility.get_fields(module_api_name, handler_instance)
284
+ require_relative 'action_handler'
285
+ handler_instance.api_call(ActionHandler.name, 'application/json')
286
+ end
287
+
288
+ # The method to get deleted records
289
+ # @param module_api_name [String] A String
290
+ # @param param_instance [ParameterMap] An instance of ParameterMap
291
+ # @param header_instance [HeaderMap] An instance of HeaderMap
292
+ # @return An instance of APIResponse
293
+ # @raise SDKException
294
+ def get_deleted_records(module_api_name, param_instance=nil, header_instance=nil)
295
+ if !module_api_name.is_a? String
296
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
297
+ end
298
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
299
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
300
+ end
301
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
302
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
303
+ end
304
+ handler_instance = Handler::CommonAPIHandler.new
305
+ api_path = ''
306
+ api_path = api_path + '/crm/v2.1/'
307
+ api_path = api_path + module_api_name.to_s
308
+ api_path = api_path + '/deleted'
309
+ handler_instance.api_path = api_path
310
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
311
+ handler_instance.category_method = 'READ'
312
+ handler_instance.param = param_instance
313
+ handler_instance.header = header_instance
314
+ Util::Utility.get_fields(module_api_name, handler_instance)
315
+ require_relative 'deleted_records_handler'
316
+ handler_instance.api_call(DeletedRecordsHandler.name, 'application/json')
317
+ end
318
+
319
+ # The method to search records
320
+ # @param module_api_name [String] A String
321
+ # @param param_instance [ParameterMap] An instance of ParameterMap
322
+ # @param header_instance [HeaderMap] An instance of HeaderMap
323
+ # @return An instance of APIResponse
324
+ # @raise SDKException
325
+ def search_records(module_api_name, param_instance=nil, header_instance=nil)
326
+ if !module_api_name.is_a? String
327
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
328
+ end
329
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
330
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
331
+ end
332
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
333
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
334
+ end
335
+ handler_instance = Handler::CommonAPIHandler.new
336
+ api_path = ''
337
+ api_path = api_path + '/crm/v2.1/'
338
+ api_path = api_path + module_api_name.to_s
339
+ api_path = api_path + '/search'
340
+ handler_instance.api_path = api_path
341
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
342
+ handler_instance.category_method = 'READ'
343
+ handler_instance.param = param_instance
344
+ handler_instance.header = header_instance
345
+ handler_instance.module_api_name = module_api_name
346
+ Util::Utility.get_fields(module_api_name, handler_instance)
347
+ require_relative 'response_handler'
348
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
349
+ end
350
+
351
+ # The method to convert lead
352
+ # @param id [Integer] A Integer
353
+ # @param request [ConvertBodyWrapper] An instance of ConvertBodyWrapper
354
+ # @return An instance of APIResponse
355
+ # @raise SDKException
356
+ def convert_lead(id, request)
357
+ if !id.is_a? Integer
358
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
359
+ end
360
+ if request!=nil and !request.is_a? ConvertBodyWrapper
361
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: ConvertBodyWrapper', nil, nil)
362
+ end
363
+ handler_instance = Handler::CommonAPIHandler.new
364
+ api_path = ''
365
+ api_path = api_path + '/crm/v2.1/Leads/'
366
+ api_path = api_path + id.to_s
367
+ api_path = api_path + '/actions/convert'
368
+ handler_instance.api_path = api_path
369
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
370
+ handler_instance.category_method = 'CREATE'
371
+ handler_instance.content_type = 'application/json'
372
+ handler_instance.request = request
373
+ handler_instance.mandatory_checker = true
374
+ Util::Utility.get_fields("Deals", handler_instance)
375
+ require_relative 'convert_action_handler'
376
+ handler_instance.api_call(ConvertActionHandler.name, 'application/json')
377
+ end
378
+
379
+ # The method to get photo
380
+ # @param id [Integer] A Integer
381
+ # @param module_api_name [String] A String
382
+ # @return An instance of APIResponse
383
+ # @raise SDKException
384
+ def get_photo(id, module_api_name)
385
+ if !id.is_a? Integer
386
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
387
+ end
388
+ if !module_api_name.is_a? String
389
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
390
+ end
391
+ handler_instance = Handler::CommonAPIHandler.new
392
+ api_path = ''
393
+ api_path = api_path + '/crm/v2.1/'
394
+ api_path = api_path + module_api_name.to_s
395
+ api_path = api_path + '/'
396
+ api_path = api_path + id.to_s
397
+ api_path = api_path + '/photo'
398
+ handler_instance.api_path = api_path
399
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
400
+ handler_instance.category_method = 'READ'
401
+ Util::Utility.get_fields(module_api_name, handler_instance)
402
+ require_relative 'download_handler'
403
+ handler_instance.api_call(DownloadHandler.name, 'application/x-download')
404
+ end
405
+
406
+ # The method to upload photo
407
+ # @param id [Integer] A Integer
408
+ # @param module_api_name [String] A String
409
+ # @param request [FileBodyWrapper] An instance of FileBodyWrapper
410
+ # @return An instance of APIResponse
411
+ # @raise SDKException
412
+ def upload_photo(id, module_api_name, request)
413
+ if !id.is_a? Integer
414
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
415
+ end
416
+ if !module_api_name.is_a? String
417
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
418
+ end
419
+ if request!=nil and !request.is_a? FileBodyWrapper
420
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', nil, nil)
421
+ end
422
+ handler_instance = Handler::CommonAPIHandler.new
423
+ api_path = ''
424
+ api_path = api_path + '/crm/v2.1/'
425
+ api_path = api_path + module_api_name.to_s
426
+ api_path = api_path + '/'
427
+ api_path = api_path + id.to_s
428
+ api_path = api_path + '/photo'
429
+ handler_instance.api_path = api_path
430
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
431
+ handler_instance.category_method = 'CREATE'
432
+ handler_instance.content_type = 'multipart/form-data'
433
+ handler_instance.request = request
434
+ handler_instance.mandatory_checker = true
435
+ Util::Utility.get_fields(module_api_name, handler_instance)
436
+ Util::Utility.verify_photo_support(module_api_name)
437
+ require_relative 'file_handler'
438
+ handler_instance.api_call(FileHandler.name, 'application/json')
439
+ end
440
+
441
+ # The method to delete photo
442
+ # @param id [Integer] A Integer
443
+ # @param module_api_name [String] A String
444
+ # @return An instance of APIResponse
445
+ # @raise SDKException
446
+ def delete_photo(id, module_api_name)
447
+ if !id.is_a? Integer
448
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
449
+ end
450
+ if !module_api_name.is_a? String
451
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
452
+ end
453
+ handler_instance = Handler::CommonAPIHandler.new
454
+ api_path = ''
455
+ api_path = api_path + '/crm/v2.1/'
456
+ api_path = api_path + module_api_name.to_s
457
+ api_path = api_path + '/'
458
+ api_path = api_path + id.to_s
459
+ api_path = api_path + '/photo'
460
+ handler_instance.api_path = api_path
461
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
462
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
463
+ Util::Utility.get_fields(module_api_name, handler_instance)
464
+ require_relative 'file_handler'
465
+ handler_instance.api_call(FileHandler.name, 'application/json')
466
+ end
467
+
468
+ # The method to mass update records
469
+ # @param module_api_name [String] A String
470
+ # @param request [MassUpdateBodyWrapper] An instance of MassUpdateBodyWrapper
471
+ # @return An instance of APIResponse
472
+ # @raise SDKException
473
+ def mass_update_records(module_api_name, request)
474
+ if !module_api_name.is_a? String
475
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
476
+ end
477
+ if request!=nil and !request.is_a? MassUpdateBodyWrapper
478
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MassUpdateBodyWrapper', nil, nil)
479
+ end
480
+ handler_instance = Handler::CommonAPIHandler.new
481
+ api_path = ''
482
+ api_path = api_path + '/crm/v2.1/'
483
+ api_path = api_path + module_api_name.to_s
484
+ api_path = api_path + '/actions/mass_update'
485
+ handler_instance.api_path = api_path
486
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
487
+ handler_instance.category_method = 'UPDATE'
488
+ handler_instance.content_type = 'application/json'
489
+ handler_instance.request = request
490
+ handler_instance.mandatory_checker = true
491
+ handler_instance.module_api_name = module_api_name
492
+ Util::Utility.get_fields(module_api_name, handler_instance)
493
+ require_relative 'mass_update_action_handler'
494
+ handler_instance.api_call(MassUpdateActionHandler.name, 'application/json')
495
+ end
496
+
497
+ # The method to get mass update status
498
+ # @param module_api_name [String] A String
499
+ # @param param_instance [ParameterMap] An instance of ParameterMap
500
+ # @return An instance of APIResponse
501
+ # @raise SDKException
502
+ def get_mass_update_status(module_api_name, param_instance=nil)
503
+ if !module_api_name.is_a? String
504
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
505
+ end
506
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
507
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
508
+ end
509
+ handler_instance = Handler::CommonAPIHandler.new
510
+ api_path = ''
511
+ api_path = api_path + '/crm/v2.1/'
512
+ api_path = api_path + module_api_name.to_s
513
+ api_path = api_path + '/actions/mass_update'
514
+ handler_instance.api_path = api_path
515
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
516
+ handler_instance.category_method = 'READ'
517
+ handler_instance.param = param_instance
518
+ Util::Utility.get_fields(module_api_name, handler_instance)
519
+ require_relative 'mass_update_response_handler'
520
+ handler_instance.api_call(MassUpdateResponseHandler.name, 'application/json')
521
+ end
522
+
523
+ # The method to assign territories to multiple records
524
+ # @param module_api_name [String] A String
525
+ # @param request [BodyWrapper] An instance of BodyWrapper
526
+ # @return An instance of APIResponse
527
+ # @raise SDKException
528
+ def assign_territories_to_multiple_records(module_api_name, request)
529
+ if !module_api_name.is_a? String
530
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
531
+ end
532
+ if request!=nil and !request.is_a? BodyWrapper
533
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
534
+ end
535
+ handler_instance = Handler::CommonAPIHandler.new
536
+ api_path = ''
537
+ api_path = api_path + '/crm/v2.1/'
538
+ api_path = api_path + module_api_name.to_s
539
+ api_path = api_path + '/actions/assign_territories'
540
+ handler_instance.api_path = api_path
541
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
542
+ handler_instance.category_method = 'UPDATE'
543
+ handler_instance.content_type = 'application/json'
544
+ handler_instance.request = request
545
+ handler_instance.mandatory_checker = true
546
+ handler_instance.module_api_name = module_api_name
547
+ Util::Utility.get_fields(module_api_name, handler_instance)
548
+ require_relative 'action_handler'
549
+ handler_instance.api_call(ActionHandler.name, 'application/json')
550
+ end
551
+
552
+ # The method to assign territory to record
553
+ # @param module_api_name [String] A String
554
+ # @param id [Integer] A Integer
555
+ # @param request [BodyWrapper] An instance of BodyWrapper
556
+ # @return An instance of APIResponse
557
+ # @raise SDKException
558
+ def assign_territory_to_record(module_api_name, id, request)
559
+ if !module_api_name.is_a? String
560
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
561
+ end
562
+ if !id.is_a? Integer
563
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
564
+ end
565
+ if request!=nil and !request.is_a? BodyWrapper
566
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
567
+ end
568
+ handler_instance = Handler::CommonAPIHandler.new
569
+ api_path = ''
570
+ api_path = api_path + '/crm/v2.1/'
571
+ api_path = api_path + module_api_name.to_s
572
+ api_path = api_path + '/'
573
+ api_path = api_path + id.to_s
574
+ api_path = api_path + '/actions/assign_territories'
575
+ handler_instance.api_path = api_path
576
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
577
+ handler_instance.category_method = 'UPDATE'
578
+ handler_instance.content_type = 'application/json'
579
+ handler_instance.request = request
580
+ handler_instance.module_api_name = module_api_name
581
+ Util::Utility.get_fields(module_api_name, handler_instance)
582
+ require_relative 'action_handler'
583
+ handler_instance.api_call(ActionHandler.name, 'application/json')
584
+ end
585
+
586
+ # The method to remove territories from multiple records
587
+ # @param module_api_name [String] A String
588
+ # @param request [BodyWrapper] An instance of BodyWrapper
589
+ # @return An instance of APIResponse
590
+ # @raise SDKException
591
+ def remove_territories_from_multiple_records(module_api_name, request)
592
+ if !module_api_name.is_a? String
593
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
594
+ end
595
+ if request!=nil and !request.is_a? BodyWrapper
596
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
597
+ end
598
+ handler_instance = Handler::CommonAPIHandler.new
599
+ api_path = ''
600
+ api_path = api_path + '/crm/v2.1/'
601
+ api_path = api_path + module_api_name.to_s
602
+ api_path = api_path + '/actions/remove_territories'
603
+ handler_instance.api_path = api_path
604
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
605
+ handler_instance.category_method = 'UPDATE'
606
+ handler_instance.content_type = 'application/json'
607
+ handler_instance.request = request
608
+ handler_instance.mandatory_checker = true
609
+ handler_instance.module_api_name = module_api_name
610
+ Util::Utility.get_fields(module_api_name, handler_instance)
611
+ require_relative 'action_handler'
612
+ handler_instance.api_call(ActionHandler.name, 'application/json')
613
+ end
614
+
615
+ # The method to remove territories from record
616
+ # @param module_api_name [String] A String
617
+ # @param id [Integer] A Integer
618
+ # @param request [BodyWrapper] An instance of BodyWrapper
619
+ # @return An instance of APIResponse
620
+ # @raise SDKException
621
+ def remove_territories_from_record(module_api_name, id, request)
622
+ if !module_api_name.is_a? String
623
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
624
+ end
625
+ if !id.is_a? Integer
626
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
627
+ end
628
+ if request!=nil and !request.is_a? BodyWrapper
629
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
630
+ end
631
+ handler_instance = Handler::CommonAPIHandler.new
632
+ api_path = ''
633
+ api_path = api_path + '/crm/v2.1/'
634
+ api_path = api_path + module_api_name.to_s
635
+ api_path = api_path + '/'
636
+ api_path = api_path + id.to_s
637
+ api_path = api_path + '/actions/remove_territories'
638
+ handler_instance.api_path = api_path
639
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
640
+ handler_instance.category_method = 'UPDATE'
641
+ handler_instance.content_type = 'application/json'
642
+ handler_instance.request = request
643
+ handler_instance.module_api_name = module_api_name
644
+ Util::Utility.get_fields(module_api_name, handler_instance)
645
+ require_relative 'action_handler'
646
+ handler_instance.api_call(ActionHandler.name, 'application/json')
647
+ end
648
+
649
+ # The method to record count
650
+ # @param module_api_name [String] A String
651
+ # @param param_instance [ParameterMap] An instance of ParameterMap
652
+ # @return An instance of APIResponse
653
+ # @raise SDKException
654
+ def record_count(module_api_name, param_instance=nil)
655
+ if !module_api_name.is_a? String
656
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
657
+ end
658
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
659
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
660
+ end
661
+ handler_instance = Handler::CommonAPIHandler.new
662
+ api_path = ''
663
+ api_path = api_path + '/crm/v2.1/'
664
+ api_path = api_path + module_api_name.to_s
665
+ api_path = api_path + '/actions/count'
666
+ handler_instance.api_path = api_path
667
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
668
+ handler_instance.category_method = 'READ'
669
+ handler_instance.param = param_instance
670
+ require_relative 'count_handler'
671
+ handler_instance.api_call(CountHandler.name, 'application/json')
672
+ end
673
+
674
+ # The method to get record using external id
675
+ # @param external_field_value [String] A String
676
+ # @param module_api_name [String] A String
677
+ # @param param_instance [ParameterMap] An instance of ParameterMap
678
+ # @param header_instance [HeaderMap] An instance of HeaderMap
679
+ # @return An instance of APIResponse
680
+ # @raise SDKException
681
+ def get_record_using_external_id(external_field_value, module_api_name, param_instance=nil, header_instance=nil)
682
+ if !external_field_value.is_a? String
683
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
684
+ end
685
+ if !module_api_name.is_a? String
686
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
687
+ end
688
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
689
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
690
+ end
691
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
692
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
693
+ end
694
+ handler_instance = Handler::CommonAPIHandler.new
695
+ api_path = ''
696
+ api_path = api_path + '/crm/v2.1/'
697
+ api_path = api_path + module_api_name.to_s
698
+ api_path = api_path + '/'
699
+ api_path = api_path + external_field_value.to_s
700
+ handler_instance.api_path = api_path
701
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
702
+ handler_instance.category_method = 'READ'
703
+ handler_instance.param = param_instance
704
+ handler_instance.header = header_instance
705
+ handler_instance.module_api_name = module_api_name
706
+ Util::Utility.get_fields(module_api_name, handler_instance)
707
+ require_relative 'response_handler'
708
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
709
+ end
710
+
711
+ # The method to update record using external id
712
+ # @param external_field_value [String] A String
713
+ # @param module_api_name [String] A String
714
+ # @param request [BodyWrapper] An instance of BodyWrapper
715
+ # @param header_instance [HeaderMap] An instance of HeaderMap
716
+ # @return An instance of APIResponse
717
+ # @raise SDKException
718
+ def update_record_using_external_id(external_field_value, module_api_name, request, header_instance=nil)
719
+ if !external_field_value.is_a? String
720
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
721
+ end
722
+ if !module_api_name.is_a? String
723
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
724
+ end
725
+ if request!=nil and !request.is_a? BodyWrapper
726
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
727
+ end
728
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
729
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
730
+ end
731
+ handler_instance = Handler::CommonAPIHandler.new
732
+ api_path = ''
733
+ api_path = api_path + '/crm/v2.1/'
734
+ api_path = api_path + module_api_name.to_s
735
+ api_path = api_path + '/'
736
+ api_path = api_path + external_field_value.to_s
737
+ handler_instance.api_path = api_path
738
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
739
+ handler_instance.category_method = 'UPDATE'
740
+ handler_instance.content_type = 'application/json'
741
+ handler_instance.request = request
742
+ handler_instance.header = header_instance
743
+ handler_instance.module_api_name = module_api_name
744
+ Util::Utility.get_fields(module_api_name, handler_instance)
745
+ require_relative 'action_handler'
746
+ handler_instance.api_call(ActionHandler.name, 'application/json')
747
+ end
748
+
749
+ # The method to delete record using external id
750
+ # @param external_field_value [String] A String
751
+ # @param module_api_name [String] A String
752
+ # @param param_instance [ParameterMap] An instance of ParameterMap
753
+ # @param header_instance [HeaderMap] An instance of HeaderMap
754
+ # @return An instance of APIResponse
755
+ # @raise SDKException
756
+ def delete_record_using_external_id(external_field_value, module_api_name, param_instance=nil, header_instance=nil)
757
+ if !external_field_value.is_a? String
758
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
759
+ end
760
+ if !module_api_name.is_a? String
761
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
762
+ end
763
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
764
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
765
+ end
766
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
767
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
768
+ end
769
+ handler_instance = Handler::CommonAPIHandler.new
770
+ api_path = ''
771
+ api_path = api_path + '/crm/v2.1/'
772
+ api_path = api_path + module_api_name.to_s
773
+ api_path = api_path + '/'
774
+ api_path = api_path + external_field_value.to_s
775
+ handler_instance.api_path = api_path
776
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
777
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
778
+ handler_instance.param = param_instance
779
+ handler_instance.header = header_instance
780
+ Util::Utility.get_fields(module_api_name, handler_instance)
781
+ require_relative 'action_handler'
782
+ handler_instance.api_call(ActionHandler.name, 'application/json')
783
+ end
784
+
785
+ class GetRecordParam
786
+ @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordParam')
787
+ def self.approved
788
+ @@approved
789
+ end
790
+ @@converted = Param.new('converted', 'com.zoho.crm.api.Record.GetRecordParam')
791
+ def self.converted
792
+ @@converted
793
+ end
794
+ @@cvid = Param.new('cvid', 'com.zoho.crm.api.Record.GetRecordParam')
795
+ def self.cvid
796
+ @@cvid
797
+ end
798
+ @@uid = Param.new('uid', 'com.zoho.crm.api.Record.GetRecordParam')
799
+ def self.uid
800
+ @@uid
801
+ end
802
+ @@fields = Param.new('fields', 'com.zoho.crm.api.Record.GetRecordParam')
803
+ def self.fields
804
+ @@fields
805
+ end
806
+ @@startDateTime = Param.new('startDateTime', 'com.zoho.crm.api.Record.GetRecordParam')
807
+ def self.startDateTime
808
+ @@startDateTime
809
+ end
810
+ @@endDateTime = Param.new('endDateTime', 'com.zoho.crm.api.Record.GetRecordParam')
811
+ def self.endDateTime
812
+ @@endDateTime
813
+ end
814
+ @@territory_id = Param.new('territory_id', 'com.zoho.crm.api.Record.GetRecordParam')
815
+ def self.territory_id
816
+ @@territory_id
817
+ end
818
+ @@include_child = Param.new('include_child', 'com.zoho.crm.api.Record.GetRecordParam')
819
+ def self.include_child
820
+ @@include_child
821
+ end
822
+ end
823
+
824
+ class GetRecordHeader
825
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordHeader')
826
+ def self.If_modified_since
827
+ @@If_modified_since
828
+ end
829
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordHeader')
830
+ def self.X_external
831
+ @@X_external
832
+ end
833
+ end
834
+
835
+ class UpdateRecordHeader
836
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordHeader')
837
+ def self.X_external
838
+ @@X_external
839
+ end
840
+ end
841
+
842
+ class DeleteRecordParam
843
+ @@wf_trigger = Param.new('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordParam')
844
+ def self.wf_trigger
845
+ @@wf_trigger
846
+ end
847
+ end
848
+
849
+ class DeleteRecordHeader
850
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordHeader')
851
+ def self.X_external
852
+ @@X_external
853
+ end
854
+ end
855
+
856
+ class GetRecordsParam
857
+ @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordsParam')
858
+ def self.approved
859
+ @@approved
860
+ end
861
+ @@converted = Param.new('converted', 'com.zoho.crm.api.Record.GetRecordsParam')
862
+ def self.converted
863
+ @@converted
864
+ end
865
+ @@cvid = Param.new('cvid', 'com.zoho.crm.api.Record.GetRecordsParam')
866
+ def self.cvid
867
+ @@cvid
868
+ end
869
+ @@ids = Param.new('ids', 'com.zoho.crm.api.Record.GetRecordsParam')
870
+ def self.ids
871
+ @@ids
872
+ end
873
+ @@uid = Param.new('uid', 'com.zoho.crm.api.Record.GetRecordsParam')
874
+ def self.uid
875
+ @@uid
876
+ end
877
+ @@fields = Param.new('fields', 'com.zoho.crm.api.Record.GetRecordsParam')
878
+ def self.fields
879
+ @@fields
880
+ end
881
+ @@sort_by = Param.new('sort_by', 'com.zoho.crm.api.Record.GetRecordsParam')
882
+ def self.sort_by
883
+ @@sort_by
884
+ end
885
+ @@sort_order = Param.new('sort_order', 'com.zoho.crm.api.Record.GetRecordsParam')
886
+ def self.sort_order
887
+ @@sort_order
888
+ end
889
+ @@page = Param.new('page', 'com.zoho.crm.api.Record.GetRecordsParam')
890
+ def self.page
891
+ @@page
892
+ end
893
+ @@per_page = Param.new('per_page', 'com.zoho.crm.api.Record.GetRecordsParam')
894
+ def self.per_page
895
+ @@per_page
896
+ end
897
+ @@startDateTime = Param.new('startDateTime', 'com.zoho.crm.api.Record.GetRecordsParam')
898
+ def self.startDateTime
899
+ @@startDateTime
900
+ end
901
+ @@endDateTime = Param.new('endDateTime', 'com.zoho.crm.api.Record.GetRecordsParam')
902
+ def self.endDateTime
903
+ @@endDateTime
904
+ end
905
+ @@territory_id = Param.new('territory_id', 'com.zoho.crm.api.Record.GetRecordsParam')
906
+ def self.territory_id
907
+ @@territory_id
908
+ end
909
+ @@include_child = Param.new('include_child', 'com.zoho.crm.api.Record.GetRecordsParam')
910
+ def self.include_child
911
+ @@include_child
912
+ end
913
+ end
914
+
915
+ class GetRecordsHeader
916
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordsHeader')
917
+ def self.If_modified_since
918
+ @@If_modified_since
919
+ end
920
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordsHeader')
921
+ def self.X_external
922
+ @@X_external
923
+ end
924
+ end
925
+
926
+ class CreateRecordsHeader
927
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.CreateRecordsHeader')
928
+ def self.X_external
929
+ @@X_external
930
+ end
931
+ end
932
+
933
+ class UpdateRecordsHeader
934
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordsHeader')
935
+ def self.X_external
936
+ @@X_external
937
+ end
938
+ end
939
+
940
+ class DeleteRecordsParam
941
+ @@ids = Param.new('ids', 'com.zoho.crm.api.Record.DeleteRecordsParam')
942
+ def self.ids
943
+ @@ids
944
+ end
945
+ @@wf_trigger = Param.new('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordsParam')
946
+ def self.wf_trigger
947
+ @@wf_trigger
948
+ end
949
+ end
950
+
951
+ class DeleteRecordsHeader
952
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordsHeader')
953
+ def self.X_external
954
+ @@X_external
955
+ end
956
+ end
957
+
958
+ class UpsertRecordsHeader
959
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.UpsertRecordsHeader')
960
+ def self.X_external
961
+ @@X_external
962
+ end
963
+ end
964
+
965
+ class GetDeletedRecordsParam
966
+ @@type = Param.new('type', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
967
+ def self.type
968
+ @@type
969
+ end
970
+ @@page = Param.new('page', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
971
+ def self.page
972
+ @@page
973
+ end
974
+ @@per_page = Param.new('per_page', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
975
+ def self.per_page
976
+ @@per_page
977
+ end
978
+ end
979
+
980
+ class GetDeletedRecordsHeader
981
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Record.GetDeletedRecordsHeader')
982
+ def self.If_modified_since
983
+ @@If_modified_since
984
+ end
985
+ end
986
+
987
+ class SearchRecordsParam
988
+ @@criteria = Param.new('criteria', 'com.zoho.crm.api.Record.SearchRecordsParam')
989
+ def self.criteria
990
+ @@criteria
991
+ end
992
+ @@email = Param.new('email', 'com.zoho.crm.api.Record.SearchRecordsParam')
993
+ def self.email
994
+ @@email
995
+ end
996
+ @@phone = Param.new('phone', 'com.zoho.crm.api.Record.SearchRecordsParam')
997
+ def self.phone
998
+ @@phone
999
+ end
1000
+ @@word = Param.new('word', 'com.zoho.crm.api.Record.SearchRecordsParam')
1001
+ def self.word
1002
+ @@word
1003
+ end
1004
+ @@converted = Param.new('converted', 'com.zoho.crm.api.Record.SearchRecordsParam')
1005
+ def self.converted
1006
+ @@converted
1007
+ end
1008
+ @@approved = Param.new('approved', 'com.zoho.crm.api.Record.SearchRecordsParam')
1009
+ def self.approved
1010
+ @@approved
1011
+ end
1012
+ @@page = Param.new('page', 'com.zoho.crm.api.Record.SearchRecordsParam')
1013
+ def self.page
1014
+ @@page
1015
+ end
1016
+ @@per_page = Param.new('per_page', 'com.zoho.crm.api.Record.SearchRecordsParam')
1017
+ def self.per_page
1018
+ @@per_page
1019
+ end
1020
+ @@fields = Param.new('fields', 'com.zoho.crm.api.Record.SearchRecordsParam')
1021
+ def self.fields
1022
+ @@fields
1023
+ end
1024
+ end
1025
+
1026
+ class SearchRecordsHeader
1027
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.SearchRecordsHeader')
1028
+ def self.X_external
1029
+ @@X_external
1030
+ end
1031
+ end
1032
+
1033
+ class GetMassUpdateStatusParam
1034
+ @@job_id = Param.new('job_id', 'com.zoho.crm.api.Record.GetMassUpdateStatusParam')
1035
+ def self.job_id
1036
+ @@job_id
1037
+ end
1038
+ end
1039
+
1040
+ class RecordCountParam
1041
+ @@criteria = Param.new('criteria', 'com.zoho.crm.api.Record.RecordCountParam')
1042
+ def self.criteria
1043
+ @@criteria
1044
+ end
1045
+ @@email = Param.new('email', 'com.zoho.crm.api.Record.RecordCountParam')
1046
+ def self.email
1047
+ @@email
1048
+ end
1049
+ @@phone = Param.new('phone', 'com.zoho.crm.api.Record.RecordCountParam')
1050
+ def self.phone
1051
+ @@phone
1052
+ end
1053
+ @@word = Param.new('word', 'com.zoho.crm.api.Record.RecordCountParam')
1054
+ def self.word
1055
+ @@word
1056
+ end
1057
+ end
1058
+
1059
+ class GetRecordUsingExternalIDParam
1060
+ @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1061
+ def self.approved
1062
+ @@approved
1063
+ end
1064
+ @@converted = Param.new('converted', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1065
+ def self.converted
1066
+ @@converted
1067
+ end
1068
+ @@cvid = Param.new('cvid', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1069
+ def self.cvid
1070
+ @@cvid
1071
+ end
1072
+ @@uid = Param.new('uid', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1073
+ def self.uid
1074
+ @@uid
1075
+ end
1076
+ @@fields = Param.new('fields', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1077
+ def self.fields
1078
+ @@fields
1079
+ end
1080
+ @@startDateTime = Param.new('startDateTime', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1081
+ def self.startDateTime
1082
+ @@startDateTime
1083
+ end
1084
+ @@endDateTime = Param.new('endDateTime', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1085
+ def self.endDateTime
1086
+ @@endDateTime
1087
+ end
1088
+ @@territory_id = Param.new('territory_id', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1089
+ def self.territory_id
1090
+ @@territory_id
1091
+ end
1092
+ @@include_child = Param.new('include_child', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
1093
+ def self.include_child
1094
+ @@include_child
1095
+ end
1096
+ end
1097
+
1098
+ class GetRecordUsingExternalIDHeader
1099
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDHeader')
1100
+ def self.If_modified_since
1101
+ @@If_modified_since
1102
+ end
1103
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDHeader')
1104
+ def self.X_external
1105
+ @@X_external
1106
+ end
1107
+ end
1108
+
1109
+ class UpdateRecordUsingExternalIDHeader
1110
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordUsingExternalIDHeader')
1111
+ def self.X_external
1112
+ @@X_external
1113
+ end
1114
+ end
1115
+
1116
+ class DeleteRecordUsingExternalIDParam
1117
+ @@wf_trigger = Param.new('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordUsingExternalIDParam')
1118
+ def self.wf_trigger
1119
+ @@wf_trigger
1120
+ end
1121
+ end
1122
+
1123
+ class DeleteRecordUsingExternalIDHeader
1124
+ @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordUsingExternalIDHeader')
1125
+ def self.X_external
1126
+ @@X_external
1127
+ end
1128
+ end
1129
+
1130
+ end
1131
+ end
1132
+ end