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.
Files changed (162) 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 +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 +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 +41 -16
  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 +196 -26
  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 +6 -6
  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 -4
  142. data/src/com/zoho/crm/api/util/constants.rb +140 -13
  143. data/src/com/zoho/crm/api/util/converter.rb +21 -4
  144. data/src/com/zoho/crm/api/util/form_data_converter.rb +3 -14
  145. data/src/com/zoho/crm/api/util/utility.rb +226 -70
  146. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +3 -3
  147. data/src/com/zoho/crm/api/variables/variables_operations.rb +9 -9
  148. data/src/com/zoho/crm/api/wizards/api_exception.rb +121 -0
  149. data/src/com/zoho/crm/api/wizards/button.rb +214 -0
  150. data/src/com/zoho/crm/api/wizards/chart_data.rb +118 -0
  151. data/src/com/zoho/crm/api/wizards/connection.rb +80 -0
  152. data/src/com/zoho/crm/api/wizards/container.rb +119 -0
  153. data/src/com/zoho/crm/api/wizards/node.rb +118 -0
  154. data/src/com/zoho/crm/api/wizards/response_handler.rb +10 -0
  155. data/src/com/zoho/crm/api/wizards/response_wrapper.rb +63 -0
  156. data/src/com/zoho/crm/api/wizards/screen.rb +99 -0
  157. data/src/com/zoho/crm/api/wizards/segment.rb +176 -0
  158. data/src/com/zoho/crm/api/wizards/wizard.rb +273 -0
  159. data/src/com/zoho/crm/api/wizards/wizards_operations.rb +61 -0
  160. data/src/resources/JSONDetails.json +1 -1
  161. data/src/version.rb +1 -1
  162. metadata +88 -5
