cloudmersive-configuration-api-client 1.7.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +121 -0
  4. data/Rakefile +8 -0
  5. data/cloudmersive-configuration-api-client.gemspec +45 -0
  6. data/docs/CreateSettingRequest.md +14 -0
  7. data/docs/CreateSettingResponse.md +11 -0
  8. data/docs/HttpFormDataParameter.md +11 -0
  9. data/docs/HttpGetParameter.md +10 -0
  10. data/docs/HttpOrchestrationHeader.md +10 -0
  11. data/docs/HttpOrchestrationRequest.md +8 -0
  12. data/docs/HttpOrchestrationResponse.md +11 -0
  13. data/docs/HttpOrchestrationTask.md +16 -0
  14. data/docs/HttpRawBinaryParameter.md +9 -0
  15. data/docs/HttpRawTextParameter.md +9 -0
  16. data/docs/HttpWwwFormUrlEncodedParameter.md +10 -0
  17. data/docs/ListSettingsRequest.md +9 -0
  18. data/docs/ListSettingsResponse.md +8 -0
  19. data/docs/OrchestratorApi.md +61 -0
  20. data/docs/SettingValue.md +15 -0
  21. data/docs/SettingsApi.md +167 -0
  22. data/docs/TaskOutputReference.md +9 -0
  23. data/docs/UpdateSettingRequest.md +10 -0
  24. data/docs/UpdateSettingResponse.md +9 -0
  25. data/git_push.sh +55 -0
  26. data/lib/cloudmersive-configuration-api-client.rb +58 -0
  27. data/lib/cloudmersive-configuration-api-client/api/orchestrator_api.rb +78 -0
  28. data/lib/cloudmersive-configuration-api-client/api/settings_api.rb +188 -0
  29. data/lib/cloudmersive-configuration-api-client/api_client.rb +389 -0
  30. data/lib/cloudmersive-configuration-api-client/api_error.rb +38 -0
  31. data/lib/cloudmersive-configuration-api-client/configuration.rb +209 -0
  32. data/lib/cloudmersive-configuration-api-client/models/create_setting_request.rb +249 -0
  33. data/lib/cloudmersive-configuration-api-client/models/create_setting_response.rb +219 -0
  34. data/lib/cloudmersive-configuration-api-client/models/http_form_data_parameter.rb +235 -0
  35. data/lib/cloudmersive-configuration-api-client/models/http_get_parameter.rb +209 -0
  36. data/lib/cloudmersive-configuration-api-client/models/http_orchestration_header.rb +209 -0
  37. data/lib/cloudmersive-configuration-api-client/models/http_orchestration_request.rb +191 -0
  38. data/lib/cloudmersive-configuration-api-client/models/http_orchestration_response.rb +235 -0
  39. data/lib/cloudmersive-configuration-api-client/models/http_orchestration_task.rb +277 -0
  40. data/lib/cloudmersive-configuration-api-client/models/http_raw_binary_parameter.rb +215 -0
  41. data/lib/cloudmersive-configuration-api-client/models/http_raw_text_parameter.rb +199 -0
  42. data/lib/cloudmersive-configuration-api-client/models/http_www_form_url_encoded_parameter.rb +209 -0
  43. data/lib/cloudmersive-configuration-api-client/models/list_settings_request.rb +199 -0
  44. data/lib/cloudmersive-configuration-api-client/models/list_settings_response.rb +191 -0
  45. data/lib/cloudmersive-configuration-api-client/models/setting_value.rb +259 -0
  46. data/lib/cloudmersive-configuration-api-client/models/task_output_reference.rb +199 -0
  47. data/lib/cloudmersive-configuration-api-client/models/update_setting_request.rb +206 -0
  48. data/lib/cloudmersive-configuration-api-client/models/update_setting_response.rb +197 -0
  49. data/lib/cloudmersive-configuration-api-client/version.rb +15 -0
  50. data/spec/api/orchestrator_api_spec.rb +47 -0
  51. data/spec/api/settings_api_spec.rb +71 -0
  52. data/spec/api_client_spec.rb +226 -0
  53. data/spec/configuration_spec.rb +42 -0
  54. data/spec/models/create_setting_request_spec.rb +78 -0
  55. data/spec/models/create_setting_response_spec.rb +60 -0
  56. data/spec/models/http_form_data_parameter_spec.rb +60 -0
  57. data/spec/models/http_get_parameter_spec.rb +54 -0
  58. data/spec/models/http_orchestration_header_spec.rb +54 -0
  59. data/spec/models/http_orchestration_request_spec.rb +42 -0
  60. data/spec/models/http_orchestration_response_spec.rb +60 -0
  61. data/spec/models/http_orchestration_task_spec.rb +90 -0
  62. data/spec/models/http_raw_binary_parameter_spec.rb +48 -0
  63. data/spec/models/http_raw_text_parameter_spec.rb +48 -0
  64. data/spec/models/http_www_form_url_encoded_parameter_spec.rb +54 -0
  65. data/spec/models/list_settings_request_spec.rb +48 -0
  66. data/spec/models/list_settings_response_spec.rb +42 -0
  67. data/spec/models/setting_value_spec.rb +84 -0
  68. data/spec/models/task_output_reference_spec.rb +48 -0
  69. data/spec/models/update_setting_request_spec.rb +54 -0
  70. data/spec/models/update_setting_response_spec.rb +48 -0
  71. data/spec/spec_helper.rb +111 -0
  72. metadata +294 -0
