ZCRMSDK 2.0.0 → 3.0.0.beta
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/src/ZCRMSDK.rb +84 -1
- data/src/com/zoho/api/authenticator/oauth_token.rb +87 -31
- data/src/com/zoho/api/authenticator/store/db_store.rb +48 -28
- data/src/com/zoho/api/authenticator/store/file_store.rb +69 -21
- data/src/com/zoho/api/authenticator/store/token_store.rb +7 -0
- data/src/com/zoho/api/logger/sdk_logger.rb +18 -9
- data/src/com/zoho/crm/api/assignment_rules/api_exception.rb +121 -0
- data/src/com/zoho/crm/api/assignment_rules/assignment_rule.rb +215 -0
- data/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.rb +61 -0
- data/src/com/zoho/crm/api/assignment_rules/default_user.rb +80 -0
- data/src/com/zoho/crm/api/assignment_rules/response_handler.rb +10 -0
- data/src/com/zoho/crm/api/assignment_rules/response_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/attachments/attachment.rb +4 -4
- data/src/com/zoho/crm/api/attachments/attachments_operations.rb +6 -6
- data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb +2 -2
- data/src/com/zoho/crm/api/blue_print/escalation.rb +80 -0
- data/src/com/zoho/crm/api/blue_print/field.rb +1107 -0
- data/src/com/zoho/crm/api/blue_print/next_transition.rb +38 -0
- data/src/com/zoho/crm/api/blue_print/process_info.rb +4 -4
- data/src/com/zoho/crm/api/blue_print/transition.rb +19 -1
- data/src/com/zoho/crm/api/blue_print/validation_error.rb +57 -0
- data/src/com/zoho/crm/api/bulk_read/bulk_read_operations.rb +3 -3
- data/src/com/zoho/crm/api/bulk_read/criteria.rb +20 -0
- data/src/com/zoho/crm/api/bulk_read/query.rb +5 -4
- data/src/com/zoho/crm/api/bulk_write/bulk_write_operations.rb +3 -3
- data/src/com/zoho/crm/api/bulk_write/resource.rb +24 -4
- data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb +7 -7
- data/src/com/zoho/crm/api/currencies/currencies_operations.rb +7 -7
- data/src/com/zoho/crm/api/custom_views/criteria.rb +5 -4
- data/src/com/zoho/crm/api/custom_views/custom_view.rb +100 -41
- data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb +2 -2
- data/src/com/zoho/crm/api/custom_views/{shared_details.rb → shared_to.rb} +2 -2
- data/src/com/zoho/crm/api/dc/au_datacenter.rb +3 -3
- data/src/com/zoho/crm/api/dc/cn_datacenter.rb +3 -3
- data/src/com/zoho/crm/api/dc/datacenter.rb +3 -2
- data/src/com/zoho/crm/api/dc/eu_datacenter.rb +3 -3
- data/src/com/zoho/crm/api/dc/in_datacenter.rb +3 -3
- data/src/com/zoho/crm/api/dc/us_datacenter.rb +3 -3
- data/src/com/zoho/crm/api/email_templates/api_exception.rb +121 -0
- data/src/com/zoho/crm/api/email_templates/attachment.rb +118 -0
- data/src/com/zoho/crm/api/email_templates/email_template.rb +390 -0
- data/src/com/zoho/crm/api/email_templates/email_templates_operations.rb +61 -0
- data/src/com/zoho/crm/api/email_templates/response_handler.rb +10 -0
- data/src/com/zoho/crm/api/email_templates/response_wrapper.rb +83 -0
- data/src/com/zoho/crm/api/field_attachments/api_exception.rb +121 -0
- data/src/com/zoho/crm/api/field_attachments/body_wrapper.rb +62 -0
- data/src/com/zoho/crm/api/field_attachments/field_attachments_operations.rb +52 -0
- data/src/com/zoho/crm/api/field_attachments/file_body_wrapper.rb +64 -0
- data/src/com/zoho/crm/api/field_attachments/response_handler.rb +10 -0
- data/src/com/zoho/crm/api/fields/external.rb +99 -0
- data/src/com/zoho/crm/api/fields/field.rb +192 -38
- data/src/com/zoho/crm/api/fields/fields_operations.rb +2 -2
- data/src/com/zoho/crm/api/fields/history_tracking.rb +80 -0
- data/src/com/zoho/crm/api/fields/maps.rb +80 -0
- data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +19 -0
- data/src/com/zoho/crm/api/fields/multi_user_lookup.rb +175 -0
- data/src/com/zoho/crm/api/fields/pick_list_value.rb +19 -0
- data/src/com/zoho/crm/api/fields/related_details.rb +19 -0
- data/src/com/zoho/crm/api/files/file_operations.rb +2 -2
- data/src/com/zoho/crm/api/initializer.rb +41 -16
- data/src/com/zoho/crm/api/inventory_templates/api_exception.rb +121 -0
- data/src/com/zoho/crm/api/inventory_templates/inventory_template.rb +352 -0
- data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb +82 -0
- data/src/com/zoho/crm/api/inventory_templates/response_handler.rb +10 -0
- data/src/com/zoho/crm/api/inventory_templates/response_wrapper.rb +83 -0
- data/src/com/zoho/crm/api/layouts/layout.rb +38 -0
- data/src/com/zoho/crm/api/layouts/layouts_operations.rb +2 -2
- data/src/com/zoho/crm/api/layouts/section.rb +19 -0
- data/src/com/zoho/crm/api/modules/module.rb +57 -0
- data/src/com/zoho/crm/api/modules/modules_operations.rb +4 -4
- data/src/com/zoho/crm/api/notes/notes_operations.rb +7 -7
- data/src/com/zoho/crm/api/notification/notification_operations.rb +6 -6
- data/src/com/zoho/crm/api/org/org_operations.rb +2 -2
- data/src/com/zoho/crm/api/pipeline/action_handler.rb +10 -0
- data/src/com/zoho/crm/api/pipeline/action_response.rb +10 -0
- data/src/com/zoho/crm/api/pipeline/action_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/pipeline/api_exception.rb +129 -0
- data/src/com/zoho/crm/api/pipeline/body_wrapper.rb +61 -0
- data/src/com/zoho/crm/api/pipeline/forecast_category.rb +80 -0
- data/src/com/zoho/crm/api/pipeline/pick_list_value.rb +175 -0
- data/src/com/zoho/crm/api/pipeline/pipeline.rb +213 -0
- data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb +165 -0
- data/src/com/zoho/crm/api/pipeline/response_handler.rb +10 -0
- data/src/com/zoho/crm/api/pipeline/response_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/pipeline/stage.rb +80 -0
- data/src/com/zoho/crm/api/pipeline/success_response.rb +123 -0
- data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb +10 -0
- data/src/com/zoho/crm/api/pipeline/transfer_action_response.rb +10 -0
- data/src/com/zoho/crm/api/pipeline/transfer_action_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/pipeline/transfer_and_delete_wrapper.rb +61 -0
- data/src/com/zoho/crm/api/pipeline/transfer_pipe_line.rb +80 -0
- data/src/com/zoho/crm/api/profiles/default_view.rb +99 -0
- data/src/com/zoho/crm/api/profiles/profile.rb +57 -0
- data/src/com/zoho/crm/api/profiles/profiles_operations.rb +2 -2
- data/src/com/zoho/crm/api/query/query_operations.rb +1 -1
- data/src/com/zoho/crm/api/record/api_exception.rb +2 -0
- data/src/com/zoho/crm/api/record/body_wrapper.rb +0 -19
- data/src/com/zoho/crm/api/record/count_handler.rb +10 -0
- data/src/com/zoho/crm/api/record/count_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/record/field.rb +1 -0
- data/src/com/zoho/crm/api/record/image_upload.rb +213 -0
- data/src/com/zoho/crm/api/record/inventory_line_items.rb +56 -39
- data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +4 -4
- data/src/com/zoho/crm/api/record/mass_update_territory.rb +80 -0
- data/src/com/zoho/crm/api/record/multi_select_lookup.rb +99 -0
- data/src/com/zoho/crm/api/record/multi_select_picklist.rb +80 -0
- data/src/com/zoho/crm/api/record/price_book.rb +31 -0
- data/src/com/zoho/crm/api/record/record_operations.rb +196 -26
- data/src/com/zoho/crm/api/record/tax.rb +80 -0
- data/src/com/zoho/crm/api/record/territory.rb +70 -12
- data/src/com/zoho/crm/api/record/widget.rb +80 -0
- data/src/com/zoho/crm/api/record/wizard.rb +80 -0
- data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +2 -2
- data/src/com/zoho/crm/api/related_records/related_records_operations.rb +6 -6
- data/src/com/zoho/crm/api/request_proxy.rb +3 -4
- data/src/com/zoho/crm/api/roles/roles_operations.rb +2 -2
- data/src/com/zoho/crm/api/sdk_config.rb +2 -68
- data/src/com/zoho/crm/api/send_mail/action_handler.rb +10 -0
- data/src/com/zoho/crm/api/send_mail/action_response.rb +10 -0
- data/src/com/zoho/crm/api/send_mail/action_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/send_mail/api_exception.rb +125 -0
- data/src/com/zoho/crm/api/send_mail/body_wrapper.rb +61 -0
- data/src/com/zoho/crm/api/send_mail/data_subject_request.rb +80 -0
- data/src/com/zoho/crm/api/send_mail/inventory_details.rb +100 -0
- data/src/com/zoho/crm/api/send_mail/mail.rb +423 -0
- data/src/com/zoho/crm/api/send_mail/response_handler.rb +10 -0
- data/src/com/zoho/crm/api/send_mail/response_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb +61 -0
- data/src/com/zoho/crm/api/send_mail/success_response.rb +121 -0
- data/src/com/zoho/crm/api/send_mail/template.rb +10 -0
- data/src/com/zoho/crm/api/send_mail/user_address.rb +137 -0
- data/src/com/zoho/crm/api/share_records/share_records_operations.rb +4 -4
- data/src/com/zoho/crm/api/tags/tag.rb +19 -0
- data/src/com/zoho/crm/api/tags/tags_operations.rb +11 -11
- data/src/com/zoho/crm/api/taxes/taxes_operations.rb +6 -6
- data/src/com/zoho/crm/api/territories/response_wrapper.rb +20 -0
- data/src/com/zoho/crm/api/territories/territories_operations.rb +2 -2
- data/src/com/zoho/crm/api/territories/territory.rb +61 -23
- data/src/com/zoho/crm/api/users/users_operations.rb +6 -6
- data/src/com/zoho/crm/api/util/api_http_connector.rb +5 -4
- data/src/com/zoho/crm/api/util/constants.rb +140 -13
- data/src/com/zoho/crm/api/util/converter.rb +21 -4
- data/src/com/zoho/crm/api/util/form_data_converter.rb +3 -14
- data/src/com/zoho/crm/api/util/utility.rb +226 -70
- data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +3 -3
- data/src/com/zoho/crm/api/variables/variables_operations.rb +9 -9
- data/src/com/zoho/crm/api/wizards/api_exception.rb +121 -0
- data/src/com/zoho/crm/api/wizards/button.rb +214 -0
- data/src/com/zoho/crm/api/wizards/chart_data.rb +118 -0
- data/src/com/zoho/crm/api/wizards/connection.rb +80 -0
- data/src/com/zoho/crm/api/wizards/container.rb +119 -0
- data/src/com/zoho/crm/api/wizards/node.rb +118 -0
- data/src/com/zoho/crm/api/wizards/response_handler.rb +10 -0
- data/src/com/zoho/crm/api/wizards/response_wrapper.rb +63 -0
- data/src/com/zoho/crm/api/wizards/screen.rb +99 -0
- data/src/com/zoho/crm/api/wizards/segment.rb +176 -0
- data/src/com/zoho/crm/api/wizards/wizard.rb +273 -0
- data/src/com/zoho/crm/api/wizards/wizards_operations.rb +61 -0
- data/src/resources/JSONDetails.json +1 -1
- data/src/version.rb +1 -1
- metadata +88 -5
@@ -16,7 +16,7 @@ module VariableGroups
|
|
16
16
|
def get_variable_groups
|
17
17
|
handler_instance = Handler::CommonAPIHandler.new
|
18
18
|
api_path = ''
|
19
|
-
api_path = api_path + '/crm/v2/settings/variable_groups'
|
19
|
+
api_path = api_path + '/crm/v2.1/settings/variable_groups'
|
20
20
|
handler_instance.api_path = api_path
|
21
21
|
handler_instance.http_method = Constants::REQUEST_METHOD_GET
|
22
22
|
handler_instance.category_method = 'READ'
|
@@ -34,7 +34,7 @@ module VariableGroups
|
|
34
34
|
end
|
35
35
|
handler_instance = Handler::CommonAPIHandler.new
|
36
36
|
api_path = ''
|
37
|
-
api_path = api_path + '/crm/v2/settings/variable_groups/'
|
37
|
+
api_path = api_path + '/crm/v2.1/settings/variable_groups/'
|
38
38
|
api_path = api_path + id.to_s
|
39
39
|
handler_instance.api_path = api_path
|
40
40
|
handler_instance.http_method = Constants::REQUEST_METHOD_GET
|
@@ -53,7 +53,7 @@ module VariableGroups
|
|
53
53
|
end
|
54
54
|
handler_instance = Handler::CommonAPIHandler.new
|
55
55
|
api_path = ''
|
56
|
-
api_path = api_path + '/crm/v2/settings/variable_groups/'
|
56
|
+
api_path = api_path + '/crm/v2.1/settings/variable_groups/'
|
57
57
|
api_path = api_path + api_name.to_s
|
58
58
|
handler_instance.api_path = api_path
|
59
59
|
handler_instance.http_method = Constants::REQUEST_METHOD_GET
|
@@ -22,7 +22,7 @@ module Variables
|
|
22
22
|
end
|
23
23
|
handler_instance = Handler::CommonAPIHandler.new
|
24
24
|
api_path = ''
|
25
|
-
api_path = api_path + '/crm/v2/settings/variables'
|
25
|
+
api_path = api_path + '/crm/v2.1/settings/variables'
|
26
26
|
handler_instance.api_path = api_path
|
27
27
|
handler_instance.http_method = Constants::REQUEST_METHOD_GET
|
28
28
|
handler_instance.category_method = 'READ'
|
@@ -41,7 +41,7 @@ module Variables
|
|
41
41
|
end
|
42
42
|
handler_instance = Handler::CommonAPIHandler.new
|
43
43
|
api_path = ''
|
44
|
-
api_path = api_path + '/crm/v2/settings/variables'
|
44
|
+
api_path = api_path + '/crm/v2.1/settings/variables'
|
45
45
|
handler_instance.api_path = api_path
|
46
46
|
handler_instance.http_method = Constants::REQUEST_METHOD_POST
|
47
47
|
handler_instance.category_method = 'CREATE'
|
@@ -62,7 +62,7 @@ module Variables
|
|
62
62
|
end
|
63
63
|
handler_instance = Handler::CommonAPIHandler.new
|
64
64
|
api_path = ''
|
65
|
-
api_path = api_path + '/crm/v2/settings/variables'
|
65
|
+
api_path = api_path + '/crm/v2.1/settings/variables'
|
66
66
|
handler_instance.api_path = api_path
|
67
67
|
handler_instance.http_method = Constants::REQUEST_METHOD_PUT
|
68
68
|
handler_instance.category_method = 'UPDATE'
|
@@ -83,7 +83,7 @@ module Variables
|
|
83
83
|
end
|
84
84
|
handler_instance = Handler::CommonAPIHandler.new
|
85
85
|
api_path = ''
|
86
|
-
api_path = api_path + '/crm/v2/settings/variables'
|
86
|
+
api_path = api_path + '/crm/v2.1/settings/variables'
|
87
87
|
handler_instance.api_path = api_path
|
88
88
|
handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
|
89
89
|
handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
|
@@ -106,7 +106,7 @@ module Variables
|
|
106
106
|
end
|
107
107
|
handler_instance = Handler::CommonAPIHandler.new
|
108
108
|
api_path = ''
|
109
|
-
api_path = api_path + '/crm/v2/settings/variables/'
|
109
|
+
api_path = api_path + '/crm/v2.1/settings/variables/'
|
110
110
|
api_path = api_path + id.to_s
|
111
111
|
handler_instance.api_path = api_path
|
112
112
|
handler_instance.http_method = Constants::REQUEST_METHOD_GET
|
@@ -130,7 +130,7 @@ module Variables
|
|
130
130
|
end
|
131
131
|
handler_instance = Handler::CommonAPIHandler.new
|
132
132
|
api_path = ''
|
133
|
-
api_path = api_path + '/crm/v2/settings/variables/'
|
133
|
+
api_path = api_path + '/crm/v2.1/settings/variables/'
|
134
134
|
api_path = api_path + id.to_s
|
135
135
|
handler_instance.api_path = api_path
|
136
136
|
handler_instance.http_method = Constants::REQUEST_METHOD_PUT
|
@@ -151,7 +151,7 @@ module Variables
|
|
151
151
|
end
|
152
152
|
handler_instance = Handler::CommonAPIHandler.new
|
153
153
|
api_path = ''
|
154
|
-
api_path = api_path + '/crm/v2/settings/variables/'
|
154
|
+
api_path = api_path + '/crm/v2.1/settings/variables/'
|
155
155
|
api_path = api_path + id.to_s
|
156
156
|
handler_instance.api_path = api_path
|
157
157
|
handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
|
@@ -174,7 +174,7 @@ module Variables
|
|
174
174
|
end
|
175
175
|
handler_instance = Handler::CommonAPIHandler.new
|
176
176
|
api_path = ''
|
177
|
-
api_path = api_path + '/crm/v2/settings/variables/'
|
177
|
+
api_path = api_path + '/crm/v2.1/settings/variables/'
|
178
178
|
api_path = api_path + api_name.to_s
|
179
179
|
handler_instance.api_path = api_path
|
180
180
|
handler_instance.http_method = Constants::REQUEST_METHOD_GET
|
@@ -198,7 +198,7 @@ module Variables
|
|
198
198
|
end
|
199
199
|
handler_instance = Handler::CommonAPIHandler.new
|
200
200
|
api_path = ''
|
201
|
-
api_path = api_path + '/crm/v2/settings/variables/'
|
201
|
+
api_path = api_path + '/crm/v2.1/settings/variables/'
|
202
202
|
api_path = api_path + api_name.to_s
|
203
203
|
handler_instance.api_path = api_path
|
204
204
|
handler_instance.http_method = Constants::REQUEST_METHOD_PUT
|
@@ -0,0 +1,121 @@
|
|
1
|
+
require_relative '../util/choice'
|
2
|
+
require_relative '../util/model'
|
3
|
+
|
4
|
+
module Wizards
|
5
|
+
require_relative 'response_handler'
|
6
|
+
class APIException
|
7
|
+
include Util::Model
|
8
|
+
include ResponseHandler
|
9
|
+
|
10
|
+
# Creates an instance of APIException
|
11
|
+
def initialize
|
12
|
+
@code = nil
|
13
|
+
@status = nil
|
14
|
+
@message = nil
|
15
|
+
@details = nil
|
16
|
+
@key_modified = Hash.new
|
17
|
+
end
|
18
|
+
|
19
|
+
# The method to get the code
|
20
|
+
# @return An instance of Util::Choice
|
21
|
+
|
22
|
+
def code
|
23
|
+
@code
|
24
|
+
end
|
25
|
+
|
26
|
+
# The method to set the value to code
|
27
|
+
# @param code [Util::Choice] An instance of Util::Choice
|
28
|
+
|
29
|
+
def code=(code)
|
30
|
+
if code!=nil and !code.is_a? Util::Choice
|
31
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
|
32
|
+
end
|
33
|
+
@code = code
|
34
|
+
@key_modified['code'] = 1
|
35
|
+
end
|
36
|
+
|
37
|
+
# The method to get the status
|
38
|
+
# @return An instance of Util::Choice
|
39
|
+
|
40
|
+
def status
|
41
|
+
@status
|
42
|
+
end
|
43
|
+
|
44
|
+
# The method to set the value to status
|
45
|
+
# @param status [Util::Choice] An instance of Util::Choice
|
46
|
+
|
47
|
+
def status=(status)
|
48
|
+
if status!=nil and !status.is_a? Util::Choice
|
49
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
|
50
|
+
end
|
51
|
+
@status = status
|
52
|
+
@key_modified['status'] = 1
|
53
|
+
end
|
54
|
+
|
55
|
+
# The method to get the message
|
56
|
+
# @return An instance of Util::Choice
|
57
|
+
|
58
|
+
def message
|
59
|
+
@message
|
60
|
+
end
|
61
|
+
|
62
|
+
# The method to set the value to message
|
63
|
+
# @param message [Util::Choice] An instance of Util::Choice
|
64
|
+
|
65
|
+
def message=(message)
|
66
|
+
if message!=nil and !message.is_a? Util::Choice
|
67
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
|
68
|
+
end
|
69
|
+
@message = message
|
70
|
+
@key_modified['message'] = 1
|
71
|
+
end
|
72
|
+
|
73
|
+
# The method to get the details
|
74
|
+
# @return An instance of Hash
|
75
|
+
|
76
|
+
def details
|
77
|
+
@details
|
78
|
+
end
|
79
|
+
|
80
|
+
# The method to set the value to details
|
81
|
+
# @param details [Hash] An instance of Hash
|
82
|
+
|
83
|
+
def details=(details)
|
84
|
+
if details!=nil and !details.is_a? Hash
|
85
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
|
86
|
+
end
|
87
|
+
@details = details
|
88
|
+
@key_modified['details'] = 1
|
89
|
+
end
|
90
|
+
|
91
|
+
# The method to check if the user has modified the given key
|
92
|
+
# @param key [String] A String
|
93
|
+
# @return A Integer value
|
94
|
+
|
95
|
+
def is_key_modified(key)
|
96
|
+
if key!=nil and !key.is_a? String
|
97
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
|
98
|
+
end
|
99
|
+
if @key_modified.key?(key)
|
100
|
+
return @key_modified[key]
|
101
|
+
end
|
102
|
+
|
103
|
+
nil
|
104
|
+
end
|
105
|
+
|
106
|
+
# The method to mark the given key as modified
|
107
|
+
# @param key [String] A String
|
108
|
+
# @param modification [Integer] A Integer
|
109
|
+
|
110
|
+
def set_key_modified(key, modification)
|
111
|
+
if key!=nil and !key.is_a? String
|
112
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
|
113
|
+
end
|
114
|
+
if modification!=nil and !modification.is_a? Integer
|
115
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
|
116
|
+
end
|
117
|
+
@key_modified[key] = modification
|
118
|
+
end
|
119
|
+
|
120
|
+
end
|
121
|
+
end
|
@@ -0,0 +1,214 @@
|
|
1
|
+
require_relative '../custom_views/criteria'
|
2
|
+
require_relative '../util/model'
|
3
|
+
|
4
|
+
module Wizards
|
5
|
+
class Button
|
6
|
+
include Util::Model
|
7
|
+
|
8
|
+
# Creates an instance of Button
|
9
|
+
def initialize
|
10
|
+
@id = nil
|
11
|
+
@sequence_number = nil
|
12
|
+
@display_label = nil
|
13
|
+
@criteria = nil
|
14
|
+
@target_screen = nil
|
15
|
+
@type = nil
|
16
|
+
@color = nil
|
17
|
+
@shape = nil
|
18
|
+
@background_color = nil
|
19
|
+
@key_modified = Hash.new
|
20
|
+
end
|
21
|
+
|
22
|
+
# The method to get the id
|
23
|
+
# @return A Integer value
|
24
|
+
|
25
|
+
def id
|
26
|
+
@id
|
27
|
+
end
|
28
|
+
|
29
|
+
# The method to set the value to id
|
30
|
+
# @param id [Integer] A Integer
|
31
|
+
|
32
|
+
def id=(id)
|
33
|
+
if id!=nil and !id.is_a? Integer
|
34
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
|
35
|
+
end
|
36
|
+
@id = id
|
37
|
+
@key_modified['id'] = 1
|
38
|
+
end
|
39
|
+
|
40
|
+
# The method to get the sequence_number
|
41
|
+
# @return A Integer value
|
42
|
+
|
43
|
+
def sequence_number
|
44
|
+
@sequence_number
|
45
|
+
end
|
46
|
+
|
47
|
+
# The method to set the value to sequence_number
|
48
|
+
# @param sequence_number [Integer] A Integer
|
49
|
+
|
50
|
+
def sequence_number=(sequence_number)
|
51
|
+
if sequence_number!=nil and !sequence_number.is_a? Integer
|
52
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: Integer', nil, nil)
|
53
|
+
end
|
54
|
+
@sequence_number = sequence_number
|
55
|
+
@key_modified['sequence_number'] = 1
|
56
|
+
end
|
57
|
+
|
58
|
+
# The method to get the display_label
|
59
|
+
# @return A String value
|
60
|
+
|
61
|
+
def display_label
|
62
|
+
@display_label
|
63
|
+
end
|
64
|
+
|
65
|
+
# The method to set the value to display_label
|
66
|
+
# @param display_label [String] A String
|
67
|
+
|
68
|
+
def display_label=(display_label)
|
69
|
+
if display_label!=nil and !display_label.is_a? String
|
70
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
|
71
|
+
end
|
72
|
+
@display_label = display_label
|
73
|
+
@key_modified['display_label'] = 1
|
74
|
+
end
|
75
|
+
|
76
|
+
# The method to get the criteria
|
77
|
+
# @return An instance of CustomViews::Criteria
|
78
|
+
|
79
|
+
def criteria
|
80
|
+
@criteria
|
81
|
+
end
|
82
|
+
|
83
|
+
# The method to set the value to criteria
|
84
|
+
# @param criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
|
85
|
+
|
86
|
+
def criteria=(criteria)
|
87
|
+
if criteria!=nil and !criteria.is_a? CustomViews::Criteria
|
88
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
|
89
|
+
end
|
90
|
+
@criteria = criteria
|
91
|
+
@key_modified['criteria'] = 1
|
92
|
+
end
|
93
|
+
|
94
|
+
# The method to get the target_screen
|
95
|
+
# @return An instance of Screen
|
96
|
+
|
97
|
+
def tarscreen
|
98
|
+
@target_screen
|
99
|
+
end
|
100
|
+
|
101
|
+
# The method to set the value to target_screen
|
102
|
+
# @param target_screen [Screen] An instance of Screen
|
103
|
+
|
104
|
+
def tarscreen=(target_screen)
|
105
|
+
if target_screen!=nil and !target_screen.is_a? Screen
|
106
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: target_screen EXPECTED TYPE: Screen', nil, nil)
|
107
|
+
end
|
108
|
+
@target_screen = target_screen
|
109
|
+
@key_modified['target_screen'] = 1
|
110
|
+
end
|
111
|
+
|
112
|
+
# The method to get the type
|
113
|
+
# @return A String value
|
114
|
+
|
115
|
+
def type
|
116
|
+
@type
|
117
|
+
end
|
118
|
+
|
119
|
+
# The method to set the value to type
|
120
|
+
# @param type [String] A String
|
121
|
+
|
122
|
+
def type=(type)
|
123
|
+
if type!=nil and !type.is_a? String
|
124
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
|
125
|
+
end
|
126
|
+
@type = type
|
127
|
+
@key_modified['type'] = 1
|
128
|
+
end
|
129
|
+
|
130
|
+
# The method to get the color
|
131
|
+
# @return A String value
|
132
|
+
|
133
|
+
def color
|
134
|
+
@color
|
135
|
+
end
|
136
|
+
|
137
|
+
# The method to set the value to color
|
138
|
+
# @param color [String] A String
|
139
|
+
|
140
|
+
def color=(color)
|
141
|
+
if color!=nil and !color.is_a? String
|
142
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: String', nil, nil)
|
143
|
+
end
|
144
|
+
@color = color
|
145
|
+
@key_modified['color'] = 1
|
146
|
+
end
|
147
|
+
|
148
|
+
# The method to get the shape
|
149
|
+
# @return A String value
|
150
|
+
|
151
|
+
def shape
|
152
|
+
@shape
|
153
|
+
end
|
154
|
+
|
155
|
+
# The method to set the value to shape
|
156
|
+
# @param shape [String] A String
|
157
|
+
|
158
|
+
def shape=(shape)
|
159
|
+
if shape!=nil and !shape.is_a? String
|
160
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shape EXPECTED TYPE: String', nil, nil)
|
161
|
+
end
|
162
|
+
@shape = shape
|
163
|
+
@key_modified['shape'] = 1
|
164
|
+
end
|
165
|
+
|
166
|
+
# The method to get the background_color
|
167
|
+
# @return A String value
|
168
|
+
|
169
|
+
def background_color
|
170
|
+
@background_color
|
171
|
+
end
|
172
|
+
|
173
|
+
# The method to set the value to background_color
|
174
|
+
# @param background_color [String] A String
|
175
|
+
|
176
|
+
def background_color=(background_color)
|
177
|
+
if background_color!=nil and !background_color.is_a? String
|
178
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: background_color EXPECTED TYPE: String', nil, nil)
|
179
|
+
end
|
180
|
+
@background_color = background_color
|
181
|
+
@key_modified['background_color'] = 1
|
182
|
+
end
|
183
|
+
|
184
|
+
# The method to check if the user has modified the given key
|
185
|
+
# @param key [String] A String
|
186
|
+
# @return A Integer value
|
187
|
+
|
188
|
+
def is_key_modified(key)
|
189
|
+
if key!=nil and !key.is_a? String
|
190
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
|
191
|
+
end
|
192
|
+
if @key_modified.key?(key)
|
193
|
+
return @key_modified[key]
|
194
|
+
end
|
195
|
+
|
196
|
+
nil
|
197
|
+
end
|
198
|
+
|
199
|
+
# The method to mark the given key as modified
|
200
|
+
# @param key [String] A String
|
201
|
+
# @param modification [Integer] A Integer
|
202
|
+
|
203
|
+
def set_key_modified(key, modification)
|
204
|
+
if key!=nil and !key.is_a? String
|
205
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
|
206
|
+
end
|
207
|
+
if modification!=nil and !modification.is_a? Integer
|
208
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
|
209
|
+
end
|
210
|
+
@key_modified[key] = modification
|
211
|
+
end
|
212
|
+
|
213
|
+
end
|
214
|
+
end
|
@@ -0,0 +1,118 @@
|
|
1
|
+
require_relative '../util/model'
|
2
|
+
|
3
|
+
module Wizards
|
4
|
+
class ChartData
|
5
|
+
include Util::Model
|
6
|
+
|
7
|
+
# Creates an instance of ChartData
|
8
|
+
def initialize
|
9
|
+
@nodes = nil
|
10
|
+
@connections = nil
|
11
|
+
@canvas_width = nil
|
12
|
+
@canvas_height = nil
|
13
|
+
@key_modified = Hash.new
|
14
|
+
end
|
15
|
+
|
16
|
+
# The method to get the nodes
|
17
|
+
# @return An instance of Array
|
18
|
+
|
19
|
+
def nodes
|
20
|
+
@nodes
|
21
|
+
end
|
22
|
+
|
23
|
+
# The method to set the value to nodes
|
24
|
+
# @param nodes [Array] An instance of Array
|
25
|
+
|
26
|
+
def nodes=(nodes)
|
27
|
+
if nodes!=nil and !nodes.is_a? Array
|
28
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: nodes EXPECTED TYPE: Array', nil, nil)
|
29
|
+
end
|
30
|
+
@nodes = nodes
|
31
|
+
@key_modified['nodes'] = 1
|
32
|
+
end
|
33
|
+
|
34
|
+
# The method to get the connections
|
35
|
+
# @return An instance of Array
|
36
|
+
|
37
|
+
def connections
|
38
|
+
@connections
|
39
|
+
end
|
40
|
+
|
41
|
+
# The method to set the value to connections
|
42
|
+
# @param connections [Array] An instance of Array
|
43
|
+
|
44
|
+
def connections=(connections)
|
45
|
+
if connections!=nil and !connections.is_a? Array
|
46
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: connections EXPECTED TYPE: Array', nil, nil)
|
47
|
+
end
|
48
|
+
@connections = connections
|
49
|
+
@key_modified['connections'] = 1
|
50
|
+
end
|
51
|
+
|
52
|
+
# The method to get the canvas_width
|
53
|
+
# @return A Integer value
|
54
|
+
|
55
|
+
def canvas_width
|
56
|
+
@canvas_width
|
57
|
+
end
|
58
|
+
|
59
|
+
# The method to set the value to canvas_width
|
60
|
+
# @param canvas_width [Integer] A Integer
|
61
|
+
|
62
|
+
def canvas_width=(canvas_width)
|
63
|
+
if canvas_width!=nil and !canvas_width.is_a? Integer
|
64
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: canvas_width EXPECTED TYPE: Integer', nil, nil)
|
65
|
+
end
|
66
|
+
@canvas_width = canvas_width
|
67
|
+
@key_modified['canvas_width'] = 1
|
68
|
+
end
|
69
|
+
|
70
|
+
# The method to get the canvas_height
|
71
|
+
# @return A Integer value
|
72
|
+
|
73
|
+
def canvas_height
|
74
|
+
@canvas_height
|
75
|
+
end
|
76
|
+
|
77
|
+
# The method to set the value to canvas_height
|
78
|
+
# @param canvas_height [Integer] A Integer
|
79
|
+
|
80
|
+
def canvas_height=(canvas_height)
|
81
|
+
if canvas_height!=nil and !canvas_height.is_a? Integer
|
82
|
+
raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: canvas_height EXPECTED TYPE: Integer', nil, nil)
|
83
|
+
end
|
84
|
+
@canvas_height = canvas_height
|
85
|
+
@key_modified['canvas_height'] = 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
|