ZOHOCRMSDK2_0_docgo 6.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (374) hide show
  1. checksums.yaml +7 -0
  2. data/src/ZOHOCRMSDK2_0_docgo.rb +370 -0
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +285 -0
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +194 -0
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +238 -0
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +35 -0
  7. data/src/com/zoho/api/authenticator/token.rb +12 -0
  8. data/src/com/zoho/api/logger/sdk_logger.rb +64 -0
  9. data/src/com/zoho/crm/api/attachments/action_handler.rb +12 -0
  10. data/src/com/zoho/crm/api/attachments/action_response.rb +12 -0
  11. data/src/com/zoho/crm/api/attachments/action_wrapper.rb +65 -0
  12. data/src/com/zoho/crm/api/attachments/api_exception.rb +127 -0
  13. data/src/com/zoho/crm/api/attachments/attachment.rb +369 -0
  14. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +198 -0
  15. data/src/com/zoho/crm/api/attachments/file_body_wrapper.rb +66 -0
  16. data/src/com/zoho/crm/api/attachments/response_handler.rb +12 -0
  17. data/src/com/zoho/crm/api/attachments/response_wrapper.rb +85 -0
  18. data/src/com/zoho/crm/api/attachments/success_response.rb +123 -0
  19. data/src/com/zoho/crm/api/blue_print/action_response.rb +12 -0
  20. data/src/com/zoho/crm/api/blue_print/api_exception.rb +125 -0
  21. data/src/com/zoho/crm/api/blue_print/blue_print.rb +121 -0
  22. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +69 -0
  23. data/src/com/zoho/crm/api/blue_print/body_wrapper.rb +63 -0
  24. data/src/com/zoho/crm/api/blue_print/next_transition.rb +82 -0
  25. data/src/com/zoho/crm/api/blue_print/process_info.rb +253 -0
  26. data/src/com/zoho/crm/api/blue_print/response_handler.rb +12 -0
  27. data/src/com/zoho/crm/api/blue_print/response_wrapper.rb +65 -0
  28. data/src/com/zoho/crm/api/blue_print/success_response.rb +123 -0
  29. data/src/com/zoho/crm/api/blue_print/transition.rb +255 -0
  30. data/src/com/zoho/crm/api/blue_print/validation_error.rb +82 -0
  31. data/src/com/zoho/crm/api/bulk_read/action_handler.rb +12 -0
  32. data/src/com/zoho/crm/api/bulk_read/action_response.rb +12 -0
  33. data/src/com/zoho/crm/api/bulk_read/action_wrapper.rb +84 -0
  34. data/src/com/zoho/crm/api/bulk_read/api_exception.rb +127 -0
  35. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +76 -0
  36. data/src/com/zoho/crm/api/bulk_read/call_back.rb +83 -0
  37. data/src/com/zoho/crm/api/bulk_read/criteria.rb +137 -0
  38. data/src/com/zoho/crm/api/bulk_read/file_body_wrapper.rb +66 -0
  39. data/src/com/zoho/crm/api/bulk_read/job_detail.rb +198 -0
  40. data/src/com/zoho/crm/api/bulk_read/query.rb +139 -0
  41. data/src/com/zoho/crm/api/bulk_read/request_wrapper.rb +102 -0
  42. data/src/com/zoho/crm/api/bulk_read/response_handler.rb +12 -0
  43. data/src/com/zoho/crm/api/bulk_read/response_wrapper.rb +65 -0
  44. data/src/com/zoho/crm/api/bulk_read/result.rb +139 -0
  45. data/src/com/zoho/crm/api/bulk_read/success_response.rb +123 -0
  46. data/src/com/zoho/crm/api/bulk_write/action_response.rb +12 -0
  47. data/src/com/zoho/crm/api/bulk_write/api_exception.rb +241 -0
  48. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +114 -0
  49. data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb +218 -0
  50. data/src/com/zoho/crm/api/bulk_write/call_back.rb +83 -0
  51. data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +158 -0
  52. data/src/com/zoho/crm/api/bulk_write/file.rb +159 -0
  53. data/src/com/zoho/crm/api/bulk_write/file_body_wrapper.rb +66 -0
  54. data/src/com/zoho/crm/api/bulk_write/request_wrapper.rb +121 -0
  55. data/src/com/zoho/crm/api/bulk_write/resource.rb +197 -0
  56. data/src/com/zoho/crm/api/bulk_write/response_handler.rb +12 -0
  57. data/src/com/zoho/crm/api/bulk_write/response_wrapper.rb +12 -0
  58. data/src/com/zoho/crm/api/bulk_write/result.rb +63 -0
  59. data/src/com/zoho/crm/api/bulk_write/success_response.rb +123 -0
  60. data/src/com/zoho/crm/api/contact_roles/action_handler.rb +12 -0
  61. data/src/com/zoho/crm/api/contact_roles/action_response.rb +12 -0
  62. data/src/com/zoho/crm/api/contact_roles/action_wrapper.rb +65 -0
  63. data/src/com/zoho/crm/api/contact_roles/api_exception.rb +131 -0
  64. data/src/com/zoho/crm/api/contact_roles/body_wrapper.rb +63 -0
  65. data/src/com/zoho/crm/api/contact_roles/contact_role.rb +101 -0
  66. data/src/com/zoho/crm/api/contact_roles/contact_role_wrapper.rb +63 -0
  67. data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +270 -0
  68. data/src/com/zoho/crm/api/contact_roles/record_action_handler.rb +12 -0
  69. data/src/com/zoho/crm/api/contact_roles/record_action_wrapper.rb +65 -0
  70. data/src/com/zoho/crm/api/contact_roles/record_body_wrapper.rb +63 -0
  71. data/src/com/zoho/crm/api/contact_roles/record_response_handler.rb +12 -0
  72. data/src/com/zoho/crm/api/contact_roles/record_response_wrapper.rb +86 -0
  73. data/src/com/zoho/crm/api/contact_roles/response_handler.rb +12 -0
  74. data/src/com/zoho/crm/api/contact_roles/response_wrapper.rb +65 -0
  75. data/src/com/zoho/crm/api/contact_roles/success_response.rb +123 -0
  76. data/src/com/zoho/crm/api/currencies/action_handler.rb +12 -0
  77. data/src/com/zoho/crm/api/currencies/action_response.rb +12 -0
  78. data/src/com/zoho/crm/api/currencies/action_wrapper.rb +65 -0
  79. data/src/com/zoho/crm/api/currencies/api_exception.rb +129 -0
  80. data/src/com/zoho/crm/api/currencies/base_currency_action_handler.rb +12 -0
  81. data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb +65 -0
  82. data/src/com/zoho/crm/api/currencies/base_currency_wrapper.rb +63 -0
  83. data/src/com/zoho/crm/api/currencies/body_wrapper.rb +63 -0
  84. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +151 -0
  85. data/src/com/zoho/crm/api/currencies/currency.rb +292 -0
  86. data/src/com/zoho/crm/api/currencies/format.rb +102 -0
  87. data/src/com/zoho/crm/api/currencies/response_handler.rb +12 -0
  88. data/src/com/zoho/crm/api/currencies/response_wrapper.rb +65 -0
  89. data/src/com/zoho/crm/api/currencies/success_response.rb +123 -0
  90. data/src/com/zoho/crm/api/custom_views/api_exception.rb +123 -0
  91. data/src/com/zoho/crm/api/custom_views/criteria.rb +137 -0
  92. data/src/com/zoho/crm/api/custom_views/custom_view.rb +329 -0
  93. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +75 -0
  94. data/src/com/zoho/crm/api/custom_views/info.rb +158 -0
  95. data/src/com/zoho/crm/api/custom_views/range.rb +82 -0
  96. data/src/com/zoho/crm/api/custom_views/response_handler.rb +12 -0
  97. data/src/com/zoho/crm/api/custom_views/response_wrapper.rb +84 -0
  98. data/src/com/zoho/crm/api/custom_views/shared_details.rb +120 -0
  99. data/src/com/zoho/crm/api/custom_views/translation.rb +120 -0
  100. data/src/com/zoho/crm/api/dc/au_datacenter.rb +21 -0
  101. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +21 -0
  102. data/src/com/zoho/crm/api/dc/datacenter.rb +23 -0
  103. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +21 -0
  104. data/src/com/zoho/crm/api/dc/in_datacenter.rb +21 -0
  105. data/src/com/zoho/crm/api/dc/jp_datacenter.rb +21 -0
  106. data/src/com/zoho/crm/api/dc/us_datacenter.rb +21 -0
  107. data/src/com/zoho/crm/api/exception/sdk_exception.rb +49 -0
  108. data/src/com/zoho/crm/api/fields/api_exception.rb +123 -0
  109. data/src/com/zoho/crm/api/fields/association_details.rb +82 -0
  110. data/src/com/zoho/crm/api/fields/auto_number.rb +101 -0
  111. data/src/com/zoho/crm/api/fields/crypt.rb +158 -0
  112. data/src/com/zoho/crm/api/fields/currency.rb +82 -0
  113. data/src/com/zoho/crm/api/fields/field.rb +958 -0
  114. data/src/com/zoho/crm/api/fields/fields_operations.rb +71 -0
  115. data/src/com/zoho/crm/api/fields/formula.rb +82 -0
  116. data/src/com/zoho/crm/api/fields/lookup_field.rb +82 -0
  117. data/src/com/zoho/crm/api/fields/module.rb +159 -0
  118. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +158 -0
  119. data/src/com/zoho/crm/api/fields/pick_list_value.rb +177 -0
  120. data/src/com/zoho/crm/api/fields/private.rb +101 -0
  121. data/src/com/zoho/crm/api/fields/related_details.rb +139 -0
  122. data/src/com/zoho/crm/api/fields/response_handler.rb +12 -0
  123. data/src/com/zoho/crm/api/fields/response_wrapper.rb +65 -0
  124. data/src/com/zoho/crm/api/fields/tool_tip.rb +82 -0
  125. data/src/com/zoho/crm/api/fields/unique.rb +63 -0
  126. data/src/com/zoho/crm/api/fields/view_type.rb +120 -0
  127. data/src/com/zoho/crm/api/files/action_handler.rb +12 -0
  128. data/src/com/zoho/crm/api/files/action_response.rb +12 -0
  129. data/src/com/zoho/crm/api/files/action_wrapper.rb +65 -0
  130. data/src/com/zoho/crm/api/files/api_exception.rb +127 -0
  131. data/src/com/zoho/crm/api/files/body_wrapper.rb +64 -0
  132. data/src/com/zoho/crm/api/files/file_body_wrapper.rb +66 -0
  133. data/src/com/zoho/crm/api/files/file_operations.rb +75 -0
  134. data/src/com/zoho/crm/api/files/response_handler.rb +12 -0
  135. data/src/com/zoho/crm/api/files/success_response.rb +123 -0
  136. data/src/com/zoho/crm/api/header.rb +12 -0
  137. data/src/com/zoho/crm/api/header_map.rb +57 -0
  138. data/src/com/zoho/crm/api/initializer.rb +255 -0
  139. data/src/com/zoho/crm/api/layouts/api_exception.rb +123 -0
  140. data/src/com/zoho/crm/api/layouts/layout.rb +274 -0
  141. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +61 -0
  142. data/src/com/zoho/crm/api/layouts/properties.rb +102 -0
  143. data/src/com/zoho/crm/api/layouts/response_handler.rb +12 -0
  144. data/src/com/zoho/crm/api/layouts/response_wrapper.rb +65 -0
  145. data/src/com/zoho/crm/api/layouts/section.rb +235 -0
  146. data/src/com/zoho/crm/api/modules/action_handler.rb +12 -0
  147. data/src/com/zoho/crm/api/modules/action_response.rb +12 -0
  148. data/src/com/zoho/crm/api/modules/action_wrapper.rb +65 -0
  149. data/src/com/zoho/crm/api/modules/api_exception.rb +127 -0
  150. data/src/com/zoho/crm/api/modules/argument.rb +82 -0
  151. data/src/com/zoho/crm/api/modules/body_wrapper.rb +63 -0
  152. data/src/com/zoho/crm/api/modules/module.rb +884 -0
  153. data/src/com/zoho/crm/api/modules/modules_operations.rb +109 -0
  154. data/src/com/zoho/crm/api/modules/related_list_properties.rb +101 -0
  155. data/src/com/zoho/crm/api/modules/response_handler.rb +12 -0
  156. data/src/com/zoho/crm/api/modules/response_wrapper.rb +65 -0
  157. data/src/com/zoho/crm/api/modules/success_response.rb +123 -0
  158. data/src/com/zoho/crm/api/modules/territory.rb +101 -0
  159. data/src/com/zoho/crm/api/notes/action_handler.rb +12 -0
  160. data/src/com/zoho/crm/api/notes/action_response.rb +12 -0
  161. data/src/com/zoho/crm/api/notes/action_wrapper.rb +65 -0
  162. data/src/com/zoho/crm/api/notes/api_exception.rb +127 -0
  163. data/src/com/zoho/crm/api/notes/body_wrapper.rb +63 -0
  164. data/src/com/zoho/crm/api/notes/info.rb +120 -0
  165. data/src/com/zoho/crm/api/notes/note.rb +351 -0
  166. data/src/com/zoho/crm/api/notes/notes_operations.rb +214 -0
  167. data/src/com/zoho/crm/api/notes/response_handler.rb +12 -0
  168. data/src/com/zoho/crm/api/notes/response_wrapper.rb +84 -0
  169. data/src/com/zoho/crm/api/notes/success_response.rb +123 -0
  170. data/src/com/zoho/crm/api/notification/action_handler.rb +12 -0
  171. data/src/com/zoho/crm/api/notification/action_response.rb +12 -0
  172. data/src/com/zoho/crm/api/notification/action_wrapper.rb +65 -0
  173. data/src/com/zoho/crm/api/notification/api_exception.rb +127 -0
  174. data/src/com/zoho/crm/api/notification/body_wrapper.rb +63 -0
  175. data/src/com/zoho/crm/api/notification/info.rb +120 -0
  176. data/src/com/zoho/crm/api/notification/notification.rb +253 -0
  177. data/src/com/zoho/crm/api/notification/notification_operations.rb +160 -0
  178. data/src/com/zoho/crm/api/notification/response_handler.rb +12 -0
  179. data/src/com/zoho/crm/api/notification/response_wrapper.rb +84 -0
  180. data/src/com/zoho/crm/api/notification/success_response.rb +123 -0
  181. data/src/com/zoho/crm/api/org/action_response.rb +12 -0
  182. data/src/com/zoho/crm/api/org/api_exception.rb +125 -0
  183. data/src/com/zoho/crm/api/org/file_body_wrapper.rb +64 -0
  184. data/src/com/zoho/crm/api/org/license_details.rb +158 -0
  185. data/src/com/zoho/crm/api/org/org.rb +633 -0
  186. data/src/com/zoho/crm/api/org/org_operations.rb +49 -0
  187. data/src/com/zoho/crm/api/org/response_handler.rb +12 -0
  188. data/src/com/zoho/crm/api/org/response_wrapper.rb +65 -0
  189. data/src/com/zoho/crm/api/org/success_response.rb +123 -0
  190. data/src/com/zoho/crm/api/param.rb +12 -0
  191. data/src/com/zoho/crm/api/parameter_map.rb +56 -0
  192. data/src/com/zoho/crm/api/profiles/api_exception.rb +123 -0
  193. data/src/com/zoho/crm/api/profiles/category.rb +101 -0
  194. data/src/com/zoho/crm/api/profiles/permission_detail.rb +139 -0
  195. data/src/com/zoho/crm/api/profiles/profile.rb +292 -0
  196. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +61 -0
  197. data/src/com/zoho/crm/api/profiles/response_handler.rb +12 -0
  198. data/src/com/zoho/crm/api/profiles/response_wrapper.rb +65 -0
  199. data/src/com/zoho/crm/api/profiles/section.rb +82 -0
  200. data/src/com/zoho/crm/api/query/api_exception.rb +123 -0
  201. data/src/com/zoho/crm/api/query/body_wrapper.rb +63 -0
  202. data/src/com/zoho/crm/api/query/query_operations.rb +36 -0
  203. data/src/com/zoho/crm/api/query/response_handler.rb +12 -0
  204. data/src/com/zoho/crm/api/query/response_wrapper.rb +86 -0
  205. data/src/com/zoho/crm/api/record/action_handler.rb +12 -0
  206. data/src/com/zoho/crm/api/record/action_response.rb +12 -0
  207. data/src/com/zoho/crm/api/record/action_wrapper.rb +65 -0
  208. data/src/com/zoho/crm/api/record/api_exception.rb +145 -0
  209. data/src/com/zoho/crm/api/record/apply_feature_execution.rb +63 -0
  210. data/src/com/zoho/crm/api/record/body_wrapper.rb +177 -0
  211. data/src/com/zoho/crm/api/record/carry_over_tags.rb +101 -0
  212. data/src/com/zoho/crm/api/record/comment.rb +120 -0
  213. data/src/com/zoho/crm/api/record/consent.rb +187 -0
  214. data/src/com/zoho/crm/api/record/convert_action_handler.rb +12 -0
  215. data/src/com/zoho/crm/api/record/convert_action_response.rb +12 -0
  216. data/src/com/zoho/crm/api/record/convert_action_wrapper.rb +65 -0
  217. data/src/com/zoho/crm/api/record/convert_body_wrapper.rb +63 -0
  218. data/src/com/zoho/crm/api/record/criteria.rb +137 -0
  219. data/src/com/zoho/crm/api/record/deleted_record.rb +159 -0
  220. data/src/com/zoho/crm/api/record/deleted_records_handler.rb +12 -0
  221. data/src/com/zoho/crm/api/record/deleted_records_wrapper.rb +84 -0
  222. data/src/com/zoho/crm/api/record/download_handler.rb +12 -0
  223. data/src/com/zoho/crm/api/record/field.rb +2111 -0
  224. data/src/com/zoho/crm/api/record/file_body_wrapper.rb +68 -0
  225. data/src/com/zoho/crm/api/record/file_details.rb +329 -0
  226. data/src/com/zoho/crm/api/record/file_handler.rb +12 -0
  227. data/src/com/zoho/crm/api/record/info.rb +120 -0
  228. data/src/com/zoho/crm/api/record/inventory_line_items.rb +237 -0
  229. data/src/com/zoho/crm/api/record/lead_converter.rb +196 -0
  230. data/src/com/zoho/crm/api/record/line_item_product.rb +67 -0
  231. data/src/com/zoho/crm/api/record/line_tax.rb +120 -0
  232. data/src/com/zoho/crm/api/record/mass_update.rb +142 -0
  233. data/src/com/zoho/crm/api/record/mass_update_action_handler.rb +12 -0
  234. data/src/com/zoho/crm/api/record/mass_update_action_response.rb +12 -0
  235. data/src/com/zoho/crm/api/record/mass_update_action_wrapper.rb +65 -0
  236. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +158 -0
  237. data/src/com/zoho/crm/api/record/mass_update_response.rb +12 -0
  238. data/src/com/zoho/crm/api/record/mass_update_response_handler.rb +12 -0
  239. data/src/com/zoho/crm/api/record/mass_update_response_wrapper.rb +65 -0
  240. data/src/com/zoho/crm/api/record/mass_update_success_response.rb +123 -0
  241. data/src/com/zoho/crm/api/record/options.rb +12 -0
  242. data/src/com/zoho/crm/api/record/participants.rb +118 -0
  243. data/src/com/zoho/crm/api/record/pricing_details.rb +67 -0
  244. data/src/com/zoho/crm/api/record/record.rb +194 -0
  245. data/src/com/zoho/crm/api/record/record_operations.rb +961 -0
  246. data/src/com/zoho/crm/api/record/recurring_activity.rb +63 -0
  247. data/src/com/zoho/crm/api/record/remind_at.rb +63 -0
  248. data/src/com/zoho/crm/api/record/reminder.rb +82 -0
  249. data/src/com/zoho/crm/api/record/response_handler.rb +12 -0
  250. data/src/com/zoho/crm/api/record/response_wrapper.rb +84 -0
  251. data/src/com/zoho/crm/api/record/success_response.rb +163 -0
  252. data/src/com/zoho/crm/api/record/successful_convert.rb +103 -0
  253. data/src/com/zoho/crm/api/record/territory.rb +82 -0
  254. data/src/com/zoho/crm/api/related_lists/api_exception.rb +123 -0
  255. data/src/com/zoho/crm/api/related_lists/related_list.rb +253 -0
  256. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +61 -0
  257. data/src/com/zoho/crm/api/related_lists/response_handler.rb +12 -0
  258. data/src/com/zoho/crm/api/related_lists/response_wrapper.rb +65 -0
  259. data/src/com/zoho/crm/api/related_records/action_handler.rb +12 -0
  260. data/src/com/zoho/crm/api/related_records/action_response.rb +12 -0
  261. data/src/com/zoho/crm/api/related_records/action_wrapper.rb +65 -0
  262. data/src/com/zoho/crm/api/related_records/api_exception.rb +127 -0
  263. data/src/com/zoho/crm/api/related_records/body_wrapper.rb +64 -0
  264. data/src/com/zoho/crm/api/related_records/file_body_wrapper.rb +66 -0
  265. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +524 -0
  266. data/src/com/zoho/crm/api/related_records/response_handler.rb +12 -0
  267. data/src/com/zoho/crm/api/related_records/response_wrapper.rb +86 -0
  268. data/src/com/zoho/crm/api/related_records/success_response.rb +123 -0
  269. data/src/com/zoho/crm/api/request_proxy.rb +17 -0
  270. data/src/com/zoho/crm/api/roles/api_exception.rb +123 -0
  271. data/src/com/zoho/crm/api/roles/response_handler.rb +12 -0
  272. data/src/com/zoho/crm/api/roles/response_wrapper.rb +65 -0
  273. data/src/com/zoho/crm/api/roles/role.rb +197 -0
  274. data/src/com/zoho/crm/api/roles/roles_operations.rb +47 -0
  275. data/src/com/zoho/crm/api/sdk_config.rb +15 -0
  276. data/src/com/zoho/crm/api/share_records/action_handler.rb +12 -0
  277. data/src/com/zoho/crm/api/share_records/action_response.rb +12 -0
  278. data/src/com/zoho/crm/api/share_records/action_wrapper.rb +65 -0
  279. data/src/com/zoho/crm/api/share_records/api_exception.rb +131 -0
  280. data/src/com/zoho/crm/api/share_records/body_wrapper.rb +63 -0
  281. data/src/com/zoho/crm/api/share_records/delete_action_handler.rb +12 -0
  282. data/src/com/zoho/crm/api/share_records/delete_action_response.rb +12 -0
  283. data/src/com/zoho/crm/api/share_records/delete_action_wrapper.rb +65 -0
  284. data/src/com/zoho/crm/api/share_records/response_handler.rb +12 -0
  285. data/src/com/zoho/crm/api/share_records/response_wrapper.rb +85 -0
  286. data/src/com/zoho/crm/api/share_records/share_record.rb +159 -0
  287. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +130 -0
  288. data/src/com/zoho/crm/api/share_records/shared_through.rb +102 -0
  289. data/src/com/zoho/crm/api/share_records/success_response.rb +125 -0
  290. data/src/com/zoho/crm/api/tags/action_handler.rb +12 -0
  291. data/src/com/zoho/crm/api/tags/action_response.rb +12 -0
  292. data/src/com/zoho/crm/api/tags/action_wrapper.rb +65 -0
  293. data/src/com/zoho/crm/api/tags/api_exception.rb +133 -0
  294. data/src/com/zoho/crm/api/tags/body_wrapper.rb +63 -0
  295. data/src/com/zoho/crm/api/tags/conflict_wrapper.rb +63 -0
  296. data/src/com/zoho/crm/api/tags/count_handler.rb +12 -0
  297. data/src/com/zoho/crm/api/tags/count_wrapper.rb +65 -0
  298. data/src/com/zoho/crm/api/tags/info.rb +82 -0
  299. data/src/com/zoho/crm/api/tags/merge_wrapper.rb +63 -0
  300. data/src/com/zoho/crm/api/tags/record_action_handler.rb +12 -0
  301. data/src/com/zoho/crm/api/tags/record_action_response.rb +12 -0
  302. data/src/com/zoho/crm/api/tags/record_action_wrapper.rb +122 -0
  303. data/src/com/zoho/crm/api/tags/response_handler.rb +12 -0
  304. data/src/com/zoho/crm/api/tags/response_wrapper.rb +84 -0
  305. data/src/com/zoho/crm/api/tags/success_response.rb +125 -0
  306. data/src/com/zoho/crm/api/tags/tag.rb +159 -0
  307. data/src/com/zoho/crm/api/tags/tags_operations.rb +382 -0
  308. data/src/com/zoho/crm/api/taxes/action_handler.rb +12 -0
  309. data/src/com/zoho/crm/api/taxes/action_response.rb +12 -0
  310. data/src/com/zoho/crm/api/taxes/action_wrapper.rb +65 -0
  311. data/src/com/zoho/crm/api/taxes/api_exception.rb +127 -0
  312. data/src/com/zoho/crm/api/taxes/body_wrapper.rb +63 -0
  313. data/src/com/zoho/crm/api/taxes/preference.rb +82 -0
  314. data/src/com/zoho/crm/api/taxes/response_handler.rb +12 -0
  315. data/src/com/zoho/crm/api/taxes/response_wrapper.rb +84 -0
  316. data/src/com/zoho/crm/api/taxes/success_response.rb +123 -0
  317. data/src/com/zoho/crm/api/taxes/tax.rb +139 -0
  318. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +132 -0
  319. data/src/com/zoho/crm/api/territories/api_exception.rb +123 -0
  320. data/src/com/zoho/crm/api/territories/response_handler.rb +12 -0
  321. data/src/com/zoho/crm/api/territories/response_wrapper.rb +65 -0
  322. data/src/com/zoho/crm/api/territories/territories_operations.rb +47 -0
  323. data/src/com/zoho/crm/api/territories/territory.rb +236 -0
  324. data/src/com/zoho/crm/api/user_signature.rb +29 -0
  325. data/src/com/zoho/crm/api/users/action_handler.rb +12 -0
  326. data/src/com/zoho/crm/api/users/action_response.rb +12 -0
  327. data/src/com/zoho/crm/api/users/action_wrapper.rb +65 -0
  328. data/src/com/zoho/crm/api/users/api_exception.rb +127 -0
  329. data/src/com/zoho/crm/api/users/body_wrapper.rb +63 -0
  330. data/src/com/zoho/crm/api/users/customize_info.rb +158 -0
  331. data/src/com/zoho/crm/api/users/info.rb +120 -0
  332. data/src/com/zoho/crm/api/users/request_wrapper.rb +63 -0
  333. data/src/com/zoho/crm/api/users/response_handler.rb +12 -0
  334. data/src/com/zoho/crm/api/users/response_wrapper.rb +84 -0
  335. data/src/com/zoho/crm/api/users/shift.rb +82 -0
  336. data/src/com/zoho/crm/api/users/success_response.rb +123 -0
  337. data/src/com/zoho/crm/api/users/tab_theme.rb +82 -0
  338. data/src/com/zoho/crm/api/users/territory.rb +101 -0
  339. data/src/com/zoho/crm/api/users/theme.rb +158 -0
  340. data/src/com/zoho/crm/api/users/user.rb +698 -0
  341. data/src/com/zoho/crm/api/users/users_operations.rb +177 -0
  342. data/src/com/zoho/crm/api/util/api_http_connector.rb +114 -0
  343. data/src/com/zoho/crm/api/util/api_response.rb +18 -0
  344. data/src/com/zoho/crm/api/util/choice.rb +11 -0
  345. data/src/com/zoho/crm/api/util/common_api_handler.rb +241 -0
  346. data/src/com/zoho/crm/api/util/constants.rb +646 -0
  347. data/src/com/zoho/crm/api/util/converter.rb +238 -0
  348. data/src/com/zoho/crm/api/util/data_type_converter.rb +170 -0
  349. data/src/com/zoho/crm/api/util/downloader.rb +86 -0
  350. data/src/com/zoho/crm/api/util/form_data_converter.rb +159 -0
  351. data/src/com/zoho/crm/api/util/header_param_validator.rb +57 -0
  352. data/src/com/zoho/crm/api/util/json_converter.rb +729 -0
  353. data/src/com/zoho/crm/api/util/model.rb +7 -0
  354. data/src/com/zoho/crm/api/util/module_fields_handler.rb +80 -0
  355. data/src/com/zoho/crm/api/util/stream_wrapper.rb +39 -0
  356. data/src/com/zoho/crm/api/util/utility.rb +871 -0
  357. data/src/com/zoho/crm/api/variable_groups/api_exception.rb +123 -0
  358. data/src/com/zoho/crm/api/variable_groups/response_handler.rb +12 -0
  359. data/src/com/zoho/crm/api/variable_groups/response_wrapper.rb +65 -0
  360. data/src/com/zoho/crm/api/variable_groups/variable_group.rb +139 -0
  361. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +65 -0
  362. data/src/com/zoho/crm/api/variables/action_handler.rb +12 -0
  363. data/src/com/zoho/crm/api/variables/action_response.rb +12 -0
  364. data/src/com/zoho/crm/api/variables/action_wrapper.rb +65 -0
  365. data/src/com/zoho/crm/api/variables/api_exception.rb +127 -0
  366. data/src/com/zoho/crm/api/variables/body_wrapper.rb +63 -0
  367. data/src/com/zoho/crm/api/variables/response_handler.rb +12 -0
  368. data/src/com/zoho/crm/api/variables/response_wrapper.rb +65 -0
  369. data/src/com/zoho/crm/api/variables/success_response.rb +123 -0
  370. data/src/com/zoho/crm/api/variables/variable.rb +175 -0
  371. data/src/com/zoho/crm/api/variables/variables_operations.rb +234 -0
  372. data/src/resources/JSONDetails.json +1 -0
  373. data/src/version.rb +3 -0
  374. metadata +500 -0
