ZCRMSDK 2.0.0 → 3.0.1

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 (174) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZCRMSDK.rb +87 -2
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +86 -31
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +71 -29
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +91 -21
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +7 -0
  7. data/src/com/zoho/api/logger/sdk_logger.rb +18 -9
  8. data/src/com/zoho/crm/api/assignment_rules/api_exception.rb +121 -0
  9. data/src/com/zoho/crm/api/assignment_rules/assignment_rule.rb +215 -0
  10. data/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.rb +61 -0
  11. data/src/com/zoho/crm/api/assignment_rules/default_user.rb +80 -0
  12. data/src/com/zoho/crm/api/assignment_rules/response_handler.rb +10 -0
  13. data/src/com/zoho/crm/api/assignment_rules/response_wrapper.rb +63 -0
  14. data/src/com/zoho/crm/api/attachments/attachment.rb +42 -4
  15. data/src/com/zoho/crm/api/attachments/attachments_operations.rb +6 -6
  16. data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +2 -2
  17. data/src/com/zoho/crm/api/blue_print/escalation.rb +80 -0
  18. data/src/com/zoho/crm/api/blue_print/field.rb +1127 -0
  19. data/src/com/zoho/crm/api/blue_print/next_transition.rb +38 -0
  20. data/src/com/zoho/crm/api/blue_print/process_info.rb +4 -4
  21. data/src/com/zoho/crm/api/blue_print/transition.rb +19 -1
  22. data/src/com/zoho/crm/api/blue_print/validation_error.rb +57 -0
  23. data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +3 -3
  24. data/src/com/zoho/crm/api/bulk_read/criteria.rb +20 -0
  25. data/src/com/zoho/crm/api/bulk_read/query.rb +5 -4
  26. data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +3 -3
  27. data/src/com/zoho/crm/api/bulk_write/resource.rb +24 -4
  28. data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +7 -7
  29. data/src/com/zoho/crm/api/currencies/currencies_operations.rb +7 -7
  30. data/src/com/zoho/crm/api/custom_views/criteria.rb +5 -4
  31. data/src/com/zoho/crm/api/custom_views/custom_view.rb +100 -41
  32. data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +2 -2
  33. data/src/com/zoho/crm/api/custom_views/{shared_details.rb → shared_to.rb} +2 -2
  34. data/src/com/zoho/crm/api/dc/au_datacenter.rb +3 -3
  35. data/src/com/zoho/crm/api/dc/cn_datacenter.rb +3 -3
  36. data/src/com/zoho/crm/api/dc/datacenter.rb +3 -2
  37. data/src/com/zoho/crm/api/dc/eu_datacenter.rb +3 -3
  38. data/src/com/zoho/crm/api/dc/in_datacenter.rb +3 -3
  39. data/src/com/zoho/crm/api/dc/us_datacenter.rb +3 -3
  40. data/src/com/zoho/crm/api/email_templates/api_exception.rb +121 -0
  41. data/src/com/zoho/crm/api/email_templates/attachment.rb +118 -0
  42. data/src/com/zoho/crm/api/email_templates/email_template.rb +390 -0
  43. data/src/com/zoho/crm/api/email_templates/email_templates_operations.rb +61 -0
  44. data/src/com/zoho/crm/api/email_templates/response_handler.rb +10 -0
  45. data/src/com/zoho/crm/api/email_templates/response_wrapper.rb +83 -0
  46. data/src/com/zoho/crm/api/field_attachments/api_exception.rb +121 -0
  47. data/src/com/zoho/crm/api/field_attachments/body_wrapper.rb +62 -0
  48. data/src/com/zoho/crm/api/field_attachments/field_attachments_operations.rb +52 -0
  49. data/src/com/zoho/crm/api/field_attachments/file_body_wrapper.rb +64 -0
  50. data/src/com/zoho/crm/api/field_attachments/response_handler.rb +10 -0
  51. data/src/com/zoho/crm/api/fields/external.rb +99 -0
  52. data/src/com/zoho/crm/api/fields/field.rb +215 -61
  53. data/src/com/zoho/crm/api/fields/fields_operations.rb +2 -2
  54. data/src/com/zoho/crm/api/fields/history_tracking.rb +80 -0
  55. data/src/com/zoho/crm/api/fields/maps.rb +80 -0
  56. data/src/com/zoho/crm/api/fields/multi_module_lookup.rb +99 -0
  57. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +19 -0
  58. data/src/com/zoho/crm/api/fields/multi_user_lookup.rb +175 -0
  59. data/src/com/zoho/crm/api/fields/pick_list_value.rb +19 -0
  60. data/src/com/zoho/crm/api/fields/related_details.rb +19 -0
  61. data/src/com/zoho/crm/api/files/file_operations.rb +2 -2
  62. data/src/com/zoho/crm/api/initializer.rb +45 -17
  63. data/src/com/zoho/crm/api/inventory_templates/api_exception.rb +121 -0
  64. data/src/com/zoho/crm/api/inventory_templates/inventory_template.rb +352 -0
  65. data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb +82 -0
  66. data/src/com/zoho/crm/api/inventory_templates/response_handler.rb +10 -0
  67. data/src/com/zoho/crm/api/inventory_templates/response_wrapper.rb +83 -0
  68. data/src/com/zoho/crm/api/layouts/layout.rb +38 -0
  69. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +2 -2
  70. data/src/com/zoho/crm/api/layouts/section.rb +19 -0
  71. data/src/com/zoho/crm/api/modules/module.rb +57 -0
  72. data/src/com/zoho/crm/api/modules/modules_operations.rb +4 -4
  73. data/src/com/zoho/crm/api/notes/note.rb +19 -0
  74. data/src/com/zoho/crm/api/notes/notes_operations.rb +7 -7
  75. data/src/com/zoho/crm/api/notification/notification_operations.rb +6 -6
  76. data/src/com/zoho/crm/api/org/hierarchy_preference.rb +61 -0
  77. data/src/com/zoho/crm/api/org/org.rb +38 -0
  78. data/src/com/zoho/crm/api/org/org_operations.rb +2 -2
  79. data/src/com/zoho/crm/api/pipeline/action_handler.rb +10 -0
  80. data/src/com/zoho/crm/api/pipeline/action_response.rb +10 -0
  81. data/src/com/zoho/crm/api/pipeline/action_wrapper.rb +63 -0
  82. data/src/com/zoho/crm/api/pipeline/api_exception.rb +129 -0
  83. data/src/com/zoho/crm/api/pipeline/body_wrapper.rb +61 -0
  84. data/src/com/zoho/crm/api/pipeline/forecast_category.rb +80 -0
  85. data/src/com/zoho/crm/api/pipeline/pick_list_value.rb +175 -0
  86. data/src/com/zoho/crm/api/pipeline/pipeline.rb +213 -0
  87. data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb +165 -0
  88. data/src/com/zoho/crm/api/pipeline/response_handler.rb +10 -0
  89. data/src/com/zoho/crm/api/pipeline/response_wrapper.rb +63 -0
  90. data/src/com/zoho/crm/api/pipeline/stage.rb +80 -0
  91. data/src/com/zoho/crm/api/pipeline/success_response.rb +123 -0
  92. data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb +10 -0
  93. data/src/com/zoho/crm/api/pipeline/transfer_action_response.rb +10 -0
  94. data/src/com/zoho/crm/api/pipeline/transfer_action_wrapper.rb +63 -0
  95. data/src/com/zoho/crm/api/pipeline/transfer_and_delete_wrapper.rb +61 -0
  96. data/src/com/zoho/crm/api/pipeline/transfer_pipe_line.rb +80 -0
  97. data/src/com/zoho/crm/api/profiles/category.rb +19 -0
  98. data/src/com/zoho/crm/api/profiles/default_view.rb +99 -0
  99. data/src/com/zoho/crm/api/profiles/profile.rb +49 -11
  100. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +2 -2
  101. data/src/com/zoho/crm/api/query/query_operations.rb +1 -1
  102. data/src/com/zoho/crm/api/record/api_exception.rb +2 -0
  103. data/src/com/zoho/crm/api/record/body_wrapper.rb +0 -19
  104. data/src/com/zoho/crm/api/record/count_handler.rb +10 -0
  105. data/src/com/zoho/crm/api/record/count_wrapper.rb +63 -0
  106. data/src/com/zoho/crm/api/record/field.rb +17 -17
  107. data/src/com/zoho/crm/api/record/image_upload.rb +213 -0
  108. data/src/com/zoho/crm/api/record/line_tax.rb +19 -0
  109. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +4 -4
  110. data/src/com/zoho/crm/api/record/mass_update_territory.rb +80 -0
  111. data/src/com/zoho/crm/api/record/multi_select_lookup.rb +99 -0
  112. data/src/com/zoho/crm/api/record/multi_select_picklist.rb +80 -0
  113. data/src/com/zoho/crm/api/record/price_book.rb +31 -0
  114. data/src/com/zoho/crm/api/record/record_operations.rb +196 -26
  115. data/src/com/zoho/crm/api/record/tax.rb +80 -0
  116. data/src/com/zoho/crm/api/record/territory.rb +70 -12
  117. data/src/com/zoho/crm/api/record/widget.rb +80 -0
  118. data/src/com/zoho/crm/api/record/wizard.rb +80 -0
  119. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +2 -2
  120. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +6 -6
  121. data/src/com/zoho/crm/api/request_proxy.rb +3 -4
  122. data/src/com/zoho/crm/api/roles/roles_operations.rb +2 -2
  123. data/src/com/zoho/crm/api/sdk_config.rb +2 -68
  124. data/src/com/zoho/crm/api/send_mail/action_handler.rb +10 -0
  125. data/src/com/zoho/crm/api/send_mail/action_response.rb +10 -0
  126. data/src/com/zoho/crm/api/send_mail/action_wrapper.rb +63 -0
  127. data/src/com/zoho/crm/api/send_mail/api_exception.rb +125 -0
  128. data/src/com/zoho/crm/api/send_mail/body_wrapper.rb +61 -0
  129. data/src/com/zoho/crm/api/send_mail/data_subject_request.rb +80 -0
  130. data/src/com/zoho/crm/api/send_mail/inventory_details.rb +100 -0
  131. data/src/com/zoho/crm/api/send_mail/mail.rb +423 -0
  132. data/src/com/zoho/crm/api/send_mail/response_handler.rb +10 -0
  133. data/src/com/zoho/crm/api/send_mail/response_wrapper.rb +63 -0
  134. data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb +61 -0
  135. data/src/com/zoho/crm/api/send_mail/success_response.rb +121 -0
  136. data/src/com/zoho/crm/api/send_mail/template.rb +10 -0
  137. data/src/com/zoho/crm/api/send_mail/user_address.rb +137 -0
  138. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +4 -4
  139. data/src/com/zoho/crm/api/tags/tag.rb +19 -0
  140. data/src/com/zoho/crm/api/tags/tags_operations.rb +11 -11
  141. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +6 -6
  142. data/src/com/zoho/crm/api/territories/response_wrapper.rb +20 -0
  143. data/src/com/zoho/crm/api/territories/territories_operations.rb +2 -2
  144. data/src/com/zoho/crm/api/territories/territory.rb +61 -23
  145. data/src/com/zoho/crm/api/users/user.rb +34 -0
  146. data/src/com/zoho/crm/api/users/users_operations.rb +6 -6
  147. data/src/com/zoho/crm/api/util/api_http_connector.rb +6 -5
  148. data/src/com/zoho/crm/api/util/common_api_handler.rb +5 -3
  149. data/src/com/zoho/crm/api/util/constants.rb +140 -15
  150. data/src/com/zoho/crm/api/util/converter.rb +30 -7
  151. data/src/com/zoho/crm/api/util/data_type_converter.rb +8 -2
  152. data/src/com/zoho/crm/api/util/form_data_converter.rb +4 -15
  153. data/src/com/zoho/crm/api/util/json_converter.rb +7 -9
  154. data/src/com/zoho/crm/api/util/module_fields_handler.rb +1 -1
  155. data/src/com/zoho/crm/api/util/utility.rb +274 -87
  156. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +3 -3
  157. data/src/com/zoho/crm/api/variables/variables_operations.rb +9 -9
  158. data/src/com/zoho/crm/api/wizards/api_exception.rb +121 -0
  159. data/src/com/zoho/crm/api/wizards/button.rb +252 -0
  160. data/src/com/zoho/crm/api/wizards/chart_data.rb +118 -0
  161. data/src/com/zoho/crm/api/wizards/connection.rb +80 -0
  162. data/src/com/zoho/crm/api/wizards/container.rb +119 -0
  163. data/src/com/zoho/crm/api/wizards/node.rb +118 -0
  164. data/src/com/zoho/crm/api/wizards/response_handler.rb +10 -0
  165. data/src/com/zoho/crm/api/wizards/response_wrapper.rb +63 -0
  166. data/src/com/zoho/crm/api/wizards/screen.rb +99 -0
  167. data/src/com/zoho/crm/api/wizards/segment.rb +176 -0
  168. data/src/com/zoho/crm/api/wizards/transition.rb +80 -0
  169. data/src/com/zoho/crm/api/wizards/wizard.rb +273 -0
  170. data/src/com/zoho/crm/api/wizards/wizards_operations.rb +61 -0
  171. data/src/resources/JSONDetails.json +1 -1
  172. data/src/version.rb +1 -1
  173. metadata +92 -7
  174. data/src/com/zoho/crm/api/record/inventory_line_items.rb +0 -235
