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,61 @@
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 EmailTemplates
8
+ class EmailTemplatesOperations
9
+
10
+ # Creates an instance of EmailTemplatesOperations with the given parameters
11
+ # @param module_1 [String] A String
12
+ def initialize(module_1=nil)
13
+ if module_1!=nil and !module_1.is_a? String
14
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
15
+ end
16
+ @module_1 = module_1
17
+ end
18
+
19
+ # The method to get email templates
20
+ # @return An instance of APIResponse
21
+ # @raise SDKException
22
+ def get_email_templates
23
+ handler_instance = Handler::CommonAPIHandler.new
24
+ api_path = ''
25
+ api_path = api_path + '/crm/v2.1/settings/email_templates'
26
+ handler_instance.api_path = api_path
27
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
28
+ handler_instance.category_method = 'READ'
29
+ handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.EmailTemplates.GetEmailTemplatesParam'), @module_1)
30
+ require_relative 'response_handler'
31
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
32
+ end
33
+
34
+ # The method to get email template by id
35
+ # @param id [Integer] A Integer
36
+ # @return An instance of APIResponse
37
+ # @raise SDKException
38
+ def get_email_template_by_id(id)
39
+ if !id.is_a? Integer
40
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
41
+ end
42
+ handler_instance = Handler::CommonAPIHandler.new
43
+ api_path = ''
44
+ api_path = api_path + '/crm/v2.1/settings/email_templates/'
45
+ api_path = api_path + id.to_s
46
+ handler_instance.api_path = api_path
47
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
48
+ handler_instance.category_method = 'READ'
49
+ handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.EmailTemplates.GetEmailTemplatebyIDParam'), @module_1)
50
+ require_relative 'response_handler'
51
+ handler_instance.api_call(ResponseHandler.name, 'application/json')
52
+ end
53
+
54
+ class GetEmailTemplatesParam
55
+ end
56
+
57
+ class GetEmailTemplatebyIDParam
58
+ end
59
+
60
+ end
61
+ end
@@ -0,0 +1,10 @@
1
+ module EmailTemplates
2
+ module ResponseHandler
3
+
4
+ # Creates an instance of ResponseHandler
5
+ def initialize
6
+ end
7
+
8
+
9
+ end
10
+ end
@@ -0,0 +1,83 @@
1
+ require_relative '../record/info'
2
+ require_relative '../util/model'
3
+
4
+ module EmailTemplates
5
+ require_relative 'response_handler'
6
+ class ResponseWrapper
7
+ include Util::Model
8
+ include ResponseHandler
9
+
10
+ # Creates an instance of ResponseWrapper
11
+ def initialize
12
+ @email_templates = nil
13
+ @info = nil
14
+ @key_modified = Hash.new
15
+ end
16
+
17
+ # The method to get the email_templates
18
+ # @return An instance of Array
19
+
20
+ def email_templates
21
+ @email_templates
22
+ end
23
+
24
+ # The method to set the value to email_templates
25
+ # @param email_templates [Array] An instance of Array
26
+
27
+ def email_templates=(email_templates)
28
+ if email_templates!=nil and !email_templates.is_a? Array
29
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: email_templates EXPECTED TYPE: Array', nil, nil)
30
+ end
31
+ @email_templates = email_templates
32
+ @key_modified['email_templates'] = 1
33
+ end
34
+
35
+ # The method to get the info
36
+ # @return An instance of Record::Info
37
+
38
+ def info
39
+ @info
40
+ end
41
+
42
+ # The method to set the value to info
43
+ # @param info [Record::Info] An instance of Record::Info
44
+
45
+ def info=(info)
46
+ if info!=nil and !info.is_a? Record::Info
47
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', nil, nil)
48
+ end
49
+ @info = info
50
+ @key_modified['info'] = 1
51
+ end
52
+
53
+ # The method to check if the user has modified the given key
54
+ # @param key [String] A String
55
+ # @return A Integer value
56
+
57
+ def is_key_modified(key)
58
+ if key!=nil and !key.is_a? String
59
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
60
+ end
61
+ if @key_modified.key?(key)
62
+ return @key_modified[key]
63
+ end
64
+
65
+ nil
66
+ end
67
+
68
+ # The method to mark the given key as modified
69
+ # @param key [String] A String
70
+ # @param modification [Integer] A Integer
71
+
72
+ def set_key_modified(key, modification)
73
+ if key!=nil and !key.is_a? String
74
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
75
+ end
76
+ if modification!=nil and !modification.is_a? Integer
77
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
78
+ end
79
+ @key_modified[key] = modification
80
+ end
81
+
82
+ end
83
+ end
@@ -0,0 +1,121 @@
1
+ require_relative '../util/choice'
2
+ require_relative '../util/model'
3
+
4
+ module FieldAttachments
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
+ @status = nil
13
+ @code = nil
14
+ @message = nil
15
+ @details = nil
16
+ @key_modified = Hash.new
17
+ end
18
+
19
+ # The method to get the status
20
+ # @return An instance of Util::Choice
21
+
22
+ def status
23
+ @status
24
+ end
25
+
26
+ # The method to set the value to status
27
+ # @param status [Util::Choice] An instance of Util::Choice
28
+
29
+ def status=(status)
30
+ if status!=nil and !status.is_a? Util::Choice
31
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
32
+ end
33
+ @status = status
34
+ @key_modified['status'] = 1
35
+ end
36
+
37
+ # The method to get the code
38
+ # @return An instance of Util::Choice
39
+
40
+ def code
41
+ @code
42
+ end
43
+
44
+ # The method to set the value to code
45
+ # @param code [Util::Choice] An instance of Util::Choice
46
+
47
+ def code=(code)
48
+ if code!=nil and !code.is_a? Util::Choice
49
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
50
+ end
51
+ @code = code
52
+ @key_modified['code'] = 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,62 @@
1
+ require_relative '../util/stream_wrapper'
2
+ require_relative '../util/model'
3
+
4
+ module FieldAttachments
5
+ class BodyWrapper
6
+ include Util::Model
7
+
8
+ # Creates an instance of BodyWrapper
9
+ def initialize
10
+ @file = nil
11
+ @key_modified = Hash.new
12
+ end
13
+
14
+ # The method to get the file
15
+ # @return An instance of Array
16
+
17
+ def file
18
+ @file
19
+ end
20
+
21
+ # The method to set the value to file
22
+ # @param file [Array] An instance of Array
23
+
24
+ def file=(file)
25
+ if file!=nil and !file.is_a? Array
26
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: Array', nil, nil)
27
+ end
28
+ @file = file
29
+ @key_modified['file'] = 1
30
+ end
31
+
32
+ # The method to check if the user has modified the given key
33
+ # @param key [String] A String
34
+ # @return A Integer value
35
+
36
+ def is_key_modified(key)
37
+ if key!=nil and !key.is_a? String
38
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
39
+ end
40
+ if @key_modified.key?(key)
41
+ return @key_modified[key]
42
+ end
43
+
44
+ nil
45
+ end
46
+
47
+ # The method to mark the given key as modified
48
+ # @param key [String] A String
49
+ # @param modification [Integer] A Integer
50
+
51
+ def set_key_modified(key, modification)
52
+ if key!=nil and !key.is_a? String
53
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
54
+ end
55
+ if modification!=nil and !modification.is_a? Integer
56
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
57
+ end
58
+ @key_modified[key] = modification
59
+ end
60
+
61
+ end
62
+ end
@@ -0,0 +1,52 @@
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 FieldAttachments
8
+ class FieldAttachmentsOperations
9
+
10
+ # Creates an instance of FieldAttachmentsOperations with the given parameters
11
+ # @param module_api_name [String] A String
12
+ # @param record_id [Integer] A Integer
13
+ # @param fields_attachment_id [Integer] A Integer
14
+ def initialize(module_api_name, record_id, fields_attachment_id=nil)
15
+ if !module_api_name.is_a? String
16
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
17
+ end
18
+ if !record_id.is_a? Integer
19
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
20
+ end
21
+ if fields_attachment_id!=nil and !fields_attachment_id.is_a? Integer
22
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: fields_attachment_id EXPECTED TYPE: Integer', nil, nil)
23
+ end
24
+ @module_api_name = module_api_name
25
+ @record_id = record_id
26
+ @fields_attachment_id = fields_attachment_id
27
+ end
28
+
29
+ # The method to get field attachments
30
+ # @return An instance of APIResponse
31
+ # @raise SDKException
32
+ def get_field_attachments
33
+ handler_instance = Handler::CommonAPIHandler.new
34
+ api_path = ''
35
+ api_path = api_path + '/crm/v2.1/'
36
+ api_path = api_path + @module_api_name.to_s
37
+ api_path = api_path + '/'
38
+ api_path = api_path + @record_id.to_s
39
+ api_path = api_path + '/actions/download_fields_attachment'
40
+ handler_instance.api_path = api_path
41
+ handler_instance.http_method = Constants::REQUEST_METHOD_GET
42
+ handler_instance.category_method = 'READ'
43
+ handler_instance.add_param(Param.new('fields_attachment_id', 'com.zoho.crm.api.FieldAttachments.GetFieldAttachmentsParam'), @fields_attachment_id)
44
+ require_relative 'response_handler'
45
+ handler_instance.api_call(ResponseHandler.name, 'application/x-download')
46
+ end
47
+
48
+ class GetFieldAttachmentsParam
49
+ end
50
+
51
+ end
52
+ end
@@ -0,0 +1,64 @@
1
+ require_relative '../util/stream_wrapper'
2
+ require_relative '../util/model'
3
+
4
+ module FieldAttachments
5
+ require_relative 'response_handler'
6
+ class FileBodyWrapper
7
+ include Util::Model
8
+ include ResponseHandler
9
+
10
+ # Creates an instance of FileBodyWrapper
11
+ def initialize
12
+ @file = nil
13
+ @key_modified = Hash.new
14
+ end
15
+
16
+ # The method to get the file
17
+ # @return An instance of Util::StreamWrapper
18
+
19
+ def file
20
+ @file
21
+ end
22
+
23
+ # The method to set the value to file
24
+ # @param file [Util::StreamWrapper] An instance of Util::StreamWrapper
25
+
26
+ def file=(file)
27
+ if file!=nil and !file.is_a? Util::StreamWrapper
28
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: Util::StreamWrapper', nil, nil)
29
+ end
30
+ @file = file
31
+ @key_modified['file'] = 1
32
+ end
33
+
34
+ # The method to check if the user has modified the given key
35
+ # @param key [String] A String
36
+ # @return A Integer value
37
+
38
+ def is_key_modified(key)
39
+ if key!=nil and !key.is_a? String
40
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
41
+ end
42
+ if @key_modified.key?(key)
43
+ return @key_modified[key]
44
+ end
45
+
46
+ nil
47
+ end
48
+
49
+ # The method to mark the given key as modified
50
+ # @param key [String] A String
51
+ # @param modification [Integer] A Integer
52
+
53
+ def set_key_modified(key, modification)
54
+ if key!=nil and !key.is_a? String
55
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
56
+ end
57
+ if modification!=nil and !modification.is_a? Integer
58
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
59
+ end
60
+ @key_modified[key] = modification
61
+ end
62
+
63
+ end
64
+ end