ZOHOCRMSDK2_0 1.0.0 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (372) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZOHOCRMSDK2_0.rb +6 -0
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +202 -134
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +141 -97
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +178 -105
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +30 -21
  7. data/src/com/zoho/api/authenticator/token.rb +10 -8
  8. data/src/com/zoho/api/logger/sdk_logger.rb +63 -51
  9. data/src/com/zoho/crm/api/attachments/action_handler.rb +7 -5
  10. data/src/com/zoho/crm/api/attachments/action_response.rb +7 -5
  11. data/src/com/zoho/crm/api/attachments/action_wrapper.rb +48 -46
  12. data/src/com/zoho/crm/api/attachments/api_exception.rb +95 -93
  13. data/src/com/zoho/crm/api/attachments/attachment.rb +271 -269
  14. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +168 -166
  15. data/src/com/zoho/crm/api/attachments/file_body_wrapper.rb +48 -46
  16. data/src/com/zoho/crm/api/attachments/response_handler.rb +7 -5
  17. data/src/com/zoho/crm/api/attachments/response_wrapper.rb +63 -61
  18. data/src/com/zoho/crm/api/attachments/success_response.rb +91 -89
  19. data/src/com/zoho/crm/api/blue_print/action_response.rb +7 -5
  20. data/src/com/zoho/crm/api/blue_print/api_exception.rb +93 -91
  21. data/src/com/zoho/crm/api/blue_print/blue_print.rb +89 -87
  22. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +56 -54
  23. data/src/com/zoho/crm/api/blue_print/body_wrapper.rb +47 -45
  24. data/src/com/zoho/crm/api/blue_print/next_transition.rb +61 -59
  25. data/src/com/zoho/crm/api/blue_print/process_info.rb +187 -185
  26. data/src/com/zoho/crm/api/blue_print/response_handler.rb +7 -5
  27. data/src/com/zoho/crm/api/blue_print/response_wrapper.rb +48 -46
  28. data/src/com/zoho/crm/api/blue_print/success_response.rb +91 -89
  29. data/src/com/zoho/crm/api/blue_print/transition.rb +187 -185
  30. data/src/com/zoho/crm/api/blue_print/validation_error.rb +61 -59
  31. data/src/com/zoho/crm/api/bulk_read/action_handler.rb +7 -5
  32. data/src/com/zoho/crm/api/bulk_read/action_response.rb +7 -5
  33. data/src/com/zoho/crm/api/bulk_read/action_wrapper.rb +63 -61
  34. data/src/com/zoho/crm/api/bulk_read/api_exception.rb +95 -93
  35. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +61 -59
  36. data/src/com/zoho/crm/api/bulk_read/call_back.rb +61 -59
  37. data/src/com/zoho/crm/api/bulk_read/criteria.rb +101 -99
  38. data/src/com/zoho/crm/api/bulk_read/file_body_wrapper.rb +48 -46
  39. data/src/com/zoho/crm/api/bulk_read/job_detail.rb +145 -143
  40. data/src/com/zoho/crm/api/bulk_read/query.rb +103 -101
  41. data/src/com/zoho/crm/api/bulk_read/request_wrapper.rb +75 -73
  42. data/src/com/zoho/crm/api/bulk_read/response_handler.rb +7 -5
  43. data/src/com/zoho/crm/api/bulk_read/response_wrapper.rb +48 -46
  44. data/src/com/zoho/crm/api/bulk_read/result.rb +103 -101
  45. data/src/com/zoho/crm/api/bulk_read/success_response.rb +91 -89
  46. data/src/com/zoho/crm/api/bulk_write/action_response.rb +7 -5
  47. data/src/com/zoho/crm/api/bulk_write/api_exception.rb +179 -177
  48. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +93 -91
  49. data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb +161 -159
  50. data/src/com/zoho/crm/api/bulk_write/call_back.rb +61 -59
  51. data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +117 -115
  52. data/src/com/zoho/crm/api/bulk_write/file.rb +117 -115
  53. data/src/com/zoho/crm/api/bulk_write/file_body_wrapper.rb +48 -46
  54. data/src/com/zoho/crm/api/bulk_write/request_wrapper.rb +89 -87
  55. data/src/com/zoho/crm/api/bulk_write/resource.rb +145 -143
  56. data/src/com/zoho/crm/api/bulk_write/response_handler.rb +7 -5
  57. data/src/com/zoho/crm/api/bulk_write/response_wrapper.rb +7 -5
  58. data/src/com/zoho/crm/api/bulk_write/result.rb +47 -45
  59. data/src/com/zoho/crm/api/bulk_write/success_response.rb +91 -89
  60. data/src/com/zoho/crm/api/contact_roles/action_handler.rb +7 -5
  61. data/src/com/zoho/crm/api/contact_roles/action_response.rb +7 -5
  62. data/src/com/zoho/crm/api/contact_roles/action_wrapper.rb +48 -46
  63. data/src/com/zoho/crm/api/contact_roles/api_exception.rb +99 -93
  64. data/src/com/zoho/crm/api/contact_roles/body_wrapper.rb +47 -45
  65. data/src/com/zoho/crm/api/contact_roles/contact_role.rb +75 -73
  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 +254 -134
  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 +7 -5
  74. data/src/com/zoho/crm/api/contact_roles/response_wrapper.rb +48 -46
  75. data/src/com/zoho/crm/api/contact_roles/success_response.rb +91 -89
  76. data/src/com/zoho/crm/api/currencies/action_handler.rb +7 -5
  77. data/src/com/zoho/crm/api/currencies/action_response.rb +7 -5
  78. data/src/com/zoho/crm/api/currencies/action_wrapper.rb +48 -46
  79. data/src/com/zoho/crm/api/currencies/api_exception.rb +97 -95
  80. data/src/com/zoho/crm/api/currencies/base_currency_action_handler.rb +7 -5
  81. data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb +48 -46
  82. data/src/com/zoho/crm/api/currencies/base_currency_wrapper.rb +47 -45
  83. data/src/com/zoho/crm/api/currencies/body_wrapper.rb +47 -45
  84. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +136 -134
  85. data/src/com/zoho/crm/api/currencies/currency.rb +215 -213
  86. data/src/com/zoho/crm/api/currencies/format.rb +75 -73
  87. data/src/com/zoho/crm/api/currencies/response_handler.rb +7 -5
  88. data/src/com/zoho/crm/api/currencies/response_wrapper.rb +48 -46
  89. data/src/com/zoho/crm/api/currencies/success_response.rb +91 -89
  90. data/src/com/zoho/crm/api/custom_views/api_exception.rb +91 -89
  91. data/src/com/zoho/crm/api/custom_views/criteria.rb +101 -99
  92. data/src/com/zoho/crm/api/custom_views/custom_view.rb +243 -241
  93. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +57 -55
  94. data/src/com/zoho/crm/api/custom_views/info.rb +117 -115
  95. data/src/com/zoho/crm/api/custom_views/range.rb +61 -59
  96. data/src/com/zoho/crm/api/custom_views/response_handler.rb +7 -5
  97. data/src/com/zoho/crm/api/custom_views/response_wrapper.rb +63 -61
  98. data/src/com/zoho/crm/api/custom_views/shared_details.rb +89 -87
  99. data/src/com/zoho/crm/api/custom_views/translation.rb +89 -87
  100. data/src/com/zoho/crm/api/dc/au_datacenter.rb +16 -13
  101. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +16 -13
  102. data/src/com/zoho/crm/api/dc/datacenter.rb +18 -15
  103. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +16 -13
  104. data/src/com/zoho/crm/api/dc/in_datacenter.rb +16 -13
  105. data/src/com/zoho/crm/api/dc/us_datacenter.rb +16 -13
  106. data/src/com/zoho/crm/api/exception/sdk_exception.rb +40 -38
  107. data/src/com/zoho/crm/api/fields/api_exception.rb +91 -89
  108. data/src/com/zoho/crm/api/fields/association_details.rb +61 -59
  109. data/src/com/zoho/crm/api/fields/auto_number.rb +75 -73
  110. data/src/com/zoho/crm/api/fields/crypt.rb +117 -115
  111. data/src/com/zoho/crm/api/fields/currency.rb +61 -59
  112. data/src/com/zoho/crm/api/fields/field.rb +712 -710
  113. data/src/com/zoho/crm/api/fields/fields_operations.rb +54 -52
  114. data/src/com/zoho/crm/api/fields/formula.rb +61 -59
  115. data/src/com/zoho/crm/api/fields/lookup_field.rb +61 -59
  116. data/src/com/zoho/crm/api/fields/module.rb +117 -115
  117. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +117 -115
  118. data/src/com/zoho/crm/api/fields/pick_list_value.rb +131 -129
  119. data/src/com/zoho/crm/api/fields/private.rb +75 -73
  120. data/src/com/zoho/crm/api/fields/related_details.rb +103 -101
  121. data/src/com/zoho/crm/api/fields/response_handler.rb +7 -5
  122. data/src/com/zoho/crm/api/fields/response_wrapper.rb +48 -46
  123. data/src/com/zoho/crm/api/fields/tool_tip.rb +61 -59
  124. data/src/com/zoho/crm/api/fields/unique.rb +47 -45
  125. data/src/com/zoho/crm/api/fields/view_type.rb +89 -87
  126. data/src/com/zoho/crm/api/files/action_handler.rb +7 -5
  127. data/src/com/zoho/crm/api/files/action_response.rb +7 -5
  128. data/src/com/zoho/crm/api/files/action_wrapper.rb +48 -46
  129. data/src/com/zoho/crm/api/files/api_exception.rb +95 -93
  130. data/src/com/zoho/crm/api/files/body_wrapper.rb +46 -44
  131. data/src/com/zoho/crm/api/files/file_body_wrapper.rb +48 -46
  132. data/src/com/zoho/crm/api/files/file_operations.rb +58 -56
  133. data/src/com/zoho/crm/api/files/response_handler.rb +7 -5
  134. data/src/com/zoho/crm/api/files/success_response.rb +91 -89
  135. data/src/com/zoho/crm/api/header.rb +10 -8
  136. data/src/com/zoho/crm/api/header_map.rb +39 -37
  137. data/src/com/zoho/crm/api/initializer.rb +148 -108
  138. data/src/com/zoho/crm/api/layouts/api_exception.rb +91 -89
  139. data/src/com/zoho/crm/api/layouts/layout.rb +201 -199
  140. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +47 -45
  141. data/src/com/zoho/crm/api/layouts/properties.rb +75 -73
  142. data/src/com/zoho/crm/api/layouts/response_handler.rb +7 -5
  143. data/src/com/zoho/crm/api/layouts/response_wrapper.rb +48 -46
  144. data/src/com/zoho/crm/api/layouts/section.rb +173 -171
  145. data/src/com/zoho/crm/api/modules/action_handler.rb +7 -5
  146. data/src/com/zoho/crm/api/modules/action_response.rb +7 -5
  147. data/src/com/zoho/crm/api/modules/action_wrapper.rb +48 -46
  148. data/src/com/zoho/crm/api/modules/api_exception.rb +95 -93
  149. data/src/com/zoho/crm/api/modules/argument.rb +61 -59
  150. data/src/com/zoho/crm/api/modules/body_wrapper.rb +47 -45
  151. data/src/com/zoho/crm/api/modules/module.rb +652 -650
  152. data/src/com/zoho/crm/api/modules/modules_operations.rb +92 -90
  153. data/src/com/zoho/crm/api/modules/related_list_properties.rb +75 -73
  154. data/src/com/zoho/crm/api/modules/response_handler.rb +7 -5
  155. data/src/com/zoho/crm/api/modules/response_wrapper.rb +48 -46
  156. data/src/com/zoho/crm/api/modules/success_response.rb +91 -89
  157. data/src/com/zoho/crm/api/modules/territory.rb +75 -73
  158. data/src/com/zoho/crm/api/notes/action_handler.rb +7 -5
  159. data/src/com/zoho/crm/api/notes/action_response.rb +7 -5
  160. data/src/com/zoho/crm/api/notes/action_wrapper.rb +48 -46
  161. data/src/com/zoho/crm/api/notes/api_exception.rb +95 -93
  162. data/src/com/zoho/crm/api/notes/body_wrapper.rb +47 -45
  163. data/src/com/zoho/crm/api/notes/info.rb +89 -87
  164. data/src/com/zoho/crm/api/notes/note.rb +257 -255
  165. data/src/com/zoho/crm/api/notes/notes_operations.rb +184 -182
  166. data/src/com/zoho/crm/api/notes/response_handler.rb +7 -5
  167. data/src/com/zoho/crm/api/notes/response_wrapper.rb +63 -61
  168. data/src/com/zoho/crm/api/notes/success_response.rb +91 -89
  169. data/src/com/zoho/crm/api/notification/action_handler.rb +7 -5
  170. data/src/com/zoho/crm/api/notification/action_response.rb +7 -5
  171. data/src/com/zoho/crm/api/notification/action_wrapper.rb +48 -46
  172. data/src/com/zoho/crm/api/notification/api_exception.rb +95 -93
  173. data/src/com/zoho/crm/api/notification/body_wrapper.rb +47 -45
  174. data/src/com/zoho/crm/api/notification/info.rb +89 -87
  175. data/src/com/zoho/crm/api/notification/notification.rb +187 -185
  176. data/src/com/zoho/crm/api/notification/notification_operations.rb +139 -137
  177. data/src/com/zoho/crm/api/notification/response_handler.rb +7 -5
  178. data/src/com/zoho/crm/api/notification/response_wrapper.rb +63 -61
  179. data/src/com/zoho/crm/api/notification/success_response.rb +91 -89
  180. data/src/com/zoho/crm/api/org/action_response.rb +7 -5
  181. data/src/com/zoho/crm/api/org/api_exception.rb +93 -91
  182. data/src/com/zoho/crm/api/org/file_body_wrapper.rb +46 -44
  183. data/src/com/zoho/crm/api/org/license_details.rb +117 -115
  184. data/src/com/zoho/crm/api/org/org.rb +467 -465
  185. data/src/com/zoho/crm/api/org/org_operations.rb +39 -37
  186. data/src/com/zoho/crm/api/org/response_handler.rb +7 -5
  187. data/src/com/zoho/crm/api/org/response_wrapper.rb +48 -46
  188. data/src/com/zoho/crm/api/org/success_response.rb +91 -89
  189. data/src/com/zoho/crm/api/param.rb +10 -8
  190. data/src/com/zoho/crm/api/parameter_map.rb +39 -37
  191. data/src/com/zoho/crm/api/profiles/api_exception.rb +91 -89
  192. data/src/com/zoho/crm/api/profiles/category.rb +75 -73
  193. data/src/com/zoho/crm/api/profiles/permission_detail.rb +103 -101
  194. data/src/com/zoho/crm/api/profiles/profile.rb +215 -213
  195. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +47 -45
  196. data/src/com/zoho/crm/api/profiles/response_handler.rb +7 -5
  197. data/src/com/zoho/crm/api/profiles/response_wrapper.rb +48 -46
  198. data/src/com/zoho/crm/api/profiles/section.rb +61 -59
  199. data/src/com/zoho/crm/api/query/api_exception.rb +91 -89
  200. data/src/com/zoho/crm/api/query/body_wrapper.rb +47 -45
  201. data/src/com/zoho/crm/api/query/query_operations.rb +26 -24
  202. data/src/com/zoho/crm/api/query/response_handler.rb +7 -5
  203. data/src/com/zoho/crm/api/query/response_wrapper.rb +63 -61
  204. data/src/com/zoho/crm/api/record/action_handler.rb +7 -5
  205. data/src/com/zoho/crm/api/record/action_response.rb +7 -5
  206. data/src/com/zoho/crm/api/record/action_wrapper.rb +48 -46
  207. data/src/com/zoho/crm/api/record/api_exception.rb +113 -111
  208. data/src/com/zoho/crm/api/record/body_wrapper.rb +117 -115
  209. data/src/com/zoho/crm/api/record/carry_over_tags.rb +75 -73
  210. data/src/com/zoho/crm/api/record/comment.rb +89 -87
  211. data/src/com/zoho/crm/api/record/consent.rb +130 -128
  212. data/src/com/zoho/crm/api/record/convert_action_handler.rb +7 -5
  213. data/src/com/zoho/crm/api/record/convert_action_response.rb +7 -5
  214. data/src/com/zoho/crm/api/record/convert_action_wrapper.rb +48 -46
  215. data/src/com/zoho/crm/api/record/convert_body_wrapper.rb +47 -45
  216. data/src/com/zoho/crm/api/record/criteria.rb +101 -99
  217. data/src/com/zoho/crm/api/record/deleted_record.rb +117 -115
  218. data/src/com/zoho/crm/api/record/deleted_records_handler.rb +7 -5
  219. data/src/com/zoho/crm/api/record/deleted_records_wrapper.rb +63 -61
  220. data/src/com/zoho/crm/api/record/download_handler.rb +7 -5
  221. data/src/com/zoho/crm/api/record/field.rb +2055 -2053
  222. data/src/com/zoho/crm/api/record/file_body_wrapper.rb +50 -48
  223. data/src/com/zoho/crm/api/record/file_details.rb +243 -241
  224. data/src/com/zoho/crm/api/record/file_handler.rb +7 -5
  225. data/src/com/zoho/crm/api/record/info.rb +89 -87
  226. data/src/com/zoho/crm/api/record/inventory_line_items.rb +166 -164
  227. data/src/com/zoho/crm/api/record/lead_converter.rb +145 -143
  228. data/src/com/zoho/crm/api/record/line_item_product.rb +45 -43
  229. data/src/com/zoho/crm/api/record/line_tax.rb +89 -87
  230. data/src/com/zoho/crm/api/record/mass_update.rb +105 -103
  231. data/src/com/zoho/crm/api/record/mass_update_action_handler.rb +7 -5
  232. data/src/com/zoho/crm/api/record/mass_update_action_response.rb +7 -5
  233. data/src/com/zoho/crm/api/record/mass_update_action_wrapper.rb +48 -46
  234. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +117 -115
  235. data/src/com/zoho/crm/api/record/mass_update_response.rb +7 -5
  236. data/src/com/zoho/crm/api/record/mass_update_response_handler.rb +7 -5
  237. data/src/com/zoho/crm/api/record/mass_update_response_wrapper.rb +48 -46
  238. data/src/com/zoho/crm/api/record/mass_update_success_response.rb +91 -89
  239. data/src/com/zoho/crm/api/record/options.rb +7 -5
  240. data/src/com/zoho/crm/api/record/participants.rb +82 -80
  241. data/src/com/zoho/crm/api/record/pricing_details.rb +45 -43
  242. data/src/com/zoho/crm/api/record/record.rb +139 -137
  243. data/src/com/zoho/crm/api/record/record_operations.rb +947 -742
  244. data/src/com/zoho/crm/api/record/recurring_activity.rb +47 -45
  245. data/src/com/zoho/crm/api/record/remind_at.rb +47 -45
  246. data/src/com/zoho/crm/api/record/reminder.rb +61 -59
  247. data/src/com/zoho/crm/api/record/response_handler.rb +7 -5
  248. data/src/com/zoho/crm/api/record/response_wrapper.rb +63 -61
  249. data/src/com/zoho/crm/api/record/success_response.rb +121 -119
  250. data/src/com/zoho/crm/api/record/successful_convert.rb +77 -75
  251. data/src/com/zoho/crm/api/record/territory.rb +61 -59
  252. data/src/com/zoho/crm/api/related_lists/api_exception.rb +91 -89
  253. data/src/com/zoho/crm/api/related_lists/related_list.rb +187 -185
  254. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +47 -45
  255. data/src/com/zoho/crm/api/related_lists/response_handler.rb +7 -5
  256. data/src/com/zoho/crm/api/related_lists/response_wrapper.rb +48 -46
  257. data/src/com/zoho/crm/api/related_records/action_handler.rb +7 -5
  258. data/src/com/zoho/crm/api/related_records/action_response.rb +7 -5
  259. data/src/com/zoho/crm/api/related_records/action_wrapper.rb +48 -46
  260. data/src/com/zoho/crm/api/related_records/api_exception.rb +95 -93
  261. data/src/com/zoho/crm/api/related_records/body_wrapper.rb +46 -44
  262. data/src/com/zoho/crm/api/related_records/file_body_wrapper.rb +48 -46
  263. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +476 -215
  264. data/src/com/zoho/crm/api/related_records/response_handler.rb +7 -5
  265. data/src/com/zoho/crm/api/related_records/response_wrapper.rb +63 -61
  266. data/src/com/zoho/crm/api/related_records/success_response.rb +91 -89
  267. data/src/com/zoho/crm/api/request_proxy.rb +12 -11
  268. data/src/com/zoho/crm/api/roles/api_exception.rb +91 -89
  269. data/src/com/zoho/crm/api/roles/response_handler.rb +7 -5
  270. data/src/com/zoho/crm/api/roles/response_wrapper.rb +48 -46
  271. data/src/com/zoho/crm/api/roles/role.rb +145 -143
  272. data/src/com/zoho/crm/api/roles/roles_operations.rb +37 -35
  273. data/src/com/zoho/crm/api/sdk_config.rb +5 -68
  274. data/src/com/zoho/crm/api/share_records/action_handler.rb +7 -5
  275. data/src/com/zoho/crm/api/share_records/action_response.rb +7 -5
  276. data/src/com/zoho/crm/api/share_records/action_wrapper.rb +48 -46
  277. data/src/com/zoho/crm/api/share_records/api_exception.rb +99 -97
  278. data/src/com/zoho/crm/api/share_records/body_wrapper.rb +47 -45
  279. data/src/com/zoho/crm/api/share_records/delete_action_handler.rb +7 -5
  280. data/src/com/zoho/crm/api/share_records/delete_action_response.rb +7 -5
  281. data/src/com/zoho/crm/api/share_records/delete_action_wrapper.rb +48 -46
  282. data/src/com/zoho/crm/api/share_records/response_handler.rb +7 -5
  283. data/src/com/zoho/crm/api/share_records/response_wrapper.rb +63 -61
  284. data/src/com/zoho/crm/api/share_records/share_record.rb +117 -115
  285. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +109 -107
  286. data/src/com/zoho/crm/api/share_records/shared_through.rb +75 -73
  287. data/src/com/zoho/crm/api/share_records/success_response.rb +93 -91
  288. data/src/com/zoho/crm/api/tags/action_handler.rb +7 -5
  289. data/src/com/zoho/crm/api/tags/action_response.rb +7 -5
  290. data/src/com/zoho/crm/api/tags/action_wrapper.rb +48 -46
  291. data/src/com/zoho/crm/api/tags/api_exception.rb +101 -99
  292. data/src/com/zoho/crm/api/tags/body_wrapper.rb +47 -45
  293. data/src/com/zoho/crm/api/tags/conflict_wrapper.rb +47 -45
  294. data/src/com/zoho/crm/api/tags/count_handler.rb +7 -5
  295. data/src/com/zoho/crm/api/tags/count_wrapper.rb +48 -46
  296. data/src/com/zoho/crm/api/tags/info.rb +61 -59
  297. data/src/com/zoho/crm/api/tags/merge_wrapper.rb +47 -45
  298. data/src/com/zoho/crm/api/tags/record_action_handler.rb +7 -5
  299. data/src/com/zoho/crm/api/tags/record_action_response.rb +7 -5
  300. data/src/com/zoho/crm/api/tags/record_action_wrapper.rb +91 -89
  301. data/src/com/zoho/crm/api/tags/response_handler.rb +7 -5
  302. data/src/com/zoho/crm/api/tags/response_wrapper.rb +63 -61
  303. data/src/com/zoho/crm/api/tags/success_response.rb +93 -91
  304. data/src/com/zoho/crm/api/tags/tag.rb +117 -115
  305. data/src/com/zoho/crm/api/tags/tags_operations.rb +338 -336
  306. data/src/com/zoho/crm/api/taxes/action_handler.rb +7 -5
  307. data/src/com/zoho/crm/api/taxes/action_response.rb +7 -5
  308. data/src/com/zoho/crm/api/taxes/action_wrapper.rb +48 -46
  309. data/src/com/zoho/crm/api/taxes/api_exception.rb +95 -93
  310. data/src/com/zoho/crm/api/taxes/body_wrapper.rb +47 -45
  311. data/src/com/zoho/crm/api/taxes/preference.rb +61 -59
  312. data/src/com/zoho/crm/api/taxes/response_handler.rb +7 -5
  313. data/src/com/zoho/crm/api/taxes/response_wrapper.rb +63 -61
  314. data/src/com/zoho/crm/api/taxes/success_response.rb +91 -89
  315. data/src/com/zoho/crm/api/taxes/tax.rb +103 -101
  316. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +114 -112
  317. data/src/com/zoho/crm/api/territories/api_exception.rb +91 -89
  318. data/src/com/zoho/crm/api/territories/response_handler.rb +7 -5
  319. data/src/com/zoho/crm/api/territories/response_wrapper.rb +48 -46
  320. data/src/com/zoho/crm/api/territories/territories_operations.rb +37 -35
  321. data/src/com/zoho/crm/api/territories/territory.rb +173 -171
  322. data/src/com/zoho/crm/api/user_signature.rb +19 -17
  323. data/src/com/zoho/crm/api/users/action_handler.rb +7 -5
  324. data/src/com/zoho/crm/api/users/action_response.rb +7 -5
  325. data/src/com/zoho/crm/api/users/action_wrapper.rb +48 -46
  326. data/src/com/zoho/crm/api/users/api_exception.rb +95 -93
  327. data/src/com/zoho/crm/api/users/body_wrapper.rb +47 -45
  328. data/src/com/zoho/crm/api/users/customize_info.rb +117 -115
  329. data/src/com/zoho/crm/api/users/info.rb +89 -87
  330. data/src/com/zoho/crm/api/users/request_wrapper.rb +47 -45
  331. data/src/com/zoho/crm/api/users/response_handler.rb +7 -5
  332. data/src/com/zoho/crm/api/users/response_wrapper.rb +63 -61
  333. data/src/com/zoho/crm/api/users/shift.rb +61 -59
  334. data/src/com/zoho/crm/api/users/success_response.rb +91 -89
  335. data/src/com/zoho/crm/api/users/tab_theme.rb +61 -59
  336. data/src/com/zoho/crm/api/users/territory.rb +75 -73
  337. data/src/com/zoho/crm/api/users/theme.rb +117 -115
  338. data/src/com/zoho/crm/api/users/user.rb +489 -487
  339. data/src/com/zoho/crm/api/users/users_operations.rb +152 -150
  340. data/src/com/zoho/crm/api/util/api_http_connector.rb +85 -83
  341. data/src/com/zoho/crm/api/util/api_response.rb +16 -14
  342. data/src/com/zoho/crm/api/util/choice.rb +8 -6
  343. data/src/com/zoho/crm/api/util/common_api_handler.rb +162 -157
  344. data/src/com/zoho/crm/api/util/constants.rb +382 -276
  345. data/src/com/zoho/crm/api/util/converter.rb +169 -150
  346. data/src/com/zoho/crm/api/util/data_type_converter.rb +129 -121
  347. data/src/com/zoho/crm/api/util/downloader.rb +60 -57
  348. data/src/com/zoho/crm/api/util/form_data_converter.rb +116 -125
  349. data/src/com/zoho/crm/api/util/header_param_validator.rb +47 -45
  350. data/src/com/zoho/crm/api/util/json_converter.rb +537 -534
  351. data/src/com/zoho/crm/api/util/model.rb +6 -4
  352. data/src/com/zoho/crm/api/util/module_fields_handler.rb +61 -59
  353. data/src/com/zoho/crm/api/util/stream_wrapper.rb +27 -25
  354. data/src/com/zoho/crm/api/util/utility.rb +697 -570
  355. data/src/com/zoho/crm/api/variable_groups/api_exception.rb +91 -89
  356. data/src/com/zoho/crm/api/variable_groups/response_handler.rb +7 -5
  357. data/src/com/zoho/crm/api/variable_groups/response_wrapper.rb +48 -46
  358. data/src/com/zoho/crm/api/variable_groups/variable_group.rb +103 -101
  359. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +54 -52
  360. data/src/com/zoho/crm/api/variables/action_handler.rb +7 -5
  361. data/src/com/zoho/crm/api/variables/action_response.rb +7 -5
  362. data/src/com/zoho/crm/api/variables/action_wrapper.rb +48 -46
  363. data/src/com/zoho/crm/api/variables/api_exception.rb +95 -93
  364. data/src/com/zoho/crm/api/variables/body_wrapper.rb +47 -45
  365. data/src/com/zoho/crm/api/variables/response_handler.rb +7 -5
  366. data/src/com/zoho/crm/api/variables/response_wrapper.rb +48 -46
  367. data/src/com/zoho/crm/api/variables/success_response.rb +91 -89
  368. data/src/com/zoho/crm/api/variables/variable.rb +129 -127
  369. data/src/com/zoho/crm/api/variables/variables_operations.rb +231 -229
  370. data/src/resources/JSONDetails.json +1 -1
  371. data/src/version.rb +3 -3
  372. metadata +10 -4