@@ -0,0 +1,10 @@
1
+ module Pipeline
2
+ module TransferActionResponse
3
+
4
+ # Creates an instance of TransferActionResponse
5
+ def initialize
6
+ end
7
+
8
+
9
+ end
10
+ end
@@ -0,0 +1,63 @@
1
+ require_relative '../util/model'
2
+
3
+ module Pipeline
4
+ require_relative 'transfer_action_handler'
5
+ class TransferActionWrapper
6
+ include Util::Model
7
+ include TransferActionHandler
8
+
9
+ # Creates an instance of TransferActionWrapper
10
+ def initialize
11
+ @transfer_pipeline = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the transfer_pipeline
16
+ # @return An instance of Array
17
+
18
+ def transfer_pipeline
19
+ @transfer_pipeline
20
+ end
21
+
22
+ # The method to set the value to transfer_pipeline
23
+ # @param transfer_pipeline [Array] An instance of Array
24
+
25
+ def transfer_pipeline=(transfer_pipeline)
26
+ if transfer_pipeline!=nil and !transfer_pipeline.is_a? Array
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: transfer_pipeline EXPECTED TYPE: Array', nil, nil)
28
+ end
29
+ @transfer_pipeline = transfer_pipeline
30
+ @key_modified['transfer_pipeline'] = 1
31
+ end
32
+
33
+ # The method to check if the user has modified the given key
34
+ # @param key [String] A String
35
+ # @return A Integer value
36
+
37
+ def is_key_modified(key)
38
+ if key!=nil and !key.is_a? String
39
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
40
+ end
41
+ if @key_modified.key?(key)
42
+ return @key_modified[key]
43
+ end
44
+
45
+ nil
46
+ end
47
+
48
+ # The method to mark the given key as modified
49
+ # @param key [String] A String
50
+ # @param modification [Integer] A Integer
51
+
52
+ def set_key_modified(key, modification)
53
+ if key!=nil and !key.is_a? String
54
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
55
+ end
56
+ if modification!=nil and !modification.is_a? Integer
57
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
58
+ end
59
+ @key_modified[key] = modification
60
+ end
61
+
62
+ end
63
+ end
@@ -0,0 +1,61 @@
1
+ require_relative '../util/model'
2
+
3
+ module Pipeline
4
+ class TransferAndDeleteWrapper
5
+ include Util::Model
6
+
7
+ # Creates an instance of TransferAndDeleteWrapper
8
+ def initialize
9
+ @transfer_pipeline = nil
10
+ @key_modified = Hash.new
11
+ end
12
+
13
+ # The method to get the transfer_pipeline
14
+ # @return An instance of Array
15
+
16
+ def transfer_pipeline
17
+ @transfer_pipeline
18
+ end
19
+
20
+ # The method to set the value to transfer_pipeline
21
+ # @param transfer_pipeline [Array] An instance of Array
22
+
23
+ def transfer_pipeline=(transfer_pipeline)
24
+ if transfer_pipeline!=nil and !transfer_pipeline.is_a? Array
25
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: transfer_pipeline EXPECTED TYPE: Array', nil, nil)
26
+ end
27
+ @transfer_pipeline = transfer_pipeline
28
+ @key_modified['transfer_pipeline'] = 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,80 @@
1
+ require_relative '../util/model'
2
+
3
+ module Pipeline
4
+ class TransferPipeLine
5
+ include Util::Model
6
+
7
+ # Creates an instance of TransferPipeLine
8
+ def initialize
9
+ @pipeline = nil
10
+ @stages = nil
11
+ @key_modified = Hash.new
12
+ end
13
+
14
+ # The method to get the pipeline
15
+ # @return An instance of Pipeline
16
+
17
+ def pipeline
18
+ @pipeline
19
+ end
20
+
21
+ # The method to set the value to pipeline
22
+ # @param pipeline [Pipeline] An instance of Pipeline
23
+
24
+ def pipeline=(pipeline)
25
+ if pipeline!=nil and !pipeline.is_a? Pipeline
26
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: Pipeline', nil, nil)
27
+ end
28
+ @pipeline = pipeline
29
+ @key_modified['pipeline'] = 1
30
+ end
31
+
32
+ # The method to get the stages
33
+ # @return An instance of Array
34
+
35
+ def stages
36
+ @stages
37
+ end
38
+
39
+ # The method to set the value to stages
40
+ # @param stages [Array] An instance of Array
41
+
42
+ def stages=(stages)
43
+ if stages!=nil and !stages.is_a? Array
44
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: stages EXPECTED TYPE: Array', nil, nil)
45
+ end
46
+ @stages = stages
47
+ @key_modified['stages'] = 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
@@ -9,6 +9,7 @@ module Profiles
9
9
  @display_label = nil
