ZCRMSDK 2.0.0 → 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
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,80 @@
1
+ require_relative '../util/model'
2
+
3
+ module Pipeline
4
+ class ForecastCategory
5
+ include Util::Model
6
+
7
+ # Creates an instance of ForecastCategory
8
+ def initialize
9
+ @id = nil
10
+ @name = nil
11
+ @key_modified = Hash.new
12
+ end
13
+
14
+ # The method to get the id
15
+ # @return A Integer value
16
+
17
+ def id
18
+ @id
19
+ end
20
+
21
+ # The method to set the value to id
22
+ # @param id [Integer] A Integer
23
+
24
+ def id=(id)
25
+ if id!=nil and !id.is_a? Integer
26
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
27
+ end
28
+ @id = id
29
+ @key_modified['id'] = 1
30
+ end
31
+
32
+ # The method to get the name
33
+ # @return A String value
34
+
35
+ def name
36
+ @name
37
+ end
38
+
39
+ # The method to set the value to name
40
+ # @param name [String] A String
41
+
42
+ def name=(name)
43
+ if name!=nil and !name.is_a? String
44
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
45
+ end
46
+ @name = name
47
+ @key_modified['name'] = 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,175 @@
1
+ require_relative '../util/model'
2
+
3
+ module Pipeline
4
+ class PickListValue
5
+ include Util::Model
6
+
7
+ # Creates an instance of PickListValue
8
+ def initialize
9
+ @display_value = nil
10
+ @delete = nil
11
+ @sequence_number = nil
12
+ @actual_value = nil
13
+ @id = nil
14
+ @forecast_type = nil
15
+ @forecast_category = nil
16
+ @key_modified = Hash.new
17
+ end
18
+
19
+ # The method to get the display_value
20
+ # @return A String value
21
+
22
+ def display_value
23
+ @display_value
24
+ end
25
+
26
+ # The method to set the value to display_value
27
+ # @param display_value [String] A String
28
+
29
+ def display_value=(display_value)
30
+ if display_value!=nil and !display_value.is_a? String
31
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: String', nil, nil)
32
+ end
33
+ @display_value = display_value
34
+ @key_modified['display_value'] = 1
35
+ end
36
+
37
+ # The method to get the delete
38
+ # @return A Boolean value
39
+
40
+ def delete
41
+ @delete
42
+ end
43
+
44
+ # The method to set the value to delete
45
+ # @param delete [Boolean] A Boolean
46
+
47
+ def delete=(delete)
48
+ if delete!=nil and ! [true, false].include?delete
49
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: Boolean', nil, nil)
50
+ end
51
+ @delete = delete
52
+ @key_modified['_delete'] = 1
53
+ end
54
+
55
+ # The method to get the sequence_number
56
+ # @return A Integer value
57
+
58
+ def sequence_number
59
+ @sequence_number
60
+ end
61
+
62
+ # The method to set the value to sequence_number
63
+ # @param sequence_number [Integer] A Integer
64
+
65
+ def sequence_number=(sequence_number)
66
+ if sequence_number!=nil and !sequence_number.is_a? Integer
67
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: Integer', nil, nil)
68
+ end
69
+ @sequence_number = sequence_number
70
+ @key_modified['sequence_number'] = 1
71
+ end
72
+
73
+ # The method to get the actual_value
74
+ # @return A String value
75
+
76
+ def actual_value
77
+ @actual_value
78
+ end
79
+
80
+ # The method to set the value to actual_value
81
+ # @param actual_value [String] A String
82
+
83
+ def actual_value=(actual_value)
84
+ if actual_value!=nil and !actual_value.is_a? String
85
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: String', nil, nil)
86
+ end
87
+ @actual_value = actual_value
88
+ @key_modified['actual_value'] = 1
89
+ end
90
+
91
+ # The method to get the id
92
+ # @return A Integer value
93
+
94
+ def id
95
+ @id
96
+ end
97
+
98
+ # The method to set the value to id
99
+ # @param id [Integer] A Integer
100
+
101
+ def id=(id)
102
+ if id!=nil and !id.is_a? Integer
103
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
104
+ end
105
+ @id = id
106
+ @key_modified['id'] = 1
107
+ end
108
+
109
+ # The method to get the forecast_type
110
+ # @return A String value
111
+
112
+ def forecast_type
113
+ @forecast_type
114
+ end
115
+
116
+ # The method to set the value to forecast_type
117
+ # @param forecast_type [String] A String
118
+
119
+ def forecast_type=(forecast_type)
120
+ if forecast_type!=nil and !forecast_type.is_a? String
121
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: forecast_type EXPECTED TYPE: String', nil, nil)
122
+ end
123
+ @forecast_type = forecast_type
124
+ @key_modified['forecast_type'] = 1
125
+ end
126
+
127
+ # The method to get the forecast_category
128
+ # @return An instance of ForecastCategory
129
+
130
+ def forecast_category
131
+ @forecast_category
132
+ end
133
+
134
+ # The method to set the value to forecast_category
135
+ # @param forecast_category [ForecastCategory] An instance of ForecastCategory
136
+
137
+ def forecast_category=(forecast_category)
138
+ if forecast_category!=nil and !forecast_category.is_a? ForecastCategory
139
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: forecast_category EXPECTED TYPE: ForecastCategory', nil, nil)
140
+ end
141
+ @forecast_category = forecast_category
142
+ @key_modified['forecast_category'] = 1
143
+ end
144
+
145
+ # The method to check if the user has modified the given key
146
+ # @param key [String] A String
147
+ # @return A Integer value
148
+
149
+ def is_key_modified(key)
150
+ if key!=nil and !key.is_a? String
151
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
152
+ end
153
+ if @key_modified.key?(key)
154
+ return @key_modified[key]
155
+ end
156
+
157
+ nil
158
+ end
159
+
160
+ # The method to mark the given key as modified
161
+ # @param key [String] A String
162
+ # @param modification [Integer] A Integer
163
+
164
+ def set_key_modified(key, modification)
165
+ if key!=nil and !key.is_a? String
166
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
167
+ end
168
+ if modification!=nil and !modification.is_a? Integer
169
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
170
+ end
171
+ @key_modified[key] = modification
172
+ end
173
+
174
+ end
175
+ end
@@ -0,0 +1,213 @@
1
+ require_relative '../util/model'
2
+
3
+ module Pipeline
4
+ class Pipeline
5
+ include Util::Model
6
+
7
+ # Creates an instance of Pipeline
8
+ def initialize
9
+ @from = nil
10
+ @to = nil
11
+ @parent = nil
12
+ @child_available = nil
13
+ @display_value = nil
14
+ @default = nil
15
+ @maps = nil
16
+ @actual_value = nil
17
+ @id = nil
18
+ @key_modified = Hash.new
19
+ end
20
+
21
+ # The method to get the from
22
+ # @return A Integer value
23
+
24
+ def from
25
+ @from
26
+ end
27
+
28
+ # The method to set the value to from
29
+ # @param from [Integer] A Integer
30
+
31
+ def from=(from)
32
+ if from!=nil and !from.is_a? Integer
33
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: from EXPECTED TYPE: Integer', nil, nil)
34
+ end
35
+ @from = from
36
+ @key_modified['from'] = 1
37
+ end
38
+
39
+ # The method to get the to
40
+ # @return A Integer value
41
+
42
+ def to
43
+ @to
44
+ end
45
+
46
+ # The method to set the value to to
47
+ # @param to [Integer] A Integer
48
+
49
+ def to=(to)
50
+ if to!=nil and !to.is_a? Integer
51
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: Integer', nil, nil)
52
+ end
53
+ @to = to
54
+ @key_modified['to'] = 1
55
+ end
56
+
57
+ # The method to get the parent
58
+ # @return An instance of Pipeline
59
+
60
+ def parent
61
+ @parent
62
+ end
63
+
64
+ # The method to set the value to parent
65
+ # @param parent [Pipeline] An instance of Pipeline
66
+
67
+ def parent=(parent)
68
+ if parent!=nil and !parent.is_a? Pipeline
69
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent EXPECTED TYPE: Pipeline', nil, nil)
70
+ end
71
+ @parent = parent
72
+ @key_modified['parent'] = 1
73
+ end
74
+
75
+ # The method to get the child_available
76
+ # @return A Boolean value
77
+
78
+ def child_available
79
+ @child_available
80
+ end
81
+
82
+ # The method to set the value to child_available
83
+ # @param child_available [Boolean] A Boolean
84
+
85
+ def child_available=(child_available)
86
+ if child_available!=nil and ! [true, false].include?child_available
87
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: child_available EXPECTED TYPE: Boolean', nil, nil)
88
+ end
89
+ @child_available = child_available
90
+ @key_modified['child_available'] = 1
91
+ end
92
+
93
+ # The method to get the display_value
94
+ # @return A String value
95
+
96
+ def display_value
97
+ @display_value
98
+ end
99
+
100
+ # The method to set the value to display_value
101
+ # @param display_value [String] A String
102
+
103
+ def display_value=(display_value)
104
+ if display_value!=nil and !display_value.is_a? String
105
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: String', nil, nil)
106
+ end
107
+ @display_value = display_value
108
+ @key_modified['display_value'] = 1
109
+ end
110
+
111
+ # The method to get the default
112
+ # @return A Boolean value
113
+
114
+ def default
115
+ @default
116
+ end
117
+
118
+ # The method to set the value to default
119
+ # @param default [Boolean] A Boolean
120
+
121
+ def default=(default)
122
+ if default!=nil and ! [true, false].include?default
123
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Boolean', nil, nil)
124
+ end
125
+ @default = default
126
+ @key_modified['default'] = 1
127
+ end
128
+
129
+ # The method to get the maps
130
+ # @return An instance of Array
131
+
132
+ def maps
133
+ @maps
134
+ end
135
+
136
+ # The method to set the value to maps
137
+ # @param maps [Array] An instance of Array
138
+
139
+ def maps=(maps)
140
+ if maps!=nil and !maps.is_a? Array
141
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: maps EXPECTED TYPE: Array', nil, nil)
142
+ end
143
+ @maps = maps
144
+ @key_modified['maps'] = 1
145
+ end
146
+
147
+ # The method to get the actual_value
148
+ # @return A String value
149
+
150
+ def actual_value
151
+ @actual_value
152
+ end
153
+
154
+ # The method to set the value to actual_value
155
+ # @param actual_value [String] A String
156
+
157
+ def actual_value=(actual_value)
158
+ if actual_value!=nil and !actual_value.is_a? String
159
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: String', nil, nil)
160
+ end
161
+ @actual_value = actual_value
162
+ @key_modified['actual_value'] = 1
163
+ end
164
+
165
+ # The method to get the id
166
+ # @return A Integer value
167
+
168
+ def id
169
+ @id
170
+ end
171
+
172
+ # The method to set the value to id
173
+ # @param id [Integer] A Integer
174
+
175
+ def id=(id)
176
+ if id!=nil and !id.is_a? Integer
177
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
178
+ end
179
+ @id = id
180
+ @key_modified['id'] = 1
181
+ end
182
+
183
+ # The method to check if the user has modified the given key
184
+ # @param key [String] A String
185
+ # @return A Integer value
186
+
187
+ def is_key_modified(key)
188
+ if key!=nil and !key.is_a? String
189
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
190
+ end
191
+ if @key_modified.key?(key)
192
+ return @key_modified[key]
193
+ end
194
+
195
+ nil
196
+ end
197
+
198
+ # The method to mark the given key as modified
199
+ # @param key [String] A String
200
+ # @param modification [Integer] A Integer
201
+
202
+ def set_key_modified(key, modification)
203
+ if key!=nil and !key.is_a? String
204
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
205
+ end
206
+ if modification!=nil and !modification.is_a? Integer
207
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
208
+ end
209
+ @key_modified[key] = modification
210
+ end
211
+
212
+ end
213
+ end