ZOHOCRMSDK2_0 2.0.0 → 3.0.0

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