@@ -8,256 +8,517 @@ require_relative '../util/common_api_handler'
8
8
  require_relative '../util/utility'
9
9
  require_relative '../util/constants'
10
10
 
11
- module RelatedRecords
12
- class RelatedRecordsOperations
11
+ module ZOHOCRMSDK
12
+ module RelatedRecords
13
+ class RelatedRecordsOperations
13
14
 
14
- # Creates an instance of RelatedRecordsOperations with the given parameters
15
- # @param related_list_api_name [String] A String
16
- # @param record_id [Integer] A Integer
17
- # @param module_api_name [String] A String
18
- def initialize(related_list_api_name, record_id, module_api_name)
19
- if !related_list_api_name.is_a? String
20
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_list_api_name EXPECTED TYPE: String', nil, nil)
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
21
32
  end
22
- if !record_id.is_a? Integer
23
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
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/v2/'
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')
24
67
  end
25
- if !module_api_name.is_a? String
26
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
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/v2/'
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')
27
98
  end
28
- @related_list_api_name = related_list_api_name
29
- @record_id = record_id
30
- @module_api_name = module_api_name
31
- end
32
99
 
33
- # The method to get related records
34
- # @param param_instance [ParameterMap] An instance of ParameterMap
35
- # @param header_instance [HeaderMap] An instance of HeaderMap
36
- # @return An instance of APIResponse
37
- # @raise SDKException
38
- def get_related_records(param_instance=nil, header_instance=nil)
39
- if param_instance!=nil and !param_instance.is_a? ParameterMap
40
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
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/v2/'
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')
41
128
  end
