ZOHOCRMSDK5_0 1.0.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZOHOCRMSDK5_0.rb +512 -510
  3. data/src/com/zoho/crm/api/bulk_write/field_mapping.rb +19 -0
  4. data/src/com/zoho/crm/api/bulk_write/resource.rb +19 -0
  5. data/src/com/zoho/crm/api/mail_merge/action_handler.rb +12 -0
  6. data/src/com/zoho/crm/api/mail_merge/action_wrapper.rb +2 -0
  7. data/src/com/zoho/crm/api/mail_merge/address.rb +31 -12
  8. data/src/com/zoho/crm/api/mail_merge/api_exception.rb +10 -0
  9. data/src/com/zoho/crm/api/mail_merge/download_response_handler.rb +12 -0
  10. data/src/com/zoho/crm/api/mail_merge/file_body_wrapper.rb +66 -0
  11. data/src/com/zoho/crm/api/mail_merge/mail_merge.rb +4 -5
  12. data/src/com/zoho/crm/api/mail_merge/mail_merge_operations.rb +101 -0
  13. data/src/com/zoho/crm/api/mail_merge/sign_action_handler.rb +12 -0
  14. data/src/com/zoho/crm/api/mail_merge/sign_action_wrapper.rb +2 -0
  15. data/src/com/zoho/crm/api/modules/modules.rb +0 -19
  16. data/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_wrapper.rb +0 -2
  17. data/src/com/zoho/crm/api/record/lead_converter.rb +19 -0
  18. data/src/com/zoho/crm/api/record/move_attachments_to.rb +82 -0
  19. data/src/com/zoho/crm/api/record_locking/api_exception.rb +2 -6
  20. data/src/com/zoho/crm/api/record_locking/record_locking_operations.rb +37 -63
  21. data/src/com/zoho/crm/api/reschedule_history/reschedule_history_operations.rb +4 -0
  22. data/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete_by_id.rb +82 -0
  23. data/src/com/zoho/crm/api/util/constants.rb +1 -1
  24. data/src/resources/json_details.json +1 -1
  25. data/src/version.rb +1 -1
  26. metadata +27 -6
@@ -13,6 +13,7 @@ module ZOHOCRMSDK
13
13
  @find_by = nil
14
14
  @default_value = nil
15
15
  @module_1 = nil
16
+ @parent_column_index = nil
16
17
  @key_modified = Hash.new
17
18
  end
18
19
 
@@ -124,6 +125,24 @@ module ZOHOCRMSDK
124
125
  @key_modified['module'] = 1
125
126
  end
126
127
 
128
+ # The method to get the parent_column_index
129
+ # @return A Integer value
130
+
131
+ def parent_column_index
132
+ @parent_column_index
133
+ end
134
+
135
+ # The method to set the value to parent_column_index
136
+ # @param parent_column_index [Integer] A Integer
137
+
138
+ def parent_column_index=(parent_column_index)
139
+ if parent_column_index!=nil and !parent_column_index.is_a? Integer
140
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent_column_index EXPECTED TYPE: Integer', nil, nil)
141
+ end
142
+ @parent_column_index = parent_column_index
143
+ @key_modified['parent_column_index'] = 1
144
+ end
145
+
127
146
  # The method to check if the user has modified the given key
128
147
  # @param key [String] A String
129
148
  # @return A Integer value
@@ -14,6 +14,7 @@ module ZOHOCRMSDK
14
14
  @module_1 = nil
15
15
  @code = nil
16
16
  @file_id = nil
17
+ @file_names = nil
17
18
  @ignore_empty = nil
18
19
  @find_by = nil
19
20
  @field_mappings = nil
@@ -111,6 +112,24 @@ module ZOHOCRMSDK
111
112
  @key_modified['file_id'] = 1
112
113
  end
113
114
 
115
+ # The method to get the file_names
116
+ # @return An instance of Array
117
+
118
+ def file_names
119
+ @file_names
120
+ end
121
+
122
+ # The method to set the value to file_names
123
+ # @param file_names [Array] An instance of Array
124
+
125
+ def file_names=(file_names)
126
+ if file_names!=nil and !file_names.is_a? Array
127
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file_names EXPECTED TYPE: Array', nil, nil)
128
+ end
129
+ @file_names = file_names
130
+ @key_modified['file_names'] = 1
131
+ end
132
+
114
133
  # The method to get the ignore_empty
