groupdocs_signature_cloud 18.8.1 → 19.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (185) hide show
  1. checksums.yaml +5 -5
  2. data/lib/groupdocs_signature_cloud.rb +99 -191
  3. data/lib/groupdocs_signature_cloud/api/file_api.rb +734 -0
  4. data/lib/groupdocs_signature_cloud/api/folder_api.rb +699 -0
  5. data/lib/groupdocs_signature_cloud/api/info_api.rb +364 -0
  6. data/lib/groupdocs_signature_cloud/api/sign_api.rb +411 -0
  7. data/lib/groupdocs_signature_cloud/api/storage_api.rb +544 -0
  8. data/lib/groupdocs_signature_cloud/api_client.rb +382 -380
  9. data/lib/groupdocs_signature_cloud/api_error.rb +58 -58
  10. data/lib/groupdocs_signature_cloud/configuration.rb +95 -110
  11. data/lib/groupdocs_signature_cloud/models/{digital_signature_data.rb → barcode_signature.rb} +312 -307
  12. data/lib/groupdocs_signature_cloud/models/barcode_type.rb +219 -230
  13. data/lib/groupdocs_signature_cloud/models/{barcode_collection.rb → barcodes_result.rb} +221 -232
  14. data/lib/groupdocs_signature_cloud/models/base_settings.rb +219 -0
  15. data/lib/groupdocs_signature_cloud/models/{border_line_data.rb → border_line.rb} +301 -312
  16. data/lib/groupdocs_signature_cloud/models/{brush_data.rb → brush.rb} +219 -230
  17. data/lib/groupdocs_signature_cloud/models/color.rb +219 -245
  18. data/lib/groupdocs_signature_cloud/models/{pdf_digital_signature_data.rb → digital_signature.rb} +363 -307
  19. data/lib/groupdocs_signature_cloud/models/disc_usage.rb +239 -0
  20. data/lib/groupdocs_signature_cloud/models/error.rb +249 -0
  21. data/lib/groupdocs_signature_cloud/models/error_details.rb +234 -0
  22. data/lib/groupdocs_signature_cloud/models/file_info.rb +249 -0
  23. data/lib/groupdocs_signature_cloud/models/{document_info.rb → file_version.rb} +294 -300
  24. data/lib/groupdocs_signature_cloud/models/file_versions.rb +221 -0
  25. data/lib/groupdocs_signature_cloud/models/files_list.rb +221 -0
  26. data/lib/groupdocs_signature_cloud/models/{base_signature_data.rb → files_upload_result.rb} +233 -230
  27. data/lib/groupdocs_signature_cloud/models/format.rb +229 -240
  28. data/lib/groupdocs_signature_cloud/models/{format_collection.rb → formats_result.rb} +221 -232
  29. data/lib/groupdocs_signature_cloud/models/{search_document_response.rb → info_result.rb} +339 -303
  30. data/lib/groupdocs_signature_cloud/models/info_settings.rb +219 -0
  31. data/lib/groupdocs_signature_cloud/models/{linear_gradient_brush_data.rb → linear_gradient_brush.rb} +254 -260
  32. data/lib/groupdocs_signature_cloud/models/object_exist.rb +239 -0
  33. data/lib/groupdocs_signature_cloud/models/options_base.rb +327 -0
  34. data/lib/groupdocs_signature_cloud/models/{padding_data.rb → padding.rb} +284 -295
  35. data/lib/groupdocs_signature_cloud/models/page_info.rb +294 -305
  36. data/lib/groupdocs_signature_cloud/models/{pages_setup_data.rb → pages_setup.rb} +281 -292
  37. data/lib/groupdocs_signature_cloud/models/{words_digital_signature_data.rb → qr_code_signature.rb} +312 -307
  38. data/lib/groupdocs_signature_cloud/models/qr_code_type.rb +219 -230
  39. data/lib/groupdocs_signature_cloud/models/{qr_code_collection.rb → qr_codes_result.rb} +221 -232
  40. data/lib/groupdocs_signature_cloud/models/{radial_gradient_brush_data.rb → radial_gradient_brush.rb} +239 -250
  41. data/lib/groupdocs_signature_cloud/models/save_options.rb +244 -0
  42. data/lib/groupdocs_signature_cloud/models/{search_barcode_options_data.rb → search_barcode_options.rb} +378 -332
  43. data/lib/groupdocs_signature_cloud/models/search_digital_options.rb +327 -0
  44. data/lib/groupdocs_signature_cloud/models/search_options.rb +327 -0
  45. data/lib/groupdocs_signature_cloud/models/{pdf_search_barcode_options_data.rb → search_qr_code_options.rb} +378 -332
  46. data/lib/groupdocs_signature_cloud/models/{sign_options_collection_data.rb → search_result.rb} +246 -232
  47. data/lib/groupdocs_signature_cloud/models/search_settings.rb +231 -0
  48. data/lib/groupdocs_signature_cloud/models/{images_sign_text_options_data.rb → sign_barcode_options.rb} +857 -706
  49. data/lib/groupdocs_signature_cloud/models/{sign_digital_options_data.rb → sign_digital_options.rb} +612 -516
  50. data/lib/groupdocs_signature_cloud/models/{sign_stamp_options_data.rb → sign_image_options.rb} +592 -592
  51. data/lib/groupdocs_signature_cloud/models/sign_options.rb +327 -0
  52. data/lib/groupdocs_signature_cloud/models/{words_sign_text_options_data.rb → sign_qr_code_options.rb} +872 -696
  53. data/lib/groupdocs_signature_cloud/models/sign_result.rb +244 -0
  54. data/lib/groupdocs_signature_cloud/models/sign_settings.rb +241 -0
  55. data/lib/groupdocs_signature_cloud/models/{slides_sign_stamp_options_data.rb → sign_stamp_options.rb} +698 -592
  56. data/lib/groupdocs_signature_cloud/models/{cells_sign_text_options_data.rb → sign_text_options.rb} +781 -736
  57. data/lib/groupdocs_signature_cloud/models/{signature_document_response.rb → signature.rb} +292 -290
  58. data/lib/groupdocs_signature_cloud/models/{signature_font_data.rb → signature_font.rb} +279 -290
  59. data/lib/groupdocs_signature_cloud/models/{solid_brush_data.rb → solid_brush.rb} +229 -240
  60. data/lib/groupdocs_signature_cloud/models/{stamp_line_data.rb → stamp_line.rb} +366 -377
  61. data/lib/groupdocs_signature_cloud/models/storage_exist.rb +224 -0
  62. data/lib/groupdocs_signature_cloud/models/{pdf_qr_code_signature_data.rb → storage_file.rb} +269 -250
  63. data/lib/groupdocs_signature_cloud/models/{texture_brush_data.rb → texture_brush.rb} +229 -240
  64. data/lib/groupdocs_signature_cloud/models/{verify_barcode_options_data.rb → verify_barcode_options.rb} +378 -342
  65. data/lib/groupdocs_signature_cloud/models/{cells_verify_digital_options_data.rb → verify_digital_options.rb} +407 -315
  66. data/lib/groupdocs_signature_cloud/models/{cells_digital_signature_data.rb → verify_options.rb} +327 -307
  67. data/lib/groupdocs_signature_cloud/models/{verify_qr_code_options_data.rb → verify_qr_code_options.rb} +378 -342
  68. data/lib/groupdocs_signature_cloud/models/verify_result.rb +249 -0
  69. data/lib/groupdocs_signature_cloud/models/verify_settings.rb +231 -0
  70. data/lib/groupdocs_signature_cloud/models/{cells_verify_barcode_options_data.rb → verify_text_options.rb} +368 -342
  71. data/lib/groupdocs_signature_cloud/version.rb +2 -2
  72. metadata +63 -171
  73. data/lib/groupdocs_signature_cloud/api/signature_api.rb +0 -2590
  74. data/lib/groupdocs_signature_cloud/models/barcode_signature_data.rb +0 -250
  75. data/lib/groupdocs_signature_cloud/models/cells_barcode_signature_data.rb +0 -250
  76. data/lib/groupdocs_signature_cloud/models/cells_qr_code_signature_data.rb +0 -250
  77. data/lib/groupdocs_signature_cloud/models/cells_search_barcode_options_data.rb +0 -332
  78. data/lib/groupdocs_signature_cloud/models/cells_search_digital_options_data.rb +0 -265
  79. data/lib/groupdocs_signature_cloud/models/cells_search_qr_code_options_data.rb +0 -332
  80. data/lib/groupdocs_signature_cloud/models/cells_sign_barcode_options_data.rb +0 -694
  81. data/lib/groupdocs_signature_cloud/models/cells_sign_digital_options_data.rb +0 -546
  82. data/lib/groupdocs_signature_cloud/models/cells_sign_image_options_data.rb +0 -526
  83. data/lib/groupdocs_signature_cloud/models/cells_sign_qr_code_options_data.rb +0 -704
  84. data/lib/groupdocs_signature_cloud/models/cells_sign_stamp_options_data.rb +0 -622
  85. data/lib/groupdocs_signature_cloud/models/cells_verify_qr_code_options_data.rb +0 -342
  86. data/lib/groupdocs_signature_cloud/models/cells_verify_text_options_data.rb +0 -285
  87. data/lib/groupdocs_signature_cloud/models/document_response.rb +0 -302
  88. data/lib/groupdocs_signature_cloud/models/images_barcode_signature_data.rb +0 -250
  89. data/lib/groupdocs_signature_cloud/models/images_qr_code_signature_data.rb +0 -250
  90. data/lib/groupdocs_signature_cloud/models/images_search_barcode_options_data.rb +0 -332
  91. data/lib/groupdocs_signature_cloud/models/images_search_qr_code_options_data.rb +0 -332
  92. data/lib/groupdocs_signature_cloud/models/images_sign_barcode_options_data.rb +0 -664
  93. data/lib/groupdocs_signature_cloud/models/images_sign_image_options_data.rb +0 -496
  94. data/lib/groupdocs_signature_cloud/models/images_sign_qr_code_options_data.rb +0 -674
  95. data/lib/groupdocs_signature_cloud/models/images_sign_stamp_options_data.rb +0 -592
  96. data/lib/groupdocs_signature_cloud/models/images_verify_barcode_options_data.rb +0 -342
  97. data/lib/groupdocs_signature_cloud/models/images_verify_qr_code_options_data.rb +0 -342
  98. data/lib/groupdocs_signature_cloud/models/pages_info.rb +0 -247
  99. data/lib/groupdocs_signature_cloud/models/pdf_barcode_signature_data.rb +0 -250
  100. data/lib/groupdocs_signature_cloud/models/pdf_search_digital_options_data.rb +0 -265
  101. data/lib/groupdocs_signature_cloud/models/pdf_search_qr_code_options_data.rb +0 -332
  102. data/lib/groupdocs_signature_cloud/models/pdf_sign_barcode_options_data.rb +0 -664
  103. data/lib/groupdocs_signature_cloud/models/pdf_sign_digital_options_data.rb +0 -556
  104. data/lib/groupdocs_signature_cloud/models/pdf_sign_image_options_data.rb +0 -496
  105. data/lib/groupdocs_signature_cloud/models/pdf_sign_qr_code_options_data.rb +0 -674
  106. data/lib/groupdocs_signature_cloud/models/pdf_sign_stamp_options_data.rb +0 -592
  107. data/lib/groupdocs_signature_cloud/models/pdf_sign_text_options_data.rb +0 -696
  108. data/lib/groupdocs_signature_cloud/models/pdf_verify_barcode_options_data.rb +0 -342
  109. data/lib/groupdocs_signature_cloud/models/pdf_verify_digital_options_data.rb +0 -315
  110. data/lib/groupdocs_signature_cloud/models/pdf_verify_qr_code_options_data.rb +0 -342
  111. data/lib/groupdocs_signature_cloud/models/pdf_verify_text_options_data.rb +0 -342
  112. data/lib/groupdocs_signature_cloud/models/qr_code_signature_data.rb +0 -250
  113. data/lib/groupdocs_signature_cloud/models/requests/get_document_info_from_url_request.rb +0 -55
  114. data/lib/groupdocs_signature_cloud/models/requests/get_document_info_request.rb +0 -59
  115. data/lib/groupdocs_signature_cloud/models/requests/post_barcode_from_url_request.rb +0 -59
  116. data/lib/groupdocs_signature_cloud/models/requests/post_barcode_request.rb +0 -63
  117. data/lib/groupdocs_signature_cloud/models/requests/post_collection_from_url_request.rb +0 -59
  118. data/lib/groupdocs_signature_cloud/models/requests/post_collection_request.rb +0 -63
  119. data/lib/groupdocs_signature_cloud/models/requests/post_digital_from_url_request.rb +0 -67
  120. data/lib/groupdocs_signature_cloud/models/requests/post_digital_request.rb +0 -71
  121. data/lib/groupdocs_signature_cloud/models/requests/post_image_from_url_request.rb +0 -63
  122. data/lib/groupdocs_signature_cloud/models/requests/post_image_request.rb +0 -67
  123. data/lib/groupdocs_signature_cloud/models/requests/post_qr_code_from_url_request.rb +0 -59
  124. data/lib/groupdocs_signature_cloud/models/requests/post_qr_code_request.rb +0 -63
  125. data/lib/groupdocs_signature_cloud/models/requests/post_search_barcode_from_url_request.rb +0 -59
  126. data/lib/groupdocs_signature_cloud/models/requests/post_search_barcode_request.rb +0 -63
  127. data/lib/groupdocs_signature_cloud/models/requests/post_search_collection_from_url_request.rb +0 -59
  128. data/lib/groupdocs_signature_cloud/models/requests/post_search_collection_request.rb +0 -63
  129. data/lib/groupdocs_signature_cloud/models/requests/post_search_digital_from_url_request.rb +0 -59
  130. data/lib/groupdocs_signature_cloud/models/requests/post_search_digital_request.rb +0 -63
  131. data/lib/groupdocs_signature_cloud/models/requests/post_search_qr_code_from_url_request.rb +0 -59
  132. data/lib/groupdocs_signature_cloud/models/requests/post_search_qr_code_request.rb +0 -63
  133. data/lib/groupdocs_signature_cloud/models/requests/post_stamp_from_url_request.rb +0 -59
  134. data/lib/groupdocs_signature_cloud/models/requests/post_stamp_request.rb +0 -63
  135. data/lib/groupdocs_signature_cloud/models/requests/post_text_from_url_request.rb +0 -59
  136. data/lib/groupdocs_signature_cloud/models/requests/post_text_request.rb +0 -63
  137. data/lib/groupdocs_signature_cloud/models/requests/post_verification_barcode_from_url_request.rb +0 -59
  138. data/lib/groupdocs_signature_cloud/models/requests/post_verification_barcode_request.rb +0 -63
  139. data/lib/groupdocs_signature_cloud/models/requests/post_verification_collection_from_url_request.rb +0 -59
  140. data/lib/groupdocs_signature_cloud/models/requests/post_verification_collection_request.rb +0 -63
  141. data/lib/groupdocs_signature_cloud/models/requests/post_verification_digital_from_url_request.rb +0 -63
  142. data/lib/groupdocs_signature_cloud/models/requests/post_verification_digital_request.rb +0 -67
  143. data/lib/groupdocs_signature_cloud/models/requests/post_verification_qr_code_from_url_request.rb +0 -59
  144. data/lib/groupdocs_signature_cloud/models/requests/post_verification_qr_code_request.rb +0 -63
  145. data/lib/groupdocs_signature_cloud/models/requests/post_verification_text_from_url_request.rb +0 -57
  146. data/lib/groupdocs_signature_cloud/models/requests/post_verification_text_request.rb +0 -63
  147. data/lib/groupdocs_signature_cloud/models/search_digital_options_data.rb +0 -265
  148. data/lib/groupdocs_signature_cloud/models/search_options_collection_data.rb +0 -232
  149. data/lib/groupdocs_signature_cloud/models/search_options_data.rb +0 -265
  150. data/lib/groupdocs_signature_cloud/models/search_qr_code_options_data.rb +0 -332
  151. data/lib/groupdocs_signature_cloud/models/sign_barcode_options_data.rb +0 -664
  152. data/lib/groupdocs_signature_cloud/models/sign_image_options_data.rb +0 -496
  153. data/lib/groupdocs_signature_cloud/models/sign_options_data.rb +0 -255
  154. data/lib/groupdocs_signature_cloud/models/sign_qr_code_options_data.rb +0 -674
  155. data/lib/groupdocs_signature_cloud/models/sign_text_options_data.rb +0 -562
  156. data/lib/groupdocs_signature_cloud/models/slides_barcode_signature_data.rb +0 -250
  157. data/lib/groupdocs_signature_cloud/models/slides_qr_code_signature_data.rb +0 -250
  158. data/lib/groupdocs_signature_cloud/models/slides_search_barcode_options_data.rb +0 -332
  159. data/lib/groupdocs_signature_cloud/models/slides_search_qr_code_options_data.rb +0 -332
  160. data/lib/groupdocs_signature_cloud/models/slides_sign_barcode_options_data.rb +0 -664
  161. data/lib/groupdocs_signature_cloud/models/slides_sign_image_options_data.rb +0 -496
  162. data/lib/groupdocs_signature_cloud/models/slides_sign_qr_code_options_data.rb +0 -674
  163. data/lib/groupdocs_signature_cloud/models/slides_sign_text_options_data.rb +0 -670
  164. data/lib/groupdocs_signature_cloud/models/slides_verify_barcode_options_data.rb +0 -342
  165. data/lib/groupdocs_signature_cloud/models/slides_verify_qr_code_options_data.rb +0 -342
  166. data/lib/groupdocs_signature_cloud/models/slides_verify_text_options_data.rb +0 -285
  167. data/lib/groupdocs_signature_cloud/models/verified_document_response.rb +0 -300
  168. data/lib/groupdocs_signature_cloud/models/verify_digital_options_data.rb +0 -285
  169. data/lib/groupdocs_signature_cloud/models/verify_options_collection_data.rb +0 -247
  170. data/lib/groupdocs_signature_cloud/models/verify_options_data.rb +0 -265
  171. data/lib/groupdocs_signature_cloud/models/verify_text_options_data.rb +0 -285
  172. data/lib/groupdocs_signature_cloud/models/words_barcode_signature_data.rb +0 -250
  173. data/lib/groupdocs_signature_cloud/models/words_qr_code_signature_data.rb +0 -250
  174. data/lib/groupdocs_signature_cloud/models/words_search_barcode_options_data.rb +0 -332
  175. data/lib/groupdocs_signature_cloud/models/words_search_digital_options_data.rb +0 -265
  176. data/lib/groupdocs_signature_cloud/models/words_search_qr_code_options_data.rb +0 -332
  177. data/lib/groupdocs_signature_cloud/models/words_sign_barcode_options_data.rb +0 -664
  178. data/lib/groupdocs_signature_cloud/models/words_sign_digital_options_data.rb +0 -516
  179. data/lib/groupdocs_signature_cloud/models/words_sign_image_options_data.rb +0 -496
  180. data/lib/groupdocs_signature_cloud/models/words_sign_qr_code_options_data.rb +0 -674
  181. data/lib/groupdocs_signature_cloud/models/words_sign_stamp_options_data.rb +0 -592
  182. data/lib/groupdocs_signature_cloud/models/words_verify_barcode_options_data.rb +0 -342
  183. data/lib/groupdocs_signature_cloud/models/words_verify_digital_options_data.rb +0 -315
  184. data/lib/groupdocs_signature_cloud/models/words_verify_qr_code_options_data.rb +0 -342
  185. data/lib/groupdocs_signature_cloud/models/words_verify_text_options_data.rb +0 -285
