ZOHOCRMSDK2_0_docgo 6.2.0

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