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 '../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 AssignmentRules
9
+ class AssignmentRulesOperations
10
+
11
+ # Creates an instance of AssignmentRulesOperations
12
+ def initialize
13
+ end
14
+
15
+ # The method to get assignment rules
16
+ # @return An instance of APIResponse
17
+ # @raise SDKException
18
+ def get_assignment_rules
19
+ handler_instance = Handler::CommonAPIHandler.new
20
+ api_path = ''
21
+ api_path = api_path + '/crm/v2.1/settings/automation/assignment_rules'
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 assignment rule
30
+ # @param rule_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_assignment_rule(rule_id, param_instance=nil)
35
+ if !rule_id.is_a? Integer
36
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: rule_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/automation/assignment_rules/'
44
+ api_path = api_path + rule_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 GetAssignmentRuleParam
54
+ @@module_1 = Param.new('module', 'com.zoho.crm.api.AssignmentRules.GetAssignmentRuleParam')
55
+ def self.module_1
56
+ @@module_1
57
+ end
58
+ end
59
+
60
+ end
61
+ end
@@ -0,0 +1,80 @@
1
+ require_relative '../util/model'
2
+
3
+ module AssignmentRules
4
+ class DefaultUser
5
+ include Util::Model
6
+
7
+ # Creates an instance of DefaultUser
8
+ def initialize
9
+ @name = nil
10
+ @id = nil
11
+ @key_modified = Hash.new
12
+ end
13
+
14
+ # The method to get the name
15
+ # @return A String value
16
+
17
+ def name
18
+ @name
19
+ end
20
+
21
+ # The method to set the value to name
22
+ # @param name [String] A String
23
+
24
+ def name=(name)
25
+ if name!=nil and !name.is_a? String
26
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
27
+ end
28
+ @name = name
29
+ @key_modified['name'] = 1
30
+ end
31
+
32
+ # The method to get the id
33
+ # @return A String value
34
+
35
+ def id
36
+ @id
37
+ end
38
+
39
+ # The method to set the value to id
40
+ # @param id [String] A String
41
+
42
+ def id=(id)
43
+ if id!=nil and !id.is_a? String
44
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: String', nil, nil)
45
+ end
46
+ @id = id
47
+ @key_modified['id'] = 1
48
+ end
49
+
50
+ # The method to check if the user has modified the given key
51
+ # @param key [String] A String
52
+ # @return A Integer value
53
+
54
+ def is_key_modified(key)
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 @key_modified.key?(key)
59
+ return @key_modified[key]
60
+ end
61
+
62
+ nil
63
+ end
64
+
65
+ # The method to mark the given key as modified
66
+ # @param key [String] A String
67
+ # @param modification [Integer] A Integer
68
+
69
+ def set_key_modified(key, modification)
70
+ if key!=nil and !key.is_a? String
71
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
72
+ end
73
+ if modification!=nil and !modification.is_a? Integer
74
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
75
+ end
76
+ @key_modified[key] = modification
77
+ end
78
+
79
+ end
80
+ end
@@ -0,0 +1,10 @@
1
+ module AssignmentRules
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 AssignmentRules
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
+ @assignment_rules = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the assignment_rules
16
+ # @return An instance of Array
17
+
18
+ def assignment_rules
19
+ @assignment_rules
20
+ end
21
+
22
+ # The method to set the value to assignment_rules
23
+ # @param assignment_rules [Array] An instance of Array
24
+
25
+ def assignment_rules=(assignment_rules)
26
+ if assignment_rules!=nil and !assignment_rules.is_a? Array
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: assignment_rules EXPECTED TYPE: Array', nil, nil)
28
+ end
29
+ @assignment_rules = assignment_rules
30
+ @key_modified['assignment_rules'] = 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
@@ -245,18 +245,18 @@ module Attachments
245
245
  end
246
246
 
247
247
  # The method to get the id
248
- # @return A Integer value
248
+ # @return A String value
249
249
 
250
250
  def id
251
251
  @id
252
252
  end
253
253
 
254
254
  # The method to set the value to id
255
- # @param id [Integer] A Integer
255
+ # @param id [String] A String
256
256
 
257
257
  def id=(id)
258
- if id!=nil and !id.is_a? Integer
259
- raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
258
+ if id!=nil and !id.is_a? String
259
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: String', nil, nil)
260
260
  end
261
261
  @id = id
262
262
  @key_modified['id'] = 1
@@ -32,7 +32,7 @@ module Attachments
32
32
  end
33
33
  handler_instance = Handler::CommonAPIHandler.new
34
34
  api_path = ''
35
- api_path = api_path + '/crm/v2/'
35
+ api_path = api_path + '/crm/v2.1/'
36
36
  api_path = api_path + @module_api_name.to_s
37
37
  api_path = api_path + '/'
38
38
  api_path = api_path + @record_id.to_s
@@ -55,7 +55,7 @@ module Attachments
55
55
  end
56
56
  handler_instance = Handler::CommonAPIHandler.new
57
57
  api_path = ''
58
- api_path = api_path + '/crm/v2/'
58
+ api_path = api_path + '/crm/v2.1/'
59
59
  api_path = api_path + @module_api_name.to_s
60
60
  api_path = api_path + '/'
61
61
  api_path = api_path + @record_id.to_s
@@ -78,7 +78,7 @@ module Attachments
78
78
  end
79
79
  handler_instance = Handler::CommonAPIHandler.new
80
80
  api_path = ''
81
- api_path = api_path + '/crm/v2/'
81
+ api_path = api_path + '/crm/v2.1/'
82
82
  api_path = api_path + @module_api_name.to_s
