ZCRMSDK 2.1.0 → 3.0.0.beta

Sign up to get free protection for your applications and to get access to all the features.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZCRMSDK.rb +84 -1
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +87 -31
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +48 -28
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +69 -21
  6. data/src/com/zoho/api/authenticator/store/token_store.rb +7 -0
  7. data/src/com/zoho/api/logger/sdk_logger.rb +19 -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 +4 -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 +1107 -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 +192 -38
  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_select_lookup.rb +19 -0
  57. data/src/com/zoho/crm/api/fields/multi_user_lookup.rb +175 -0
  58. data/src/com/zoho/crm/api/fields/pick_list_value.rb +19 -0
  59. data/src/com/zoho/crm/api/fields/related_details.rb +19 -0
  60. data/src/com/zoho/crm/api/files/file_operations.rb +2 -2
  61. data/src/com/zoho/crm/api/initializer.rb +40 -15
  62. data/src/com/zoho/crm/api/inventory_templates/api_exception.rb +121 -0
  63. data/src/com/zoho/crm/api/inventory_templates/inventory_template.rb +352 -0
  64. data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb +82 -0
  65. data/src/com/zoho/crm/api/inventory_templates/response_handler.rb +10 -0
  66. data/src/com/zoho/crm/api/inventory_templates/response_wrapper.rb +83 -0
  67. data/src/com/zoho/crm/api/layouts/layout.rb +38 -0
  68. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +2 -2
  69. data/src/com/zoho/crm/api/layouts/section.rb +19 -0
  70. data/src/com/zoho/crm/api/modules/module.rb +57 -0
  71. data/src/com/zoho/crm/api/modules/modules_operations.rb +4 -4
  72. data/src/com/zoho/crm/api/notes/notes_operations.rb +7 -7
  73. data/src/com/zoho/crm/api/notification/notification_operations.rb +6 -6
  74. data/src/com/zoho/crm/api/org/org_operations.rb +2 -2
  75. data/src/com/zoho/crm/api/pipeline/action_handler.rb +10 -0
  76. data/src/com/zoho/crm/api/pipeline/action_response.rb +10 -0
  77. data/src/com/zoho/crm/api/pipeline/action_wrapper.rb +63 -0
  78. data/src/com/zoho/crm/api/pipeline/api_exception.rb +129 -0
  79. data/src/com/zoho/crm/api/pipeline/body_wrapper.rb +61 -0
  80. data/src/com/zoho/crm/api/pipeline/forecast_category.rb +80 -0
  81. data/src/com/zoho/crm/api/pipeline/pick_list_value.rb +175 -0
  82. data/src/com/zoho/crm/api/pipeline/pipeline.rb +213 -0
  83. data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb +165 -0
  84. data/src/com/zoho/crm/api/pipeline/response_handler.rb +10 -0
  85. data/src/com/zoho/crm/api/pipeline/response_wrapper.rb +63 -0
  86. data/src/com/zoho/crm/api/pipeline/stage.rb +80 -0
  87. data/src/com/zoho/crm/api/pipeline/success_response.rb +123 -0
  88. data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb +10 -0
  89. data/src/com/zoho/crm/api/pipeline/transfer_action_response.rb +10 -0
  90. data/src/com/zoho/crm/api/pipeline/transfer_action_wrapper.rb +63 -0
  91. data/src/com/zoho/crm/api/pipeline/transfer_and_delete_wrapper.rb +61 -0
  92. data/src/com/zoho/crm/api/pipeline/transfer_pipe_line.rb +80 -0
  93. data/src/com/zoho/crm/api/profiles/default_view.rb +99 -0
  94. data/src/com/zoho/crm/api/profiles/profile.rb +57 -0
  95. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +2 -2
  96. data/src/com/zoho/crm/api/query/query_operations.rb +1 -1
  97. data/src/com/zoho/crm/api/record/api_exception.rb +2 -0
  98. data/src/com/zoho/crm/api/record/body_wrapper.rb +0 -19
  99. data/src/com/zoho/crm/api/record/count_handler.rb +10 -0
  100. data/src/com/zoho/crm/api/record/count_wrapper.rb +63 -0
  101. data/src/com/zoho/crm/api/record/field.rb +1 -0
  102. data/src/com/zoho/crm/api/record/image_upload.rb +213 -0
  103. data/src/com/zoho/crm/api/record/inventory_line_items.rb +56 -39
  104. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +4 -4
  105. data/src/com/zoho/crm/api/record/mass_update_territory.rb +80 -0
  106. data/src/com/zoho/crm/api/record/multi_select_lookup.rb +99 -0
  107. data/src/com/zoho/crm/api/record/multi_select_picklist.rb +80 -0
  108. data/src/com/zoho/crm/api/record/price_book.rb +31 -0
  109. data/src/com/zoho/crm/api/record/record_operations.rb +201 -111
  110. data/src/com/zoho/crm/api/record/tax.rb +80 -0
  111. data/src/com/zoho/crm/api/record/territory.rb +70 -12
  112. data/src/com/zoho/crm/api/record/widget.rb +80 -0
  113. data/src/com/zoho/crm/api/record/wizard.rb +80 -0
  114. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +2 -2
  115. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +8 -36
  116. data/src/com/zoho/crm/api/request_proxy.rb +3 -4
  117. data/src/com/zoho/crm/api/roles/roles_operations.rb +2 -2
  118. data/src/com/zoho/crm/api/sdk_config.rb +2 -68
  119. data/src/com/zoho/crm/api/send_mail/action_handler.rb +10 -0
  120. data/src/com/zoho/crm/api/send_mail/action_response.rb +10 -0
  121. data/src/com/zoho/crm/api/send_mail/action_wrapper.rb +63 -0
  122. data/src/com/zoho/crm/api/send_mail/api_exception.rb +125 -0
  123. data/src/com/zoho/crm/api/send_mail/body_wrapper.rb +61 -0
  124. data/src/com/zoho/crm/api/send_mail/data_subject_request.rb +80 -0
  125. data/src/com/zoho/crm/api/send_mail/inventory_details.rb +100 -0
  126. data/src/com/zoho/crm/api/send_mail/mail.rb +423 -0
  127. data/src/com/zoho/crm/api/send_mail/response_handler.rb +10 -0
  128. data/src/com/zoho/crm/api/send_mail/response_wrapper.rb +63 -0
  129. data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb +61 -0
  130. data/src/com/zoho/crm/api/send_mail/success_response.rb +121 -0
  131. data/src/com/zoho/crm/api/send_mail/template.rb +10 -0
  132. data/src/com/zoho/crm/api/send_mail/user_address.rb +137 -0
  133. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +4 -4
  134. data/src/com/zoho/crm/api/tags/tag.rb +19 -0
  135. data/src/com/zoho/crm/api/tags/tags_operations.rb +11 -11
  136. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +6 -6
  137. data/src/com/zoho/crm/api/territories/response_wrapper.rb +20 -0
  138. data/src/com/zoho/crm/api/territories/territories_operations.rb +2 -2
  139. data/src/com/zoho/crm/api/territories/territory.rb +61 -23
  140. data/src/com/zoho/crm/api/users/users_operations.rb +6 -6
  141. data/src/com/zoho/crm/api/util/api_http_connector.rb +5 -5
  142. data/src/com/zoho/crm/api/util/common_api_handler.rb +0 -1
  143. data/src/com/zoho/crm/api/util/constants.rb +140 -13
  144. data/src/com/zoho/crm/api/util/converter.rb +21 -4
  145. data/src/com/zoho/crm/api/util/form_data_converter.rb +3 -15
  146. data/src/com/zoho/crm/api/util/utility.rb +226 -86
  147. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +3 -3
  148. data/src/com/zoho/crm/api/variables/variables_operations.rb +9 -9
  149. data/src/com/zoho/crm/api/wizards/api_exception.rb +121 -0
  150. data/src/com/zoho/crm/api/wizards/button.rb +214 -0
  151. data/src/com/zoho/crm/api/wizards/chart_data.rb +118 -0
  152. data/src/com/zoho/crm/api/wizards/connection.rb +80 -0
  153. data/src/com/zoho/crm/api/wizards/container.rb +119 -0
  154. data/src/com/zoho/crm/api/wizards/node.rb +118 -0
  155. data/src/com/zoho/crm/api/wizards/response_handler.rb +10 -0
  156. data/src/com/zoho/crm/api/wizards/response_wrapper.rb +63 -0
  157. data/src/com/zoho/crm/api/wizards/screen.rb +99 -0
  158. data/src/com/zoho/crm/api/wizards/segment.rb +176 -0
  159. data/src/com/zoho/crm/api/wizards/wizard.rb +273 -0
  160. data/src/com/zoho/crm/api/wizards/wizards_operations.rb +61 -0
  161. data/src/resources/JSONDetails.json +1 -1
  162. data/src/version.rb +1 -1
  163. metadata +88 -5