@@ -0,0 +1,219 @@
1
+ =begin
2
+ #configapi
3
+
4
+ #Config API lets you easily manage configuration at scale.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveConfigurationApiClient
16
+ # Result of performing a create setting operation
17
+ class CreateSettingResponse
18
+ # True if the operation was successful, false otherwise
19
+ attr_accessor :successful
20
+
21
+ # SettingDefinitionID of the setting created
22
+ attr_accessor :setting_definition_id
23
+
24
+ # SettingValueID of the value of the setting
25
+ attr_accessor :setting_value_id
26
+
27
+ # Error message, if any, when the operation was not successful
28
+ attr_accessor :error_message
29
+
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+ :'successful' => :'Successful',
35
+ :'setting_definition_id' => :'SettingDefinitionID',
36
+ :'setting_value_id' => :'SettingValueID',
37
+ :'error_message' => :'ErrorMessage'
38
+ }
39
+ end
40
+
41
+ # Attribute type mapping.
42
+ def self.swagger_types
43
+ {
44
+ :'successful' => :'BOOLEAN',
45
+ :'setting_definition_id' => :'String',
46
+ :'setting_value_id' => :'String',
47
+ :'error_message' => :'String'
48
+ }
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ return unless attributes.is_a?(Hash)
55
+
56
+ # convert string to symbol for hash key
57
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
58
+
59
+ if attributes.has_key?(:'Successful')
60
+ self.successful = attributes[:'Successful']
61
+ end
62
+
63
+ if attributes.has_key?(:'SettingDefinitionID')
64
+ self.setting_definition_id = attributes[:'SettingDefinitionID']
65
+ end
66
+
67
+ if attributes.has_key?(:'SettingValueID')
68
+ self.setting_value_id = attributes[:'SettingValueID']
69
+ end
70
+
71
+ if attributes.has_key?(:'ErrorMessage')
72
+ self.error_message = attributes[:'ErrorMessage']
73
+ end
74
+
75
+ end
76
+
77
+ # Show invalid properties with the reasons. Usually used together with valid?
78
+ # @return Array for valid properties with the reasons
79
+ def list_invalid_properties
80
+ invalid_properties = Array.new
81
+ return invalid_properties
82
+ end
83
+
84
+ # Check to see if the all the properties in the model are valid
85
+ # @return true if the model is valid
86
+ def valid?
87
+ return true
88
+ end
89
+
90
+ # Checks equality by comparing each attribute.
91
+ # @param [Object] Object to be compared
92
+ def ==(o)
93
+ return true if self.equal?(o)
94
+ self.class == o.class &&
95
+ successful == o.successful &&
96
+ setting_definition_id == o.setting_definition_id &&
97
+ setting_value_id == o.setting_value_id &&
98
+ error_message == o.error_message
99
+ end
100
+
101
+ # @see the `==` method
102
+ # @param [Object] Object to be compared
103
+ def eql?(o)
104
+ self == o
105
+ end
106
+
107
+ # Calculates hash code according to all attributes.
108
+ # @return [Fixnum] Hash code
109
+ def hash
110
+ [successful, setting_definition_id, setting_value_id, error_message].hash
111
+ end
112
+
113
+ # Builds the object from hash
114
+ # @param [Hash] attributes Model attributes in the form of hash
115
+ # @return [Object] Returns the model itself
116
+ def build_from_hash(attributes)
117
+ return nil unless attributes.is_a?(Hash)
118
+ self.class.swagger_types.each_pair do |key, type|
119
+ if type =~ /\AArray<(.*)>/i
120
+ # check to ensure the input is an array given that the the attribute
121
+ # is documented as an array but the input is not
122
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
123
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
124
+ end
125
+ elsif !attributes[self.class.attribute_map[key]].nil?
126
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
127
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
128
+ end
129
+
130
+ self
131
+ end
132
+
133
+ # Deserializes the data based on type
134
+ # @param string type Data type
135
+ # @param string value Value to be deserialized
136
+ # @return [Object] Deserialized data
137
+ def _deserialize(type, value)
138
+ case type.to_sym
139
+ when :DateTime
140
+ DateTime.parse(value)
141
+ when :Date
142
+ Date.parse(value)
143
+ when :String
144
+ value.to_s
145
+ when :Integer
146
+ value.to_i
147
+ when :Float
148
+ value.to_f
149
+ when :BOOLEAN
150
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
151
+ true
152
+ else
153
+ false
154
+ end
155
+ when :Object
156
+ # generic object (usually a Hash), return directly
157
+ value
158
+ when /\AArray<(?<inner_type>.+)>\z/
159
+ inner_type = Regexp.last_match[:inner_type]
160
+ value.map { |v| _deserialize(inner_type, v) }
161
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
162
+ k_type = Regexp.last_match[:k_type]
163
+ v_type = Regexp.last_match[:v_type]
164
+ {}.tap do |hash|
165
+ value.each do |k, v|
166
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
167
+ end
168
+ end
169
+ else # model
170
+ temp_model = CloudmersiveConfigurationApiClient.const_get(type).new
171
+ temp_model.build_from_hash(value)
172
+ end
173
+ end
174
+
175
+ # Returns the string representation of the object
176
+ # @return [String] String presentation of the object
177
+ def to_s
178
+ to_hash.to_s
179
+ end
180
+
181
+ # to_body is an alias to to_hash (backward compatibility)
182
+ # @return [Hash] Returns the object in the form of hash
183
+ def to_body
184
+ to_hash
185
+ end
186
+
187
+ # Returns the object in the form of hash
188
+ # @return [Hash] Returns the object in the form of hash
189
+ def to_hash
190
+ hash = {}
191
+ self.class.attribute_map.each_pair do |attr, param|
192
+ value = self.send(attr)
193
+ next if value.nil?
194
+ hash[param] = _to_hash(value)
195
+ end
196
+ hash
197
+ end
198
+
199
+ # Outputs non-array value in the form of hash
200
+ # For object, use to_hash. Otherwise, just return the value
201
+ # @param [Object] value Any valid value
202
+ # @return [Hash] Returns the value in the form of hash
203
+ def _to_hash(value)
204
+ if value.is_a?(Array)
205
+ value.compact.map{ |v| _to_hash(v) }
206
+ elsif value.is_a?(Hash)
207
+ {}.tap do |hash|
208
+ value.each { |k, v| hash[k] = _to_hash(v) }
209
+ end
210
+ elsif value.respond_to? :to_hash
211
+ value.to_hash
212
+ else
213
+ value
214
+ end
215
+ end
216
+
217
+ end
218
+
219
+ end
@@ -0,0 +1,235 @@
1
+ =begin
2
+ #configapi
3
+
4
+ #Config API lets you easily manage configuration at scale.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveConfigurationApiClient
16
+ # Defines a parameter of type FormData (multipart/form-data)
17
+ class HttpFormDataParameter
18
+ # Name of the parameter
19
+ attr_accessor :parameter_name
20
+
21
+ # Text value of the parameter; if set, do not set ParameterFileContents or UseOutputFromPreviousTask
22
+ attr_accessor :parameter_text_value
23
+
24
+ # Binary contents of the parameter; if set, do not set ParameterTextValue or UseOutputFromPreviousTask
25
+ attr_accessor :parameter_file_contents
26
+
27
+ # Optional; use the output from a previous task as the input to this parameter. Set to null (default) to ignore.
28
+ attr_accessor :use_output_from_previous_task
29
+
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+ :'parameter_name' => :'ParameterName',
35
+ :'parameter_text_value' => :'ParameterTextValue',
36
+ :'parameter_file_contents' => :'ParameterFileContents',
37
+ :'use_output_from_previous_task' => :'UseOutputFromPreviousTask'
38
+ }
39
+ end
40
+
41
+ # Attribute type mapping.
42
+ def self.swagger_types
43
+ {
44
+ :'parameter_name' => :'String',
45
+ :'parameter_text_value' => :'String',
46
+ :'parameter_file_contents' => :'String',
47
+ :'use_output_from_previous_task' => :'TaskOutputReference'
48
+ }
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ return unless attributes.is_a?(Hash)
55
+
56
+ # convert string to symbol for hash key
57
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
58
+
59
+ if attributes.has_key?(:'ParameterName')
60
+ self.parameter_name = attributes[:'ParameterName']
61
+ end
62
+
63
+ if attributes.has_key?(:'ParameterTextValue')
64
+ self.parameter_text_value = attributes[:'ParameterTextValue']
65
+ end
66
+
67
+ if attributes.has_key?(:'ParameterFileContents')
68
+ self.parameter_file_contents = attributes[:'ParameterFileContents']
69
+ end
70
+
71
+ if attributes.has_key?(:'UseOutputFromPreviousTask')
72
+ self.use_output_from_previous_task = attributes[:'UseOutputFromPreviousTask']
73
+ end
74
+
75
+ end
76
+
77
+ # Show invalid properties with the reasons. Usually used together with valid?
78
+ # @return Array for valid properties with the reasons
79
+ def list_invalid_properties
80
+ invalid_properties = Array.new
81
+ if !@parameter_file_contents.nil? && @parameter_file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
82
+ invalid_properties.push("invalid value for 'parameter_file_contents', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.")
83
+ end
84
+
85
+ return invalid_properties
86
+ end
87
+
88
+ # Check to see if the all the properties in the model are valid
89
+ # @return true if the model is valid
90
+ def valid?
91
+ return false if !@parameter_file_contents.nil? && @parameter_file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
92
+ return true
93
+ end
94
+
95
+ # Custom attribute writer method with validation
96
+ # @param [Object] parameter_file_contents Value to be assigned
97
+ def parameter_file_contents=(parameter_file_contents)
98
+
99
+ if !parameter_file_contents.nil? && parameter_file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
100
+ fail ArgumentError, "invalid value for 'parameter_file_contents', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
101
+ end
102
+
103
+ @parameter_file_contents = parameter_file_contents
104
+ end
105
+
106
+ # Checks equality by comparing each attribute.
107
+ # @param [Object] Object to be compared
108
+ def ==(o)
109
+ return true if self.equal?(o)
110
+ self.class == o.class &&
111
+ parameter_name == o.parameter_name &&
112
+ parameter_text_value == o.parameter_text_value &&
113
+ parameter_file_contents == o.parameter_file_contents &&
114
+ use_output_from_previous_task == o.use_output_from_previous_task
115
+ end
116
+
117
+ # @see the `==` method
118
+ # @param [Object] Object to be compared
119
+ def eql?(o)
120
+ self == o
121
+ end
122
+
123
+ # Calculates hash code according to all attributes.
124
+ # @return [Fixnum] Hash code
125
+ def hash
126
+ [parameter_name, parameter_text_value, parameter_file_contents, use_output_from_previous_task].hash
127
+ end
128
+
129
+ # Builds the object from hash
130
+ # @param [Hash] attributes Model attributes in the form of hash
131
+ # @return [Object] Returns the model itself
132
+ def build_from_hash(attributes)
133
+ return nil unless attributes.is_a?(Hash)
134
+ self.class.swagger_types.each_pair do |key, type|
135
+ if type =~ /\AArray<(.*)>/i
136
+ # check to ensure the input is an array given that the the attribute
137
+ # is documented as an array but the input is not
138
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
139
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
140
+ end
141
+ elsif !attributes[self.class.attribute_map[key]].nil?
142
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
143
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
144
+ end
145
+
146
+ self
147
+ end
148
+
149
+ # Deserializes the data based on type
150
+ # @param string type Data type
151
+ # @param string value Value to be deserialized
152
+ # @return [Object] Deserialized data
153
+ def _deserialize(type, value)
154
+ case type.to_sym
155
+ when :DateTime
156
+ DateTime.parse(value)
157
+ when :Date
158
+ Date.parse(value)
159
+ when :String
160
+ value.to_s
161
+ when :Integer
162
+ value.to_i
163
+ when :Float
164
+ value.to_f
165
+ when :BOOLEAN
166
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
167
+ true
168
+ else
169
+ false
170
+ end
171
+ when :Object
172
+ # generic object (usually a Hash), return directly
173
+ value
174
+ when /\AArray<(?<inner_type>.+)>\z/
175
+ inner_type = Regexp.last_match[:inner_type]
176
+ value.map { |v| _deserialize(inner_type, v) }
177
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
178
+ k_type = Regexp.last_match[:k_type]
179
+ v_type = Regexp.last_match[:v_type]
180
+ {}.tap do |hash|
181
+ value.each do |k, v|
182
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
183
+ end
184
+ end
185
+ else # model
186
+ temp_model = CloudmersiveConfigurationApiClient.const_get(type).new
187
+ temp_model.build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ # Returns the string representation of the object
192
+ # @return [String] String presentation of the object
193
+ def to_s
194
+ to_hash.to_s
195
+ end
196
+
197
+ # to_body is an alias to to_hash (backward compatibility)
198
+ # @return [Hash] Returns the object in the form of hash
199
+ def to_body
200
+ to_hash
201
+ end
202
+
203
+ # Returns the object in the form of hash
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_hash
206
+ hash = {}
207
+ self.class.attribute_map.each_pair do |attr, param|
208
+ value = self.send(attr)
209
+ next if value.nil?
210
+ hash[param] = _to_hash(value)
211
+ end
212
+ hash
213
+ end
214
+
215
+ # Outputs non-array value in the form of hash
216
+ # For object, use to_hash. Otherwise, just return the value
217
+ # @param [Object] value Any valid value
218
+ # @return [Hash] Returns the value in the form of hash
219
+ def _to_hash(value)
220
+ if value.is_a?(Array)
221
+ value.compact.map{ |v| _to_hash(v) }
222
+ elsif value.is_a?(Hash)
223
+ {}.tap do |hash|
224
+ value.each { |k, v| hash[k] = _to_hash(v) }
225
+ end
226
+ elsif value.respond_to? :to_hash
227
+ value.to_hash
228
+ else
229
+ value
230
+ end
231
+ end
232
+
233
+ end
234
+
235
+ end