ZCRMSDK 1.0.5 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (378) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZCRMSDK.rb +362 -0
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +217 -0
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +149 -0
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +165 -0
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +26 -0
  7. data/src/com/zoho/api/authenticator/token.rb +10 -0
  8. data/src/com/zoho/api/logger/sdk_logger.rb +69 -0
  9. data/src/com/zoho/crm/api/attachments/action_handler.rb +10 -0
  10. data/src/com/zoho/crm/api/attachments/action_response.rb +10 -0
  11. data/src/com/zoho/crm/api/attachments/action_wrapper.rb +63 -0
  12. data/src/com/zoho/crm/api/attachments/api_exception.rb +125 -0
  13. data/src/com/zoho/crm/api/attachments/attachment.rb +367 -0
  14. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +196 -0
  15. data/src/com/zoho/crm/api/attachments/file_body_wrapper.rb +64 -0
  16. data/src/com/zoho/crm/api/attachments/response_handler.rb +10 -0
  17. data/src/com/zoho/crm/api/attachments/response_wrapper.rb +83 -0
  18. data/src/com/zoho/crm/api/attachments/success_response.rb +121 -0
  19. data/src/com/zoho/crm/api/blue_print/action_response.rb +10 -0
  20. data/src/com/zoho/crm/api/blue_print/api_exception.rb +123 -0
  21. data/src/com/zoho/crm/api/blue_print/blue_print.rb +119 -0
  22. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +67 -0
  23. data/src/com/zoho/crm/api/blue_print/body_wrapper.rb +61 -0
  24. data/src/com/zoho/crm/api/blue_print/next_transition.rb +80 -0
  25. data/src/com/zoho/crm/api/blue_print/process_info.rb +251 -0
  26. data/src/com/zoho/crm/api/blue_print/response_handler.rb +10 -0
  27. data/src/com/zoho/crm/api/blue_print/response_wrapper.rb +63 -0
  28. data/src/com/zoho/crm/api/blue_print/success_response.rb +121 -0
  29. data/src/com/zoho/crm/api/blue_print/transition.rb +253 -0
  30. data/src/com/zoho/crm/api/blue_print/validation_error.rb +80 -0
  31. data/src/com/zoho/crm/api/bulk_read/action_handler.rb +10 -0
  32. data/src/com/zoho/crm/api/bulk_read/action_response.rb +10 -0
  33. data/src/com/zoho/crm/api/bulk_read/action_wrapper.rb +82 -0
  34. data/src/com/zoho/crm/api/bulk_read/api_exception.rb +125 -0
  35. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +74 -0
  36. data/src/com/zoho/crm/api/bulk_read/call_back.rb +81 -0
  37. data/src/com/zoho/crm/api/bulk_read/criteria.rb +135 -0
  38. data/src/com/zoho/crm/api/bulk_read/file_body_wrapper.rb +64 -0
  39. data/src/com/zoho/crm/api/bulk_read/job_detail.rb +196 -0
  40. data/src/com/zoho/crm/api/bulk_read/query.rb +137 -0
  41. data/src/com/zoho/crm/api/bulk_read/request_wrapper.rb +100 -0
  42. data/src/com/zoho/crm/api/bulk_read/response_handler.rb +10 -0
  43. data/src/com/zoho/crm/api/bulk_read/response_wrapper.rb +63 -0
  44. data/src/com/zoho/crm/api/bulk_read/result.rb +137 -0
  45. data/src/com/zoho/crm/api/bulk_read/success_response.rb +121 -0
  46. data/src/com/zoho/crm/api/bulk_write/action_response.rb +10 -0
  47. data/src/com/zoho/crm/api/bulk_write/api_exception.rb +239 -0
  48. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +112 -0
  49. data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb +216 -0
  50. data/src/com/zoho/crm/api/bulk_write/call_back.rb +81 -0
  51. data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +156 -0
  52. data/src/com/zoho/crm/api/bulk_write/file.rb +157 -0
  53. data/src/com/zoho/crm/api/bulk_write/file_body_wrapper.rb +64 -0
  54. data/src/com/zoho/crm/api/bulk_write/request_wrapper.rb +119 -0
  55. data/src/com/zoho/crm/api/bulk_write/resource.rb +195 -0
  56. data/src/com/zoho/crm/api/bulk_write/response_handler.rb +10 -0
  57. data/src/com/zoho/crm/api/bulk_write/response_wrapper.rb +10 -0
  58. data/src/com/zoho/crm/api/bulk_write/result.rb +61 -0
  59. data/src/com/zoho/crm/api/bulk_write/success_response.rb +121 -0
  60. data/src/com/zoho/crm/api/contact_roles/action_handler.rb +10 -0
  61. data/src/com/zoho/crm/api/contact_roles/action_response.rb +10 -0
  62. data/src/com/zoho/crm/api/contact_roles/action_wrapper.rb +63 -0
  63. data/src/com/zoho/crm/api/contact_roles/api_exception.rb +125 -0
  64. data/src/com/zoho/crm/api/contact_roles/body_wrapper.rb +61 -0
  65. data/src/com/zoho/crm/api/contact_roles/contact_role.rb +99 -0
  66. data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +161 -0
  67. data/src/com/zoho/crm/api/contact_roles/response_handler.rb +10 -0
  68. data/src/com/zoho/crm/api/contact_roles/response_wrapper.rb +63 -0
  69. data/src/com/zoho/crm/api/contact_roles/success_response.rb +121 -0
  70. data/src/com/zoho/crm/api/currencies/action_handler.rb +10 -0
  71. data/src/com/zoho/crm/api/currencies/action_response.rb +10 -0
  72. data/src/com/zoho/crm/api/currencies/action_wrapper.rb +63 -0
  73. data/src/com/zoho/crm/api/currencies/api_exception.rb +127 -0
  74. data/src/com/zoho/crm/api/currencies/base_currency_action_handler.rb +10 -0
  75. data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb +63 -0
  76. data/src/com/zoho/crm/api/currencies/base_currency_wrapper.rb +61 -0
  77. data/src/com/zoho/crm/api/currencies/body_wrapper.rb +61 -0
  78. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +156 -0
  79. data/src/com/zoho/crm/api/currencies/currency.rb +290 -0
  80. data/src/com/zoho/crm/api/currencies/format.rb +100 -0
  81. data/src/com/zoho/crm/api/currencies/response_handler.rb +10 -0
  82. data/src/com/zoho/crm/api/currencies/response_wrapper.rb +63 -0
  83. data/src/com/zoho/crm/api/currencies/success_response.rb +121 -0
  84. data/src/com/zoho/crm/api/custom_views/api_exception.rb +121 -0
  85. data/src/com/zoho/crm/api/custom_views/criteria.rb +135 -0
  86. data/src/com/zoho/crm/api/custom_views/custom_view.rb +327 -0
  87. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +75 -0
  88. data/src/com/zoho/crm/api/custom_views/info.rb +156 -0
  89. data/src/com/zoho/crm/api/custom_views/range.rb +80 -0
  90. data/src/com/zoho/crm/api/custom_views/response_handler.rb +10 -0
  91. data/src/com/zoho/crm/api/custom_views/response_wrapper.rb +82 -0
  92. data/src/com/zoho/crm/api/custom_views/shared_details.rb +118 -0
  93. data/src/com/zoho/crm/api/custom_views/translation.rb +118 -0
  94. data/src/com/zoho/crm/api/dc/au_datacenter.rb +18 -0
  95. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +18 -0
  96. data/src/com/zoho/crm/api/dc/datacenter.rb +20 -0
  97. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +18 -0
  98. data/src/com/zoho/crm/api/dc/in_datacenter.rb +18 -0
  99. data/src/com/zoho/crm/api/dc/us_datacenter.rb +18 -0
  100. data/src/com/zoho/crm/api/exception/sdk_exception.rb +47 -0
  101. data/src/com/zoho/crm/api/fields/api_exception.rb +121 -0
  102. data/src/com/zoho/crm/api/fields/association_details.rb +80 -0
  103. data/src/com/zoho/crm/api/fields/auto_number.rb +99 -0
  104. data/src/com/zoho/crm/api/fields/crypt.rb +156 -0
  105. data/src/com/zoho/crm/api/fields/currency.rb +80 -0
  106. data/src/com/zoho/crm/api/fields/field.rb +956 -0
  107. data/src/com/zoho/crm/api/fields/fields_operations.rb +71 -0
  108. data/src/com/zoho/crm/api/fields/formula.rb +80 -0
  109. data/src/com/zoho/crm/api/fields/lookup_field.rb +80 -0
  110. data/src/com/zoho/crm/api/fields/module.rb +157 -0
  111. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +156 -0
  112. data/src/com/zoho/crm/api/fields/pick_list_value.rb +175 -0
  113. data/src/com/zoho/crm/api/fields/private.rb +99 -0
  114. data/src/com/zoho/crm/api/fields/related_details.rb +137 -0
  115. data/src/com/zoho/crm/api/fields/response_handler.rb +10 -0
  116. data/src/com/zoho/crm/api/fields/response_wrapper.rb +63 -0
  117. data/src/com/zoho/crm/api/fields/tool_tip.rb +80 -0
  118. data/src/com/zoho/crm/api/fields/unique.rb +61 -0
  119. data/src/com/zoho/crm/api/fields/view_type.rb +118 -0
  120. data/src/com/zoho/crm/api/files/action_handler.rb +10 -0
  121. data/src/com/zoho/crm/api/files/action_response.rb +10 -0
  122. data/src/com/zoho/crm/api/files/action_wrapper.rb +63 -0
  123. data/src/com/zoho/crm/api/files/api_exception.rb +125 -0
  124. data/src/com/zoho/crm/api/files/body_wrapper.rb +62 -0
  125. data/src/com/zoho/crm/api/files/file_body_wrapper.rb +64 -0
  126. data/src/com/zoho/crm/api/files/file_operations.rb +75 -0
  127. data/src/com/zoho/crm/api/files/response_handler.rb +10 -0
  128. data/src/com/zoho/crm/api/files/success_response.rb +121 -0
  129. data/src/com/zoho/crm/api/header.rb +10 -0
  130. data/src/com/zoho/crm/api/header_map.rb +55 -0
  131. data/src/com/zoho/crm/api/initializer.rb +192 -0
  132. data/src/com/zoho/crm/api/layouts/api_exception.rb +121 -0
  133. data/src/com/zoho/crm/api/layouts/layout.rb +272 -0
  134. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +61 -0
  135. data/src/com/zoho/crm/api/layouts/properties.rb +100 -0
  136. data/src/com/zoho/crm/api/layouts/response_handler.rb +10 -0
  137. data/src/com/zoho/crm/api/layouts/response_wrapper.rb +63 -0
  138. data/src/com/zoho/crm/api/layouts/section.rb +233 -0
  139. data/src/com/zoho/crm/api/modules/action_handler.rb +10 -0
  140. data/src/com/zoho/crm/api/modules/action_response.rb +10 -0
  141. data/src/com/zoho/crm/api/modules/action_wrapper.rb +63 -0
  142. data/src/com/zoho/crm/api/modules/api_exception.rb +125 -0
  143. data/src/com/zoho/crm/api/modules/argument.rb +80 -0
  144. data/src/com/zoho/crm/api/modules/body_wrapper.rb +61 -0
  145. data/src/com/zoho/crm/api/modules/module.rb +882 -0
  146. data/src/com/zoho/crm/api/modules/modules_operations.rb +111 -0
  147. data/src/com/zoho/crm/api/modules/related_list_properties.rb +99 -0
  148. data/src/com/zoho/crm/api/modules/response_handler.rb +10 -0
  149. data/src/com/zoho/crm/api/modules/response_wrapper.rb +63 -0
  150. data/src/com/zoho/crm/api/modules/success_response.rb +121 -0
  151. data/src/com/zoho/crm/api/modules/territory.rb +99 -0
  152. data/src/com/zoho/crm/api/notes/action_handler.rb +10 -0
  153. data/src/com/zoho/crm/api/notes/action_response.rb +10 -0
  154. data/src/com/zoho/crm/api/notes/action_wrapper.rb +63 -0
  155. data/src/com/zoho/crm/api/notes/api_exception.rb +125 -0
  156. data/src/com/zoho/crm/api/notes/body_wrapper.rb +61 -0
  157. data/src/com/zoho/crm/api/notes/info.rb +118 -0
  158. data/src/com/zoho/crm/api/notes/note.rb +349 -0
  159. data/src/com/zoho/crm/api/notes/notes_operations.rb +219 -0
  160. data/src/com/zoho/crm/api/notes/response_handler.rb +10 -0
  161. data/src/com/zoho/crm/api/notes/response_wrapper.rb +82 -0
  162. data/src/com/zoho/crm/api/notes/success_response.rb +121 -0
  163. data/src/com/zoho/crm/api/notification/action_handler.rb +10 -0
  164. data/src/com/zoho/crm/api/notification/action_response.rb +10 -0
  165. data/src/com/zoho/crm/api/notification/action_wrapper.rb +63 -0
  166. data/src/com/zoho/crm/api/notification/api_exception.rb +125 -0
  167. data/src/com/zoho/crm/api/notification/body_wrapper.rb +61 -0
  168. data/src/com/zoho/crm/api/notification/info.rb +118 -0
  169. data/src/com/zoho/crm/api/notification/notification.rb +251 -0
  170. data/src/com/zoho/crm/api/notification/notification_operations.rb +164 -0
  171. data/src/com/zoho/crm/api/notification/response_handler.rb +10 -0
  172. data/src/com/zoho/crm/api/notification/response_wrapper.rb +82 -0
  173. data/src/com/zoho/crm/api/notification/success_response.rb +121 -0
  174. data/src/com/zoho/crm/api/org/action_response.rb +10 -0
  175. data/src/com/zoho/crm/api/org/api_exception.rb +123 -0
  176. data/src/com/zoho/crm/api/org/file_body_wrapper.rb +62 -0
  177. data/src/com/zoho/crm/api/org/license_details.rb +156 -0
  178. data/src/com/zoho/crm/api/org/org.rb +631 -0
  179. data/src/com/zoho/crm/api/org/org_operations.rb +49 -0
  180. data/src/com/zoho/crm/api/org/response_handler.rb +10 -0
  181. data/src/com/zoho/crm/api/org/response_wrapper.rb +63 -0
  182. data/src/com/zoho/crm/api/org/success_response.rb +121 -0
  183. data/src/com/zoho/crm/api/param.rb +10 -0
  184. data/src/com/zoho/crm/api/parameter_map.rb +54 -0
  185. data/src/com/zoho/crm/api/profiles/api_exception.rb +121 -0
  186. data/src/com/zoho/crm/api/profiles/category.rb +99 -0
  187. data/src/com/zoho/crm/api/profiles/permission_detail.rb +137 -0
  188. data/src/com/zoho/crm/api/profiles/profile.rb +290 -0
  189. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +61 -0
  190. data/src/com/zoho/crm/api/profiles/response_handler.rb +10 -0
  191. data/src/com/zoho/crm/api/profiles/response_wrapper.rb +63 -0
  192. data/src/com/zoho/crm/api/profiles/section.rb +80 -0
  193. data/src/com/zoho/crm/api/query/api_exception.rb +121 -0
  194. data/src/com/zoho/crm/api/query/body_wrapper.rb +61 -0
  195. data/src/com/zoho/crm/api/query/query_operations.rb +35 -0
  196. data/src/com/zoho/crm/api/query/response_handler.rb +10 -0
  197. data/src/com/zoho/crm/api/query/response_wrapper.rb +84 -0
  198. data/src/com/zoho/crm/api/record/action_handler.rb +10 -0
  199. data/src/com/zoho/crm/api/record/action_response.rb +10 -0
  200. data/src/com/zoho/crm/api/record/action_wrapper.rb +63 -0
  201. data/src/com/zoho/crm/api/record/api_exception.rb +143 -0
  202. data/src/com/zoho/crm/api/record/body_wrapper.rb +156 -0
  203. data/src/com/zoho/crm/api/record/carry_over_tags.rb +99 -0
  204. data/src/com/zoho/crm/api/record/comment.rb +118 -0
  205. data/src/com/zoho/crm/api/record/consent.rb +185 -0
  206. data/src/com/zoho/crm/api/record/convert_action_handler.rb +10 -0
  207. data/src/com/zoho/crm/api/record/convert_action_response.rb +10 -0
  208. data/src/com/zoho/crm/api/record/convert_action_wrapper.rb +63 -0
  209. data/src/com/zoho/crm/api/record/convert_body_wrapper.rb +61 -0
  210. data/src/com/zoho/crm/api/record/criteria.rb +135 -0
  211. data/src/com/zoho/crm/api/record/deleted_record.rb +157 -0
  212. data/src/com/zoho/crm/api/record/deleted_records_handler.rb +10 -0
  213. data/src/com/zoho/crm/api/record/deleted_records_wrapper.rb +82 -0
  214. data/src/com/zoho/crm/api/record/download_handler.rb +10 -0
  215. data/src/com/zoho/crm/api/record/field.rb +2109 -0
  216. data/src/com/zoho/crm/api/record/file_body_wrapper.rb +66 -0
  217. data/src/com/zoho/crm/api/record/file_details.rb +327 -0
  218. data/src/com/zoho/crm/api/record/file_handler.rb +10 -0
  219. data/src/com/zoho/crm/api/record/info.rb +118 -0
  220. data/src/com/zoho/crm/api/record/inventory_line_items.rb +235 -0
  221. data/src/com/zoho/crm/api/record/lead_converter.rb +194 -0
  222. data/src/com/zoho/crm/api/record/line_item_product.rb +65 -0
  223. data/src/com/zoho/crm/api/record/line_tax.rb +118 -0
  224. data/src/com/zoho/crm/api/record/mass_update.rb +140 -0
  225. data/src/com/zoho/crm/api/record/mass_update_action_handler.rb +10 -0
  226. data/src/com/zoho/crm/api/record/mass_update_action_response.rb +10 -0
  227. data/src/com/zoho/crm/api/record/mass_update_action_wrapper.rb +63 -0
  228. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +156 -0
  229. data/src/com/zoho/crm/api/record/mass_update_response.rb +10 -0
  230. data/src/com/zoho/crm/api/record/mass_update_response_handler.rb +10 -0
  231. data/src/com/zoho/crm/api/record/mass_update_response_wrapper.rb +63 -0
  232. data/src/com/zoho/crm/api/record/mass_update_success_response.rb +121 -0
  233. data/src/com/zoho/crm/api/record/options.rb +10 -0
  234. data/src/com/zoho/crm/api/record/participants.rb +116 -0
  235. data/src/com/zoho/crm/api/record/pricing_details.rb +65 -0
  236. data/src/com/zoho/crm/api/record/record.rb +192 -0
  237. data/src/com/zoho/crm/api/record/record_operations.rb +677 -0
  238. data/src/com/zoho/crm/api/record/recurring_activity.rb +61 -0
  239. data/src/com/zoho/crm/api/record/remind_at.rb +61 -0
  240. data/src/com/zoho/crm/api/record/reminder.rb +80 -0
  241. data/src/com/zoho/crm/api/record/response_handler.rb +10 -0
  242. data/src/com/zoho/crm/api/record/response_wrapper.rb +82 -0
  243. data/src/com/zoho/crm/api/record/success_response.rb +161 -0
  244. data/src/com/zoho/crm/api/record/successful_convert.rb +101 -0
  245. data/src/com/zoho/crm/api/record/territory.rb +80 -0
  246. data/src/com/zoho/crm/api/related_lists/api_exception.rb +121 -0
  247. data/src/com/zoho/crm/api/related_lists/related_list.rb +251 -0
  248. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +61 -0
  249. data/src/com/zoho/crm/api/related_lists/response_handler.rb +10 -0
  250. data/src/com/zoho/crm/api/related_lists/response_wrapper.rb +63 -0
  251. data/src/com/zoho/crm/api/related_records/action_handler.rb +10 -0
  252. data/src/com/zoho/crm/api/related_records/action_response.rb +10 -0
  253. data/src/com/zoho/crm/api/related_records/action_wrapper.rb +63 -0
  254. data/src/com/zoho/crm/api/related_records/api_exception.rb +125 -0
  255. data/src/com/zoho/crm/api/related_records/body_wrapper.rb +62 -0
  256. data/src/com/zoho/crm/api/related_records/file_body_wrapper.rb +64 -0
  257. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +235 -0
  258. data/src/com/zoho/crm/api/related_records/response_handler.rb +10 -0
  259. data/src/com/zoho/crm/api/related_records/response_wrapper.rb +84 -0
  260. data/src/com/zoho/crm/api/related_records/success_response.rb +121 -0
  261. data/src/com/zoho/crm/api/request_proxy.rb +16 -0
  262. data/src/com/zoho/crm/api/roles/api_exception.rb +121 -0
  263. data/src/com/zoho/crm/api/roles/response_handler.rb +10 -0
  264. data/src/com/zoho/crm/api/roles/response_wrapper.rb +63 -0
  265. data/src/com/zoho/crm/api/roles/role.rb +195 -0
  266. data/src/com/zoho/crm/api/roles/roles_operations.rb +47 -0
  267. data/src/com/zoho/crm/api/sdk_config.rb +78 -0
  268. data/src/com/zoho/crm/api/share_records/action_handler.rb +10 -0
  269. data/src/com/zoho/crm/api/share_records/action_response.rb +10 -0
  270. data/src/com/zoho/crm/api/share_records/action_wrapper.rb +63 -0
  271. data/src/com/zoho/crm/api/share_records/api_exception.rb +129 -0
  272. data/src/com/zoho/crm/api/share_records/body_wrapper.rb +61 -0
  273. data/src/com/zoho/crm/api/share_records/delete_action_handler.rb +10 -0
  274. data/src/com/zoho/crm/api/share_records/delete_action_response.rb +10 -0
  275. data/src/com/zoho/crm/api/share_records/delete_action_wrapper.rb +63 -0
  276. data/src/com/zoho/crm/api/share_records/response_handler.rb +10 -0
  277. data/src/com/zoho/crm/api/share_records/response_wrapper.rb +83 -0
  278. data/src/com/zoho/crm/api/share_records/share_record.rb +157 -0
  279. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +128 -0
  280. data/src/com/zoho/crm/api/share_records/shared_through.rb +100 -0
  281. data/src/com/zoho/crm/api/share_records/success_response.rb +123 -0
  282. data/src/com/zoho/crm/api/tags/action_handler.rb +10 -0
  283. data/src/com/zoho/crm/api/tags/action_response.rb +10 -0
  284. data/src/com/zoho/crm/api/tags/action_wrapper.rb +63 -0
  285. data/src/com/zoho/crm/api/tags/api_exception.rb +131 -0
  286. data/src/com/zoho/crm/api/tags/body_wrapper.rb +61 -0
  287. data/src/com/zoho/crm/api/tags/conflict_wrapper.rb +61 -0
  288. data/src/com/zoho/crm/api/tags/count_handler.rb +10 -0
  289. data/src/com/zoho/crm/api/tags/count_wrapper.rb +63 -0
  290. data/src/com/zoho/crm/api/tags/info.rb +80 -0
  291. data/src/com/zoho/crm/api/tags/merge_wrapper.rb +61 -0
  292. data/src/com/zoho/crm/api/tags/record_action_handler.rb +10 -0
  293. data/src/com/zoho/crm/api/tags/record_action_response.rb +10 -0
  294. data/src/com/zoho/crm/api/tags/record_action_wrapper.rb +120 -0
  295. data/src/com/zoho/crm/api/tags/response_handler.rb +10 -0
  296. data/src/com/zoho/crm/api/tags/response_wrapper.rb +82 -0
  297. data/src/com/zoho/crm/api/tags/success_response.rb +123 -0
  298. data/src/com/zoho/crm/api/tags/tag.rb +157 -0
  299. data/src/com/zoho/crm/api/tags/tags_operations.rb +387 -0
  300. data/src/com/zoho/crm/api/taxes/action_handler.rb +10 -0
  301. data/src/com/zoho/crm/api/taxes/action_response.rb +10 -0
  302. data/src/com/zoho/crm/api/taxes/action_wrapper.rb +63 -0
  303. data/src/com/zoho/crm/api/taxes/api_exception.rb +125 -0
  304. data/src/com/zoho/crm/api/taxes/body_wrapper.rb +61 -0
  305. data/src/com/zoho/crm/api/taxes/preference.rb +80 -0
  306. data/src/com/zoho/crm/api/taxes/response_handler.rb +10 -0
  307. data/src/com/zoho/crm/api/taxes/response_wrapper.rb +82 -0
  308. data/src/com/zoho/crm/api/taxes/success_response.rb +121 -0
  309. data/src/com/zoho/crm/api/taxes/tax.rb +137 -0
  310. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +136 -0
  311. data/src/com/zoho/crm/api/territories/api_exception.rb +121 -0
  312. data/src/com/zoho/crm/api/territories/response_handler.rb +10 -0
  313. data/src/com/zoho/crm/api/territories/response_wrapper.rb +63 -0
  314. data/src/com/zoho/crm/api/territories/territories_operations.rb +47 -0
  315. data/src/com/zoho/crm/api/territories/territory.rb +234 -0
  316. data/src/com/zoho/crm/api/user_signature.rb +27 -0
  317. data/src/com/zoho/crm/api/users/action_handler.rb +10 -0
  318. data/src/com/zoho/crm/api/users/action_response.rb +10 -0
  319. data/src/com/zoho/crm/api/users/action_wrapper.rb +63 -0
  320. data/src/com/zoho/crm/api/users/api_exception.rb +125 -0
  321. data/src/com/zoho/crm/api/users/body_wrapper.rb +61 -0
  322. data/src/com/zoho/crm/api/users/customize_info.rb +156 -0
  323. data/src/com/zoho/crm/api/users/info.rb +118 -0
  324. data/src/com/zoho/crm/api/users/request_wrapper.rb +61 -0
  325. data/src/com/zoho/crm/api/users/response_handler.rb +10 -0
  326. data/src/com/zoho/crm/api/users/response_wrapper.rb +82 -0
  327. data/src/com/zoho/crm/api/users/shift.rb +80 -0
  328. data/src/com/zoho/crm/api/users/success_response.rb +121 -0
  329. data/src/com/zoho/crm/api/users/tab_theme.rb +80 -0
  330. data/src/com/zoho/crm/api/users/territory.rb +99 -0
  331. data/src/com/zoho/crm/api/users/theme.rb +156 -0
  332. data/src/com/zoho/crm/api/users/user.rb +696 -0
  333. data/src/com/zoho/crm/api/users/users_operations.rb +181 -0
  334. data/src/com/zoho/crm/api/util/api_http_connector.rb +111 -0
  335. data/src/com/zoho/crm/api/util/api_response.rb +16 -0
  336. data/src/com/zoho/crm/api/util/choice.rb +9 -0
  337. data/src/com/zoho/crm/api/util/common_api_handler.rb +235 -0
  338. data/src/com/zoho/crm/api/util/constants.rb +536 -0
  339. data/src/com/zoho/crm/api/util/converter.rb +213 -0
  340. data/src/com/zoho/crm/api/util/data_type_converter.rb +162 -0
  341. data/src/com/zoho/crm/api/util/downloader.rb +83 -0
  342. data/src/com/zoho/crm/api/util/form_data_converter.rb +167 -0
  343. data/src/com/zoho/crm/api/util/header_param_validator.rb +55 -0
  344. data/src/com/zoho/crm/api/util/json_converter.rb +726 -0
  345. data/src/com/zoho/crm/api/util/model.rb +5 -0
  346. data/src/com/zoho/crm/api/util/module_fields_handler.rb +78 -0
  347. data/src/com/zoho/crm/api/util/stream_wrapper.rb +37 -0
  348. data/src/com/zoho/crm/api/util/utility.rb +727 -0
  349. data/src/com/zoho/crm/api/variable_groups/api_exception.rb +121 -0
  350. data/src/com/zoho/crm/api/variable_groups/response_handler.rb +10 -0
  351. data/src/com/zoho/crm/api/variable_groups/response_wrapper.rb +63 -0
  352. data/src/com/zoho/crm/api/variable_groups/variable_group.rb +137 -0
  353. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +66 -0
  354. data/src/com/zoho/crm/api/variables/action_handler.rb +10 -0
  355. data/src/com/zoho/crm/api/variables/action_response.rb +10 -0
  356. data/src/com/zoho/crm/api/variables/action_wrapper.rb +63 -0
  357. data/src/com/zoho/crm/api/variables/api_exception.rb +125 -0
  358. data/src/com/zoho/crm/api/variables/body_wrapper.rb +61 -0
  359. data/src/com/zoho/crm/api/variables/response_handler.rb +10 -0
  360. data/src/com/zoho/crm/api/variables/response_wrapper.rb +63 -0
  361. data/src/com/zoho/crm/api/variables/success_response.rb +121 -0
  362. data/src/com/zoho/crm/api/variables/variable.rb +173 -0
  363. data/src/com/zoho/crm/api/variables/variables_operations.rb +241 -0
  364. data/src/resources/JSONDetails.json +1 -0
  365. data/src/version.rb +3 -0
  366. metadata +393 -42
  367. data/lib/ZCRMSDK.rb +0 -14
  368. data/lib/ZCRMSDK/handler.rb +0 -3299
  369. data/lib/ZCRMSDK/oauth_client.rb +0 -257
  370. data/lib/ZCRMSDK/oauth_utility.rb +0 -161
  371. data/lib/ZCRMSDK/operations.rb +0 -1091
  372. data/lib/ZCRMSDK/org.rb +0 -174
  373. data/lib/ZCRMSDK/persistence.rb +0 -129
  374. data/lib/ZCRMSDK/request.rb +0 -83
  375. data/lib/ZCRMSDK/response.rb +0 -216
  376. data/lib/ZCRMSDK/restclient.rb +0 -65
  377. data/lib/ZCRMSDK/utility.rb +0 -310
  378. data/lib/ZCRMSDK/version.rb +0 -5
