groupdocs_signature_cloud 18.8.1

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.
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,674 @@
1
+ #
2
+ # --------------------------------------------------------------------------------------------------------------------
3
+ # <copyright company="Aspose Pty Ltd" file="sign_qr_code_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 QRCode Signature Options.
32
+ class SignQRCodeOptionsData
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 Barcode bars Using of this property could cause problems with verification. Use it carefully with maximum contrast with background.
89
+ attr_accessor :fore_color
90
+
91
+ # Gets or sets the border color of signature. Using of this property could cause problems with verification. Use it carefully with maximum contrast with background.
92
+ attr_accessor :border_color
93
+
94
+ # Gets or sets the background color of signature. Using of this property could cause problems with verification. Use it carefully with maximum contrast with background.
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. BackgroundBrush has limited scope of application for Qr-codes. SolidBrush, LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used instead BackgroundColor. TextureBrush is not used.
98
+ attr_accessor :background_brush
99
+
100
+ # Get or set QRCode type. Pick one from supported QRCode Types list.
101
+ attr_accessor :qr_code_type_name
102
+
103
+ # Gets or sets the signature border visibility.
104
+ attr_accessor :border_visiblity
105
+
106
+ # Gets or sets the signature border style.
107
+ attr_accessor :border_dash_style
108
+
109
+ # Gets or sets the weight of the signature border.
110
+ attr_accessor :border_weight
111
+
112
+ # Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.
113
+ attr_accessor :opacity
114
+
115
+ # Gets or sets the alignment of text in the result QRCode. Default value is None.
116
+ attr_accessor :code_text_alignment
117
+
118
+ # Gets or sets the space between QRCode elements and result image borders.
119
+ attr_accessor :inner_margins
120
+
121
+ # Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully.
122
+ attr_accessor :logo_guid
123
+ class EnumAttributeValidator
124
+ attr_reader :datatype
125
+ attr_reader :allowable_values
126
+
127
+ def initialize(datatype, allowable_values)
128
+ @allowable_values = allowable_values.map do |value|
129
+ case datatype.to_s
130
+ when /Integer/i
131
+ value.to_i
132
+ when /Float/i
133
+ value.to_f
134
+ else
135
+ value
136
+ end
137
+ end
138
+ end
139
+
140
+ def valid?(value)
141
+ !value || allowable_values.include?(value)
142
+ end
143
+ end
144
+
145
+ # Attribute mapping from ruby-style variable name to JSON key.
146
+ def self.attribute_map
147
+ {
148
+ :'document_page_number' => :'DocumentPageNumber',
149
+ :'pages_setup' => :'PagesSetup',
150
+ :'options_type' => :'OptionsType',
151
+ :'left' => :'Left',
152
+ :'top' => :'Top',
153
+ :'width' => :'Width',
154
+ :'height' => :'Height',
155
+ :'location_measure_type' => :'LocationMeasureType',
156
+ :'size_measure_type' => :'SizeMeasureType',
157
+ :'stretch' => :'Stretch',
158
+ :'rotation_angle' => :'RotationAngle',
159
+ :'horizontal_alignment' => :'HorizontalAlignment',
160
+ :'vertical_alignment' => :'VerticalAlignment',
161
+ :'margin' => :'Margin',
162
+ :'margin_measure_type' => :'MarginMeasureType',
163
+ :'text' => :'Text',
164
+ :'sign_all_pages' => :'SignAllPages',
165
+ :'font' => :'Font',
166
+ :'fore_color' => :'ForeColor',
167
+ :'border_color' => :'BorderColor',
168
+ :'background_color' => :'BackgroundColor',
169
+ :'background_brush' => :'BackgroundBrush',
170
+ :'qr_code_type_name' => :'QRCodeTypeName',
171
+ :'border_visiblity' => :'BorderVisiblity',
172
+ :'border_dash_style' => :'BorderDashStyle',
173
+ :'border_weight' => :'BorderWeight',
174
+ :'opacity' => :'Opacity',
175
+ :'code_text_alignment' => :'CodeTextAlignment',
176
+ :'inner_margins' => :'InnerMargins',
177
+ :'logo_guid' => :'LogoGuid'
178
+ }
179
+ end
180
+
181
+ # Attribute type mapping.
182
+ def self.swagger_types
183
+ {
184
+ :'document_page_number' => :'Integer',
185
+ :'pages_setup' => :'PagesSetupData',
186
+ :'options_type' => :'String',
187
+ :'left' => :'Integer',
188
+ :'top' => :'Integer',
189
+ :'width' => :'Integer',
190
+ :'height' => :'Integer',
191
+ :'location_measure_type' => :'String',
192
+ :'size_measure_type' => :'String',
193
+ :'stretch' => :'String',
194
+ :'rotation_angle' => :'Integer',
195
+ :'horizontal_alignment' => :'String',
196
+ :'vertical_alignment' => :'String',
197
+ :'margin' => :'PaddingData',
198
+ :'margin_measure_type' => :'String',
199
+ :'text' => :'String',
200
+ :'sign_all_pages' => :'BOOLEAN',
201
+ :'font' => :'SignatureFontData',
202
+ :'fore_color' => :'Color',
203
+ :'border_color' => :'Color',
204
+ :'background_color' => :'Color',
205
+ :'background_brush' => :'BrushData',
206
+ :'qr_code_type_name' => :'String',
207
+ :'border_visiblity' => :'BOOLEAN',
208
+ :'border_dash_style' => :'String',
209
+ :'border_weight' => :'Float',
210
+ :'opacity' => :'Float',
211
+ :'code_text_alignment' => :'String',
212
+ :'inner_margins' => :'PaddingData',
213
+ :'logo_guid' => :'String'
214
+ }
215
+ end
216
+
217
+ # Initializes the object
218
+ # @param [Hash] attributes Model attributes in the form of hash
219
+ def initialize(attributes = {})
220
+ return unless attributes.is_a?(Hash)
221
+
222
+ # convert string to symbol for hash key
223
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
224
+
225
+ if attributes.key?(:'DocumentPageNumber')
226
+ self.document_page_number = attributes[:'DocumentPageNumber']
227
+ end
228
+
229
+ if attributes.key?(:'PagesSetup')
230
+ self.pages_setup = attributes[:'PagesSetup']
231
+ end
232
+
233
+ if attributes.key?(:'OptionsType')
234
+ self.options_type = attributes[:'OptionsType']
235
+ end
236
+
237
+ if attributes.key?(:'Left')
238
+ self.left = attributes[:'Left']
239
+ end
240
+
241
+ if attributes.key?(:'Top')
242
+ self.top = attributes[:'Top']
243
+ end
244
+
245
+ if attributes.key?(:'Width')
246
+ self.width = attributes[:'Width']
247
+ end
248
+
249
+ if attributes.key?(:'Height')
250
+ self.height = attributes[:'Height']
251
+ end
252
+
253
+ if attributes.key?(:'LocationMeasureType')
254
+ self.location_measure_type = attributes[:'LocationMeasureType']
255
+ end
256
+
257
+ if attributes.key?(:'SizeMeasureType')
258
+ self.size_measure_type = attributes[:'SizeMeasureType']
259
+ end
260
+
261
+ if attributes.key?(:'Stretch')
262
+ self.stretch = attributes[:'Stretch']
263
+ end
264
+
265
+ if attributes.key?(:'RotationAngle')
266
+ self.rotation_angle = attributes[:'RotationAngle']
267
+ end
268
+
269
+ if attributes.key?(:'HorizontalAlignment')
270
+ self.horizontal_alignment = attributes[:'HorizontalAlignment']
271
+ end
272
+
273
+ if attributes.key?(:'VerticalAlignment')
274
+ self.vertical_alignment = attributes[:'VerticalAlignment']
275
+ end
276
+
277
+ if attributes.key?(:'Margin')
278
+ self.margin = attributes[:'Margin']
279
+ end
280
+
281
+ if attributes.key?(:'MarginMeasureType')
282
+ self.margin_measure_type = attributes[:'MarginMeasureType']
283
+ end
284
+
285
+ if attributes.key?(:'Text')
286
+ self.text = attributes[:'Text']
287
+ end
288
+
289
+ if attributes.key?(:'SignAllPages')
290
+ self.sign_all_pages = attributes[:'SignAllPages']
291
+ end
292
+
293
+ if attributes.key?(:'Font')
294
+ self.font = attributes[:'Font']
295
+ end
296
+
297
+ if attributes.key?(:'ForeColor')
298
+ self.fore_color = attributes[:'ForeColor']
299
+ end
300
+
301
+ if attributes.key?(:'BorderColor')
302
+ self.border_color = attributes[:'BorderColor']
303
+ end
304
+
305
+ if attributes.key?(:'BackgroundColor')
306
+ self.background_color = attributes[:'BackgroundColor']
307
+ end
308
+
309
+ if attributes.key?(:'BackgroundBrush')
310
+ self.background_brush = attributes[:'BackgroundBrush']
311
+ end
312
+
313
+ if attributes.key?(:'QRCodeTypeName')
314
+ self.qr_code_type_name = attributes[:'QRCodeTypeName']
315
+ end
316
+
317
+ if attributes.key?(:'BorderVisiblity')
318
+ self.border_visiblity = attributes[:'BorderVisiblity']
319
+ end
320
+
321
+ if attributes.key?(:'BorderDashStyle')
322
+ self.border_dash_style = attributes[:'BorderDashStyle']
323
+ end
324
+
325
+ if attributes.key?(:'BorderWeight')
326
+ self.border_weight = attributes[:'BorderWeight']
327
+ end
328
+
329
+ if attributes.key?(:'Opacity')
330
+ self.opacity = attributes[:'Opacity']
331
+ end
332
+
333
+ if attributes.key?(:'CodeTextAlignment')
334
+ self.code_text_alignment = attributes[:'CodeTextAlignment']
335
+ end
336
+
337
+ if attributes.key?(:'InnerMargins')
338
+ self.inner_margins = attributes[:'InnerMargins']
339
+ end
340
+
341
+ if attributes.key?(:'LogoGuid')
342
+ self.logo_guid = attributes[:'LogoGuid']
343
+ end
344
+
345
+
346
+ if !((defined? options_type) == nil)
347
+ self.options_type = "SignQRCodeOptionsData"
348
+ end
349
+
350
+ end
351
+
352
+ # Show invalid properties with the reasons. Usually used together with valid?
353
+ # @return Array for valid properies with the reasons
354
+ def list_invalid_properties
355
+ invalid_properties = []
356
+ if @document_page_number.nil?
357
+ invalid_properties.push("invalid value for 'document_page_number', document_page_number cannot be nil.")
358
+ end
359
+
360
+ return invalid_properties
361
+ end
362
+
363
+ # Check to see if the all the properties in the model are valid
364
+ # @return true if the model is valid
365
+ def valid?
366
+ return false if @document_page_number.nil?
367
+ location_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
368
+ return false unless location_measure_type_validator.valid?(@location_measure_type)
369
+ size_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
370
+ return false unless size_measure_type_validator.valid?(@size_measure_type)
371
+ stretch_validator = EnumAttributeValidator.new('String', ["None", "PageWidth", "PageHeight", "PageArea"])
372
+ return false unless stretch_validator.valid?(@stretch)
373
+ horizontal_alignment_validator = EnumAttributeValidator.new('String', ["Default", "None", "Left", "Center", "Right"])
374
+ return false unless horizontal_alignment_validator.valid?(@horizontal_alignment)
375
+ vertical_alignment_validator = EnumAttributeValidator.new('String', ["Default", "None", "Top", "Center", "Bottom"])
376
+ return false unless vertical_alignment_validator.valid?(@vertical_alignment)
377
+ margin_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
378
+ return false unless margin_measure_type_validator.valid?(@margin_measure_type)
379
+ border_dash_style_validator = EnumAttributeValidator.new('String', ["Dash", "DashDot", "DashDotDot", "DashLongDash", "DashLongDashDot", "RoundDot", "Solid", "SquareDot"])
380
+ return false unless border_dash_style_validator.valid?(@border_dash_style)
381
+ code_text_alignment_validator = EnumAttributeValidator.new('String', ["None", "Above", "Below", "Right"])
382
+ return false unless code_text_alignment_validator.valid?(@code_text_alignment)
383
+ return true
384
+ end
385
+
386
+ # Custom attribute writer method checking allowed values (enum).
387
+ # @param [Object] location_measure_type Object to be assigned
388
+ def location_measure_type=(location_measure_type)
389
+ validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
390
+ if location_measure_type.to_i == 0
391
+ unless validator.valid?(location_measure_type)
392
+ raise ArgumentError, "invalid value for 'location_measure_type', must be one of #{validator.allowable_values}."
393
+ end
394
+ @location_measure_type = location_measure_type
395
+ else
396
+ @location_measure_type = validator.allowable_values[location_measure_type.to_i]
397
+ end
398
+ end
399
+
400
+ # Custom attribute writer method checking allowed values (enum).
401
+ # @param [Object] size_measure_type Object to be assigned
402
+ def size_measure_type=(size_measure_type)
403
+ validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
404
+ if size_measure_type.to_i == 0
405
+ unless validator.valid?(size_measure_type)
406
+ raise ArgumentError, "invalid value for 'size_measure_type', must be one of #{validator.allowable_values}."
407
+ end
408
+ @size_measure_type = size_measure_type
409
+ else
410
+ @size_measure_type = validator.allowable_values[size_measure_type.to_i]
411
+ end
412
+ end
413
+
414
+ # Custom attribute writer method checking allowed values (enum).
415
+ # @param [Object] stretch Object to be assigned
416
+ def stretch=(stretch)
417
+ validator = EnumAttributeValidator.new('String', ["None", "PageWidth", "PageHeight", "PageArea"])
418
+ if stretch.to_i == 0
419
+ unless validator.valid?(stretch)
420
+ raise ArgumentError, "invalid value for 'stretch', must be one of #{validator.allowable_values}."
421
+ end
422
+ @stretch = stretch
423
+ else
424
+ @stretch = validator.allowable_values[stretch.to_i]
425
+ end
426
+ end
427
+
428
+ # Custom attribute writer method checking allowed values (enum).
429
+ # @param [Object] horizontal_alignment Object to be assigned
430
+ def horizontal_alignment=(horizontal_alignment)
431
+ validator = EnumAttributeValidator.new('String', ["Default", "None", "Left", "Center", "Right"])
432
+ if horizontal_alignment.to_i == 0
433
+ unless validator.valid?(horizontal_alignment)
434
+ raise ArgumentError, "invalid value for 'horizontal_alignment', must be one of #{validator.allowable_values}."
435
+ end
436
+ @horizontal_alignment = horizontal_alignment
437
+ else
438
+ @horizontal_alignment = validator.allowable_values[horizontal_alignment.to_i]
439
+ end
440
+ end
441
+
442
+ # Custom attribute writer method checking allowed values (enum).
443
+ # @param [Object] vertical_alignment Object to be assigned
444
+ def vertical_alignment=(vertical_alignment)
445
+ validator = EnumAttributeValidator.new('String', ["Default", "None", "Top", "Center", "Bottom"])
446
+ if vertical_alignment.to_i == 0
447
+ unless validator.valid?(vertical_alignment)
448
+ raise ArgumentError, "invalid value for 'vertical_alignment', must be one of #{validator.allowable_values}."
449
+ end
450
+ @vertical_alignment = vertical_alignment
451
+ else
452
+ @vertical_alignment = validator.allowable_values[vertical_alignment.to_i]
453
+ end
454
+ end
455
+
456
+ # Custom attribute writer method checking allowed values (enum).
457
+ # @param [Object] margin_measure_type Object to be assigned
458
+ def margin_measure_type=(margin_measure_type)
459
+ validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
460
+ if margin_measure_type.to_i == 0
461
+ unless validator.valid?(margin_measure_type)
462
+ raise ArgumentError, "invalid value for 'margin_measure_type', must be one of #{validator.allowable_values}."
463
+ end
464
+ @margin_measure_type = margin_measure_type
465
+ else
466
+ @margin_measure_type = validator.allowable_values[margin_measure_type.to_i]
467
+ end
468
+ end
469
+
470
+ # Custom attribute writer method checking allowed values (enum).
471
+ # @param [Object] border_dash_style Object to be assigned
472
+ def border_dash_style=(border_dash_style)
473
+ validator = EnumAttributeValidator.new('String', ["Dash", "DashDot", "DashDotDot", "DashLongDash", "DashLongDashDot", "RoundDot", "Solid", "SquareDot"])
474
+ if border_dash_style.to_i == 0
475
+ unless validator.valid?(border_dash_style)
476
+ raise ArgumentError, "invalid value for 'border_dash_style', must be one of #{validator.allowable_values}."
477
+ end
478
+ @border_dash_style = border_dash_style
479
+ else
480
+ @border_dash_style = validator.allowable_values[border_dash_style.to_i]
481
+ end
482
+ end
483
+
484
+ # Custom attribute writer method checking allowed values (enum).
485
+ # @param [Object] code_text_alignment Object to be assigned
486
+ def code_text_alignment=(code_text_alignment)
487
+ validator = EnumAttributeValidator.new('String', ["None", "Above", "Below", "Right"])
488
+ if code_text_alignment.to_i == 0
489
+ unless validator.valid?(code_text_alignment)
490
+ raise ArgumentError, "invalid value for 'code_text_alignment', must be one of #{validator.allowable_values}."
491
+ end
492
+ @code_text_alignment = code_text_alignment
493
+ else
494
+ @code_text_alignment = validator.allowable_values[code_text_alignment.to_i]
495
+ end
496
+ end
497
+
498
+ # Checks equality by comparing each attribute.
499
+ # @param [Object] Object to be compared
500
+ def ==(other)
501
+ return true if self.equal?(other)
502
+ self.class == other.class &&
503
+ document_page_number == other.document_page_number &&
504
+ pages_setup == other.pages_setup &&
505
+ options_type == other.options_type &&
506
+ left == other.left &&
507
+ top == other.top &&
508
+ width == other.width &&
509
+ height == other.height &&
510
+ location_measure_type == other.location_measure_type &&
511
+ size_measure_type == other.size_measure_type &&
512
+ stretch == other.stretch &&
513
+ rotation_angle == other.rotation_angle &&
514
+ horizontal_alignment == other.horizontal_alignment &&
515
+ vertical_alignment == other.vertical_alignment &&
516
+ margin == other.margin &&
517
+ margin_measure_type == other.margin_measure_type &&
518
+ text == other.text &&
519
+ sign_all_pages == other.sign_all_pages &&
520
+ font == other.font &&
521
+ fore_color == other.fore_color &&
522
+ border_color == other.border_color &&
523
+ background_color == other.background_color &&
524
+ background_brush == other.background_brush &&
525
+ qr_code_type_name == other.qr_code_type_name &&
526
+ border_visiblity == other.border_visiblity &&
527
+ border_dash_style == other.border_dash_style &&
528
+ border_weight == other.border_weight &&
529
+ opacity == other.opacity &&
530
+ code_text_alignment == other.code_text_alignment &&
531
+ inner_margins == other.inner_margins &&
532
+ logo_guid == other.logo_guid
533
+ end
534
+
535
+ # @see the `==` method
536
+ # @param [Object] Object to be compared
537
+ def eql?(other)
538
+ self == other
539
+ end
540
+
541
+ # Calculates hash code according to all attributes.
542
+ # @return [Fixnum] Hash code
543
+ def hash
544
+ [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, qr_code_type_name, border_visiblity, border_dash_style, border_weight, opacity, code_text_alignment, inner_margins, logo_guid].hash
545
+ end
546
+
547
+ # Builds the object from hash
548
+ # @param [Hash] attributes Model attributes in the form of hash
549
+ # @return [Object] Returns the model itself
550
+ def build_from_hash(attributes)
551
+ return nil unless attributes.is_a?(Hash)
552
+ self.class.swagger_types.each_pair do |key, type|
553
+
554
+ attributeName = self.class.attribute_map[key]
555
+ attributeNameLowerStr = attributeName.to_s
556
+ attributeNameLowerStr[0] = attributeNameLowerStr[0].downcase
557
+ attributeNameLower = attributeNameLowerStr.to_sym
558
+ attributeNameLowerStr2 = attributeName.to_s
559
+ attributeNameLowerStr2[0] = attributeNameLowerStr[0].downcase
560
+ attributeNameLowerStr2[1] = attributeNameLowerStr[1].downcase
561
+ attributeNameLower2 = attributeNameLowerStr2.to_sym
562
+
563
+ if type =~ /\AArray<(.*)>/i
564
+ # check to ensure the input is an array given that the the attribute
565
+ # is documented as an array but the input is not
566
+ if attributes[attributeName].is_a?(Array)
567
+ self.send("#{key}=", attributes[attributeName].map { |v| _deserialize($1, v) })
568
+ end
569
+ if attributes[attributeNameLower].is_a?(Array)
570
+ self.send("#{key}=", attributes[attributeNameLower].map { |v| _deserialize($1, v) })
571
+ end
572
+ if attributes[attributeNameLower2].is_a?(Array)
573
+ self.send("#{key}=", attributes[attributeNameLower2].map { |v| _deserialize($1, v) })
574
+ end
575
+ elsif !attributes[attributeName].nil?
576
+ self.send("#{key}=", _deserialize(type, attributes[attributeName]))
577
+ elsif !attributes[attributeNameLower].nil?
578
+ self.send("#{key}=", _deserialize(type, attributes[attributeNameLower]))
579
+ elsif !attributes[attributeNameLower2].nil?
580
+ self.send("#{key}=", _deserialize(type, attributes[attributeNameLower2]))
581
+ end
582
+ # or else data not found in attributes(hash), not an issue as the data can be optional
583
+ end
584
+ self
585
+ end
586
+
587
+ # Deserializes the data based on type
588
+ # @param string type Data type
589
+ # @param string value Value to be deserialized
590
+ # @return [Object] Deserialized data
591
+ def _deserialize(type, value)
592
+ case type.to_sym
593
+ when :DateTime
594
+ Time.at(/\d/.match(value)[0].to_f).to_datetime
595
+ when :Date
596
+ Time.at(/\d/.match(value)[0].to_f).to_date
597
+ when :String
598
+ value.to_s
599
+ when :Integer
600
+ value.to_i
601
+ when :Float
602
+ value.to_f
603
+ when :BOOLEAN
604
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
605
+ true
606
+ else
607
+ false
608
+ end
609
+ when :Object
610
+ # generic object (usually a Hash), return directly
611
+ value
612
+ when /\AArray<(?<inner_type>.+)>\z/
613
+ inner_type = Regexp.last_match[:inner_type]
614
+ value.map { |v| _deserialize(inner_type, v) }
615
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
616
+ k_type = Regexp.last_match[:k_type]
617
+ v_type = Regexp.last_match[:v_type]
618
+ {}.tap do |hash|
619
+ value.each do |k, v|
620
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
621
+ end
622
+ end
623
+ else
624
+ # model
625
+ temp_model = GroupDocsSignatureCloud.const_get(type).new
626
+ temp_model.build_from_hash(value)
627
+ end
628
+ end
629
+
630
+ # Returns the string representation of the object
631
+ # @return [String] String presentation of the object
632
+ def to_s
633
+ to_hash.to_s
634
+ end
635
+
636
+ # to_body is an alias to to_hash (backward compatibility)
637
+ # @return [Hash] Returns the object in the form of hash
638
+ def to_body
639
+ to_hash
640
+ end
641
+
642
+ # Returns the object in the form of hash
643
+ # @return [Hash] Returns the object in the form of hash
644
+ def to_hash
645
+ hash = {}
646
+ self.class.attribute_map.each_pair do |attr, param|
647
+ value = self.send(attr)
648
+ next if value.nil?
649
+ hash[param] = _to_hash(value)
650
+ end
651
+ hash
652
+ end
653
+
654
+ # Outputs non-array value in the form of hash
655
+ # For object, use to_hash. Otherwise, just return the value
656
+ # @param [Object] value Any valid value
657
+ # @return [Hash] Returns the value in the form of hash
658
+ def _to_hash(value)
659
+ if value.is_a?(Array)
660
+ value.compact.map { |v| _to_hash(v) }
661
+ elsif value.is_a?(Hash)
662
+ {}.tap do |hash|
663
+ value.each { |k, v| hash[k] = _to_hash(v) }
664
+ end
665
+ elsif value.respond_to? :to_hash
666
+ value.to_hash
667
+ else
668
+ value
669
+ end
670
+ end
671
+
672
+ end
673
+
674
+ end