docspring 1.4.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitlab-ci.yml +26 -0
- data/.openapi-generator/FILES +220 -0
- data/.openapi-generator/VERSION +1 -1
- data/.rubocop.yml +6 -12
- data/.travis.yml +11 -0
- data/CHANGELOG.md +9 -0
- data/Gemfile +5 -1
- data/Gemfile.lock +85 -48
- data/README.md +47 -16
- data/docs/AddFieldsData.md +13 -3
- data/docs/AddFieldsTemplateResponse.md +17 -5
- data/docs/AuthenticationError.md +15 -4
- data/docs/AuthenticationSuccessResponse.md +13 -3
- data/docs/CombinePdfsData.md +23 -7
- data/docs/CombinedSubmission.md +37 -12
- data/docs/CombinedSubmissionAction.md +23 -8
- data/docs/CombinedSubmissionData.md +21 -6
- data/docs/CopyTemplateData.md +15 -4
- data/docs/CreateCombinedSubmissionResponse.md +17 -5
- data/docs/CreateCustomFileData.md +13 -3
- data/docs/CreateCustomFileResponse.md +17 -5
- data/docs/CreateFolderAttributes.md +20 -0
- data/docs/CreateFolderData.md +13 -3
- data/docs/CreateHtmlTemplateData.md +13 -3
- data/docs/CreateSubmissionBatchResponse.md +21 -7
- data/docs/CreateSubmissionBatchSubmissionsResponse.md +17 -5
- data/docs/CreateSubmissionData.md +36 -0
- data/docs/CreateSubmissionDataRequestData.md +37 -15
- data/docs/CreateSubmissionDataRequestEventRequest.md +24 -0
- data/docs/CreateSubmissionDataRequestEventResponse.md +22 -0
- data/docs/CreateSubmissionDataRequestTokenResponse.md +17 -5
- data/docs/CreateSubmissionResponse.md +17 -5
- data/docs/CreateTemplateFromUploadData.md +13 -3
- data/docs/DataRequestToken.md +24 -0
- data/docs/DeleteTemplateResponse.md +20 -0
- data/docs/ErrorResponse.md +20 -0
- data/docs/Folder.md +19 -6
- data/docs/FullTemplate.md +94 -0
- data/docs/HtmlTemplateData.md +51 -19
- data/docs/HtmlTemplateDataWebhookOptions.md +18 -0
- data/docs/InvalidRequest.md +15 -4
- data/docs/InvalidRequestSingleError.md +20 -0
- data/docs/ListSubmissionsResponse.md +22 -0
- data/docs/MoveFolderData.md +13 -3
- data/docs/MoveTemplateData.md +13 -3
- data/docs/PDFApi.md +1746 -495
- data/docs/PendingTemplate.md +45 -19
- data/docs/PreviewPdfResponse.md +20 -0
- data/docs/PublishTemplateVersion404Response.md +20 -0
- data/docs/PublishTemplateVersion422Response.md +20 -0
- data/docs/PublishTemplateVersionResponse.md +20 -0
- data/docs/PublishTemplateVersionResponseResult.md +24 -0
- data/docs/PublishVersionData.md +20 -0
- data/docs/RenameFolderData.md +13 -3
- data/docs/RestoreTemplateVersionResponse.md +18 -0
- data/docs/RestoreVersionData.md +18 -0
- data/docs/Submission.md +49 -21
- data/docs/SubmissionAction.md +23 -8
- data/docs/SubmissionBatch.md +29 -11
- data/docs/SubmissionBatchData.md +21 -6
- data/docs/SubmissionData.md +23 -9
- data/docs/SubmissionDataBatchRequest.md +25 -8
- data/docs/SubmissionDataRequest.md +53 -22
- data/docs/SubmissionDataRequestEvent.md +30 -0
- data/docs/Template.md +51 -22
- data/docs/TemplateData.md +49 -18
- data/docs/TemplateDefaults.md +22 -0
- data/docs/TemplateDocument.md +22 -0
- data/docs/TemplateDocumentMetadata.md +22 -0
- data/docs/TemplateSchema.md +34 -0
- data/docs/UpdateDataRequestResponse.md +17 -5
- data/docs/UpdateSubmissionDataRequestData.md +37 -15
- data/docs/UpdateTemplateData.md +13 -3
- data/docs/UpdateTemplateResponse.md +15 -4
- data/docs/UploadPresign.md +24 -0
- data/docs/UploadTemplateData.md +53 -20
- data/docspring.gemspec +14 -11
- data/git_push.sh +11 -9
- data/lib/docspring/api/pdf_api.rb +1485 -497
- data/lib/docspring/api_client.rb +106 -98
- data/lib/docspring/api_error.rb +22 -2
- data/lib/docspring/configuration.rb +127 -16
- data/lib/docspring/models/add_fields_data.rb +59 -26
- data/lib/docspring/models/add_fields_template_response.rb +81 -43
- data/lib/docspring/models/authentication_error.rb +62 -29
- data/lib/docspring/models/authentication_success_response.rb +66 -28
- data/lib/docspring/models/combine_pdfs_data.rb +74 -32
- data/lib/docspring/models/combined_submission.rb +167 -68
- data/lib/docspring/models/combined_submission_action.rb +83 -39
- data/lib/docspring/models/combined_submission_data.rb +72 -30
- data/lib/docspring/models/copy_template_data.rb +59 -26
- data/lib/docspring/models/create_combined_submission_response.rb +86 -41
- data/lib/docspring/models/create_custom_file_data.rb +58 -25
- data/lib/docspring/models/create_custom_file_response.rb +86 -41
- data/lib/docspring/models/create_folder_attributes.rb +230 -0
- data/lib/docspring/models/create_folder_data.rb +59 -26
- data/lib/docspring/models/create_html_template_data.rb +58 -25
- data/lib/docspring/models/create_submission_batch_response.rb +104 -52
- data/lib/docspring/models/create_submission_batch_submissions_response.rb +79 -41
- data/lib/docspring/models/create_submission_data.rb +304 -0
- data/lib/docspring/models/create_submission_data_request_data.rb +139 -90
- data/lib/docspring/models/create_submission_data_request_event_request.rb +297 -0
- data/lib/docspring/models/create_submission_data_request_event_response.rb +282 -0
- data/lib/docspring/models/create_submission_data_request_token_response.rb +85 -40
- data/lib/docspring/models/create_submission_response.rb +86 -41
- data/lib/docspring/models/create_template_from_upload_data.rb +58 -25
- data/lib/docspring/models/{custom_file.rb → data_request_token.rb} +110 -33
- data/lib/docspring/models/delete_template_response.rb +266 -0
- data/lib/docspring/models/{error.rb → error_response.rb} +65 -30
- data/lib/docspring/models/folder.rb +78 -46
- data/lib/docspring/models/full_template.rb +801 -0
- data/lib/docspring/models/html_template_data.rb +180 -110
- data/lib/docspring/models/{folders_folder.rb → html_template_data_webhook_options.rb} +63 -41
- data/lib/docspring/models/invalid_request.rb +64 -29
- data/lib/docspring/models/invalid_request_single_error.rb +271 -0
- data/lib/docspring/models/list_submissions_response.rb +251 -0
- data/lib/docspring/models/move_folder_data.rb +56 -25
- data/lib/docspring/models/move_template_data.rb +58 -25
- data/lib/docspring/models/pending_template.rb +221 -118
- data/lib/docspring/models/preview_pdf_response.rb +264 -0
- data/lib/docspring/models/publish_template_version404_response.rb +271 -0
- data/lib/docspring/models/publish_template_version422_response.rb +273 -0
- data/lib/docspring/models/publish_template_version_response.rb +271 -0
- data/lib/docspring/models/publish_template_version_response_result.rb +263 -0
- data/lib/docspring/models/publish_version_data.rb +230 -0
- data/lib/docspring/models/rename_folder_data.rb +58 -25
- data/lib/docspring/models/restore_template_version_response.rb +255 -0
- data/lib/docspring/models/{create_submission_data_request_token_response_token.rb → restore_version_data.rb} +69 -58
- data/lib/docspring/models/submission.rb +98 -49
- data/lib/docspring/models/submission_action.rb +83 -39
- data/lib/docspring/models/submission_batch.rb +158 -75
- data/lib/docspring/models/submission_batch_data.rb +74 -30
- data/lib/docspring/models/submission_data.rb +65 -41
- data/lib/docspring/models/submission_data_batch_request.rb +100 -49
- data/lib/docspring/models/submission_data_request.rb +123 -54
- data/lib/docspring/models/submission_data_request_event.rb +309 -0
- data/lib/docspring/models/template.rb +267 -132
- data/lib/docspring/models/template_data.rb +173 -105
- data/lib/docspring/models/template_defaults.rb +249 -0
- data/lib/docspring/models/{upload_template_data_document.rb → template_document.rb} +91 -39
- data/lib/docspring/models/{upload_template_data_document_metadata.rb → template_document_metadata.rb} +94 -42
- data/lib/docspring/models/template_schema.rb +288 -0
- data/lib/docspring/models/update_data_request_response.rb +86 -41
- data/lib/docspring/models/update_submission_data_request_data.rb +82 -43
- data/lib/docspring/models/update_template_data.rb +58 -25
- data/lib/docspring/models/update_template_response.rb +79 -41
- data/lib/docspring/models/upload_presign.rb +296 -0
- data/lib/docspring/models/upload_template_data.rb +186 -116
- data/lib/docspring/version.rb +3 -3
- data/lib/docspring.rb +30 -10
- data/spec/api/client_integration_spec.rb +26 -19
- data/spec/api/pdf_api_integration_spec.rb +21 -19
- data/spec/api/pdf_api_spec_original.skipped.rb +469 -98
- data/spec/models/add_fields_data_spec.rb +8 -13
- data/spec/models/add_fields_template_response_spec.rb +16 -21
- data/spec/models/authentication_error_spec.rb +10 -15
- data/spec/models/authentication_success_response_spec.rb +9 -14
- data/spec/models/combine_pdfs_data_spec.rb +18 -17
- data/spec/models/combined_submission_action_spec.rb +16 -21
- data/spec/models/combined_submission_data_spec.rb +17 -16
- data/spec/models/combined_submission_spec.rb +45 -32
- data/spec/models/copy_template_data_spec.rb +9 -14
- data/spec/models/create_combined_submission_response_spec.rb +16 -21
- data/spec/models/create_custom_file_data_spec.rb +8 -13
- data/spec/models/create_custom_file_response_spec.rb +16 -21
- data/spec/models/create_folder_attributes_spec.rb +42 -0
- data/spec/models/create_folder_data_spec.rb +8 -13
- data/spec/models/create_html_template_data_spec.rb +8 -13
- data/spec/models/create_submission_batch_response_spec.rb +21 -26
- data/spec/models/create_submission_batch_submissions_response_spec.rb +16 -21
- data/spec/models/create_submission_data_request_data_spec.rb +33 -38
- data/spec/models/create_submission_data_request_event_request_spec.rb +62 -0
- data/spec/models/create_submission_data_request_event_response_spec.rb +52 -0
- data/spec/models/create_submission_data_request_token_response_spec.rb +15 -20
- data/spec/models/create_submission_data_spec.rb +90 -0
- data/spec/models/create_submission_response_spec.rb +16 -21
- data/spec/models/create_template_from_upload_data_spec.rb +8 -13
- data/spec/models/data_request_token_spec.rb +54 -0
- data/spec/models/delete_template_response_spec.rb +46 -0
- data/spec/models/error_response_spec.rb +46 -0
- data/spec/models/folder_spec.rb +15 -20
- data/spec/models/full_template_spec.rb +268 -0
- data/spec/models/html_template_data_spec.rb +62 -49
- data/spec/models/html_template_data_webhook_options_spec.rb +36 -0
- data/spec/models/invalid_request_single_error_spec.rb +46 -0
- data/spec/models/invalid_request_spec.rb +10 -15
- data/spec/models/list_submissions_response_spec.rb +48 -0
- data/spec/models/move_folder_data_spec.rb +8 -13
- data/spec/models/move_template_data_spec.rb +8 -13
- data/spec/models/pending_template_spec.rb +45 -50
- data/spec/models/preview_pdf_response_spec.rb +46 -0
- data/spec/models/publish_template_version404_response_spec.rb +46 -0
- data/spec/models/publish_template_version422_response_spec.rb +46 -0
- data/spec/models/publish_template_version_response_result_spec.rb +54 -0
- data/spec/models/publish_template_version_response_spec.rb +46 -0
- data/spec/models/publish_version_data_spec.rb +42 -0
- data/spec/models/rename_folder_data_spec.rb +8 -13
- data/spec/models/restore_template_version_response_spec.rb +40 -0
- data/spec/models/restore_version_data_spec.rb +36 -0
- data/spec/models/submission_action_spec.rb +16 -21
- data/spec/models/submission_batch_data_spec.rb +17 -16
- data/spec/models/submission_batch_spec.rb +29 -34
- data/spec/models/submission_data_batch_request_spec.rb +24 -23
- data/spec/models/submission_data_request_event_spec.rb +72 -0
- data/spec/models/submission_data_request_spec.rb +36 -35
- data/spec/models/submission_data_spec.rb +13 -24
- data/spec/models/submission_spec.rb +27 -32
- data/spec/models/template_data_spec.rb +59 -46
- data/spec/models/template_defaults_spec.rb +48 -0
- data/spec/models/template_document_metadata_spec.rb +52 -0
- data/spec/models/template_document_spec.rb +52 -0
- data/spec/models/template_schema_spec.rb +84 -0
- data/spec/models/template_spec.rb +50 -55
- data/spec/models/update_data_request_response_spec.rb +16 -21
- data/spec/models/update_submission_data_request_data_spec.rb +22 -27
- data/spec/models/update_template_data_spec.rb +8 -13
- data/spec/models/update_template_response_spec.rb +14 -19
- data/spec/models/upload_presign_spec.rb +58 -0
- data/spec/models/upload_template_data_spec.rb +64 -51
- data/spec/spec_helper.rb +5 -5
- metadata +112 -124
- data/docs/CreateSubmissionDataRequestTokenResponseToken.md +0 -11
- data/docs/CustomFile.md +0 -9
- data/docs/Error.md +0 -9
- data/docs/FoldersFolder.md +0 -9
- data/docs/TemplatestemplateIdaddFieldsFields.md +0 -92
- data/docs/UploadTemplateDataDocument.md +0 -10
- data/docs/UploadTemplateDataDocumentMetadata.md +0 -10
- data/lib/docspring/models/templatestemplate_idadd_fields_fields.rb +0 -1306
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -53
- data/spec/models/create_submission_data_request_token_response_token_spec.rb +0 -59
- data/spec/models/custom_file_spec.rb +0 -47
- data/spec/models/error_spec.rb +0 -51
- data/spec/models/folders_folder_spec.rb +0 -47
- data/spec/models/templatestemplate_idadd_fields_fields_spec.rb +0 -589
- data/spec/models/upload_template_data_document_metadata_spec.rb +0 -57
- data/spec/models/upload_template_data_document_spec.rb +0 -57
|
@@ -3,14 +3,15 @@
|
|
|
3
3
|
|
|
4
4
|
#DocSpring is a service that helps you fill out and sign PDF templates.
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: v1
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.11.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module DocSpring
|
|
16
17
|
class UpdateTemplateData
|
|
@@ -23,6 +24,11 @@ module DocSpring
|
|
|
23
24
|
}
|
|
24
25
|
end
|
|
25
26
|
|
|
27
|
+
# Returns all the JSON keys this model knows about
|
|
28
|
+
def self.acceptable_attributes
|
|
29
|
+
attribute_map.values
|
|
30
|
+
end
|
|
31
|
+
|
|
26
32
|
# Attribute type mapping.
|
|
27
33
|
def self.openapi_types
|
|
28
34
|
{
|
|
@@ -30,22 +36,38 @@ module DocSpring
|
|
|
30
36
|
}
|
|
31
37
|
end
|
|
32
38
|
|
|
39
|
+
# List of attributes with nullable: true
|
|
40
|
+
def self.openapi_nullable
|
|
41
|
+
Set.new([
|
|
42
|
+
])
|
|
43
|
+
end
|
|
44
|
+
|
|
33
45
|
# Initializes the object
|
|
34
46
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
35
47
|
def initialize(attributes = {})
|
|
36
|
-
|
|
48
|
+
if (!attributes.is_a?(Hash))
|
|
49
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::UpdateTemplateData` initialize method"
|
|
50
|
+
end
|
|
37
51
|
|
|
38
|
-
# convert string to symbol for hash key
|
|
39
|
-
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
52
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
53
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
54
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
55
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::UpdateTemplateData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
56
|
+
end
|
|
57
|
+
h[k.to_sym] = v
|
|
58
|
+
}
|
|
40
59
|
|
|
41
|
-
if attributes.
|
|
60
|
+
if attributes.key?(:'template')
|
|
42
61
|
self.template = attributes[:'template']
|
|
62
|
+
else
|
|
63
|
+
self.template = nil
|
|
43
64
|
end
|
|
44
65
|
end
|
|
45
66
|
|
|
46
67
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
47
68
|
# @return Array for valid properties with the reasons
|
|
48
69
|
def list_invalid_properties
|
|
70
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
49
71
|
invalid_properties = Array.new
|
|
50
72
|
if @template.nil?
|
|
51
73
|
invalid_properties.push('invalid value for "template", template cannot be nil.')
|
|
@@ -57,6 +79,7 @@ module DocSpring
|
|
|
57
79
|
# Check to see if the all the properties in the model are valid
|
|
58
80
|
# @return true if the model is valid
|
|
59
81
|
def valid?
|
|
82
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
60
83
|
return false if @template.nil?
|
|
61
84
|
true
|
|
62
85
|
end
|
|
@@ -76,7 +99,7 @@ module DocSpring
|
|
|
76
99
|
end
|
|
77
100
|
|
|
78
101
|
# Calculates hash code according to all attributes.
|
|
79
|
-
# @return [
|
|
102
|
+
# @return [Integer] Hash code
|
|
80
103
|
def hash
|
|
81
104
|
[template].hash
|
|
82
105
|
end
|
|
@@ -84,31 +107,34 @@ module DocSpring
|
|
|
84
107
|
# Builds the object from hash
|
|
85
108
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
86
109
|
# @return [Object] Returns the model itself
|
|
87
|
-
def build_from_hash(attributes)
|
|
110
|
+
def self.build_from_hash(attributes)
|
|
88
111
|
return nil unless attributes.is_a?(Hash)
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
112
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
113
|
+
transformed_hash = {}
|
|
114
|
+
openapi_types.each_pair do |key, type|
|
|
115
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
116
|
+
transformed_hash["#{key}"] = nil
|
|
117
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
118
|
+
# check to ensure the input is an array given that the attribute
|
|
92
119
|
# is documented as an array but the input is not
|
|
93
|
-
if attributes[
|
|
94
|
-
|
|
120
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
121
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
95
122
|
end
|
|
96
|
-
elsif !attributes[
|
|
97
|
-
|
|
98
|
-
end
|
|
123
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
124
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
125
|
+
end
|
|
99
126
|
end
|
|
100
|
-
|
|
101
|
-
self
|
|
127
|
+
new(transformed_hash)
|
|
102
128
|
end
|
|
103
129
|
|
|
104
130
|
# Deserializes the data based on type
|
|
105
131
|
# @param string type Data type
|
|
106
132
|
# @param string value Value to be deserialized
|
|
107
133
|
# @return [Object] Deserialized data
|
|
108
|
-
def _deserialize(type, value)
|
|
134
|
+
def self._deserialize(type, value)
|
|
109
135
|
case type.to_sym
|
|
110
|
-
when :
|
|
111
|
-
|
|
136
|
+
when :Time
|
|
137
|
+
Time.parse(value)
|
|
112
138
|
when :Date
|
|
113
139
|
Date.parse(value)
|
|
114
140
|
when :String
|
|
@@ -117,7 +143,7 @@ module DocSpring
|
|
|
117
143
|
value.to_i
|
|
118
144
|
when :Float
|
|
119
145
|
value.to_f
|
|
120
|
-
when :
|
|
146
|
+
when :Boolean
|
|
121
147
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
122
148
|
true
|
|
123
149
|
else
|
|
@@ -138,8 +164,9 @@ module DocSpring
|
|
|
138
164
|
end
|
|
139
165
|
end
|
|
140
166
|
else # model
|
|
141
|
-
|
|
142
|
-
|
|
167
|
+
# models (e.g. Pet) or oneOf
|
|
168
|
+
klass = DocSpring.const_get(type)
|
|
169
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
143
170
|
end
|
|
144
171
|
end
|
|
145
172
|
|
|
@@ -161,7 +188,11 @@ module DocSpring
|
|
|
161
188
|
hash = {}
|
|
162
189
|
self.class.attribute_map.each_pair do |attr, param|
|
|
163
190
|
value = self.send(attr)
|
|
164
|
-
|
|
191
|
+
if value.nil?
|
|
192
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
193
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
194
|
+
end
|
|
195
|
+
|
|
165
196
|
hash[param] = _to_hash(value)
|
|
166
197
|
end
|
|
167
198
|
hash
|
|
@@ -184,5 +215,7 @@ module DocSpring
|
|
|
184
215
|
value
|
|
185
216
|
end
|
|
186
217
|
end
|
|
218
|
+
|
|
187
219
|
end
|
|
220
|
+
|
|
188
221
|
end
|
|
@@ -3,21 +3,22 @@
|
|
|
3
3
|
|
|
4
4
|
#DocSpring is a service that helps you fill out and sign PDF templates.
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: v1
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.11.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module DocSpring
|
|
16
17
|
class UpdateTemplateResponse
|
|
17
|
-
attr_accessor :errors
|
|
18
|
-
|
|
19
18
|
attr_accessor :status
|
|
20
19
|
|
|
20
|
+
attr_accessor :errors
|
|
21
|
+
|
|
21
22
|
class EnumAttributeValidator
|
|
22
23
|
attr_reader :datatype
|
|
23
24
|
attr_reader :allowable_values
|
|
@@ -43,49 +44,76 @@ module DocSpring
|
|
|
43
44
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
44
45
|
def self.attribute_map
|
|
45
46
|
{
|
|
46
|
-
:'
|
|
47
|
-
:'
|
|
47
|
+
:'status' => :'status',
|
|
48
|
+
:'errors' => :'errors'
|
|
48
49
|
}
|
|
49
50
|
end
|
|
50
51
|
|
|
52
|
+
# Returns all the JSON keys this model knows about
|
|
53
|
+
def self.acceptable_attributes
|
|
54
|
+
attribute_map.values
|
|
55
|
+
end
|
|
56
|
+
|
|
51
57
|
# Attribute type mapping.
|
|
52
58
|
def self.openapi_types
|
|
53
59
|
{
|
|
54
|
-
:'
|
|
55
|
-
:'
|
|
60
|
+
:'status' => :'String',
|
|
61
|
+
:'errors' => :'Array<String>'
|
|
56
62
|
}
|
|
57
63
|
end
|
|
58
64
|
|
|
65
|
+
# List of attributes with nullable: true
|
|
66
|
+
def self.openapi_nullable
|
|
67
|
+
Set.new([
|
|
68
|
+
])
|
|
69
|
+
end
|
|
70
|
+
|
|
59
71
|
# Initializes the object
|
|
60
72
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
61
73
|
def initialize(attributes = {})
|
|
62
|
-
|
|
74
|
+
if (!attributes.is_a?(Hash))
|
|
75
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::UpdateTemplateResponse` initialize method"
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
79
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
80
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
81
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::UpdateTemplateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
82
|
+
end
|
|
83
|
+
h[k.to_sym] = v
|
|
84
|
+
}
|
|
63
85
|
|
|
64
|
-
|
|
65
|
-
|
|
86
|
+
if attributes.key?(:'status')
|
|
87
|
+
self.status = attributes[:'status']
|
|
88
|
+
else
|
|
89
|
+
self.status = nil
|
|
90
|
+
end
|
|
66
91
|
|
|
67
|
-
if attributes.
|
|
92
|
+
if attributes.key?(:'errors')
|
|
68
93
|
if (value = attributes[:'errors']).is_a?(Array)
|
|
69
94
|
self.errors = value
|
|
70
95
|
end
|
|
71
96
|
end
|
|
72
|
-
|
|
73
|
-
if attributes.has_key?(:'status')
|
|
74
|
-
self.status = attributes[:'status']
|
|
75
|
-
end
|
|
76
97
|
end
|
|
77
98
|
|
|
78
99
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
79
100
|
# @return Array for valid properties with the reasons
|
|
80
101
|
def list_invalid_properties
|
|
102
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
81
103
|
invalid_properties = Array.new
|
|
104
|
+
if @status.nil?
|
|
105
|
+
invalid_properties.push('invalid value for "status", status cannot be nil.')
|
|
106
|
+
end
|
|
107
|
+
|
|
82
108
|
invalid_properties
|
|
83
109
|
end
|
|
84
110
|
|
|
85
111
|
# Check to see if the all the properties in the model are valid
|
|
86
112
|
# @return true if the model is valid
|
|
87
113
|
def valid?
|
|
88
|
-
|
|
114
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
115
|
+
return false if @status.nil?
|
|
116
|
+
status_validator = EnumAttributeValidator.new('String', ["success", "error"])
|
|
89
117
|
return false unless status_validator.valid?(@status)
|
|
90
118
|
true
|
|
91
119
|
end
|
|
@@ -93,9 +121,9 @@ module DocSpring
|
|
|
93
121
|
# Custom attribute writer method checking allowed values (enum).
|
|
94
122
|
# @param [Object] status Object to be assigned
|
|
95
123
|
def status=(status)
|
|
96
|
-
validator = EnumAttributeValidator.new('String', [
|
|
124
|
+
validator = EnumAttributeValidator.new('String', ["success", "error"])
|
|
97
125
|
unless validator.valid?(status)
|
|
98
|
-
fail ArgumentError,
|
|
126
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
|
|
99
127
|
end
|
|
100
128
|
@status = status
|
|
101
129
|
end
|
|
@@ -105,8 +133,8 @@ module DocSpring
|
|
|
105
133
|
def ==(o)
|
|
106
134
|
return true if self.equal?(o)
|
|
107
135
|
self.class == o.class &&
|
|
108
|
-
|
|
109
|
-
|
|
136
|
+
status == o.status &&
|
|
137
|
+
errors == o.errors
|
|
110
138
|
end
|
|
111
139
|
|
|
112
140
|
# @see the `==` method
|
|
@@ -116,39 +144,42 @@ module DocSpring
|
|
|
116
144
|
end
|
|
117
145
|
|
|
118
146
|
# Calculates hash code according to all attributes.
|
|
119
|
-
# @return [
|
|
147
|
+
# @return [Integer] Hash code
|
|
120
148
|
def hash
|
|
121
|
-
[
|
|
149
|
+
[status, errors].hash
|
|
122
150
|
end
|
|
123
151
|
|
|
124
152
|
# Builds the object from hash
|
|
125
153
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
126
154
|
# @return [Object] Returns the model itself
|
|
127
|
-
def build_from_hash(attributes)
|
|
155
|
+
def self.build_from_hash(attributes)
|
|
128
156
|
return nil unless attributes.is_a?(Hash)
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
157
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
158
|
+
transformed_hash = {}
|
|
159
|
+
openapi_types.each_pair do |key, type|
|
|
160
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
161
|
+
transformed_hash["#{key}"] = nil
|
|
162
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
163
|
+
# check to ensure the input is an array given that the attribute
|
|
132
164
|
# is documented as an array but the input is not
|
|
133
|
-
if attributes[
|
|
134
|
-
|
|
165
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
166
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
135
167
|
end
|
|
136
|
-
elsif !attributes[
|
|
137
|
-
|
|
138
|
-
end
|
|
168
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
169
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
170
|
+
end
|
|
139
171
|
end
|
|
140
|
-
|
|
141
|
-
self
|
|
172
|
+
new(transformed_hash)
|
|
142
173
|
end
|
|
143
174
|
|
|
144
175
|
# Deserializes the data based on type
|
|
145
176
|
# @param string type Data type
|
|
146
177
|
# @param string value Value to be deserialized
|
|
147
178
|
# @return [Object] Deserialized data
|
|
148
|
-
def _deserialize(type, value)
|
|
179
|
+
def self._deserialize(type, value)
|
|
149
180
|
case type.to_sym
|
|
150
|
-
when :
|
|
151
|
-
|
|
181
|
+
when :Time
|
|
182
|
+
Time.parse(value)
|
|
152
183
|
when :Date
|
|
153
184
|
Date.parse(value)
|
|
154
185
|
when :String
|
|
@@ -157,7 +188,7 @@ module DocSpring
|
|
|
157
188
|
value.to_i
|
|
158
189
|
when :Float
|
|
159
190
|
value.to_f
|
|
160
|
-
when :
|
|
191
|
+
when :Boolean
|
|
161
192
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
162
193
|
true
|
|
163
194
|
else
|
|
@@ -178,8 +209,9 @@ module DocSpring
|
|
|
178
209
|
end
|
|
179
210
|
end
|
|
180
211
|
else # model
|
|
181
|
-
|
|
182
|
-
|
|
212
|
+
# models (e.g. Pet) or oneOf
|
|
213
|
+
klass = DocSpring.const_get(type)
|
|
214
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
183
215
|
end
|
|
184
216
|
end
|
|
185
217
|
|
|
@@ -201,7 +233,11 @@ module DocSpring
|
|
|
201
233
|
hash = {}
|
|
202
234
|
self.class.attribute_map.each_pair do |attr, param|
|
|
203
235
|
value = self.send(attr)
|
|
204
|
-
|
|
236
|
+
if value.nil?
|
|
237
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
238
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
239
|
+
end
|
|
240
|
+
|
|
205
241
|
hash[param] = _to_hash(value)
|
|
206
242
|
end
|
|
207
243
|
hash
|
|
@@ -224,5 +260,7 @@ module DocSpring
|
|
|
224
260
|
value
|
|
225
261
|
end
|
|
226
262
|
end
|
|
263
|
+
|
|
227
264
|
end
|
|
265
|
+
|
|
228
266
|
end
|