42
- if header_instance!=nil and !header_instance.is_a? HeaderMap
43
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
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/v2/'
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')
44
163
  end
45
- handler_instance = Handler::CommonAPIHandler.new
46
- api_path = ''
47
- api_path = api_path + '/crm/v2/'
48
- api_path = api_path + @module_api_name.to_s
49
- api_path = api_path + '/'
50
- api_path = api_path + @record_id.to_s
51
- api_path = api_path + '/'
52
- api_path = api_path + @related_list_api_name.to_s
53
- handler_instance.api_path = api_path
54
- handler_instance.http_method = Constants::REQUEST_METHOD_GET
55
- handler_instance.category_method = 'READ'
56
- handler_instance.param = param_instance
57
- handler_instance.header = header_instance
58
- Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
59
- require_relative 'response_handler'
60
- handler_instance.api_call(ResponseHandler.name, 'application/json')
61
- end
62
164
 
63
- # The method to update related records
64
- # @param request [BodyWrapper] An instance of BodyWrapper
65
- # @return An instance of APIResponse
66
- # @raise SDKException
67
- def update_related_records(request)
68
- if request!=nil and !request.is_a? BodyWrapper
69
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
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/v2/'
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')
70
194
  end
71
- handler_instance = Handler::CommonAPIHandler.new
72
- api_path = ''
73
- api_path = api_path + '/crm/v2/'
74
- api_path = api_path + @module_api_name.to_s
75
- api_path = api_path + '/'
76
- api_path = api_path + @record_id.to_s
77
- api_path = api_path + '/'
78
- api_path = api_path + @related_list_api_name.to_s
79
- handler_instance.api_path = api_path
80
- handler_instance.http_method = Constants::REQUEST_METHOD_PUT
81
- handler_instance.category_method = 'UPDATE'
82
- handler_instance.content_type = 'application/json'
83
- handler_instance.request = request
84
- handler_instance.mandatory_checker = true
85
- Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
86
- require_relative 'action_handler'
87
- handler_instance.api_call(ActionHandler.name, 'application/json')
88
- end
89
195
 
