ZCRMSDK 1.0.4 → 3.0.0

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