ZCRMSDK 1.0.4 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (464) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZCRMSDK.rb +447 -0
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +272 -0
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +191 -0
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +235 -0
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +33 -0
  7. data/src/com/zoho/api/authenticator/token.rb +10 -0
  8. data/src/com/zoho/api/logger/sdk_logger.rb +78 -0
  9. data/src/com/zoho/crm/api/assignment_rules/api_exception.rb +121 -0
  10. data/src/com/zoho/crm/api/assignment_rules/assignment_rule.rb +215 -0
  11. data/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.rb +61 -0
  12. data/src/com/zoho/crm/api/assignment_rules/default_user.rb +80 -0
  13. data/src/com/zoho/crm/api/assignment_rules/response_handler.rb +10 -0
  14. data/src/com/zoho/crm/api/assignment_rules/response_wrapper.rb +63 -0
  15. data/src/com/zoho/crm/api/attachments/action_handler.rb +10 -0
  16. data/src/com/zoho/crm/api/attachments/action_response.rb +10 -0
  17. data/src/com/zoho/crm/api/attachments/action_wrapper.rb +63 -0
  18. data/src/com/zoho/crm/api/attachments/api_exception.rb +125 -0
  19. data/src/com/zoho/crm/api/attachments/attachment.rb +405 -0
  20. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +196 -0
  21. data/src/com/zoho/crm/api/attachments/file_body_wrapper.rb +64 -0
  22. data/src/com/zoho/crm/api/attachments/response_handler.rb +10 -0
  23. data/src/com/zoho/crm/api/attachments/response_wrapper.rb +83 -0
  24. data/src/com/zoho/crm/api/attachments/success_response.rb +121 -0
  25. data/src/com/zoho/crm/api/blue_print/action_response.rb +10 -0
  26. data/src/com/zoho/crm/api/blue_print/api_exception.rb +123 -0
  27. data/src/com/zoho/crm/api/blue_print/blue_print.rb +119 -0
  28. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +67 -0
  29. data/src/com/zoho/crm/api/blue_print/body_wrapper.rb +61 -0
  30. data/src/com/zoho/crm/api/blue_print/escalation.rb +80 -0
  31. data/src/com/zoho/crm/api/blue_print/field.rb +1127 -0
  32. data/src/com/zoho/crm/api/blue_print/next_transition.rb +118 -0
  33. data/src/com/zoho/crm/api/blue_print/process_info.rb +251 -0
  34. data/src/com/zoho/crm/api/blue_print/response_handler.rb +10 -0
  35. data/src/com/zoho/crm/api/blue_print/response_wrapper.rb +63 -0
  36. data/src/com/zoho/crm/api/blue_print/success_response.rb +121 -0
  37. data/src/com/zoho/crm/api/blue_print/transition.rb +271 -0
  38. data/src/com/zoho/crm/api/blue_print/validation_error.rb +137 -0
  39. data/src/com/zoho/crm/api/bulk_read/action_handler.rb +10 -0
  40. data/src/com/zoho/crm/api/bulk_read/action_response.rb +10 -0
  41. data/src/com/zoho/crm/api/bulk_read/action_wrapper.rb +82 -0
  42. data/src/com/zoho/crm/api/bulk_read/api_exception.rb +125 -0
  43. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +74 -0
  44. data/src/com/zoho/crm/api/bulk_read/call_back.rb +81 -0
  45. data/src/com/zoho/crm/api/bulk_read/criteria.rb +155 -0
  46. data/src/com/zoho/crm/api/bulk_read/file_body_wrapper.rb +64 -0
  47. data/src/com/zoho/crm/api/bulk_read/job_detail.rb +196 -0
  48. data/src/com/zoho/crm/api/bulk_read/query.rb +138 -0
  49. data/src/com/zoho/crm/api/bulk_read/request_wrapper.rb +100 -0
  50. data/src/com/zoho/crm/api/bulk_read/response_handler.rb +10 -0
  51. data/src/com/zoho/crm/api/bulk_read/response_wrapper.rb +63 -0
  52. data/src/com/zoho/crm/api/bulk_read/result.rb +137 -0
  53. data/src/com/zoho/crm/api/bulk_read/success_response.rb +121 -0
  54. data/src/com/zoho/crm/api/bulk_write/action_response.rb +10 -0
  55. data/src/com/zoho/crm/api/bulk_write/api_exception.rb +239 -0
  56. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +112 -0
  57. data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb +216 -0
  58. data/src/com/zoho/crm/api/bulk_write/call_back.rb +81 -0
  59. data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +156 -0
  60. data/src/com/zoho/crm/api/bulk_write/file.rb +157 -0
  61. data/src/com/zoho/crm/api/bulk_write/file_body_wrapper.rb +64 -0
  62. data/src/com/zoho/crm/api/bulk_write/request_wrapper.rb +119 -0
  63. data/src/com/zoho/crm/api/bulk_write/resource.rb +215 -0
  64. data/src/com/zoho/crm/api/bulk_write/response_handler.rb +10 -0
  65. data/src/com/zoho/crm/api/bulk_write/response_wrapper.rb +10 -0
  66. data/src/com/zoho/crm/api/bulk_write/result.rb +61 -0
  67. data/src/com/zoho/crm/api/bulk_write/success_response.rb +121 -0
  68. data/src/com/zoho/crm/api/contact_roles/action_handler.rb +10 -0
  69. data/src/com/zoho/crm/api/contact_roles/action_response.rb +10 -0
  70. data/src/com/zoho/crm/api/contact_roles/action_wrapper.rb +63 -0
  71. data/src/com/zoho/crm/api/contact_roles/api_exception.rb +125 -0
  72. data/src/com/zoho/crm/api/contact_roles/body_wrapper.rb +61 -0
  73. data/src/com/zoho/crm/api/contact_roles/contact_role.rb +99 -0
  74. data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +161 -0
  75. data/src/com/zoho/crm/api/contact_roles/response_handler.rb +10 -0
  76. data/src/com/zoho/crm/api/contact_roles/response_wrapper.rb +63 -0
  77. data/src/com/zoho/crm/api/contact_roles/success_response.rb +121 -0
  78. data/src/com/zoho/crm/api/currencies/action_handler.rb +10 -0
  79. data/src/com/zoho/crm/api/currencies/action_response.rb +10 -0
  80. data/src/com/zoho/crm/api/currencies/action_wrapper.rb +63 -0
  81. data/src/com/zoho/crm/api/currencies/api_exception.rb +127 -0
  82. data/src/com/zoho/crm/api/currencies/base_currency_action_handler.rb +10 -0
  83. data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb +63 -0
  84. data/src/com/zoho/crm/api/currencies/base_currency_wrapper.rb +61 -0
  85. data/src/com/zoho/crm/api/currencies/body_wrapper.rb +61 -0
  86. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +156 -0
  87. data/src/com/zoho/crm/api/currencies/currency.rb +290 -0
  88. data/src/com/zoho/crm/api/currencies/format.rb +100 -0
  89. data/src/com/zoho/crm/api/currencies/response_handler.rb +10 -0
  90. data/src/com/zoho/crm/api/currencies/response_wrapper.rb +63 -0
  91. data/src/com/zoho/crm/api/currencies/success_response.rb +121 -0
  92. data/src/com/zoho/crm/api/custom_views/api_exception.rb +121 -0
  93. data/src/com/zoho/crm/api/custom_views/criteria.rb +136 -0
  94. data/src/com/zoho/crm/api/custom_views/custom_view.rb +386 -0
  95. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +75 -0
  96. data/src/com/zoho/crm/api/custom_views/info.rb +156 -0
  97. data/src/com/zoho/crm/api/custom_views/range.rb +80 -0
  98. data/src/com/zoho/crm/api/custom_views/response_handler.rb +10 -0
  99. data/src/com/zoho/crm/api/custom_views/response_wrapper.rb +82 -0
  100. data/src/com/zoho/crm/api/custom_views/shared_to.rb +118 -0
  101. data/src/com/zoho/crm/api/custom_views/translation.rb +118 -0
  102. data/src/com/zoho/crm/api/dc/au_datacenter.rb +18 -0
  103. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +18 -0
  104. data/src/com/zoho/crm/api/dc/datacenter.rb +21 -0
  105. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +18 -0
  106. data/src/com/zoho/crm/api/dc/in_datacenter.rb +18 -0
  107. data/src/com/zoho/crm/api/dc/us_datacenter.rb +18 -0
  108. data/src/com/zoho/crm/api/email_templates/api_exception.rb +121 -0
  109. data/src/com/zoho/crm/api/email_templates/attachment.rb +118 -0
  110. data/src/com/zoho/crm/api/email_templates/email_template.rb +390 -0
  111. data/src/com/zoho/crm/api/email_templates/email_templates_operations.rb +61 -0
  112. data/src/com/zoho/crm/api/email_templates/response_handler.rb +10 -0
  113. data/src/com/zoho/crm/api/email_templates/response_wrapper.rb +83 -0
  114. data/src/com/zoho/crm/api/exception/sdk_exception.rb +47 -0
  115. data/src/com/zoho/crm/api/field_attachments/api_exception.rb +121 -0
  116. data/src/com/zoho/crm/api/field_attachments/body_wrapper.rb +62 -0
  117. data/src/com/zoho/crm/api/field_attachments/field_attachments_operations.rb +52 -0
  118. data/src/com/zoho/crm/api/field_attachments/file_body_wrapper.rb +64 -0
  119. data/src/com/zoho/crm/api/field_attachments/response_handler.rb +10 -0
  120. data/src/com/zoho/crm/api/fields/api_exception.rb +121 -0
  121. data/src/com/zoho/crm/api/fields/association_details.rb +80 -0
  122. data/src/com/zoho/crm/api/fields/auto_number.rb +99 -0
  123. data/src/com/zoho/crm/api/fields/crypt.rb +156 -0
  124. data/src/com/zoho/crm/api/fields/currency.rb +80 -0
  125. data/src/com/zoho/crm/api/fields/external.rb +99 -0
  126. data/src/com/zoho/crm/api/fields/field.rb +1110 -0
  127. data/src/com/zoho/crm/api/fields/fields_operations.rb +71 -0
  128. data/src/com/zoho/crm/api/fields/formula.rb +80 -0
  129. data/src/com/zoho/crm/api/fields/history_tracking.rb +80 -0
  130. data/src/com/zoho/crm/api/fields/lookup_field.rb +80 -0
  131. data/src/com/zoho/crm/api/fields/maps.rb +80 -0
  132. data/src/com/zoho/crm/api/fields/module.rb +157 -0
  133. data/src/com/zoho/crm/api/fields/multi_module_lookup.rb +99 -0
  134. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +175 -0
  135. data/src/com/zoho/crm/api/fields/multi_user_lookup.rb +175 -0
  136. data/src/com/zoho/crm/api/fields/pick_list_value.rb +194 -0
  137. data/src/com/zoho/crm/api/fields/private.rb +99 -0
  138. data/src/com/zoho/crm/api/fields/related_details.rb +156 -0
  139. data/src/com/zoho/crm/api/fields/response_handler.rb +10 -0
  140. data/src/com/zoho/crm/api/fields/response_wrapper.rb +63 -0
  141. data/src/com/zoho/crm/api/fields/tool_tip.rb +80 -0
  142. data/src/com/zoho/crm/api/fields/unique.rb +61 -0
  143. data/src/com/zoho/crm/api/fields/view_type.rb +118 -0
  144. data/src/com/zoho/crm/api/files/action_handler.rb +10 -0
  145. data/src/com/zoho/crm/api/files/action_response.rb +10 -0
  146. data/src/com/zoho/crm/api/files/action_wrapper.rb +63 -0
  147. data/src/com/zoho/crm/api/files/api_exception.rb +125 -0
  148. data/src/com/zoho/crm/api/files/body_wrapper.rb +62 -0
  149. data/src/com/zoho/crm/api/files/file_body_wrapper.rb +64 -0
  150. data/src/com/zoho/crm/api/files/file_operations.rb +75 -0
  151. data/src/com/zoho/crm/api/files/response_handler.rb +10 -0
  152. data/src/com/zoho/crm/api/files/success_response.rb +121 -0
  153. data/src/com/zoho/crm/api/header.rb +10 -0
  154. data/src/com/zoho/crm/api/header_map.rb +55 -0
  155. data/src/com/zoho/crm/api/initializer.rb +220 -0
  156. data/src/com/zoho/crm/api/inventory_templates/api_exception.rb +121 -0
  157. data/src/com/zoho/crm/api/inventory_templates/inventory_template.rb +352 -0
  158. data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb +82 -0
  159. data/src/com/zoho/crm/api/inventory_templates/response_handler.rb +10 -0
  160. data/src/com/zoho/crm/api/inventory_templates/response_wrapper.rb +83 -0
  161. data/src/com/zoho/crm/api/layouts/api_exception.rb +121 -0
  162. data/src/com/zoho/crm/api/layouts/layout.rb +310 -0
  163. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +61 -0
  164. data/src/com/zoho/crm/api/layouts/properties.rb +100 -0
  165. data/src/com/zoho/crm/api/layouts/response_handler.rb +10 -0
  166. data/src/com/zoho/crm/api/layouts/response_wrapper.rb +63 -0
  167. data/src/com/zoho/crm/api/layouts/section.rb +252 -0
  168. data/src/com/zoho/crm/api/modules/action_handler.rb +10 -0
  169. data/src/com/zoho/crm/api/modules/action_response.rb +10 -0
  170. data/src/com/zoho/crm/api/modules/action_wrapper.rb +63 -0
  171. data/src/com/zoho/crm/api/modules/api_exception.rb +125 -0
  172. data/src/com/zoho/crm/api/modules/argument.rb +80 -0
  173. data/src/com/zoho/crm/api/modules/body_wrapper.rb +61 -0
  174. data/src/com/zoho/crm/api/modules/module.rb +939 -0
  175. data/src/com/zoho/crm/api/modules/modules_operations.rb +111 -0
  176. data/src/com/zoho/crm/api/modules/related_list_properties.rb +99 -0
  177. data/src/com/zoho/crm/api/modules/response_handler.rb +10 -0
  178. data/src/com/zoho/crm/api/modules/response_wrapper.rb +63 -0
  179. data/src/com/zoho/crm/api/modules/success_response.rb +121 -0
  180. data/src/com/zoho/crm/api/modules/territory.rb +99 -0
  181. data/src/com/zoho/crm/api/notes/action_handler.rb +10 -0
  182. data/src/com/zoho/crm/api/notes/action_response.rb +10 -0
  183. data/src/com/zoho/crm/api/notes/action_wrapper.rb +63 -0
  184. data/src/com/zoho/crm/api/notes/api_exception.rb +125 -0
  185. data/src/com/zoho/crm/api/notes/body_wrapper.rb +61 -0
  186. data/src/com/zoho/crm/api/notes/info.rb +118 -0
  187. data/src/com/zoho/crm/api/notes/note.rb +368 -0
  188. data/src/com/zoho/crm/api/notes/notes_operations.rb +219 -0
  189. data/src/com/zoho/crm/api/notes/response_handler.rb +10 -0
  190. data/src/com/zoho/crm/api/notes/response_wrapper.rb +82 -0
  191. data/src/com/zoho/crm/api/notes/success_response.rb +121 -0
  192. data/src/com/zoho/crm/api/notification/action_handler.rb +10 -0
  193. data/src/com/zoho/crm/api/notification/action_response.rb +10 -0
  194. data/src/com/zoho/crm/api/notification/action_wrapper.rb +63 -0
  195. data/src/com/zoho/crm/api/notification/api_exception.rb +125 -0
  196. data/src/com/zoho/crm/api/notification/body_wrapper.rb +61 -0
  197. data/src/com/zoho/crm/api/notification/info.rb +118 -0
  198. data/src/com/zoho/crm/api/notification/notification.rb +251 -0
  199. data/src/com/zoho/crm/api/notification/notification_operations.rb +164 -0
  200. data/src/com/zoho/crm/api/notification/response_handler.rb +10 -0
  201. data/src/com/zoho/crm/api/notification/response_wrapper.rb +82 -0
  202. data/src/com/zoho/crm/api/notification/success_response.rb +121 -0
  203. data/src/com/zoho/crm/api/org/action_response.rb +10 -0
  204. data/src/com/zoho/crm/api/org/api_exception.rb +123 -0
  205. data/src/com/zoho/crm/api/org/file_body_wrapper.rb +62 -0
  206. data/src/com/zoho/crm/api/org/hierarchy_preference.rb +61 -0
  207. data/src/com/zoho/crm/api/org/license_details.rb +156 -0
  208. data/src/com/zoho/crm/api/org/org.rb +669 -0
  209. data/src/com/zoho/crm/api/org/org_operations.rb +49 -0
  210. data/src/com/zoho/crm/api/org/response_handler.rb +10 -0
  211. data/src/com/zoho/crm/api/org/response_wrapper.rb +63 -0
  212. data/src/com/zoho/crm/api/org/success_response.rb +121 -0
  213. data/src/com/zoho/crm/api/param.rb +10 -0
  214. data/src/com/zoho/crm/api/parameter_map.rb +54 -0
  215. data/src/com/zoho/crm/api/pipeline/action_handler.rb +10 -0
  216. data/src/com/zoho/crm/api/pipeline/action_response.rb +10 -0
  217. data/src/com/zoho/crm/api/pipeline/action_wrapper.rb +63 -0
  218. data/src/com/zoho/crm/api/pipeline/api_exception.rb +129 -0
  219. data/src/com/zoho/crm/api/pipeline/body_wrapper.rb +61 -0
  220. data/src/com/zoho/crm/api/pipeline/forecast_category.rb +80 -0
  221. data/src/com/zoho/crm/api/pipeline/pick_list_value.rb +175 -0
  222. data/src/com/zoho/crm/api/pipeline/pipeline.rb +213 -0
  223. data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb +165 -0
  224. data/src/com/zoho/crm/api/pipeline/response_handler.rb +10 -0
  225. data/src/com/zoho/crm/api/pipeline/response_wrapper.rb +63 -0
  226. data/src/com/zoho/crm/api/pipeline/stage.rb +80 -0
  227. data/src/com/zoho/crm/api/pipeline/success_response.rb +123 -0
  228. data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb +10 -0
  229. data/src/com/zoho/crm/api/pipeline/transfer_action_response.rb +10 -0
  230. data/src/com/zoho/crm/api/pipeline/transfer_action_wrapper.rb +63 -0
  231. data/src/com/zoho/crm/api/pipeline/transfer_and_delete_wrapper.rb +61 -0
  232. data/src/com/zoho/crm/api/pipeline/transfer_pipe_line.rb +80 -0
  233. data/src/com/zoho/crm/api/profiles/api_exception.rb +121 -0
  234. data/src/com/zoho/crm/api/profiles/category.rb +118 -0
  235. data/src/com/zoho/crm/api/profiles/default_view.rb +99 -0
  236. data/src/com/zoho/crm/api/profiles/permission_detail.rb +137 -0
  237. data/src/com/zoho/crm/api/profiles/profile.rb +328 -0
  238. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +61 -0
  239. data/src/com/zoho/crm/api/profiles/response_handler.rb +10 -0
  240. data/src/com/zoho/crm/api/profiles/response_wrapper.rb +63 -0
  241. data/src/com/zoho/crm/api/profiles/section.rb +80 -0
  242. data/src/com/zoho/crm/api/query/api_exception.rb +121 -0
  243. data/src/com/zoho/crm/api/query/body_wrapper.rb +61 -0
  244. data/src/com/zoho/crm/api/query/query_operations.rb +35 -0
  245. data/src/com/zoho/crm/api/query/response_handler.rb +10 -0
  246. data/src/com/zoho/crm/api/query/response_wrapper.rb +84 -0
  247. data/src/com/zoho/crm/api/record/action_handler.rb +10 -0
  248. data/src/com/zoho/crm/api/record/action_response.rb +10 -0
  249. data/src/com/zoho/crm/api/record/action_wrapper.rb +63 -0
  250. data/src/com/zoho/crm/api/record/api_exception.rb +145 -0
  251. data/src/com/zoho/crm/api/record/body_wrapper.rb +137 -0
  252. data/src/com/zoho/crm/api/record/carry_over_tags.rb +99 -0
  253. data/src/com/zoho/crm/api/record/comment.rb +118 -0
  254. data/src/com/zoho/crm/api/record/consent.rb +185 -0
  255. data/src/com/zoho/crm/api/record/convert_action_handler.rb +10 -0
  256. data/src/com/zoho/crm/api/record/convert_action_response.rb +10 -0
  257. data/src/com/zoho/crm/api/record/convert_action_wrapper.rb +63 -0
  258. data/src/com/zoho/crm/api/record/convert_body_wrapper.rb +61 -0
  259. data/src/com/zoho/crm/api/record/count_handler.rb +10 -0
  260. data/src/com/zoho/crm/api/record/count_wrapper.rb +63 -0
  261. data/src/com/zoho/crm/api/record/criteria.rb +135 -0
  262. data/src/com/zoho/crm/api/record/deleted_record.rb +157 -0
  263. data/src/com/zoho/crm/api/record/deleted_records_handler.rb +10 -0
  264. data/src/com/zoho/crm/api/record/deleted_records_wrapper.rb +82 -0
  265. data/src/com/zoho/crm/api/record/download_handler.rb +10 -0
  266. data/src/com/zoho/crm/api/record/field.rb +2109 -0
  267. data/src/com/zoho/crm/api/record/file_body_wrapper.rb +66 -0
  268. data/src/com/zoho/crm/api/record/file_details.rb +327 -0
  269. data/src/com/zoho/crm/api/record/file_handler.rb +10 -0
  270. data/src/com/zoho/crm/api/record/image_upload.rb +213 -0
  271. data/src/com/zoho/crm/api/record/info.rb +118 -0
  272. data/src/com/zoho/crm/api/record/lead_converter.rb +194 -0
  273. data/src/com/zoho/crm/api/record/line_item_product.rb +65 -0
  274. data/src/com/zoho/crm/api/record/line_tax.rb +137 -0
  275. data/src/com/zoho/crm/api/record/mass_update.rb +140 -0
  276. data/src/com/zoho/crm/api/record/mass_update_action_handler.rb +10 -0
  277. data/src/com/zoho/crm/api/record/mass_update_action_response.rb +10 -0
  278. data/src/com/zoho/crm/api/record/mass_update_action_wrapper.rb +63 -0
  279. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +156 -0
  280. data/src/com/zoho/crm/api/record/mass_update_response.rb +10 -0
  281. data/src/com/zoho/crm/api/record/mass_update_response_handler.rb +10 -0
  282. data/src/com/zoho/crm/api/record/mass_update_response_wrapper.rb +63 -0
  283. data/src/com/zoho/crm/api/record/mass_update_success_response.rb +121 -0
  284. data/src/com/zoho/crm/api/record/mass_update_territory.rb +80 -0
  285. data/src/com/zoho/crm/api/record/multi_select_lookup.rb +99 -0
  286. data/src/com/zoho/crm/api/record/multi_select_picklist.rb +80 -0
  287. data/src/com/zoho/crm/api/record/options.rb +10 -0
  288. data/src/com/zoho/crm/api/record/participants.rb +116 -0
  289. data/src/com/zoho/crm/api/record/price_book.rb +31 -0
  290. data/src/com/zoho/crm/api/record/pricing_details.rb +65 -0
  291. data/src/com/zoho/crm/api/record/record.rb +192 -0
  292. data/src/com/zoho/crm/api/record/record_operations.rb +847 -0
  293. data/src/com/zoho/crm/api/record/recurring_activity.rb +61 -0
  294. data/src/com/zoho/crm/api/record/remind_at.rb +61 -0
  295. data/src/com/zoho/crm/api/record/reminder.rb +80 -0
  296. data/src/com/zoho/crm/api/record/response_handler.rb +10 -0
  297. data/src/com/zoho/crm/api/record/response_wrapper.rb +82 -0
  298. data/src/com/zoho/crm/api/record/success_response.rb +161 -0
  299. data/src/com/zoho/crm/api/record/successful_convert.rb +101 -0
  300. data/src/com/zoho/crm/api/record/tax.rb +80 -0
  301. data/src/com/zoho/crm/api/record/territory.rb +138 -0
  302. data/src/com/zoho/crm/api/record/widget.rb +80 -0
  303. data/src/com/zoho/crm/api/record/wizard.rb +80 -0
  304. data/src/com/zoho/crm/api/related_lists/api_exception.rb +121 -0
  305. data/src/com/zoho/crm/api/related_lists/related_list.rb +251 -0
  306. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +61 -0
  307. data/src/com/zoho/crm/api/related_lists/response_handler.rb +10 -0
  308. data/src/com/zoho/crm/api/related_lists/response_wrapper.rb +63 -0
  309. data/src/com/zoho/crm/api/related_records/action_handler.rb +10 -0
  310. data/src/com/zoho/crm/api/related_records/action_response.rb +10 -0
  311. data/src/com/zoho/crm/api/related_records/action_wrapper.rb +63 -0
  312. data/src/com/zoho/crm/api/related_records/api_exception.rb +125 -0
  313. data/src/com/zoho/crm/api/related_records/body_wrapper.rb +62 -0
  314. data/src/com/zoho/crm/api/related_records/file_body_wrapper.rb +64 -0
  315. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +235 -0
  316. data/src/com/zoho/crm/api/related_records/response_handler.rb +10 -0
  317. data/src/com/zoho/crm/api/related_records/response_wrapper.rb +84 -0
  318. data/src/com/zoho/crm/api/related_records/success_response.rb +121 -0
  319. data/src/com/zoho/crm/api/request_proxy.rb +15 -0
  320. data/src/com/zoho/crm/api/roles/api_exception.rb +121 -0
  321. data/src/com/zoho/crm/api/roles/response_handler.rb +10 -0
  322. data/src/com/zoho/crm/api/roles/response_wrapper.rb +63 -0
  323. data/src/com/zoho/crm/api/roles/role.rb +195 -0
  324. data/src/com/zoho/crm/api/roles/roles_operations.rb +47 -0
  325. data/src/com/zoho/crm/api/sdk_config.rb +12 -0
  326. data/src/com/zoho/crm/api/send_mail/action_handler.rb +10 -0
  327. data/src/com/zoho/crm/api/send_mail/action_response.rb +10 -0
  328. data/src/com/zoho/crm/api/send_mail/action_wrapper.rb +63 -0
  329. data/src/com/zoho/crm/api/send_mail/api_exception.rb +125 -0
  330. data/src/com/zoho/crm/api/send_mail/body_wrapper.rb +61 -0
  331. data/src/com/zoho/crm/api/send_mail/data_subject_request.rb +80 -0
  332. data/src/com/zoho/crm/api/send_mail/inventory_details.rb +100 -0
  333. data/src/com/zoho/crm/api/send_mail/mail.rb +423 -0
  334. data/src/com/zoho/crm/api/send_mail/response_handler.rb +10 -0
  335. data/src/com/zoho/crm/api/send_mail/response_wrapper.rb +63 -0
  336. data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb +61 -0
  337. data/src/com/zoho/crm/api/send_mail/success_response.rb +121 -0
  338. data/src/com/zoho/crm/api/send_mail/template.rb +10 -0
  339. data/src/com/zoho/crm/api/send_mail/user_address.rb +137 -0
  340. data/src/com/zoho/crm/api/share_records/action_handler.rb +10 -0
  341. data/src/com/zoho/crm/api/share_records/action_response.rb +10 -0
  342. data/src/com/zoho/crm/api/share_records/action_wrapper.rb +63 -0
  343. data/src/com/zoho/crm/api/share_records/api_exception.rb +129 -0
  344. data/src/com/zoho/crm/api/share_records/body_wrapper.rb +61 -0
  345. data/src/com/zoho/crm/api/share_records/delete_action_handler.rb +10 -0
  346. data/src/com/zoho/crm/api/share_records/delete_action_response.rb +10 -0
  347. data/src/com/zoho/crm/api/share_records/delete_action_wrapper.rb +63 -0
  348. data/src/com/zoho/crm/api/share_records/response_handler.rb +10 -0
  349. data/src/com/zoho/crm/api/share_records/response_wrapper.rb +83 -0
  350. data/src/com/zoho/crm/api/share_records/share_record.rb +157 -0
  351. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +128 -0
  352. data/src/com/zoho/crm/api/share_records/shared_through.rb +100 -0
  353. data/src/com/zoho/crm/api/share_records/success_response.rb +123 -0
  354. data/src/com/zoho/crm/api/tags/action_handler.rb +10 -0
  355. data/src/com/zoho/crm/api/tags/action_response.rb +10 -0
  356. data/src/com/zoho/crm/api/tags/action_wrapper.rb +63 -0
  357. data/src/com/zoho/crm/api/tags/api_exception.rb +131 -0
  358. data/src/com/zoho/crm/api/tags/body_wrapper.rb +61 -0
  359. data/src/com/zoho/crm/api/tags/conflict_wrapper.rb +61 -0
  360. data/src/com/zoho/crm/api/tags/count_handler.rb +10 -0
  361. data/src/com/zoho/crm/api/tags/count_wrapper.rb +63 -0
  362. data/src/com/zoho/crm/api/tags/info.rb +80 -0
  363. data/src/com/zoho/crm/api/tags/merge_wrapper.rb +61 -0
  364. data/src/com/zoho/crm/api/tags/record_action_handler.rb +10 -0
  365. data/src/com/zoho/crm/api/tags/record_action_response.rb +10 -0
  366. data/src/com/zoho/crm/api/tags/record_action_wrapper.rb +120 -0
  367. data/src/com/zoho/crm/api/tags/response_handler.rb +10 -0
  368. data/src/com/zoho/crm/api/tags/response_wrapper.rb +82 -0
  369. data/src/com/zoho/crm/api/tags/success_response.rb +123 -0
  370. data/src/com/zoho/crm/api/tags/tag.rb +176 -0
  371. data/src/com/zoho/crm/api/tags/tags_operations.rb +387 -0
  372. data/src/com/zoho/crm/api/taxes/action_handler.rb +10 -0
  373. data/src/com/zoho/crm/api/taxes/action_response.rb +10 -0
  374. data/src/com/zoho/crm/api/taxes/action_wrapper.rb +63 -0
  375. data/src/com/zoho/crm/api/taxes/api_exception.rb +125 -0
  376. data/src/com/zoho/crm/api/taxes/body_wrapper.rb +61 -0
  377. data/src/com/zoho/crm/api/taxes/preference.rb +80 -0
  378. data/src/com/zoho/crm/api/taxes/response_handler.rb +10 -0
  379. data/src/com/zoho/crm/api/taxes/response_wrapper.rb +82 -0
  380. data/src/com/zoho/crm/api/taxes/success_response.rb +121 -0
  381. data/src/com/zoho/crm/api/taxes/tax.rb +137 -0
  382. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +136 -0
  383. data/src/com/zoho/crm/api/territories/api_exception.rb +121 -0
  384. data/src/com/zoho/crm/api/territories/response_handler.rb +10 -0
  385. data/src/com/zoho/crm/api/territories/response_wrapper.rb +83 -0
  386. data/src/com/zoho/crm/api/territories/territories_operations.rb +47 -0
  387. data/src/com/zoho/crm/api/territories/territory.rb +272 -0
  388. data/src/com/zoho/crm/api/user_signature.rb +27 -0
  389. data/src/com/zoho/crm/api/users/action_handler.rb +10 -0
  390. data/src/com/zoho/crm/api/users/action_response.rb +10 -0
  391. data/src/com/zoho/crm/api/users/action_wrapper.rb +63 -0
  392. data/src/com/zoho/crm/api/users/api_exception.rb +125 -0
  393. data/src/com/zoho/crm/api/users/body_wrapper.rb +61 -0
  394. data/src/com/zoho/crm/api/users/customize_info.rb +156 -0
  395. data/src/com/zoho/crm/api/users/info.rb +118 -0
  396. data/src/com/zoho/crm/api/users/request_wrapper.rb +61 -0
  397. data/src/com/zoho/crm/api/users/response_handler.rb +10 -0
  398. data/src/com/zoho/crm/api/users/response_wrapper.rb +82 -0
  399. data/src/com/zoho/crm/api/users/shift.rb +80 -0
  400. data/src/com/zoho/crm/api/users/success_response.rb +121 -0
  401. data/src/com/zoho/crm/api/users/tab_theme.rb +80 -0
  402. data/src/com/zoho/crm/api/users/territory.rb +99 -0
  403. data/src/com/zoho/crm/api/users/theme.rb +156 -0
  404. data/src/com/zoho/crm/api/users/user.rb +730 -0
  405. data/src/com/zoho/crm/api/users/users_operations.rb +181 -0
  406. data/src/com/zoho/crm/api/util/api_http_connector.rb +112 -0
  407. data/src/com/zoho/crm/api/util/api_response.rb +16 -0
  408. data/src/com/zoho/crm/api/util/choice.rb +9 -0
  409. data/src/com/zoho/crm/api/util/common_api_handler.rb +237 -0
  410. data/src/com/zoho/crm/api/util/constants.rb +661 -0
  411. data/src/com/zoho/crm/api/util/converter.rb +236 -0
  412. data/src/com/zoho/crm/api/util/data_type_converter.rb +168 -0
  413. data/src/com/zoho/crm/api/util/downloader.rb +83 -0
  414. data/src/com/zoho/crm/api/util/form_data_converter.rb +156 -0
  415. data/src/com/zoho/crm/api/util/header_param_validator.rb +55 -0
  416. data/src/com/zoho/crm/api/util/json_converter.rb +724 -0
  417. data/src/com/zoho/crm/api/util/model.rb +5 -0
  418. data/src/com/zoho/crm/api/util/module_fields_handler.rb +78 -0
  419. data/src/com/zoho/crm/api/util/stream_wrapper.rb +37 -0
  420. data/src/com/zoho/crm/api/util/utility.rb +914 -0
  421. data/src/com/zoho/crm/api/variable_groups/api_exception.rb +121 -0
  422. data/src/com/zoho/crm/api/variable_groups/response_handler.rb +10 -0
  423. data/src/com/zoho/crm/api/variable_groups/response_wrapper.rb +63 -0
  424. data/src/com/zoho/crm/api/variable_groups/variable_group.rb +137 -0
  425. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +66 -0
  426. data/src/com/zoho/crm/api/variables/action_handler.rb +10 -0
  427. data/src/com/zoho/crm/api/variables/action_response.rb +10 -0
  428. data/src/com/zoho/crm/api/variables/action_wrapper.rb +63 -0
  429. data/src/com/zoho/crm/api/variables/api_exception.rb +125 -0
  430. data/src/com/zoho/crm/api/variables/body_wrapper.rb +61 -0
  431. data/src/com/zoho/crm/api/variables/response_handler.rb +10 -0
  432. data/src/com/zoho/crm/api/variables/response_wrapper.rb +63 -0
  433. data/src/com/zoho/crm/api/variables/success_response.rb +121 -0
  434. data/src/com/zoho/crm/api/variables/variable.rb +173 -0
  435. data/src/com/zoho/crm/api/variables/variables_operations.rb +241 -0
  436. data/src/com/zoho/crm/api/wizards/api_exception.rb +121 -0
  437. data/src/com/zoho/crm/api/wizards/button.rb +252 -0
  438. data/src/com/zoho/crm/api/wizards/chart_data.rb +118 -0
  439. data/src/com/zoho/crm/api/wizards/connection.rb +80 -0
  440. data/src/com/zoho/crm/api/wizards/container.rb +119 -0
  441. data/src/com/zoho/crm/api/wizards/node.rb +118 -0
  442. data/src/com/zoho/crm/api/wizards/response_handler.rb +10 -0
  443. data/src/com/zoho/crm/api/wizards/response_wrapper.rb +63 -0
  444. data/src/com/zoho/crm/api/wizards/screen.rb +99 -0
  445. data/src/com/zoho/crm/api/wizards/segment.rb +176 -0
  446. data/src/com/zoho/crm/api/wizards/transition.rb +80 -0
  447. data/src/com/zoho/crm/api/wizards/wizard.rb +273 -0
  448. data/src/com/zoho/crm/api/wizards/wizards_operations.rb +61 -0
  449. data/src/resources/JSONDetails.json +1 -0
  450. data/src/version.rb +3 -0
  451. metadata +476 -41
  452. data/lib/ZCRMSDK.rb +0 -14
  453. data/lib/ZCRMSDK/handler.rb +0 -3290
  454. data/lib/ZCRMSDK/oauth_client.rb +0 -257
  455. data/lib/ZCRMSDK/oauth_utility.rb +0 -161
  456. data/lib/ZCRMSDK/operations.rb +0 -1091
  457. data/lib/ZCRMSDK/org.rb +0 -174
  458. data/lib/ZCRMSDK/persistence.rb +0 -129
  459. data/lib/ZCRMSDK/request.rb +0 -83
  460. data/lib/ZCRMSDK/response.rb +0 -216
  461. data/lib/ZCRMSDK/restclient.rb +0 -65
  462. data/lib/ZCRMSDK/test.rb +0 -5748
  463. data/lib/ZCRMSDK/utility.rb +0 -310
  464. data/lib/ZCRMSDK/version.rb +0 -5