@@ -0,0 +1,524 @@
1
+ require_relative '../header'
2
+ require_relative '../header_map'
3
+ require_relative '../param'
4
+ require_relative '../parameter_map'
5
+ require_relative '../exception/sdk_exception'
6
+ require_relative '../util/api_response'
7
+ require_relative '../util/common_api_handler'
8
+ require_relative '../util/utility'
9
+ require_relative '../util/constants'
10
+
11
+ module ZOHOCRMSDK
12
+ module RelatedRecords
13
+ class RelatedRecordsOperations
14
+
15
+ # Creates an instance of RelatedRecordsOperations with the given parameters
16
+ # @param related_list_api_name [String] A String
17
+ # @param module_api_name [String] A String
18
+ # @param x_external [String] A String
19
+ def initialize(related_list_api_name, module_api_name, x_external=nil)
20
+ if !related_list_api_name.is_a? String
21
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_list_api_name EXPECTED TYPE: String', nil, nil)
22
+ end
23
+ if !module_api_name.is_a? String
24
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
25
+ end
26
+ if x_external!=nil and !x_external.is_a? String
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: x_external EXPECTED TYPE: String', nil, nil)
28
+ end
29
+ @related_list_api_name = related_list_api_name
30
+ @module_api_name = module_api_name
31
+ @x_external = x_external
32
+ end
33
+
34
+ # The method to get related records
35
+ # @param record_id [Integer] A Integer
36
+ # @param param_instance [ParameterMap] An instance of ParameterMap
37
+ # @param header_instance [HeaderMap] An instance of HeaderMap
38
+ # @return An instance of APIResponse
39
+ # @raise SDKException
40
+ def get_related_records(record_id, param_instance=nil, header_instance=nil)
41
+ if !record_id.is_a? Integer
42
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
43
+ end
44
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
45
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
46
+ end
47
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
48
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
49
+ end
50
+ handler_instance = Handler::CommonAPIHandler.new
51
+ api_path = ''
52
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
53
+ api_path = api_path + @module_api_name.to_s
54
+ api_path = api_path + '/'
55
+ api_path = api_path + record_id.to_s
56
+ api_path = api_path + '/'
57
+ api_path = api_path + @related_list_api_name.to_s
58
+ handler_instance.api_path = api_path
59
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
60
+ handler_instance.category_method = 'READ'
61
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader'), @x_external)
62
+ handler_instance.param = param_instance
63
+ handler_instance.header = header_instance
64
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
65
+ require_relative 'response_handler'
66
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
67
+ end
68
+
69
+ # The method to update related records
70
+ # @param record_id [Integer] A Integer
71
+ # @param request [BodyWrapper] An instance of BodyWrapper
72
+ # @return An instance of APIResponse
73
+ # @raise SDKException
74
+ def update_related_records(record_id, request)
75
+ if !record_id.is_a? Integer
76
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
77
+ end
78
+ if request!=nil and !request.is_a? BodyWrapper
79
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
80
+ end
81
+ handler_instance = Handler::CommonAPIHandler.new
82
+ api_path = ''
83
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
84
+ api_path = api_path + @module_api_name.to_s
85
+ api_path = api_path + '/'
86
+ api_path = api_path + record_id.to_s
87
+ api_path = api_path + '/'
88
+ api_path = api_path + @related_list_api_name.to_s
89
+ handler_instance.api_path = api_path
90
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
91
+ handler_instance.category_method = 'UPDATE'
92
+ handler_instance.content_type = 'application/json'
93
+ handler_instance.request = request
94
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordsHeader'), @x_external)
95
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
96
+ require_relative 'action_handler'
97
+ handler_instance.api_call(ActionHandler.name, 'application/json')
98
+ end
99
+
100
+ # The method to delink records
101
+ # @param record_id [Integer] A Integer
102
+ # @param param_instance [ParameterMap] An instance of ParameterMap
103
+ # @return An instance of APIResponse
104
+ # @raise SDKException
105
+ def delink_records(record_id, param_instance=nil)
106
+ if !record_id.is_a? Integer
107
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
108
+ end
109
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
110
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
111
+ end
112
+ handler_instance = Handler::CommonAPIHandler.new
113
+ api_path = ''
114
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
115
+ api_path = api_path + @module_api_name.to_s
116
+ api_path = api_path + '/'
117
+ api_path = api_path + record_id.to_s
118
+ api_path = api_path + '/'
119
+ api_path = api_path + @related_list_api_name.to_s
120
+ handler_instance.api_path = api_path
121
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
122
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
123
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsHeader'), @x_external)
124
+ handler_instance.param = param_instance
125
+ Util::Utility.get_fields(@module_api_name, handler_instance)
126
+ require_relative 'action_handler'
127
+ handler_instance.api_call(ActionHandler.name, 'application/json')
128
+ end
129
+
130
+ # The method to get related records using external id
131
+ # @param external_value [String] A String
132
+ # @param param_instance [ParameterMap] An instance of ParameterMap
133
+ # @param header_instance [HeaderMap] An instance of HeaderMap
134
+ # @return An instance of APIResponse
135
+ # @raise SDKException
136
+ def get_related_records_using_external_id(external_value, param_instance=nil, header_instance=nil)
137
+ if !external_value.is_a? String
138
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: String', nil, nil)
139
+ end
140
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
141
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
142
+ end
143
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
144
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
145
+ end
146
+ handler_instance = Handler::CommonAPIHandler.new
147
+ api_path = ''
148
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
149
+ api_path = api_path + @module_api_name.to_s
150
+ api_path = api_path + '/'
151
+ api_path = api_path + external_value.to_s
152
+ api_path = api_path + '/'
153
+ api_path = api_path + @related_list_api_name.to_s
154
+ handler_instance.api_path = api_path
155
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
156
+ handler_instance.category_method = 'READ'
157
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDHeader'), @x_external)
158
+ handler_instance.param = param_instance
159
+ handler_instance.header = header_instance
160
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
161
+ require_relative 'response_handler'
162
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
163
+ end
164
+
165
+ # The method to update related records using external id
166
+ # @param external_value [String] A String
167
+ # @param request [BodyWrapper] An instance of BodyWrapper
168
+ # @return An instance of APIResponse
169
+ # @raise SDKException
170
+ def update_related_records_using_external_id(external_value, request)
171
+ if !external_value.is_a? String
172
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: String', nil, nil)
173
+ end
174
+ if request!=nil and !request.is_a? BodyWrapper
175
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
176
+ end
177
+ handler_instance = Handler::CommonAPIHandler.new
178
+ api_path = ''
179
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
180
+ api_path = api_path + @module_api_name.to_s
181
+ api_path = api_path + '/'
182
+ api_path = api_path + external_value.to_s
183
+ api_path = api_path + '/'
184
+ api_path = api_path + @related_list_api_name.to_s
185
+ handler_instance.api_path = api_path
186
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
187
+ handler_instance.category_method = 'UPDATE'
188
+ handler_instance.content_type = 'application/json'
189
+ handler_instance.request = request
190
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordsUsingExternalIDHeader'), @x_external)
191
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
192
+ require_relative 'action_handler'
193
+ handler_instance.api_call(ActionHandler.name, 'application/json')
194
+ end
195
+
196
+ # The method to delete related records using external id
197
+ # @param external_value [String] A String
198
+ # @param param_instance [ParameterMap] An instance of ParameterMap
199
+ # @return An instance of APIResponse
200
+ # @raise SDKException
201
+ def delete_related_records_using_external_id(external_value, param_instance=nil)
202
+ if !external_value.is_a? String
203
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: String', nil, nil)
204
+ end
205
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
206
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
207
+ end
208
+ handler_instance = Handler::CommonAPIHandler.new
209
+ api_path = ''
210
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
211
+ api_path = api_path + @module_api_name.to_s
212
+ api_path = api_path + '/'
213
+ api_path = api_path + external_value.to_s
214
+ api_path = api_path + '/'
215
+ api_path = api_path + @related_list_api_name.to_s
216
+ handler_instance.api_path = api_path
217
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
218
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
219
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordsUsingExternalIDHeader'), @x_external)
220
+ handler_instance.param = param_instance
221
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
222
+ require_relative 'action_handler'
223
+ handler_instance.api_call(ActionHandler.name, 'application/json')
224
+ end
225
+
226
+ # The method to get related record
227
+ # @param related_record_id [Integer] A Integer
228
+ # @param record_id [Integer] A Integer
229
+ # @param header_instance [HeaderMap] An instance of HeaderMap
230
+ # @return An instance of APIResponse
231
+ # @raise SDKException
232
+ def get_related_record(related_record_id, record_id, header_instance=nil)
233
+ if !related_record_id.is_a? Integer
234
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: Integer', nil, nil)
235
+ end
236
+ if !record_id.is_a? Integer
237
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
238
+ end
239
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
240
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
241
+ end
242
+ handler_instance = Handler::CommonAPIHandler.new
243
+ api_path = ''
244
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
245
+ api_path = api_path + @module_api_name.to_s
246
+ api_path = api_path + '/'
247
+ api_path = api_path + record_id.to_s
248
+ api_path = api_path + '/'
249
+ api_path = api_path + @related_list_api_name.to_s
250
+ api_path = api_path + '/'
251
+ api_path = api_path + related_record_id.to_s
252
+ handler_instance.api_path = api_path
253
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
254
+ handler_instance.category_method = 'READ'
255
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordHeader'), @x_external)
256
+ handler_instance.header = header_instance
257
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
258
+ require_relative 'response_handler'
259
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
260
+ end
261
+
262
+ # The method to update related record
263
+ # @param related_record_id [Integer] A Integer
264
+ # @param record_id [Integer] A Integer
265
+ # @param request [BodyWrapper] An instance of BodyWrapper
266
+ # @return An instance of APIResponse
267
+ # @raise SDKException
268
+ def update_related_record(related_record_id, record_id, request)
269
+ if !related_record_id.is_a? Integer
270
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: Integer', nil, nil)
271
+ end
272
+ if !record_id.is_a? Integer
273
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
274
+ end
275
+ if request!=nil and !request.is_a? BodyWrapper
276
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
277
+ end
278
+ handler_instance = Handler::CommonAPIHandler.new
279
+ api_path = ''
280
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
281
+ api_path = api_path + @module_api_name.to_s
282
+ api_path = api_path + '/'
283
+ api_path = api_path + record_id.to_s
284
+ api_path = api_path + '/'
285
+ api_path = api_path + @related_list_api_name.to_s
286
+ api_path = api_path + '/'
287
+ api_path = api_path + related_record_id.to_s
288
+ handler_instance.api_path = api_path
289
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
290
+ handler_instance.category_method = 'UPDATE'
291
+ handler_instance.content_type = 'application/json'
292
+ handler_instance.request = request
293
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordHeader'), @x_external)
294
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
295
+ require_relative 'action_handler'
296
+ handler_instance.api_call(ActionHandler.name, 'application/json')
297
+ end
298
+
299
+ # The method to delink record
300
+ # @param related_record_id [Integer] A Integer
301
+ # @param record_id [Integer] A Integer
302
+ # @return An instance of APIResponse
303
+ # @raise SDKException
304
+ def delink_record(related_record_id, record_id)
305
+ if !related_record_id.is_a? Integer
306
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: Integer', nil, nil)
307
+ end
308
+ if !record_id.is_a? Integer
309
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
310
+ end
311
+ handler_instance = Handler::CommonAPIHandler.new
312
+ api_path = ''
313
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
314
+ api_path = api_path + @module_api_name.to_s
315
+ api_path = api_path + '/'
316
+ api_path = api_path + record_id.to_s
317
+ api_path = api_path + '/'
318
+ api_path = api_path + @related_list_api_name.to_s
319
+ api_path = api_path + '/'
320
+ api_path = api_path + related_record_id.to_s
321
+ handler_instance.api_path = api_path
322
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
323
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
324
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DelinkRecordHeader'), @x_external)
325
+ Util::Utility.get_fields(@module_api_name, handler_instance)
326
+ require_relative 'action_handler'
327
+ handler_instance.api_call(ActionHandler.name, 'application/json')
328
+ end
329
+
330
+ # The method to get related record using external id
331
+ # @param external_field_value [String] A String
332
+ # @param external_value [String] A String
333
+ # @param header_instance [HeaderMap] An instance of HeaderMap
334
+ # @return An instance of APIResponse
335
+ # @raise SDKException
336
+ def get_related_record_using_external_id(external_field_value, external_value, header_instance=nil)
337
+ if !external_field_value.is_a? String
338
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
339
+ end
340
+ if !external_value.is_a? String
341
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: String', nil, nil)
342
+ end
343
+ if header_instance!=nil and !header_instance.is_a? HeaderMap
344
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
345
+ end
346
+ handler_instance = Handler::CommonAPIHandler.new
347
+ api_path = ''
348
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
349
+ api_path = api_path + @module_api_name.to_s
350
+ api_path = api_path + '/'
351
+ api_path = api_path + external_value.to_s
352
+ api_path = api_path + '/'
353
+ api_path = api_path + @related_list_api_name.to_s
354
+ api_path = api_path + '/'
355
+ api_path = api_path + external_field_value.to_s
356
+ handler_instance.api_path = api_path
357
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
358
+ handler_instance.category_method = 'READ'
359
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordUsingExternalIDHeader'), @x_external)
360
+ handler_instance.header = header_instance
361
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
362
+ require_relative 'response_handler'
363
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
364
+ end
365
+
366
+ # The method to update related record using external id
367
+ # @param external_field_value [String] A String
368
+ # @param external_value [String] A String
369
+ # @param request [BodyWrapper] An instance of BodyWrapper
370
+ # @return An instance of APIResponse
371
+ # @raise SDKException
372
+ def update_related_record_using_external_id(external_field_value, external_value, request)
373
+ if !external_field_value.is_a? String
374
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
375
+ end
376
+ if !external_value.is_a? String
377
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: String', nil, nil)
378
+ end
379
+ if request!=nil and !request.is_a? BodyWrapper
380
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
381
+ end
382
+ handler_instance = Handler::CommonAPIHandler.new
383
+ api_path = ''
384
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
385
+ api_path = api_path + @module_api_name.to_s
386
+ api_path = api_path + '/'
387
+ api_path = api_path + external_value.to_s
388
+ api_path = api_path + '/'
389
+ api_path = api_path + @related_list_api_name.to_s
390
+ api_path = api_path + '/'
391
+ api_path = api_path + external_field_value.to_s
392
+ handler_instance.api_path = api_path
393
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
394
+ handler_instance.category_method = 'UPDATE'
395
+ handler_instance.content_type = 'application/json'
396
+ handler_instance.request = request
397
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordUsingExternalIDHeader'), @x_external)
398
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
399
+ require_relative 'action_handler'
400
+ handler_instance.api_call(ActionHandler.name, 'application/json')
401
+ end
402
+
403
+ # The method to delete related record using external id
404
+ # @param external_field_value [String] A String
405
+ # @param external_value [String] A String
406
+ # @return An instance of APIResponse
407
+ # @raise SDKException
408
+ def delete_related_record_using_external_id(external_field_value, external_value)
409
+ if !external_field_value.is_a? String
410
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
411
+ end
412
+ if !external_value.is_a? String
413
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: String', nil, nil)
414
+ end
415
+ handler_instance = Handler::CommonAPIHandler.new
416
+ api_path = ''
417
+ api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
418
+ api_path = api_path + @module_api_name.to_s
419
+ api_path = api_path + '/'
420
+ api_path = api_path + external_value.to_s
421
+ api_path = api_path + '/'
422
+ api_path = api_path + @related_list_api_name.to_s
423
+ api_path = api_path + '/'
424
+ api_path = api_path + external_field_value.to_s
425
+ handler_instance.api_path = api_path
426
+ handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
427
+ handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
428
+ handler_instance.add_header(Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordUsingExternalIDHeader'), @x_external)
429
+ Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
430
+ require_relative 'action_handler'
431
+ handler_instance.api_call(ActionHandler.name, 'application/json')
432
+ end
433
+
434
+ class GetRelatedRecordsHeader
435
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader')
436
+ def self.If_modified_since
437
+ @@If_modified_since
438
+ end
439
+ end
440
+
441
+ class GetRelatedRecordsParam
442
+ @@page = Param.new('page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam')
443
+ def self.page
444
+ @@page
445
+ end
446
+ @@per_page = Param.new('per_page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam')
447
+ def self.per_page
448
+ @@per_page
449
+ end
450
+ end
451
+
452
+ class UpdateRelatedRecordsHeader
453
+ end
454
+
455
+ class DelinkRecordsHeader
456
+ end
457
+
458
+ class DelinkRecordsParam
459
+ @@ids = Param.new('ids', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsParam')
460
+ def self.ids
461
+ @@ids
462
+ end
463
+ end
464
+
465
+ class GetRelatedRecordsUsingExternalIDHeader
466
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDHeader')
467
+ def self.If_modified_since
468
+ @@If_modified_since
469
+ end
470
+ end
471
+
472
+ class GetRelatedRecordsUsingExternalIDParam
473
+ @@page = Param.new('page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDParam')
474
+ def self.page
475
+ @@page
476
+ end
477
+ @@per_page = Param.new('per_page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDParam')
478
+ def self.per_page
479
+ @@per_page
480
+ end
481
+ end
482
+
483
+ class UpdateRelatedRecordsUsingExternalIDHeader
484
+ end
485
+
486
+ class DeleteRelatedRecordsUsingExternalIDHeader
487
+ end
488
+
489
+ class DeleteRelatedRecordsUsingExternalIDParam
490
+ @@ids = Param.new('ids', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordsUsingExternalIDParam')
491
+ def self.ids
492
+ @@ids
493
+ end
494
+ end
495
+
496
+ class GetRelatedRecordHeader
497
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordHeader')
498
+ def self.If_modified_since
499
+ @@If_modified_since
500
+ end
501
+ end
502
+
503
+ class UpdateRelatedRecordHeader
504
+ end
505
+
506
+ class DelinkRecordHeader
507
+ end
508
+
509
+ class GetRelatedRecordUsingExternalIDHeader
510
+ @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordUsingExternalIDHeader')
511
+ def self.If_modified_since
512
+ @@If_modified_since
513
+ end
514
+ end
515
+
516
+ class UpdateRelatedRecordUsingExternalIDHeader
517
+ end
518
+
519
+ class DeleteRelatedRecordUsingExternalIDHeader
520
+ end
521
+
522
+ end
523
+ end
524
+ end
@@ -0,0 +1,12 @@
1
+ module ZOHOCRMSDK
2
+ module RelatedRecords
3
+ module ResponseHandler
4
+
5
+ # Creates an instance of ResponseHandler
6
+ def initialize
7
+ end
8
+
9
+
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,86 @@
1
+ require_relative '../record/info'
2
+ require_relative '../record/record'
3
+ require_relative '../util/model'
4
+
5
+ module ZOHOCRMSDK
6
+ module RelatedRecords
7
+ require_relative 'response_handler'
8
+ class ResponseWrapper
9
+ include Util::Model
10
+ include ResponseHandler
11
+
12
+ # Creates an instance of ResponseWrapper
13
+ def initialize
14
+ @data = nil
15
+ @info = nil
16
+ @key_modified = Hash.new
17
+ end
18
+
19
+ # The method to get the data
20
+ # @return An instance of Array
21
+
22
+ def data
23
+ @data
24
+ end
25
+
26
+ # The method to set the value to data
27
+ # @param data [Array] An instance of Array
28
+
29
+ def data=(data)
30
+ if data!=nil and !data.is_a? Array
31
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Array', nil, nil)
32
+ end
33
+ @data = data
34
+ @key_modified['data'] = 1
35
+ end
36
+
37
+ # The method to get the info
38
+ # @return An instance of Record::Info
39
+
40
+ def info
41
+ @info
42
+ end
43
+
44
+ # The method to set the value to info
45
+ # @param info [Record::Info] An instance of Record::Info
46
+
47
+ def info=(info)
48
+ if info!=nil and !info.is_a? Record::Info
49
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', nil, nil)
50
+ end
51
+ @info = info
52
+ @key_modified['info'] = 1
53
+ end
54
+
55
+ # The method to check if the user has modified the given key
56
+ # @param key [String] A String
57
+ # @return A Integer value
58
+
59
+ def is_key_modified(key)
60
+ if key!=nil and !key.is_a? String
61
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
62
+ end
63
+ if @key_modified.key?(key)
64
+ return @key_modified[key]
65
+ end
66
+
67
+ nil
68
+ end
69
+
70
+ # The method to mark the given key as modified
71
+ # @param key [String] A String
72
+ # @param modification [Integer] A Integer
73
+
74
+ def set_key_modified(key, modification)
75
+ if key!=nil and !key.is_a? String
76
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
77
+ end
78
+ if modification!=nil and !modification.is_a? Integer
79
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
80
+ end
81
+ @key_modified[key] = modification
82
+ end
83
+
84
+ end
85
+ end
86
+ end