90
- # The method to delink records
91
- # @param param_instance [ParameterMap] An instance of ParameterMap
92
- # @return An instance of APIResponse
93
- # @raise SDKException
94
- def delink_records(param_instance=nil)
95
- if param_instance!=nil and !param_instance.is_a? ParameterMap
96
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
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/v2/'
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')
97
224
  end
98
- handler_instance = Handler::CommonAPIHandler.new
99
- api_path = ''
100
- api_path = api_path + '/crm/v2/'
101
- api_path = api_path + @module_api_name.to_s
102
- api_path = api_path + '/'
103
- api_path = api_path + @record_id.to_s
104
- api_path = api_path + '/'
105
- api_path = api_path + @related_list_api_name.to_s
106
- handler_instance.api_path = api_path
107
- handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
108
- handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
109
- handler_instance.param = param_instance
110
- require_relative 'action_handler'
111
- handler_instance.api_call(ActionHandler.name, 'application/json')
112
- end
113
225
 
114
- # The method to get related record
115
- # @param related_record_id [Integer] A Integer
116
- # @param header_instance [HeaderMap] An instance of HeaderMap
117
- # @return An instance of APIResponse
118
- # @raise SDKException
119
- def get_related_record(related_record_id, header_instance=nil)
120
- if !related_record_id.is_a? Integer
121
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: Integer', nil, nil)
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/v2/'
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')
122
260
  end