@@ -0,0 +1,31 @@
1
+ require_relative '../record/record'
2
+ require_relative '../util/model'
3
+
4
+ module Record
5
+ class PriceBook < Record
6
+ include Util::Model
7
+
8
+ # Creates an instance of PriceBook
9
+ def initialize
10
+ super
11
+ end
12
+
13
+ # The method to get the name
14
+ # @return A String value
15
+
16
+ def name
17
+ get_key_value('name')
18
+ end
19
+
20
+ # The method to set the value to name
21
+ # @param name [String] A String
22
+
23
+ def name=(name)
24
+ if name!=nil and !name.is_a? String
25
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
26
+ end
27
+ add_key_value('name', name)
28
+ end
29
+
30
+ end
31
+ end
@@ -0,0 +1,65 @@
1
+ require_relative '../record/record'
2
+ require_relative '../util/model'
3
+
4
+ module Record
5
+ class PricingDetails < Record
6
+ include Util::Model
7
+
8
+ # Creates an instance of PricingDetails
9
+ def initialize
10
+ super
11
+ end
12
+
13
+ # The method to get the to_range
14
+ # @return An instance of Float
15
+
16
+ def to_range
17
+ get_key_value('to_range')
18
+ end
19
+
20
+ # The method to set the value to to_range
21
+ # @param to_range [Float] An instance of Float
22
+
23
+ def to_range=(to_range)
24
+ if to_range!=nil and !to_range.is_a? Float
25
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: to_range EXPECTED TYPE: Float', nil, nil)
26
+ end
27
+ add_key_value('to_range', to_range)
28
+ end
29
+
30
+ # The method to get the discount
31
+ # @return An instance of Float
32
+
33
+ def discount
34
+ get_key_value('discount')
35
+ end
36
+
37
+ # The method to set the value to discount
38
+ # @param discount [Float] An instance of Float
39
+
40
+ def discount=(discount)
41
+ if discount!=nil and !discount.is_a? Float
42
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: discount EXPECTED TYPE: Float', nil, nil)
43
+ end
44
+ add_key_value('discount', discount)
45
+ end
46
+
47
+ # The method to get the from_range
48
+ # @return An instance of Float
49
+
50
+ def from_range
51
+ get_key_value('from_range')
52
+ end
53
+
54
+ # The method to set the value to from_range
55
+ # @param from_range [Float] An instance of Float
56
+
57
+ def from_range=(from_range)
58
+ if from_range!=nil and !from_range.is_a? Float
59
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: from_range EXPECTED TYPE: Float', nil, nil)
60
+ end
61
+ add_key_value('from_range', from_range)
62
+ end
63
+
64
+ end
65
+ end
@@ -0,0 +1,192 @@
1
+ require_relative '../tags/tag'
2
+ require_relative '../users/user'
3
+ require_relative '../util/model'
4
+
5
+ module Record
6
+ class Record
7
+ include Util::Model
8
+
9
+ # Creates an instance of Record
10
+ def initialize
11
+ @key_values = Hash.new
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the id
16
+ # @return A Integer value
17
+
18
+ def id
19
+ get_key_value('id')
20
+ end
21
+
22
+ # The method to set the value to id
23
+ # @param id [Integer] A Integer
24
+
25
+ def id=(id)
26
+ if id!=nil and !id.is_a? Integer
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
28
+ end
29
+ add_key_value('id', id)
30
+ end
31
+
32
+ # The method to get the created_by
33
+ # @return An instance of Users::User
34
+
35
+ def created_by
36
+ get_key_value('Created_By')
37
+ end
38
+
39
+ # The method to set the value to created_by
40
+ # @param created_by [Users::User] An instance of Users::User
41
+
42
+ def created_by=(created_by)
43
+ if created_by!=nil and !created_by.is_a? Users::User
44
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
45
+ end
46
+ add_key_value('Created_By', created_by)
47
+ end
48
+
49
+ # The method to get the created_time
50
+ # @return An instance of DateTime
51
+
52
+ def created_time
53
+ get_key_value('Created_Time')
54
+ end
55
+
56
+ # The method to set the value to created_time
57
+ # @param created_time [DateTime] An instance of DateTime
58
+
59
+ def created_time=(created_time)
60
+ if created_time!=nil and !created_time.is_a? DateTime
61
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
62
+ end
63
+ add_key_value('Created_Time', created_time)
64
+ end
65
+
66
+ # The method to get the modified_by
67
+ # @return An instance of Users::User
68
+
69
+ def modified_by
70
+ get_key_value('Modified_By')
71
+ end
72
+
73
+ # The method to set the value to modified_by
74
+ # @param modified_by [Users::User] An instance of Users::User
75
+
76
+ def modified_by=(modified_by)
77
+ if modified_by!=nil and !modified_by.is_a? Users::User
78
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
79
+ end
80
+ add_key_value('Modified_By', modified_by)
81
+ end
82
+
83
+ # The method to get the modified_time
84
+ # @return An instance of DateTime
85
+
86
+ def modified_time
87
+ get_key_value('Modified_Time')
88
+ end
89
+
90
+ # The method to set the value to modified_time
91
+ # @param modified_time [DateTime] An instance of DateTime
92
+
93
+ def modified_time=(modified_time)
94
+ if modified_time!=nil and !modified_time.is_a? DateTime
95
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
96
+ end
97
+ add_key_value('Modified_Time', modified_time)
98
+ end
99
+
100
+ # The method to get the tag
101
+ # @return An instance of Array
102
+
103
+ def tag
104
+ get_key_value('Tag')
105
+ end
106
+
107
+ # The method to set the value to tag
108
+ # @param tag [Array] An instance of Array
109
+
110
+ def tag=(tag)
111
+ if tag!=nil and !tag.is_a? Array
112
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: Array', nil, nil)
113
+ end
114
+ add_key_value('Tag', tag)
115
+ end
116
+
117
+ # The method to add field value
118
+ # @param field [Field] An instance of Field
119
+ # @param value [object] A Object
120
+
121
+ def add_field_value(field, value)
122
+ if field!=nil and !field.is_a? Field
123
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', nil, nil)
124
+ end
125
+ add_key_value(field.api_name, value)
126
+ end
127
+
128
+ # The method to add key value
129
+ # @param api_name [String] A String
130
+ # @param value [lang::Object] A lang::Object
131
+
132
+ def add_key_value(api_name, value)
133
+ if api_name!=nil and !api_name.is_a? String
134
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
135
+ end
136
+ @key_values[api_name] = value
137
+ @key_modified[api_name] = 1
138
+ end
139
+
140
+ # The method to get key value
141
+ # @param api_name [String] A String
142
+ # @return A lang::Object value
143
+
144
+ def get_key_value(api_name)
145
+ if api_name!=nil and !api_name.is_a? String
146
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
147
+ end
148
+ if @key_values.key?(api_name)
149
+ return @key_values[api_name]
150
+ end
151
+
152
+ nil
153
+ end
154
+
155
+ # The method to get key values
156
+ # @return An instance of Hash
157
+
158
+ def get_key_values
159
+ @key_values
160
+ end
161
+
162
+ # The method to check if the user has modified the given key
163
+ # @param key [String] A String
164
+ # @return A Integer value
165
+
166
+ def is_key_modified(key)
167
+ if key!=nil and !key.is_a? String
168
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
169
+ end
170
+ if @key_modified.key?(key)
171
+ return @key_modified[key]
172
+ end
173
+
174
+ nil
175
+ end
176
+
177
+ # The method to mark the given key as modified
178
+ # @param key [String] A String
179
+ # @param modification [Integer] A Integer
180
+
181
+ def set_key_modified(key, modification)
182
+ if key!=nil and !key.is_a? String
183
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
184
+ end
185
+ if modification!=nil and !modification.is_a? Integer
186
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
187
+ end
188
+ @key_modified[key] = modification
189
+ end
190
+
191
+ end
192
+ end
@@ -0,0 +1,847 @@
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 Record
12
+ class RecordOperations
13
+
14
+ # Creates an instance of RecordOperations
15
+ def initialize
16
+ end
17
+
18
+ # The method to get record
19
+ # @param id [Integer] A Integer
20
+ # @param module_api_name [String] A String
21
+ # @param param_instance [ParameterMap] An instance of ParameterMap
22
+ # @param header_instance [HeaderMap] An instance of HeaderMap
23
+ # @return An instance of APIResponse
24
+ # @raise SDKException
25
+ def get_record(id, module_api_name, param_instance=nil, header_instance=nil)
26
+ if !id.is_a? Integer
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
28
+ end
29
+ if !module_api_name.is_a? String
30
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
31
+ end
32
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
33
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
34
+ end
35
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
36
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
37
+ end
38
+ handler_instance = Handler::CommonAPIHandler.new
39
+ api_path = ''
40
+ api_path = api_path + '/crm/v2.1/'
41
+ api_path = api_path + module_api_name.to_s
42
+ api_path = api_path + '/'
43
+ api_path = api_path + id.to_s
44
+ handler_instance.api_path = api_path
45
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
46
+ handler_instance.category_method = 'READ'
47
+ handler_instance.param = param_instance
48
+ handler_instance.header = header_instance
49
+ Util::Utility.get_fields(module_api_name, handler_instance)
50
+ handler_instance.module_api_name = module_api_name
51
+ require_relative 'response_handler'
52
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
53
+ end
54
+
55
+ # The method to update record
56
+ # @param id [Integer] A Integer
57
+ # @param module_api_name [String] A String
58
+ # @param request [BodyWrapper] An instance of BodyWrapper
59
+ # @return An instance of APIResponse
60
+ # @raise SDKException
61
+ def update_record(id, module_api_name, request)
62
+ if !id.is_a? Integer
63
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
64
+ end
65
+ if !module_api_name.is_a? String
66
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
67
+ end
68
+ if request!=nil and !request.is_a? BodyWrapper
69
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
70
+ end
71
+ handler_instance = Handler::CommonAPIHandler.new
72
+ api_path = ''
73
+ api_path = api_path + '/crm/v2.1/'
74
+ api_path = api_path + module_api_name.to_s
75
+ api_path = api_path + '/'
76
+ api_path = api_path + id.to_s
77
+ handler_instance.api_path = api_path
78
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
79
+ handler_instance.category_method = 'UPDATE'
80
+ handler_instance.content_type = 'application/json'
81
+ handler_instance.request = request
82
+ Util::Utility.get_fields(module_api_name, handler_instance)
83
+ handler_instance.module_api_name = module_api_name
84
+ require_relative 'action_handler'
85
+ handler_instance.api_call(ActionHandler.name, 'application/json')
86
+ end
87
+
88
+ # The method to delete record
89
+ # @param id [Integer] A Integer
90
+ # @param module_api_name [String] A String
91
+ # @param param_instance [ParameterMap] An instance of ParameterMap
92
+ # @return An instance of APIResponse
93
+ # @raise SDKException
94
+ def delete_record(id, module_api_name, param_instance=nil)
95
+ if !id.is_a? Integer
96
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
97
+ end
98
+ if !module_api_name.is_a? String
99
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
100
+ end
101
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
102
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
103
+ end
104
+ handler_instance = Handler::CommonAPIHandler.new
105
+ api_path = ''
106
+ api_path = api_path + '/crm/v2.1/'
107
+ api_path = api_path + module_api_name.to_s
108
+ api_path = api_path + '/'
109
+ api_path = api_path + id.to_s
110
+ handler_instance.api_path = api_path
111
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
112
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
113
+ handler_instance.param = param_instance
114
+ require_relative 'action_handler'
115
+ handler_instance.api_call(ActionHandler.name, 'application/json')
116
+ end
117
+
118
+ # The method to get records
119
+ # @param module_api_name [String] A String
120
+ # @param param_instance [ParameterMap] An instance of ParameterMap
121
+ # @param header_instance [HeaderMap] An instance of HeaderMap
122
+ # @return An instance of APIResponse
123
+ # @raise SDKException
124
+ def get_records(module_api_name, param_instance=nil, header_instance=nil)
125
+ if !module_api_name.is_a? String
126
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
127
+ end
128
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
129
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
130
+ end
131
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
132
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
133
+ end
134
+ handler_instance = Handler::CommonAPIHandler.new
135
+ api_path = ''
136
+ api_path = api_path + '/crm/v2.1/'
137
+ api_path = api_path + module_api_name.to_s
138
+ handler_instance.api_path = api_path
139
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
140
+ handler_instance.category_method = 'READ'
141
+ handler_instance.param = param_instance
142
+ handler_instance.header = header_instance
143
+ Util::Utility.get_fields(module_api_name, handler_instance)
144
+ handler_instance.module_api_name = module_api_name
145
+ require_relative 'response_handler'
146
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
147
+ end
148
+
149
+ # The method to create records
150
+ # @param module_api_name [String] A String
151
+ # @param request [BodyWrapper] An instance of BodyWrapper
152
+ # @return An instance of APIResponse
153
+ # @raise SDKException
154
+ def create_records(module_api_name, request)
155
+ if !module_api_name.is_a? String
156
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
157
+ end
158
+ if request!=nil and !request.is_a? BodyWrapper
159
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
160
+ end
161
+ handler_instance = Handler::CommonAPIHandler.new
162
+ api_path = ''
163
+ api_path = api_path + '/crm/v2.1/'
164
+ api_path = api_path + module_api_name.to_s
165
+ handler_instance.api_path = api_path
166
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
167
+ handler_instance.category_method = 'CREATE'
168
+ handler_instance.content_type = 'application/json'
169
+ handler_instance.request = request
170
+ handler_instance.mandatory_checker = true
171
+ Util::Utility.get_fields(module_api_name, handler_instance)
172
+ handler_instance.module_api_name = module_api_name
173
+ require_relative 'action_handler'
174
+ handler_instance.api_call(ActionHandler.name, 'application/json')
175
+ end
176
+
177
+ # The method to update records
178
+ # @param module_api_name [String] A String
179
+ # @param request [BodyWrapper] An instance of BodyWrapper
180
+ # @return An instance of APIResponse
181
+ # @raise SDKException
182
+ def update_records(module_api_name, request)
183
+ if !module_api_name.is_a? String
184
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
185
+ end
186
+ if request!=nil and !request.is_a? BodyWrapper
187
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
188
+ end
189
+ handler_instance = Handler::CommonAPIHandler.new
190
+ api_path = ''
191
+ api_path = api_path + '/crm/v2.1/'
192
+ api_path = api_path + module_api_name.to_s
193
+ handler_instance.api_path = api_path
194
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
195
+ handler_instance.category_method = 'UPDATE'
196
+ handler_instance.content_type = 'application/json'
197
+ handler_instance.request = request
198
+ handler_instance.mandatory_checker = true
199
+ Util::Utility.get_fields(module_api_name, handler_instance)
200
+ handler_instance.module_api_name = module_api_name
201
+ require_relative 'action_handler'
202
+ handler_instance.api_call(ActionHandler.name, 'application/json')
203
+ end
204
+
205
+ # The method to delete records
206
+ # @param module_api_name [String] A String
207
+ # @param param_instance [ParameterMap] An instance of ParameterMap
208
+ # @return An instance of APIResponse
209
+ # @raise SDKException
210
+ def delete_records(module_api_name, param_instance=nil)
211
+ if !module_api_name.is_a? String
212
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
213
+ end
214
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
215
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
216
+ end
217
+ handler_instance = Handler::CommonAPIHandler.new
218
+ api_path = ''
219
+ api_path = api_path + '/crm/v2.1/'
220
+ api_path = api_path + module_api_name.to_s
221
+ handler_instance.api_path = api_path
222
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
223
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
224
+ handler_instance.param = param_instance
225
+ require_relative 'action_handler'
226
+ handler_instance.api_call(ActionHandler.name, 'application/json')
227
+ end
228
+
229
+ # The method to upsert records
230
+ # @param module_api_name [String] A String
231
+ # @param request [BodyWrapper] An instance of BodyWrapper
232
+ # @return An instance of APIResponse
233
+ # @raise SDKException
234
+ def upsert_records(module_api_name, request)
235
+ if !module_api_name.is_a? String
236
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
237
+ end
238
+ if request!=nil and !request.is_a? BodyWrapper
239
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', 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
+ api_path = api_path + '/upsert'
246
+ handler_instance.api_path = api_path
247
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
248
+ handler_instance.category_method = 'ACTION'
249
+ handler_instance.content_type = 'application/json'
250
+ handler_instance.request = request
251
+ Util::Utility.get_fields(module_api_name, handler_instance)
252
+ handler_instance.module_api_name = module_api_name
253
+ require_relative 'action_handler'
254
+ handler_instance.api_call(ActionHandler.name, 'application/json')
255
+ end
256
+
257
+ # The method to get deleted records
258
+ # @param module_api_name [String] A String
259
+ # @param param_instance [ParameterMap] An instance of ParameterMap
260
+ # @param header_instance [HeaderMap] An instance of HeaderMap
261
+ # @return An instance of APIResponse
262
+ # @raise SDKException
263
+ def get_deleted_records(module_api_name, param_instance=nil, header_instance=nil)
264
+ if !module_api_name.is_a? String
265
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
266
+ end
267
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
268
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
269
+ end
270
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
271
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
272
+ end
273
+ handler_instance = Handler::CommonAPIHandler.new
274
+ api_path = ''
275
+ api_path = api_path + '/crm/v2.1/'
276
+ api_path = api_path + module_api_name.to_s
277
+ api_path = api_path + '/deleted'
278
+ handler_instance.api_path = api_path
279
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
280
+ handler_instance.category_method = 'READ'
281
+ handler_instance.param = param_instance
282
+ handler_instance.header = header_instance
283
+ require_relative 'deleted_records_handler'
284
+ handler_instance.api_call(DeletedRecordsHandler.name, 'application/json')
285
+ end
286
+
287
+ # The method to search records
288
+ # @param module_api_name [String] A String
289
+ # @param param_instance [ParameterMap] An instance of ParameterMap
290
+ # @return An instance of APIResponse
291
+ # @raise SDKException
292
+ def search_records(module_api_name, param_instance=nil)
293
+ if !module_api_name.is_a? String
294
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
295
+ end
296
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
297
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
298
+ end
299
+ handler_instance = Handler::CommonAPIHandler.new
300
+ api_path = ''
301
+ api_path = api_path + '/crm/v2.1/'
302
+ api_path = api_path + module_api_name.to_s
303
+ api_path = api_path + '/search'
304
+ handler_instance.api_path = api_path
305
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
306
+ handler_instance.category_method = 'READ'
307
+ handler_instance.param = param_instance
308
+ Util::Utility.get_fields(module_api_name, handler_instance)
309
+ handler_instance.module_api_name = module_api_name
310
+ require_relative 'response_handler'
311
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
312
+ end
313
+
314
+ # The method to convert lead
315
+ # @param id [Integer] A Integer
316
+ # @param request [ConvertBodyWrapper] An instance of ConvertBodyWrapper
317
+ # @return An instance of APIResponse
318
+ # @raise SDKException
319
+ def convert_lead(id, request)
320
+ if !id.is_a? Integer
321
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
322
+ end
323
+ if request!=nil and !request.is_a? ConvertBodyWrapper
324
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: ConvertBodyWrapper', nil, nil)
325
+ end
326
+ handler_instance = Handler::CommonAPIHandler.new
327
+ api_path = ''
328
+ api_path = api_path + '/crm/v2.1/Leads/'
329
+ api_path = api_path + id.to_s
330
+ api_path = api_path + '/actions/convert'
331
+ handler_instance.api_path = api_path
332
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
333
+ handler_instance.category_method = 'CREATE'
334
+ handler_instance.content_type = 'application/json'
335
+ handler_instance.request = request
336
+ handler_instance.mandatory_checker = true
337
+ Util::Utility.get_fields("Deals", handler_instance)
338
+ require_relative 'convert_action_handler'
339
+ handler_instance.api_call(ConvertActionHandler.name, 'application/json')
340
+ end
341
+
342
+ # The method to get photo
343
+ # @param id [Integer] A Integer
344
+ # @param module_api_name [String] A String
345
+ # @return An instance of APIResponse
346
+ # @raise SDKException
347
+ def get_photo(id, module_api_name)
348
+ if !id.is_a? Integer
349
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
350
+ end
351
+ if !module_api_name.is_a? String
352
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
353
+ end
354
+ handler_instance = Handler::CommonAPIHandler.new
355
+ api_path = ''
356
+ api_path = api_path + '/crm/v2.1/'
357
+ api_path = api_path + module_api_name.to_s
358
+ api_path = api_path + '/'
359
+ api_path = api_path + id.to_s
360
+ api_path = api_path + '/photo'
361
+ handler_instance.api_path = api_path
362
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
363
+ handler_instance.category_method = 'READ'
364
+ require_relative 'download_handler'
365
+ handler_instance.api_call(DownloadHandler.name, 'application/x-download')
366
+ end
367
+
368
+ # The method to upload photo
369
+ # @param id [Integer] A Integer
370
+ # @param module_api_name [String] A String
371
+ # @param request [FileBodyWrapper] An instance of FileBodyWrapper
372
+ # @return An instance of APIResponse
373
+ # @raise SDKException
374
+ def upload_photo(id, module_api_name, request)
375
+ if !id.is_a? Integer
376
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
377
+ end
378
+ if !module_api_name.is_a? String
379
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
380
+ end
381
+ if request!=nil and !request.is_a? FileBodyWrapper
382
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', nil, nil)
383
+ end
384
+ handler_instance = Handler::CommonAPIHandler.new
385
+ api_path = ''
386
+ api_path = api_path + '/crm/v2.1/'
387
+ api_path = api_path + module_api_name.to_s
388
+ api_path = api_path + '/'
389
+ api_path = api_path + id.to_s
390
+ api_path = api_path + '/photo'
391
+ handler_instance.api_path = api_path
392
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
393
+ handler_instance.category_method = 'CREATE'
394
+ handler_instance.content_type = 'multipart/form-data'
395
+ handler_instance.request = request
396
+ handler_instance.mandatory_checker = true
397
+ Util::Utility.verify_photo_support(module_api_name)
398
+ require_relative 'file_handler'
399
+ handler_instance.api_call(FileHandler.name, 'application/json')
400
+ end
401
+
402
+ # The method to delete photo
403
+ # @param id [Integer] A Integer
404
+ # @param module_api_name [String] A String
405
+ # @return An instance of APIResponse
406
+ # @raise SDKException
407
+ def delete_photo(id, module_api_name)
408
+ if !id.is_a? Integer
409
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
410
+ end
411
+ if !module_api_name.is_a? String
412
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
413
+ end
414
+ handler_instance = Handler::CommonAPIHandler.new
415
+ api_path = ''
416
+ api_path = api_path + '/crm/v2.1/'
417
+ api_path = api_path + module_api_name.to_s
418
+ api_path = api_path + '/'
419
+ api_path = api_path + id.to_s
420
+ api_path = api_path + '/photo'
421
+ handler_instance.api_path = api_path
422
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
423
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
424
+ require_relative 'file_handler'
425
+ handler_instance.api_call(FileHandler.name, 'application/json')
426
+ end
427
+
428
+ # The method to mass update records
429
+ # @param module_api_name [String] A String
430
+ # @param request [MassUpdateBodyWrapper] An instance of MassUpdateBodyWrapper
431
+ # @return An instance of APIResponse
432
+ # @raise SDKException
433
+ def mass_update_records(module_api_name, request)
434
+ if !module_api_name.is_a? String
435
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
436
+ end
437
+ if request!=nil and !request.is_a? MassUpdateBodyWrapper
438
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MassUpdateBodyWrapper', nil, nil)
439
+ end
440
+ handler_instance = Handler::CommonAPIHandler.new
441
+ api_path = ''
442
+ api_path = api_path + '/crm/v2.1/'
443
+ api_path = api_path + module_api_name.to_s
444
+ api_path = api_path + '/actions/mass_update'
445
+ handler_instance.api_path = api_path
446
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
447
+ handler_instance.category_method = 'UPDATE'
448
+ handler_instance.content_type = 'application/json'
449
+ handler_instance.request = request
450
+ handler_instance.mandatory_checker = true
451
+ Util::Utility.get_fields(module_api_name, handler_instance)
452
+ handler_instance.module_api_name = module_api_name
453
+ require_relative 'mass_update_action_handler'
454
+ handler_instance.api_call(MassUpdateActionHandler.name, 'application/json')
455
+ end
456
+
457
+ # The method to get mass update status
458
+ # @param module_api_name [String] A String
459
+ # @param param_instance [ParameterMap] An instance of ParameterMap
460
+ # @return An instance of APIResponse
461
+ # @raise SDKException
462
+ def get_mass_update_status(module_api_name, param_instance=nil)
463
+ if !module_api_name.is_a? String
464
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
465
+ end
466
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
467
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
468
+ end
469
+ handler_instance = Handler::CommonAPIHandler.new
470
+ api_path = ''
471
+ api_path = api_path + '/crm/v2.1/'
472
+ api_path = api_path + module_api_name.to_s
473
+ api_path = api_path + '/actions/mass_update'
474
+ handler_instance.api_path = api_path
475
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
476
+ handler_instance.category_method = 'READ'
477
+ handler_instance.param = param_instance
478
+ require_relative 'mass_update_response_handler'
479
+ handler_instance.api_call(MassUpdateResponseHandler.name, 'application/json')
480
+ end
481
+
482
+ # The method to assign territories to multiple records
483
+ # @param module_api_name [String] A String
484
+ # @param request [BodyWrapper] An instance of BodyWrapper
485
+ # @return An instance of APIResponse
486
+ # @raise SDKException
487
+ def assign_territories_to_multiple_records(module_api_name, request)
488
+ if !module_api_name.is_a? String
489
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
490
+ end
491
+ if request!=nil and !request.is_a? BodyWrapper
492
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
493
+ end
494
+ handler_instance = Handler::CommonAPIHandler.new
495
+ api_path = ''
496
+ api_path = api_path + '/crm/v2.1/'
497
+ api_path = api_path + module_api_name.to_s
498
+ api_path = api_path + '/actions/assign_territories'
499
+ handler_instance.api_path = api_path
500
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
501
+ handler_instance.category_method = 'UPDATE'
502
+ handler_instance.content_type = 'application/json'
503
+ handler_instance.request = request
504
+ handler_instance.mandatory_checker = true
505
+ Util::Utility.get_fields(module_api_name, handler_instance)
506
+ handler_instance.module_api_name = module_api_name
507
+ require_relative 'action_handler'
508
+ handler_instance.api_call(ActionHandler.name, 'application/json')
509
+ end
510
+
511
+ # The method to assign territory to record
512
+ # @param module_api_name [String] A String
513
+ # @param id [Integer] A Integer
514
+ # @param request [BodyWrapper] An instance of BodyWrapper
515
+ # @return An instance of APIResponse
516
+ # @raise SDKException
517
+ def assign_territory_to_record(module_api_name, id, request)
518
+ if !module_api_name.is_a? String
519
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
520
+ end
521
+ if !id.is_a? Integer
522
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
523
+ end
524
+ if request!=nil and !request.is_a? BodyWrapper
525
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
526
+ end
527
+ handler_instance = Handler::CommonAPIHandler.new
528
+ api_path = ''
529
+ api_path = api_path + '/crm/v2.1/'
530
+ api_path = api_path + module_api_name.to_s
531
+ api_path = api_path + '/'
532
+ api_path = api_path + id.to_s
533
+ api_path = api_path + '/actions/assign_territories'
534
+ handler_instance.api_path = api_path
535
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
536
+ handler_instance.category_method = 'UPDATE'
537
+ handler_instance.content_type = 'application/json'
538
+ handler_instance.request = request
539
+ Util::Utility.get_fields(module_api_name, handler_instance)
540
+ handler_instance.module_api_name = module_api_name
541
+ require_relative 'action_handler'
542
+ handler_instance.api_call(ActionHandler.name, 'application/json')
543
+ end
544
+
545
+ # The method to remove territories from multiple records
546
+ # @param module_api_name [String] A String
547
+ # @param request [BodyWrapper] An instance of BodyWrapper
548
+ # @return An instance of APIResponse
549
+ # @raise SDKException
550
+ def remove_territories_from_multiple_records(module_api_name, request)
551
+ if !module_api_name.is_a? String
552
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
553
+ end
554
+ if request!=nil and !request.is_a? BodyWrapper
555
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
556
+ end
557
+ handler_instance = Handler::CommonAPIHandler.new
558
+ api_path = ''
559
+ api_path = api_path + '/crm/v2.1/'
560
+ api_path = api_path + module_api_name.to_s
561
+ api_path = api_path + '/actions/remove_territories'
562
+ handler_instance.api_path = api_path
563
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
564
+ handler_instance.category_method = 'UPDATE'
565
+ handler_instance.content_type = 'application/json'
566
+ handler_instance.request = request
567
+ handler_instance.mandatory_checker = true
568
+ Util::Utility.get_fields(module_api_name, handler_instance)
569
+ handler_instance.module_api_name = module_api_name
570
+ require_relative 'action_handler'
571
+ handler_instance.api_call(ActionHandler.name, 'application/json')
572
+ end
573
+
574
+ # The method to remove territories from record
575
+ # @param module_api_name [String] A String
576
+ # @param id [Integer] A Integer
577
+ # @param request [BodyWrapper] An instance of BodyWrapper
578
+ # @return An instance of APIResponse
579
+ # @raise SDKException
580
+ def remove_territories_from_record(module_api_name, id, request)
581
+ if !module_api_name.is_a? String
582
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
583
+ end
584
+ if !id.is_a? Integer
585
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
586
+ end
587
+ if request!=nil and !request.is_a? BodyWrapper
588
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
589
+ end
590
+ handler_instance = Handler::CommonAPIHandler.new
591
+ api_path = ''
592
+ api_path = api_path + '/crm/v2.1/'
593
+ api_path = api_path + module_api_name.to_s
594
+ api_path = api_path + '/'
595
+ api_path = api_path + id.to_s
596
+ api_path = api_path + '/actions/remove_territories'
597
+ handler_instance.api_path = api_path
598
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
599
+ handler_instance.category_method = 'UPDATE'
600
+ handler_instance.content_type = 'application/json'
601
+ handler_instance.request = request
602
+ Util::Utility.get_fields(module_api_name, handler_instance)
603
+ handler_instance.module_api_name = module_api_name
604
+ require_relative 'action_handler'
605
+ handler_instance.api_call(ActionHandler.name, 'application/json')
606
+ end
607
+
608
+ # The method to record count
609
+ # @param module_api_name [String] A String
610
+ # @param param_instance [ParameterMap] An instance of ParameterMap
611
+ # @return An instance of APIResponse
612
+ # @raise SDKException
613
+ def record_count(module_api_name, param_instance=nil)
614
+ if !module_api_name.is_a? String
615
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
616
+ end
617
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
618
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
619
+ end
620
+ handler_instance = Handler::CommonAPIHandler.new
621
+ api_path = ''
622
+ api_path = api_path + '/crm/v2.1/'
623
+ api_path = api_path + module_api_name.to_s
624
+ api_path = api_path + '/actions/count'
625
+ handler_instance.api_path = api_path
626
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
627
+ handler_instance.category_method = 'READ'
628
+ handler_instance.param = param_instance
629
+ require_relative 'count_handler'
630
+ handler_instance.api_call(CountHandler.name, 'application/json')
631
+ end
632
+
633
+ class GetRecordParam
634
+ @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordParam')
635
+ def self.approved
636
+ @@approved
637
+ end
638
+ @@converted = Param.new('converted', 'com.zoho.crm.api.Record.GetRecordParam')
639
+ def self.converted
640
+ @@converted
641
+ end
642
+ @@cvid = Param.new('cvid', 'com.zoho.crm.api.Record.GetRecordParam')
643
+ def self.cvid
644
+ @@cvid
645
+ end
646
+ @@uid = Param.new('uid', 'com.zoho.crm.api.Record.GetRecordParam')
647
+ def self.uid
648
+ @@uid
649
+ end
650
+ @@fields = Param.new('fields', 'com.zoho.crm.api.Record.GetRecordParam')
651
+ def self.fields
652
+ @@fields
653
+ end
654
+ @@startDateTime = Param.new('startDateTime', 'com.zoho.crm.api.Record.GetRecordParam')
655
+ def self.startDateTime
656
+ @@startDateTime
657
+ end
658
+ @@endDateTime = Param.new('endDateTime', 'com.zoho.crm.api.Record.GetRecordParam')
659
+ def self.endDateTime
660
+ @@endDateTime
661
+ end
662
+ @@territory_id = Param.new('territory_id', 'com.zoho.crm.api.Record.GetRecordParam')
663
+ def self.territory_id
664
+ @@territory_id
665
+ end
666
+ @@include_child = Param.new('include_child', 'com.zoho.crm.api.Record.GetRecordParam')
667
+ def self.include_child
668
+ @@include_child
669
+ end
670
+ end
671
+
672
+ class GetRecordHeader
673
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordHeader')
674
+ def self.If_modified_since
675
+ @@If_modified_since
676
+ end
677
+ end
678
+
679
+ class DeleteRecordParam
680
+ @@wf_trigger = Param.new('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordParam')
681
+ def self.wf_trigger
682
+ @@wf_trigger
683
+ end
684
+ end
685
+
686
+ class GetRecordsParam
687
+ @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordsParam')
688
+ def self.approved
689
+ @@approved
690
+ end
691
+ @@converted = Param.new('converted', 'com.zoho.crm.api.Record.GetRecordsParam')
692
+ def self.converted
693
+ @@converted
694
+ end
695
+ @@cvid = Param.new('cvid', 'com.zoho.crm.api.Record.GetRecordsParam')
696
+ def self.cvid
697
+ @@cvid
698
+ end
699
+ @@ids = Param.new('ids', 'com.zoho.crm.api.Record.GetRecordsParam')
700
+ def self.ids
701
+ @@ids
702
+ end
703
+ @@uid = Param.new('uid', 'com.zoho.crm.api.Record.GetRecordsParam')
704
+ def self.uid
705
+ @@uid
706
+ end
707
+ @@fields = Param.new('fields', 'com.zoho.crm.api.Record.GetRecordsParam')
708
+ def self.fields
709
+ @@fields
710
+ end
711
+ @@sort_by = Param.new('sort_by', 'com.zoho.crm.api.Record.GetRecordsParam')
712
+ def self.sort_by
713
+ @@sort_by
714
+ end
715
+ @@sort_order = Param.new('sort_order', 'com.zoho.crm.api.Record.GetRecordsParam')
716
+ def self.sort_order
717
+ @@sort_order
718
+ end
719
+ @@page = Param.new('page', 'com.zoho.crm.api.Record.GetRecordsParam')
720
+ def self.page
721
+ @@page
722
+ end
723
+ @@per_page = Param.new('per_page', 'com.zoho.crm.api.Record.GetRecordsParam')
724
+ def self.per_page
725
+ @@per_page
726
+ end
727
+ @@startDateTime = Param.new('startDateTime', 'com.zoho.crm.api.Record.GetRecordsParam')
728
+ def self.startDateTime
729
+ @@startDateTime
730
+ end
731
+ @@endDateTime = Param.new('endDateTime', 'com.zoho.crm.api.Record.GetRecordsParam')
732
+ def self.endDateTime
733
+ @@endDateTime
734
+ end
735
+ @@territory_id = Param.new('territory_id', 'com.zoho.crm.api.Record.GetRecordsParam')
736
+ def self.territory_id
737
+ @@territory_id
738
+ end
739
+ @@include_child = Param.new('include_child', 'com.zoho.crm.api.Record.GetRecordsParam')
740
+ def self.include_child
741
+ @@include_child
742
+ end
743
+ end
744
+
745
+ class GetRecordsHeader
746
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordsHeader')
747
+ def self.If_modified_since
748
+ @@If_modified_since
749
+ end
750
+ end
751
+
752
+ class DeleteRecordsParam
753
+ @@ids = Param.new('ids', 'com.zoho.crm.api.Record.DeleteRecordsParam')
754
+ def self.ids
755
+ @@ids
756
+ end
757
+ @@wf_trigger = Param.new('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordsParam')
758
+ def self.wf_trigger
759
+ @@wf_trigger
760
+ end
761
+ end
762
+
763
+ class GetDeletedRecordsParam
764
+ @@type = Param.new('type', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
765
+ def self.type
766
+ @@type
767
+ end
768
+ @@page = Param.new('page', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
769
+ def self.page
770
+ @@page
771
+ end
772
+ @@per_page = Param.new('per_page', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
773
+ def self.per_page
774
+ @@per_page
775
+ end
776
+ end
777
+
778
+ class GetDeletedRecordsHeader
779
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Record.GetDeletedRecordsHeader')
780
+ def self.If_modified_since
781
+ @@If_modified_since
782
+ end
783
+ end
784
+
785
+ class SearchRecordsParam
786
+ @@criteria = Param.new('criteria', 'com.zoho.crm.api.Record.SearchRecordsParam')
787
+ def self.criteria
788
+ @@criteria
789
+ end
790
+ @@email = Param.new('email', 'com.zoho.crm.api.Record.SearchRecordsParam')
791
+ def self.email
792
+ @@email
793
+ end
794
+ @@phone = Param.new('phone', 'com.zoho.crm.api.Record.SearchRecordsParam')
795
+ def self.phone
796
+ @@phone
797
+ end
798
+ @@word = Param.new('word', 'com.zoho.crm.api.Record.SearchRecordsParam')
799
+ def self.word
800
+ @@word
801
+ end
802
+ @@converted = Param.new('converted', 'com.zoho.crm.api.Record.SearchRecordsParam')
803
+ def self.converted
804
+ @@converted
805
+ end
806
+ @@approved = Param.new('approved', 'com.zoho.crm.api.Record.SearchRecordsParam')
807
+ def self.approved
808
+ @@approved
809
+ end
810
+ @@page = Param.new('page', 'com.zoho.crm.api.Record.SearchRecordsParam')
811
+ def self.page
812
+ @@page
813
+ end
814
+ @@per_page = Param.new('per_page', 'com.zoho.crm.api.Record.SearchRecordsParam')
815
+ def self.per_page
816
+ @@per_page
817
+ end
818
+ end
819
+
820
+ class GetMassUpdateStatusParam
821
+ @@job_id = Param.new('job_id', 'com.zoho.crm.api.Record.GetMassUpdateStatusParam')
822
+ def self.job_id
823
+ @@job_id
824
+ end
825
+ end
826
+
827
+ class RecordCountParam
828
+ @@criteria = Param.new('criteria', 'com.zoho.crm.api.Record.RecordCountParam')
829
+ def self.criteria
830
+ @@criteria
831
+ end
832
+ @@email = Param.new('email', 'com.zoho.crm.api.Record.RecordCountParam')
833
+ def self.email
834
+ @@email
835
+ end
836
+ @@phone = Param.new('phone', 'com.zoho.crm.api.Record.RecordCountParam')
837
+ def self.phone
838
+ @@phone
839
+ end
840
+ @@word = Param.new('word', 'com.zoho.crm.api.Record.RecordCountParam')
841
+ def self.word
842
+ @@word
843
+ end
844
+ end
845
+
846
+ end
847
+ end