ZCRMSDK 2.0.0 → 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (174) hide show
  1. checksums.yaml +4 -4
  2. data/src/ZCRMSDK.rb +87 -2
  3. data/src/com/zoho/api/authenticator/oauth_token.rb +86 -31
  4. data/src/com/zoho/api/authenticator/store/db_store.rb +71 -29
  5. data/src/com/zoho/api/authenticator/store/file_store.rb +91 -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 +42 -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 +1127 -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 +215 -61
  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_module_lookup.rb +99 -0
  57. data/src/com/zoho/crm/api/fields/multi_select_lookup.rb +19 -0
  58. data/src/com/zoho/crm/api/fields/multi_user_lookup.rb +175 -0
  59. data/src/com/zoho/crm/api/fields/pick_list_value.rb +19 -0
  60. data/src/com/zoho/crm/api/fields/related_details.rb +19 -0
  61. data/src/com/zoho/crm/api/files/file_operations.rb +2 -2
  62. data/src/com/zoho/crm/api/initializer.rb +45 -17
  63. data/src/com/zoho/crm/api/inventory_templates/api_exception.rb +121 -0
  64. data/src/com/zoho/crm/api/inventory_templates/inventory_template.rb +352 -0
  65. data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb +82 -0
  66. data/src/com/zoho/crm/api/inventory_templates/response_handler.rb +10 -0
  67. data/src/com/zoho/crm/api/inventory_templates/response_wrapper.rb +83 -0
  68. data/src/com/zoho/crm/api/layouts/layout.rb +38 -0
  69. data/src/com/zoho/crm/api/layouts/layouts_operations.rb +2 -2
  70. data/src/com/zoho/crm/api/layouts/section.rb +19 -0
  71. data/src/com/zoho/crm/api/modules/module.rb +57 -0
  72. data/src/com/zoho/crm/api/modules/modules_operations.rb +4 -4
  73. data/src/com/zoho/crm/api/notes/note.rb +19 -0
  74. data/src/com/zoho/crm/api/notes/notes_operations.rb +7 -7
  75. data/src/com/zoho/crm/api/notification/notification_operations.rb +6 -6
  76. data/src/com/zoho/crm/api/org/hierarchy_preference.rb +61 -0
  77. data/src/com/zoho/crm/api/org/org.rb +38 -0
  78. data/src/com/zoho/crm/api/org/org_operations.rb +2 -2
  79. data/src/com/zoho/crm/api/pipeline/action_handler.rb +10 -0
  80. data/src/com/zoho/crm/api/pipeline/action_response.rb +10 -0
  81. data/src/com/zoho/crm/api/pipeline/action_wrapper.rb +63 -0
  82. data/src/com/zoho/crm/api/pipeline/api_exception.rb +129 -0
  83. data/src/com/zoho/crm/api/pipeline/body_wrapper.rb +61 -0
  84. data/src/com/zoho/crm/api/pipeline/forecast_category.rb +80 -0
  85. data/src/com/zoho/crm/api/pipeline/pick_list_value.rb +175 -0
  86. data/src/com/zoho/crm/api/pipeline/pipeline.rb +213 -0
  87. data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb +165 -0
  88. data/src/com/zoho/crm/api/pipeline/response_handler.rb +10 -0
  89. data/src/com/zoho/crm/api/pipeline/response_wrapper.rb +63 -0
  90. data/src/com/zoho/crm/api/pipeline/stage.rb +80 -0
  91. data/src/com/zoho/crm/api/pipeline/success_response.rb +123 -0
  92. data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb +10 -0
  93. data/src/com/zoho/crm/api/pipeline/transfer_action_response.rb +10 -0
  94. data/src/com/zoho/crm/api/pipeline/transfer_action_wrapper.rb +63 -0
  95. data/src/com/zoho/crm/api/pipeline/transfer_and_delete_wrapper.rb +61 -0
  96. data/src/com/zoho/crm/api/pipeline/transfer_pipe_line.rb +80 -0
  97. data/src/com/zoho/crm/api/profiles/category.rb +19 -0
  98. data/src/com/zoho/crm/api/profiles/default_view.rb +99 -0
  99. data/src/com/zoho/crm/api/profiles/profile.rb +49 -11
  100. data/src/com/zoho/crm/api/profiles/profiles_operations.rb +2 -2
  101. data/src/com/zoho/crm/api/query/query_operations.rb +1 -1
  102. data/src/com/zoho/crm/api/record/api_exception.rb +2 -0
  103. data/src/com/zoho/crm/api/record/body_wrapper.rb +0 -19
  104. data/src/com/zoho/crm/api/record/count_handler.rb +10 -0
  105. data/src/com/zoho/crm/api/record/count_wrapper.rb +63 -0
  106. data/src/com/zoho/crm/api/record/field.rb +17 -17
  107. data/src/com/zoho/crm/api/record/image_upload.rb +213 -0
  108. data/src/com/zoho/crm/api/record/line_tax.rb +19 -0
  109. data/src/com/zoho/crm/api/record/mass_update_body_wrapper.rb +4 -4
  110. data/src/com/zoho/crm/api/record/mass_update_territory.rb +80 -0
  111. data/src/com/zoho/crm/api/record/multi_select_lookup.rb +99 -0
  112. data/src/com/zoho/crm/api/record/multi_select_picklist.rb +80 -0
  113. data/src/com/zoho/crm/api/record/price_book.rb +31 -0
  114. data/src/com/zoho/crm/api/record/record_operations.rb +196 -26
  115. data/src/com/zoho/crm/api/record/tax.rb +80 -0
  116. data/src/com/zoho/crm/api/record/territory.rb +70 -12
  117. data/src/com/zoho/crm/api/record/widget.rb +80 -0
  118. data/src/com/zoho/crm/api/record/wizard.rb +80 -0
  119. data/src/com/zoho/crm/api/related_lists/related_lists_operations.rb +2 -2
  120. data/src/com/zoho/crm/api/related_records/related_records_operations.rb +6 -6
  121. data/src/com/zoho/crm/api/request_proxy.rb +3 -4
  122. data/src/com/zoho/crm/api/roles/roles_operations.rb +2 -2
  123. data/src/com/zoho/crm/api/sdk_config.rb +2 -68
  124. data/src/com/zoho/crm/api/send_mail/action_handler.rb +10 -0
  125. data/src/com/zoho/crm/api/send_mail/action_response.rb +10 -0
  126. data/src/com/zoho/crm/api/send_mail/action_wrapper.rb +63 -0
  127. data/src/com/zoho/crm/api/send_mail/api_exception.rb +125 -0
  128. data/src/com/zoho/crm/api/send_mail/body_wrapper.rb +61 -0
  129. data/src/com/zoho/crm/api/send_mail/data_subject_request.rb +80 -0
  130. data/src/com/zoho/crm/api/send_mail/inventory_details.rb +100 -0
  131. data/src/com/zoho/crm/api/send_mail/mail.rb +423 -0
  132. data/src/com/zoho/crm/api/send_mail/response_handler.rb +10 -0
  133. data/src/com/zoho/crm/api/send_mail/response_wrapper.rb +63 -0
  134. data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb +61 -0
  135. data/src/com/zoho/crm/api/send_mail/success_response.rb +121 -0
  136. data/src/com/zoho/crm/api/send_mail/template.rb +10 -0
  137. data/src/com/zoho/crm/api/send_mail/user_address.rb +137 -0
  138. data/src/com/zoho/crm/api/share_records/share_records_operations.rb +4 -4
  139. data/src/com/zoho/crm/api/tags/tag.rb +19 -0
  140. data/src/com/zoho/crm/api/tags/tags_operations.rb +11 -11
  141. data/src/com/zoho/crm/api/taxes/taxes_operations.rb +6 -6
  142. data/src/com/zoho/crm/api/territories/response_wrapper.rb +20 -0
  143. data/src/com/zoho/crm/api/territories/territories_operations.rb +2 -2
  144. data/src/com/zoho/crm/api/territories/territory.rb +61 -23
  145. data/src/com/zoho/crm/api/users/user.rb +34 -0
  146. data/src/com/zoho/crm/api/users/users_operations.rb +6 -6
  147. data/src/com/zoho/crm/api/util/api_http_connector.rb +6 -5
  148. data/src/com/zoho/crm/api/util/common_api_handler.rb +5 -3
  149. data/src/com/zoho/crm/api/util/constants.rb +140 -15
  150. data/src/com/zoho/crm/api/util/converter.rb +30 -7
  151. data/src/com/zoho/crm/api/util/data_type_converter.rb +8 -2
  152. data/src/com/zoho/crm/api/util/form_data_converter.rb +4 -15
  153. data/src/com/zoho/crm/api/util/json_converter.rb +7 -9
  154. data/src/com/zoho/crm/api/util/module_fields_handler.rb +1 -1
  155. data/src/com/zoho/crm/api/util/utility.rb +274 -87
  156. data/src/com/zoho/crm/api/variable_groups/variable_groups_operations.rb +3 -3
  157. data/src/com/zoho/crm/api/variables/variables_operations.rb +9 -9
  158. data/src/com/zoho/crm/api/wizards/api_exception.rb +121 -0
  159. data/src/com/zoho/crm/api/wizards/button.rb +252 -0
  160. data/src/com/zoho/crm/api/wizards/chart_data.rb +118 -0
  161. data/src/com/zoho/crm/api/wizards/connection.rb +80 -0
  162. data/src/com/zoho/crm/api/wizards/container.rb +119 -0
  163. data/src/com/zoho/crm/api/wizards/node.rb +118 -0
  164. data/src/com/zoho/crm/api/wizards/response_handler.rb +10 -0
  165. data/src/com/zoho/crm/api/wizards/response_wrapper.rb +63 -0
  166. data/src/com/zoho/crm/api/wizards/screen.rb +99 -0
  167. data/src/com/zoho/crm/api/wizards/segment.rb +176 -0
  168. data/src/com/zoho/crm/api/wizards/transition.rb +80 -0
  169. data/src/com/zoho/crm/api/wizards/wizard.rb +273 -0
  170. data/src/com/zoho/crm/api/wizards/wizards_operations.rb +61 -0
  171. data/src/resources/JSONDetails.json +1 -1
  172. data/src/version.rb +1 -1
  173. metadata +92 -7
  174. data/src/com/zoho/crm/api/record/inventory_line_items.rb +0 -235