123
- if header_instance!=nil and !header_instance.is_a? HeaderMap
124
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
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/v2/'
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')
125
297
  end
126
- handler_instance = Handler::CommonAPIHandler.new
127
- api_path = ''
128
- api_path = api_path + '/crm/v2/'
129
- api_path = api_path + @module_api_name.to_s
130
- api_path = api_path + '/'
131
- api_path = api_path + @record_id.to_s
132
- api_path = api_path + '/'
133
- api_path = api_path + @related_list_api_name.to_s
134
- api_path = api_path + '/'
135
- api_path = api_path + related_record_id.to_s
136
- handler_instance.api_path = api_path
137
- handler_instance.http_method = Constants::REQUEST_METHOD_GET
138
- handler_instance.category_method = 'READ'
139
- handler_instance.header = header_instance
140
- Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
141
- require_relative 'response_handler'
142
- handler_instance.api_call(ResponseHandler.name, 'application/json')
143
- end
144
298
 
145
- # The method to update related record
146
- # @param related_record_id [Integer] A Integer
147
- # @param request [BodyWrapper] An instance of BodyWrapper
148
- # @param header_instance [HeaderMap] An instance of HeaderMap
149
- # @return An instance of APIResponse
150
- # @raise SDKException
151
- def update_related_record(related_record_id, request, header_instance=nil)
152
- if !related_record_id.is_a? Integer
153
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: Integer', nil, nil)
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/v2/'
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')
154
328
  end
