groupdocs_signature_cloud 18.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (160) hide show
  1. checksums.yaml +7 -0
  2. data/lib/groupdocs_signature_cloud.rb +191 -0
  3. data/lib/groupdocs_signature_cloud/api/signature_api.rb +2590 -0
  4. data/lib/groupdocs_signature_cloud/api_client.rb +380 -0
  5. data/lib/groupdocs_signature_cloud/api_error.rb +58 -0
  6. data/lib/groupdocs_signature_cloud/configuration.rb +110 -0
  7. data/lib/groupdocs_signature_cloud/models/barcode_collection.rb +232 -0
  8. data/lib/groupdocs_signature_cloud/models/barcode_signature_data.rb +250 -0
  9. data/lib/groupdocs_signature_cloud/models/barcode_type.rb +230 -0
  10. data/lib/groupdocs_signature_cloud/models/base_signature_data.rb +230 -0
  11. data/lib/groupdocs_signature_cloud/models/border_line_data.rb +312 -0
  12. data/lib/groupdocs_signature_cloud/models/brush_data.rb +230 -0
  13. data/lib/groupdocs_signature_cloud/models/cells_barcode_signature_data.rb +250 -0
  14. data/lib/groupdocs_signature_cloud/models/cells_digital_signature_data.rb +307 -0
  15. data/lib/groupdocs_signature_cloud/models/cells_qr_code_signature_data.rb +250 -0
  16. data/lib/groupdocs_signature_cloud/models/cells_search_barcode_options_data.rb +332 -0
  17. data/lib/groupdocs_signature_cloud/models/cells_search_digital_options_data.rb +265 -0
  18. data/lib/groupdocs_signature_cloud/models/cells_search_qr_code_options_data.rb +332 -0
  19. data/lib/groupdocs_signature_cloud/models/cells_sign_barcode_options_data.rb +694 -0
  20. data/lib/groupdocs_signature_cloud/models/cells_sign_digital_options_data.rb +546 -0
  21. data/lib/groupdocs_signature_cloud/models/cells_sign_image_options_data.rb +526 -0
  22. data/lib/groupdocs_signature_cloud/models/cells_sign_qr_code_options_data.rb +704 -0
  23. data/lib/groupdocs_signature_cloud/models/cells_sign_stamp_options_data.rb +622 -0
  24. data/lib/groupdocs_signature_cloud/models/cells_sign_text_options_data.rb +736 -0
  25. data/lib/groupdocs_signature_cloud/models/cells_verify_barcode_options_data.rb +342 -0
  26. data/lib/groupdocs_signature_cloud/models/cells_verify_digital_options_data.rb +315 -0
  27. data/lib/groupdocs_signature_cloud/models/cells_verify_qr_code_options_data.rb +342 -0
  28. data/lib/groupdocs_signature_cloud/models/cells_verify_text_options_data.rb +285 -0
  29. data/lib/groupdocs_signature_cloud/models/color.rb +245 -0
  30. data/lib/groupdocs_signature_cloud/models/digital_signature_data.rb +307 -0
  31. data/lib/groupdocs_signature_cloud/models/document_info.rb +300 -0
  32. data/lib/groupdocs_signature_cloud/models/document_response.rb +302 -0
  33. data/lib/groupdocs_signature_cloud/models/format.rb +240 -0
  34. data/lib/groupdocs_signature_cloud/models/format_collection.rb +232 -0
  35. data/lib/groupdocs_signature_cloud/models/images_barcode_signature_data.rb +250 -0
  36. data/lib/groupdocs_signature_cloud/models/images_qr_code_signature_data.rb +250 -0
  37. data/lib/groupdocs_signature_cloud/models/images_search_barcode_options_data.rb +332 -0
  38. data/lib/groupdocs_signature_cloud/models/images_search_qr_code_options_data.rb +332 -0
  39. data/lib/groupdocs_signature_cloud/models/images_sign_barcode_options_data.rb +664 -0
  40. data/lib/groupdocs_signature_cloud/models/images_sign_image_options_data.rb +496 -0
  41. data/lib/groupdocs_signature_cloud/models/images_sign_qr_code_options_data.rb +674 -0
  42. data/lib/groupdocs_signature_cloud/models/images_sign_stamp_options_data.rb +592 -0
  43. data/lib/groupdocs_signature_cloud/models/images_sign_text_options_data.rb +706 -0
  44. data/lib/groupdocs_signature_cloud/models/images_verify_barcode_options_data.rb +342 -0
  45. data/lib/groupdocs_signature_cloud/models/images_verify_qr_code_options_data.rb +342 -0
  46. data/lib/groupdocs_signature_cloud/models/linear_gradient_brush_data.rb +260 -0
  47. data/lib/groupdocs_signature_cloud/models/padding_data.rb +295 -0
  48. data/lib/groupdocs_signature_cloud/models/page_info.rb +305 -0
  49. data/lib/groupdocs_signature_cloud/models/pages_info.rb +247 -0
  50. data/lib/groupdocs_signature_cloud/models/pages_setup_data.rb +292 -0
  51. data/lib/groupdocs_signature_cloud/models/pdf_barcode_signature_data.rb +250 -0
  52. data/lib/groupdocs_signature_cloud/models/pdf_digital_signature_data.rb +307 -0
  53. data/lib/groupdocs_signature_cloud/models/pdf_qr_code_signature_data.rb +250 -0
  54. data/lib/groupdocs_signature_cloud/models/pdf_search_barcode_options_data.rb +332 -0
  55. data/lib/groupdocs_signature_cloud/models/pdf_search_digital_options_data.rb +265 -0
  56. data/lib/groupdocs_signature_cloud/models/pdf_search_qr_code_options_data.rb +332 -0
  57. data/lib/groupdocs_signature_cloud/models/pdf_sign_barcode_options_data.rb +664 -0
  58. data/lib/groupdocs_signature_cloud/models/pdf_sign_digital_options_data.rb +556 -0
  59. data/lib/groupdocs_signature_cloud/models/pdf_sign_image_options_data.rb +496 -0
  60. data/lib/groupdocs_signature_cloud/models/pdf_sign_qr_code_options_data.rb +674 -0
  61. data/lib/groupdocs_signature_cloud/models/pdf_sign_stamp_options_data.rb +592 -0
  62. data/lib/groupdocs_signature_cloud/models/pdf_sign_text_options_data.rb +696 -0
  63. data/lib/groupdocs_signature_cloud/models/pdf_verify_barcode_options_data.rb +342 -0
  64. data/lib/groupdocs_signature_cloud/models/pdf_verify_digital_options_data.rb +315 -0
  65. data/lib/groupdocs_signature_cloud/models/pdf_verify_qr_code_options_data.rb +342 -0
  66. data/lib/groupdocs_signature_cloud/models/pdf_verify_text_options_data.rb +342 -0
  67. data/lib/groupdocs_signature_cloud/models/qr_code_collection.rb +232 -0
  68. data/lib/groupdocs_signature_cloud/models/qr_code_signature_data.rb +250 -0
  69. data/lib/groupdocs_signature_cloud/models/qr_code_type.rb +230 -0
  70. data/lib/groupdocs_signature_cloud/models/radial_gradient_brush_data.rb +250 -0
  71. data/lib/groupdocs_signature_cloud/models/requests/get_document_info_from_url_request.rb +55 -0
  72. data/lib/groupdocs_signature_cloud/models/requests/get_document_info_request.rb +59 -0
  73. data/lib/groupdocs_signature_cloud/models/requests/post_barcode_from_url_request.rb +59 -0
  74. data/lib/groupdocs_signature_cloud/models/requests/post_barcode_request.rb +63 -0
  75. data/lib/groupdocs_signature_cloud/models/requests/post_collection_from_url_request.rb +59 -0
  76. data/lib/groupdocs_signature_cloud/models/requests/post_collection_request.rb +63 -0
  77. data/lib/groupdocs_signature_cloud/models/requests/post_digital_from_url_request.rb +67 -0
  78. data/lib/groupdocs_signature_cloud/models/requests/post_digital_request.rb +71 -0
  79. data/lib/groupdocs_signature_cloud/models/requests/post_image_from_url_request.rb +63 -0
  80. data/lib/groupdocs_signature_cloud/models/requests/post_image_request.rb +67 -0
  81. data/lib/groupdocs_signature_cloud/models/requests/post_qr_code_from_url_request.rb +59 -0
  82. data/lib/groupdocs_signature_cloud/models/requests/post_qr_code_request.rb +63 -0
  83. data/lib/groupdocs_signature_cloud/models/requests/post_search_barcode_from_url_request.rb +59 -0
  84. data/lib/groupdocs_signature_cloud/models/requests/post_search_barcode_request.rb +63 -0
  85. data/lib/groupdocs_signature_cloud/models/requests/post_search_collection_from_url_request.rb +59 -0
  86. data/lib/groupdocs_signature_cloud/models/requests/post_search_collection_request.rb +63 -0
  87. data/lib/groupdocs_signature_cloud/models/requests/post_search_digital_from_url_request.rb +59 -0
  88. data/lib/groupdocs_signature_cloud/models/requests/post_search_digital_request.rb +63 -0
  89. data/lib/groupdocs_signature_cloud/models/requests/post_search_qr_code_from_url_request.rb +59 -0
  90. data/lib/groupdocs_signature_cloud/models/requests/post_search_qr_code_request.rb +63 -0
  91. data/lib/groupdocs_signature_cloud/models/requests/post_stamp_from_url_request.rb +59 -0
  92. data/lib/groupdocs_signature_cloud/models/requests/post_stamp_request.rb +63 -0
  93. data/lib/groupdocs_signature_cloud/models/requests/post_text_from_url_request.rb +59 -0
  94. data/lib/groupdocs_signature_cloud/models/requests/post_text_request.rb +63 -0
  95. data/lib/groupdocs_signature_cloud/models/requests/post_verification_barcode_from_url_request.rb +59 -0
  96. data/lib/groupdocs_signature_cloud/models/requests/post_verification_barcode_request.rb +63 -0
  97. data/lib/groupdocs_signature_cloud/models/requests/post_verification_collection_from_url_request.rb +59 -0
  98. data/lib/groupdocs_signature_cloud/models/requests/post_verification_collection_request.rb +63 -0
  99. data/lib/groupdocs_signature_cloud/models/requests/post_verification_digital_from_url_request.rb +63 -0
  100. data/lib/groupdocs_signature_cloud/models/requests/post_verification_digital_request.rb +67 -0
  101. data/lib/groupdocs_signature_cloud/models/requests/post_verification_qr_code_from_url_request.rb +59 -0
  102. data/lib/groupdocs_signature_cloud/models/requests/post_verification_qr_code_request.rb +63 -0
  103. data/lib/groupdocs_signature_cloud/models/requests/post_verification_text_from_url_request.rb +57 -0
  104. data/lib/groupdocs_signature_cloud/models/requests/post_verification_text_request.rb +63 -0
  105. data/lib/groupdocs_signature_cloud/models/search_barcode_options_data.rb +332 -0
  106. data/lib/groupdocs_signature_cloud/models/search_digital_options_data.rb +265 -0
  107. data/lib/groupdocs_signature_cloud/models/search_document_response.rb +305 -0
  108. data/lib/groupdocs_signature_cloud/models/search_options_collection_data.rb +232 -0
  109. data/lib/groupdocs_signature_cloud/models/search_options_data.rb +265 -0
  110. data/lib/groupdocs_signature_cloud/models/search_qr_code_options_data.rb +332 -0
  111. data/lib/groupdocs_signature_cloud/models/sign_barcode_options_data.rb +664 -0
  112. data/lib/groupdocs_signature_cloud/models/sign_digital_options_data.rb +516 -0
  113. data/lib/groupdocs_signature_cloud/models/sign_image_options_data.rb +496 -0
  114. data/lib/groupdocs_signature_cloud/models/sign_options_collection_data.rb +232 -0
  115. data/lib/groupdocs_signature_cloud/models/sign_options_data.rb +255 -0
  116. data/lib/groupdocs_signature_cloud/models/sign_qr_code_options_data.rb +674 -0
  117. data/lib/groupdocs_signature_cloud/models/sign_stamp_options_data.rb +592 -0
  118. data/lib/groupdocs_signature_cloud/models/sign_text_options_data.rb +562 -0
  119. data/lib/groupdocs_signature_cloud/models/signature_document_response.rb +290 -0
  120. data/lib/groupdocs_signature_cloud/models/signature_font_data.rb +290 -0
  121. data/lib/groupdocs_signature_cloud/models/slides_barcode_signature_data.rb +250 -0
  122. data/lib/groupdocs_signature_cloud/models/slides_qr_code_signature_data.rb +250 -0
  123. data/lib/groupdocs_signature_cloud/models/slides_search_barcode_options_data.rb +332 -0
  124. data/lib/groupdocs_signature_cloud/models/slides_search_qr_code_options_data.rb +332 -0
  125. data/lib/groupdocs_signature_cloud/models/slides_sign_barcode_options_data.rb +664 -0
  126. data/lib/groupdocs_signature_cloud/models/slides_sign_image_options_data.rb +496 -0
  127. data/lib/groupdocs_signature_cloud/models/slides_sign_qr_code_options_data.rb +674 -0
  128. data/lib/groupdocs_signature_cloud/models/slides_sign_stamp_options_data.rb +592 -0
  129. data/lib/groupdocs_signature_cloud/models/slides_sign_text_options_data.rb +670 -0
  130. data/lib/groupdocs_signature_cloud/models/slides_verify_barcode_options_data.rb +342 -0
  131. data/lib/groupdocs_signature_cloud/models/slides_verify_qr_code_options_data.rb +342 -0
  132. data/lib/groupdocs_signature_cloud/models/slides_verify_text_options_data.rb +285 -0
  133. data/lib/groupdocs_signature_cloud/models/solid_brush_data.rb +240 -0
  134. data/lib/groupdocs_signature_cloud/models/stamp_line_data.rb +377 -0
  135. data/lib/groupdocs_signature_cloud/models/texture_brush_data.rb +240 -0
  136. data/lib/groupdocs_signature_cloud/models/verified_document_response.rb +300 -0
  137. data/lib/groupdocs_signature_cloud/models/verify_barcode_options_data.rb +342 -0
  138. data/lib/groupdocs_signature_cloud/models/verify_digital_options_data.rb +285 -0
  139. data/lib/groupdocs_signature_cloud/models/verify_options_collection_data.rb +247 -0
  140. data/lib/groupdocs_signature_cloud/models/verify_options_data.rb +265 -0
  141. data/lib/groupdocs_signature_cloud/models/verify_qr_code_options_data.rb +342 -0
  142. data/lib/groupdocs_signature_cloud/models/verify_text_options_data.rb +285 -0
  143. data/lib/groupdocs_signature_cloud/models/words_barcode_signature_data.rb +250 -0
  144. data/lib/groupdocs_signature_cloud/models/words_digital_signature_data.rb +307 -0
  145. data/lib/groupdocs_signature_cloud/models/words_qr_code_signature_data.rb +250 -0
  146. data/lib/groupdocs_signature_cloud/models/words_search_barcode_options_data.rb +332 -0
  147. data/lib/groupdocs_signature_cloud/models/words_search_digital_options_data.rb +265 -0
  148. data/lib/groupdocs_signature_cloud/models/words_search_qr_code_options_data.rb +332 -0
  149. data/lib/groupdocs_signature_cloud/models/words_sign_barcode_options_data.rb +664 -0
  150. data/lib/groupdocs_signature_cloud/models/words_sign_digital_options_data.rb +516 -0
  151. data/lib/groupdocs_signature_cloud/models/words_sign_image_options_data.rb +496 -0
  152. data/lib/groupdocs_signature_cloud/models/words_sign_qr_code_options_data.rb +674 -0
  153. data/lib/groupdocs_signature_cloud/models/words_sign_stamp_options_data.rb +592 -0
  154. data/lib/groupdocs_signature_cloud/models/words_sign_text_options_data.rb +696 -0
  155. data/lib/groupdocs_signature_cloud/models/words_verify_barcode_options_data.rb +342 -0
  156. data/lib/groupdocs_signature_cloud/models/words_verify_digital_options_data.rb +315 -0
  157. data/lib/groupdocs_signature_cloud/models/words_verify_qr_code_options_data.rb +342 -0
  158. data/lib/groupdocs_signature_cloud/models/words_verify_text_options_data.rb +285 -0
  159. data/lib/groupdocs_signature_cloud/version.rb +29 -0
  160. metadata +290 -0