@@ -0,0 +1,80 @@
1
+ require_relative '../util/model'
2
+
3
+ module Wizards
4
+ class Connection
5
+ include Util::Model
6
+
7
+ # Creates an instance of Connection
8
+ def initialize
9
+ @source_button = nil
10
+ @target_screen = nil
11
+ @key_modified = Hash.new
12
+ end
13
+
14
+ # The method to get the source_button
15
+ # @return An instance of Button
16
+
17
+ def source_button
18
+ @source_button
19
+ end
20
+
21
+ # The method to set the value to source_button
22
+ # @param source_button [Button] An instance of Button
23
+
24
+ def source_button=(source_button)
25
+ if source_button!=nil and !source_button.is_a? Button
26
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: source_button EXPECTED TYPE: Button', nil, nil)
27
+ end
28
+ @source_button = source_button
29
+ @key_modified['source_button'] = 1
30
+ end
31
+
32
+ # The method to get the target_screen
33
+ # @return An instance of Screen
34
+
35
+ def tarscreen
36
+ @target_screen
37
+ end
38
+
39
+ # The method to set the value to target_screen
40
+ # @param target_screen [Screen] An instance of Screen
41
+
42
+ def tarscreen=(target_screen)
43
+ if target_screen!=nil and !target_screen.is_a? Screen
44
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: target_screen EXPECTED TYPE: Screen', nil, nil)
45
+ end
46
+ @target_screen = target_screen
47
+ @key_modified['target_screen'] = 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,119 @@
1
+ require_relative '../layouts/layout'
2
+ require_relative '../util/model'
3
+
4
+ module Wizards
5
+ class Container
6
+ include Util::Model
7
+
8
+ # Creates an instance of Container
9
+ def initialize
10
+ @id = nil
11
+ @layout = nil
12
+ @chart_data = nil
13
+ @screens = nil
14
+ @key_modified = Hash.new
15
+ end
16
+
17
+ # The method to get the id
18
+ # @return A Integer value
19
+
20
+ def id
21
+ @id
22
+ end
23
+
24
+ # The method to set the value to id
25
+ # @param id [Integer] A Integer
26
+
27
+ def id=(id)
28
+ if id!=nil and !id.is_a? Integer
29
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
30
+ end
31
+ @id = id
32
+ @key_modified['id'] = 1
33
+ end
34
+
35
+ # The method to get the layout
36
+ # @return An instance of Layouts::Layout
37
+
38
+ def layout
39
+ @layout
40
+ end
41
+
42
+ # The method to set the value to layout
43
+ # @param layout [Layouts::Layout] An instance of Layouts::Layout
44
+
45
+ def layout=(layout)
46
+ if layout!=nil and !layout.is_a? Layouts::Layout
47
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', nil, nil)
48
+ end
49
+ @layout = layout
50
+ @key_modified['layout'] = 1
51
+ end
52
+
53
+ # The method to get the chart_data
54
+ # @return An instance of ChartData
55
+
56
+ def chart_data
57
+ @chart_data
58
+ end
59
+
60
+ # The method to set the value to chart_data
61
+ # @param chart_data [ChartData] An instance of ChartData
62
+
63
+ def chart_data=(chart_data)
64
+ if chart_data!=nil and !chart_data.is_a? ChartData
65
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: chart_data EXPECTED TYPE: ChartData', nil, nil)
66
+ end
67
+ @chart_data = chart_data
68
+ @key_modified['chart_data'] = 1
69
+ end
70
+
71
+ # The method to get the screens
72
+ # @return An instance of Array
73
+
74
+ def screens
75
+ @screens
76
+ end
77
+
78
+ # The method to set the value to screens
79
+ # @param screens [Array] An instance of Array
80
+
81
+ def screens=(screens)
82
+ if screens!=nil and !screens.is_a? Array
83
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: screens EXPECTED TYPE: Array', nil, nil)
84
+ end
85
+ @screens = screens
86
+ @key_modified['screens'] = 1
87
+ end
88
+
89
+ # The method to check if the user has modified the given key
90
+ # @param key [String] A String
91
+ # @return A Integer value
92
+
93
+ def is_key_modified(key)
94
+ if key!=nil and !key.is_a? String
95
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
96
+ end
97
+ if @key_modified.key?(key)
98
+ return @key_modified[key]
99
+ end
100
+
101
+ nil
102
+ end
103
+
104
+ # The method to mark the given key as modified
105
+ # @param key [String] A String
106
+ # @param modification [Integer] A Integer
107
+
108
+ def set_key_modified(key, modification)
109
+ if key!=nil and !key.is_a? String
110
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
111
+ end
112
+ if modification!=nil and !modification.is_a? Integer
113
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
114
+ end
115
+ @key_modified[key] = modification
116
+ end
117
+
118
+ end
119
+ end
@@ -0,0 +1,118 @@
1
+ require_relative '../util/model'
2
+
3
+ module Wizards
4
+ class Node
5
+ include Util::Model
6
+
7
+ # Creates an instance of Node
8
+ def initialize
9
+ @pos_y = nil
10
+ @pos_x = nil
11
+ @start_node = nil
12
+ @screen = nil
13
+ @key_modified = Hash.new
14
+ end
15
+
16
+ # The method to get the pos_y
17
+ # @return A Integer value
18
+
19
+ def pos_y
20
+ @pos_y
21
+ end
22
+
23
+ # The method to set the value to pos_y
24
+ # @param pos_y [Integer] A Integer
25
+
26
+ def pos_y=(pos_y)
27
+ if pos_y!=nil and !pos_y.is_a? Integer
28
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pos_y EXPECTED TYPE: Integer', nil, nil)
29
+ end
30
+ @pos_y = pos_y
31
+ @key_modified['pos_y'] = 1
32
+ end
33
+
34
+ # The method to get the pos_x
35
+ # @return A Integer value
36
+
37
+ def pos_x
38
+ @pos_x
39
+ end
40
+
41
+ # The method to set the value to pos_x
42
+ # @param pos_x [Integer] A Integer
43
+
44
+ def pos_x=(pos_x)
45
+ if pos_x!=nil and !pos_x.is_a? Integer
46
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pos_x EXPECTED TYPE: Integer', nil, nil)
47
+ end
48
+ @pos_x = pos_x
49
+ @key_modified['pos_x'] = 1
50
+ end
51
+
52
+ # The method to get the start_node
53
+ # @return A Boolean value
54
+
55
+ def start_node
56
+ @start_node
57
+ end
58
+
59
+ # The method to set the value to start_node
60
+ # @param start_node [Boolean] A Boolean
61
+
62
+ def start_node=(start_node)
63
+ if start_node!=nil and ! [true, false].include?start_node
64
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: start_node EXPECTED TYPE: Boolean', nil, nil)
65
+ end
66
+ @start_node = start_node
67
+ @key_modified['start_node'] = 1
68
+ end
69
+
70
+ # The method to get the screen
71
+ # @return An instance of Screen
72
+
73
+ def screen
74
+ @screen
75
+ end
76
+
77
+ # The method to set the value to screen
78
+ # @param screen [Screen] An instance of Screen
79
+
80
+ def screen=(screen)
81
+ if screen!=nil and !screen.is_a? Screen
82
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: screen EXPECTED TYPE: Screen', nil, nil)
83
+ end
84
+ @screen = screen
85
+ @key_modified['screen'] = 1
86
+ end
87
+
88
+ # The method to check if the user has modified the given key
89
+ # @param key [String] A String
90
+ # @return A Integer value
91
+
92
+ def is_key_modified(key)
93
+ if key!=nil and !key.is_a? String
94
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
95
+ end
96
+ if @key_modified.key?(key)
97
+ return @key_modified[key]
98
+ end
99
+
100
+ nil
101
+ end
102
+
103
+ # The method to mark the given key as modified
104
+ # @param key [String] A String
105
+ # @param modification [Integer] A Integer
106
+
107
+ def set_key_modified(key, modification)
108
+ if key!=nil and !key.is_a? String
109
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
110
+ end
111
+ if modification!=nil and !modification.is_a? Integer
112
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
113
+ end
114
+ @key_modified[key] = modification
115
+ end
116
+
117
+ end
118
+ end
@@ -0,0 +1,10 @@
1
+ module Wizards
2
+ module ResponseHandler
3
+
4
+ # Creates an instance of ResponseHandler
5
+ def initialize
6
+ end
7
+
8
+
9
+ end
10
+ end
@@ -0,0 +1,63 @@
1
+ require_relative '../util/model'
2
+
3
+ module Wizards
4
+ require_relative 'response_handler'
5
+ class ResponseWrapper
6
+ include Util::Model
7
+ include ResponseHandler
8
+
9
+ # Creates an instance of ResponseWrapper
10
+ def initialize
11
+ @wizards = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the wizards
16
+ # @return An instance of Array
17
+
18
+ def wizards
19
+ @wizards
20
+ end
21
+
22
+ # The method to set the value to wizards
23
+ # @param wizards [Array] An instance of Array
24
+
25
+ def wizards=(wizards)
26
+ if wizards!=nil and !wizards.is_a? Array
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: wizards EXPECTED TYPE: Array', nil, nil)
28
+ end
29
+ @wizards = wizards
30
+ @key_modified['wizards'] = 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,99 @@
1
+ require_relative '../util/model'
2
+
3
+ module Wizards
4
+ class Screen
5
+ include Util::Model
6
+
7
+ # Creates an instance of Screen
8
+ def initialize
9
+ @id = nil
10
+ @display_label = nil
11
+ @segments = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the id
16
+ # @return A Integer value
17
+
18
+ def id
19
+ @id
20
+ end
21
+
22
+ # The method to set the value to id
23
+ # @param id [Integer] A Integer
24
+
25
+ def id=(id)
26
+ if id!=nil and !id.is_a? Integer
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
28
+ end
29
+ @id = id
30
+ @key_modified['id'] = 1
31
+ end
32
+
33
+ # The method to get the display_label
34
+ # @return A String value
35
+
36
+ def display_label
37
+ @display_label
38
+ end
39
+
40
+ # The method to set the value to display_label
41
+ # @param display_label [String] A String
42
+
43
+ def display_label=(display_label)
44
+ if display_label!=nil and !display_label.is_a? String
45
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
46
+ end
47
+ @display_label = display_label
48
+ @key_modified['display_label'] = 1
49
+ end
50
+
51
+ # The method to get the segments
52
+ # @return An instance of Array
53
+
54
+ def segments
55
+ @segments
56
+ end
57
+
58
+ # The method to set the value to segments
59
+ # @param segments [Array] An instance of Array
60
+
61
+ def segments=(segments)
62
+ if segments!=nil and !segments.is_a? Array
63
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: segments EXPECTED TYPE: Array', nil, nil)
64
+ end
65
+ @segments = segments
66
+ @key_modified['segments'] = 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