10
10
  @permissions_details = nil
11
11
  @name = nil
12
+ @module_1 = nil
12
13
  @key_modified = Hash.new
13
14
  end
14
15
 
@@ -66,6 +67,24 @@ module Profiles
66
67
  @key_modified['name'] = 1
67
68
  end
68
69
 
70
+ # The method to get the module
71
+ # @return A String value
72
+
73
+ def module
74
+ @module_1
75
+ end
76
+
77
+ # The method to set the value to module
78
+ # @param module_1 [String] A String
79
+
80
+ def module=(module_1)
81
+ if module_1!=nil and !module_1.is_a? String
82
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
83
+ end
84
+ @module_1 = module_1
85
+ @key_modified['module'] = 1
86
+ end
87
+
69
88
  # The method to check if the user has modified the given key
70
89
  # @param key [String] A String
71
90
  # @return A Integer value
@@ -0,0 +1,99 @@
1
+ require_relative '../util/model'
2
+
3
+ module Profiles
4
+ class DefaultView
5
+ include Util::Model
6
+
7
+ # Creates an instance of DefaultView
8
+ def initialize
9
+ @name = nil
10
+ @id = nil
11
+ @type = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the name
16
+ # @return A String value
17
+
18
+ def name
19
+ @name
20
+ end
21
+
22
+ # The method to set the value to name
23
+ # @param name [String] A String
24
+
25
+ def name=(name)
26
+ if name!=nil and !name.is_a? String
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
28
+ end
29
+ @name = name
30
+ @key_modified['name'] = 1
31
+ end
32
+
33
+ # The method to get the id
34
+ # @return A Integer value
35
+
36
+ def id
37
+ @id
38
+ end
39
+
40
+ # The method to set the value to id
41
+ # @param id [Integer] A Integer
42
+
43
+ def id=(id)
44
+ if id!=nil and !id.is_a? Integer
45
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
46
+ end
47
+ @id = id
48
+ @key_modified['id'] = 1
49
+ end
50
+
51
+ # The method to get the type
52
+ # @return A String value
53
+
54
+ def type
55
+ @type
56
+ end
57
+
58
+ # The method to set the value to type
59
+ # @param type [String] A String
60
+
61
+ def type=(type)
62
+ if type!=nil and !type.is_a? String
63
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
64
+ end
65
+ @type = type
66
+ @key_modified['type'] = 1
67
+ end
68
+
69
+ # The method to check if the user has modified the given key
70
+ # @param key [String] A String
71
+ # @return A Integer value
72
+
73
+ def is_key_modified(key)
74
+ if key!=nil and !key.is_a? String
75
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
76
+ end
77
+ if @key_modified.key?(key)
78
+ return @key_modified[key]
79
+ end
80
+
81
+ nil
82
+ end
83
+
84
+ # The method to mark the given key as modified
85
+ # @param key [String] A String
86
+ # @param modification [Integer] A Integer
87
+
88
+ def set_key_modified(key, modification)
89
+ if key!=nil and !key.is_a? String
90
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
91
+ end
92
+ if modification!=nil and !modification.is_a? Integer
93
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
94
+ end
95
+ @key_modified[key] = modification
96
+ end
97
+
98
+ end
99
+ end
@@ -13,13 +13,15 @@ module Profiles
13
13
  @permissions_details = nil