115
134
  # @return A Boolean value
116
135
 
@@ -0,0 +1,12 @@
1
+ module ZOHOCRMSDK
2
+ module MailMerge
3
+ module ActionHandler
4
+
5
+ # Creates an instance of ActionHandler
6
+ def initialize
7
+ end
8
+
9
+
10
+ end
11
+ end
12
+ end
@@ -2,8 +2,10 @@ require_relative '../util/model'
2
2
 
3
3
  module ZOHOCRMSDK
4
4
  module MailMerge
5
+ require_relative 'action_handler'
5
6
  class ActionWrapper
6
7
  include Util::Model
8
+ include ActionHandler
7
9
 
8
10
  # Creates an instance of ActionWrapper
9
11
  def initialize
@@ -7,26 +7,45 @@ module ZOHOCRMSDK
7
7
 
8
8
  # Creates an instance of Address
9
9
  def initialize
10
- @address_value_map = nil
10
+ @type = nil
11
+ @value = nil
11
12
  @key_modified = Hash.new
12
13
  end
13
14
 
14
- # The method to get the address_value_map
15
- # @return An instance of AddressValueMap
15
+ # The method to get the type
16
+ # @return A String value
16
17
 
17
- def address_value_map
18
- @address_value_map
18
+ def type
19
+ @type
19
20
  end
20
21
 
21
- # The method to set the value to address_value_map
22
- # @param address_value_map [AddressValueMap] An instance of AddressValueMap
22
+ # The method to set the value to type
23
+ # @param type [String] A String
23
24
 
24
- def address_value_map=(address_value_map)
25
- if address_value_map!=nil and !address_value_map.is_a? AddressValueMap
26
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: address_value_map EXPECTED TYPE: AddressValueMap', nil, nil)
25
+ def type=(type)
26
+ if type!=nil and !type.is_a? String
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
27
28
  end
28
- @address_value_map = address_value_map
29
- @key_modified['Address_Value_Map'] = 1
29
+ @type = type
30
+ @key_modified['type'] = 1
31
+ end
32
+
33
+ # The method to get the value
34
+ # @return A String value
35
+
36
+ def value
37
+ @value
38
+ end
39
+
40
+ # The method to set the value to value
41
+ # @param value [String] A String
42
+
43
+ def value=(value)
44
+ if value!=nil and !value.is_a? String
45
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: String', nil, nil)
46
+ end
47
+ @value = value
48
+ @key_modified['value'] = 1
30
49
  end
31
50
 
32
51
  # The method to check if the user has modified the given key
@@ -3,8 +3,18 @@ require_relative '../util/model'
3
3
 
4
4
  module ZOHOCRMSDK
5
5
  module MailMerge
6
+ require_relative 'action_handler'
7
+ require_relative 'action_response'
8
+ require_relative 'download_response_handler'
9
+ require_relative 'sign_action_handler'
10
+ require_relative 'sign_action_response'
6
11
  class APIException
7
12
  include Util::Model
13
+ include ActionHandler
14
+ include ActionResponse
15
+ include DownloadResponseHandler
16
+ include SignActionHandler
17
+ include SignActionResponse
8
18
 
9
19
  # Creates an instance of APIException
10
20
  def initialize