@@ -22,7 +22,7 @@ module Notification
22
22
  end
23
23
  handler_instance = Handler::CommonAPIHandler.new
24
24
  api_path = ''
25
- api_path = api_path + '/crm/v2/actions/watch'
25
+ api_path = api_path + '/crm/v2.1/actions/watch'
26
26
  handler_instance.api_path = api_path
27
27
  handler_instance.http_method = Constants::REQUEST_METHOD_POST
28
28
  handler_instance.category_method = 'CREATE'
@@ -43,7 +43,7 @@ module Notification
43
43
  end
44
44
  handler_instance = Handler::CommonAPIHandler.new
45
45
  api_path = ''
46
- api_path = api_path + '/crm/v2/actions/watch'
46
+ api_path = api_path + '/crm/v2.1/actions/watch'
47
47
  handler_instance.api_path = api_path
48
48
  handler_instance.http_method = Constants::REQUEST_METHOD_GET
49
49
  handler_instance.category_method = 'READ'
@@ -62,7 +62,7 @@ module Notification
62
62
  end
63
63
  handler_instance = Handler::CommonAPIHandler.new
64
64
  api_path = ''
65
- api_path = api_path + '/crm/v2/actions/watch'
65
+ api_path = api_path + '/crm/v2.1/actions/watch'
66
66
  handler_instance.api_path = api_path
