ZOHOCRMSDK2_0 1.0.0

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