@@ -0,0 +1,12 @@
1
+ module ZOHOCRMSDK
2
+ module MailMerge
3
+ module DownloadResponseHandler
4
+
5
+ # Creates an instance of DownloadResponseHandler
6
+ def initialize
7
+ end
8
+
9
+
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,66 @@
1
+ require_relative '../util/stream_wrapper'
2
+ require_relative '../util/model'
3
+
4
+ module ZOHOCRMSDK
5
+ module MailMerge
6
+ require_relative 'download_response_handler'
7
+ class FileBodyWrapper
8
+ include Util::Model
9
+ include DownloadResponseHandler
10
+
11
+ # Creates an instance of FileBodyWrapper
12
+ def initialize
13
+ @file = nil
14
+ @key_modified = Hash.new
15
+ end
16
+
17
+ # The method to get the file
18
+ # @return An instance of Util::StreamWrapper
19
+
20
+ def file
21
+ @file
22
+ end
23
+
24
+ # The method to set the value to file
25
+ # @param file [Util::StreamWrapper] An instance of Util::StreamWrapper
26
+
27
+ def file=(file)
28
+ if file!=nil and !file.is_a? Util::StreamWrapper
29
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: Util::StreamWrapper', nil, nil)
30
+ end
31
+ @file = file
32
+ @key_modified['file'] = 1
33
+ end
34
+
35
+ # The method to check if the user has modified the given key
36
+ # @param key [String] A String
37
+ # @return A Integer value
38
+
39
+ def is_key_modified(key)
40
+ if key!=nil and !key.is_a? String
41
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
42
+ end
43
+ if @key_modified.key?(key)
44
+ return @key_modified[key]
45
+ end
46
+
47
+ nil
48
+ end
49
+
50
+ # The method to mark the given key as modified
51
+ # @param key [String] A String
52
+ # @param modification [Integer] A Integer
53
+
54
+ def set_key_modified(key, modification)
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 modification!=nil and !modification.is_a? Integer
59
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
60
+ end
61
+ @key_modified[key] = modification
62
+ end
63
+
64
+ end
65
+ end
66
+ end
@@ -1,4 +1,3 @@
1
- require_relative '../util/choice'
2
1
  require_relative '../util/model'
3
2
 
4
3
  module ZOHOCRMSDK
@@ -147,18 +146,18 @@ module ZOHOCRMSDK
147
146
  end
148
147
 
149
148
  # The method to get the type
150
- # @return An instance of Util::Choice
149
+ # @return A String value
151
150
 
152
151
  def type
153
152
  @type
154
153
  end
155
154
 
156
155
  # The method to set the value to type
157
- # @param type [Util::Choice] An instance of Util::Choice
156
+ # @param type [String] A String
158
157
 
159
158
  def type=(type)
160
- if type!=nil and !type.is_a? Util::Choice
161
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Util::Choice', nil, nil)
159
+ if type!=nil and !type.is_a? String
160
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
162
161
  end
163
162
  @type = type
164
163
  @key_modified['type'] = 1