@@ -0,0 +1,696 @@
1
+ #
2
+ # --------------------------------------------------------------------------------------------------------------------
3
+ # <copyright company="Aspose Pty Ltd" file="pdf_sign_text_options_data.rb">
4
+ # Copyright (c) 2003-2018 Aspose Pty Ltd
5
+ # </copyright>
6
+ # <summary>
7
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ # of this software and associated documentation files (the "Software"), to deal
9
+ # in the Software without restriction, including without limitation the rights
10
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ # copies of the Software, and to permit persons to whom the Software is
12
+ # furnished to do so, subject to the following conditions:
13
+ #
14
+ # The above copyright notice and this permission notice shall be included in all
15
+ # copies or substantial portions of the Software.
16
+ #
17
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
+ # SOFTWARE.
24
+ # </summary>
25
+ # --------------------------------------------------------------------------------------------------------------------
26
+ #
27
+
28
+ require 'date'
29
+
30
+ module GroupDocsSignatureCloud
31
+ # Represents the Text Sign Options for PDF Documents.
32
+ class PdfSignTextOptionsData
33
+
34
+ # Gets or sets a document page number to put signature Value starts from 1
35
+ attr_accessor :document_page_number
36
+
37
+ # Page Options to specify pages to be verified.
38
+ attr_accessor :pages_setup
39
+
40
+ # Internal property that specify the name of Options.
41
+ attr_accessor :options_type
42
+
43
+ # Left X position of Signature on Document Page in Measure values (pixels or percent see LocationMeasureType property)
44
+ attr_accessor :left
45
+
46
+ # Top Y Position of Signature on Document Page in Measure values (pixels or percent see LocationMeasureType property)
47
+ attr_accessor :top
48
+
49
+ # Width of Signature area on Document Page in Measure values (pixels or percent see SizeMeasureType property)
50
+ attr_accessor :width
51
+
52
+ # Height of Signature are on Document Page in Measure values (pixels or percent see SizeMeasureType property)
53
+ attr_accessor :height
54
+
55
+ # Measure type (pixels or percent) for Left and Top properties.
56
+ attr_accessor :location_measure_type
57
+
58
+ # Measure type (pixels or percent) for Width and Height properties.
59
+ attr_accessor :size_measure_type
60
+
61
+ # Stretch mode on Document Page
62
+ attr_accessor :stretch
63
+
64
+ # Rotation angle of signature on document page (clockwise).
65
+ attr_accessor :rotation_angle
66
+
67
+ # Horizontal alignment of signature on document page.
68
+ attr_accessor :horizontal_alignment
69
+
70
+ # Vertical alignment of signature on document page.
71
+ attr_accessor :vertical_alignment
72
+
73
+ # Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
74
+ attr_accessor :margin
75
+
76
+ # Gets or sets the measure type (pixels or percent) for Margin.
77
+ attr_accessor :margin_measure_type
78
+
79
+ # Text of signature
80
+ attr_accessor :text
81
+
82
+ # Put signature on all document pages.
83
+ attr_accessor :sign_all_pages
84
+
85
+ # Gets or sets the font of signature.
86
+ attr_accessor :font
87
+
88
+ # Gets or sets the fore color of signature.
89
+ attr_accessor :fore_color
90
+
91
+ # Gets or sets the border color of signature.
92
+ attr_accessor :border_color
93
+
94
+ # Gets or sets the background color of signature.
95
+ attr_accessor :background_color
96
+
97
+ # Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For Stamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. It is not used for Annotation, Sticker, TextToFormField and Watermark implementations.
98
+ attr_accessor :background_brush
99
+
100
+ # Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.
101
+ attr_accessor :opacity
102
+
103
+ # Gets or sets the unique ID of signature. It can be used in signature verification options.
104
+ attr_accessor :signature_id
105
+
106
+ # Gets or sets the type of text signature implementation.
107
+ attr_accessor :signature_implementation
108
+
109
+ # Gets or sets the title of text form field to put text signature into it. This property could be used only with PdfTextSignatureImplementation = TextToFormField.
110
+ attr_accessor :form_text_field_title
111
+
112
+ # Gets or sets the type of form field to put text signature into it. This property could be used only with PdfTextSignatureImplementation = TextToFormField. Value by default is AllTextTypes.
113
+ attr_accessor :form_text_field_type
114
+
115
+ # Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see SignatureImplementation property).
116
+ attr_accessor :text_horizontal_alignment
117
+
118
+ # Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see SignatureImplementation property).
119
+ attr_accessor :text_vertical_alignment
120
+ class EnumAttributeValidator
121
+ attr_reader :datatype
122
+ attr_reader :allowable_values
123
+
124
+ def initialize(datatype, allowable_values)
125
+ @allowable_values = allowable_values.map do |value|
126
+ case datatype.to_s
127
+ when /Integer/i
128
+ value.to_i
129
+ when /Float/i
130
+ value.to_f
131
+ else
132
+ value
133
+ end
134
+ end
135
+ end
136
+
137
+ def valid?(value)
138
+ !value || allowable_values.include?(value)
139
+ end
140
+ end
141
+
142
+ # Attribute mapping from ruby-style variable name to JSON key.
143
+ def self.attribute_map
144
+ {
145
+ :'document_page_number' => :'DocumentPageNumber',
146
+ :'pages_setup' => :'PagesSetup',
147
+ :'options_type' => :'OptionsType',
148
+ :'left' => :'Left',
149
+ :'top' => :'Top',
150
+ :'width' => :'Width',
151
+ :'height' => :'Height',
152
+ :'location_measure_type' => :'LocationMeasureType',
153
+ :'size_measure_type' => :'SizeMeasureType',
154
+ :'stretch' => :'Stretch',
155
+ :'rotation_angle' => :'RotationAngle',
156
+ :'horizontal_alignment' => :'HorizontalAlignment',
157
+ :'vertical_alignment' => :'VerticalAlignment',
158
+ :'margin' => :'Margin',
159
+ :'margin_measure_type' => :'MarginMeasureType',
160
+ :'text' => :'Text',
161
+ :'sign_all_pages' => :'SignAllPages',
162
+ :'font' => :'Font',
163
+ :'fore_color' => :'ForeColor',
164
+ :'border_color' => :'BorderColor',
165
+ :'background_color' => :'BackgroundColor',
166
+ :'background_brush' => :'BackgroundBrush',
167
+ :'opacity' => :'Opacity',
168
+ :'signature_id' => :'SignatureID',
169
+ :'signature_implementation' => :'SignatureImplementation',
170
+ :'form_text_field_title' => :'FormTextFieldTitle',
171
+ :'form_text_field_type' => :'FormTextFieldType',
172
+ :'text_horizontal_alignment' => :'TextHorizontalAlignment',
173
+ :'text_vertical_alignment' => :'TextVerticalAlignment'
174
+ }
175
+ end
176
+
177
+ # Attribute type mapping.
178
+ def self.swagger_types
179
+ {
180
+ :'document_page_number' => :'Integer',
181
+ :'pages_setup' => :'PagesSetupData',
182
+ :'options_type' => :'String',
183
+ :'left' => :'Integer',
184
+ :'top' => :'Integer',
185
+ :'width' => :'Integer',
186
+ :'height' => :'Integer',
187
+ :'location_measure_type' => :'String',
188
+ :'size_measure_type' => :'String',
189
+ :'stretch' => :'String',
190
+ :'rotation_angle' => :'Integer',
191
+ :'horizontal_alignment' => :'String',
192
+ :'vertical_alignment' => :'String',
193
+ :'margin' => :'PaddingData',
194
+ :'margin_measure_type' => :'String',
195
+ :'text' => :'String',
196
+ :'sign_all_pages' => :'BOOLEAN',
197
+ :'font' => :'SignatureFontData',
198
+ :'fore_color' => :'Color',
199
+ :'border_color' => :'Color',
200
+ :'background_color' => :'Color',
201
+ :'background_brush' => :'BrushData',
202
+ :'opacity' => :'Float',
203
+ :'signature_id' => :'Integer',
204
+ :'signature_implementation' => :'String',
205
+ :'form_text_field_title' => :'String',
206
+ :'form_text_field_type' => :'String',
207
+ :'text_horizontal_alignment' => :'String',
208
+ :'text_vertical_alignment' => :'String'
209
+ }
210
+ end
211
+
212
+ # Initializes the object
213
+ # @param [Hash] attributes Model attributes in the form of hash
214
+ def initialize(attributes = {})
215
+ return unless attributes.is_a?(Hash)
216
+
217
+ # convert string to symbol for hash key
218
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
219
+
220
+ if attributes.key?(:'DocumentPageNumber')
221
+ self.document_page_number = attributes[:'DocumentPageNumber']
222
+ end
223
+
224
+ if attributes.key?(:'PagesSetup')
225
+ self.pages_setup = attributes[:'PagesSetup']
226
+ end
227
+
228
+ if attributes.key?(:'OptionsType')
229
+ self.options_type = attributes[:'OptionsType']
230
+ end
231
+
232
+ if attributes.key?(:'Left')
233
+ self.left = attributes[:'Left']
234
+ end
235
+
236
+ if attributes.key?(:'Top')
237
+ self.top = attributes[:'Top']
238
+ end
239
+
240
+ if attributes.key?(:'Width')
241
+ self.width = attributes[:'Width']
242
+ end
243
+
244
+ if attributes.key?(:'Height')
245
+ self.height = attributes[:'Height']
246
+ end
247
+
248
+ if attributes.key?(:'LocationMeasureType')
249
+ self.location_measure_type = attributes[:'LocationMeasureType']
250
+ end
251
+
252
+ if attributes.key?(:'SizeMeasureType')
253
+ self.size_measure_type = attributes[:'SizeMeasureType']
254
+ end
255
+
256
+ if attributes.key?(:'Stretch')
257
+ self.stretch = attributes[:'Stretch']
258
+ end
259
+
260
+ if attributes.key?(:'RotationAngle')
261
+ self.rotation_angle = attributes[:'RotationAngle']
262
+ end
263
+
264
+ if attributes.key?(:'HorizontalAlignment')
265
+ self.horizontal_alignment = attributes[:'HorizontalAlignment']
266
+ end
267
+
268
+ if attributes.key?(:'VerticalAlignment')
269
+ self.vertical_alignment = attributes[:'VerticalAlignment']
270
+ end
271
+
272
+ if attributes.key?(:'Margin')
273
+ self.margin = attributes[:'Margin']
274
+ end
275
+
276
+ if attributes.key?(:'MarginMeasureType')
277
+ self.margin_measure_type = attributes[:'MarginMeasureType']
278
+ end
279
+
280
+ if attributes.key?(:'Text')
281
+ self.text = attributes[:'Text']
282
+ end
283
+
284
+ if attributes.key?(:'SignAllPages')
285
+ self.sign_all_pages = attributes[:'SignAllPages']
286
+ end
287
+
288
+ if attributes.key?(:'Font')
289
+ self.font = attributes[:'Font']
290
+ end
291
+
292
+ if attributes.key?(:'ForeColor')
293
+ self.fore_color = attributes[:'ForeColor']
294
+ end
295
+
296
+ if attributes.key?(:'BorderColor')
297
+ self.border_color = attributes[:'BorderColor']
298
+ end
299
+
300
+ if attributes.key?(:'BackgroundColor')
301
+ self.background_color = attributes[:'BackgroundColor']
302
+ end
303
+
304
+ if attributes.key?(:'BackgroundBrush')
305
+ self.background_brush = attributes[:'BackgroundBrush']
306
+ end
307
+
308
+ if attributes.key?(:'Opacity')
309
+ self.opacity = attributes[:'Opacity']
310
+ end
311
+
312
+ if attributes.key?(:'SignatureID')
313
+ self.signature_id = attributes[:'SignatureID']
314
+ end
315
+
316
+ if attributes.key?(:'SignatureImplementation')
317
+ self.signature_implementation = attributes[:'SignatureImplementation']
318
+ end
319
+
320
+ if attributes.key?(:'FormTextFieldTitle')
321
+ self.form_text_field_title = attributes[:'FormTextFieldTitle']
322
+ end
323
+
324
+ if attributes.key?(:'FormTextFieldType')
325
+ self.form_text_field_type = attributes[:'FormTextFieldType']
326
+ end
327
+
328
+ if attributes.key?(:'TextHorizontalAlignment')
329
+ self.text_horizontal_alignment = attributes[:'TextHorizontalAlignment']
330
+ end
331
+
332
+ if attributes.key?(:'TextVerticalAlignment')
333
+ self.text_vertical_alignment = attributes[:'TextVerticalAlignment']
334
+ end
335
+
336
+
337
+ if !((defined? options_type) == nil)
338
+ self.options_type = "PdfSignTextOptionsData"
339
+ end
340
+
341
+ end
342
+
343
+ # Show invalid properties with the reasons. Usually used together with valid?
344
+ # @return Array for valid properies with the reasons
345
+ def list_invalid_properties
346
+ invalid_properties = []
347
+ if @document_page_number.nil?
348
+ invalid_properties.push("invalid value for 'document_page_number', document_page_number cannot be nil.")
349
+ end
350
+
351
+ return invalid_properties
352
+ end
353
+
354
+ # Check to see if the all the properties in the model are valid
355
+ # @return true if the model is valid
356
+ def valid?
357
+ return false if @document_page_number.nil?
358
+ location_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
359
+ return false unless location_measure_type_validator.valid?(@location_measure_type)
360
+ size_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
361
+ return false unless size_measure_type_validator.valid?(@size_measure_type)
362
+ stretch_validator = EnumAttributeValidator.new('String', ["None", "PageWidth", "PageHeight", "PageArea"])
363
+ return false unless stretch_validator.valid?(@stretch)
364
+ horizontal_alignment_validator = EnumAttributeValidator.new('String', ["Default", "None", "Left", "Center", "Right"])
365
+ return false unless horizontal_alignment_validator.valid?(@horizontal_alignment)
366
+ vertical_alignment_validator = EnumAttributeValidator.new('String', ["Default", "None", "Top", "Center", "Bottom"])
367
+ return false unless vertical_alignment_validator.valid?(@vertical_alignment)
368
+ margin_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
369
+ return false unless margin_measure_type_validator.valid?(@margin_measure_type)
370
+ signature_implementation_validator = EnumAttributeValidator.new('String', ["Stamp", "Image", "Annotation", "Sticker", "TextToFormField", "Watermark"])
371
+ return false unless signature_implementation_validator.valid?(@signature_implementation)
372
+ form_text_field_type_validator = EnumAttributeValidator.new('String', ["AllTextTypes", "PlainText", "RichText"])
373
+ return false unless form_text_field_type_validator.valid?(@form_text_field_type)
374
+ text_horizontal_alignment_validator = EnumAttributeValidator.new('String', ["Left", "Center", "Right"])
375
+ return false unless text_horizontal_alignment_validator.valid?(@text_horizontal_alignment)
376
+ text_vertical_alignment_validator = EnumAttributeValidator.new('String', ["Top", "Center", "Bottom"])
377
+ return false unless text_vertical_alignment_validator.valid?(@text_vertical_alignment)
378
+ return true
379
+ end
380
+
381
+ # Custom attribute writer method checking allowed values (enum).
382
+ # @param [Object] location_measure_type Object to be assigned
383
+ def location_measure_type=(location_measure_type)
384
+ validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
385
+ if location_measure_type.to_i == 0
386
+ unless validator.valid?(location_measure_type)
387
+ raise ArgumentError, "invalid value for 'location_measure_type', must be one of #{validator.allowable_values}."
388
+ end
389
+ @location_measure_type = location_measure_type
390
+ else
391
+ @location_measure_type = validator.allowable_values[location_measure_type.to_i]
392
+ end
393
+ end
394
+
395
+ # Custom attribute writer method checking allowed values (enum).
396
+ # @param [Object] size_measure_type Object to be assigned
397
+ def size_measure_type=(size_measure_type)
398
+ validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
399
+ if size_measure_type.to_i == 0
400
+ unless validator.valid?(size_measure_type)
401
+ raise ArgumentError, "invalid value for 'size_measure_type', must be one of #{validator.allowable_values}."
402
+ end
403
+ @size_measure_type = size_measure_type
404
+ else
405
+ @size_measure_type = validator.allowable_values[size_measure_type.to_i]
406
+ end
407
+ end
408
+
409
+ # Custom attribute writer method checking allowed values (enum).
410
+ # @param [Object] stretch Object to be assigned
411
+ def stretch=(stretch)
412
+ validator = EnumAttributeValidator.new('String', ["None", "PageWidth", "PageHeight", "PageArea"])
413
+ if stretch.to_i == 0
414
+ unless validator.valid?(stretch)
415
+ raise ArgumentError, "invalid value for 'stretch', must be one of #{validator.allowable_values}."
416
+ end
417
+ @stretch = stretch
418
+ else
419
+ @stretch = validator.allowable_values[stretch.to_i]
420
+ end
421
+ end
422
+
423
+ # Custom attribute writer method checking allowed values (enum).
424
+ # @param [Object] horizontal_alignment Object to be assigned
425
+ def horizontal_alignment=(horizontal_alignment)
426
+ validator = EnumAttributeValidator.new('String', ["Default", "None", "Left", "Center", "Right"])
427
+ if horizontal_alignment.to_i == 0
428
+ unless validator.valid?(horizontal_alignment)
429
+ raise ArgumentError, "invalid value for 'horizontal_alignment', must be one of #{validator.allowable_values}."
430
+ end
431
+ @horizontal_alignment = horizontal_alignment
432
+ else
433
+ @horizontal_alignment = validator.allowable_values[horizontal_alignment.to_i]
434
+ end
435
+ end
436
+
437
+ # Custom attribute writer method checking allowed values (enum).
438
+ # @param [Object] vertical_alignment Object to be assigned
439
+ def vertical_alignment=(vertical_alignment)
440
+ validator = EnumAttributeValidator.new('String', ["Default", "None", "Top", "Center", "Bottom"])
441
+ if vertical_alignment.to_i == 0
442
+ unless validator.valid?(vertical_alignment)
443
+ raise ArgumentError, "invalid value for 'vertical_alignment', must be one of #{validator.allowable_values}."
444
+ end
445
+ @vertical_alignment = vertical_alignment
446
+ else
447
+ @vertical_alignment = validator.allowable_values[vertical_alignment.to_i]
448
+ end
449
+ end
450
+
451
+ # Custom attribute writer method checking allowed values (enum).
452
+ # @param [Object] margin_measure_type Object to be assigned
453
+ def margin_measure_type=(margin_measure_type)
454
+ validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
455
+ if margin_measure_type.to_i == 0
456
+ unless validator.valid?(margin_measure_type)
457
+ raise ArgumentError, "invalid value for 'margin_measure_type', must be one of #{validator.allowable_values}."
458
+ end
459
+ @margin_measure_type = margin_measure_type
460
+ else
461
+ @margin_measure_type = validator.allowable_values[margin_measure_type.to_i]
462
+ end
463
+ end
464
+
465
+ # Custom attribute writer method checking allowed values (enum).
466
+ # @param [Object] signature_implementation Object to be assigned
467
+ def signature_implementation=(signature_implementation)
468
+ validator = EnumAttributeValidator.new('String', ["Stamp", "Image", "Annotation", "Sticker", "TextToFormField", "Watermark"])
469
+ if signature_implementation.to_i == 0
470
+ unless validator.valid?(signature_implementation)
471
+ raise ArgumentError, "invalid value for 'signature_implementation', must be one of #{validator.allowable_values}."
472
+ end
473
+ @signature_implementation = signature_implementation
474
+ else
475
+ @signature_implementation = validator.allowable_values[signature_implementation.to_i]
476
+ end
477
+ end
478
+
479
+ # Custom attribute writer method checking allowed values (enum).
480
+ # @param [Object] form_text_field_type Object to be assigned
481
+ def form_text_field_type=(form_text_field_type)
482
+ validator = EnumAttributeValidator.new('String', ["AllTextTypes", "PlainText", "RichText"])
483
+ if form_text_field_type.to_i == 0
484
+ unless validator.valid?(form_text_field_type)
485
+ raise ArgumentError, "invalid value for 'form_text_field_type', must be one of #{validator.allowable_values}."
486
+ end
487
+ @form_text_field_type = form_text_field_type
488
+ else
489
+ @form_text_field_type = validator.allowable_values[form_text_field_type.to_i]
490
+ end
491
+ end
492
+
493
+ # Custom attribute writer method checking allowed values (enum).
494
+ # @param [Object] text_horizontal_alignment Object to be assigned
495
+ def text_horizontal_alignment=(text_horizontal_alignment)
496
+ validator = EnumAttributeValidator.new('String', ["Left", "Center", "Right"])
497
+ if text_horizontal_alignment.to_i == 0
498
+ unless validator.valid?(text_horizontal_alignment)
499
+ raise ArgumentError, "invalid value for 'text_horizontal_alignment', must be one of #{validator.allowable_values}."
500
+ end
501
+ @text_horizontal_alignment = text_horizontal_alignment
502
+ else
503
+ @text_horizontal_alignment = validator.allowable_values[text_horizontal_alignment.to_i]
504
+ end
505
+ end
506
+
507
+ # Custom attribute writer method checking allowed values (enum).
508
+ # @param [Object] text_vertical_alignment Object to be assigned
509
+ def text_vertical_alignment=(text_vertical_alignment)
510
+ validator = EnumAttributeValidator.new('String', ["Top", "Center", "Bottom"])
511
+ if text_vertical_alignment.to_i == 0
512
+ unless validator.valid?(text_vertical_alignment)
513
+ raise ArgumentError, "invalid value for 'text_vertical_alignment', must be one of #{validator.allowable_values}."
514
+ end
515
+ @text_vertical_alignment = text_vertical_alignment
516
+ else
517
+ @text_vertical_alignment = validator.allowable_values[text_vertical_alignment.to_i]
518
+ end
519
+ end
520
+
521
+ # Checks equality by comparing each attribute.
522
+ # @param [Object] Object to be compared
523
+ def ==(other)
524
+ return true if self.equal?(other)
525
+ self.class == other.class &&
526
+ document_page_number == other.document_page_number &&
527
+ pages_setup == other.pages_setup &&
528
+ options_type == other.options_type &&
529
+ left == other.left &&
530
+ top == other.top &&
531
+ width == other.width &&
532
+ height == other.height &&
533
+ location_measure_type == other.location_measure_type &&
534
+ size_measure_type == other.size_measure_type &&
535
+ stretch == other.stretch &&
536
+ rotation_angle == other.rotation_angle &&
537
+ horizontal_alignment == other.horizontal_alignment &&
538
+ vertical_alignment == other.vertical_alignment &&
539
+ margin == other.margin &&
540
+ margin_measure_type == other.margin_measure_type &&
541
+ text == other.text &&
542
+ sign_all_pages == other.sign_all_pages &&
543
+ font == other.font &&
544
+ fore_color == other.fore_color &&
545
+ border_color == other.border_color &&
546
+ background_color == other.background_color &&
547
+ background_brush == other.background_brush &&
548
+ opacity == other.opacity &&
549
+ signature_id == other.signature_id &&
550
+ signature_implementation == other.signature_implementation &&
551
+ form_text_field_title == other.form_text_field_title &&
552
+ form_text_field_type == other.form_text_field_type &&
553
+ text_horizontal_alignment == other.text_horizontal_alignment &&
554
+ text_vertical_alignment == other.text_vertical_alignment
555
+ end
556
+
557
+ # @see the `==` method
558
+ # @param [Object] Object to be compared
559
+ def eql?(other)
560
+ self == other
561
+ end
562
+
563
+ # Calculates hash code according to all attributes.
564
+ # @return [Fixnum] Hash code
565
+ def hash
566
+ [document_page_number, pages_setup, options_type, left, top, width, height, location_measure_type, size_measure_type, stretch, rotation_angle, horizontal_alignment, vertical_alignment, margin, margin_measure_type, text, sign_all_pages, font, fore_color, border_color, background_color, background_brush, opacity, signature_id, signature_implementation, form_text_field_title, form_text_field_type, text_horizontal_alignment, text_vertical_alignment].hash
567
+ end
568
+
569
+ # Builds the object from hash
570
+ # @param [Hash] attributes Model attributes in the form of hash
571
+ # @return [Object] Returns the model itself
572
+ def build_from_hash(attributes)
573
+ return nil unless attributes.is_a?(Hash)
574
+ self.class.swagger_types.each_pair do |key, type|
575
+
576
+ attributeName = self.class.attribute_map[key]
577
+ attributeNameLowerStr = attributeName.to_s
578
+ attributeNameLowerStr[0] = attributeNameLowerStr[0].downcase
579
+ attributeNameLower = attributeNameLowerStr.to_sym
580
+ attributeNameLowerStr2 = attributeName.to_s
581
+ attributeNameLowerStr2[0] = attributeNameLowerStr[0].downcase
582
+ attributeNameLowerStr2[1] = attributeNameLowerStr[1].downcase
583
+ attributeNameLower2 = attributeNameLowerStr2.to_sym
584
+
585
+ if type =~ /\AArray<(.*)>/i
586
+ # check to ensure the input is an array given that the the attribute
587
+ # is documented as an array but the input is not
588
+ if attributes[attributeName].is_a?(Array)
589
+ self.send("#{key}=", attributes[attributeName].map { |v| _deserialize($1, v) })
590
+ end
591
+ if attributes[attributeNameLower].is_a?(Array)
592
+ self.send("#{key}=", attributes[attributeNameLower].map { |v| _deserialize($1, v) })
593
+ end
594
+ if attributes[attributeNameLower2].is_a?(Array)
595
+ self.send("#{key}=", attributes[attributeNameLower2].map { |v| _deserialize($1, v) })
596
+ end
597
+ elsif !attributes[attributeName].nil?
598
+ self.send("#{key}=", _deserialize(type, attributes[attributeName]))
599
+ elsif !attributes[attributeNameLower].nil?
600
+ self.send("#{key}=", _deserialize(type, attributes[attributeNameLower]))
601
+ elsif !attributes[attributeNameLower2].nil?
602
+ self.send("#{key}=", _deserialize(type, attributes[attributeNameLower2]))
603
+ end
604
+ # or else data not found in attributes(hash), not an issue as the data can be optional
605
+ end
606
+ self
607
+ end
608
+
609
+ # Deserializes the data based on type
610
+ # @param string type Data type
611
+ # @param string value Value to be deserialized
612
+ # @return [Object] Deserialized data
613
+ def _deserialize(type, value)
614
+ case type.to_sym
615
+ when :DateTime
616
+ Time.at(/\d/.match(value)[0].to_f).to_datetime
617
+ when :Date
618
+ Time.at(/\d/.match(value)[0].to_f).to_date
619
+ when :String
620
+ value.to_s
621
+ when :Integer
622
+ value.to_i
623
+ when :Float
624
+ value.to_f
625
+ when :BOOLEAN
626
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
627
+ true
628
+ else
629
+ false
630
+ end
631
+ when :Object
632
+ # generic object (usually a Hash), return directly
633
+ value
634
+ when /\AArray<(?<inner_type>.+)>\z/
635
+ inner_type = Regexp.last_match[:inner_type]
636
+ value.map { |v| _deserialize(inner_type, v) }
637
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
638
+ k_type = Regexp.last_match[:k_type]
639
+ v_type = Regexp.last_match[:v_type]
640
+ {}.tap do |hash|
641
+ value.each do |k, v|
642
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
643
+ end
644
+ end
645
+ else
646
+ # model
647
+ temp_model = GroupDocsSignatureCloud.const_get(type).new
648
+ temp_model.build_from_hash(value)
649
+ end
650
+ end
651
+
652
+ # Returns the string representation of the object
653
+ # @return [String] String presentation of the object
654
+ def to_s
655
+ to_hash.to_s
656
+ end
657
+
658
+ # to_body is an alias to to_hash (backward compatibility)
659
+ # @return [Hash] Returns the object in the form of hash
660
+ def to_body
661
+ to_hash
662
+ end
663
+
664
+ # Returns the object in the form of hash
665
+ # @return [Hash] Returns the object in the form of hash
666
+ def to_hash
667
+ hash = {}
668
+ self.class.attribute_map.each_pair do |attr, param|
669
+ value = self.send(attr)
670
+ next if value.nil?
671
+ hash[param] = _to_hash(value)
672
+ end
673
+ hash
674
+ end
675
+
676
+ # Outputs non-array value in the form of hash
677
+ # For object, use to_hash. Otherwise, just return the value
678
+ # @param [Object] value Any valid value
679
+ # @return [Hash] Returns the value in the form of hash
680
+ def _to_hash(value)
681
+ if value.is_a?(Array)
682
+ value.compact.map { |v| _to_hash(v) }
683
+ elsif value.is_a?(Hash)
684
+ {}.tap do |hash|
685
+ value.each { |k, v| hash[k] = _to_hash(v) }
686
+ end
687
+ elsif value.respond_to? :to_hash
688
+ value.to_hash
689
+ else
690
+ value
691
+ end
692
+ end
693
+
694
+ end
695
+
696
+ end