ZCRMSDK 1.0.2 → 3.0.0.beta

Sign up to get free protection for your applications and to get access to all the features.
Files changed (462) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZCRMSDK.rb +445 -0
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +273 -0
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +169 -0
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +213 -0
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +33 -0
  7. data/src/com/zoho/api/authenticator/token.rb +10 -0
  8. data/src/com/zoho/api/logger/sdk_logger.rb +78 -0
  9. data/src/com/zoho/crm/api/assignment_rules/api_exception.rb +121 -0
  10. data/src/com/zoho/crm/api/assignment_rules/assignment_rule.rb +215 -0
  11. data/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.rb +61 -0
  12. data/src/com/zoho/crm/api/assignment_rules/default_user.rb +80 -0
  13. data/src/com/zoho/crm/api/assignment_rules/response_handler.rb +10 -0
  14. data/src/com/zoho/crm/api/assignment_rules/response_wrapper.rb +63 -0
  15. data/src/com/zoho/crm/api/attachments/action_handler.rb +10 -0
  16. data/src/com/zoho/crm/api/attachments/action_response.rb +10 -0
  17. data/src/com/zoho/crm/api/attachments/action_wrapper.rb +63 -0
  18. data/src/com/zoho/crm/api/attachments/api_exception.rb +125 -0
  19. data/src/com/zoho/crm/api/attachments/attachment.rb +367 -0
  20. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +196 -0
  21. data/src/com/zoho/crm/api/attachments/file_body_wrapper.rb +64 -0
  22. data/src/com/zoho/crm/api/attachments/response_handler.rb +10 -0
  23. data/src/com/zoho/crm/api/attachments/response_wrapper.rb +83 -0
  24. data/src/com/zoho/crm/api/attachments/success_response.rb +121 -0
  25. data/src/com/zoho/crm/api/blue_print/action_response.rb +10 -0
  26. data/src/com/zoho/crm/api/blue_print/api_exception.rb +123 -0
  27. data/src/com/zoho/crm/api/blue_print/blue_print.rb +119 -0
  28. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +67 -0
  29. data/src/com/zoho/crm/api/blue_print/body_wrapper.rb +61 -0
  30. data/src/com/zoho/crm/api/blue_print/escalation.rb +80 -0
  31. data/src/com/zoho/crm/api/blue_print/field.rb +1107 -0
  32. data/src/com/zoho/crm/api/blue_print/next_transition.rb +118 -0
  33. data/src/com/zoho/crm/api/blue_print/process_info.rb +251 -0
  34. data/src/com/zoho/crm/api/blue_print/response_handler.rb +10 -0
  35. data/src/com/zoho/crm/api/blue_print/response_wrapper.rb +63 -0
  36. data/src/com/zoho/crm/api/blue_print/success_response.rb +121 -0
  37. data/src/com/zoho/crm/api/blue_print/transition.rb +271 -0
  38. data/src/com/zoho/crm/api/blue_print/validation_error.rb +137 -0
  39. data/src/com/zoho/crm/api/bulk_read/action_handler.rb +10 -0
  40. data/src/com/zoho/crm/api/bulk_read/action_response.rb +10 -0
  41. data/src/com/zoho/crm/api/bulk_read/action_wrapper.rb +82 -0
  42. data/src/com/zoho/crm/api/bulk_read/api_exception.rb +125 -0
  43. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +74 -0
  44. data/src/com/zoho/crm/api/bulk_read/call_back.rb +81 -0
  45. data/src/com/zoho/crm/api/bulk_read/criteria.rb +155 -0
  46. data/src/com/zoho/crm/api/bulk_read/file_body_wrapper.rb +64 -0
  47. data/src/com/zoho/crm/api/bulk_read/job_detail.rb +196 -0
  48. data/src/com/zoho/crm/api/bulk_read/query.rb +138 -0
  49. data/src/com/zoho/crm/api/bulk_read/request_wrapper.rb +100 -0
  50. data/src/com/zoho/crm/api/bulk_read/response_handler.rb +10 -0
  51. data/src/com/zoho/crm/api/bulk_read/response_wrapper.rb +63 -0
  52. data/src/com/zoho/crm/api/bulk_read/result.rb +137 -0
  53. data/src/com/zoho/crm/api/bulk_read/success_response.rb +121 -0
  54. data/src/com/zoho/crm/api/bulk_write/action_response.rb +10 -0
  55. data/src/com/zoho/crm/api/bulk_write/api_exception.rb +239 -0
  56. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +112 -0
  57. data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb +216 -0
  58. data/src/com/zoho/crm/api/bulk_write/call_back.rb +81 -0
  59. data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +156 -0
  60. data/src/com/zoho/crm/api/bulk_write/file.rb +157 -0
  61. data/src/com/zoho/crm/api/bulk_write/file_body_wrapper.rb +64 -0
  62. data/src/com/zoho/crm/api/bulk_write/request_wrapper.rb +119 -0
  63. data/src/com/zoho/crm/api/bulk_write/resource.rb +215 -0
  64. data/src/com/zoho/crm/api/bulk_write/response_handler.rb +10 -0
  65. data/src/com/zoho/crm/api/bulk_write/response_wrapper.rb +10 -0
  66. data/src/com/zoho/crm/api/bulk_write/result.rb +61 -0
  67. data/src/com/zoho/crm/api/bulk_write/success_response.rb +121 -0
  68. data/src/com/zoho/crm/api/contact_roles/action_handler.rb +10 -0
  69. data/src/com/zoho/crm/api/contact_roles/action_response.rb +10 -0
  70. data/src/com/zoho/crm/api/contact_roles/action_wrapper.rb +63 -0
  71. data/src/com/zoho/crm/api/contact_roles/api_exception.rb +125 -0
  72. data/src/com/zoho/crm/api/contact_roles/body_wrapper.rb +61 -0
  73. data/src/com/zoho/crm/api/contact_roles/contact_role.rb +99 -0
  74. data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +161 -0
  75. data/src/com/zoho/crm/api/contact_roles/response_handler.rb +10 -0
  76. data/src/com/zoho/crm/api/contact_roles/response_wrapper.rb +63 -0
  77. data/src/com/zoho/crm/api/contact_roles/success_response.rb +121 -0
  78. data/src/com/zoho/crm/api/currencies/action_handler.rb +10 -0
  79. data/src/com/zoho/crm/api/currencies/action_response.rb +10 -0
  80. data/src/com/zoho/crm/api/currencies/action_wrapper.rb +63 -0
  81. data/src/com/zoho/crm/api/currencies/api_exception.rb +127 -0
  82. data/src/com/zoho/crm/api/currencies/base_currency_action_handler.rb +10 -0
  83. data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb +63 -0
  84. data/src/com/zoho/crm/api/currencies/base_currency_wrapper.rb +61 -0
  85. data/src/com/zoho/crm/api/currencies/body_wrapper.rb +61 -0
  86. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +156 -0
  87. data/src/com/zoho/crm/api/currencies/currency.rb +290 -0
  88. data/src/com/zoho/crm/api/currencies/format.rb +100 -0
  89. data/src/com/zoho/crm/api/currencies/response_handler.rb +10 -0
  90. data/src/com/zoho/crm/api/currencies/response_wrapper.rb +63 -0
  91. data/src/com/zoho/crm/api/currencies/success_response.rb +121 -0
  92. data/src/com/zoho/crm/api/custom_views/api_exception.rb +121 -0
  93. data/src/com/zoho/crm/api/custom_views/criteria.rb +136 -0
  94. data/src/com/zoho/crm/api/custom_views/custom_view.rb +386 -0
  95. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +75 -0
  96. data/src/com/zoho/crm/api/custom_views/info.rb +156 -0
  97. data/src/com/zoho/crm/api/custom_views/range.rb +80 -0
  98. data/src/com/zoho/crm/api/custom_views/response_handler.rb +10 -0
  99. data/src/com/zoho/crm/api/custom_views/response_wrapper.rb +82 -0
  100. data/src/com/zoho/crm/api/custom_views/shared_to.rb +118 -0
  101. data/src/com/zoho/crm/api/custom_views/translation.rb +118 -0
  102. data/src/com/zoho/crm/api/dc/au_datacenter.rb +18 -0
  103. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +18 -0
  104. data/src/com/zoho/crm/api/dc/datacenter.rb +21 -0
  105. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +18 -0
  106. data/src/com/zoho/crm/api/dc/in_datacenter.rb +18 -0
  107. data/src/com/zoho/crm/api/dc/us_datacenter.rb +18 -0
  108. data/src/com/zoho/crm/api/email_templates/api_exception.rb +121 -0
  109. data/src/com/zoho/crm/api/email_templates/attachment.rb +118 -0
  110. data/src/com/zoho/crm/api/email_templates/email_template.rb +390 -0
  111. data/src/com/zoho/crm/api/email_templates/email_templates_operations.rb +61 -0
  112. data/src/com/zoho/crm/api/email_templates/response_handler.rb +10 -0
  113. data/src/com/zoho/crm/api/email_templates/response_wrapper.rb +83 -0
  114. data/src/com/zoho/crm/api/exception/sdk_exception.rb +47 -0
  115. data/src/com/zoho/crm/api/field_attachments/api_exception.rb +121 -0
  116. data/src/com/zoho/crm/api/field_attachments/body_wrapper.rb +62 -0
  117. data/src/com/zoho/crm/api/field_attachments/field_attachments_operations.rb +52 -0
  118. data/src/com/zoho/crm/api/field_attachments/file_body_wrapper.rb +64 -0
  119. data/src/com/zoho/crm/api/field_attachments/response_handler.rb +10 -0
  120. data/src/com/zoho/crm/api/fields/api_exception.rb +121 -0
  121. data/src/com/zoho/crm/api/fields/association_details.rb +80 -0
  122. data/src/com/zoho/crm/api/fields/auto_number.rb +99 -0
  123. data/src/com/zoho/crm/api/fields/crypt.rb +156 -0
  124. data/src/com/zoho/crm/api/fields/currency.rb +80 -0
  125. data/src/com/zoho/crm/api/fields/external.rb +99 -0
  126. data/src/com/zoho/crm/api/fields/field.rb +1110 -0
  127. data/src/com/zoho/crm/api/fields/fields_operations.rb +71 -0
  128. data/src/com/zoho/crm/api/fields/formula.rb +80 -0
  129. data/src/com/zoho/crm/api/fields/history_tracking.rb +80 -0
  130. data/src/com/zoho/crm/api/fields/lookup_field.rb +80 -0
  131. data/src/com/zoho/crm/api/fields/maps.rb +80 -0
  132. data/src/com/zoho/crm/api/fields/module.rb +157 -0
  133. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +175 -0
  134. data/src/com/zoho/crm/api/fields/multi_user_lookup.rb +175 -0
  135. data/src/com/zoho/crm/api/fields/pick_list_value.rb +194 -0
  136. data/src/com/zoho/crm/api/fields/private.rb +99 -0
  137. data/src/com/zoho/crm/api/fields/related_details.rb +156 -0
  138. data/src/com/zoho/crm/api/fields/response_handler.rb +10 -0
  139. data/src/com/zoho/crm/api/fields/response_wrapper.rb +63 -0
  140. data/src/com/zoho/crm/api/fields/tool_tip.rb +80 -0
  141. data/src/com/zoho/crm/api/fields/unique.rb +61 -0
  142. data/src/com/zoho/crm/api/fields/view_type.rb +118 -0
  143. data/src/com/zoho/crm/api/files/action_handler.rb +10 -0
  144. data/src/com/zoho/crm/api/files/action_response.rb +10 -0
  145. data/src/com/zoho/crm/api/files/action_wrapper.rb +63 -0
  146. data/src/com/zoho/crm/api/files/api_exception.rb +125 -0
  147. data/src/com/zoho/crm/api/files/body_wrapper.rb +62 -0
  148. data/src/com/zoho/crm/api/files/file_body_wrapper.rb +64 -0
  149. data/src/com/zoho/crm/api/files/file_operations.rb +75 -0
  150. data/src/com/zoho/crm/api/files/response_handler.rb +10 -0
  151. data/src/com/zoho/crm/api/files/success_response.rb +121 -0
  152. data/src/com/zoho/crm/api/header.rb +10 -0
  153. data/src/com/zoho/crm/api/header_map.rb +55 -0
  154. data/src/com/zoho/crm/api/initializer.rb +217 -0
  155. data/src/com/zoho/crm/api/inventory_templates/api_exception.rb +121 -0
  156. data/src/com/zoho/crm/api/inventory_templates/inventory_template.rb +352 -0
  157. data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb +82 -0
  158. data/src/com/zoho/crm/api/inventory_templates/response_handler.rb +10 -0
  159. data/src/com/zoho/crm/api/inventory_templates/response_wrapper.rb +83 -0
  160. data/src/com/zoho/crm/api/layouts/api_exception.rb +121 -0
  161. data/src/com/zoho/crm/api/layouts/layout.rb +310 -0
  162. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +61 -0
  163. data/src/com/zoho/crm/api/layouts/properties.rb +100 -0
  164. data/src/com/zoho/crm/api/layouts/response_handler.rb +10 -0
  165. data/src/com/zoho/crm/api/layouts/response_wrapper.rb +63 -0
  166. data/src/com/zoho/crm/api/layouts/section.rb +252 -0
  167. data/src/com/zoho/crm/api/modules/action_handler.rb +10 -0
  168. data/src/com/zoho/crm/api/modules/action_response.rb +10 -0
  169. data/src/com/zoho/crm/api/modules/action_wrapper.rb +63 -0
  170. data/src/com/zoho/crm/api/modules/api_exception.rb +125 -0
  171. data/src/com/zoho/crm/api/modules/argument.rb +80 -0
  172. data/src/com/zoho/crm/api/modules/body_wrapper.rb +61 -0
  173. data/src/com/zoho/crm/api/modules/module.rb +939 -0
  174. data/src/com/zoho/crm/api/modules/modules_operations.rb +111 -0
  175. data/src/com/zoho/crm/api/modules/related_list_properties.rb +99 -0
  176. data/src/com/zoho/crm/api/modules/response_handler.rb +10 -0
  177. data/src/com/zoho/crm/api/modules/response_wrapper.rb +63 -0
  178. data/src/com/zoho/crm/api/modules/success_response.rb +121 -0
  179. data/src/com/zoho/crm/api/modules/territory.rb +99 -0
  180. data/src/com/zoho/crm/api/notes/action_handler.rb +10 -0
  181. data/src/com/zoho/crm/api/notes/action_response.rb +10 -0
  182. data/src/com/zoho/crm/api/notes/action_wrapper.rb +63 -0
  183. data/src/com/zoho/crm/api/notes/api_exception.rb +125 -0
  184. data/src/com/zoho/crm/api/notes/body_wrapper.rb +61 -0
  185. data/src/com/zoho/crm/api/notes/info.rb +118 -0
  186. data/src/com/zoho/crm/api/notes/note.rb +349 -0
  187. data/src/com/zoho/crm/api/notes/notes_operations.rb +219 -0
  188. data/src/com/zoho/crm/api/notes/response_handler.rb +10 -0
  189. data/src/com/zoho/crm/api/notes/response_wrapper.rb +82 -0
  190. data/src/com/zoho/crm/api/notes/success_response.rb +121 -0
  191. data/src/com/zoho/crm/api/notification/action_handler.rb +10 -0
  192. data/src/com/zoho/crm/api/notification/action_response.rb +10 -0
  193. data/src/com/zoho/crm/api/notification/action_wrapper.rb +63 -0
  194. data/src/com/zoho/crm/api/notification/api_exception.rb +125 -0
  195. data/src/com/zoho/crm/api/notification/body_wrapper.rb +61 -0
  196. data/src/com/zoho/crm/api/notification/info.rb +118 -0
  197. data/src/com/zoho/crm/api/notification/notification.rb +251 -0
  198. data/src/com/zoho/crm/api/notification/notification_operations.rb +164 -0
  199. data/src/com/zoho/crm/api/notification/response_handler.rb +10 -0
  200. data/src/com/zoho/crm/api/notification/response_wrapper.rb +82 -0
  201. data/src/com/zoho/crm/api/notification/success_response.rb +121 -0
  202. data/src/com/zoho/crm/api/org/action_response.rb +10 -0
  203. data/src/com/zoho/crm/api/org/api_exception.rb +123 -0
  204. data/src/com/zoho/crm/api/org/file_body_wrapper.rb +62 -0
  205. data/src/com/zoho/crm/api/org/license_details.rb +156 -0
  206. data/src/com/zoho/crm/api/org/org.rb +631 -0
  207. data/src/com/zoho/crm/api/org/org_operations.rb +49 -0
  208. data/src/com/zoho/crm/api/org/response_handler.rb +10 -0
  209. data/src/com/zoho/crm/api/org/response_wrapper.rb +63 -0
  210. data/src/com/zoho/crm/api/org/success_response.rb +121 -0
  211. data/src/com/zoho/crm/api/param.rb +10 -0
  212. data/src/com/zoho/crm/api/parameter_map.rb +54 -0
  213. data/src/com/zoho/crm/api/pipeline/action_handler.rb +10 -0
  214. data/src/com/zoho/crm/api/pipeline/action_response.rb +10 -0
  215. data/src/com/zoho/crm/api/pipeline/action_wrapper.rb +63 -0
  216. data/src/com/zoho/crm/api/pipeline/api_exception.rb +129 -0
  217. data/src/com/zoho/crm/api/pipeline/body_wrapper.rb +61 -0
  218. data/src/com/zoho/crm/api/pipeline/forecast_category.rb +80 -0
  219. data/src/com/zoho/crm/api/pipeline/pick_list_value.rb +175 -0
  220. data/src/com/zoho/crm/api/pipeline/pipeline.rb +213 -0
  221. data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb +165 -0
  222. data/src/com/zoho/crm/api/pipeline/response_handler.rb +10 -0
  223. data/src/com/zoho/crm/api/pipeline/response_wrapper.rb +63 -0
  224. data/src/com/zoho/crm/api/pipeline/stage.rb +80 -0
  225. data/src/com/zoho/crm/api/pipeline/success_response.rb +123 -0
  226. data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb +10 -0
  227. data/src/com/zoho/crm/api/pipeline/transfer_action_response.rb +10 -0
  228. data/src/com/zoho/crm/api/pipeline/transfer_action_wrapper.rb +63 -0
  229. data/src/com/zoho/crm/api/pipeline/transfer_and_delete_wrapper.rb +61 -0
  230. data/src/com/zoho/crm/api/pipeline/transfer_pipe_line.rb +80 -0
  231. data/src/com/zoho/crm/api/profiles/api_exception.rb +121 -0
  232. data/src/com/zoho/crm/api/profiles/category.rb +99 -0
  233. data/src/com/zoho/crm/api/profiles/default_view.rb +99 -0
  234. data/src/com/zoho/crm/api/profiles/permission_detail.rb +137 -0
  235. data/src/com/zoho/crm/api/profiles/profile.rb +347 -0
  236. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +61 -0
  237. data/src/com/zoho/crm/api/profiles/response_handler.rb +10 -0
  238. data/src/com/zoho/crm/api/profiles/response_wrapper.rb +63 -0
  239. data/src/com/zoho/crm/api/profiles/section.rb +80 -0
  240. data/src/com/zoho/crm/api/query/api_exception.rb +121 -0
  241. data/src/com/zoho/crm/api/query/body_wrapper.rb +61 -0
  242. data/src/com/zoho/crm/api/query/query_operations.rb +35 -0
  243. data/src/com/zoho/crm/api/query/response_handler.rb +10 -0
  244. data/src/com/zoho/crm/api/query/response_wrapper.rb +84 -0
  245. data/src/com/zoho/crm/api/record/action_handler.rb +10 -0
  246. data/src/com/zoho/crm/api/record/action_response.rb +10 -0
  247. data/src/com/zoho/crm/api/record/action_wrapper.rb +63 -0
  248. data/src/com/zoho/crm/api/record/api_exception.rb +145 -0
  249. data/src/com/zoho/crm/api/record/body_wrapper.rb +137 -0
  250. data/src/com/zoho/crm/api/record/carry_over_tags.rb +99 -0
  251. data/src/com/zoho/crm/api/record/comment.rb +118 -0
  252. data/src/com/zoho/crm/api/record/consent.rb +185 -0
  253. data/src/com/zoho/crm/api/record/convert_action_handler.rb +10 -0
  254. data/src/com/zoho/crm/api/record/convert_action_response.rb +10 -0
  255. data/src/com/zoho/crm/api/record/convert_action_wrapper.rb +63 -0
  256. data/src/com/zoho/crm/api/record/convert_body_wrapper.rb +61 -0
  257. data/src/com/zoho/crm/api/record/count_handler.rb +10 -0
  258. data/src/com/zoho/crm/api/record/count_wrapper.rb +63 -0
  259. data/src/com/zoho/crm/api/record/criteria.rb +135 -0
  260. data/src/com/zoho/crm/api/record/deleted_record.rb +157 -0
  261. data/src/com/zoho/crm/api/record/deleted_records_handler.rb +10 -0
  262. data/src/com/zoho/crm/api/record/deleted_records_wrapper.rb +82 -0
  263. data/src/com/zoho/crm/api/record/download_handler.rb +10 -0
  264. data/src/com/zoho/crm/api/record/field.rb +2110 -0
  265. data/src/com/zoho/crm/api/record/file_body_wrapper.rb +66 -0
  266. data/src/com/zoho/crm/api/record/file_details.rb +327 -0
  267. data/src/com/zoho/crm/api/record/file_handler.rb +10 -0
  268. data/src/com/zoho/crm/api/record/image_upload.rb +213 -0
  269. data/src/com/zoho/crm/api/record/info.rb +118 -0
  270. data/src/com/zoho/crm/api/record/inventory_line_items.rb +252 -0
  271. data/src/com/zoho/crm/api/record/lead_converter.rb +194 -0
  272. data/src/com/zoho/crm/api/record/line_item_product.rb +65 -0
  273. data/src/com/zoho/crm/api/record/line_tax.rb +118 -0
  274. data/src/com/zoho/crm/api/record/mass_update.rb +140 -0
  275. data/src/com/zoho/crm/api/record/mass_update_action_handler.rb +10 -0
  276. data/src/com/zoho/crm/api/record/mass_update_action_response.rb +10 -0
  277. data/src/com/zoho/crm/api/record/mass_update_action_wrapper.rb +63 -0
  278. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +156 -0
  279. data/src/com/zoho/crm/api/record/mass_update_response.rb +10 -0
  280. data/src/com/zoho/crm/api/record/mass_update_response_handler.rb +10 -0
  281. data/src/com/zoho/crm/api/record/mass_update_response_wrapper.rb +63 -0
  282. data/src/com/zoho/crm/api/record/mass_update_success_response.rb +121 -0
  283. data/src/com/zoho/crm/api/record/mass_update_territory.rb +80 -0
  284. data/src/com/zoho/crm/api/record/multi_select_lookup.rb +99 -0
  285. data/src/com/zoho/crm/api/record/multi_select_picklist.rb +80 -0
  286. data/src/com/zoho/crm/api/record/options.rb +10 -0
  287. data/src/com/zoho/crm/api/record/participants.rb +116 -0
  288. data/src/com/zoho/crm/api/record/price_book.rb +31 -0
  289. data/src/com/zoho/crm/api/record/pricing_details.rb +65 -0
  290. data/src/com/zoho/crm/api/record/record.rb +192 -0
  291. data/src/com/zoho/crm/api/record/record_operations.rb +847 -0
  292. data/src/com/zoho/crm/api/record/recurring_activity.rb +61 -0
  293. data/src/com/zoho/crm/api/record/remind_at.rb +61 -0
  294. data/src/com/zoho/crm/api/record/reminder.rb +80 -0
  295. data/src/com/zoho/crm/api/record/response_handler.rb +10 -0
  296. data/src/com/zoho/crm/api/record/response_wrapper.rb +82 -0
  297. data/src/com/zoho/crm/api/record/success_response.rb +161 -0
  298. data/src/com/zoho/crm/api/record/successful_convert.rb +101 -0
  299. data/src/com/zoho/crm/api/record/tax.rb +80 -0
  300. data/src/com/zoho/crm/api/record/territory.rb +138 -0
  301. data/src/com/zoho/crm/api/record/widget.rb +80 -0
  302. data/src/com/zoho/crm/api/record/wizard.rb +80 -0
  303. data/src/com/zoho/crm/api/related_lists/api_exception.rb +121 -0
  304. data/src/com/zoho/crm/api/related_lists/related_list.rb +251 -0
  305. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +61 -0
  306. data/src/com/zoho/crm/api/related_lists/response_handler.rb +10 -0
  307. data/src/com/zoho/crm/api/related_lists/response_wrapper.rb +63 -0
  308. data/src/com/zoho/crm/api/related_records/action_handler.rb +10 -0
  309. data/src/com/zoho/crm/api/related_records/action_response.rb +10 -0
  310. data/src/com/zoho/crm/api/related_records/action_wrapper.rb +63 -0
  311. data/src/com/zoho/crm/api/related_records/api_exception.rb +125 -0
  312. data/src/com/zoho/crm/api/related_records/body_wrapper.rb +62 -0
  313. data/src/com/zoho/crm/api/related_records/file_body_wrapper.rb +64 -0
  314. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +235 -0
  315. data/src/com/zoho/crm/api/related_records/response_handler.rb +10 -0
  316. data/src/com/zoho/crm/api/related_records/response_wrapper.rb +84 -0
  317. data/src/com/zoho/crm/api/related_records/success_response.rb +121 -0
  318. data/src/com/zoho/crm/api/request_proxy.rb +15 -0
  319. data/src/com/zoho/crm/api/roles/api_exception.rb +121 -0
  320. data/src/com/zoho/crm/api/roles/response_handler.rb +10 -0
  321. data/src/com/zoho/crm/api/roles/response_wrapper.rb +63 -0
  322. data/src/com/zoho/crm/api/roles/role.rb +195 -0
  323. data/src/com/zoho/crm/api/roles/roles_operations.rb +47 -0
  324. data/src/com/zoho/crm/api/sdk_config.rb +12 -0
  325. data/src/com/zoho/crm/api/send_mail/action_handler.rb +10 -0
  326. data/src/com/zoho/crm/api/send_mail/action_response.rb +10 -0
  327. data/src/com/zoho/crm/api/send_mail/action_wrapper.rb +63 -0
  328. data/src/com/zoho/crm/api/send_mail/api_exception.rb +125 -0
  329. data/src/com/zoho/crm/api/send_mail/body_wrapper.rb +61 -0
  330. data/src/com/zoho/crm/api/send_mail/data_subject_request.rb +80 -0
  331. data/src/com/zoho/crm/api/send_mail/inventory_details.rb +100 -0
  332. data/src/com/zoho/crm/api/send_mail/mail.rb +423 -0
  333. data/src/com/zoho/crm/api/send_mail/response_handler.rb +10 -0
  334. data/src/com/zoho/crm/api/send_mail/response_wrapper.rb +63 -0
  335. data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb +61 -0
  336. data/src/com/zoho/crm/api/send_mail/success_response.rb +121 -0
  337. data/src/com/zoho/crm/api/send_mail/template.rb +10 -0
  338. data/src/com/zoho/crm/api/send_mail/user_address.rb +137 -0
  339. data/src/com/zoho/crm/api/share_records/action_handler.rb +10 -0
  340. data/src/com/zoho/crm/api/share_records/action_response.rb +10 -0
  341. data/src/com/zoho/crm/api/share_records/action_wrapper.rb +63 -0
  342. data/src/com/zoho/crm/api/share_records/api_exception.rb +129 -0
  343. data/src/com/zoho/crm/api/share_records/body_wrapper.rb +61 -0
  344. data/src/com/zoho/crm/api/share_records/delete_action_handler.rb +10 -0
  345. data/src/com/zoho/crm/api/share_records/delete_action_response.rb +10 -0
  346. data/src/com/zoho/crm/api/share_records/delete_action_wrapper.rb +63 -0
  347. data/src/com/zoho/crm/api/share_records/response_handler.rb +10 -0
  348. data/src/com/zoho/crm/api/share_records/response_wrapper.rb +83 -0
  349. data/src/com/zoho/crm/api/share_records/share_record.rb +157 -0
  350. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +128 -0
  351. data/src/com/zoho/crm/api/share_records/shared_through.rb +100 -0
  352. data/src/com/zoho/crm/api/share_records/success_response.rb +123 -0
  353. data/src/com/zoho/crm/api/tags/action_handler.rb +10 -0
  354. data/src/com/zoho/crm/api/tags/action_response.rb +10 -0
  355. data/src/com/zoho/crm/api/tags/action_wrapper.rb +63 -0
  356. data/src/com/zoho/crm/api/tags/api_exception.rb +131 -0
  357. data/src/com/zoho/crm/api/tags/body_wrapper.rb +61 -0
  358. data/src/com/zoho/crm/api/tags/conflict_wrapper.rb +61 -0
  359. data/src/com/zoho/crm/api/tags/count_handler.rb +10 -0
  360. data/src/com/zoho/crm/api/tags/count_wrapper.rb +63 -0
  361. data/src/com/zoho/crm/api/tags/info.rb +80 -0
  362. data/src/com/zoho/crm/api/tags/merge_wrapper.rb +61 -0
  363. data/src/com/zoho/crm/api/tags/record_action_handler.rb +10 -0
  364. data/src/com/zoho/crm/api/tags/record_action_response.rb +10 -0
  365. data/src/com/zoho/crm/api/tags/record_action_wrapper.rb +120 -0
  366. data/src/com/zoho/crm/api/tags/response_handler.rb +10 -0
  367. data/src/com/zoho/crm/api/tags/response_wrapper.rb +82 -0
  368. data/src/com/zoho/crm/api/tags/success_response.rb +123 -0
  369. data/src/com/zoho/crm/api/tags/tag.rb +176 -0
  370. data/src/com/zoho/crm/api/tags/tags_operations.rb +387 -0
  371. data/src/com/zoho/crm/api/taxes/action_handler.rb +10 -0
  372. data/src/com/zoho/crm/api/taxes/action_response.rb +10 -0
  373. data/src/com/zoho/crm/api/taxes/action_wrapper.rb +63 -0
  374. data/src/com/zoho/crm/api/taxes/api_exception.rb +125 -0
  375. data/src/com/zoho/crm/api/taxes/body_wrapper.rb +61 -0
  376. data/src/com/zoho/crm/api/taxes/preference.rb +80 -0
  377. data/src/com/zoho/crm/api/taxes/response_handler.rb +10 -0
  378. data/src/com/zoho/crm/api/taxes/response_wrapper.rb +82 -0
  379. data/src/com/zoho/crm/api/taxes/success_response.rb +121 -0
  380. data/src/com/zoho/crm/api/taxes/tax.rb +137 -0
  381. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +136 -0
  382. data/src/com/zoho/crm/api/territories/api_exception.rb +121 -0
  383. data/src/com/zoho/crm/api/territories/response_handler.rb +10 -0
  384. data/src/com/zoho/crm/api/territories/response_wrapper.rb +83 -0
  385. data/src/com/zoho/crm/api/territories/territories_operations.rb +47 -0
  386. data/src/com/zoho/crm/api/territories/territory.rb +272 -0
  387. data/src/com/zoho/crm/api/user_signature.rb +27 -0
  388. data/src/com/zoho/crm/api/users/action_handler.rb +10 -0
  389. data/src/com/zoho/crm/api/users/action_response.rb +10 -0
  390. data/src/com/zoho/crm/api/users/action_wrapper.rb +63 -0
  391. data/src/com/zoho/crm/api/users/api_exception.rb +125 -0
  392. data/src/com/zoho/crm/api/users/body_wrapper.rb +61 -0
  393. data/src/com/zoho/crm/api/users/customize_info.rb +156 -0
  394. data/src/com/zoho/crm/api/users/info.rb +118 -0
  395. data/src/com/zoho/crm/api/users/request_wrapper.rb +61 -0
  396. data/src/com/zoho/crm/api/users/response_handler.rb +10 -0
  397. data/src/com/zoho/crm/api/users/response_wrapper.rb +82 -0
  398. data/src/com/zoho/crm/api/users/shift.rb +80 -0
  399. data/src/com/zoho/crm/api/users/success_response.rb +121 -0
  400. data/src/com/zoho/crm/api/users/tab_theme.rb +80 -0
  401. data/src/com/zoho/crm/api/users/territory.rb +99 -0
  402. data/src/com/zoho/crm/api/users/theme.rb +156 -0
  403. data/src/com/zoho/crm/api/users/user.rb +696 -0
  404. data/src/com/zoho/crm/api/users/users_operations.rb +181 -0
  405. data/src/com/zoho/crm/api/util/api_http_connector.rb +112 -0
  406. data/src/com/zoho/crm/api/util/api_response.rb +16 -0
  407. data/src/com/zoho/crm/api/util/choice.rb +9 -0
  408. data/src/com/zoho/crm/api/util/common_api_handler.rb +235 -0
  409. data/src/com/zoho/crm/api/util/constants.rb +663 -0
  410. data/src/com/zoho/crm/api/util/converter.rb +230 -0
  411. data/src/com/zoho/crm/api/util/data_type_converter.rb +162 -0
  412. data/src/com/zoho/crm/api/util/downloader.rb +83 -0
  413. data/src/com/zoho/crm/api/util/form_data_converter.rb +156 -0
  414. data/src/com/zoho/crm/api/util/header_param_validator.rb +55 -0
  415. data/src/com/zoho/crm/api/util/json_converter.rb +726 -0
  416. data/src/com/zoho/crm/api/util/model.rb +5 -0
  417. data/src/com/zoho/crm/api/util/module_fields_handler.rb +78 -0
  418. data/src/com/zoho/crm/api/util/stream_wrapper.rb +37 -0
  419. data/src/com/zoho/crm/api/util/utility.rb +883 -0
  420. data/src/com/zoho/crm/api/variable_groups/api_exception.rb +121 -0
  421. data/src/com/zoho/crm/api/variable_groups/response_handler.rb +10 -0
  422. data/src/com/zoho/crm/api/variable_groups/response_wrapper.rb +63 -0
  423. data/src/com/zoho/crm/api/variable_groups/variable_group.rb +137 -0
  424. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +66 -0
  425. data/src/com/zoho/crm/api/variables/action_handler.rb +10 -0
  426. data/src/com/zoho/crm/api/variables/action_response.rb +10 -0
  427. data/src/com/zoho/crm/api/variables/action_wrapper.rb +63 -0
  428. data/src/com/zoho/crm/api/variables/api_exception.rb +125 -0
  429. data/src/com/zoho/crm/api/variables/body_wrapper.rb +61 -0
  430. data/src/com/zoho/crm/api/variables/response_handler.rb +10 -0
  431. data/src/com/zoho/crm/api/variables/response_wrapper.rb +63 -0
  432. data/src/com/zoho/crm/api/variables/success_response.rb +121 -0
  433. data/src/com/zoho/crm/api/variables/variable.rb +173 -0
  434. data/src/com/zoho/crm/api/variables/variables_operations.rb +241 -0
  435. data/src/com/zoho/crm/api/wizards/api_exception.rb +121 -0
  436. data/src/com/zoho/crm/api/wizards/button.rb +214 -0
  437. data/src/com/zoho/crm/api/wizards/chart_data.rb +118 -0
  438. data/src/com/zoho/crm/api/wizards/connection.rb +80 -0
  439. data/src/com/zoho/crm/api/wizards/container.rb +119 -0
  440. data/src/com/zoho/crm/api/wizards/node.rb +118 -0
  441. data/src/com/zoho/crm/api/wizards/response_handler.rb +10 -0
  442. data/src/com/zoho/crm/api/wizards/response_wrapper.rb +63 -0
  443. data/src/com/zoho/crm/api/wizards/screen.rb +99 -0
  444. data/src/com/zoho/crm/api/wizards/segment.rb +176 -0
  445. data/src/com/zoho/crm/api/wizards/wizard.rb +273 -0
  446. data/src/com/zoho/crm/api/wizards/wizards_operations.rb +61 -0
  447. data/src/resources/JSONDetails.json +1 -0
  448. data/src/version.rb +3 -0
  449. metadata +480 -47
  450. data/lib/ZCRMSDK.rb +0 -14
  451. data/lib/ZCRMSDK/handler.rb +0 -3290
  452. data/lib/ZCRMSDK/oauth_client.rb +0 -253
  453. data/lib/ZCRMSDK/oauth_utility.rb +0 -161
  454. data/lib/ZCRMSDK/operations.rb +0 -1091
  455. data/lib/ZCRMSDK/org.rb +0 -174
  456. data/lib/ZCRMSDK/persistence.rb +0 -129
  457. data/lib/ZCRMSDK/request.rb +0 -83
  458. data/lib/ZCRMSDK/response.rb +0 -216
  459. data/lib/ZCRMSDK/restclient.rb +0 -65
  460. data/lib/ZCRMSDK/test.rb +0 -5746
  461. data/lib/ZCRMSDK/utility.rb +0 -309
  462. data/lib/ZCRMSDK/version.rb +0 -5