67
67
  handler_instance.http_method = Constants::REQUEST_METHOD_PUT
68
68
  handler_instance.category_method = 'UPDATE'
@@ -83,7 +83,7 @@ module Notification
83
83
  end
84
84
  handler_instance = Handler::CommonAPIHandler.new
85
85
  api_path = ''
86
- api_path = api_path + '/crm/v2/actions/watch'
86
+ api_path = api_path + '/crm/v2.1/actions/watch'
87
87
  handler_instance.api_path = api_path
88
88
  handler_instance.http_method = Constants::REQUEST_METHOD_PATCH
89
89
  handler_instance.category_method = 'UPDATE'
@@ -104,7 +104,7 @@ module Notification
104
104
  end
105
105
  handler_instance = Handler::CommonAPIHandler.new
106
106
  api_path = ''
107
- api_path = api_path + '/crm/v2/actions/watch'
107
+ api_path = api_path + '/crm/v2.1/actions/watch'
108
108
  handler_instance.api_path = api_path
109
109
  handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
110
110
  handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
@@ -123,7 +123,7 @@ module Notification
123
123
  end
124
124
  handler_instance = Handler::CommonAPIHandler.new
125
125
  api_path = ''
126
- api_path = api_path + '/crm/v2/actions/watch'
126
+ api_path = api_path + '/crm/v2.1/actions/watch'
127
127
  handler_instance.api_path = api_path