@@ -0,0 +1,99 @@
1
+ require_relative '../util/model'
2
+
3
+ module Fields
4
+ class AutoNumber
5
+ include Util::Model
6
+
7
+ # Creates an instance of AutoNumber
8
+ def initialize
9
+ @prefix = nil
10
+ @suffix = nil
11
+ @start_number = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the prefix
16
+ # @return A String value
17
+
18
+ def prefix
19
+ @prefix
20
+ end
21
+
22
+ # The method to set the value to prefix
23
+ # @param prefix [String] A String
24
+
25
+ def prefix=(prefix)
26
+ if prefix!=nil and !prefix.is_a? String
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: prefix EXPECTED TYPE: String', nil, nil)
28
+ end
29
+ @prefix = prefix
30
+ @key_modified['prefix'] = 1
31
+ end
32
+
33
+ # The method to get the suffix
34
+ # @return A String value
35
+
36
+ def suffix
37
+ @suffix
38
+ end
39
+
40
+ # The method to set the value to suffix
41
+ # @param suffix [String] A String
42
+
43
+ def suffix=(suffix)
44
+ if suffix!=nil and !suffix.is_a? String
45
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: suffix EXPECTED TYPE: String', nil, nil)
46
+ end
47
+ @suffix = suffix
48
+ @key_modified['suffix'] = 1
49
+ end
50
+
51
+ # The method to get the start_number
52
+ # @return A Integer value
53
+
54
+ def start_number
55
+ @start_number
56
+ end
57
+
58
+ # The method to set the value to start_number
59
+ # @param start_number [Integer] A Integer
60
+
61
+ def start_number=(start_number)
62
+ if start_number!=nil and !start_number.is_a? Integer
63
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: start_number EXPECTED TYPE: Integer', nil, nil)
64
+ end
65
+ @start_number = start_number
66
+ @key_modified['start_number'] = 1
67
+ end
68
+
69
+ # The method to check if the user has modified the given key
70
+ # @param key [String] A String
71
+ # @return A Integer value
72
+
73
+ def is_key_modified(key)
74
+ if key!=nil and !key.is_a? String
75
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
76
+ end
77
+ if @key_modified.key?(key)
78
+ return @key_modified[key]
79
+ end
80
+
81
+ nil
82
+ end
83
+
84
+ # The method to mark the given key as modified
85
+ # @param key [String] A String
86
+ # @param modification [Integer] A Integer
87
+
88
+ def set_key_modified(key, modification)
89
+ if key!=nil and !key.is_a? String
90
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
91
+ end
92
+ if modification!=nil and !modification.is_a? Integer
93
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
94
+ end
95
+ @key_modified[key] = modification
96
+ end
97
+
98
+ end
99
+ end
@@ -0,0 +1,156 @@
1
+ require_relative '../util/model'
2
+
3
+ module Fields
4
+ class Crypt
5
+ include Util::Model
6
+
7
+ # Creates an instance of Crypt
8
+ def initialize
9
+ @mode = nil
10
+ @column = nil
11
+ @encfldids = nil
12
+ @notify = nil
13
+ @table = nil
14
+ @status = nil
15
+ @key_modified = Hash.new
16
+ end
17
+
18
+ # The method to get the mode
19
+ # @return A String value
20
+
21
+ def mode
22
+ @mode
23
+ end
24
+
25
+ # The method to set the value to mode
26
+ # @param mode [String] A String
27
+
28
+ def mode=(mode)
29
+ if mode!=nil and !mode.is_a? String
30
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: String', nil, nil)
31
+ end
32
+ @mode = mode
33
+ @key_modified['mode'] = 1
34
+ end
35
+
36
+ # The method to get the column
37
+ # @return A String value
38
+
39
+ def column
40
+ @column
41
+ end
42
+
43
+ # The method to set the value to column
44
+ # @param column [String] A String
45
+
46
+ def column=(column)
47
+ if column!=nil and !column.is_a? String
48
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column EXPECTED TYPE: String', nil, nil)
49
+ end
50
+ @column = column
51
+ @key_modified['column'] = 1
52
+ end
53
+
54
+ # The method to get the encfldids
55
+ # @return An instance of Array
56
+
57
+ def encfldids
58
+ @encfldids
59
+ end
60
+
61
+ # The method to set the value to encfldids
62
+ # @param encfldids [Array] An instance of Array
63
+
64
+ def encfldids=(encfldids)
65
+ if encfldids!=nil and !encfldids.is_a? Array
66
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: encfldids EXPECTED TYPE: Array', nil, nil)
67
+ end
68
+ @encfldids = encfldids
69
+ @key_modified['encFldIds'] = 1
70
+ end
71
+
72
+ # The method to get the notify
73
+ # @return A String value
74
+
75
+ def notify
76
+ @notify
77
+ end
78
+
79
+ # The method to set the value to notify
80
+ # @param notify [String] A String
81
+
82
+ def notify=(notify)
83
+ if notify!=nil and !notify.is_a? String
84
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: String', nil, nil)
85
+ end
86
+ @notify = notify
87
+ @key_modified['notify'] = 1
88
+ end
89
+
90
+ # The method to get the table
91
+ # @return A String value
92
+
93
+ def table
94
+ @table
95
+ end
96
+
97
+ # The method to set the value to table
98
+ # @param table [String] A String
99
+
100
+ def table=(table)
101
+ if table!=nil and !table.is_a? String
102
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: table EXPECTED TYPE: String', nil, nil)
103
+ end
104
+ @table = table
105
+ @key_modified['table'] = 1
106
+ end
107
+
108
+ # The method to get the status
109
+ # @return A Integer value
110
+
111
+ def status
112
+ @status
113
+ end
114
+
115
+ # The method to set the value to status
116
+ # @param status [Integer] A Integer
117
+
118
+ def status=(status)
119
+ if status!=nil and !status.is_a? Integer
120
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Integer', nil, nil)
121
+ end
122
+ @status = status
123
+ @key_modified['status'] = 1
124
+ end
125
+
126
+ # The method to check if the user has modified the given key
127
+ # @param key [String] A String
128
+ # @return A Integer value
129
+
130
+ def is_key_modified(key)
131
+ if key!=nil and !key.is_a? String
132
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
133
+ end
134
+ if @key_modified.key?(key)
135
+ return @key_modified[key]
136
+ end
137
+
138
+ nil
139
+ end
140
+
141
+ # The method to mark the given key as modified
142
+ # @param key [String] A String
143
+ # @param modification [Integer] A Integer
144
+
145
+ def set_key_modified(key, modification)
146
+ if key!=nil and !key.is_a? String
147
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
148
+ end
149
+ if modification!=nil and !modification.is_a? Integer
150
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
151
+ end
152
+ @key_modified[key] = modification
153
+ end
154
+
155
+ end
156
+ end
@@ -0,0 +1,80 @@
1
+ require_relative '../util/model'
2
+
3
+ module Fields
4
+ class Currency
5
+ include Util::Model
6
+
7
+ # Creates an instance of Currency
8
+ def initialize
9
+ @rounding_option = nil
10
+ @precision = nil
11
+ @key_modified = Hash.new
12
+ end
13
+
14
+ # The method to get the rounding_option
15
+ # @return A String value
16
+
17
+ def rounding_option
18
+ @rounding_option
19
+ end
20
+
21
+ # The method to set the value to rounding_option
22
+ # @param rounding_option [String] A String
23
+
24
+ def rounding_option=(rounding_option)
25
+ if rounding_option!=nil and !rounding_option.is_a? String
26
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: rounding_option EXPECTED TYPE: String', nil, nil)
27
+ end
28
+ @rounding_option = rounding_option
29
+ @key_modified['rounding_option'] = 1
30
+ end
31
+
32
+ # The method to get the precision
33
+ # @return A Integer value
34
+
35
+ def precision
36
+ @precision
37
+ end
38
+
39
+ # The method to set the value to precision
40
+ # @param precision [Integer] A Integer
41
+
42
+ def precision=(precision)
43
+ if precision!=nil and !precision.is_a? Integer
44
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: precision EXPECTED TYPE: Integer', nil, nil)
45
+ end
46
+ @precision = precision
47
+ @key_modified['precision'] = 1
48
+ end
49
+
50
+ # The method to check if the user has modified the given key
51
+ # @param key [String] A String
52
+ # @return A Integer value
53
+
54
+ def is_key_modified(key)
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 @key_modified.key?(key)
59
+ return @key_modified[key]
60
+ end
61
+
62
+ nil
63
+ end
64
+
65
+ # The method to mark the given key as modified
66
+ # @param key [String] A String
67
+ # @param modification [Integer] A Integer
68
+
69
+ def set_key_modified(key, modification)
70
+ if key!=nil and !key.is_a? String
71
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
72
+ end
73
+ if modification!=nil and !modification.is_a? Integer
74
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
75
+ end
76
+ @key_modified[key] = modification
77
+ end
78
+
79
+ end
80
+ end
@@ -0,0 +1,956 @@
1
+ require_relative '../custom_views/criteria'
2
+ require_relative '../layouts/layout'
3
+ require_relative '../util/model'
4
+
5
+ module Fields
6
+ class Field
7
+ include Util::Model
8
+
9
+ # Creates an instance of Field
10
+ def initialize
11
+ @system_mandatory = nil
12
+ @webhook = nil
13
+ @private = nil
14
+ @layouts = nil
15
+ @content = nil
16
+ @column_name = nil
17
+ @type = nil
18
+ @transition_sequence = nil
19
+ @personality_name = nil
20
+ @message = nil
21
+ @mandatory = nil
22
+ @criteria = nil
23
+ @related_details = nil
24
+ @json_type = nil
25
+ @crypt = nil
26
+ @field_label = nil
27
+ @tooltip = nil
28
+ @created_source = nil
29
+ @field_read_only = nil
30
+ @display_label = nil
31
+ @read_only = nil
32
+ @association_details = nil
33
+ @quick_sequence_number = nil
34
+ @businesscard_supported = nil
35
+ @multi_module_lookup = nil
36
+ @currency = nil
37
+ @id = nil
38
+ @custom_field = nil
39
+ @lookup = nil
40
+ @visible = nil
41
+ @length = nil
42
+ @view_type = nil
43
+ @subform = nil
44
+ @api_name = nil
45
+ @unique = nil
46
+ @history_tracking = nil
47
+ @data_type = nil
48
+ @formula = nil
49
+ @decimal_place = nil
50
+ @mass_update = nil
51
+ @blueprint_supported = nil
52
+ @multiselectlookup = nil
53
+ @pick_list_values = nil
54
+ @auto_number = nil
55
+ @default_value = nil
56
+ @section_id = nil
57
+ @validation_rule = nil
58
+ @convert_mapping = nil
59
+ @key_modified = Hash.new
60
+ end
61
+
62
+ # The method to get the system_mandatory
63
+ # @return A Boolean value
64
+
65
+ def system_mandatory
66
+ @system_mandatory
67
+ end
68
+
69
+ # The method to set the value to system_mandatory
70
+ # @param system_mandatory [Boolean] A Boolean
71
+
72
+ def system_mandatory=(system_mandatory)
73
+ if system_mandatory!=nil and ! [true, false].include?system_mandatory
74
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: Boolean', nil, nil)
75
+ end
76
+ @system_mandatory = system_mandatory
77
+ @key_modified['system_mandatory'] = 1
78
+ end
79
+
80
+ # The method to get the webhook
81
+ # @return A Boolean value
82
+
83
+ def webhook
84
+ @webhook
85
+ end
86
+
87
+ # The method to set the value to webhook
88
+ # @param webhook [Boolean] A Boolean
89
+
90
+ def webhook=(webhook)
91
+ if webhook!=nil and ! [true, false].include?webhook
92
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: Boolean', nil, nil)
93
+ end
94
+ @webhook = webhook
95
+ @key_modified['webhook'] = 1
96
+ end
97
+
98
+ # The method to get the private
99
+ # @return An instance of Private
100
+
101
+ def private
102
+ @private
103
+ end
104
+
105
+ # The method to set the value to private
106
+ # @param private [Private] An instance of Private
107
+
108
+ def private=(private)
109
+ if private!=nil and !private.is_a? Private
110
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', nil, nil)
111
+ end
112
+ @private = private
113
+ @key_modified['private'] = 1
114
+ end
115
+
116
+ # The method to get the layouts
117
+ # @return An instance of Layouts::Layout
118
+
119
+ def layouts
120
+ @layouts
121
+ end
122
+
123
+ # The method to set the value to layouts
124
+ # @param layouts [Layouts::Layout] An instance of Layouts::Layout
125
+
126
+ def layouts=(layouts)
127
+ if layouts!=nil and !layouts.is_a? Layouts::Layout
128
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: Layout', nil, nil)
129
+ end
130
+ @layouts = layouts
131
+ @key_modified['layouts'] = 1
132
+ end
133
+
134
+ # The method to get the content
135
+ # @return A String value
136
+
137
+ def content
138
+ @content
139
+ end
140
+
141
+ # The method to set the value to content
142
+ # @param content [String] A String
143
+
144
+ def content=(content)
145
+ if content!=nil and !content.is_a? String
146
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: String', nil, nil)
147
+ end
148
+ @content = content
149
+ @key_modified['content'] = 1
150
+ end
151
+
152
+ # The method to get the column_name
153
+ # @return A String value
154
+
155
+ def column_name
156
+ @column_name
157
+ end
158
+
159
+ # The method to set the value to column_name
160
+ # @param column_name [String] A String
161
+
162
+ def column_name=(column_name)
163
+ if column_name!=nil and !column_name.is_a? String
164
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: String', nil, nil)
165
+ end
166
+ @column_name = column_name
167
+ @key_modified['column_name'] = 1
168
+ end
169
+
170
+ # The method to get the type
171
+ # @return A String value
172
+
173
+ def type
174
+ @type
175
+ end
176
+
177
+ # The method to set the value to type
178
+ # @param type [String] A String
179
+
180
+ def type=(type)
181
+ if type!=nil and !type.is_a? String
182
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
183
+ end
184
+ @type = type
185
+ @key_modified['_type'] = 1
186
+ end
187
+
188
+ # The method to get the transition_sequence
189
+ # @return A Integer value
190
+
191
+ def transition_sequence
192
+ @transition_sequence
193
+ end
194
+
195
+ # The method to set the value to transition_sequence
196
+ # @param transition_sequence [Integer] A Integer
197
+
198
+ def transition_sequence=(transition_sequence)
199
+ if transition_sequence!=nil and !transition_sequence.is_a? Integer
200
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: transition_sequence EXPECTED TYPE: Integer', nil, nil)
201
+ end
202
+ @transition_sequence = transition_sequence
203
+ @key_modified['transition_sequence'] = 1
204
+ end
205
+
206
+ # The method to get the personality_name
207
+ # @return A String value
208
+
209
+ def personality_name
210
+ @personality_name
211
+ end
212
+
213
+ # The method to set the value to personality_name
214
+ # @param personality_name [String] A String
215
+
216
+ def personality_name=(personality_name)
217
+ if personality_name!=nil and !personality_name.is_a? String
218
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: personality_name EXPECTED TYPE: String', nil, nil)
219
+ end
220
+ @personality_name = personality_name
221
+ @key_modified['personality_name'] = 1
222
+ end
223
+
224
+ # The method to get the message
225
+ # @return A String value
226
+
227
+ def message
228
+ @message
229
+ end
230
+
231
+ # The method to set the value to message
232
+ # @param message [String] A String
233
+
234
+ def message=(message)
235
+ if message!=nil and !message.is_a? String
236
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: String', nil, nil)
237
+ end
238
+ @message = message
239
+ @key_modified['message'] = 1
240
+ end
241
+
242
+ # The method to get the mandatory
243
+ # @return A Boolean value
244
+
245
+ def mandatory
246
+ @mandatory
247
+ end
248
+
249
+ # The method to set the value to mandatory
250
+ # @param mandatory [Boolean] A Boolean
251
+
252
+ def mandatory=(mandatory)
253
+ if mandatory!=nil and ! [true, false].include?mandatory
254
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mandatory EXPECTED TYPE: Boolean', nil, nil)
255
+ end
256
+ @mandatory = mandatory
257
+ @key_modified['mandatory'] = 1
258
+ end
259
+
260
+ # The method to get the criteria
261
+ # @return An instance of CustomViews::Criteria
262
+
263
+ def criteria
264
+ @criteria
265
+ end
266
+
267
+ # The method to set the value to criteria
268
+ # @param criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
269
+
270
+ def criteria=(criteria)
271
+ if criteria!=nil and !criteria.is_a? CustomViews::Criteria
272
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
273
+ end
274
+ @criteria = criteria
275
+ @key_modified['criteria'] = 1
276
+ end
277
+
278
+ # The method to get the related_details
279
+ # @return An instance of RelatedDetails
280
+
281
+ def related_details
282
+ @related_details
283
+ end
284
+
285
+ # The method to set the value to related_details
286
+ # @param related_details [RelatedDetails] An instance of RelatedDetails
287
+
288
+ def related_details=(related_details)
289
+ if related_details!=nil and !related_details.is_a? RelatedDetails
290
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_details EXPECTED TYPE: RelatedDetails', nil, nil)
291
+ end
292
+ @related_details = related_details
293
+ @key_modified['related_details'] = 1
294
+ end
295
+
296
+ # The method to get the json_type
297
+ # @return A String value
298
+
299
+ def json_type
300
+ @json_type
301
+ end
302
+
303
+ # The method to set the value to json_type
304
+ # @param json_type [String] A String
305
+
306
+ def json_type=(json_type)
307
+ if json_type!=nil and !json_type.is_a? String
308
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: String', nil, nil)
309
+ end
310
+ @json_type = json_type
311
+ @key_modified['json_type'] = 1
312
+ end
313
+
314
+ # The method to get the crypt
315
+ # @return An instance of Crypt
316
+
317
+ def crypt
318
+ @crypt
319
+ end
320
+
321
+ # The method to set the value to crypt
322
+ # @param crypt [Crypt] An instance of Crypt
323
+
324
+ def crypt=(crypt)
325
+ if crypt!=nil and !crypt.is_a? Crypt
326
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', nil, nil)
327
+ end
328
+ @crypt = crypt
329
+ @key_modified['crypt'] = 1
330
+ end
331
+
332
+ # The method to get the field_label
333
+ # @return A String value
334
+
335
+ def field_label
336
+ @field_label
337
+ end
338
+
339
+ # The method to set the value to field_label
340
+ # @param field_label [String] A String
341
+
342
+ def field_label=(field_label)
343
+ if field_label!=nil and !field_label.is_a? String
344
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: String', nil, nil)
345
+ end
346
+ @field_label = field_label
347
+ @key_modified['field_label'] = 1
348
+ end
349
+
350
+ # The method to get the tooltip
351
+ # @return An instance of ToolTip
352
+
353
+ def tooltip
354
+ @tooltip
355
+ end
356
+
357
+ # The method to set the value to tooltip
358
+ # @param tooltip [ToolTip] An instance of ToolTip
359
+
360
+ def tooltip=(tooltip)
361
+ if tooltip!=nil and !tooltip.is_a? ToolTip
362
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: ToolTip', nil, nil)
363
+ end
364
+ @tooltip = tooltip
365
+ @key_modified['tooltip'] = 1
366
+ end
367
+
368
+ # The method to get the created_source
369
+ # @return A String value
370
+
371
+ def created_source
372
+ @created_source
373
+ end
374
+
375
+ # The method to set the value to created_source
376
+ # @param created_source [String] A String
377
+
378
+ def created_source=(created_source)
379
+ if created_source!=nil and !created_source.is_a? String
380
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: String', nil, nil)
381
+ end
382
+ @created_source = created_source
383
+ @key_modified['created_source'] = 1
384
+ end
385
+
386
+ # The method to get the field_read_only
387
+ # @return A Boolean value
388
+
389
+ def field_read_only
390
+ @field_read_only
391
+ end
392
+
393
+ # The method to set the value to field_read_only
394
+ # @param field_read_only [Boolean] A Boolean
395
+
396
+ def field_read_only=(field_read_only)
397
+ if field_read_only!=nil and ! [true, false].include?field_read_only
398
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: Boolean', nil, nil)
399
+ end
400
+ @field_read_only = field_read_only
401
+ @key_modified['field_read_only'] = 1
402
+ end
403
+
404
+ # The method to get the display_label
405
+ # @return A String value
406
+
407
+ def display_label
408
+ @display_label
409
+ end
410
+
411
+ # The method to set the value to display_label
412
+ # @param display_label [String] A String
413
+
414
+ def display_label=(display_label)
415
+ if display_label!=nil and !display_label.is_a? String
416
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
417
+ end
418
+ @display_label = display_label
419
+ @key_modified['display_label'] = 1
420
+ end
421
+
422
+ # The method to get the read_only
423
+ # @return A Boolean value
424
+
425
+ def read_only
426
+ @read_only
427
+ end
428
+
429
+ # The method to set the value to read_only
430
+ # @param read_only [Boolean] A Boolean
431
+
432
+ def read_only=(read_only)
433
+ if read_only!=nil and ! [true, false].include?read_only
434
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: Boolean', nil, nil)
435
+ end
436
+ @read_only = read_only
437
+ @key_modified['read_only'] = 1
438
+ end
439
+
440
+ # The method to get the association_details
441
+ # @return An instance of AssociationDetails
442
+
443
+ def association_details
444
+ @association_details
445
+ end
446
+
447
+ # The method to set the value to association_details
448
+ # @param association_details [AssociationDetails] An instance of AssociationDetails
449
+
450
+ def association_details=(association_details)
451
+ if association_details!=nil and !association_details.is_a? AssociationDetails
452
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', nil, nil)
453
+ end
454
+ @association_details = association_details
455
+ @key_modified['association_details'] = 1
456
+ end
457
+
458
+ # The method to get the quick_sequence_number
459
+ # @return A Integer value
460
+
461
+ def quick_sequence_number
462
+ @quick_sequence_number
463
+ end
464
+
465
+ # The method to set the value to quick_sequence_number
466
+ # @param quick_sequence_number [Integer] A Integer
467
+
468
+ def quick_sequence_number=(quick_sequence_number)
469
+ if quick_sequence_number!=nil and !quick_sequence_number.is_a? Integer
470
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: Integer', nil, nil)
471
+ end
472
+ @quick_sequence_number = quick_sequence_number
473
+ @key_modified['quick_sequence_number'] = 1
474
+ end
475
+
476
+ # The method to get the businesscard_supported
477
+ # @return A Boolean value
478
+
479
+ def businesscard_supported
480
+ @businesscard_supported
481
+ end
482
+
483
+ # The method to set the value to businesscard_supported
484
+ # @param businesscard_supported [Boolean] A Boolean
485
+
486
+ def businesscard_supported=(businesscard_supported)
487
+ if businesscard_supported!=nil and ! [true, false].include?businesscard_supported
488
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: Boolean', nil, nil)
489
+ end
490
+ @businesscard_supported = businesscard_supported
491
+ @key_modified['businesscard_supported'] = 1
492
+ end
493
+
494
+ # The method to get the multi_module_lookup
495
+ # @return An instance of Hash
496
+
497
+ def multi_module_lookup
498
+ @multi_module_lookup
499
+ end
500
+
501
+ # The method to set the value to multi_module_lookup
502
+ # @param multi_module_lookup [Hash] An instance of Hash
503
+
504
+ def multi_module_lookup=(multi_module_lookup)
505
+ if multi_module_lookup!=nil and !multi_module_lookup.is_a? Hash
506
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: Hash', nil, nil)
507
+ end
508
+ @multi_module_lookup = multi_module_lookup
509
+ @key_modified['multi_module_lookup'] = 1
510
+ end
511
+
512
+ # The method to get the currency
513
+ # @return An instance of Currency
514
+
515
+ def currency
516
+ @currency
517
+ end
518
+
519
+ # The method to set the value to currency
520
+ # @param currency [Currency] An instance of Currency
521
+
522
+ def currency=(currency)
523
+ if currency!=nil and !currency.is_a? Currency
524
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', nil, nil)
525
+ end
526
+ @currency = currency
527
+ @key_modified['currency'] = 1
528
+ end
529
+
530
+ # The method to get the id
531
+ # @return A Integer value
532
+
533
+ def id
534
+ @id
535
+ end
536
+
537
+ # The method to set the value to id
538
+ # @param id [Integer] A Integer
539
+
540
+ def id=(id)
541
+ if id!=nil and !id.is_a? Integer
542
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
543
+ end
544
+ @id = id
545
+ @key_modified['id'] = 1
546
+ end
547
+
548
+ # The method to get the custom_field
549
+ # @return A Boolean value
550
+
551
+ def custom_field
552
+ @custom_field
553
+ end
554
+
555
+ # The method to set the value to custom_field
556
+ # @param custom_field [Boolean] A Boolean
557
+
558
+ def custom_field=(custom_field)
559
+ if custom_field!=nil and ! [true, false].include?custom_field
560
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: Boolean', nil, nil)
561
+ end
562
+ @custom_field = custom_field
563
+ @key_modified['custom_field'] = 1
564
+ end
565
+
566
+ # The method to get the lookup
567
+ # @return An instance of Module
568
+
569
+ def lookup
570
+ @lookup
571
+ end
572
+
573
+ # The method to set the value to lookup
574
+ # @param lookup [Module] An instance of Module
575
+
576
+ def lookup=(lookup)
577
+ if lookup!=nil and !lookup.is_a? Module
578
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Module', nil, nil)
579
+ end
580
+ @lookup = lookup
581
+ @key_modified['lookup'] = 1
582
+ end
583
+
584
+ # The method to get the visible
585
+ # @return A Boolean value
586
+
587
+ def visible
588
+ @visible
589
+ end
590
+
591
+ # The method to set the value to visible
592
+ # @param visible [Boolean] A Boolean
593
+
594
+ def visible=(visible)
595
+ if visible!=nil and ! [true, false].include?visible
596
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: Boolean', nil, nil)
597
+ end
598
+ @visible = visible
599
+ @key_modified['visible'] = 1
600
+ end
601
+
602
+ # The method to get the length
603
+ # @return A Integer value
604
+
605
+ def length
606
+ @length
607
+ end
608
+
609
+ # The method to set the value to length
610
+ # @param length [Integer] A Integer
611
+
612
+ def length=(length)
613
+ if length!=nil and !length.is_a? Integer
614
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: Integer', nil, nil)
615
+ end
616
+ @length = length
617
+ @key_modified['length'] = 1
618
+ end
619
+
620
+ # The method to get the view_type
621
+ # @return An instance of ViewType
622
+
623
+ def view_type
624
+ @view_type
625
+ end
626
+
627
+ # The method to set the value to view_type
628
+ # @param view_type [ViewType] An instance of ViewType
629
+
630
+ def view_type=(view_type)
631
+ if view_type!=nil and !view_type.is_a? ViewType
632
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', nil, nil)
633
+ end
634
+ @view_type = view_type
635
+ @key_modified['view_type'] = 1
636
+ end
637
+
638
+ # The method to get the subform
639
+ # @return An instance of Module
640
+
641
+ def subform
642
+ @subform
643
+ end
644
+
645
+ # The method to set the value to subform
646
+ # @param subform [Module] An instance of Module
647
+
648
+ def subform=(subform)
649
+ if subform!=nil and !subform.is_a? Module
650
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Module', nil, nil)
651
+ end
652
+ @subform = subform
653
+ @key_modified['subform'] = 1
654
+ end
655
+
656
+ # The method to get the api_name
657
+ # @return A String value
658
+
659
+ def api_name
660
+ @api_name
661
+ end
662
+
663
+ # The method to set the value to api_name
664
+ # @param api_name [String] A String
665
+
666
+ def api_name=(api_name)
667
+ if api_name!=nil and !api_name.is_a? String
668
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
669
+ end
670
+ @api_name = api_name
671
+ @key_modified['api_name'] = 1
672
+ end
673
+
674
+ # The method to get the unique
675
+ # @return An instance of Unique
676
+
677
+ def unique
678
+ @unique
679
+ end
680
+
681
+ # The method to set the value to unique
682
+ # @param unique [Unique] An instance of Unique
683
+
684
+ def unique=(unique)
685
+ if unique!=nil and !unique.is_a? Unique
686
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', nil, nil)
687
+ end
688
+ @unique = unique
689
+ @key_modified['unique'] = 1
690
+ end
691
+
692
+ # The method to get the history_tracking
693
+ # @return A Boolean value
694
+
695
+ def history_tracking
696
+ @history_tracking
697
+ end
698
+
699
+ # The method to set the value to history_tracking
700
+ # @param history_tracking [Boolean] A Boolean
701
+
702
+ def history_tracking=(history_tracking)
703
+ if history_tracking!=nil and ! [true, false].include?history_tracking
704
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: Boolean', nil, nil)
705
+ end
706
+ @history_tracking = history_tracking
707
+ @key_modified['history_tracking'] = 1
708
+ end
709
+
710
+ # The method to get the data_type
711
+ # @return A String value
712
+
713
+ def data_type
714
+ @data_type
715
+ end
716
+
717
+ # The method to set the value to data_type
718
+ # @param data_type [String] A String
719
+
720
+ def data_type=(data_type)
721
+ if data_type!=nil and !data_type.is_a? String
722
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: String', nil, nil)
723
+ end
724
+ @data_type = data_type
725
+ @key_modified['data_type'] = 1
726
+ end
727
+
728
+ # The method to get the formula
729
+ # @return An instance of Formula
730
+
731
+ def formula
732
+ @formula
733
+ end
734
+
735
+ # The method to set the value to formula
736
+ # @param formula [Formula] An instance of Formula
737
+
738
+ def formula=(formula)
739
+ if formula!=nil and !formula.is_a? Formula
740
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', nil, nil)
741
+ end
742
+ @formula = formula
743
+ @key_modified['formula'] = 1
744
+ end
745
+
746
+ # The method to get the decimal_place
747
+ # @return A Integer value
748
+
749
+ def decimal_place
750
+ @decimal_place
751
+ end
752
+
753
+ # The method to set the value to decimal_place
754
+ # @param decimal_place [Integer] A Integer
755
+
756
+ def decimal_place=(decimal_place)
757
+ if decimal_place!=nil and !decimal_place.is_a? Integer
758
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: Integer', nil, nil)
759
+ end
760
+ @decimal_place = decimal_place
761
+ @key_modified['decimal_place'] = 1
762
+ end
763
+
764
+ # The method to get the mass_update
765
+ # @return A Boolean value
766
+
767
+ def mass_update
768
+ @mass_update
769
+ end
770
+
771
+ # The method to set the value to mass_update
772
+ # @param mass_update [Boolean] A Boolean
773
+
774
+ def mass_update=(mass_update)
775
+ if mass_update!=nil and ! [true, false].include?mass_update
776
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: Boolean', nil, nil)
777
+ end
778
+ @mass_update = mass_update
779
+ @key_modified['mass_update'] = 1
780
+ end
781
+
782
+ # The method to get the blueprint_supported
783
+ # @return A Boolean value
784
+
785
+ def blueprint_supported
786
+ @blueprint_supported
787
+ end
788
+
789
+ # The method to set the value to blueprint_supported
790
+ # @param blueprint_supported [Boolean] A Boolean
791
+
792
+ def blueprint_supported=(blueprint_supported)
793
+ if blueprint_supported!=nil and ! [true, false].include?blueprint_supported
794
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: Boolean', nil, nil)
795
+ end
796
+ @blueprint_supported = blueprint_supported
797
+ @key_modified['blueprint_supported'] = 1
798
+ end
799
+
800
+ # The method to get the multiselectlookup
801
+ # @return An instance of MultiSelectLookup
802
+
803
+ def multiselectlookup
804
+ @multiselectlookup
805
+ end
806
+
807
+ # The method to set the value to multiselectlookup
808
+ # @param multiselectlookup [MultiSelectLookup] An instance of MultiSelectLookup
809
+
810
+ def multiselectlookup=(multiselectlookup)
811
+ if multiselectlookup!=nil and !multiselectlookup.is_a? MultiSelectLookup
812
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: MultiSelectLookup', nil, nil)
813
+ end
814
+ @multiselectlookup = multiselectlookup
815
+ @key_modified['multiselectlookup'] = 1
816
+ end
817
+
818
+ # The method to get the pick_list_values
819
+ # @return An instance of Array
820
+
821
+ def pick_list_values
822
+ @pick_list_values
823
+ end
824
+
825
+ # The method to set the value to pick_list_values
826
+ # @param pick_list_values [Array] An instance of Array
827
+
828
+ def pick_list_values=(pick_list_values)
829
+ if pick_list_values!=nil and !pick_list_values.is_a? Array
830
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: Array', nil, nil)
831
+ end
832
+ @pick_list_values = pick_list_values
833
+ @key_modified['pick_list_values'] = 1
834
+ end
835
+
836
+ # The method to get the auto_number
837
+ # @return An instance of AutoNumber
838
+
839
+ def auto_number
840
+ @auto_number
841
+ end
842
+
843
+ # The method to set the value to auto_number
844
+ # @param auto_number [AutoNumber] An instance of AutoNumber
845
+
846
+ def auto_number=(auto_number)
847
+ if auto_number!=nil and !auto_number.is_a? AutoNumber
848
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: auto_number EXPECTED TYPE: AutoNumber', nil, nil)
849
+ end
850
+ @auto_number = auto_number
851
+ @key_modified['auto_number'] = 1
852
+ end
853
+
854
+ # The method to get the default_value
855
+ # @return A String value
856
+
857
+ def default_value
858
+ @default_value
859
+ end
860
+
861
+ # The method to set the value to default_value
862
+ # @param default_value [String] A String
863
+
864
+ def default_value=(default_value)
865
+ if default_value!=nil and !default_value.is_a? String
866
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: String', nil, nil)
867
+ end
868
+ @default_value = default_value
869
+ @key_modified['default_value'] = 1
870
+ end
871
+
872
+ # The method to get the section_id
873
+ # @return A Integer value
874
+
875
+ def section_id
876
+ @section_id
877
+ end
878
+
879
+ # The method to set the value to section_id
880
+ # @param section_id [Integer] A Integer
881
+
882
+ def section_id=(section_id)
883
+ if section_id!=nil and !section_id.is_a? Integer
884
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: section_id EXPECTED TYPE: Integer', nil, nil)
885
+ end
886
+ @section_id = section_id
887
+ @key_modified['section_id'] = 1
888
+ end
889
+
890
+ # The method to get the validation_rule
891
+ # @return An instance of Hash
892
+
893
+ def validation_rule
894
+ @validation_rule
895
+ end
896
+
897
+ # The method to set the value to validation_rule
898
+ # @param validation_rule [Hash] An instance of Hash
899
+
900
+ def validation_rule=(validation_rule)
901
+ if validation_rule!=nil and !validation_rule.is_a? Hash
902
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: validation_rule EXPECTED TYPE: Hash', nil, nil)
903
+ end
904
+ @validation_rule = validation_rule
905
+ @key_modified['validation_rule'] = 1
906
+ end
907
+
908
+ # The method to get the convert_mapping
909
+ # @return An instance of Hash
910
+
911
+ def convert_mapping
912
+ @convert_mapping
913
+ end
914
+
915
+ # The method to set the value to convert_mapping
916
+ # @param convert_mapping [Hash] An instance of Hash
917
+
918
+ def convert_mapping=(convert_mapping)
919
+ if convert_mapping!=nil and !convert_mapping.is_a? Hash
920
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: Hash', nil, nil)
921
+ end
922
+ @convert_mapping = convert_mapping
923
+ @key_modified['convert_mapping'] = 1
924
+ end
925
+
926
+ # The method to check if the user has modified the given key
927
+ # @param key [String] A String
928
+ # @return A Integer value
929
+
930
+ def is_key_modified(key)
931
+ if key!=nil and !key.is_a? String
932
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
933
+ end
934
+ if @key_modified.key?(key)
935
+ return @key_modified[key]
936
+ end
937
+
938
+ nil
939
+ end
940
+
941
+ # The method to mark the given key as modified
942
+ # @param key [String] A String
943
+ # @param modification [Integer] A Integer
944
+
945
+ def set_key_modified(key, modification)
946
+ if key!=nil and !key.is_a? String
947
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
948
+ end
949
+ if modification!=nil and !modification.is_a? Integer
950
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
951
+ end
952
+ @key_modified[key] = modification
953
+ end
954
+
955
+ end
956
+ end