155
- if request!=nil and !request.is_a? BodyWrapper
156
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
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/v2/'
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')
157
364
  end
158
- if header_instance!=nil and !header_instance.is_a? HeaderMap
159
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
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/v2/'
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')
160
401
  end
161
- handler_instance = Handler::CommonAPIHandler.new
162
- api_path = ''
163
- api_path = api_path + '/crm/v2/'
164
- api_path = api_path + @module_api_name.to_s
165
- api_path = api_path + '/'
166
- api_path = api_path + @record_id.to_s
167
- api_path = api_path + '/'
168
- api_path = api_path + @related_list_api_name.to_s
169
- api_path = api_path + '/'
170
- api_path = api_path + related_record_id.to_s
171
- handler_instance.api_path = api_path
172
- handler_instance.http_method = Constants::REQUEST_METHOD_PUT
173
- handler_instance.category_method = 'UPDATE'
174
- handler_instance.content_type = 'application/json'
175
- handler_instance.request = request
176
- handler_instance.header = header_instance
177
- Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
178
- require_relative 'action_handler'
179
- handler_instance.api_call(ActionHandler.name, 'application/json')
180
- end
181
402
 
182
- # The method to delink record
183
- # @param related_record_id [Integer] A Integer
184
- # @param header_instance [HeaderMap] An instance of HeaderMap
185
- # @return An instance of APIResponse
186
- # @raise SDKException
187
- def delink_record(related_record_id, header_instance=nil)
188
- if !related_record_id.is_a? Integer
189
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: Integer', nil, nil)
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/v2/'
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')
190
432
  end