@@ -0,0 +1,101 @@
1
+ require_relative '../exception/sdk_exception'
2
+ require_relative '../util/api_response'
3
+ require_relative '../util/common_api_handler'
4
+ require_relative '../util/constants'
5
+
6
+ module ZOHOCRMSDK
7
+ module MailMerge
8
+ class MailMergeOperations
9
+
10
+ # Creates an instance of MailMergeOperations with the given parameters
11
+ # @param module_1 [String] A String
12
+ # @param id [String] A String
13
+ def initialize(module_1, id)
14
+ if !module_1.is_a? String
15
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
16
+ end
17
+ if !id.is_a? String
18
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: String', nil, nil)
19
+ end
20
+ @module_1 = module_1
21
+ @id = id
22
+ end
23
+
24
+ # The method to send mail merge
25
+ # @param request [MailMergeWrapper] An instance of MailMergeWrapper
26
+ # @return An instance of APIResponse
27
+ # @raise SDKException
28
+ def send_mail_merge(request)
29
+ if request!=nil and !request.is_a? MailMergeWrapper
30
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MailMergeWrapper', nil, nil)
31
+ end
32
+ handler_instance = Handler::CommonAPIHandler.new
33
+ api_path = ''
34
+ api_path = api_path + '/crm/v5/'
35
+ api_path = api_path + @module_1.to_s
36
+ api_path = api_path + '/'
37
+ api_path = api_path + @id.to_s
38
+ api_path = api_path + '/actions/send_mail_merge'
39
+ handler_instance.api_path = api_path
40
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
41
+ handler_instance.category_method = 'CREATE'
42
+ handler_instance.content_type = 'application/json'
43
+ handler_instance.request = request
44
+ handler_instance.mandatory_checker = true
45
+ require_relative 'action_handler'
46
+ handler_instance.api_call(ActionHandler.name, 'application/json')
47
+ end
48
+
49
+ # The method to download mail merge
50
+ # @param request [DownloadMailMergeWrapper] An instance of DownloadMailMergeWrapper
51
+ # @return An instance of APIResponse
52
+ # @raise SDKException
53
+ def download_mail_merge(request)
54
+ if request!=nil and !request.is_a? DownloadMailMergeWrapper
55
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: DownloadMailMergeWrapper', nil, nil)
56
+ end
57
+ handler_instance = Handler::CommonAPIHandler.new
58
+ api_path = ''
59
+ api_path = api_path + '/crm/v5/'
60
+ api_path = api_path + @module_1.to_s
61
+ api_path = api_path + '/'
62
+ api_path = api_path + @id.to_s
63
+ api_path = api_path + '/actions/download_mail_merge'
64
+ handler_instance.api_path = api_path
65
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
66
+ handler_instance.category_method = 'CREATE'
67
+ handler_instance.content_type = 'application/json'
68
+ handler_instance.request = request
69
+ handler_instance.mandatory_checker = true
70
+ require_relative 'download_response_handler'
71
+ handler_instance.api_call(DownloadResponseHandler.name, 'application/json')
72
+ end
73
+
74
+ # The method to sign mail merge
75
+ # @param request [SignMailMergeWrapper] An instance of SignMailMergeWrapper
76
+ # @return An instance of APIResponse
77
+ # @raise SDKException
78
+ def sign_mail_merge(request)
79
+ if request!=nil and !request.is_a? SignMailMergeWrapper
80
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: SignMailMergeWrapper', nil, nil)
81
+ end
82
+ handler_instance = Handler::CommonAPIHandler.new
83
+ api_path = ''
84
+ api_path = api_path + '/crm/v5/'
85
+ api_path = api_path + @module_1.to_s
86
+ api_path = api_path + '/'
87
+ api_path = api_path + @id.to_s
88
+ api_path = api_path + '/actions/sign_mail_merge'
89
+ handler_instance.api_path = api_path
90
+ handler_instance.http_method = Constants::REQUEST_METHOD_POST
91
+ handler_instance.category_method = 'CREATE'
92
+ handler_instance.content_type = 'application/json'
93
+ handler_instance.request = request
94
+ handler_instance.mandatory_checker = true
95
+ require_relative 'sign_action_handler'
96
+ handler_instance.api_call(SignActionHandler.name, 'application/json')
97
+ end
98
+
99
+ end
100
+ end
101
+ end
@@ -0,0 +1,12 @@
1
+ module ZOHOCRMSDK
2
+ module MailMerge
3
+ module SignActionHandler
4
+
5
+ # Creates an instance of SignActionHandler
6
+ def initialize
7
+ end
8
+
9
+
10
+ end
11
+ end
12
+ end
@@ -2,8 +2,10 @@ require_relative '../util/model'
2
2
 
3
3
  module ZOHOCRMSDK
4
4
  module MailMerge
5
+ require_relative 'sign_action_handler'
5
6
  class SignActionWrapper
6
7
  include Util::Model
8
+ include SignActionHandler
7
9
 
8
10
  # Creates an instance of SignActionWrapper
9
11
  def initialize
@@ -73,7 +73,6 @@ module ZOHOCRMSDK
73
73
  @zia_view = nil
74
74
  @default_mapping_fields = nil
75
75
  @status = nil
76
- @arguments_32 = nil
77
76
  @key_modified = Hash.new
78
77
  end
79
78
 
@@ -1139,24 +1138,6 @@ module ZOHOCRMSDK
1139
1138
  @key_modified['status'] = 1
1140
1139
  end
1141
1140
 
1142
- # The method to get the arguments_32
1143
- # @return An instance of Array
1144
-
1145
- def arguments_32
1146
- @arguments_32
1147
- end
1148
-
1149
- # The method to set the value to arguments_32
1150
- # @param arguments_32 [Array] An instance of Array
1151
-
1152
- def arguments_32=(arguments_32)
1153
- if arguments_32!=nil and !arguments_32.is_a? Array
1154
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: arguments_32 EXPECTED TYPE: Array', nil, nil)
1155
- end
1156
- @arguments_32 = arguments_32
1157
- @key_modified['arguments'] = 1
1158
- end
1159
-
1160
1141
  # The method to check if the user has modified the given key
1161
1142
  # @param key [String] A String
