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,71 @@
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 Fields
10
+ class FieldsOperations
11
+
12
+ # Creates an instance of FieldsOperations with the given parameters
13
+ # @param module_1 [String] A String
14
+ def initialize(module_1=nil)
15
+ if module_1!=nil and !module_1.is_a? String
16
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
17
+ end
18
+ @module_1 = module_1
19
+ end
20
+
21
+ # The method to get fields
22
+ # @param param_instance [ParameterMap] An instance of ParameterMap
23
+ # @return An instance of APIResponse
24
+ # @raise SDKException
25
+ def get_fields(param_instance=nil)
26
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
28
+ end
29
+ handler_instance = Handler::CommonAPIHandler.new
30
+ api_path = "/crm/v#{Initializer.get_initializer.api_version}/settings/fields"
31
+ handler_instance.api_path = api_path
32
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
33
+ handler_instance.category_method = 'READ'
34
+ handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.Fields.GetFieldsParam'), @module_1)
35
+ handler_instance.param = param_instance
36
+ require_relative 'response_handler'
37
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
38
+ end
39
+
40
+ # The method to get field
41
+ # @param id [Integer] A Integer
42
+ # @return An instance of APIResponse
43
+ # @raise SDKException
44
+ def get_field(id)
45
+ if !id.is_a? Integer
46
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
47
+ end
48
+ handler_instance = Handler::CommonAPIHandler.new
49
+ api_path = "/crm/v#{Initializer.get_initializer.api_version}/settings/fields/"
50
+ api_path = api_path + id.to_s
51
+ handler_instance.api_path = api_path
52
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
53
+ handler_instance.category_method = 'READ'
54
+ handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.Fields.GetFieldParam'), @module_1)
55
+ require_relative 'response_handler'
56
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
57
+ end
58
+
59
+ class GetFieldsParam
60
+ @@type = Param.new('type', 'com.zoho.crm.api.Fields.GetFieldsParam')
61
+ def self.type
62
+ @@type
63
+ end
64
+ end
65
+
66
+ class GetFieldParam
67
+ end
68
+
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,82 @@
1
+ require_relative '../util/model'
2
+
3
+ module ZOHOCRMSDK
4
+ module Fields
5
+ class Formula
6
+ include Util::Model
7
+
8
+ # Creates an instance of Formula
9
+ def initialize
10
+ @return_type = nil
11
+ @expression = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the return_type
16
+ # @return A String value
17
+
18
+ def return_type
19
+ @return_type
20
+ end
21
+
22
+ # The method to set the value to return_type
23
+ # @param return_type [String] A String
24
+
25
+ def return_type=(return_type)
26
+ if return_type!=nil and !return_type.is_a? String
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: return_type EXPECTED TYPE: String', nil, nil)
28
+ end
29
+ @return_type = return_type
30
+ @key_modified['return_type'] = 1
31
+ end
32
+
33
+ # The method to get the expression
34
+ # @return A String value
35
+
36
+ def expression
37
+ @expression
38
+ end
39
+
40
+ # The method to set the value to expression
41
+ # @param expression [String] A String
42
+
43
+ def expression=(expression)
44
+ if expression!=nil and !expression.is_a? String
45
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: expression EXPECTED TYPE: String', nil, nil)
46
+ end
47
+ @expression = expression
48
+ @key_modified['expression'] = 1
49
+ end
50
+
51
+ # The method to check if the user has modified the given key
52
+ # @param key [String] A String
53
+ # @return A Integer value
54
+
55
+ def is_key_modified(key)
56
+ if key!=nil and !key.is_a? String
57
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
58
+ end
59
+ if @key_modified.key?(key)
60
+ return @key_modified[key]
61
+ end
62
+
63
+ nil
64
+ end
65
+
66
+ # The method to mark the given key as modified
67
+ # @param key [String] A String
68
+ # @param modification [Integer] A Integer
69
+
70
+ def set_key_modified(key, modification)
71
+ if key!=nil and !key.is_a? String
72
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
73
+ end
74
+ if modification!=nil and !modification.is_a? Integer
75
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
76
+ end
77
+ @key_modified[key] = modification
78
+ end
79
+
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,82 @@
1
+ require_relative '../util/model'
2
+
3
+ module ZOHOCRMSDK
4
+ module Fields
5
+ class LookupField
6
+ include Util::Model
7
+
8
+ # Creates an instance of LookupField
9
+ def initialize
10
+ @id = nil
11
+ @name = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the id
16
+ # @return A Integer value
17
+
18
+ def id
19
+ @id
20
+ end
21
+
22
+ # The method to set the value to id
23
+ # @param id [Integer] A Integer
24
+
25
+ def id=(id)
26
+ if id!=nil and !id.is_a? Integer
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
28
+ end
29
+ @id = id
30
+ @key_modified['id'] = 1
31
+ end
32
+
33
+ # The method to get the name
34
+ # @return A String value
35
+
36
+ def name
37
+ @name
38
+ end
39
+
40
+ # The method to set the value to name
41
+ # @param name [String] A String
42
+
43
+ def name=(name)
44
+ if name!=nil and !name.is_a? String
45
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
46
+ end
47
+ @name = name
48
+ @key_modified['name'] = 1
49
+ end
50
+
51
+ # The method to check if the user has modified the given key
52
+ # @param key [String] A String
53
+ # @return A Integer value
54
+
55
+ def is_key_modified(key)
56
+ if key!=nil and !key.is_a? String
57
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
58
+ end
59
+ if @key_modified.key?(key)
60
+ return @key_modified[key]
61
+ end
62
+
63
+ nil
64
+ end
65
+
66
+ # The method to mark the given key as modified
67
+ # @param key [String] A String
68
+ # @param modification [Integer] A Integer
69
+
70
+ def set_key_modified(key, modification)
71
+ if key!=nil and !key.is_a? String
72
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
73
+ end
74
+ if modification!=nil and !modification.is_a? Integer
75
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
76
+ end
77
+ @key_modified[key] = modification
78
+ end
79
+
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,159 @@
1
+ require_relative '../layouts/layout'
2
+ require_relative '../util/model'
3
+
4
+ module ZOHOCRMSDK
5
+ module Fields
6
+ class Module
7
+ include Util::Model
8
+
9
+ # Creates an instance of Module
10
+ def initialize
11
+ @layout = nil
12
+ @display_label = nil
13
+ @api_name = nil
14
+ @module_1 = nil
15
+ @id = nil
16
+ @module_name = nil
17
+ @key_modified = Hash.new
18
+ end
19
+
20
+ # The method to get the layout
21
+ # @return An instance of Layouts::Layout
22
+
23
+ def layout
24
+ @layout
25
+ end
26
+
27
+ # The method to set the value to layout
28
+ # @param layout [Layouts::Layout] An instance of Layouts::Layout
29
+
30
+ def layout=(layout)
31
+ if layout!=nil and !layout.is_a? Layouts::Layout
32
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', nil, nil)
33
+ end
34
+ @layout = layout
35
+ @key_modified['layout'] = 1
36
+ end
37
+
38
+ # The method to get the display_label
39
+ # @return A String value
40
+
41
+ def display_label
42
+ @display_label
43
+ end
44
+
45
+ # The method to set the value to display_label
46
+ # @param display_label [String] A String
47
+
48
+ def display_label=(display_label)
49
+ if display_label!=nil and !display_label.is_a? String
50
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
51
+ end
52
+ @display_label = display_label
53
+ @key_modified['display_label'] = 1
54
+ end
55
+
56
+ # The method to get the api_name
57
+ # @return A String value
58
+
59
+ def api_name
60
+ @api_name
61
+ end
62
+
63
+ # The method to set the value to api_name
64
+ # @param api_name [String] A String
65
+
66
+ def api_name=(api_name)
67
+ if api_name!=nil and !api_name.is_a? String
68
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
69
+ end
70
+ @api_name = api_name
71
+ @key_modified['api_name'] = 1
72
+ end
73
+
74
+ # The method to get the module
75
+ # @return A String value
76
+
77
+ def module
78
+ @module_1
79
+ end
80
+
81
+ # The method to set the value to module
82
+ # @param module_1 [String] A String
83
+
84
+ def module=(module_1)
85
+ if module_1!=nil and !module_1.is_a? String
86
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
87
+ end
88
+ @module_1 = module_1
89
+ @key_modified['module'] = 1
90
+ end
91
+
92
+ # The method to get the id
93
+ # @return A Integer value
94
+
95
+ def id
96
+ @id
97
+ end
98
+
99
+ # The method to set the value to id
100
+ # @param id [Integer] A Integer
101
+
102
+ def id=(id)
103
+ if id!=nil and !id.is_a? Integer
104
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
105
+ end
106
+ @id = id
107
+ @key_modified['id'] = 1
108
+ end
109
+
110
+ # The method to get the module_name
111
+ # @return A String value
112
+
113
+ def module_name
114
+ @module_name
115
+ end
116
+
117
+ # The method to set the value to module_name
118
+ # @param module_name [String] A String
119
+
120
+ def module_name=(module_name)
121
+ if module_name!=nil and !module_name.is_a? String
122
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: String', nil, nil)
123
+ end
124
+ @module_name = module_name
125
+ @key_modified['module_name'] = 1
126
+ end
127
+
128
+ # The method to check if the user has modified the given key
129
+ # @param key [String] A String
130
+ # @return A Integer value
131
+
132
+ def is_key_modified(key)
133
+ if key!=nil and !key.is_a? String
134
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
135
+ end
136
+ if @key_modified.key?(key)
137
+ return @key_modified[key]
138
+ end
139
+
140
+ nil
141
+ end
142
+
143
+ # The method to mark the given key as modified
144
+ # @param key [String] A String
145
+ # @param modification [Integer] A Integer
146
+
147
+ def set_key_modified(key, modification)
148
+ if key!=nil and !key.is_a? String
149
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
150
+ end
151
+ if modification!=nil and !modification.is_a? Integer
152
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
153
+ end
154
+ @key_modified[key] = modification
155
+ end
156
+
157
+ end
158
+ end
159
+ end
@@ -0,0 +1,158 @@
1
+ require_relative '../util/model'
2
+
3
+ module ZOHOCRMSDK
4
+ module Fields
5
+ class MultiSelectLookup
6
+ include Util::Model
7
+
8
+ # Creates an instance of MultiSelectLookup
9
+ def initialize
10
+ @display_label = nil
11
+ @linking_module = nil
12
+ @lookup_apiname = nil
13
+ @api_name = nil
14
+ @connectedlookup_apiname = nil
15
+ @id = nil
16
+ @key_modified = Hash.new
17
+ end
18
+
19
+ # The method to get the display_label
20
+ # @return A String value
21
+
22
+ def display_label
23
+ @display_label
24
+ end
25
+
26
+ # The method to set the value to display_label
27
+ # @param display_label [String] A String
28
+
29
+ def display_label=(display_label)
30
+ if display_label!=nil and !display_label.is_a? String
31
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
32
+ end
33
+ @display_label = display_label
34
+ @key_modified['display_label'] = 1
35
+ end
36
+
37
+ # The method to get the linking_module
38
+ # @return A String value
39
+
40
+ def linking_module
41
+ @linking_module
42
+ end
43
+
44
+ # The method to set the value to linking_module
45
+ # @param linking_module [String] A String
46
+
47
+ def linking_module=(linking_module)
48
+ if linking_module!=nil and !linking_module.is_a? String
49
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: linking_module EXPECTED TYPE: String', nil, nil)
50
+ end
51
+ @linking_module = linking_module
52
+ @key_modified['linking_module'] = 1
53
+ end
54
+
55
+ # The method to get the lookup_apiname
56
+ # @return A String value
57
+
58
+ def lookup_apiname
59
+ @lookup_apiname
60
+ end
61
+
62
+ # The method to set the value to lookup_apiname
63
+ # @param lookup_apiname [String] A String
64
+
65
+ def lookup_apiname=(lookup_apiname)
66
+ if lookup_apiname!=nil and !lookup_apiname.is_a? String
67
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: lookup_apiname EXPECTED TYPE: String', nil, nil)
68
+ end
69
+ @lookup_apiname = lookup_apiname
70
+ @key_modified['lookup_apiname'] = 1
71
+ end
72
+
73
+ # The method to get the api_name
74
+ # @return A String value
75
+
76
+ def api_name
77
+ @api_name
78
+ end
79
+
80
+ # The method to set the value to api_name
81
+ # @param api_name [String] A String
82
+
83
+ def api_name=(api_name)
84
+ if api_name!=nil and !api_name.is_a? String
85
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
86
+ end
87
+ @api_name = api_name
88
+ @key_modified['api_name'] = 1
89
+ end
90
+
91
+ # The method to get the connectedlookup_apiname
92
+ # @return A String value
93
+
94
+ def connectedlookup_apiname
95
+ @connectedlookup_apiname
96
+ end
97
+
98
+ # The method to set the value to connectedlookup_apiname
99
+ # @param connectedlookup_apiname [String] A String
100
+
101
+ def connectedlookup_apiname=(connectedlookup_apiname)
102
+ if connectedlookup_apiname!=nil and !connectedlookup_apiname.is_a? String
103
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: connectedlookup_apiname EXPECTED TYPE: String', nil, nil)
104
+ end
105
+ @connectedlookup_apiname = connectedlookup_apiname
106
+ @key_modified['connectedlookup_apiname'] = 1
107
+ end
108
+
109
+ # The method to get the id
110
+ # @return A Integer value
111
+
112
+ def id
113
+ @id
114
+ end
115
+
116
+ # The method to set the value to id
117
+ # @param id [Integer] A Integer
118
+
119
+ def id=(id)
120
+ if id!=nil and !id.is_a? Integer
121
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
122
+ end
123
+ @id = id
124
+ @key_modified['id'] = 1
125
+ end
126
+
127
+ # The method to check if the user has modified the given key
128
+ # @param key [String] A String
129
+ # @return A Integer value
130
+
131
+ def is_key_modified(key)
132
+ if key!=nil and !key.is_a? String
133
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
134
+ end
135
+ if @key_modified.key?(key)
136
+ return @key_modified[key]
137
+ end
138
+
139
+ nil
140
+ end
141
+
142
+ # The method to mark the given key as modified
143
+ # @param key [String] A String
144
+ # @param modification [Integer] A Integer
145
+
146
+ def set_key_modified(key, modification)
147
+ if key!=nil and !key.is_a? String
148
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
149
+ end
150
+ if modification!=nil and !modification.is_a? Integer
151
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
152
+ end
153
+ @key_modified[key] = modification
154
+ end
155
+
156
+ end
157
+ end
158
+ end