191
- if header_instance!=nil and !header_instance.is_a? HeaderMap
192
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
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
193
439
  end
194
- handler_instance = Handler::CommonAPIHandler.new
195
- api_path = ''
196
- api_path = api_path + '/crm/v2/'
197
- api_path = api_path + @module_api_name.to_s
198
- api_path = api_path + '/'
199
- api_path = api_path + @record_id.to_s
200
- api_path = api_path + '/'
201
- api_path = api_path + @related_list_api_name.to_s
202
- api_path = api_path + '/'
203
- api_path = api_path + related_record_id.to_s
204
- handler_instance.api_path = api_path
205
- handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
206
- handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
207
- handler_instance.header = header_instance
208
- require_relative 'action_handler'
209
- handler_instance.api_call(ActionHandler.name, 'application/json')
210
- end
211
440
 
212
- class GetRelatedRecordsParam
213
- @@page = Param.new('page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam')
214
- def self.page
215
- @@page
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
216
450
  end
217
- @@per_page = Param.new('per_page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam')
218
- def self.per_page
219
- @@per_page
451
+
452
+ class UpdateRelatedRecordsHeader
220
453
  end
221
- end
222
454
 
223
- class GetRelatedRecordsHeader
224
- @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader')
225
- def self.If_modified_since
226
- @@If_modified_since
455
+ class DelinkRecordsHeader
227
456
  end
228
- @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader')
229
- def self.X_external
230
- @@X_external
457
+
458
+ class DelinkRecordsParam
459
+ @@ids = Param.new('ids', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsParam')
460
+ def self.ids
461
+ @@ids
462
+ end
231
463
  end
232
- end
233
464
 
234
- class DelinkRecordsParam
235
- @@ids = Param.new('ids', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsParam')
236
- def self.ids
237
- @@ids
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
238
470
  end
239
- end
240
471
 
241
- class GetRelatedRecordHeader
242
- @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordHeader')
243
- def self.If_modified_since
244
- @@If_modified_since
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
245
481
  end
246
- end
247
482
 
248
- class UpdateRelatedRecordHeader
249
- @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordHeader')
250
- def self.X_external
251
- @@X_external
483
+ class UpdateRelatedRecordsUsingExternalIDHeader
252
484
  end
253
- end
254
485
 
255
- class DelinkRecordHeader
256
- @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DelinkRecordHeader')
257
- def self.X_external
258
- @@X_external
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
259
504
  end
260
- end
261
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
262
523
  end
263
524
  end