@@ -0,0 +1,176 @@
1
+ require_relative '../fields/field'
2
+ require_relative '../util/model'
3
+
4
+ module Wizards
5
+ class Segment
6
+ include Util::Model
7
+
8
+ # Creates an instance of Segment
9
+ def initialize
10
+ @id = nil
11
+ @sequence_number = nil
12
+ @display_label = nil
13
+ @type = nil
14
+ @column_count = nil
15
+ @fields = nil
16
+ @buttons = nil
17
+ @key_modified = Hash.new
18
+ end
19
+
20
+ # The method to get the id
21
+ # @return A Integer value
22
+
23
+ def id
24
+ @id
25
+ end
26
+
27
+ # The method to set the value to id
28
+ # @param id [Integer] A Integer
29
+
30
+ def id=(id)
31
+ if id!=nil and !id.is_a? Integer
32
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
33
+ end
34
+ @id = id
35
+ @key_modified['id'] = 1
36
+ end
37
+
38
+ # The method to get the sequence_number
39
+ # @return A Integer value
40
+
41
+ def sequence_number
42
+ @sequence_number
43
+ end
44
+
45
+ # The method to set the value to sequence_number
46
+ # @param sequence_number [Integer] A Integer
47
+
48
+ def sequence_number=(sequence_number)
49
+ if sequence_number!=nil and !sequence_number.is_a? Integer
50
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: Integer', nil, nil)
51
+ end
52
+ @sequence_number = sequence_number
53
+ @key_modified['sequence_number'] = 1
54
+ end
55
+
56
+ # The method to get the display_label
57
+ # @return A String value
58
+
59
+ def display_label
60
+ @display_label
61
+ end
62
+
63
+ # The method to set the value to display_label
64
+ # @param display_label [String] A String
65
+
66
+ def display_label=(display_label)
67
+ if display_label!=nil and !display_label.is_a? String
68
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
69
+ end
70
+ @display_label = display_label
71
+ @key_modified['display_label'] = 1
72
+ end
73
+
74
+ # The method to get the type
75
+ # @return A String value
76
+
77
+ def type
78
+ @type
79
+ end
80
+
81
+ # The method to set the value to type
82
+ # @param type [String] A String
83
+
84
+ def type=(type)
85
+ if type!=nil and !type.is_a? String
86
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
87
+ end
88
+ @type = type
89
+ @key_modified['type'] = 1
90
+ end
91
+
92
+ # The method to get the column_count
93
+ # @return A Integer value
94
+
95
+ def column_count
96
+ @column_count
97
+ end
98
+
99
+ # The method to set the value to column_count
100
+ # @param column_count [Integer] A Integer
101
+
102
+ def column_count=(column_count)
103
+ if column_count!=nil and !column_count.is_a? Integer
104
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column_count EXPECTED TYPE: Integer', nil, nil)
105
+ end
106
+ @column_count = column_count
107
+ @key_modified['column_count'] = 1
108
+ end
109
+
110
+ # The method to get the fields
111
+ # @return An instance of Array
112
+
113
+ def fields
114
+ @fields
115
+ end
116
+
117
+ # The method to set the value to fields
118
+ # @param fields [Array] An instance of Array
119
+
120
+ def fields=(fields)
121
+ if fields!=nil and !fields.is_a? Array
122
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: Array', nil, nil)
123
+ end
124
+ @fields = fields
125
+ @key_modified['fields'] = 1
126
+ end
127
+
128
+ # The method to get the buttons
129
+ # @return An instance of Array
130
+
131
+ def buttons
132
+ @buttons
133
+ end
134
+
135
+ # The method to set the value to buttons
136
+ # @param buttons [Array] An instance of Array
137
+
138
+ def buttons=(buttons)
139
+ if buttons!=nil and !buttons.is_a? Array
140
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: buttons EXPECTED TYPE: Array', nil, nil)
141
+ end
142
+ @buttons = buttons
143
+ @key_modified['buttons'] = 1
144
+ end
145
+
146
+ # The method to check if the user has modified the given key
147
+ # @param key [String] A String
148
+ # @return A Integer value
149
+
150
+ def is_key_modified(key)
151
+ if key!=nil and !key.is_a? String
152
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
153
+ end
154
+ if @key_modified.key?(key)
155
+ return @key_modified[key]
156
+ end
157
+
158
+ nil
159
+ end
160
+
161
+ # The method to mark the given key as modified
162
+ # @param key [String] A String
163
+ # @param modification [Integer] A Integer
164
+
165
+ def set_key_modified(key, modification)
166
+ if key!=nil and !key.is_a? String
167
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
168
+ end
169
+ if modification!=nil and !modification.is_a? Integer
170
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
171
+ end
172
+ @key_modified[key] = modification
173
+ end
174
+
175
+ end
176
+ end
@@ -0,0 +1,273 @@
1
+ require_relative '../modules/module'
2
+ require_relative '../profiles/profile'
3
+ require_relative '../users/user'
4
+ require_relative '../util/model'
5
+
6
+ module Wizards
7
+ class Wizard
8
+ include Util::Model
9
+
10
+ # Creates an instance of Wizard
11
+ def initialize
12
+ @created_time = nil
13
+ @modified_time = nil
14
+ @module_1 = nil
15
+ @name = nil
16
+ @modified_by = nil
17
+ @profiles = nil
18
+ @active = nil
19
+ @containers = nil
20
+ @created_by = nil
21
+ @parent_wizard = nil
22
+ @draft = nil
23
+ @id = nil
24
+ @key_modified = Hash.new
25
+ end
26
+
27
+ # The method to get the created_time
28
+ # @return An instance of DateTime
29
+
30
+ def created_time
31
+ @created_time
32
+ end
33
+
34
+ # The method to set the value to created_time
35
+ # @param created_time [DateTime] An instance of DateTime
36
+
37
+ def created_time=(created_time)
38
+ if created_time!=nil and !created_time.is_a? DateTime
39
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
40
+ end
41
+ @created_time = created_time
42
+ @key_modified['created_time'] = 1
43
+ end
44
+
45
+ # The method to get the modified_time
46
+ # @return An instance of DateTime
47
+
48
+ def modified_time
49
+ @modified_time
50
+ end
51
+
52
+ # The method to set the value to modified_time
53
+ # @param modified_time [DateTime] An instance of DateTime
54
+
55
+ def modified_time=(modified_time)
56
+ if modified_time!=nil and !modified_time.is_a? DateTime
57
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
58
+ end
59
+ @modified_time = modified_time
60
+ @key_modified['modified_time'] = 1
61
+ end
62
+
63
+ # The method to get the module
64
+ # @return An instance of Modules::Module
65
+
66
+ def module
67
+ @module_1
68
+ end
69
+
70
+ # The method to set the value to module
71
+ # @param module_1 [Modules::Module] An instance of Modules::Module
72
+
73
+ def module=(module_1)
74
+ if module_1!=nil and !module_1.is_a? Modules::Module
75
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: Module', nil, nil)
76
+ end
77
+ @module_1 = module_1
78
+ @key_modified['module'] = 1
79
+ end
80
+
81
+ # The method to get the name
82
+ # @return A String value
83
+
84
+ def name
85
+ @name
86
+ end
87
+
88
+ # The method to set the value to name
89
+ # @param name [String] A String
90
+
91
+ def name=(name)
92
+ if name!=nil and !name.is_a? String
93
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
94
+ end
95
+ @name = name
96
+ @key_modified['name'] = 1
97
+ end
98
+
99
+ # The method to get the modified_by
100
+ # @return An instance of Users::User
101
+
102
+ def modified_by
103
+ @modified_by
104
+ end
105
+
106
+ # The method to set the value to modified_by
107
+ # @param modified_by [Users::User] An instance of Users::User
108
+
109
+ def modified_by=(modified_by)
110
+ if modified_by!=nil and !modified_by.is_a? Users::User
111
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
112
+ end
113
+ @modified_by = modified_by
114
+ @key_modified['modified_by'] = 1
115
+ end
116
+
117
+ # The method to get the profiles
118
+ # @return An instance of Array
119
+
120
+ def profiles
121
+ @profiles
122
+ end
123
+
124
+ # The method to set the value to profiles
125
+ # @param profiles [Array] An instance of Array
126
+
127
+ def profiles=(profiles)
128
+ if profiles!=nil and !profiles.is_a? Array
129
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: Array', nil, nil)
130
+ end
131
+ @profiles = profiles
132
+ @key_modified['profiles'] = 1
133
+ end
134
+
135
+ # The method to get the active
136
+ # @return A Boolean value
137
+
138
+ def active
139
+ @active
140
+ end
141
+
142
+ # The method to set the value to active
143
+ # @param active [Boolean] A Boolean
144
+
145
+ def active=(active)
146
+ if active!=nil and ! [true, false].include?active
147
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: Boolean', nil, nil)
148
+ end
149
+ @active = active
150
+ @key_modified['active'] = 1
151
+ end
152
+
153
+ # The method to get the containers
154
+ # @return An instance of Array
155
+
156
+ def containers
157
+ @containers
158
+ end
159
+
160
+ # The method to set the value to containers
161
+ # @param containers [Array] An instance of Array
162
+
163
+ def containers=(containers)
164
+ if containers!=nil and !containers.is_a? Array
165
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: containers EXPECTED TYPE: Array', nil, nil)
166
+ end
167
+ @containers = containers
168
+ @key_modified['containers'] = 1
169
+ end
170
+
171
+ # The method to get the created_by
172
+ # @return An instance of Users::User
173
+
174
+ def created_by
175
+ @created_by
176
+ end
177
+
178
+ # The method to set the value to created_by
179
+ # @param created_by [Users::User] An instance of Users::User
180
+
181
+ def created_by=(created_by)
182
+ if created_by!=nil and !created_by.is_a? Users::User
183
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
184
+ end
185
+ @created_by = created_by
186
+ @key_modified['created_by'] = 1
187
+ end
188
+
189
+ # The method to get the parent_wizard
190
+ # @return An instance of Wizard
191
+
192
+ def parent_wizard
193
+ @parent_wizard
194
+ end
195
+
196
+ # The method to set the value to parent_wizard
197
+ # @param parent_wizard [Wizard] An instance of Wizard
198
+
199
+ def parent_wizard=(parent_wizard)
200
+ if parent_wizard!=nil and !parent_wizard.is_a? Wizard
201
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent_wizard EXPECTED TYPE: Wizard', nil, nil)
202
+ end
203
+ @parent_wizard = parent_wizard
204
+ @key_modified['parent_wizard'] = 1
205
+ end
206
+
207
+ # The method to get the draft
208
+ # @return A Boolean value
209
+
210
+ def draft
211
+ @draft
212
+ end
213
+
214
+ # The method to set the value to draft
215
+ # @param draft [Boolean] A Boolean
216
+
217
+ def draft=(draft)
218
+ if draft!=nil and ! [true, false].include?draft
219
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: draft EXPECTED TYPE: Boolean', nil, nil)
220
+ end
221
+ @draft = draft
222
+ @key_modified['draft'] = 1
223
+ end
224
+
225
+ # The method to get the id
226
+ # @return A Integer value
227
+
228
+ def id
229
+ @id
230
+ end
231
+
232
+ # The method to set the value to id
233
+ # @param id [Integer] A Integer
234
+
235
+ def id=(id)
236
+ if id!=nil and !id.is_a? Integer
237
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
238
+ end
239
+ @id = id
240
+ @key_modified['id'] = 1
241
+ end
242
+
243
+ # The method to check if the user has modified the given key
244
+ # @param key [String] A String
245
+ # @return A Integer value
246
+
247
+ def is_key_modified(key)
248
+ if key!=nil and !key.is_a? String
249
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
250
+ end
251
+ if @key_modified.key?(key)
252
+ return @key_modified[key]
253
+ end
254
+
255
+ nil
256
+ end
257
+
258
+ # The method to mark the given key as modified
259
+ # @param key [String] A String
260
+ # @param modification [Integer] A Integer
261
+
262
+ def set_key_modified(key, modification)
263
+ if key!=nil and !key.is_a? String
264
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
265
+ end
266
+ if modification!=nil and !modification.is_a? Integer
267
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
268
+ end
269
+ @key_modified[key] = modification
270
+ end
271
+
272
+ end
273
+ end
@@ -0,0 +1,61 @@
1
+ require_relative '../param'
2
+ require_relative '../parameter_map'
3
+ require_relative '../exception/sdk_exception'
4
+ require_relative '../util/api_response'
5
+ require_relative '../util/common_api_handler'
6
+ require_relative '../util/constants'
7
+
8
+ module Wizards
9
+ class WizardsOperations
10
+
11
+ # Creates an instance of WizardsOperations
12
+ def initialize
13
+ end
14
+
15
+ # The method to get wizards
16
+ # @return An instance of APIResponse
17
+ # @raise SDKException
18
+ def get_wizards
19
+ handler_instance = Handler::CommonAPIHandler.new
20
+ api_path = ''
21
+ api_path = api_path + '/crm/v2.1/settings/wizards'
22
+ handler_instance.api_path = api_path
23
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
24
+ handler_instance.category_method = 'READ'
25
+ require_relative 'response_handler'
26
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
27
+ end
28
+
29
+ # The method to get wizard by id
30
+ # @param wizard_id [Integer] A Integer
31
+ # @param param_instance [ParameterMap] An instance of ParameterMap
32
+ # @return An instance of APIResponse
33
+ # @raise SDKException
34
+ def get_wizard_by_id(wizard_id, param_instance=nil)
35
+ if !wizard_id.is_a? Integer
36
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: wizard_id EXPECTED TYPE: Integer', nil, nil)
37
+ end
38
+ if param_instance!=nil and !param_instance.is_a? ParameterMap
39
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
40
+ end
41
+ handler_instance = Handler::CommonAPIHandler.new
42
+ api_path = ''
43
+ api_path = api_path + '/crm/v2.1/settings/wizards/'
44
+ api_path = api_path + wizard_id.to_s
45
+ handler_instance.api_path = api_path
46
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
47
+ handler_instance.category_method = 'READ'
48
+ handler_instance.param = param_instance
49
+ require_relative 'response_handler'
50
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
51
+ end
52
+
53
+ class GetWizardbyIDParam
54
+ @@layout_id = Param.new('layout_id', 'com.zoho.crm.api.Wizards.GetWizardbyIDParam')
55
+ def self.layout_id
56
+ @@layout_id
57
+ end
58
+ end
59
+
60
+ end
61
+ end