14
14
  @name = nil
15
15
  @modified_by = nil
16
+ @defaultview = nil
16
17
  @default = nil
17
18
  @description = nil
18
19
  @id = nil
19
- @category = nil
20
+ @custom = nil
20
21
  @created_by = nil
21
22
  @sections = nil
22
23
  @delete = nil
24
+ @permission_type = nil
23
25
  @key_modified = Hash.new
24
26
  end
25
27
 
@@ -131,6 +133,24 @@ module Profiles
131
133
  @key_modified['modified_by'] = 1
132
134
  end
133
135
 
136
+ # The method to get the defaultview
137
+ # @return An instance of DefaultView
138
+
139
+ def defaultview
140
+ @defaultview
141
+ end
142
+
143
+ # The method to set the value to defaultview
144
+ # @param defaultview [DefaultView] An instance of DefaultView
145
+
146
+ def defaultview=(defaultview)
147
+ if defaultview!=nil and !defaultview.is_a? DefaultView
148
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: DefaultView', nil, nil)
149
+ end
150
+ @defaultview = defaultview
151
+ @key_modified['_default_view'] = 1
152
+ end
153
+
134
154
  # The method to get the default
135
155
  # @return A Boolean value
136
156
 
@@ -185,22 +205,22 @@ module Profiles
185
205
  @key_modified['id'] = 1
