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,123 @@
1
+ require_relative '../util/choice'
2
+ require_relative '../util/model'
3
+
4
+ module ZOHOCRMSDK
5
+ module Currencies
6
+ require_relative 'action_response'
7
+ class SuccessResponse
8
+ include Util::Model
9
+ include ActionResponse
10
+
11
+ # Creates an instance of SuccessResponse
12
+ def initialize
13
+ @status = nil
14
+ @code = nil
15
+ @message = nil
16
+ @details = nil
17
+ @key_modified = Hash.new
18
+ end
19
+
20
+ # The method to get the status
21
+ # @return An instance of Util::Choice
22
+
23
+ def status
24
+ @status
25
+ end
26
+
27
+ # The method to set the value to status
28
+ # @param status [Util::Choice] An instance of Util::Choice
29
+
30
+ def status=(status)
31
+ if status!=nil and !status.is_a? Util::Choice
32
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
33
+ end
34
+ @status = status
35
+ @key_modified['status'] = 1
36
+ end
37
+
38
+ # The method to get the code
39
+ # @return An instance of Util::Choice
40
+
41
+ def code
42
+ @code
43
+ end
44
+
45
+ # The method to set the value to code
46
+ # @param code [Util::Choice] An instance of Util::Choice
47
+
48
+ def code=(code)
49
+ if code!=nil and !code.is_a? Util::Choice
50
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
51
+ end
52
+ @code = code
53
+ @key_modified['code'] = 1
54
+ end
55
+
56
+ # The method to get the message
57
+ # @return An instance of Util::Choice
58
+
59
+ def message
60
+ @message
61
+ end
62
+
63
+ # The method to set the value to message
64
+ # @param message [Util::Choice] An instance of Util::Choice
65
+
66
+ def message=(message)
67
+ if message!=nil and !message.is_a? Util::Choice
68
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
69
+ end
70
+ @message = message
71
+ @key_modified['message'] = 1
72
+ end
73
+
74
+ # The method to get the details
75
+ # @return An instance of Hash
76
+
77
+ def details
78
+ @details
79
+ end
80
+
81
+ # The method to set the value to details
82
+ # @param details [Hash] An instance of Hash
83
+
84
+ def details=(details)
85
+ if details!=nil and !details.is_a? Hash
86
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
87
+ end
88
+ @details = details
89
+ @key_modified['details'] = 1
90
+ end
91
+
92
+ # The method to check if the user has modified the given key
93
+ # @param key [String] A String
94
+ # @return A Integer value
95
+
96
+ def is_key_modified(key)
97
+ if key!=nil and !key.is_a? String
98
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
99
+ end
100
+ if @key_modified.key?(key)
101
+ return @key_modified[key]
102
+ end
103
+
104
+ nil
105
+ end
106
+
107
+ # The method to mark the given key as modified
108
+ # @param key [String] A String
109
+ # @param modification [Integer] A Integer
110
+
111
+ def set_key_modified(key, modification)
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 modification!=nil and !modification.is_a? Integer
116
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
117
+ end
118
+ @key_modified[key] = modification
119
+ end
120
+
121
+ end
122
+ end
123
+ end
@@ -0,0 +1,123 @@
1
+ require_relative '../util/choice'
2
+ require_relative '../util/model'
3
+
4
+ module ZOHOCRMSDK
5
+ module CustomViews
6
+ require_relative 'response_handler'
7
+ class APIException
8
+ include Util::Model
9
+ include ResponseHandler
10
+
11
+ # Creates an instance of APIException
12
+ def initialize
13
+ @status = nil
14
+ @code = nil
15
+ @message = nil
16
+ @details = nil
17
+ @key_modified = Hash.new
18
+ end
19
+
20
+ # The method to get the status
21
+ # @return An instance of Util::Choice
22
+
23
+ def status
24
+ @status
25
+ end
26
+
27
+ # The method to set the value to status
28
+ # @param status [Util::Choice] An instance of Util::Choice
29
+
30
+ def status=(status)
31
+ if status!=nil and !status.is_a? Util::Choice
32
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
33
+ end
34
+ @status = status
35
+ @key_modified['status'] = 1
36
+ end
37
+
38
+ # The method to get the code
39
+ # @return An instance of Util::Choice
40
+
41
+ def code
42
+ @code
43
+ end
44
+
45
+ # The method to set the value to code
46
+ # @param code [Util::Choice] An instance of Util::Choice
47
+
48
+ def code=(code)
49
+ if code!=nil and !code.is_a? Util::Choice
50
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
51
+ end
52
+ @code = code
53
+ @key_modified['code'] = 1
54
+ end
55
+
56
+ # The method to get the message
57
+ # @return An instance of Util::Choice
58
+
59
+ def message
60
+ @message
61
+ end
62
+
63
+ # The method to set the value to message
64
+ # @param message [Util::Choice] An instance of Util::Choice
65
+
66
+ def message=(message)
67
+ if message!=nil and !message.is_a? Util::Choice
68
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
69
+ end
70
+ @message = message
71
+ @key_modified['message'] = 1
72
+ end
73
+
74
+ # The method to get the details
75
+ # @return An instance of Hash
76
+
77
+ def details
78
+ @details
79
+ end
80
+
81
+ # The method to set the value to details
82
+ # @param details [Hash] An instance of Hash
83
+
84
+ def details=(details)
85
+ if details!=nil and !details.is_a? Hash
86
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
87
+ end
88
+ @details = details
89
+ @key_modified['details'] = 1
90
+ end
91
+
92
+ # The method to check if the user has modified the given key
93
+ # @param key [String] A String
94
+ # @return A Integer value
95
+
96
+ def is_key_modified(key)
97
+ if key!=nil and !key.is_a? String
98
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
99
+ end
100
+ if @key_modified.key?(key)
101
+ return @key_modified[key]
102
+ end
103
+
104
+ nil
105
+ end
106
+
107
+ # The method to mark the given key as modified
108
+ # @param key [String] A String
109
+ # @param modification [Integer] A Integer
110
+
111
+ def set_key_modified(key, modification)
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 modification!=nil and !modification.is_a? Integer
116
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
117
+ end
118
+ @key_modified[key] = modification
119
+ end
120
+
121
+ end
122
+ end
123
+ end
@@ -0,0 +1,137 @@
1
+ require_relative '../util/choice'
2
+ require_relative '../util/model'
3
+
4
+ module ZOHOCRMSDK
5
+ module CustomViews
6
+ class Criteria
7
+ include Util::Model
8
+
9
+ # Creates an instance of Criteria
10
+ def initialize
11
+ @comparator = nil
12
+ @field = nil
13
+ @value = nil
14
+ @group_operator = nil
15
+ @group = nil
16
+ @key_modified = Hash.new
17
+ end
18
+
19
+ # The method to get the comparator
20
+ # @return An instance of Util::Choice
21
+
22
+ def comparator
23
+ @comparator
24
+ end
25
+
26
+ # The method to set the value to comparator
27
+ # @param comparator [Util::Choice] An instance of Util::Choice
28
+
29
+ def comparator=(comparator)
30
+ if comparator!=nil and !comparator.is_a? Util::Choice
31
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Util::Choice', nil, nil)
32
+ end
33
+ @comparator = comparator
34
+ @key_modified['comparator'] = 1
35
+ end
36
+
37
+ # The method to get the field
38
+ # @return A String value
39
+
40
+ def field
41
+ @field
42
+ end
43
+
44
+ # The method to set the value to field
45
+ # @param field [String] A String
46
+
47
+ def field=(field)
48
+ if field!=nil and !field.is_a? String
49
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: String', nil, nil)
50
+ end
51
+ @field = field
52
+ @key_modified['field'] = 1
53
+ end
54
+
55
+ # The method to get the value
56
+ # @return A lang::Object value
57
+
58
+ def value
59
+ @value
60
+ end
61
+
62
+ # The method to set the value to value
63
+ # @param value [lang::Object] A lang::Object
64
+
65
+ def value=(value)
66
+ @value = value
67
+ @key_modified['value'] = 1
68
+ end
69
+
70
+ # The method to get the group_operator
71
+ # @return An instance of Util::Choice
72
+
73
+ def group_operator
74
+ @group_operator
75
+ end
76
+
77
+ # The method to set the value to group_operator
78
+ # @param group_operator [Util::Choice] An instance of Util::Choice
79
+
80
+ def group_operator=(group_operator)
81
+ if group_operator!=nil and !group_operator.is_a? Util::Choice
82
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: Util::Choice', nil, nil)
83
+ end
84
+ @group_operator = group_operator
85
+ @key_modified['group_operator'] = 1
86
+ end
87
+
88
+ # The method to get the group
89
+ # @return An instance of Array
90
+
91
+ def group
92
+ @group
93
+ end
94
+
95
+ # The method to set the value to group
96
+ # @param group [Array] An instance of Array
97
+
98
+ def group=(group)
99
+ if group!=nil and !group.is_a? Array
100
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: Array', nil, nil)
101
+ end
102
+ @group = group
103
+ @key_modified['group'] = 1
104
+ end
105
+
106
+ # The method to check if the user has modified the given key
107
+ # @param key [String] A String
108
+ # @return A Integer value
109
+
110
+ def is_key_modified(key)
111
+ if key!=nil and !key.is_a? String
112
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
113
+ end
114
+ if @key_modified.key?(key)
115
+ return @key_modified[key]
116
+ end
117
+
118
+ nil
119
+ end
120
+
121
+ # The method to mark the given key as modified
122
+ # @param key [String] A String
123
+ # @param modification [Integer] A Integer
124
+
125
+ def set_key_modified(key, modification)
126
+ if key!=nil and !key.is_a? String
127
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
128
+ end
129
+ if modification!=nil and !modification.is_a? Integer
130
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
131
+ end
132
+ @key_modified[key] = modification
133
+ end
134
+
135
+ end
136
+ end
137
+ end
@@ -0,0 +1,329 @@
1
+ require_relative '../util/model'
2
+
3
+ module ZOHOCRMSDK
4
+ module CustomViews
5
+ class CustomView
6
+ include Util::Model
7
+
8
+ # Creates an instance of CustomView
9
+ def initialize
10
+ @id = nil
11
+ @name = nil
12
+ @system_name = nil
13
+ @display_value = nil
14
+ @shared_type = nil
15
+ @category = nil
16
+ @sort_by = nil
17
+ @sort_order = nil
18
+ @favorite = nil
19
+ @offline = nil
20
+ @default = nil
21
+ @system_defined = nil
22
+ @criteria = nil
23
+ @shared_details = nil
24
+ @fields = nil
25
+ @key_modified = Hash.new
26
+ end
27
+
28
+ # The method to get the id
29
+ # @return A Integer value
30
+
31
+ def id
32
+ @id
33
+ end
34
+
35
+ # The method to set the value to id
36
+ # @param id [Integer] A Integer
37
+
38
+ def id=(id)
39
+ if id!=nil and !id.is_a? Integer
40
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
41
+ end
42
+ @id = id
43
+ @key_modified['id'] = 1
44
+ end
45
+
46
+ # The method to get the name
47
+ # @return A String value
48
+
49
+ def name
50
+ @name
51
+ end
52
+
53
+ # The method to set the value to name
54
+ # @param name [String] A String
55
+
56
+ def name=(name)
57
+ if name!=nil and !name.is_a? String
58
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
59
+ end
60
+ @name = name
61
+ @key_modified['name'] = 1
62
+ end
63
+
64
+ # The method to get the system_name
65
+ # @return A String value
66
+
67
+ def system_name
68
+ @system_name
69
+ end
70
+
71
+ # The method to set the value to system_name
72
+ # @param system_name [String] A String
73
+
74
+ def system_name=(system_name)
75
+ if system_name!=nil and !system_name.is_a? String
76
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_name EXPECTED TYPE: String', nil, nil)
77
+ end
78
+ @system_name = system_name
79
+ @key_modified['system_name'] = 1
80
+ end
81
+
82
+ # The method to get the display_value
83
+ # @return A String value
84
+
85
+ def display_value
86
+ @display_value
87
+ end
88
+
89
+ # The method to set the value to display_value
90
+ # @param display_value [String] A String
91
+
92
+ def display_value=(display_value)
93
+ if display_value!=nil and !display_value.is_a? String
94
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: String', nil, nil)
95
+ end
96
+ @display_value = display_value
97
+ @key_modified['display_value'] = 1
98
+ end
99
+
100
+ # The method to get the shared_type
101
+ # @return A String value
102
+
103
+ def shared_type
104
+ @shared_type
105
+ end
106
+
107
+ # The method to set the value to shared_type
108
+ # @param shared_type [String] A String
109
+
110
+ def shared_type=(shared_type)
111
+ if shared_type!=nil and !shared_type.is_a? String
112
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_type EXPECTED TYPE: String', nil, nil)
113
+ end
114
+ @shared_type = shared_type
115
+ @key_modified['shared_type'] = 1
116
+ end
117
+
118
+ # The method to get the category
119
+ # @return A String value
120
+
121
+ def category
122
+ @category
123
+ end
124
+
125
+ # The method to set the value to category
126
+ # @param category [String] A String
127
+
128
+ def category=(category)
129
+ if category!=nil and !category.is_a? String
130
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: String', nil, nil)
131
+ end
132
+ @category = category
133
+ @key_modified['category'] = 1
134
+ end
135
+
136
+ # The method to get the sort_by
137
+ # @return A String value
138
+
139
+ def sort_by
140
+ @sort_by
141
+ end
142
+
143
+ # The method to set the value to sort_by
144
+ # @param sort_by [String] A String
145
+
146
+ def sort_by=(sort_by)
147
+ if sort_by!=nil and !sort_by.is_a? String
148
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: String', nil, nil)
149
+ end
150
+ @sort_by = sort_by
151
+ @key_modified['sort_by'] = 1
152
+ end
153
+
154
+ # The method to get the sort_order
155
+ # @return A String value
156
+
157
+ def sort_order
158
+ @sort_order
159
+ end
160
+
161
+ # The method to set the value to sort_order
162
+ # @param sort_order [String] A String
163
+
164
+ def sort_order=(sort_order)
165
+ if sort_order!=nil and !sort_order.is_a? String
166
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: String', nil, nil)
167
+ end
168
+ @sort_order = sort_order
169
+ @key_modified['sort_order'] = 1
170
+ end
171
+
172
+ # The method to get the favorite
173
+ # @return A Integer value
174
+
175
+ def favorite
176
+ @favorite
177
+ end
178
+
179
+ # The method to set the value to favorite
180
+ # @param favorite [Integer] A Integer
181
+
182
+ def favorite=(favorite)
183
+ if favorite!=nil and !favorite.is_a? Integer
184
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: Integer', nil, nil)
185
+ end
186
+ @favorite = favorite
187
+ @key_modified['favorite'] = 1
188
+ end
189
+
190
+ # The method to get the offline
191
+ # @return A Boolean value
192
+
193
+ def offline
194
+ @offline
195
+ end
196
+
197
+ # The method to set the value to offline
198
+ # @param offline [Boolean] A Boolean
199
+
200
+ def offline=(offline)
201
+ if offline!=nil and ! [true, false].include?offline
202
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: offline EXPECTED TYPE: Boolean', nil, nil)
203
+ end
204
+ @offline = offline
205
+ @key_modified['offline'] = 1
206
+ end
207
+
208
+ # The method to get the default
209
+ # @return A Boolean value
210
+
211
+ def default
212
+ @default
213
+ end
214
+
215
+ # The method to set the value to default
216
+ # @param default [Boolean] A Boolean
217
+
218
+ def default=(default)
219
+ if default!=nil and ! [true, false].include?default
220
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Boolean', nil, nil)
221
+ end
222
+ @default = default
223
+ @key_modified['default'] = 1
224
+ end
225
+
226
+ # The method to get the system_defined
227
+ # @return A Boolean value
228
+
229
+ def system_defined
230
+ @system_defined
231
+ end
232
+
233
+ # The method to set the value to system_defined
234
+ # @param system_defined [Boolean] A Boolean
235
+
236
+ def system_defined=(system_defined)
237
+ if system_defined!=nil and ! [true, false].include?system_defined
238
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_defined EXPECTED TYPE: Boolean', nil, nil)
239
+ end
240
+ @system_defined = system_defined
241
+ @key_modified['system_defined'] = 1
242
+ end
243
+
244
+ # The method to get the criteria
245
+ # @return An instance of Criteria
246
+
247
+ def criteria
248
+ @criteria
249
+ end
250
+
251
+ # The method to set the value to criteria
252
+ # @param criteria [Criteria] An instance of Criteria
253
+
254
+ def criteria=(criteria)
255
+ if criteria!=nil and !criteria.is_a? Criteria
256
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
257
+ end
258
+ @criteria = criteria
259
+ @key_modified['criteria'] = 1
260
+ end
261
+
262
+ # The method to get the shared_details
263
+ # @return An instance of Array
264
+
265
+ def shared_details
266
+ @shared_details
267
+ end
268
+
269
+ # The method to set the value to shared_details
270
+ # @param shared_details [Array] An instance of Array
271
+
272
+ def shared_details=(shared_details)
273
+ if shared_details!=nil and !shared_details.is_a? Array
274
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_details EXPECTED TYPE: Array', nil, nil)
275
+ end
276
+ @shared_details = shared_details
277
+ @key_modified['shared_details'] = 1
278
+ end
279
+
280
+ # The method to get the fields
281
+ # @return An instance of Array
282
+
283
+ def fields
284
+ @fields
285
+ end
286
+
287
+ # The method to set the value to fields
288
+ # @param fields [Array] An instance of Array
289
+
290
+ def fields=(fields)
291
+ if fields!=nil and !fields.is_a? Array
292
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: Array', nil, nil)
293
+ end
294
+ @fields = fields
295
+ @key_modified['fields'] = 1
296
+ end
297
+
298
+ # The method to check if the user has modified the given key
299
+ # @param key [String] A String
300
+ # @return A Integer value
301
+
302
+ def is_key_modified(key)
303
+ if key!=nil and !key.is_a? String
304
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
305
+ end
306
+ if @key_modified.key?(key)
307
+ return @key_modified[key]
308
+ end
309
+
310
+ nil
311
+ end
312
+
313
+ # The method to mark the given key as modified
314
+ # @param key [String] A String
315
+ # @param modification [Integer] A Integer
316
+
317
+ def set_key_modified(key, modification)
318
+ if key!=nil and !key.is_a? String
319
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
320
+ end
321
+ if modification!=nil and !modification.is_a? Integer
322
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
323
+ end
324
+ @key_modified[key] = modification
325
+ end
326
+
327
+ end
328
+ end
329
+ end