128
128
  handler_instance.http_method = Constants::REQUEST_METHOD_PATCH
129
129
  handler_instance.category_method = 'UPDATE'
@@ -0,0 +1,61 @@
1
+ require_relative '../util/model'
2
+
3
+ module Org
4
+ class HierarchyPreference
5
+ include Util::Model
6
+
7
+ # Creates an instance of HierarchyPreference
8
+ def initialize
9
+ @type = nil
10
+ @key_modified = Hash.new
11
+ end
12
+
13
+ # The method to get the type
14
+ # @return A String value
15
+
16
+ def type
17
+ @type
18
+ end
19
+
20
+ # The method to set the value to type
21
+ # @param type [String] A String
22
+
23
+ def type=(type)
24
+ if type!=nil and !type.is_a? String
25
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
26
+ end
27
+ @type = type
28
+ @key_modified['type'] = 1
29
+ end
30
+
31
+ # The method to check if the user has modified the given key
32
+ # @param key [String] A String
33
+ # @return A Integer value
34
+
35
+ def is_key_modified(key)
36
+ if key!=nil and !key.is_a? String
37
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
38
+ end
39
+ if @key_modified.key?(key)
40
+ return @key_modified[key]
41
+ end
42
+
43
+ nil
44
+ end
45
+
46
+ # The method to mark the given key as modified
47
+ # @param key [String] A String
48
+ # @param modification [Integer] A Integer
49
+
50
+ def set_key_modified(key, modification)
51
+ if key!=nil and !key.is_a? String
52
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
53
+ end
54
+ if modification!=nil and !modification.is_a? Integer
55
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
56
+ end
57
+ @key_modified[key] = modification
58
+ end
59
+
60
+ end
61
+ end
@@ -7,6 +7,7 @@ module Org
7
7
  # Creates an instance of Org
8
8
  def initialize
9
9
  @country = nil
10
+ @hierarchy_preferences = nil
10
11
  @photo_id = nil
11
12
  @city = nil
12
13
  @description = nil
@@ -36,6 +37,7 @@ module Org
36
37
  @company_name = nil
37
38
  @privacy_settings = nil
38
39
  @primary_email = nil
40
+ @hipaa_compliance_enabled = nil
39
41
  @iso_code = nil
40
42
  @key_modified = Hash.new
41
43
  end
@@ -58,6 +60,24 @@ module Org
58
60
  @key_modified['country'] = 1
59
61
  end
60
62
 
63
+ # The method to get the hierarchy_preferences
64
+ # @return An instance of HierarchyPreference
65
+
66
+ def hierarchy_preferences
67
+ @hierarchy_preferences
68
+ end
69
+
70
+ # The method to set the value to hierarchy_preferences
71
+ # @param hierarchy_preferences [HierarchyPreference] An instance of HierarchyPreference
72
+
73
+ def hierarchy_preferences=(hierarchy_preferences)
74
+ if hierarchy_preferences!=nil and !hierarchy_preferences.is_a? HierarchyPreference
75
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: hierarchy_preferences EXPECTED TYPE: HierarchyPreference', nil, nil)
76
+ end
77
+ @hierarchy_preferences = hierarchy_preferences
78
+ @key_modified['hierarchy_preferences'] = 1
79
+ end
80
+
61
81
  # The method to get the photo_id
62
82
  # @return A String value
63
83
 
@@ -580,6 +600,24 @@ module Org
580
600
  @key_modified['primary_email'] = 1
581
601
  end
582
602
 
603
+ # The method to get the hipaa_compliance_enabled
604
+ # @return A Boolean value
605
+
606
+ def hipaa_compliance_enabled
607
+ @hipaa_compliance_enabled
608
+ end
609
+
610
+ # The method to set the value to hipaa_compliance_enabled
611
+ # @param hipaa_compliance_enabled [Boolean] A Boolean
612
+
613
+ def hipaa_compliance_enabled=(hipaa_compliance_enabled)
614
+ if hipaa_compliance_enabled!=nil and ! [true, false].include?hipaa_compliance_enabled
615
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: Boolean', nil, nil)
616
+ end
617
+ @hipaa_compliance_enabled = hipaa_compliance_enabled
618
+ @key_modified['hipaa_compliance_enabled'] = 1
619
+ end
620
+
583
621
  # The method to get the iso_code