186
206
  end
187
207
 
188
- # The method to get the category
208
+ # The method to get the custom
189
209
  # @return A Boolean value
190
210
 
191
- def category
192
- @category
211
+ def custom
212
+ @custom
193
213
  end
194
214
 
195
- # The method to set the value to category
196
- # @param category [Boolean] A Boolean
215
+ # The method to set the value to custom
216
+ # @param custom [Boolean] A Boolean
197
217
 
198
- def category=(category)
199
- if category!=nil and ! [true, false].include?category
200
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: Boolean', nil, nil)
218
+ def custom=(custom)
219
+ if custom!=nil and ! [true, false].include?custom
220
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: custom EXPECTED TYPE: Boolean', nil, nil)
201
221
  end
202
- @category = category
203
- @key_modified['category'] = 1
222
+ @custom = custom
223
+ @key_modified['custom'] = 1
204
224
  end
205
225
 
206
226
  # The method to get the created_by
@@ -257,6 +277,24 @@ module Profiles
257
277
  @key_modified['_delete'] = 1
258
278
  end
259
279
 
280
+ # The method to get the permission_type
281
+ # @return A String value
282
+
283
+ def permission_type
284
+ @permission_type
285
+ end
286
+
287
+ # The method to set the value to permission_type
288
+ # @param permission_type [String] A String
289
+
290
+ def permission_type=(permission_type)
291
+ if permission_type!=nil and !permission_type.is_a? String
292
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: String', nil, nil)
293
+ end
294
+ @permission_type = permission_type
295
+ @key_modified['permission_type'] = 1
296
+ end
297
+
260
298
  # The method to check if the user has modified the given key
261
299
  # @param key [String] A String
262
300
  # @return A Integer value