1162
1143
  # @return A Integer value
@@ -2,11 +2,9 @@ require_relative '../util/model'
2
2
 
3
3
  module ZOHOCRMSDK
4
4
  module Pipeline
5
- require_relative 'action_handler'
6
5
  require_relative 'transfer_pipeline_action_handler'
7
6
  class TransferPipelineActionWrapper
8
7
  include Util::Model
9
- include ActionHandler
10
8
  include TransferPipelineActionHandler
11
9
 
12
10
  # Creates an instance of TransferPipelineActionWrapper
@@ -16,6 +16,7 @@ module ZOHOCRMSDK
16
16
  @assign_to = nil
17
17
  @deals = nil
18
18
  @carry_over_tags = nil
19
+ @move_attachments_to = nil
19
20
  @key_modified = Hash.new
20
21
  end
21
22
 
@@ -163,6 +164,24 @@ module ZOHOCRMSDK
163
164
  @key_modified['carry_over_tags'] = 1
164
165
  end
165
166
 
167
+ # The method to get the move_attachments_to
168
+ # @return An instance of MoveAttachmentsTo
169
+
170
+ def move_attachments_to
171
+ @move_attachments_to
172
+ end
173
+
174
+ # The method to set the value to move_attachments_to
175
+ # @param move_attachments_to [MoveAttachmentsTo] An instance of MoveAttachmentsTo
176
+
177
+ def move_attachments_to=(move_attachments_to)
178
+ if move_attachments_to!=nil and !move_attachments_to.is_a? MoveAttachmentsTo
179
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: move_attachments_to EXPECTED TYPE: MoveAttachmentsTo', nil, nil)
180
+ end
181
+ @move_attachments_to = move_attachments_to
182
+ @key_modified['move_attachments_to'] = 1
183
+ end
184
+
166
185
  # The method to check if the user has modified the given key
167
186
  # @param key [String] A String
168
187
  # @return A Integer value
@@ -0,0 +1,82 @@
1
+ require_relative '../util/model'
2
+
3
+ module ZOHOCRMSDK
4
+ module Record
5
+ class MoveAttachmentsTo
6
+ include Util::Model
7
+
8
+ # Creates an instance of MoveAttachmentsTo
9
+ def initialize
10
+ @id = nil
11
+ @api_name = 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 api_name
34
+ # @return A String value
35
+
36
+ def api_name
37
+ @api_name
38
+ end
39
+
40
+ # The method to set the value to api_name
41
+ # @param api_name [String] A String
42
+
43
+ def api_name=(api_name)
44
+ if api_name!=nil and !api_name.is_a? String
45
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
46
+ end
47
+ @api_name = api_name
48
+ @key_modified['api_name'] = 1
49
+ end
50
+
51
+ # The method to check if the user has modified the given key
52
+ # @param key [String] A String
53
+ # @return A Integer value
54
+
55
+ def is_key_modified(key)
56
+ if key!=nil and !key.is_a? String
57
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
58
+ end
59
+ if @key_modified.key?(key)
60
+ return @key_modified[key]
61
+ end
62
+
63
+ nil
64
+ end
65
+
66
+ # The method to mark the given key as modified
67
+ # @param key [String] A String
68
+ # @param modification [Integer] A Integer
69
+
70
+ def set_key_modified(key, modification)
71
+ if key!=nil and !key.is_a? String
72
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
73
+ end
74
+ if modification!=nil and !modification.is_a? Integer
75
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
76
+ end
77
+ @key_modified[key] = modification
78
+ end
79
+
80
+ end
81
+ end
82
+ end
@@ -3,16 +3,12 @@ require_relative '../util/model'
3
3
 
4
4
  module ZOHOCRMSDK
5
5
  module RecordLocking
6
- require_relative 'action_response'
7
- require_relative 'error_handler'
8
- require_relative 'response_handler'
9
6
  require_relative 'action_handler'
7
+ require_relative 'response_handler'
10
8
  class APIException
11
9
  include Util::Model
12
- include ActionResponse
13
- include ErrorHandler
14
- include ResponseHandler
15
10
  include ActionHandler
11
+ include ResponseHandler
16
12
 
17
13
  # Creates an instance of APIException
18
14
  def initialize