aspose_pdf_cloud 19.1.0 → 19.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -4
- data/docs/PdfApi.md +361 -18
- data/docs/RedactionAnnotationsResponse.md +1 -1
- data/docs/ScreenAnnotation.md +22 -0
- data/docs/ScreenAnnotationResponse.md +11 -0
- data/docs/ScreenAnnotations.md +10 -0
- data/docs/ScreenAnnotationsResponse.md +11 -0
- data/docs/StampAnnotation.md +27 -0
- data/docs/StampAnnotationResponse.md +11 -0
- data/docs/StampAnnotations.md +10 -0
- data/docs/StampAnnotationsResponse.md +11 -0
- data/docs/StampIcon.md +23 -0
- data/lib/aspose_pdf_cloud.rb +9 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +1116 -84
- data/lib/aspose_pdf_cloud/models/redaction_annotations_response.rb +1 -1
- data/lib/aspose_pdf_cloud/models/screen_annotation.rb +335 -0
- data/lib/aspose_pdf_cloud/models/screen_annotation_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/screen_annotations.rb +215 -0
- data/lib/aspose_pdf_cloud/models/screen_annotations_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/stamp_annotation.rb +385 -0
- data/lib/aspose_pdf_cloud/models/stamp_annotation_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/stamp_annotations.rb +215 -0
- data/lib/aspose_pdf_cloud/models/stamp_annotations_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/stamp_icon.rb +56 -0
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +287 -0
- data/test_data/PdfWithScreenAnnotations.pdf +0 -0
- data/test_data/ScreenMovie.swf +0 -0
- metadata +22 -2
@@ -0,0 +1,215 @@
|
|
1
|
+
=begin
|
2
|
+
--------------------------------------------------------------------------------------------------------------------
|
3
|
+
Copyright (c) 2019 Aspose.PDF Cloud
|
4
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
5
|
+
of this software and associated documentation files (the "Software"), to deal
|
6
|
+
in the Software without restriction, including without limitation the rights
|
7
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
8
|
+
copies of the Software, and to permit persons to whom the Software is
|
9
|
+
furnished to do so, subject to the following conditions:
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
11
|
+
copies or substantial portions of the Software.
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
14
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
15
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
16
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
17
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
18
|
+
SOFTWARE.
|
19
|
+
--------------------------------------------------------------------------------------------------------------------
|
20
|
+
=end
|
21
|
+
|
22
|
+
require 'date'
|
23
|
+
require 'time'
|
24
|
+
|
25
|
+
module AsposePdfCloud
|
26
|
+
# Object representing a list of screen annotations.
|
27
|
+
class ScreenAnnotations
|
28
|
+
# Link to the document.
|
29
|
+
attr_accessor :links
|
30
|
+
|
31
|
+
# List of screen annotations.
|
32
|
+
attr_accessor :list
|
33
|
+
|
34
|
+
|
35
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
36
|
+
def self.attribute_map
|
37
|
+
{
|
38
|
+
:'links' => :'Links',
|
39
|
+
:'list' => :'List'
|
40
|
+
}
|
41
|
+
end
|
42
|
+
|
43
|
+
# Attribute type mapping.
|
44
|
+
def self.swagger_types
|
45
|
+
{
|
46
|
+
:'links' => :'Array<Link>',
|
47
|
+
:'list' => :'Array<ScreenAnnotation>'
|
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?(:'Links')
|
60
|
+
if (value = attributes[:'Links']).is_a?(Array)
|
61
|
+
self.links = value
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
if attributes.has_key?(:'List')
|
66
|
+
if (value = attributes[:'List']).is_a?(Array)
|
67
|
+
self.list = value
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
end
|
72
|
+
|
73
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
74
|
+
# @return Array for valid properies with the reasons
|
75
|
+
def list_invalid_properties
|
76
|
+
invalid_properties = Array.new
|
77
|
+
return invalid_properties
|
78
|
+
end
|
79
|
+
|
80
|
+
# Check to see if the all the properties in the model are valid
|
81
|
+
# @return true if the model is valid
|
82
|
+
def valid?
|
83
|
+
return true
|
84
|
+
end
|
85
|
+
|
86
|
+
# Checks equality by comparing each attribute.
|
87
|
+
# @param [Object] Object to be compared
|
88
|
+
def ==(o)
|
89
|
+
return true if self.equal?(o)
|
90
|
+
self.class == o.class &&
|
91
|
+
links == o.links &&
|
92
|
+
list == o.list
|
93
|
+
end
|
94
|
+
|
95
|
+
# @see the `==` method
|
96
|
+
# @param [Object] Object to be compared
|
97
|
+
def eql?(o)
|
98
|
+
self == o
|
99
|
+
end
|
100
|
+
|
101
|
+
# Calculates hash code according to all attributes.
|
102
|
+
# @return [Fixnum] Hash code
|
103
|
+
def hash
|
104
|
+
[links, list].hash
|
105
|
+
end
|
106
|
+
|
107
|
+
# Builds the object from hash
|
108
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
109
|
+
# @return [Object] Returns the model itself
|
110
|
+
def build_from_hash(attributes)
|
111
|
+
return nil unless attributes.is_a?(Hash)
|
112
|
+
self.class.swagger_types.each_pair do |key, type|
|
113
|
+
if type =~ /\AArray<(.*)>/i
|
114
|
+
# check to ensure the input is an array given that the the attribute
|
115
|
+
# is documented as an array but the input is not
|
116
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
117
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
118
|
+
end
|
119
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
120
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
121
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
122
|
+
end
|
123
|
+
|
124
|
+
self
|
125
|
+
end
|
126
|
+
|
127
|
+
# Deserializes the data based on type
|
128
|
+
# @param string type Data type
|
129
|
+
# @param string value Value to be deserialized
|
130
|
+
# @return [Object] Deserialized data
|
131
|
+
def _deserialize(type, value)
|
132
|
+
case type.to_sym
|
133
|
+
when :DateTime
|
134
|
+
format = (value.include? '+') ? '/Date(%Q%z)/' : '/Date(%Q)/'
|
135
|
+
Time.strptime(value, format).utc.to_datetime
|
136
|
+
when :Date
|
137
|
+
format = (value.include? '+') ? '/Date(%Q%z)/' : '/Date(%Q)/'
|
138
|
+
Time.strptime(value, format).utc.to_datetime.to_date
|
139
|
+
when :String
|
140
|
+
value.to_s
|
141
|
+
when :Integer
|
142
|
+
value.to_i
|
143
|
+
when :Float
|
144
|
+
value.to_f
|
145
|
+
when :BOOLEAN
|
146
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
147
|
+
true
|
148
|
+
else
|
149
|
+
false
|
150
|
+
end
|
151
|
+
when :Object
|
152
|
+
# generic object (usually a Hash), return directly
|
153
|
+
value
|
154
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
155
|
+
inner_type = Regexp.last_match[:inner_type]
|
156
|
+
value.map { |v| _deserialize(inner_type, v) }
|
157
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
158
|
+
k_type = Regexp.last_match[:k_type]
|
159
|
+
v_type = Regexp.last_match[:v_type]
|
160
|
+
{}.tap do |hash|
|
161
|
+
value.each do |k, v|
|
162
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
163
|
+
end
|
164
|
+
end
|
165
|
+
else # model
|
166
|
+
temp_model = AsposePdfCloud.const_get(type).new
|
167
|
+
temp_model.build_from_hash(value)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
# Returns the string representation of the object
|
172
|
+
# @return [String] String presentation of the object
|
173
|
+
def to_s
|
174
|
+
to_hash.to_s
|
175
|
+
end
|
176
|
+
|
177
|
+
# to_body is an alias to to_hash (backward compatibility)
|
178
|
+
# @return [Hash] Returns the object in the form of hash
|
179
|
+
def to_body
|
180
|
+
to_hash
|
181
|
+
end
|
182
|
+
|
183
|
+
# Returns the object in the form of hash
|
184
|
+
# @return [Hash] Returns the object in the form of hash
|
185
|
+
def to_hash
|
186
|
+
hash = {}
|
187
|
+
self.class.attribute_map.each_pair do |attr, param|
|
188
|
+
value = self.send(attr)
|
189
|
+
next if value.nil?
|
190
|
+
hash[param] = _to_hash(value)
|
191
|
+
end
|
192
|
+
hash
|
193
|
+
end
|
194
|
+
|
195
|
+
# Outputs non-array value in the form of hash
|
196
|
+
# For object, use to_hash. Otherwise, just return the value
|
197
|
+
# @param [Object] value Any valid value
|
198
|
+
# @return [Hash] Returns the value in the form of hash
|
199
|
+
def _to_hash(value)
|
200
|
+
if value.is_a?(Array)
|
201
|
+
value.compact.map{ |v| _to_hash(v) }
|
202
|
+
elsif value.is_a?(Hash)
|
203
|
+
{}.tap do |hash|
|
204
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
205
|
+
end
|
206
|
+
elsif value.respond_to? :to_hash
|
207
|
+
value.to_hash
|
208
|
+
else
|
209
|
+
value
|
210
|
+
end
|
211
|
+
end
|
212
|
+
|
213
|
+
end
|
214
|
+
|
215
|
+
end
|
@@ -0,0 +1,226 @@
|
|
1
|
+
=begin
|
2
|
+
--------------------------------------------------------------------------------------------------------------------
|
3
|
+
Copyright (c) 2019 Aspose.PDF Cloud
|
4
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
5
|
+
of this software and associated documentation files (the "Software"), to deal
|
6
|
+
in the Software without restriction, including without limitation the rights
|
7
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
8
|
+
copies of the Software, and to permit persons to whom the Software is
|
9
|
+
furnished to do so, subject to the following conditions:
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
11
|
+
copies or substantial portions of the Software.
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
14
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
15
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
16
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
17
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
18
|
+
SOFTWARE.
|
19
|
+
--------------------------------------------------------------------------------------------------------------------
|
20
|
+
=end
|
21
|
+
|
22
|
+
require 'date'
|
23
|
+
require 'time'
|
24
|
+
|
25
|
+
module AsposePdfCloud
|
26
|
+
# Represents response containing multiple screen annotation objects
|
27
|
+
class ScreenAnnotationsResponse
|
28
|
+
# Response status code.
|
29
|
+
attr_accessor :code
|
30
|
+
|
31
|
+
# Response status.
|
32
|
+
attr_accessor :status
|
33
|
+
|
34
|
+
# Screen annotations object
|
35
|
+
attr_accessor :annotations
|
36
|
+
|
37
|
+
|
38
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
39
|
+
def self.attribute_map
|
40
|
+
{
|
41
|
+
:'code' => :'Code',
|
42
|
+
:'status' => :'Status',
|
43
|
+
:'annotations' => :'Annotations'
|
44
|
+
}
|
45
|
+
end
|
46
|
+
|
47
|
+
# Attribute type mapping.
|
48
|
+
def self.swagger_types
|
49
|
+
{
|
50
|
+
:'code' => :'Integer',
|
51
|
+
:'status' => :'String',
|
52
|
+
:'annotations' => :'ScreenAnnotations'
|
53
|
+
}
|
54
|
+
end
|
55
|
+
|
56
|
+
# Initializes the object
|
57
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
58
|
+
def initialize(attributes = {})
|
59
|
+
return unless attributes.is_a?(Hash)
|
60
|
+
|
61
|
+
# convert string to symbol for hash key
|
62
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
63
|
+
|
64
|
+
if attributes.has_key?(:'Code')
|
65
|
+
self.code = attributes[:'Code']
|
66
|
+
end
|
67
|
+
|
68
|
+
if attributes.has_key?(:'Status')
|
69
|
+
self.status = attributes[:'Status']
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.has_key?(:'Annotations')
|
73
|
+
self.annotations = attributes[:'Annotations']
|
74
|
+
end
|
75
|
+
|
76
|
+
end
|
77
|
+
|
78
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
79
|
+
# @return Array for valid properies with the reasons
|
80
|
+
def list_invalid_properties
|
81
|
+
invalid_properties = Array.new
|
82
|
+
if @code.nil?
|
83
|
+
invalid_properties.push("invalid value for 'code', code cannot be nil.")
|
84
|
+
end
|
85
|
+
|
86
|
+
return invalid_properties
|
87
|
+
end
|
88
|
+
|
89
|
+
# Check to see if the all the properties in the model are valid
|
90
|
+
# @return true if the model is valid
|
91
|
+
def valid?
|
92
|
+
return false if @code.nil?
|
93
|
+
return true
|
94
|
+
end
|
95
|
+
|
96
|
+
# Checks equality by comparing each attribute.
|
97
|
+
# @param [Object] Object to be compared
|
98
|
+
def ==(o)
|
99
|
+
return true if self.equal?(o)
|
100
|
+
self.class == o.class &&
|
101
|
+
code == o.code &&
|
102
|
+
status == o.status &&
|
103
|
+
annotations == o.annotations
|
104
|
+
end
|
105
|
+
|
106
|
+
# @see the `==` method
|
107
|
+
# @param [Object] Object to be compared
|
108
|
+
def eql?(o)
|
109
|
+
self == o
|
110
|
+
end
|
111
|
+
|
112
|
+
# Calculates hash code according to all attributes.
|
113
|
+
# @return [Fixnum] Hash code
|
114
|
+
def hash
|
115
|
+
[code, status, annotations].hash
|
116
|
+
end
|
117
|
+
|
118
|
+
# Builds the object from hash
|
119
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
120
|
+
# @return [Object] Returns the model itself
|
121
|
+
def build_from_hash(attributes)
|
122
|
+
return nil unless attributes.is_a?(Hash)
|
123
|
+
self.class.swagger_types.each_pair do |key, type|
|
124
|
+
if type =~ /\AArray<(.*)>/i
|
125
|
+
# check to ensure the input is an array given that the the attribute
|
126
|
+
# is documented as an array but the input is not
|
127
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
128
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
129
|
+
end
|
130
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
131
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
132
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
133
|
+
end
|
134
|
+
|
135
|
+
self
|
136
|
+
end
|
137
|
+
|
138
|
+
# Deserializes the data based on type
|
139
|
+
# @param string type Data type
|
140
|
+
# @param string value Value to be deserialized
|
141
|
+
# @return [Object] Deserialized data
|
142
|
+
def _deserialize(type, value)
|
143
|
+
case type.to_sym
|
144
|
+
when :DateTime
|
145
|
+
format = (value.include? '+') ? '/Date(%Q%z)/' : '/Date(%Q)/'
|
146
|
+
Time.strptime(value, format).utc.to_datetime
|
147
|
+
when :Date
|
148
|
+
format = (value.include? '+') ? '/Date(%Q%z)/' : '/Date(%Q)/'
|
149
|
+
Time.strptime(value, format).utc.to_datetime.to_date
|
150
|
+
when :String
|
151
|
+
value.to_s
|
152
|
+
when :Integer
|
153
|
+
value.to_i
|
154
|
+
when :Float
|
155
|
+
value.to_f
|
156
|
+
when :BOOLEAN
|
157
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
158
|
+
true
|
159
|
+
else
|
160
|
+
false
|
161
|
+
end
|
162
|
+
when :Object
|
163
|
+
# generic object (usually a Hash), return directly
|
164
|
+
value
|
165
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
166
|
+
inner_type = Regexp.last_match[:inner_type]
|
167
|
+
value.map { |v| _deserialize(inner_type, v) }
|
168
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
169
|
+
k_type = Regexp.last_match[:k_type]
|
170
|
+
v_type = Regexp.last_match[:v_type]
|
171
|
+
{}.tap do |hash|
|
172
|
+
value.each do |k, v|
|
173
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
174
|
+
end
|
175
|
+
end
|
176
|
+
else # model
|
177
|
+
temp_model = AsposePdfCloud.const_get(type).new
|
178
|
+
temp_model.build_from_hash(value)
|
179
|
+
end
|
180
|
+
end
|
181
|
+
|
182
|
+
# Returns the string representation of the object
|
183
|
+
# @return [String] String presentation of the object
|
184
|
+
def to_s
|
185
|
+
to_hash.to_s
|
186
|
+
end
|
187
|
+
|
188
|
+
# to_body is an alias to to_hash (backward compatibility)
|
189
|
+
# @return [Hash] Returns the object in the form of hash
|
190
|
+
def to_body
|
191
|
+
to_hash
|
192
|
+
end
|
193
|
+
|
194
|
+
# Returns the object in the form of hash
|
195
|
+
# @return [Hash] Returns the object in the form of hash
|
196
|
+
def to_hash
|
197
|
+
hash = {}
|
198
|
+
self.class.attribute_map.each_pair do |attr, param|
|
199
|
+
value = self.send(attr)
|
200
|
+
next if value.nil?
|
201
|
+
hash[param] = _to_hash(value)
|
202
|
+
end
|
203
|
+
hash
|
204
|
+
end
|
205
|
+
|
206
|
+
# Outputs non-array value in the form of hash
|
207
|
+
# For object, use to_hash. Otherwise, just return the value
|
208
|
+
# @param [Object] value Any valid value
|
209
|
+
# @return [Hash] Returns the value in the form of hash
|
210
|
+
def _to_hash(value)
|
211
|
+
if value.is_a?(Array)
|
212
|
+
value.compact.map{ |v| _to_hash(v) }
|
213
|
+
elsif value.is_a?(Hash)
|
214
|
+
{}.tap do |hash|
|
215
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
216
|
+
end
|
217
|
+
elsif value.respond_to? :to_hash
|
218
|
+
value.to_hash
|
219
|
+
else
|
220
|
+
value
|
221
|
+
end
|
222
|
+
end
|
223
|
+
|
224
|
+
end
|
225
|
+
|
226
|
+
end
|
@@ -0,0 +1,385 @@
|
|
1
|
+
=begin
|
2
|
+
--------------------------------------------------------------------------------------------------------------------
|
3
|
+
Copyright (c) 2019 Aspose.PDF Cloud
|
4
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
5
|
+
of this software and associated documentation files (the "Software"), to deal
|
6
|
+
in the Software without restriction, including without limitation the rights
|
7
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
8
|
+
copies of the Software, and to permit persons to whom the Software is
|
9
|
+
furnished to do so, subject to the following conditions:
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
11
|
+
copies or substantial portions of the Software.
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
14
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
15
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
16
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
17
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
18
|
+
SOFTWARE.
|
19
|
+
--------------------------------------------------------------------------------------------------------------------
|
20
|
+
=end
|
21
|
+
|
22
|
+
require 'date'
|
23
|
+
require 'time'
|
24
|
+
|
25
|
+
module AsposePdfCloud
|
26
|
+
# Provides StampAnnotation.
|
27
|
+
class StampAnnotation
|
28
|
+
# Link to the document.
|
29
|
+
attr_accessor :links
|
30
|
+
|
31
|
+
# Color of the annotation.
|
32
|
+
attr_accessor :color
|
33
|
+
|
34
|
+
# Get the annotation content.
|
35
|
+
attr_accessor :contents
|
36
|
+
|
37
|
+
# The date and time when the annotation was last modified.
|
38
|
+
attr_accessor :modified
|
39
|
+
|
40
|
+
# Gets ID of the annotation.
|
41
|
+
attr_accessor :id
|
42
|
+
|
43
|
+
# Gets Flags of the annotation.
|
44
|
+
attr_accessor :flags
|
45
|
+
|
46
|
+
# Gets Name of the annotation.
|
47
|
+
attr_accessor :name
|
48
|
+
|
49
|
+
# Gets Rect of the annotation.
|
50
|
+
attr_accessor :rect
|
51
|
+
|
52
|
+
# Gets PageIndex of the annotation.
|
53
|
+
attr_accessor :page_index
|
54
|
+
|
55
|
+
# Gets ZIndex of the annotation.
|
56
|
+
attr_accessor :z_index
|
57
|
+
|
58
|
+
# Gets HorizontalAlignment of the annotation.
|
59
|
+
attr_accessor :horizontal_alignment
|
60
|
+
|
61
|
+
# Gets VerticalAlignment of the annotation.
|
62
|
+
attr_accessor :vertical_alignment
|
63
|
+
|
64
|
+
# The date and time when the annotation was created.
|
65
|
+
attr_accessor :creation_date
|
66
|
+
|
67
|
+
# Get the annotation subject.
|
68
|
+
attr_accessor :subject
|
69
|
+
|
70
|
+
# Get the annotation title.
|
71
|
+
attr_accessor :title
|
72
|
+
|
73
|
+
# Get the annotation RichText.
|
74
|
+
attr_accessor :rich_text
|
75
|
+
|
76
|
+
# Gets or sets icon for rubber stamp.
|
77
|
+
attr_accessor :icon
|
78
|
+
|
79
|
+
# Sets content file path.
|
80
|
+
attr_accessor :file_path
|
81
|
+
|
82
|
+
# Gets is image exist.
|
83
|
+
attr_accessor :has_image
|
84
|
+
|
85
|
+
|
86
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
87
|
+
def self.attribute_map
|
88
|
+
{
|
89
|
+
:'links' => :'Links',
|
90
|
+
:'color' => :'Color',
|
91
|
+
:'contents' => :'Contents',
|
92
|
+
:'modified' => :'Modified',
|
93
|
+
:'id' => :'Id',
|
94
|
+
:'flags' => :'Flags',
|
95
|
+
:'name' => :'Name',
|
96
|
+
:'rect' => :'Rect',
|
97
|
+
:'page_index' => :'PageIndex',
|
98
|
+
:'z_index' => :'ZIndex',
|
99
|
+
:'horizontal_alignment' => :'HorizontalAlignment',
|
100
|
+
:'vertical_alignment' => :'VerticalAlignment',
|
101
|
+
:'creation_date' => :'CreationDate',
|
102
|
+
:'subject' => :'Subject',
|
103
|
+
:'title' => :'Title',
|
104
|
+
:'rich_text' => :'RichText',
|
105
|
+
:'icon' => :'Icon',
|
106
|
+
:'file_path' => :'FilePath',
|
107
|
+
:'has_image' => :'HasImage'
|
108
|
+
}
|
109
|
+
end
|
110
|
+
|
111
|
+
# Attribute type mapping.
|
112
|
+
def self.swagger_types
|
113
|
+
{
|
114
|
+
:'links' => :'Array<Link>',
|
115
|
+
:'color' => :'Color',
|
116
|
+
:'contents' => :'String',
|
117
|
+
:'modified' => :'String',
|
118
|
+
:'id' => :'String',
|
119
|
+
:'flags' => :'Array<AnnotationFlags>',
|
120
|
+
:'name' => :'String',
|
121
|
+
:'rect' => :'Rectangle',
|
122
|
+
:'page_index' => :'Integer',
|
123
|
+
:'z_index' => :'Integer',
|
124
|
+
:'horizontal_alignment' => :'HorizontalAlignment',
|
125
|
+
:'vertical_alignment' => :'VerticalAlignment',
|
126
|
+
:'creation_date' => :'String',
|
127
|
+
:'subject' => :'String',
|
128
|
+
:'title' => :'String',
|
129
|
+
:'rich_text' => :'String',
|
130
|
+
:'icon' => :'StampIcon',
|
131
|
+
:'file_path' => :'String',
|
132
|
+
:'has_image' => :'BOOLEAN'
|
133
|
+
}
|
134
|
+
end
|
135
|
+
|
136
|
+
# Initializes the object
|
137
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
138
|
+
def initialize(attributes = {})
|
139
|
+
return unless attributes.is_a?(Hash)
|
140
|
+
|
141
|
+
# convert string to symbol for hash key
|
142
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
143
|
+
|
144
|
+
if attributes.has_key?(:'Links')
|
145
|
+
if (value = attributes[:'Links']).is_a?(Array)
|
146
|
+
self.links = value
|
147
|
+
end
|
148
|
+
end
|
149
|
+
|
150
|
+
if attributes.has_key?(:'Color')
|
151
|
+
self.color = attributes[:'Color']
|
152
|
+
end
|
153
|
+
|
154
|
+
if attributes.has_key?(:'Contents')
|
155
|
+
self.contents = attributes[:'Contents']
|
156
|
+
end
|
157
|
+
|
158
|
+
if attributes.has_key?(:'Modified')
|
159
|
+
self.modified = attributes[:'Modified']
|
160
|
+
end
|
161
|
+
|
162
|
+
if attributes.has_key?(:'Id')
|
163
|
+
self.id = attributes[:'Id']
|
164
|
+
end
|
165
|
+
|
166
|
+
if attributes.has_key?(:'Flags')
|
167
|
+
if (value = attributes[:'Flags']).is_a?(Array)
|
168
|
+
self.flags = value
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
if attributes.has_key?(:'Name')
|
173
|
+
self.name = attributes[:'Name']
|
174
|
+
end
|
175
|
+
|
176
|
+
if attributes.has_key?(:'Rect')
|
177
|
+
self.rect = attributes[:'Rect']
|
178
|
+
end
|
179
|
+
|
180
|
+
if attributes.has_key?(:'PageIndex')
|
181
|
+
self.page_index = attributes[:'PageIndex']
|
182
|
+
end
|
183
|
+
|
184
|
+
if attributes.has_key?(:'ZIndex')
|
185
|
+
self.z_index = attributes[:'ZIndex']
|
186
|
+
end
|
187
|
+
|
188
|
+
if attributes.has_key?(:'HorizontalAlignment')
|
189
|
+
self.horizontal_alignment = attributes[:'HorizontalAlignment']
|
190
|
+
end
|
191
|
+
|
192
|
+
if attributes.has_key?(:'VerticalAlignment')
|
193
|
+
self.vertical_alignment = attributes[:'VerticalAlignment']
|
194
|
+
end
|
195
|
+
|
196
|
+
if attributes.has_key?(:'CreationDate')
|
197
|
+
self.creation_date = attributes[:'CreationDate']
|
198
|
+
end
|
199
|
+
|
200
|
+
if attributes.has_key?(:'Subject')
|
201
|
+
self.subject = attributes[:'Subject']
|
202
|
+
end
|
203
|
+
|
204
|
+
if attributes.has_key?(:'Title')
|
205
|
+
self.title = attributes[:'Title']
|
206
|
+
end
|
207
|
+
|
208
|
+
if attributes.has_key?(:'RichText')
|
209
|
+
self.rich_text = attributes[:'RichText']
|
210
|
+
end
|
211
|
+
|
212
|
+
if attributes.has_key?(:'Icon')
|
213
|
+
self.icon = attributes[:'Icon']
|
214
|
+
end
|
215
|
+
|
216
|
+
if attributes.has_key?(:'FilePath')
|
217
|
+
self.file_path = attributes[:'FilePath']
|
218
|
+
end
|
219
|
+
|
220
|
+
if attributes.has_key?(:'HasImage')
|
221
|
+
self.has_image = attributes[:'HasImage']
|
222
|
+
end
|
223
|
+
|
224
|
+
end
|
225
|
+
|
226
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
227
|
+
# @return Array for valid properies with the reasons
|
228
|
+
def list_invalid_properties
|
229
|
+
invalid_properties = Array.new
|
230
|
+
return invalid_properties
|
231
|
+
end
|
232
|
+
|
233
|
+
# Check to see if the all the properties in the model are valid
|
234
|
+
# @return true if the model is valid
|
235
|
+
def valid?
|
236
|
+
return true
|
237
|
+
end
|
238
|
+
|
239
|
+
# Checks equality by comparing each attribute.
|
240
|
+
# @param [Object] Object to be compared
|
241
|
+
def ==(o)
|
242
|
+
return true if self.equal?(o)
|
243
|
+
self.class == o.class &&
|
244
|
+
links == o.links &&
|
245
|
+
color == o.color &&
|
246
|
+
contents == o.contents &&
|
247
|
+
modified == o.modified &&
|
248
|
+
id == o.id &&
|
249
|
+
flags == o.flags &&
|
250
|
+
name == o.name &&
|
251
|
+
rect == o.rect &&
|
252
|
+
page_index == o.page_index &&
|
253
|
+
z_index == o.z_index &&
|
254
|
+
horizontal_alignment == o.horizontal_alignment &&
|
255
|
+
vertical_alignment == o.vertical_alignment &&
|
256
|
+
creation_date == o.creation_date &&
|
257
|
+
subject == o.subject &&
|
258
|
+
title == o.title &&
|
259
|
+
rich_text == o.rich_text &&
|
260
|
+
icon == o.icon &&
|
261
|
+
file_path == o.file_path &&
|
262
|
+
has_image == o.has_image
|
263
|
+
end
|
264
|
+
|
265
|
+
# @see the `==` method
|
266
|
+
# @param [Object] Object to be compared
|
267
|
+
def eql?(o)
|
268
|
+
self == o
|
269
|
+
end
|
270
|
+
|
271
|
+
# Calculates hash code according to all attributes.
|
272
|
+
# @return [Fixnum] Hash code
|
273
|
+
def hash
|
274
|
+
[links, color, contents, modified, id, flags, name, rect, page_index, z_index, horizontal_alignment, vertical_alignment, creation_date, subject, title, rich_text, icon, file_path, has_image].hash
|
275
|
+
end
|
276
|
+
|
277
|
+
# Builds the object from hash
|
278
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
279
|
+
# @return [Object] Returns the model itself
|
280
|
+
def build_from_hash(attributes)
|
281
|
+
return nil unless attributes.is_a?(Hash)
|
282
|
+
self.class.swagger_types.each_pair do |key, type|
|
283
|
+
if type =~ /\AArray<(.*)>/i
|
284
|
+
# check to ensure the input is an array given that the the attribute
|
285
|
+
# is documented as an array but the input is not
|
286
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
287
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
288
|
+
end
|
289
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
290
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
291
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
292
|
+
end
|
293
|
+
|
294
|
+
self
|
295
|
+
end
|
296
|
+
|
297
|
+
# Deserializes the data based on type
|
298
|
+
# @param string type Data type
|
299
|
+
# @param string value Value to be deserialized
|
300
|
+
# @return [Object] Deserialized data
|
301
|
+
def _deserialize(type, value)
|
302
|
+
case type.to_sym
|
303
|
+
when :DateTime
|
304
|
+
format = (value.include? '+') ? '/Date(%Q%z)/' : '/Date(%Q)/'
|
305
|
+
Time.strptime(value, format).utc.to_datetime
|
306
|
+
when :Date
|
307
|
+
format = (value.include? '+') ? '/Date(%Q%z)/' : '/Date(%Q)/'
|
308
|
+
Time.strptime(value, format).utc.to_datetime.to_date
|
309
|
+
when :String
|
310
|
+
value.to_s
|
311
|
+
when :Integer
|
312
|
+
value.to_i
|
313
|
+
when :Float
|
314
|
+
value.to_f
|
315
|
+
when :BOOLEAN
|
316
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
317
|
+
true
|
318
|
+
else
|
319
|
+
false
|
320
|
+
end
|
321
|
+
when :Object
|
322
|
+
# generic object (usually a Hash), return directly
|
323
|
+
value
|
324
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
325
|
+
inner_type = Regexp.last_match[:inner_type]
|
326
|
+
value.map { |v| _deserialize(inner_type, v) }
|
327
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
328
|
+
k_type = Regexp.last_match[:k_type]
|
329
|
+
v_type = Regexp.last_match[:v_type]
|
330
|
+
{}.tap do |hash|
|
331
|
+
value.each do |k, v|
|
332
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
333
|
+
end
|
334
|
+
end
|
335
|
+
else # model
|
336
|
+
temp_model = AsposePdfCloud.const_get(type).new
|
337
|
+
temp_model.build_from_hash(value)
|
338
|
+
end
|
339
|
+
end
|
340
|
+
|
341
|
+
# Returns the string representation of the object
|
342
|
+
# @return [String] String presentation of the object
|
343
|
+
def to_s
|
344
|
+
to_hash.to_s
|
345
|
+
end
|
346
|
+
|
347
|
+
# to_body is an alias to to_hash (backward compatibility)
|
348
|
+
# @return [Hash] Returns the object in the form of hash
|
349
|
+
def to_body
|
350
|
+
to_hash
|
351
|
+
end
|
352
|
+
|
353
|
+
# Returns the object in the form of hash
|
354
|
+
# @return [Hash] Returns the object in the form of hash
|
355
|
+
def to_hash
|
356
|
+
hash = {}
|
357
|
+
self.class.attribute_map.each_pair do |attr, param|
|
358
|
+
value = self.send(attr)
|
359
|
+
next if value.nil?
|
360
|
+
hash[param] = _to_hash(value)
|
361
|
+
end
|
362
|
+
hash
|
363
|
+
end
|
364
|
+
|
365
|
+
# Outputs non-array value in the form of hash
|
366
|
+
# For object, use to_hash. Otherwise, just return the value
|
367
|
+
# @param [Object] value Any valid value
|
368
|
+
# @return [Hash] Returns the value in the form of hash
|
369
|
+
def _to_hash(value)
|
370
|
+
if value.is_a?(Array)
|
371
|
+
value.compact.map{ |v| _to_hash(v) }
|
372
|
+
elsif value.is_a?(Hash)
|
373
|
+
{}.tap do |hash|
|
374
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
375
|
+
end
|
376
|
+
elsif value.respond_to? :to_hash
|
377
|
+
value.to_hash
|
378
|
+
else
|
379
|
+
value
|
380
|
+
end
|
381
|
+
end
|
382
|
+
|
383
|
+
end
|
384
|
+
|
385
|
+
end
|