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,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
@@ -0,0 +1,165 @@
1
+ require_relative '../param'
2
+ require_relative '../exception/sdk_exception'
3
+ require_relative '../util/api_response'
4
+ require_relative '../util/common_api_handler'
5
+ require_relative '../util/constants'
6
+
7
+ module Pipeline
8
+ class PipelineOperations
9
+
10
+ # Creates an instance of PipelineOperations with the given parameters
11
+ # @param layout_id [Integer] A Integer
12
+ def initialize(layout_id=nil)
13
+ if layout_id!=nil and !layout_id.is_a? Integer
14
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layout_id EXPECTED TYPE: Integer', nil, nil)
15
+ end
16
+ @layout_id = layout_id
17
+ end
18
+
19
+ # The method to transfer and delete
20
+ # @param request [TransferAndDeleteWrapper] An instance of TransferAndDeleteWrapper
21
+ # @return An instance of APIResponse
22
+ # @raise SDKException
23
+ def transfer_and_delete(request)
24
+ if request!=nil and !request.is_a? TransferAndDeleteWrapper
25
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferAndDeleteWrapper', nil, nil)
26
+ end
27
+ handler_instance = Handler::CommonAPIHandler.new
28
+ api_path = ''
29
+ api_path = api_path + '/crm/v2.1/settings/pipeline/actions/transfer'
30
+ handler_instance.api_path = api_path
31
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
32
+ handler_instance.category_method = 'CREATE'
33
+ handler_instance.content_type = 'application/json'
34
+ handler_instance.request = request
35
+ handler_instance.mandatory_checker = true
36
+ handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.TransferAndDeleteParam'), @layout_id)
37
+ require_relative 'transfer_action_handler'
38
+ handler_instance.api_call(TransferActionHandler.name, 'application/json')
39
+ end
40
+
41
+ # The method to get pipelines
42
+ # @return An instance of APIResponse
43
+ # @raise SDKException
44
+ def get_pipelines
45
+ handler_instance = Handler::CommonAPIHandler.new
46
+ api_path = ''
47
+ api_path = api_path + '/crm/v2.1/settings/pipeline'
48
+ handler_instance.api_path = api_path
49
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
50
+ handler_instance.category_method = 'READ'
51
+ handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.GetPipelinesParam'), @layout_id)
52
+ require_relative 'response_handler'
53
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
54
+ end
55
+
56
+ # The method to create pipelines
57
+ # @param request [BodyWrapper] An instance of BodyWrapper
58
+ # @return An instance of APIResponse
59
+ # @raise SDKException
60
+ def create_pipelines(request)
61
+ if request!=nil and !request.is_a? BodyWrapper
62
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
63
+ end
64
+ handler_instance = Handler::CommonAPIHandler.new
65
+ api_path = ''
66
+ api_path = api_path + '/crm/v2.1/settings/pipeline'
67
+ handler_instance.api_path = api_path
68
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
69
+ handler_instance.category_method = 'CREATE'
70
+ handler_instance.content_type = 'application/json'
71
+ handler_instance.request = request
72
+ handler_instance.mandatory_checker = true
73
+ handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.CreatePipelinesParam'), @layout_id)
74
+ require_relative 'action_handler'
75
+ handler_instance.api_call(ActionHandler.name, 'application/json')
76
+ end
77
+
78
+ # The method to update pipelines
79
+ # @param request [BodyWrapper] An instance of BodyWrapper
80
+ # @return An instance of APIResponse
81
+ # @raise SDKException
82
+ def update_pipelines(request)
83
+ if request!=nil and !request.is_a? BodyWrapper
84
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
85
+ end
86
+ handler_instance = Handler::CommonAPIHandler.new
87
+ api_path = ''
88
+ api_path = api_path + '/crm/v2.1/settings/pipeline'
89
+ handler_instance.api_path = api_path
90
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
91
+ handler_instance.category_method = 'UPDATE'
92
+ handler_instance.content_type = 'application/json'
93
+ handler_instance.request = request
94
+ handler_instance.mandatory_checker = true
95
+ handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.UpdatePipelinesParam'), @layout_id)
96
+ require_relative 'action_handler'
97
+ handler_instance.api_call(ActionHandler.name, 'application/json')
98
+ end
99
+
100
+ # The method to get pipeline
101
+ # @param pipeline_id [Integer] A Integer
102
+ # @return An instance of APIResponse
103
+ # @raise SDKException
104
+ def get_pipeline(pipeline_id)
105
+ if !pipeline_id.is_a? Integer
106
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline_id EXPECTED TYPE: Integer', nil, nil)
107
+ end
108
+ handler_instance = Handler::CommonAPIHandler.new
109
+ api_path = ''
110
+ api_path = api_path + '/crm/v2.1/settings/pipeline/'
111
+ api_path = api_path + pipeline_id.to_s
112
+ handler_instance.api_path = api_path
113
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
114
+ handler_instance.category_method = 'READ'
115
+ handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.GetPipelineParam'), @layout_id)
116
+ require_relative 'response_handler'
117
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
118
+ end
119
+
120
+ # The method to update pipeline
121
+ # @param pipeline_id [Integer] A Integer
122
+ # @param request [BodyWrapper] An instance of BodyWrapper
123
+ # @return An instance of APIResponse
124
+ # @raise SDKException
125
+ def update_pipeline(pipeline_id, request)
126
+ if !pipeline_id.is_a? Integer
127
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline_id EXPECTED TYPE: Integer', nil, nil)
128
+ end
129
+ if request!=nil and !request.is_a? BodyWrapper
130
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
131
+ end
132
+ handler_instance = Handler::CommonAPIHandler.new
133
+ api_path = ''
134
+ api_path = api_path + '/crm/v2.1/settings/pipeline/'
135
+ api_path = api_path + pipeline_id.to_s
136
+ handler_instance.api_path = api_path
137
+ handler_instance.http_method = Constants::REQUEST_METHOD_PUT
138
+ handler_instance.category_method = 'UPDATE'
139
+ handler_instance.content_type = 'application/json'
140
+ handler_instance.request = request
141
+ handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.UpdatePipelineParam'), @layout_id)
142
+ require_relative 'action_handler'
143
+ handler_instance.api_call(ActionHandler.name, 'application/json')
144
+ end
145
+
146
+ class TransferAndDeleteParam
147
+ end
148
+
149
+ class GetPipelinesParam
150
+ end
151
+
152
+ class CreatePipelinesParam
153
+ end
154
+
155
+ class UpdatePipelinesParam
156
+ end
157
+
158
+ class GetPipelineParam
159
+ end
160
+
161
+ class UpdatePipelineParam
162
+ end
163
+
164
+ end
165
+ end
@@ -0,0 +1,10 @@
1
+ module Pipeline
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 Pipeline
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
+ @pipeline = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the pipeline
16
+ # @return An instance of Array
17
+
18
+ def pipeline
19
+ @pipeline
20
+ end
21
+
22
+ # The method to set the value to pipeline
23
+ # @param pipeline [Array] An instance of Array
24
+
25
+ def pipeline=(pipeline)
26
+ if pipeline!=nil and !pipeline.is_a? Array
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: Array', nil, nil)
28
+ end
29
+ @pipeline = pipeline
30
+ @key_modified['pipeline'] = 1
31
+ end
32
+
33
+ # The method to check if the user has modified the given key
34
+ # @param key [String] A String
35
+ # @return A Integer value
36
+
37
+ def is_key_modified(key)
38
+ if key!=nil and !key.is_a? String
39
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
40
+ end
41
+ if @key_modified.key?(key)
42
+ return @key_modified[key]
43
+ end
44
+
45
+ nil
46
+ end
47
+
48
+ # The method to mark the given key as modified
49
+ # @param key [String] A String
50
+ # @param modification [Integer] A Integer
51
+
52
+ def set_key_modified(key, modification)
53
+ if key!=nil and !key.is_a? String
54
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
55
+ end
56
+ if modification!=nil and !modification.is_a? Integer
57
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
58
+ end
59
+ @key_modified[key] = modification
60
+ end
61
+
62
+ end
63
+ end