ZOHOCRMSDK2_0_docgo 6.2.0

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