83
83
  api_path = api_path + '/'
84
84
  api_path = api_path + @record_id.to_s
@@ -101,7 +101,7 @@ module Attachments
101
101
  end
102
102
  handler_instance = Handler::CommonAPIHandler.new
103
103
  api_path = ''
104
- api_path = api_path + '/crm/v2/'
104
+ api_path = api_path + '/crm/v2.1/'
105
105
  api_path = api_path + @module_api_name.to_s
106
106
  api_path = api_path + '/'
107
107
  api_path = api_path + @record_id.to_s
@@ -126,7 +126,7 @@ module Attachments
126
126
  end
127
127
  handler_instance = Handler::CommonAPIHandler.new
128
128
  api_path = ''
129
- api_path = api_path + '/crm/v2/'
129
+ api_path = api_path + '/crm/v2.1/'
130
130
  api_path = api_path + @module_api_name.to_s
131
131
  api_path = api_path + '/'
132
132
  api_path = api_path + @record_id.to_s
@@ -150,7 +150,7 @@ module Attachments
150
150
  end
151
151
  handler_instance = Handler::CommonAPIHandler.new
152
152
  api_path = ''
153
- api_path = api_path + '/crm/v2/'
153
+ api_path = api_path + '/crm/v2.1/'
154
154
  api_path = api_path + @module_api_name.to_s
155
155
  api_path = api_path + '/'
156
156
  api_path = api_path + @record_id.to_s
@@ -26,7 +26,7 @@ module BluePrint
26
26
  def get_blueprint
27
27
  handler_instance = Handler::CommonAPIHandler.new
28
28
  api_path = ''
29
- api_path = api_path + '/crm/v2/'
29
+ api_path = api_path + '/crm/v2.1/'
30
30
  api_path = api_path + @module_api_name.to_s
31
31
  api_path = api_path + '/'
32
32
  api_path = api_path + @record_id.to_s
@@ -48,7 +48,7 @@ module BluePrint
48
48
  end
49
49
  handler_instance = Handler::CommonAPIHandler.new
50
50
  api_path = ''
51
- api_path = api_path + '/crm/v2/'
51
+ api_path = api_path + '/crm/v2.1/'
52
52
  api_path = api_path + @module_api_name.to_s
53
53
  api_path = api_path + '/'
54
54
  api_path = api_path + @record_id.to_s