@@ -1,694 +0,0 @@
1
- #
2
- # --------------------------------------------------------------------------------------------------------------------
3
- # <copyright company="Aspose Pty Ltd" file="cells_sign_barcode_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 Barcode Signature Options for Cells Documents.
32
- class CellsSignBarcodeOptionsData
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 Bar-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 Barcode type. Pick one from supported Barcode Types list.
101
- attr_accessor :barcode_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 Barcode. Default value is None.
116
- attr_accessor :code_text_alignment
117
-
118
- # Gets or sets the space between Barcode elements and result image borders.
119
- attr_accessor :inner_margins
120
-
121
- # Gets or sets worksheet number for signing. DocumentPageNumber parameter contains the same value.
122
- attr_accessor :sheet_number
123
-
124
- # Gets or sets the top row number of signature (min value is 0). Top parameter contains the same value.
125
- attr_accessor :row_number
126
-
127
- # Gets or sets the left column number of signature (min value is 0). Left parameter contains the same value.
128
- attr_accessor :column_number
129
- class EnumAttributeValidator
130
- attr_reader :datatype
131
- attr_reader :allowable_values
132
-
133
- def initialize(datatype, allowable_values)
134
- @allowable_values = allowable_values.map do |value|
135
- case datatype.to_s
136
- when /Integer/i
137
- value.to_i
138
- when /Float/i
139
- value.to_f
140
- else
141
- value
142
- end
143
- end
144
- end
145
-
146
- def valid?(value)
147
- !value || allowable_values.include?(value)
148
- end
149
- end
150
-
151
- # Attribute mapping from ruby-style variable name to JSON key.
152
- def self.attribute_map
153
- {
154
- :'document_page_number' => :'DocumentPageNumber',
155
- :'pages_setup' => :'PagesSetup',
156
- :'options_type' => :'OptionsType',
157
- :'left' => :'Left',
158
- :'top' => :'Top',
159
- :'width' => :'Width',
160
- :'height' => :'Height',
161
- :'location_measure_type' => :'LocationMeasureType',
162
- :'size_measure_type' => :'SizeMeasureType',
163
- :'stretch' => :'Stretch',
164
- :'rotation_angle' => :'RotationAngle',
165
- :'horizontal_alignment' => :'HorizontalAlignment',
166
- :'vertical_alignment' => :'VerticalAlignment',
167
- :'margin' => :'Margin',
168
- :'margin_measure_type' => :'MarginMeasureType',
169
- :'text' => :'Text',
170
- :'sign_all_pages' => :'SignAllPages',
171
- :'font' => :'Font',
172
- :'fore_color' => :'ForeColor',
173
- :'border_color' => :'BorderColor',
174
- :'background_color' => :'BackgroundColor',
175
- :'background_brush' => :'BackgroundBrush',
176
- :'barcode_type_name' => :'BarcodeTypeName',
177
- :'border_visiblity' => :'BorderVisiblity',
178
- :'border_dash_style' => :'BorderDashStyle',
179
- :'border_weight' => :'BorderWeight',
180
- :'opacity' => :'Opacity',
181
- :'code_text_alignment' => :'CodeTextAlignment',
182
- :'inner_margins' => :'InnerMargins',
183
- :'sheet_number' => :'SheetNumber',
184
- :'row_number' => :'RowNumber',
185
- :'column_number' => :'ColumnNumber'
186
- }
187
- end
188
-
189
- # Attribute type mapping.
190
- def self.swagger_types
191
- {
192
- :'document_page_number' => :'Integer',
193
- :'pages_setup' => :'PagesSetupData',
194
- :'options_type' => :'String',
195
- :'left' => :'Integer',
196
- :'top' => :'Integer',
197
- :'width' => :'Integer',
198
- :'height' => :'Integer',
199
- :'location_measure_type' => :'String',
200
- :'size_measure_type' => :'String',
201
- :'stretch' => :'String',
202
- :'rotation_angle' => :'Integer',
203
- :'horizontal_alignment' => :'String',
204
- :'vertical_alignment' => :'String',
205
- :'margin' => :'PaddingData',
206
- :'margin_measure_type' => :'String',
207
- :'text' => :'String',
208
- :'sign_all_pages' => :'BOOLEAN',
209
- :'font' => :'SignatureFontData',
210
- :'fore_color' => :'Color',
211
- :'border_color' => :'Color',
212
- :'background_color' => :'Color',
213
- :'background_brush' => :'BrushData',
214
- :'barcode_type_name' => :'String',
215
- :'border_visiblity' => :'BOOLEAN',
216
- :'border_dash_style' => :'String',
217
- :'border_weight' => :'Float',
218
- :'opacity' => :'Float',
219
- :'code_text_alignment' => :'String',
220
- :'inner_margins' => :'PaddingData',
221
- :'sheet_number' => :'Integer',
222
- :'row_number' => :'Integer',
223
- :'column_number' => :'Integer'
224
- }
225
- end
226
-
227
- # Initializes the object
228
- # @param [Hash] attributes Model attributes in the form of hash
229
- def initialize(attributes = {})
230
- return unless attributes.is_a?(Hash)
231
-
232
- # convert string to symbol for hash key
233
- attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
234
-
235
- if attributes.key?(:'DocumentPageNumber')
236
- self.document_page_number = attributes[:'DocumentPageNumber']
237
- end
238
-
239
- if attributes.key?(:'PagesSetup')
240
- self.pages_setup = attributes[:'PagesSetup']
241
- end
242
-
243
- if attributes.key?(:'OptionsType')
244
- self.options_type = attributes[:'OptionsType']
245
- end
246
-
247
- if attributes.key?(:'Left')
248
- self.left = attributes[:'Left']
249
- end
250
-
251
- if attributes.key?(:'Top')
252
- self.top = attributes[:'Top']
253
- end
254
-
255
- if attributes.key?(:'Width')
256
- self.width = attributes[:'Width']
257
- end
258
-
259
- if attributes.key?(:'Height')
260
- self.height = attributes[:'Height']
261
- end
262
-
263
- if attributes.key?(:'LocationMeasureType')
264
- self.location_measure_type = attributes[:'LocationMeasureType']
265
- end
266
-
267
- if attributes.key?(:'SizeMeasureType')
268
- self.size_measure_type = attributes[:'SizeMeasureType']
269
- end
270
-
271
- if attributes.key?(:'Stretch')
272
- self.stretch = attributes[:'Stretch']
273
- end
274
-
275
- if attributes.key?(:'RotationAngle')
276
- self.rotation_angle = attributes[:'RotationAngle']
277
- end
278
-
279
- if attributes.key?(:'HorizontalAlignment')
280
- self.horizontal_alignment = attributes[:'HorizontalAlignment']
281
- end
282
-
283
- if attributes.key?(:'VerticalAlignment')
284
- self.vertical_alignment = attributes[:'VerticalAlignment']
285
- end
286
-
287
- if attributes.key?(:'Margin')
288
- self.margin = attributes[:'Margin']
289
- end
290
-
291
- if attributes.key?(:'MarginMeasureType')
292
- self.margin_measure_type = attributes[:'MarginMeasureType']
293
- end
294
-
295
- if attributes.key?(:'Text')
296
- self.text = attributes[:'Text']
297
- end
298
-
299
- if attributes.key?(:'SignAllPages')
300
- self.sign_all_pages = attributes[:'SignAllPages']
301
- end
302
-
303
- if attributes.key?(:'Font')
304
- self.font = attributes[:'Font']
305
- end
306
-
307
- if attributes.key?(:'ForeColor')
308
- self.fore_color = attributes[:'ForeColor']
309
- end
310
-
311
- if attributes.key?(:'BorderColor')
312
- self.border_color = attributes[:'BorderColor']
313
- end
314
-
315
- if attributes.key?(:'BackgroundColor')
316
- self.background_color = attributes[:'BackgroundColor']
317
- end
318
-
319
- if attributes.key?(:'BackgroundBrush')
320
- self.background_brush = attributes[:'BackgroundBrush']
321
- end
322
-
323
- if attributes.key?(:'BarcodeTypeName')
324
- self.barcode_type_name = attributes[:'BarcodeTypeName']
325
- end
326
-
327
- if attributes.key?(:'BorderVisiblity')
328
- self.border_visiblity = attributes[:'BorderVisiblity']
329
- end
330
-
331
- if attributes.key?(:'BorderDashStyle')
332
- self.border_dash_style = attributes[:'BorderDashStyle']
333
- end
334
-
335
- if attributes.key?(:'BorderWeight')
336
- self.border_weight = attributes[:'BorderWeight']
337
- end
338
-
339
- if attributes.key?(:'Opacity')
340
- self.opacity = attributes[:'Opacity']
341
- end
342
-
343
- if attributes.key?(:'CodeTextAlignment')
344
- self.code_text_alignment = attributes[:'CodeTextAlignment']
345
- end
346
-
347
- if attributes.key?(:'InnerMargins')
348
- self.inner_margins = attributes[:'InnerMargins']
349
- end
350
-
351
- if attributes.key?(:'SheetNumber')
352
- self.sheet_number = attributes[:'SheetNumber']
353
- end
354
-
355
- if attributes.key?(:'RowNumber')
356
- self.row_number = attributes[:'RowNumber']
357
- end
358
-
359
- if attributes.key?(:'ColumnNumber')
360
- self.column_number = attributes[:'ColumnNumber']
361
- end
362
-
363
-
364
- if !((defined? options_type) == nil)
365
- self.options_type = "CellsSignBarcodeOptionsData"
366
- end
367
-
368
- end
369
-
370
- # Show invalid properties with the reasons. Usually used together with valid?
371
- # @return Array for valid properies with the reasons
372
- def list_invalid_properties
373
- invalid_properties = []
374
- if @document_page_number.nil?
375
- invalid_properties.push("invalid value for 'document_page_number', document_page_number cannot be nil.")
376
- end
377
-
378
- return invalid_properties
379
- end
380
-
381
- # Check to see if the all the properties in the model are valid
382
- # @return true if the model is valid
383
- def valid?
384
- return false if @document_page_number.nil?
385
- location_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
386
- return false unless location_measure_type_validator.valid?(@location_measure_type)
387
- size_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
388
- return false unless size_measure_type_validator.valid?(@size_measure_type)
389
- stretch_validator = EnumAttributeValidator.new('String', ["None", "PageWidth", "PageHeight", "PageArea"])
390
- return false unless stretch_validator.valid?(@stretch)
391
- horizontal_alignment_validator = EnumAttributeValidator.new('String', ["Default", "None", "Left", "Center", "Right"])
392
- return false unless horizontal_alignment_validator.valid?(@horizontal_alignment)
393
- vertical_alignment_validator = EnumAttributeValidator.new('String', ["Default", "None", "Top", "Center", "Bottom"])
394
- return false unless vertical_alignment_validator.valid?(@vertical_alignment)
395
- margin_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
396
- return false unless margin_measure_type_validator.valid?(@margin_measure_type)
397
- border_dash_style_validator = EnumAttributeValidator.new('String', ["Dash", "DashDot", "DashDotDot", "DashLongDash", "DashLongDashDot", "RoundDot", "Solid", "SquareDot"])
398
- return false unless border_dash_style_validator.valid?(@border_dash_style)
399
- code_text_alignment_validator = EnumAttributeValidator.new('String', ["None", "Above", "Below", "Right"])
400
- return false unless code_text_alignment_validator.valid?(@code_text_alignment)
401
- return true
402
- end
403
-
404
- # Custom attribute writer method checking allowed values (enum).
405
- # @param [Object] location_measure_type Object to be assigned
406
- def location_measure_type=(location_measure_type)
407
- validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
408
- if location_measure_type.to_i == 0
409
- unless validator.valid?(location_measure_type)
410
- raise ArgumentError, "invalid value for 'location_measure_type', must be one of #{validator.allowable_values}."
411
- end
412
- @location_measure_type = location_measure_type
413
- else
414
- @location_measure_type = validator.allowable_values[location_measure_type.to_i]
415
- end
416
- end
417
-
418
- # Custom attribute writer method checking allowed values (enum).
419
- # @param [Object] size_measure_type Object to be assigned
420
- def size_measure_type=(size_measure_type)
421
- validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
422
- if size_measure_type.to_i == 0
423
- unless validator.valid?(size_measure_type)
424
- raise ArgumentError, "invalid value for 'size_measure_type', must be one of #{validator.allowable_values}."
425
- end
426
- @size_measure_type = size_measure_type
427
- else
428
- @size_measure_type = validator.allowable_values[size_measure_type.to_i]
429
- end
430
- end
431
-
432
- # Custom attribute writer method checking allowed values (enum).
433
- # @param [Object] stretch Object to be assigned
434
- def stretch=(stretch)
435
- validator = EnumAttributeValidator.new('String', ["None", "PageWidth", "PageHeight", "PageArea"])
436
- if stretch.to_i == 0
437
- unless validator.valid?(stretch)
438
- raise ArgumentError, "invalid value for 'stretch', must be one of #{validator.allowable_values}."
439
- end
440
- @stretch = stretch
441
- else
442
- @stretch = validator.allowable_values[stretch.to_i]
443
- end
444
- end
445
-
446
- # Custom attribute writer method checking allowed values (enum).
447
- # @param [Object] horizontal_alignment Object to be assigned
448
- def horizontal_alignment=(horizontal_alignment)
449
- validator = EnumAttributeValidator.new('String', ["Default", "None", "Left", "Center", "Right"])
450
- if horizontal_alignment.to_i == 0
451
- unless validator.valid?(horizontal_alignment)
452
- raise ArgumentError, "invalid value for 'horizontal_alignment', must be one of #{validator.allowable_values}."
453
- end
454
- @horizontal_alignment = horizontal_alignment
455
- else
456
- @horizontal_alignment = validator.allowable_values[horizontal_alignment.to_i]
457
- end
458
- end
459
-
460
- # Custom attribute writer method checking allowed values (enum).
461
- # @param [Object] vertical_alignment Object to be assigned
462
- def vertical_alignment=(vertical_alignment)
463
- validator = EnumAttributeValidator.new('String', ["Default", "None", "Top", "Center", "Bottom"])
464
- if vertical_alignment.to_i == 0
465
- unless validator.valid?(vertical_alignment)
466
- raise ArgumentError, "invalid value for 'vertical_alignment', must be one of #{validator.allowable_values}."
467
- end
468
- @vertical_alignment = vertical_alignment
469
- else
470
- @vertical_alignment = validator.allowable_values[vertical_alignment.to_i]
471
- end
472
- end
473
-
474
- # Custom attribute writer method checking allowed values (enum).
475
- # @param [Object] margin_measure_type Object to be assigned
476
- def margin_measure_type=(margin_measure_type)
477
- validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
478
- if margin_measure_type.to_i == 0
479
- unless validator.valid?(margin_measure_type)
480
- raise ArgumentError, "invalid value for 'margin_measure_type', must be one of #{validator.allowable_values}."
481
- end
482
- @margin_measure_type = margin_measure_type
483
- else
484
- @margin_measure_type = validator.allowable_values[margin_measure_type.to_i]
485
- end
486
- end
487
-
488
- # Custom attribute writer method checking allowed values (enum).
489
- # @param [Object] border_dash_style Object to be assigned
490
- def border_dash_style=(border_dash_style)
491
- validator = EnumAttributeValidator.new('String', ["Dash", "DashDot", "DashDotDot", "DashLongDash", "DashLongDashDot", "RoundDot", "Solid", "SquareDot"])
492
- if border_dash_style.to_i == 0
493
- unless validator.valid?(border_dash_style)
494
- raise ArgumentError, "invalid value for 'border_dash_style', must be one of #{validator.allowable_values}."
495
- end
496
- @border_dash_style = border_dash_style
497
- else
498
- @border_dash_style = validator.allowable_values[border_dash_style.to_i]
499
- end
500
- end
501
-
502
- # Custom attribute writer method checking allowed values (enum).
503
- # @param [Object] code_text_alignment Object to be assigned
504
- def code_text_alignment=(code_text_alignment)
505
- validator = EnumAttributeValidator.new('String', ["None", "Above", "Below", "Right"])
506
- if code_text_alignment.to_i == 0
507
- unless validator.valid?(code_text_alignment)
508
- raise ArgumentError, "invalid value for 'code_text_alignment', must be one of #{validator.allowable_values}."
509
- end
510
- @code_text_alignment = code_text_alignment
511
- else
512
- @code_text_alignment = validator.allowable_values[code_text_alignment.to_i]
513
- end
514
- end
515
-
516
- # Checks equality by comparing each attribute.
517
- # @param [Object] Object to be compared
518
- def ==(other)
519
- return true if self.equal?(other)
520
- self.class == other.class &&
521
- document_page_number == other.document_page_number &&
522
- pages_setup == other.pages_setup &&
523
- options_type == other.options_type &&
524
- left == other.left &&
525
- top == other.top &&
526
- width == other.width &&
527
- height == other.height &&
528
- location_measure_type == other.location_measure_type &&
529
- size_measure_type == other.size_measure_type &&
530
- stretch == other.stretch &&
531
- rotation_angle == other.rotation_angle &&
532
- horizontal_alignment == other.horizontal_alignment &&
533
- vertical_alignment == other.vertical_alignment &&
534
- margin == other.margin &&
535
- margin_measure_type == other.margin_measure_type &&
536
- text == other.text &&
537
- sign_all_pages == other.sign_all_pages &&
538
- font == other.font &&
539
- fore_color == other.fore_color &&
540
- border_color == other.border_color &&
541
- background_color == other.background_color &&
542
- background_brush == other.background_brush &&
543
- barcode_type_name == other.barcode_type_name &&
544
- border_visiblity == other.border_visiblity &&
545
- border_dash_style == other.border_dash_style &&
546
- border_weight == other.border_weight &&
547
- opacity == other.opacity &&
548
- code_text_alignment == other.code_text_alignment &&
549
- inner_margins == other.inner_margins &&
550
- sheet_number == other.sheet_number &&
551
- row_number == other.row_number &&
552
- column_number == other.column_number
553
- end
554
-
555
- # @see the `==` method
556
- # @param [Object] Object to be compared
557
- def eql?(other)
558
- self == other
559
- end
560
-
561
- # Calculates hash code according to all attributes.
562
- # @return [Fixnum] Hash code
563
- def hash
564
- [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, barcode_type_name, border_visiblity, border_dash_style, border_weight, opacity, code_text_alignment, inner_margins, sheet_number, row_number, column_number].hash
565
- end
566
-
567
- # Builds the object from hash
568
- # @param [Hash] attributes Model attributes in the form of hash
569
- # @return [Object] Returns the model itself
570
- def build_from_hash(attributes)
571
- return nil unless attributes.is_a?(Hash)
572
- self.class.swagger_types.each_pair do |key, type|
573
-
574
- attributeName = self.class.attribute_map[key]
575
- attributeNameLowerStr = attributeName.to_s
576
- attributeNameLowerStr[0] = attributeNameLowerStr[0].downcase
577
- attributeNameLower = attributeNameLowerStr.to_sym
578
- attributeNameLowerStr2 = attributeName.to_s
579
- attributeNameLowerStr2[0] = attributeNameLowerStr[0].downcase
580
- attributeNameLowerStr2[1] = attributeNameLowerStr[1].downcase
581
- attributeNameLower2 = attributeNameLowerStr2.to_sym
582
-
583
- if type =~ /\AArray<(.*)>/i
584
- # check to ensure the input is an array given that the the attribute
585
- # is documented as an array but the input is not
586
- if attributes[attributeName].is_a?(Array)
587
- self.send("#{key}=", attributes[attributeName].map { |v| _deserialize($1, v) })
588
- end
589
- if attributes[attributeNameLower].is_a?(Array)
590
- self.send("#{key}=", attributes[attributeNameLower].map { |v| _deserialize($1, v) })
591
- end
592
- if attributes[attributeNameLower2].is_a?(Array)
593
- self.send("#{key}=", attributes[attributeNameLower2].map { |v| _deserialize($1, v) })
594
- end
595
- elsif !attributes[attributeName].nil?
596
- self.send("#{key}=", _deserialize(type, attributes[attributeName]))
597
- elsif !attributes[attributeNameLower].nil?
598
- self.send("#{key}=", _deserialize(type, attributes[attributeNameLower]))
599
- elsif !attributes[attributeNameLower2].nil?
600
- self.send("#{key}=", _deserialize(type, attributes[attributeNameLower2]))
601
- end
602
- # or else data not found in attributes(hash), not an issue as the data can be optional
603
- end
604
- self
605
- end
606
-
607
- # Deserializes the data based on type
608
- # @param string type Data type
609
- # @param string value Value to be deserialized
610
- # @return [Object] Deserialized data
611
- def _deserialize(type, value)
612
- case type.to_sym
613
- when :DateTime
614
- Time.at(/\d/.match(value)[0].to_f).to_datetime
615
- when :Date
616
- Time.at(/\d/.match(value)[0].to_f).to_date
617
- when :String
618
- value.to_s
619
- when :Integer
620
- value.to_i
621
- when :Float
622
- value.to_f
623
- when :BOOLEAN
624
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
625
- true
626
- else
627
- false
628
- end
629
- when :Object
630
- # generic object (usually a Hash), return directly
631
- value
632
- when /\AArray<(?<inner_type>.+)>\z/
633
- inner_type = Regexp.last_match[:inner_type]
634
- value.map { |v| _deserialize(inner_type, v) }
635
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
636
- k_type = Regexp.last_match[:k_type]
637
- v_type = Regexp.last_match[:v_type]
638
- {}.tap do |hash|
639
- value.each do |k, v|
640
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
641
- end
642
- end
643
- else
644
- # model
645
- temp_model = GroupDocsSignatureCloud.const_get(type).new
646
- temp_model.build_from_hash(value)
647
- end
648
- end
649
-
650
- # Returns the string representation of the object
651
- # @return [String] String presentation of the object
652
- def to_s
653
- to_hash.to_s
654
- end
655
-
656
- # to_body is an alias to to_hash (backward compatibility)
657
- # @return [Hash] Returns the object in the form of hash
658
- def to_body
659
- to_hash
660
- end
661
-
662
- # Returns the object in the form of hash
663
- # @return [Hash] Returns the object in the form of hash
664
- def to_hash
665
- hash = {}
666
- self.class.attribute_map.each_pair do |attr, param|
667
- value = self.send(attr)
668
- next if value.nil?
669
- hash[param] = _to_hash(value)
670
- end
671
- hash
672
- end
673
-
674
- # Outputs non-array value in the form of hash
675
- # For object, use to_hash. Otherwise, just return the value
676
- # @param [Object] value Any valid value
677
- # @return [Hash] Returns the value in the form of hash
678
- def _to_hash(value)
679
- if value.is_a?(Array)
680
- value.compact.map { |v| _to_hash(v) }
681
- elsif value.is_a?(Hash)
682
- {}.tap do |hash|
683
- value.each { |k, v| hash[k] = _to_hash(v) }
684
- end
685
- elsif value.respond_to? :to_hash
686
- value.to_hash
687
- else
688
- value
689
- end
690
- end
691
-
692
- end
693
-
694
- end