584
622
  # @return A String value
585
623
 
@@ -16,7 +16,7 @@ module Org
16
16
  def get_organization
17
17
  handler_instance = Handler::CommonAPIHandler.new
18
18
  api_path = ''
19
- api_path = api_path + '/crm/v2/org'
19
+ api_path = api_path + '/crm/v2.1/org'
20
20
  handler_instance.api_path = api_path
21
21
  handler_instance.http_method = Constants::REQUEST_METHOD_GET
22
22
  handler_instance.category_method = 'READ'
@@ -34,7 +34,7 @@ module Org
34
34
  end
35
35
  handler_instance = Handler::CommonAPIHandler.new
36
36
  api_path = ''
37
- api_path = api_path + '/crm/v2/org/photo'
37
+ api_path = api_path + '/crm/v2.1/org/photo'
38
38
  handler_instance.api_path = api_path
39
39
  handler_instance.http_method = Constants::REQUEST_METHOD_POST
40
40
  handler_instance.category_method = 'CREATE'
@@ -0,0 +1,10 @@
1
+ module Pipeline
2
+ module ActionHandler
3
+
4
+ # Creates an instance of ActionHandler
5
+ def initialize
6
+ end
7
+
8
+
9
+ end
10
+ end
@@ -0,0 +1,10 @@
1
+ module Pipeline
2
+ module ActionResponse
3
+
4
+ # Creates an instance of ActionResponse
5
+ def initialize
6
+ end
7
+
8
+
9
+ end
10
+ end
@@ -0,0 +1,63 @@
1
+ require_relative '../util/model'
2
+
3
+ module Pipeline
4
+ require_relative 'action_handler'
5
+ class ActionWrapper
6
+ include Util::Model
7
+ include ActionHandler
8
+
9
+ # Creates an instance of ActionWrapper
10
+ def initialize
11
+ @pipeline = nil
12
+ @key_modified = Hash.new
13
+ end
14
+
15
+ # The method to get the pipeline
16
+ # @return An instance of Array
17
+
18
+ def pipeline
19
+ @pipeline
20
+ end
21
+
22
+ # The method to set the value to pipeline
23
+ # @param pipeline [Array] An instance of Array
24
+
25
+ def pipeline=(pipeline)
26
+ if pipeline!=nil and !pipeline.is_a? Array
27
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: Array', nil, nil)
28
+ end
29
+ @pipeline = pipeline
30
+ @key_modified['pipeline'] = 1
31
+ end
32
+
33
+ # The method to check if the user has modified the given key
34
+ # @param key [String] A String
35
+ # @return A Integer value
36
+
37
+ def is_key_modified(key)
38
+ if key!=nil and !key.is_a? String
39
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
40
+ end
41
+ if @key_modified.key?(key)
42
+ return @key_modified[key]
43
+ end
44
+
45
+ nil
46
+ end
47
+
48
+ # The method to mark the given key as modified
49
+ # @param key [String] A String
50
+ # @param modification [Integer] A Integer
51
+
52
+ def set_key_modified(key, modification)
53
+ if key!=nil and !key.is_a? String
54
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
55
+ end
56
+ if modification!=nil and !modification.is_a? Integer
57
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
58
+ end
59
+ @key_modified[key] = modification
60
+ end
61
+
62
+ end
63
+ end
@@ -0,0 +1,129 @@
1
+ require_relative '../util/choice'
2
+ require_relative '../util/model'
3
+
4
+ module Pipeline
5
+ require_relative 'transfer_action_response'
6
+ require_relative 'transfer_action_handler'
7
+ require_relative 'response_handler'
8
+ require_relative 'action_response'
9
+ require_relative 'action_handler'
10
+ class APIException
11
+ include Util::Model
12
+ include TransferActionResponse
13
+ include TransferActionHandler
14
+ include ResponseHandler
15
+ include ActionResponse
16
+ include ActionHandler
17
+
18
+ # Creates an instance of APIException
19
+ def initialize
20
+ @status = nil
21
+ @code = nil
22
+ @message = nil
23
+ @details = nil
24
+ @key_modified = Hash.new
25
+ end
26
+
27
+ # The method to get the status
28
+ # @return An instance of Util::Choice
29
+
30
+ def status
31
+ @status
32
+ end
33
+
34
+ # The method to set the value to status
35
+ # @param status [Util::Choice] An instance of Util::Choice
36
+
37
+ def status=(status)
38
+ if status!=nil and !status.is_a? Util::Choice
39
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
40
+ end
41
+ @status = status
42
+ @key_modified['status'] = 1
43
+ end
44
+
45
+ # The method to get the code
46
+ # @return An instance of Util::Choice
47
+
48
+ def code
49
+ @code
50
+ end
51
+
52
+ # The method to set the value to code
53
+ # @param code [Util::Choice] An instance of Util::Choice
54
+
55
+ def code=(code)
56
+ if code!=nil and !code.is_a? Util::Choice
57
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
58
+ end
59
+ @code = code
60
+ @key_modified['code'] = 1
61
+ end
62
+
63
+ # The method to get the message
64
+ # @return An instance of Util::Choice
65
+
66
+ def message
67
+ @message
68
+ end
69
+
70
+ # The method to set the value to message
71
+ # @param message [Util::Choice] An instance of Util::Choice
72
+
73
+ def message=(message)
74
+ if message!=nil and !message.is_a? Util::Choice
75
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
76
+ end
77
+ @message = message
78
+ @key_modified['message'] = 1
79
+ end
80
+
81
+ # The method to get the details
82
+ # @return An instance of Hash
83
+
84
+ def details
85
+ @details
86
+ end
87
+
88
+ # The method to set the value to details
89
+ # @param details [Hash] An instance of Hash
90
+
91
+ def details=(details)
92
+ if details!=nil and !details.is_a? Hash
93
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
94
+ end
95
+ @details = details
96
+ @key_modified['details'] = 1
97
+ end
98
+
99
+ # The method to check if the user has modified the given key
100
+ # @param key [String] A String
101
+ # @return A Integer value
102
+
103
+ def is_key_modified(key)
104
+ if key!=nil and !key.is_a? String
105
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
106
+ end
107
+ if @key_modified.key?(key)
108
+ return @key_modified[key]
109
+ end
110
+
111
+ nil
112
+ end
113
+
114
+ # The method to mark the given key as modified
115
+ # @param key [String] A String
116
+ # @param modification [Integer] A Integer
117
+
118
+ def set_key_modified(key, modification)
119
+ if key!=nil and !key.is_a? String
120
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
121
+ end
122
+ if modification!=nil and !modification.is_a? Integer
123
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
124
+ end
125
+ @key_modified[key] = modification
126
+ end
127
+
128
+ end
129
+ end
@@ -0,0 +1,61 @@
1
+ require_relative '../util/model'
2
+
3
+ module Pipeline
4
+ class BodyWrapper
5
+ include Util::Model
6
+
7
+ # Creates an instance of BodyWrapper
8
+ def initialize
9
+ @pipeline = nil
10
+ @key_modified = Hash.new
11
+ end
12
+
13
+ # The method to get the pipeline
14
+ # @return An instance of Array
15
+
16
+ def pipeline
17
+ @pipeline
18
+ end
19
+
20
+ # The method to set the value to pipeline
21
+ # @param pipeline [Array] An instance of Array
22
+
23
+ def pipeline=(pipeline)
24
+ if pipeline!=nil and !pipeline.is_a? Array
25
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: Array', nil, nil)
26
+ end
27
+ @pipeline = pipeline
28
+ @key_modified['pipeline'] = 1
29
+ end
30
+
31
+ # The method to check if the user has modified the given key
32
+ # @param key [String] A String
33
+ # @return A Integer value
34
+
35
+ def is_key_modified(key)
36
+ if key!=nil and !key.is_a? String
37
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
38
+ end
39
+ if @key_modified.key?(key)
40
+ return @key_modified[key]
41
+ end
42
+
43
+ nil
44
+ end
45
+
46
+ # The method to mark the given key as modified
47
+ # @param key [String] A String
48
+ # @param modification [Integer] A Integer
49
+
50
+ def set_key_modified(key, modification)
51
+ if key!=nil and !key.is_a? String
52
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
53
+ end
54
+ if modification!=nil and !modification.is_a? Integer
55
+ raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
56
+ end
57
+ @key_modified[key] = modification
58
+ end
59
+
60
+ end
61
+ end