@@ -0,0 +1,80 @@
1
+ require_relative '../util/model'
2
+
3
+ module BluePrint
4
+ class Escalation
5
+ include Util::Model
6
+
7
+ # Creates an instance of Escalation
8
+ def initialize
9
+ @days = nil
10
+ @status = nil
11
+ @key_modified = Hash.new
12
+ end
13
+
14
+ # The method to get the days
15
+ # @return A Integer value
16
+
17
+ def days
18
+ @days
19
+ end
20
+
21
+ # The method to set the value to days
22
+ # @param days [Integer] A Integer
23
+
24
+ def days=(days)
25
+ if days!=nil and !days.is_a? Integer
26
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: Integer', nil, nil)
27
+ end
28
+ @days = days
29
+ @key_modified['days'] = 1
30
+ end
31
+
32
+ # The method to get the status
33
+ # @return A String value
34
+
35
+ def status
36
+ @status
37
+ end
38
+
39
+ # The method to set the value to status
40
+ # @param status [String] A String
41
+
42
+ def status=(status)
43
+ if status!=nil and !status.is_a? String
44
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: String', nil, nil)
45
+ end
46
+ @status = status
47
+ @key_modified['status'] = 1
48
+ end
49
+
50
+ # The method to check if the user has modified the given key
51
+ # @param key [String] A String
52
+ # @return A Integer value
53
+
54
+ def is_key_modified(key)
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 @key_modified.key?(key)
59
+ return @key_modified[key]
60
+ end
61
+
62
+ nil
63
+ end
64
+
65
+ # The method to mark the given key as modified
66
+ # @param key [String] A String
67
+ # @param modification [Integer] A Integer
68
+
69
+ def set_key_modified(key, modification)
70
+ if key!=nil and !key.is_a? String
71
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
72
+ end
73
+ if modification!=nil and !modification.is_a? Integer
74
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
75
+ end
76
+ @key_modified[key] = modification
77
+ end
78
+
79
+ end
80
+ end
@@ -0,0 +1,1107 @@
1
+ require_relative '../custom_views/criteria'
2
+ require_relative '../fields/association_details'
3
+ require_relative '../fields/auto_number'
4
+ require_relative '../fields/crypt'
5
+ require_relative '../fields/currency'
6
+ require_relative '../fields/external'
7
+ require_relative '../fields/formula'
8
+ require_relative '../fields/history_tracking'
9
+ require_relative '../fields/module'
10
+ require_relative '../fields/multi_select_lookup'
11
+ require_relative '../fields/multi_user_lookup'
12
+ require_relative '../fields/pick_list_value'
13
+ require_relative '../fields/private'
14
+ require_relative '../fields/related_details'
15
+ require_relative '../fields/tool_tip'
16
+ require_relative '../fields/unique'
17
+ require_relative '../fields/view_type'
18
+ require_relative '../layouts/layout'
19
+ require_relative '../profiles/profile'
20
+ require_relative '../util/choice'
21
+ require_relative '../util/model'
22
+
23
+ module BluePrint
24
+ class Field
25
+ include Util::Model
26
+
27
+ # Creates an instance of Field
28
+ def initialize
29
+ @system_mandatory = nil
30
+ @webhook = nil
31
+ @private = nil
32
+ @layouts = nil
33
+ @profiles = nil
34
+ @sequence_number = nil
35
+ @content = nil
36
+ @column_name = nil
37
+ @type = nil
38
+ @transition_sequence = nil
39
+ @personality_name = nil
40
+ @message = nil
41
+ @mandatory = nil
42
+ @criteria = nil
43
+ @related_details = nil
44
+ @json_type = nil
45
+ @crypt = nil
46
+ @field_label = nil
47
+ @tooltip = nil
48
+ @created_source = nil
49
+ @field_read_only = nil
50
+ @display_label = nil
51
+ @ui_type = nil
52
+ @read_only = nil
53
+ @association_details = nil
54
+ @quick_sequence_number = nil
55
+ @businesscard_supported = nil
56
+ @multi_module_lookup = nil
57
+ @currency = nil
58
+ @id = nil
59
+ @custom_field = nil
60
+ @lookup = nil
61
+ @visible = nil
62
+ @pick_list_values_sorted_lexically = nil
63
+ @length = nil
64
+ @view_type = nil
65
+ @subform = nil
66
+ @api_name = nil
67
+ @sortable = nil
68
+ @unique = nil
69
+ @data_type = nil
70
+ @formula = nil
71
+ @decimal_place = nil
72
+ @mass_update = nil
73
+ @blueprint_supported = nil
74
+ @multiselectlookup = nil
75
+ @multiuserlookup = nil
76
+ @pick_list_values = nil
77
+ @auto_number = nil
78
+ @default_value = nil
79
+ @validation_rule = nil
80
+ @convert_mapping = nil
81
+ @external = nil
82
+ @history_tracking = nil
83
+ @display_type = nil
84
+ @key_modified = Hash.new
85
+ end
86
+
87
+ # The method to get the system_mandatory
88
+ # @return A Boolean value
89
+
90
+ def system_mandatory
91
+ @system_mandatory
92
+ end
93
+
94
+ # The method to set the value to system_mandatory
95
+ # @param system_mandatory [Boolean] A Boolean
96
+
97
+ def system_mandatory=(system_mandatory)
98
+ if system_mandatory!=nil and ! [true, false].include?system_mandatory
99
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: Boolean', nil, nil)
100
+ end
101
+ @system_mandatory = system_mandatory
102
+ @key_modified['system_mandatory'] = 1
103
+ end
104
+
105
+ # The method to get the webhook
106
+ # @return A Boolean value
107
+
108
+ def webhook
109
+ @webhook
110
+ end
111
+
112
+ # The method to set the value to webhook
113
+ # @param webhook [Boolean] A Boolean
114
+
115
+ def webhook=(webhook)
116
+ if webhook!=nil and ! [true, false].include?webhook
117
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: Boolean', nil, nil)
118
+ end
119
+ @webhook = webhook
120
+ @key_modified['webhook'] = 1
121
+ end
122
+
123
+ # The method to get the private
124
+ # @return An instance of Fields::Private
125
+
126
+ def private
127
+ @private
128
+ end
129
+
130
+ # The method to set the value to private
131
+ # @param private [Fields::Private] An instance of Fields::Private
132
+
133
+ def private=(private)
134
+ if private!=nil and !private.is_a? Fields::Private
135
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', nil, nil)
136
+ end
137
+ @private = private
138
+ @key_modified['private'] = 1
139
+ end
140
+
141
+ # The method to get the layouts
142
+ # @return An instance of Layouts::Layout
143
+
144
+ def layouts
145
+ @layouts
146
+ end
147
+
148
+ # The method to set the value to layouts
149
+ # @param layouts [Layouts::Layout] An instance of Layouts::Layout
150
+
151
+ def layouts=(layouts)
152
+ if layouts!=nil and !layouts.is_a? Layouts::Layout
153
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: Layout', nil, nil)
154
+ end
155
+ @layouts = layouts
156
+ @key_modified['layouts'] = 1
157
+ end
158
+
159
+ # The method to get the profiles
160
+ # @return An instance of Array
161
+
162
+ def profiles
163
+ @profiles
164
+ end
165
+
166
+ # The method to set the value to profiles
167
+ # @param profiles [Array] An instance of Array
168
+
169
+ def profiles=(profiles)
170
+ if profiles!=nil and !profiles.is_a? Array
171
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: Array', nil, nil)
172
+ end
173
+ @profiles = profiles
174
+ @key_modified['profiles'] = 1
175
+ end
176
+
177
+ # The method to get the sequence_number
178
+ # @return A Integer value
179
+
180
+ def sequence_number
181
+ @sequence_number
182
+ end
183
+
184
+ # The method to set the value to sequence_number
185
+ # @param sequence_number [Integer] A Integer
186
+
187
+ def sequence_number=(sequence_number)
188
+ if sequence_number!=nil and !sequence_number.is_a? Integer
189
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: Integer', nil, nil)
190
+ end
191
+ @sequence_number = sequence_number
192
+ @key_modified['sequence_number'] = 1
193
+ end
194
+
195
+ # The method to get the content
196
+ # @return A String value
197
+
198
+ def content
199
+ @content
200
+ end
201
+
202
+ # The method to set the value to content
203
+ # @param content [String] A String
204
+
205
+ def content=(content)
206
+ if content!=nil and !content.is_a? String
207
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: String', nil, nil)
208
+ end
209
+ @content = content
210
+ @key_modified['content'] = 1
211
+ end
212
+
213
+ # The method to get the column_name
214
+ # @return A String value
215
+
216
+ def column_name
217
+ @column_name
218
+ end
219
+
220
+ # The method to set the value to column_name
221
+ # @param column_name [String] A String
222
+
223
+ def column_name=(column_name)
224
+ if column_name!=nil and !column_name.is_a? String
225
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: String', nil, nil)
226
+ end
227
+ @column_name = column_name
228
+ @key_modified['column_name'] = 1
229
+ end
230
+
231
+ # The method to get the type
232
+ # @return A String value
233
+
234
+ def type
235
+ @type
236
+ end
237
+
238
+ # The method to set the value to type
239
+ # @param type [String] A String
240
+
241
+ def type=(type)
242
+ if type!=nil and !type.is_a? String
243
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
244
+ end
245
+ @type = type
246
+ @key_modified['_type'] = 1
247
+ end
248
+
249
+ # The method to get the transition_sequence
250
+ # @return A Integer value
251
+
252
+ def transition_sequence
253
+ @transition_sequence
254
+ end
255
+
256
+ # The method to set the value to transition_sequence
257
+ # @param transition_sequence [Integer] A Integer
258
+
259
+ def transition_sequence=(transition_sequence)
260
+ if transition_sequence!=nil and !transition_sequence.is_a? Integer
261
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: transition_sequence EXPECTED TYPE: Integer', nil, nil)
262
+ end
263
+ @transition_sequence = transition_sequence
264
+ @key_modified['transition_sequence'] = 1
265
+ end
266
+
267
+ # The method to get the personality_name
268
+ # @return A String value
269
+
270
+ def personality_name
271
+ @personality_name
272
+ end
273
+
274
+ # The method to set the value to personality_name
275
+ # @param personality_name [String] A String
276
+
277
+ def personality_name=(personality_name)
278
+ if personality_name!=nil and !personality_name.is_a? String
279
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: personality_name EXPECTED TYPE: String', nil, nil)
280
+ end
281
+ @personality_name = personality_name
282
+ @key_modified['personality_name'] = 1
283
+ end
284
+
285
+ # The method to get the message
286
+ # @return A String value
287
+
288
+ def message
289
+ @message
290
+ end
291
+
292
+ # The method to set the value to message
293
+ # @param message [String] A String
294
+
295
+ def message=(message)
296
+ if message!=nil and !message.is_a? String
297
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: String', nil, nil)
298
+ end
299
+ @message = message
300
+ @key_modified['message'] = 1
301
+ end
302
+
303
+ # The method to get the mandatory
304
+ # @return A Boolean value
305
+
306
+ def mandatory
307
+ @mandatory
308
+ end
309
+
310
+ # The method to set the value to mandatory
311
+ # @param mandatory [Boolean] A Boolean
312
+
313
+ def mandatory=(mandatory)
314
+ if mandatory!=nil and ! [true, false].include?mandatory
315
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mandatory EXPECTED TYPE: Boolean', nil, nil)
316
+ end
317
+ @mandatory = mandatory
318
+ @key_modified['mandatory'] = 1
319
+ end
320
+
321
+ # The method to get the criteria
322
+ # @return An instance of CustomViews::Criteria
323
+
324
+ def criteria
325
+ @criteria
326
+ end
327
+
328
+ # The method to set the value to criteria
329
+ # @param criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
330
+
331
+ def criteria=(criteria)
332
+ if criteria!=nil and !criteria.is_a? CustomViews::Criteria
333
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
334
+ end
335
+ @criteria = criteria
336
+ @key_modified['criteria'] = 1
337
+ end
338
+
339
+ # The method to get the related_details
340
+ # @return An instance of Fields::RelatedDetails
341
+
342
+ def related_details
343
+ @related_details
344
+ end
345
+
346
+ # The method to set the value to related_details
347
+ # @param related_details [Fields::RelatedDetails] An instance of Fields::RelatedDetails
348
+
349
+ def related_details=(related_details)
350
+ if related_details!=nil and !related_details.is_a? Fields::RelatedDetails
351
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_details EXPECTED TYPE: RelatedDetails', nil, nil)
352
+ end
353
+ @related_details = related_details
354
+ @key_modified['related_details'] = 1
355
+ end
356
+
357
+ # The method to get the json_type
358
+ # @return A String value
359
+
360
+ def json_type
361
+ @json_type
362
+ end
363
+
364
+ # The method to set the value to json_type
365
+ # @param json_type [String] A String
366
+
367
+ def json_type=(json_type)
368
+ if json_type!=nil and !json_type.is_a? String
369
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: String', nil, nil)
370
+ end
371
+ @json_type = json_type
372
+ @key_modified['json_type'] = 1
373
+ end
374
+
375
+ # The method to get the crypt
376
+ # @return An instance of Fields::Crypt
377
+
378
+ def crypt
379
+ @crypt
380
+ end
381
+
382
+ # The method to set the value to crypt
383
+ # @param crypt [Fields::Crypt] An instance of Fields::Crypt
384
+
385
+ def crypt=(crypt)
386
+ if crypt!=nil and !crypt.is_a? Fields::Crypt
387
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', nil, nil)
388
+ end
389
+ @crypt = crypt
390
+ @key_modified['crypt'] = 1
391
+ end
392
+
393
+ # The method to get the field_label
394
+ # @return A String value
395
+
396
+ def field_label
397
+ @field_label
398
+ end
399
+
400
+ # The method to set the value to field_label
401
+ # @param field_label [String] A String
402
+
403
+ def field_label=(field_label)
404
+ if field_label!=nil and !field_label.is_a? String
405
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: String', nil, nil)
406
+ end
407
+ @field_label = field_label
408
+ @key_modified['field_label'] = 1
409
+ end
410
+
411
+ # The method to get the tooltip
412
+ # @return An instance of Fields::ToolTip
413
+
414
+ def tooltip
415
+ @tooltip
416
+ end
417
+
418
+ # The method to set the value to tooltip
419
+ # @param tooltip [Fields::ToolTip] An instance of Fields::ToolTip
420
+
421
+ def tooltip=(tooltip)
422
+ if tooltip!=nil and !tooltip.is_a? Fields::ToolTip
423
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: ToolTip', nil, nil)
424
+ end
425
+ @tooltip = tooltip
426
+ @key_modified['tooltip'] = 1
427
+ end
428
+
429
+ # The method to get the created_source
430
+ # @return A String value
431
+
432
+ def created_source
433
+ @created_source
434
+ end
435
+
436
+ # The method to set the value to created_source
437
+ # @param created_source [String] A String
438
+
439
+ def created_source=(created_source)
440
+ if created_source!=nil and !created_source.is_a? String
441
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: String', nil, nil)
442
+ end
443
+ @created_source = created_source
444
+ @key_modified['created_source'] = 1
445
+ end
446
+
447
+ # The method to get the field_read_only
448
+ # @return A Boolean value
449
+
450
+ def field_read_only
451
+ @field_read_only
452
+ end
453
+
454
+ # The method to set the value to field_read_only
455
+ # @param field_read_only [Boolean] A Boolean
456
+
457
+ def field_read_only=(field_read_only)
458
+ if field_read_only!=nil and ! [true, false].include?field_read_only
459
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: Boolean', nil, nil)
460
+ end
461
+ @field_read_only = field_read_only
462
+ @key_modified['field_read_only'] = 1
463
+ end
464
+
465
+ # The method to get the display_label
466
+ # @return A String value
467
+
468
+ def display_label
469
+ @display_label
470
+ end
471
+
472
+ # The method to set the value to display_label
473
+ # @param display_label [String] A String
474
+
475
+ def display_label=(display_label)
476
+ if display_label!=nil and !display_label.is_a? String
477
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
478
+ end
479
+ @display_label = display_label
480
+ @key_modified['display_label'] = 1
481
+ end
482
+
483
+ # The method to get the ui_type
484
+ # @return A Integer value
485
+
486
+ def ui_type
487
+ @ui_type
488
+ end
489
+
490
+ # The method to set the value to ui_type
491
+ # @param ui_type [Integer] A Integer
492
+
493
+ def ui_type=(ui_type)
494
+ if ui_type!=nil and !ui_type.is_a? Integer
495
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: Integer', nil, nil)
496
+ end
497
+ @ui_type = ui_type
498
+ @key_modified['ui_type'] = 1
499
+ end
500
+
501
+ # The method to get the read_only
502
+ # @return A Boolean value
503
+
504
+ def read_only
505
+ @read_only
506
+ end
507
+
508
+ # The method to set the value to read_only
509
+ # @param read_only [Boolean] A Boolean
510
+
511
+ def read_only=(read_only)
512
+ if read_only!=nil and ! [true, false].include?read_only
513
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: Boolean', nil, nil)
514
+ end
515
+ @read_only = read_only
516
+ @key_modified['read_only'] = 1
517
+ end
518
+
519
+ # The method to get the association_details
520
+ # @return An instance of Fields::AssociationDetails
521
+
522
+ def association_details
523
+ @association_details
524
+ end
525
+
526
+ # The method to set the value to association_details
527
+ # @param association_details [Fields::AssociationDetails] An instance of Fields::AssociationDetails
528
+
529
+ def association_details=(association_details)
530
+ if association_details!=nil and !association_details.is_a? Fields::AssociationDetails
531
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', nil, nil)
532
+ end
533
+ @association_details = association_details
534
+ @key_modified['association_details'] = 1
535
+ end
536
+
537
+ # The method to get the quick_sequence_number
538
+ # @return A Integer value
539
+
540
+ def quick_sequence_number
541
+ @quick_sequence_number
542
+ end
543
+
544
+ # The method to set the value to quick_sequence_number
545
+ # @param quick_sequence_number [Integer] A Integer
546
+
547
+ def quick_sequence_number=(quick_sequence_number)
548
+ if quick_sequence_number!=nil and !quick_sequence_number.is_a? Integer
549
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: Integer', nil, nil)
550
+ end
551
+ @quick_sequence_number = quick_sequence_number
552
+ @key_modified['quick_sequence_number'] = 1
553
+ end
554
+
555
+ # The method to get the businesscard_supported
556
+ # @return A Boolean value
557
+
558
+ def businesscard_supported
559
+ @businesscard_supported
560
+ end
561
+
562
+ # The method to set the value to businesscard_supported
563
+ # @param businesscard_supported [Boolean] A Boolean
564
+
565
+ def businesscard_supported=(businesscard_supported)
566
+ if businesscard_supported!=nil and ! [true, false].include?businesscard_supported
567
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: Boolean', nil, nil)
568
+ end
569
+ @businesscard_supported = businesscard_supported
570
+ @key_modified['businesscard_supported'] = 1
571
+ end
572
+
573
+ # The method to get the multi_module_lookup
574
+ # @return An instance of Hash
575
+
576
+ def multi_module_lookup
577
+ @multi_module_lookup
578
+ end
579
+
580
+ # The method to set the value to multi_module_lookup
581
+ # @param multi_module_lookup [Hash] An instance of Hash
582
+
583
+ def multi_module_lookup=(multi_module_lookup)
584
+ if multi_module_lookup!=nil and !multi_module_lookup.is_a? Hash
585
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: Hash', nil, nil)
586
+ end
587
+ @multi_module_lookup = multi_module_lookup
588
+ @key_modified['multi_module_lookup'] = 1
589
+ end
590
+
591
+ # The method to get the currency
592
+ # @return An instance of Fields::Currency
593
+
594
+ def currency
595
+ @currency
596
+ end
597
+
598
+ # The method to set the value to currency
599
+ # @param currency [Fields::Currency] An instance of Fields::Currency
600
+
601
+ def currency=(currency)
602
+ if currency!=nil and !currency.is_a? Fields::Currency
603
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', nil, nil)
604
+ end
605
+ @currency = currency
606
+ @key_modified['currency'] = 1
607
+ end
608
+
609
+ # The method to get the id
610
+ # @return A Integer value
611
+
612
+ def id
613
+ @id
614
+ end
615
+
616
+ # The method to set the value to id
617
+ # @param id [Integer] A Integer
618
+
619
+ def id=(id)
620
+ if id!=nil and !id.is_a? Integer
621
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
622
+ end
623
+ @id = id
624
+ @key_modified['id'] = 1
625
+ end
626
+
627
+ # The method to get the custom_field
628
+ # @return A Boolean value
629
+
630
+ def custom_field
631
+ @custom_field
632
+ end
633
+
634
+ # The method to set the value to custom_field
635
+ # @param custom_field [Boolean] A Boolean
636
+
637
+ def custom_field=(custom_field)
638
+ if custom_field!=nil and ! [true, false].include?custom_field
639
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: Boolean', nil, nil)
640
+ end
641
+ @custom_field = custom_field
642
+ @key_modified['custom_field'] = 1
643
+ end
644
+
645
+ # The method to get the lookup
646
+ # @return An instance of Fields::Module
647
+
648
+ def lookup
649
+ @lookup
650
+ end
651
+
652
+ # The method to set the value to lookup
653
+ # @param lookup [Fields::Module] An instance of Fields::Module
654
+
655
+ def lookup=(lookup)
656
+ if lookup!=nil and !lookup.is_a? Fields::Module
657
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Module', nil, nil)
658
+ end
659
+ @lookup = lookup
660
+ @key_modified['lookup'] = 1
661
+ end
662
+
663
+ # The method to get the visible
664
+ # @return A Boolean value
665
+
666
+ def visible
667
+ @visible
668
+ end
669
+
670
+ # The method to set the value to visible
671
+ # @param visible [Boolean] A Boolean
672
+
673
+ def visible=(visible)
674
+ if visible!=nil and ! [true, false].include?visible
675
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: Boolean', nil, nil)
676
+ end
677
+ @visible = visible
678
+ @key_modified['visible'] = 1
679
+ end
680
+
681
+ # The method to get the pick_list_values_sorted_lexically
682
+ # @return A Boolean value
683
+
684
+ def pick_list_values_sorted_lexically
685
+ @pick_list_values_sorted_lexically
686
+ end
687
+
688
+ # The method to set the value to pick_list_values_sorted_lexically
689
+ # @param pick_list_values_sorted_lexically [Boolean] A Boolean
690
+
691
+ def pick_list_values_sorted_lexically=(pick_list_values_sorted_lexically)
692
+ if pick_list_values_sorted_lexically!=nil and ! [true, false].include?pick_list_values_sorted_lexically
693
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: Boolean', nil, nil)
694
+ end
695
+ @pick_list_values_sorted_lexically = pick_list_values_sorted_lexically
696
+ @key_modified['pick_list_values_sorted_lexically'] = 1
697
+ end
698
+
699
+ # The method to get the length
700
+ # @return A Integer value
701
+
702
+ def length
703
+ @length
704
+ end
705
+
706
+ # The method to set the value to length
707
+ # @param length [Integer] A Integer
708
+
709
+ def length=(length)
710
+ if length!=nil and !length.is_a? Integer
711
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: Integer', nil, nil)
712
+ end
713
+ @length = length
714
+ @key_modified['length'] = 1
715
+ end
716
+
717
+ # The method to get the view_type
718
+ # @return An instance of Fields::ViewType
719
+
720
+ def view_type
721
+ @view_type
722
+ end
723
+
724
+ # The method to set the value to view_type
725
+ # @param view_type [Fields::ViewType] An instance of Fields::ViewType
726
+
727
+ def view_type=(view_type)
728
+ if view_type!=nil and !view_type.is_a? Fields::ViewType
729
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', nil, nil)
730
+ end
731
+ @view_type = view_type
732
+ @key_modified['view_type'] = 1
733
+ end
734
+
735
+ # The method to get the subform
736
+ # @return An instance of Fields::Module
737
+
738
+ def subform
739
+ @subform
740
+ end
741
+
742
+ # The method to set the value to subform
743
+ # @param subform [Fields::Module] An instance of Fields::Module
744
+
745
+ def subform=(subform)
746
+ if subform!=nil and !subform.is_a? Fields::Module
747
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Module', nil, nil)
748
+ end
749
+ @subform = subform
750
+ @key_modified['subform'] = 1
751
+ end
752
+
753
+ # The method to get the api_name
754
+ # @return A String value
755
+
756
+ def api_name
757
+ @api_name
758
+ end
759
+
760
+ # The method to set the value to api_name
761
+ # @param api_name [String] A String
762
+
763
+ def api_name=(api_name)
764
+ if api_name!=nil and !api_name.is_a? String
765
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
766
+ end
767
+ @api_name = api_name
768
+ @key_modified['api_name'] = 1
769
+ end
770
+
771
+ # The method to get the sortable
772
+ # @return A Boolean value
773
+
774
+ def sortable
775
+ @sortable
776
+ end
777
+
778
+ # The method to set the value to sortable
779
+ # @param sortable [Boolean] A Boolean
780
+
781
+ def sortable=(sortable)
782
+ if sortable!=nil and ! [true, false].include?sortable
783
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: Boolean', nil, nil)
784
+ end
785
+ @sortable = sortable
786
+ @key_modified['sortable'] = 1
787
+ end
788
+
789
+ # The method to get the unique
790
+ # @return An instance of Fields::Unique
791
+
792
+ def unique
793
+ @unique
794
+ end
795
+
796
+ # The method to set the value to unique
797
+ # @param unique [Fields::Unique] An instance of Fields::Unique
798
+
799
+ def unique=(unique)
800
+ if unique!=nil and !unique.is_a? Fields::Unique
801
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', nil, nil)
802
+ end
803
+ @unique = unique
804
+ @key_modified['unique'] = 1
805
+ end
806
+
807
+ # The method to get the data_type
808
+ # @return A String value
809
+
810
+ def data_type
811
+ @data_type
812
+ end
813
+
814
+ # The method to set the value to data_type
815
+ # @param data_type [String] A String
816
+
817
+ def data_type=(data_type)
818
+ if data_type!=nil and !data_type.is_a? String
819
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: String', nil, nil)
820
+ end
821
+ @data_type = data_type
822
+ @key_modified['data_type'] = 1
823
+ end
824
+
825
+ # The method to get the formula
826
+ # @return An instance of Fields::Formula
827
+
828
+ def formula
829
+ @formula
830
+ end
831
+
832
+ # The method to set the value to formula
833
+ # @param formula [Fields::Formula] An instance of Fields::Formula
834
+
835
+ def formula=(formula)
836
+ if formula!=nil and !formula.is_a? Fields::Formula
837
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', nil, nil)
838
+ end
839
+ @formula = formula
840
+ @key_modified['formula'] = 1
841
+ end
842
+
843
+ # The method to get the decimal_place
844
+ # @return A Integer value
845
+
846
+ def decimal_place
847
+ @decimal_place
848
+ end
849
+
850
+ # The method to set the value to decimal_place
851
+ # @param decimal_place [Integer] A Integer
852
+
853
+ def decimal_place=(decimal_place)
854
+ if decimal_place!=nil and !decimal_place.is_a? Integer
855
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: Integer', nil, nil)
856
+ end
857
+ @decimal_place = decimal_place
858
+ @key_modified['decimal_place'] = 1
859
+ end
860
+
861
+ # The method to get the mass_update
862
+ # @return A Boolean value
863
+
864
+ def mass_update
865
+ @mass_update
866
+ end
867
+
868
+ # The method to set the value to mass_update
869
+ # @param mass_update [Boolean] A Boolean
870
+
871
+ def mass_update=(mass_update)
872
+ if mass_update!=nil and ! [true, false].include?mass_update
873
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: Boolean', nil, nil)
874
+ end
875
+ @mass_update = mass_update
876
+ @key_modified['mass_update'] = 1
877
+ end
878
+
879
+ # The method to get the blueprint_supported
880
+ # @return A Boolean value
881
+
882
+ def blueprint_supported
883
+ @blueprint_supported
884
+ end
885
+
886
+ # The method to set the value to blueprint_supported
887
+ # @param blueprint_supported [Boolean] A Boolean
888
+
889
+ def blueprint_supported=(blueprint_supported)
890
+ if blueprint_supported!=nil and ! [true, false].include?blueprint_supported
891
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: Boolean', nil, nil)
892
+ end
893
+ @blueprint_supported = blueprint_supported
894
+ @key_modified['blueprint_supported'] = 1
895
+ end
896
+
897
+ # The method to get the multiselectlookup
898
+ # @return An instance of Fields::MultiSelectLookup
899
+
900
+ def multiselectlookup
901
+ @multiselectlookup
902
+ end
903
+
904
+ # The method to set the value to multiselectlookup
905
+ # @param multiselectlookup [Fields::MultiSelectLookup] An instance of Fields::MultiSelectLookup
906
+
907
+ def multiselectlookup=(multiselectlookup)
908
+ if multiselectlookup!=nil and !multiselectlookup.is_a? Fields::MultiSelectLookup
909
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: MultiSelectLookup', nil, nil)
910
+ end
911
+ @multiselectlookup = multiselectlookup
912
+ @key_modified['multiselectlookup'] = 1
913
+ end
914
+
915
+ # The method to get the multiuserlookup
916
+ # @return An instance of Fields::MultiUserLookup
917
+
918
+ def multiuserlookup
919
+ @multiuserlookup
920
+ end
921
+
922
+ # The method to set the value to multiuserlookup
923
+ # @param multiuserlookup [Fields::MultiUserLookup] An instance of Fields::MultiUserLookup
924
+
925
+ def multiuserlookup=(multiuserlookup)
926
+ if multiuserlookup!=nil and !multiuserlookup.is_a? Fields::MultiUserLookup
927
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: MultiUserLookup', nil, nil)
928
+ end
929
+ @multiuserlookup = multiuserlookup
930
+ @key_modified['multiuserlookup'] = 1
931
+ end
932
+
933
+ # The method to get the pick_list_values
934
+ # @return An instance of Array
935
+
936
+ def pick_list_values
937
+ @pick_list_values
938
+ end
939
+
940
+ # The method to set the value to pick_list_values
941
+ # @param pick_list_values [Array] An instance of Array
942
+
943
+ def pick_list_values=(pick_list_values)
944
+ if pick_list_values!=nil and !pick_list_values.is_a? Array
945
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: Array', nil, nil)
946
+ end
947
+ @pick_list_values = pick_list_values
948
+ @key_modified['pick_list_values'] = 1
949
+ end
950
+
951
+ # The method to get the auto_number
952
+ # @return An instance of Fields::AutoNumber
953
+
954
+ def auto_number
955
+ @auto_number
956
+ end
957
+
958
+ # The method to set the value to auto_number
959
+ # @param auto_number [Fields::AutoNumber] An instance of Fields::AutoNumber
960
+
961
+ def auto_number=(auto_number)
962
+ if auto_number!=nil and !auto_number.is_a? Fields::AutoNumber
963
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: auto_number EXPECTED TYPE: AutoNumber', nil, nil)
964
+ end
965
+ @auto_number = auto_number
966
+ @key_modified['auto_number'] = 1
967
+ end
968
+
969
+ # The method to get the default_value
970
+ # @return A String value
971
+
972
+ def default_value
973
+ @default_value
974
+ end
975
+
976
+ # The method to set the value to default_value
977
+ # @param default_value [String] A String
978
+
979
+ def default_value=(default_value)
980
+ if default_value!=nil and !default_value.is_a? String
981
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: String', nil, nil)
982
+ end
983
+ @default_value = default_value
984
+ @key_modified['default_value'] = 1
985
+ end
986
+
987
+ # The method to get the validation_rule
988
+ # @return An instance of Hash
989
+
990
+ def validation_rule
991
+ @validation_rule
992
+ end
993
+
994
+ # The method to set the value to validation_rule
995
+ # @param validation_rule [Hash] An instance of Hash
996
+
997
+ def validation_rule=(validation_rule)
998
+ if validation_rule!=nil and !validation_rule.is_a? Hash
999
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: validation_rule EXPECTED TYPE: Hash', nil, nil)
1000
+ end
1001
+ @validation_rule = validation_rule
1002
+ @key_modified['validation_rule'] = 1
1003
+ end
1004
+
1005
+ # The method to get the convert_mapping
1006
+ # @return An instance of Hash
1007
+
1008
+ def convert_mapping
1009
+ @convert_mapping
1010
+ end
1011
+
1012
+ # The method to set the value to convert_mapping
1013
+ # @param convert_mapping [Hash] An instance of Hash
1014
+
1015
+ def convert_mapping=(convert_mapping)
1016
+ if convert_mapping!=nil and !convert_mapping.is_a? Hash
1017
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: Hash', nil, nil)
1018
+ end
1019
+ @convert_mapping = convert_mapping
1020
+ @key_modified['convert_mapping'] = 1
1021
+ end
1022
+
1023
+ # The method to get the external
1024
+ # @return An instance of Fields::External
1025
+
1026
+ def external
1027
+ @external
1028
+ end
1029
+
1030
+ # The method to set the value to external
1031
+ # @param external [Fields::External] An instance of Fields::External
1032
+
1033
+ def external=(external)
1034
+ if external!=nil and !external.is_a? Fields::External
1035
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', nil, nil)
1036
+ end
1037
+ @external = external
1038
+ @key_modified['external'] = 1
1039
+ end
1040
+
1041
+ # The method to get the history_tracking
1042
+ # @return An instance of Fields::HistoryTracking
1043
+
1044
+ def history_tracking
1045
+ @history_tracking
1046
+ end
1047
+
1048
+ # The method to set the value to history_tracking
1049
+ # @param history_tracking [Fields::HistoryTracking] An instance of Fields::HistoryTracking
1050
+
1051
+ def history_tracking=(history_tracking)
1052
+ if history_tracking!=nil and !history_tracking.is_a? Fields::HistoryTracking
1053
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', nil, nil)
1054
+ end
1055
+ @history_tracking = history_tracking
1056
+ @key_modified['history_tracking'] = 1
1057
+ end
1058
+
1059
+ # The method to get the display_type
1060
+ # @return An instance of Util::Choice
1061
+
1062
+ def display_type
1063
+ @display_type
1064
+ end
1065
+
1066
+ # The method to set the value to display_type
1067
+ # @param display_type [Util::Choice] An instance of Util::Choice
1068
+
1069
+ def display_type=(display_type)
1070
+ if display_type!=nil and !display_type.is_a? Util::Choice
1071
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: Util::Choice', nil, nil)
1072
+ end
1073
+ @display_type = display_type
1074
+ @key_modified['display_type'] = 1
1075
+ end
1076
+
1077
+ # The method to check if the user has modified the given key
1078
+ # @param key [String] A String
1079
+ # @return A Integer value
1080
+
1081
+ def is_key_modified(key)
1082
+ if key!=nil and !key.is_a? String
1083
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
1084
+ end
1085
+ if @key_modified.key?(key)
1086
+ return @key_modified[key]
1087
+ end
1088
+
1089
+ nil
1090
+ end
1091
+
1092
+ # The method to mark the given key as modified
1093
+ # @param key [String] A String
1094
+ # @param modification [Integer] A Integer
1095
+
1096
+ def set_key_modified(key, modification)
1097
+ if key!=nil and !key.is_a? String
1098
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
1099
+ end
1100
+ if modification!=nil and !modification.is_a? Integer
1101
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
1102
+ end
1103
+ @key_modified[key] = modification
1104
+ end
1105
+
1106
+ end
1107
+ end