@@ -0,0 +1,137 @@
1
+ require_relative '../util/model'
2
+
3
+ module Profiles
4
+ class PermissionDetail
5
+ include Util::Model
6
+
7
+ # Creates an instance of PermissionDetail
8
+ def initialize
9
+ @display_label = nil
10
+ @module_1 = nil
11
+ @name = nil
12
+ @id = nil
13
+ @enabled = nil
14
+ @key_modified = Hash.new
15
+ end
16
+
17
+ # The method to get the display_label
18
+ # @return A String value
19
+
20
+ def display_label
21
+ @display_label
22
+ end
23
+
24
+ # The method to set the value to display_label
25
+ # @param display_label [String] A String
26
+
27
+ def display_label=(display_label)
28
+ if display_label!=nil and !display_label.is_a? String
29
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
30
+ end
31
+ @display_label = display_label
32
+ @key_modified['display_label'] = 1
33
+ end
34
+
35
+ # The method to get the module
36
+ # @return A String value
37
+
38
+ def module
39
+ @module_1
40
+ end
41
+
42
+ # The method to set the value to module
43
+ # @param module_1 [String] A String
44
+
45
+ def module=(module_1)
46
+ if module_1!=nil and !module_1.is_a? String
47
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
48
+ end
49
+ @module_1 = module_1
50
+ @key_modified['module'] = 1
51
+ end
52
+
53
+ # The method to get the name
54
+ # @return A String value
55
+
56
+ def name
57
+ @name
58
+ end
59
+
60
+ # The method to set the value to name
61
+ # @param name [String] A String
62
+
63
+ def name=(name)
64
+ if name!=nil and !name.is_a? String
65
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
66
+ end
67
+ @name = name
68
+ @key_modified['name'] = 1
69
+ end
70
+
71
+ # The method to get the id
72
+ # @return A Integer value
73
+
74
+ def id
75
+ @id
76
+ end
77
+
78
+ # The method to set the value to id
79
+ # @param id [Integer] A Integer
80
+
81
+ def id=(id)
82
+ if id!=nil and !id.is_a? Integer
83
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
84
+ end
85
+ @id = id
86
+ @key_modified['id'] = 1
87
+ end
88
+
89
+ # The method to get the enabled
90
+ # @return A Boolean value
91
+
92
+ def enabled
93
+ @enabled
94
+ end
95
+
96
+ # The method to set the value to enabled
97
+ # @param enabled [Boolean] A Boolean
98
+
99
+ def enabled=(enabled)
100
+ if enabled!=nil and ! [true, false].include?enabled
101
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: enabled EXPECTED TYPE: Boolean', nil, nil)
102
+ end
103
+ @enabled = enabled
104
+ @key_modified['enabled'] = 1
105
+ end
106
+
107
+ # The method to check if the user has modified the given key
108
+ # @param key [String] A String
109
+ # @return A Integer value
110
+
111
+ def is_key_modified(key)
112
+ if key!=nil and !key.is_a? String
113
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
114
+ end
115
+ if @key_modified.key?(key)
116
+ return @key_modified[key]
117
+ end
118
+
119
+ nil
120
+ end
121
+
122
+ # The method to mark the given key as modified
123
+ # @param key [String] A String
124
+ # @param modification [Integer] A Integer
125
+
126
+ def set_key_modified(key, modification)
127
+ if key!=nil and !key.is_a? String
128
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
129
+ end
130
+ if modification!=nil and !modification.is_a? Integer
131
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
132
+ end
133
+ @key_modified[key] = modification
134
+ end
135
+
136
+ end
137
+ end
@@ -0,0 +1,347 @@
1
+ require_relative '../users/user'
2
+ require_relative '../util/model'
3
+
4
+ module Profiles
5
+ class Profile
6
+ include Util::Model
7
+
8
+ # Creates an instance of Profile
9
+ def initialize
10
+ @display_label = nil
11
+ @created_time = nil
12
+ @modified_time = nil
13
+ @permissions_details = nil
14
+ @name = nil
15
+ @modified_by = nil
16
+ @defaultview = nil
17
+ @default = nil
18
+ @description = nil
19
+ @id = nil
20
+ @category = nil
21
+ @custom = nil
22
+ @created_by = nil
23
+ @sections = nil
24
+ @delete = nil
25
+ @permission_type = nil
26
+ @key_modified = Hash.new
27
+ end
28
+
29
+ # The method to get the display_label
30
+ # @return A String value
31
+
32
+ def display_label
33
+ @display_label
34
+ end
35
+
36
+ # The method to set the value to display_label
37
+ # @param display_label [String] A String
38
+
39
+ def display_label=(display_label)
40
+ if display_label!=nil and !display_label.is_a? String
41
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
42
+ end
43
+ @display_label = display_label
44
+ @key_modified['display_label'] = 1
45
+ end
46
+
47
+ # The method to get the created_time
48
+ # @return An instance of DateTime
49
+
50
+ def created_time
51
+ @created_time
52
+ end
53
+
54
+ # The method to set the value to created_time
55
+ # @param created_time [DateTime] An instance of DateTime
56
+
57
+ def created_time=(created_time)
58
+ if created_time!=nil and !created_time.is_a? DateTime
59
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
60
+ end
61
+ @created_time = created_time
62
+ @key_modified['created_time'] = 1
63
+ end
64
+
65
+ # The method to get the modified_time
66
+ # @return An instance of DateTime
67
+
68
+ def modified_time
69
+ @modified_time
70
+ end
71
+
72
+ # The method to set the value to modified_time
73
+ # @param modified_time [DateTime] An instance of DateTime
74
+
75
+ def modified_time=(modified_time)
76
+ if modified_time!=nil and !modified_time.is_a? DateTime
77
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
78
+ end
79
+ @modified_time = modified_time
80
+ @key_modified['modified_time'] = 1
81
+ end
82
+
83
+ # The method to get the permissions_details
84
+ # @return An instance of Array
85
+
86
+ def permissions_details
87
+ @permissions_details
88
+ end
89
+
90
+ # The method to set the value to permissions_details
91
+ # @param permissions_details [Array] An instance of Array
92
+
93
+ def permissions_details=(permissions_details)
94
+ if permissions_details!=nil and !permissions_details.is_a? Array
95
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: permissions_details EXPECTED TYPE: Array', nil, nil)
96
+ end
97
+ @permissions_details = permissions_details
98
+ @key_modified['permissions_details'] = 1
99
+ end
100
+
101
+ # The method to get the name
102
+ # @return A String value
103
+
104
+ def name
105
+ @name
106
+ end
107
+
108
+ # The method to set the value to name
109
+ # @param name [String] A String
110
+
111
+ def name=(name)
112
+ if name!=nil and !name.is_a? String
113
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
114
+ end
115
+ @name = name
116
+ @key_modified['name'] = 1
117
+ end
118
+
119
+ # The method to get the modified_by
120
+ # @return An instance of Users::User
121
+
122
+ def modified_by
123
+ @modified_by
124
+ end
125
+
126
+ # The method to set the value to modified_by
127
+ # @param modified_by [Users::User] An instance of Users::User
128
+
129
+ def modified_by=(modified_by)
130
+ if modified_by!=nil and !modified_by.is_a? Users::User
131
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
132
+ end
133
+ @modified_by = modified_by
134
+ @key_modified['modified_by'] = 1
135
+ end
136
+
137
+ # The method to get the defaultview
138
+ # @return An instance of DefaultView
139
+
140
+ def defaultview
141
+ @defaultview
142
+ end
143
+
144
+ # The method to set the value to defaultview
145
+ # @param defaultview [DefaultView] An instance of DefaultView
146
+
147
+ def defaultview=(defaultview)
148
+ if defaultview!=nil and !defaultview.is_a? DefaultView
149
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: DefaultView', nil, nil)
150
+ end
151
+ @defaultview = defaultview
152
+ @key_modified['_default_view'] = 1
153
+ end
154
+
155
+ # The method to get the default
156
+ # @return A Boolean value
157
+
158
+ def default
159
+ @default
160
+ end
161
+
162
+ # The method to set the value to default
163
+ # @param default [Boolean] A Boolean
164
+
165
+ def default=(default)
166
+ if default!=nil and ! [true, false].include?default
167
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Boolean', nil, nil)
168
+ end
169
+ @default = default
170
+ @key_modified['default'] = 1
171
+ end
172
+
173
+ # The method to get the description
174
+ # @return A String value
175
+
176
+ def description
177
+ @description
178
+ end
179
+
180
+ # The method to set the value to description
181
+ # @param description [String] A String
182
+
183
+ def description=(description)
184
+ if description!=nil and !description.is_a? String
185
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: description EXPECTED TYPE: String', nil, nil)
186
+ end
187
+ @description = description
188
+ @key_modified['description'] = 1
189
+ end
190
+
191
+ # The method to get the id
192
+ # @return A Integer value
193
+
194
+ def id
195
+ @id
196
+ end
197
+
198
+ # The method to set the value to id
199
+ # @param id [Integer] A Integer
200
+
201
+ def id=(id)
202
+ if id!=nil and !id.is_a? Integer
203
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
204
+ end
205
+ @id = id
206
+ @key_modified['id'] = 1
207
+ end
208
+
209
+ # The method to get the category
210
+ # @return A Boolean value
211
+
212
+ def category
213
+ @category
214
+ end
215
+
216
+ # The method to set the value to category
217
+ # @param category [Boolean] A Boolean
218
+
219
+ def category=(category)
220
+ if category!=nil and ! [true, false].include?category
221
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: Boolean', nil, nil)
222
+ end
223
+ @category = category
224
+ @key_modified['category'] = 1
225
+ end
226
+
227
+ # The method to get the custom
228
+ # @return A Boolean value
229
+
230
+ def custom
231
+ @custom
232
+ end
233
+
234
+ # The method to set the value to custom
235
+ # @param custom [Boolean] A Boolean
236
+
237
+ def custom=(custom)
238
+ if custom!=nil and ! [true, false].include?custom
239
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: custom EXPECTED TYPE: Boolean', nil, nil)
240
+ end
241
+ @custom = custom
242
+ @key_modified['custom'] = 1
243
+ end
244
+
245
+ # The method to get the created_by
246
+ # @return An instance of Users::User
247
+
248
+ def created_by
249
+ @created_by
250
+ end
251
+
252
+ # The method to set the value to created_by
253
+ # @param created_by [Users::User] An instance of Users::User
254
+
255
+ def created_by=(created_by)
256
+ if created_by!=nil and !created_by.is_a? Users::User
257
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
258
+ end
259
+ @created_by = created_by
260
+ @key_modified['created_by'] = 1
261
+ end
262
+
263
+ # The method to get the sections
264
+ # @return An instance of Array
265
+
266
+ def sections
267
+ @sections
268
+ end
269
+
270
+ # The method to set the value to sections
271
+ # @param sections [Array] An instance of Array
272
+
273
+ def sections=(sections)
274
+ if sections!=nil and !sections.is_a? Array
275
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sections EXPECTED TYPE: Array', nil, nil)
276
+ end
277
+ @sections = sections
278
+ @key_modified['sections'] = 1
279
+ end
280
+
281
+ # The method to get the delete
282
+ # @return A Boolean value
283
+
284
+ def delete
285
+ @delete
286
+ end
287
+
288
+ # The method to set the value to delete
289
+ # @param delete [Boolean] A Boolean
290
+
291
+ def delete=(delete)
292
+ if delete!=nil and ! [true, false].include?delete
293
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: Boolean', nil, nil)
294
+ end
295
+ @delete = delete
296
+ @key_modified['_delete'] = 1
297
+ end
298
+
299
+ # The method to get the permission_type
300
+ # @return A String value
301
+
302
+ def permission_type
303
+ @permission_type
304
+ end
305
+
306
+ # The method to set the value to permission_type
307
+ # @param permission_type [String] A String
308
+
309
+ def permission_type=(permission_type)
310
+ if permission_type!=nil and !permission_type.is_a? String
311
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: String', nil, nil)
312
+ end
313
+ @permission_type = permission_type
314
+ @key_modified['permission_type'] = 1
315
+ end
316
+
317
+ # The method to check if the user has modified the given key
318
+ # @param key [String] A String
319
+ # @return A Integer value
320
+
321
+ def is_key_modified(key)
322
+ if key!=nil and !key.is_a? String
323
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
324
+ end
325
+ if @key_modified.key?(key)
326
+ return @key_modified[key]
327
+ end
328
+
329
+ nil
330
+ end
331
+
332
+ # The method to mark the given key as modified
333
+ # @param key [String] A String
334
+ # @param modification [Integer] A Integer
335
+
336
+ def set_key_modified(key, modification)
337
+ if key!=nil and !key.is_a? String
338
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
339
+ end
340
+ if modification!=nil and !modification.is_a? Integer
341
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
342
+ end
343
+ @key_modified[key] = modification
344
+ end
345
+
346
+ end
347
+ end