form_api 1.9.1 → 1.11.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/CHANGELOG.md +27 -10
- data/Gemfile.lock +1 -1
- data/README.md +17 -5
- data/docs/CreateFolderData.md +8 -0
- data/docs/Folder.md +11 -0
- data/docs/FoldersFolder.md +9 -0
- data/docs/MoveFolderData.md +8 -0
- data/docs/MoveTemplateData.md +8 -0
- data/docs/PDFApi.md +319 -6
- data/docs/PendingTemplate.md +2 -0
- data/docs/RenameFolderData.md +8 -0
- data/docs/Template.md +4 -0
- data/lib/form_api.rb +6 -0
- data/lib/form_api/api/pdf_api.rb +336 -2
- data/lib/form_api/models/create_folder_data.rb +188 -0
- data/lib/form_api/models/folder.rb +210 -0
- data/lib/form_api/models/folders_folder.rb +192 -0
- data/lib/form_api/models/move_folder_data.rb +183 -0
- data/lib/form_api/models/move_template_data.rb +183 -0
- data/lib/form_api/models/pending_template.rb +19 -1
- data/lib/form_api/models/rename_folder_data.rb +188 -0
- data/lib/form_api/models/submission.rb +2 -2
- data/lib/form_api/models/template.rb +40 -4
- data/lib/form_api/version.rb +1 -1
- data/spec/api/pdf_api_spec_original.skipped.rb +89 -3
- data/spec/models/create_folder_data_spec.rb +41 -0
- data/spec/models/folder_spec.rb +59 -0
- data/spec/models/folders_folder_spec.rb +47 -0
- data/spec/models/move_folder_data_spec.rb +41 -0
- data/spec/models/move_template_data_spec.rb +41 -0
- data/spec/models/pending_template_spec.rb +12 -0
- data/spec/models/rename_folder_data_spec.rb +41 -0
- data/spec/models/submission_spec.rb +1 -1
- data/spec/models/template_spec.rb +24 -0
- metadata +26 -2
@@ -0,0 +1,183 @@
|
|
1
|
+
=begin
|
2
|
+
#API v1
|
3
|
+
|
4
|
+
#FormAPI is a service that helps you fill out and sign PDF templates.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 3.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module FormAPI
|
16
|
+
class MoveFolderData
|
17
|
+
attr_accessor :parent_folder_id
|
18
|
+
|
19
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
20
|
+
def self.attribute_map
|
21
|
+
{
|
22
|
+
:'parent_folder_id' => :'parent_folder_id'
|
23
|
+
}
|
24
|
+
end
|
25
|
+
|
26
|
+
# Attribute type mapping.
|
27
|
+
def self.openapi_types
|
28
|
+
{
|
29
|
+
:'parent_folder_id' => :'String'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Initializes the object
|
34
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
35
|
+
def initialize(attributes = {})
|
36
|
+
return unless attributes.is_a?(Hash)
|
37
|
+
|
38
|
+
# convert string to symbol for hash key
|
39
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
40
|
+
|
41
|
+
if attributes.has_key?(:'parent_folder_id')
|
42
|
+
self.parent_folder_id = attributes[:'parent_folder_id']
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
47
|
+
# @return Array for valid properties with the reasons
|
48
|
+
def list_invalid_properties
|
49
|
+
invalid_properties = Array.new
|
50
|
+
invalid_properties
|
51
|
+
end
|
52
|
+
|
53
|
+
# Check to see if the all the properties in the model are valid
|
54
|
+
# @return true if the model is valid
|
55
|
+
def valid?
|
56
|
+
true
|
57
|
+
end
|
58
|
+
|
59
|
+
# Checks equality by comparing each attribute.
|
60
|
+
# @param [Object] Object to be compared
|
61
|
+
def ==(o)
|
62
|
+
return true if self.equal?(o)
|
63
|
+
self.class == o.class &&
|
64
|
+
parent_folder_id == o.parent_folder_id
|
65
|
+
end
|
66
|
+
|
67
|
+
# @see the `==` method
|
68
|
+
# @param [Object] Object to be compared
|
69
|
+
def eql?(o)
|
70
|
+
self == o
|
71
|
+
end
|
72
|
+
|
73
|
+
# Calculates hash code according to all attributes.
|
74
|
+
# @return [Fixnum] Hash code
|
75
|
+
def hash
|
76
|
+
[parent_folder_id].hash
|
77
|
+
end
|
78
|
+
|
79
|
+
# Builds the object from hash
|
80
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
81
|
+
# @return [Object] Returns the model itself
|
82
|
+
def build_from_hash(attributes)
|
83
|
+
return nil unless attributes.is_a?(Hash)
|
84
|
+
self.class.openapi_types.each_pair do |key, type|
|
85
|
+
if type =~ /\AArray<(.*)>/i
|
86
|
+
# check to ensure the input is an array given that the the attribute
|
87
|
+
# is documented as an array but the input is not
|
88
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
89
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
90
|
+
end
|
91
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
92
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
93
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
94
|
+
end
|
95
|
+
|
96
|
+
self
|
97
|
+
end
|
98
|
+
|
99
|
+
# Deserializes the data based on type
|
100
|
+
# @param string type Data type
|
101
|
+
# @param string value Value to be deserialized
|
102
|
+
# @return [Object] Deserialized data
|
103
|
+
def _deserialize(type, value)
|
104
|
+
case type.to_sym
|
105
|
+
when :DateTime
|
106
|
+
DateTime.parse(value)
|
107
|
+
when :Date
|
108
|
+
Date.parse(value)
|
109
|
+
when :String
|
110
|
+
value.to_s
|
111
|
+
when :Integer
|
112
|
+
value.to_i
|
113
|
+
when :Float
|
114
|
+
value.to_f
|
115
|
+
when :BOOLEAN
|
116
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
117
|
+
true
|
118
|
+
else
|
119
|
+
false
|
120
|
+
end
|
121
|
+
when :Object
|
122
|
+
# generic object (usually a Hash), return directly
|
123
|
+
value
|
124
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
125
|
+
inner_type = Regexp.last_match[:inner_type]
|
126
|
+
value.map { |v| _deserialize(inner_type, v) }
|
127
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
128
|
+
k_type = Regexp.last_match[:k_type]
|
129
|
+
v_type = Regexp.last_match[:v_type]
|
130
|
+
{}.tap do |hash|
|
131
|
+
value.each do |k, v|
|
132
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
133
|
+
end
|
134
|
+
end
|
135
|
+
else # model
|
136
|
+
temp_model = FormAPI.const_get(type).new
|
137
|
+
temp_model.build_from_hash(value)
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
141
|
+
# Returns the string representation of the object
|
142
|
+
# @return [String] String presentation of the object
|
143
|
+
def to_s
|
144
|
+
to_hash.to_s
|
145
|
+
end
|
146
|
+
|
147
|
+
# to_body is an alias to to_hash (backward compatibility)
|
148
|
+
# @return [Hash] Returns the object in the form of hash
|
149
|
+
def to_body
|
150
|
+
to_hash
|
151
|
+
end
|
152
|
+
|
153
|
+
# Returns the object in the form of hash
|
154
|
+
# @return [Hash] Returns the object in the form of hash
|
155
|
+
def to_hash
|
156
|
+
hash = {}
|
157
|
+
self.class.attribute_map.each_pair do |attr, param|
|
158
|
+
value = self.send(attr)
|
159
|
+
next if value.nil?
|
160
|
+
hash[param] = _to_hash(value)
|
161
|
+
end
|
162
|
+
hash
|
163
|
+
end
|
164
|
+
|
165
|
+
# Outputs non-array value in the form of hash
|
166
|
+
# For object, use to_hash. Otherwise, just return the value
|
167
|
+
# @param [Object] value Any valid value
|
168
|
+
# @return [Hash] Returns the value in the form of hash
|
169
|
+
def _to_hash(value)
|
170
|
+
if value.is_a?(Array)
|
171
|
+
value.compact.map { |v| _to_hash(v) }
|
172
|
+
elsif value.is_a?(Hash)
|
173
|
+
{}.tap do |hash|
|
174
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
175
|
+
end
|
176
|
+
elsif value.respond_to? :to_hash
|
177
|
+
value.to_hash
|
178
|
+
else
|
179
|
+
value
|
180
|
+
end
|
181
|
+
end
|
182
|
+
end
|
183
|
+
end
|
@@ -0,0 +1,183 @@
|
|
1
|
+
=begin
|
2
|
+
#API v1
|
3
|
+
|
4
|
+
#FormAPI is a service that helps you fill out and sign PDF templates.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 3.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module FormAPI
|
16
|
+
class MoveTemplateData
|
17
|
+
attr_accessor :parent_folder_id
|
18
|
+
|
19
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
20
|
+
def self.attribute_map
|
21
|
+
{
|
22
|
+
:'parent_folder_id' => :'parent_folder_id'
|
23
|
+
}
|
24
|
+
end
|
25
|
+
|
26
|
+
# Attribute type mapping.
|
27
|
+
def self.openapi_types
|
28
|
+
{
|
29
|
+
:'parent_folder_id' => :'String'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Initializes the object
|
34
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
35
|
+
def initialize(attributes = {})
|
36
|
+
return unless attributes.is_a?(Hash)
|
37
|
+
|
38
|
+
# convert string to symbol for hash key
|
39
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
40
|
+
|
41
|
+
if attributes.has_key?(:'parent_folder_id')
|
42
|
+
self.parent_folder_id = attributes[:'parent_folder_id']
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
47
|
+
# @return Array for valid properties with the reasons
|
48
|
+
def list_invalid_properties
|
49
|
+
invalid_properties = Array.new
|
50
|
+
invalid_properties
|
51
|
+
end
|
52
|
+
|
53
|
+
# Check to see if the all the properties in the model are valid
|
54
|
+
# @return true if the model is valid
|
55
|
+
def valid?
|
56
|
+
true
|
57
|
+
end
|
58
|
+
|
59
|
+
# Checks equality by comparing each attribute.
|
60
|
+
# @param [Object] Object to be compared
|
61
|
+
def ==(o)
|
62
|
+
return true if self.equal?(o)
|
63
|
+
self.class == o.class &&
|
64
|
+
parent_folder_id == o.parent_folder_id
|
65
|
+
end
|
66
|
+
|
67
|
+
# @see the `==` method
|
68
|
+
# @param [Object] Object to be compared
|
69
|
+
def eql?(o)
|
70
|
+
self == o
|
71
|
+
end
|
72
|
+
|
73
|
+
# Calculates hash code according to all attributes.
|
74
|
+
# @return [Fixnum] Hash code
|
75
|
+
def hash
|
76
|
+
[parent_folder_id].hash
|
77
|
+
end
|
78
|
+
|
79
|
+
# Builds the object from hash
|
80
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
81
|
+
# @return [Object] Returns the model itself
|
82
|
+
def build_from_hash(attributes)
|
83
|
+
return nil unless attributes.is_a?(Hash)
|
84
|
+
self.class.openapi_types.each_pair do |key, type|
|
85
|
+
if type =~ /\AArray<(.*)>/i
|
86
|
+
# check to ensure the input is an array given that the the attribute
|
87
|
+
# is documented as an array but the input is not
|
88
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
89
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
90
|
+
end
|
91
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
92
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
93
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
94
|
+
end
|
95
|
+
|
96
|
+
self
|
97
|
+
end
|
98
|
+
|
99
|
+
# Deserializes the data based on type
|
100
|
+
# @param string type Data type
|
101
|
+
# @param string value Value to be deserialized
|
102
|
+
# @return [Object] Deserialized data
|
103
|
+
def _deserialize(type, value)
|
104
|
+
case type.to_sym
|
105
|
+
when :DateTime
|
106
|
+
DateTime.parse(value)
|
107
|
+
when :Date
|
108
|
+
Date.parse(value)
|
109
|
+
when :String
|
110
|
+
value.to_s
|
111
|
+
when :Integer
|
112
|
+
value.to_i
|
113
|
+
when :Float
|
114
|
+
value.to_f
|
115
|
+
when :BOOLEAN
|
116
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
117
|
+
true
|
118
|
+
else
|
119
|
+
false
|
120
|
+
end
|
121
|
+
when :Object
|
122
|
+
# generic object (usually a Hash), return directly
|
123
|
+
value
|
124
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
125
|
+
inner_type = Regexp.last_match[:inner_type]
|
126
|
+
value.map { |v| _deserialize(inner_type, v) }
|
127
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
128
|
+
k_type = Regexp.last_match[:k_type]
|
129
|
+
v_type = Regexp.last_match[:v_type]
|
130
|
+
{}.tap do |hash|
|
131
|
+
value.each do |k, v|
|
132
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
133
|
+
end
|
134
|
+
end
|
135
|
+
else # model
|
136
|
+
temp_model = FormAPI.const_get(type).new
|
137
|
+
temp_model.build_from_hash(value)
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
141
|
+
# Returns the string representation of the object
|
142
|
+
# @return [String] String presentation of the object
|
143
|
+
def to_s
|
144
|
+
to_hash.to_s
|
145
|
+
end
|
146
|
+
|
147
|
+
# to_body is an alias to to_hash (backward compatibility)
|
148
|
+
# @return [Hash] Returns the object in the form of hash
|
149
|
+
def to_body
|
150
|
+
to_hash
|
151
|
+
end
|
152
|
+
|
153
|
+
# Returns the object in the form of hash
|
154
|
+
# @return [Hash] Returns the object in the form of hash
|
155
|
+
def to_hash
|
156
|
+
hash = {}
|
157
|
+
self.class.attribute_map.each_pair do |attr, param|
|
158
|
+
value = self.send(attr)
|
159
|
+
next if value.nil?
|
160
|
+
hash[param] = _to_hash(value)
|
161
|
+
end
|
162
|
+
hash
|
163
|
+
end
|
164
|
+
|
165
|
+
# Outputs non-array value in the form of hash
|
166
|
+
# For object, use to_hash. Otherwise, just return the value
|
167
|
+
# @param [Object] value Any valid value
|
168
|
+
# @return [Hash] Returns the value in the form of hash
|
169
|
+
def _to_hash(value)
|
170
|
+
if value.is_a?(Array)
|
171
|
+
value.compact.map { |v| _to_hash(v) }
|
172
|
+
elsif value.is_a?(Hash)
|
173
|
+
{}.tap do |hash|
|
174
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
175
|
+
end
|
176
|
+
elsif value.respond_to? :to_hash
|
177
|
+
value.to_hash
|
178
|
+
else
|
179
|
+
value
|
180
|
+
end
|
181
|
+
end
|
182
|
+
end
|
183
|
+
end
|
@@ -18,6 +18,8 @@ module FormAPI
|
|
18
18
|
|
19
19
|
attr_accessor :webhook_url
|
20
20
|
|
21
|
+
attr_accessor :parent_folder_id
|
22
|
+
|
21
23
|
attr_accessor :expire_after
|
22
24
|
|
23
25
|
attr_accessor :allow_additional_properties
|
@@ -26,6 +28,8 @@ module FormAPI
|
|
26
28
|
|
27
29
|
attr_accessor :slack_webhook_url
|
28
30
|
|
31
|
+
attr_accessor :path
|
32
|
+
|
29
33
|
attr_accessor :public_web_form
|
30
34
|
|
31
35
|
attr_accessor :editable_submissions
|
@@ -67,10 +71,12 @@ module FormAPI
|
|
67
71
|
{
|
68
72
|
:'expiration_interval' => :'expiration_interval',
|
69
73
|
:'webhook_url' => :'webhook_url',
|
74
|
+
:'parent_folder_id' => :'parent_folder_id',
|
70
75
|
:'expire_after' => :'expire_after',
|
71
76
|
:'allow_additional_properties' => :'allow_additional_properties',
|
72
77
|
:'public_submissions' => :'public_submissions',
|
73
78
|
:'slack_webhook_url' => :'slack_webhook_url',
|
79
|
+
:'path' => :'path',
|
74
80
|
:'public_web_form' => :'public_web_form',
|
75
81
|
:'editable_submissions' => :'editable_submissions',
|
76
82
|
:'expire_submissions' => :'expire_submissions',
|
@@ -86,10 +92,12 @@ module FormAPI
|
|
86
92
|
{
|
87
93
|
:'expiration_interval' => :'String',
|
88
94
|
:'webhook_url' => :'String',
|
95
|
+
:'parent_folder_id' => :'String',
|
89
96
|
:'expire_after' => :'Float',
|
90
97
|
:'allow_additional_properties' => :'BOOLEAN',
|
91
98
|
:'public_submissions' => :'BOOLEAN',
|
92
99
|
:'slack_webhook_url' => :'String',
|
100
|
+
:'path' => :'String',
|
93
101
|
:'public_web_form' => :'BOOLEAN',
|
94
102
|
:'editable_submissions' => :'BOOLEAN',
|
95
103
|
:'expire_submissions' => :'BOOLEAN',
|
@@ -116,6 +124,10 @@ module FormAPI
|
|
116
124
|
self.webhook_url = attributes[:'webhook_url']
|
117
125
|
end
|
118
126
|
|
127
|
+
if attributes.has_key?(:'parent_folder_id')
|
128
|
+
self.parent_folder_id = attributes[:'parent_folder_id']
|
129
|
+
end
|
130
|
+
|
119
131
|
if attributes.has_key?(:'expire_after')
|
120
132
|
self.expire_after = attributes[:'expire_after']
|
121
133
|
end
|
@@ -132,6 +144,10 @@ module FormAPI
|
|
132
144
|
self.slack_webhook_url = attributes[:'slack_webhook_url']
|
133
145
|
end
|
134
146
|
|
147
|
+
if attributes.has_key?(:'path')
|
148
|
+
self.path = attributes[:'path']
|
149
|
+
end
|
150
|
+
|
135
151
|
if attributes.has_key?(:'public_web_form')
|
136
152
|
self.public_web_form = attributes[:'public_web_form']
|
137
153
|
end
|
@@ -193,10 +209,12 @@ module FormAPI
|
|
193
209
|
self.class == o.class &&
|
194
210
|
expiration_interval == o.expiration_interval &&
|
195
211
|
webhook_url == o.webhook_url &&
|
212
|
+
parent_folder_id == o.parent_folder_id &&
|
196
213
|
expire_after == o.expire_after &&
|
197
214
|
allow_additional_properties == o.allow_additional_properties &&
|
198
215
|
public_submissions == o.public_submissions &&
|
199
216
|
slack_webhook_url == o.slack_webhook_url &&
|
217
|
+
path == o.path &&
|
200
218
|
public_web_form == o.public_web_form &&
|
201
219
|
editable_submissions == o.editable_submissions &&
|
202
220
|
expire_submissions == o.expire_submissions &&
|
@@ -215,7 +233,7 @@ module FormAPI
|
|
215
233
|
# Calculates hash code according to all attributes.
|
216
234
|
# @return [Fixnum] Hash code
|
217
235
|
def hash
|
218
|
-
[expiration_interval, webhook_url, expire_after, allow_additional_properties, public_submissions, slack_webhook_url, public_web_form, editable_submissions, expire_submissions, name, template_type, id, redirect_url].hash
|
236
|
+
[expiration_interval, webhook_url, parent_folder_id, expire_after, allow_additional_properties, public_submissions, slack_webhook_url, path, public_web_form, editable_submissions, expire_submissions, name, template_type, id, redirect_url].hash
|
219
237
|
end
|
220
238
|
|
221
239
|
# Builds the object from hash
|