ZCRMSDK 1.0.1 → 2.0.0

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