aspose_pdf_cloud 19.9.0 → 19.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -4
- data/docs/BoxStyle.md +15 -0
- data/docs/CheckBoxField.md +31 -0
- data/docs/CheckBoxFieldResponse.md +11 -0
- data/docs/CheckBoxFields.md +10 -0
- data/docs/CheckBoxFieldsResponse.md +11 -0
- data/docs/ChoiceField.md +27 -0
- data/docs/Option.md +12 -0
- data/docs/PdfApi.md +260 -0
- data/docs/RadioButtonField.md +31 -0
- data/docs/RadioButtonFieldResponse.md +11 -0
- data/docs/RadioButtonFields.md +10 -0
- data/docs/RadioButtonFieldsResponse.md +11 -0
- data/docs/RadioButtonOptionField.md +28 -0
- data/lib/aspose_pdf_cloud.rb +12 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +814 -38
- data/lib/aspose_pdf_cloud/models/box_style.rb +48 -0
- data/lib/aspose_pdf_cloud/models/check_box_field.rb +440 -0
- data/lib/aspose_pdf_cloud/models/check_box_field_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/check_box_fields.rb +213 -0
- data/lib/aspose_pdf_cloud/models/check_box_fields_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/choice_field.rb +393 -0
- data/lib/aspose_pdf_cloud/models/option.rb +229 -0
- data/lib/aspose_pdf_cloud/models/radio_button_field.rb +442 -0
- data/lib/aspose_pdf_cloud/models/radio_button_field_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/radio_button_fields.rb +213 -0
- data/lib/aspose_pdf_cloud/models/radio_button_fields_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/radio_button_option_field.rb +403 -0
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +200 -0
- metadata +26 -2
@@ -0,0 +1,31 @@
|
|
1
|
+
# AsposePdfCloud::RadioButtonField
|
2
|
+
Provides RadioButtonField.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
|
+
**value** | **String** | Field value. | [optional]
|
11
|
+
**page_index** | **Integer** | Page index. |
|
12
|
+
**height** | **Float** | Gets or sets height of the field. | [optional]
|
13
|
+
**width** | **Float** | Gets or sets width of the field. | [optional]
|
14
|
+
**z_index** | **Integer** | Z index. | [optional]
|
15
|
+
**is_group** | **BOOLEAN** | Is group. |
|
16
|
+
**parent** | [**FormField**](FormField.md) | Gets field parent. | [optional]
|
17
|
+
**is_shared_field** | **BOOLEAN** | Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page. | [optional]
|
18
|
+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the field. | [optional]
|
19
|
+
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
|
20
|
+
**contents** | **String** | Get the field content. | [optional]
|
21
|
+
**margin** | [**MarginInfo**](MarginInfo.md) | Gets or sets a outer margin for paragraph (for pdf generation) | [optional]
|
22
|
+
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | Field highlighting mode. | [optional]
|
23
|
+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the field. | [optional]
|
24
|
+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the field. | [optional]
|
25
|
+
**multi_select** | **BOOLEAN** | Gets or sets multiselection flag. | [optional]
|
26
|
+
**options** | [**Array<Option>**](Option.md) | Gets collection of options of the radio button. | [optional]
|
27
|
+
**radio_button_options_field** | [**Array<RadioButtonOptionField>**](RadioButtonOptionField.md) | Gets collection of radio button options field. | [optional]
|
28
|
+
**style** | [**BoxStyle**](BoxStyle.md) | Style of field box. | [optional]
|
29
|
+
**selected** | **Integer** | Gets or sets index of selected item. Numbering of items is started from 1. |
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::RadioButtonFieldResponse
|
2
|
+
Represents response containing single RadioButton field object
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**field** | [**RadioButtonField**](RadioButtonField.md) | RadioButton field object | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::RadioButtonFields
|
2
|
+
Object representing a list of radiobox fields.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**list** | [**Array<RadioButtonField>**](RadioButtonField.md) | List of radiobox fields. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::RadioButtonFieldsResponse
|
2
|
+
Represents response containing multiple RadioButton field objects
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**fields** | [**RadioButtonFields**](RadioButtonFields.md) | Text box fields object | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# AsposePdfCloud::RadioButtonOptionField
|
2
|
+
Provides RadioButtonField.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
|
+
**value** | **String** | Field value. | [optional]
|
11
|
+
**page_index** | **Integer** | Page index. |
|
12
|
+
**height** | **Float** | Gets or sets height of the field. | [optional]
|
13
|
+
**width** | **Float** | Gets or sets width of the field. | [optional]
|
14
|
+
**z_index** | **Integer** | Z index. | [optional]
|
15
|
+
**is_group** | **BOOLEAN** | Is group. |
|
16
|
+
**parent** | [**FormField**](FormField.md) | Gets field parent. | [optional]
|
17
|
+
**is_shared_field** | **BOOLEAN** | Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page. | [optional]
|
18
|
+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the field. | [optional]
|
19
|
+
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
|
20
|
+
**contents** | **String** | Get the field content. | [optional]
|
21
|
+
**margin** | [**MarginInfo**](MarginInfo.md) | Gets or sets a outer margin for paragraph (for pdf generation) | [optional]
|
22
|
+
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | Field highlighting mode. | [optional]
|
23
|
+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the field. | [optional]
|
24
|
+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the field. | [optional]
|
25
|
+
**option_name** | **String** | Gets or sets name of the option. | [optional]
|
26
|
+
**style** | [**BoxStyle**](BoxStyle.md) | Style of field box. | [optional]
|
27
|
+
|
28
|
+
|
data/lib/aspose_pdf_cloud.rb
CHANGED
@@ -33,6 +33,7 @@ require_relative 'aspose_pdf_cloud/models/antialiasing_processing_type'
|
|
33
33
|
require_relative 'aspose_pdf_cloud/models/aspose_response'
|
34
34
|
require_relative 'aspose_pdf_cloud/models/border_corner_style'
|
35
35
|
require_relative 'aspose_pdf_cloud/models/border_info'
|
36
|
+
require_relative 'aspose_pdf_cloud/models/box_style'
|
36
37
|
require_relative 'aspose_pdf_cloud/models/cap_style'
|
37
38
|
require_relative 'aspose_pdf_cloud/models/caption_position'
|
38
39
|
require_relative 'aspose_pdf_cloud/models/caret_symbol'
|
@@ -80,6 +81,7 @@ require_relative 'aspose_pdf_cloud/models/margin_info'
|
|
80
81
|
require_relative 'aspose_pdf_cloud/models/merge_documents'
|
81
82
|
require_relative 'aspose_pdf_cloud/models/object_exist'
|
82
83
|
require_relative 'aspose_pdf_cloud/models/optimize_options'
|
84
|
+
require_relative 'aspose_pdf_cloud/models/option'
|
83
85
|
require_relative 'aspose_pdf_cloud/models/page_word_count'
|
84
86
|
require_relative 'aspose_pdf_cloud/models/paragraph'
|
85
87
|
require_relative 'aspose_pdf_cloud/models/parts_embedding_modes'
|
@@ -134,6 +136,9 @@ require_relative 'aspose_pdf_cloud/models/bookmarks_response'
|
|
134
136
|
require_relative 'aspose_pdf_cloud/models/caret_annotation_response'
|
135
137
|
require_relative 'aspose_pdf_cloud/models/caret_annotations'
|
136
138
|
require_relative 'aspose_pdf_cloud/models/caret_annotations_response'
|
139
|
+
require_relative 'aspose_pdf_cloud/models/check_box_field_response'
|
140
|
+
require_relative 'aspose_pdf_cloud/models/check_box_fields'
|
141
|
+
require_relative 'aspose_pdf_cloud/models/check_box_fields_response'
|
137
142
|
require_relative 'aspose_pdf_cloud/models/circle_annotation_response'
|
138
143
|
require_relative 'aspose_pdf_cloud/models/circle_annotations'
|
139
144
|
require_relative 'aspose_pdf_cloud/models/circle_annotations_response'
|
@@ -188,6 +193,9 @@ require_relative 'aspose_pdf_cloud/models/polygon_annotations_response'
|
|
188
193
|
require_relative 'aspose_pdf_cloud/models/popup_annotation_response'
|
189
194
|
require_relative 'aspose_pdf_cloud/models/popup_annotations'
|
190
195
|
require_relative 'aspose_pdf_cloud/models/popup_annotations_response'
|
196
|
+
require_relative 'aspose_pdf_cloud/models/radio_button_field_response'
|
197
|
+
require_relative 'aspose_pdf_cloud/models/radio_button_fields'
|
198
|
+
require_relative 'aspose_pdf_cloud/models/radio_button_fields_response'
|
191
199
|
require_relative 'aspose_pdf_cloud/models/redaction_annotation_response'
|
192
200
|
require_relative 'aspose_pdf_cloud/models/redaction_annotations'
|
193
201
|
require_relative 'aspose_pdf_cloud/models/redaction_annotations_response'
|
@@ -237,6 +245,8 @@ require_relative 'aspose_pdf_cloud/models/underline_annotations'
|
|
237
245
|
require_relative 'aspose_pdf_cloud/models/underline_annotations_response'
|
238
246
|
require_relative 'aspose_pdf_cloud/models/word_count_response'
|
239
247
|
require_relative 'aspose_pdf_cloud/models/annotation_info'
|
248
|
+
require_relative 'aspose_pdf_cloud/models/check_box_field'
|
249
|
+
require_relative 'aspose_pdf_cloud/models/choice_field'
|
240
250
|
require_relative 'aspose_pdf_cloud/models/image_footer'
|
241
251
|
require_relative 'aspose_pdf_cloud/models/image_header'
|
242
252
|
require_relative 'aspose_pdf_cloud/models/image_stamp'
|
@@ -245,6 +255,7 @@ require_relative 'aspose_pdf_cloud/models/movie_annotation'
|
|
245
255
|
require_relative 'aspose_pdf_cloud/models/page_number_stamp'
|
246
256
|
require_relative 'aspose_pdf_cloud/models/pdf_page_stamp'
|
247
257
|
require_relative 'aspose_pdf_cloud/models/popup_annotation'
|
258
|
+
require_relative 'aspose_pdf_cloud/models/radio_button_option_field'
|
248
259
|
require_relative 'aspose_pdf_cloud/models/redaction_annotation'
|
249
260
|
require_relative 'aspose_pdf_cloud/models/screen_annotation'
|
250
261
|
require_relative 'aspose_pdf_cloud/models/signature_field'
|
@@ -261,6 +272,7 @@ require_relative 'aspose_pdf_cloud/models/ink_annotation'
|
|
261
272
|
require_relative 'aspose_pdf_cloud/models/line_annotation'
|
262
273
|
require_relative 'aspose_pdf_cloud/models/poly_annotation'
|
263
274
|
require_relative 'aspose_pdf_cloud/models/popup_annotation_with_parent'
|
275
|
+
require_relative 'aspose_pdf_cloud/models/radio_button_field'
|
264
276
|
require_relative 'aspose_pdf_cloud/models/sound_annotation'
|
265
277
|
require_relative 'aspose_pdf_cloud/models/squiggly_annotation'
|
266
278
|
require_relative 'aspose_pdf_cloud/models/stamp_annotation'
|
@@ -2153,6 +2153,84 @@ module AsposePdfCloud
|
|
2153
2153
|
return data, status_code, headers
|
2154
2154
|
end
|
2155
2155
|
|
2156
|
+
# Read document checkbox field by name.
|
2157
|
+
#
|
2158
|
+
# @param name The document name.
|
2159
|
+
# @param field_name The field name.
|
2160
|
+
# @param [Hash] opts the optional parameters
|
2161
|
+
# @option opts [String] :storage The document storage.
|
2162
|
+
# @option opts [String] :folder The document folder.
|
2163
|
+
# @return [CheckBoxFieldResponse]
|
2164
|
+
def get_check_box_field(name, field_name, opts = {})
|
2165
|
+
@api_client.request_token_if_needed
|
2166
|
+
data, _status_code, _headers = get_check_box_field_with_http_info(name, field_name, opts)
|
2167
|
+
rescue ApiError => error
|
2168
|
+
if error.code == 401
|
2169
|
+
@api_client.request_token_if_needed
|
2170
|
+
data, _status_code, _headers = get_check_box_field_with_http_info(name, field_name, opts)
|
2171
|
+
else
|
2172
|
+
raise
|
2173
|
+
end
|
2174
|
+
return data
|
2175
|
+
end
|
2176
|
+
|
2177
|
+
# Read document checkbox field by name.
|
2178
|
+
#
|
2179
|
+
# @param name The document name.
|
2180
|
+
# @param field_name The field name.
|
2181
|
+
# @param [Hash] opts the optional parameters
|
2182
|
+
# @option opts [String] :storage The document storage.
|
2183
|
+
# @option opts [String] :folder The document folder.
|
2184
|
+
# @return [Array<(CheckBoxFieldResponse, Fixnum, Hash)>] CheckBoxFieldResponse data, response status code and response headers
|
2185
|
+
def get_check_box_field_with_http_info(name, field_name, opts = {})
|
2186
|
+
if @api_client.config.debugging
|
2187
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_check_box_field ..."
|
2188
|
+
end
|
2189
|
+
# verify the required parameter 'name' is set
|
2190
|
+
if @api_client.config.client_side_validation && name.nil?
|
2191
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_check_box_field"
|
2192
|
+
end
|
2193
|
+
# verify the required parameter 'field_name' is set
|
2194
|
+
if @api_client.config.client_side_validation && field_name.nil?
|
2195
|
+
fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_check_box_field"
|
2196
|
+
end
|
2197
|
+
# resource path
|
2198
|
+
local_var_path = "/pdf/{name}/fields/checkbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)
|
2199
|
+
|
2200
|
+
# query parameters
|
2201
|
+
query_params = {}
|
2202
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
2203
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
2204
|
+
|
2205
|
+
# header parameters
|
2206
|
+
header_params = {}
|
2207
|
+
# HTTP header 'Accept' (if needed)
|
2208
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2209
|
+
# HTTP header 'Content-Type'
|
2210
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2211
|
+
|
2212
|
+
# form parameters
|
2213
|
+
form_params = {}
|
2214
|
+
# Fix header in file
|
2215
|
+
post_body = nil
|
2216
|
+
|
2217
|
+
# http body (model)
|
2218
|
+
# Fix header in file
|
2219
|
+
# post_body = nil
|
2220
|
+
auth_names = ['JWT']
|
2221
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2222
|
+
:header_params => header_params,
|
2223
|
+
:query_params => query_params,
|
2224
|
+
:form_params => form_params,
|
2225
|
+
:body => post_body,
|
2226
|
+
:auth_names => auth_names,
|
2227
|
+
:return_type => 'CheckBoxFieldResponse')
|
2228
|
+
if @api_client.config.debugging
|
2229
|
+
@api_client.config.logger.debug "API called: PdfApi#get_check_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2230
|
+
end
|
2231
|
+
return data, status_code, headers
|
2232
|
+
end
|
2233
|
+
|
2156
2234
|
# Read document page circle annotation by ID.
|
2157
2235
|
#
|
2158
2236
|
# @param name The document name.
|
@@ -2732,6 +2810,78 @@ module AsposePdfCloud
|
|
2732
2810
|
return data, status_code, headers
|
2733
2811
|
end
|
2734
2812
|
|
2813
|
+
# Read document checkbox fields.
|
2814
|
+
#
|
2815
|
+
# @param name The document name.
|
2816
|
+
# @param [Hash] opts the optional parameters
|
2817
|
+
# @option opts [String] :storage The document storage.
|
2818
|
+
# @option opts [String] :folder The document folder.
|
2819
|
+
# @return [CheckBoxFieldsResponse]
|
2820
|
+
def get_document_check_box_fields(name, opts = {})
|
2821
|
+
@api_client.request_token_if_needed
|
2822
|
+
data, _status_code, _headers = get_document_check_box_fields_with_http_info(name, opts)
|
2823
|
+
rescue ApiError => error
|
2824
|
+
if error.code == 401
|
2825
|
+
@api_client.request_token_if_needed
|
2826
|
+
data, _status_code, _headers = get_document_check_box_fields_with_http_info(name, opts)
|
2827
|
+
else
|
2828
|
+
raise
|
2829
|
+
end
|
2830
|
+
return data
|
2831
|
+
end
|
2832
|
+
|
2833
|
+
# Read document checkbox fields.
|
2834
|
+
#
|
2835
|
+
# @param name The document name.
|
2836
|
+
# @param [Hash] opts the optional parameters
|
2837
|
+
# @option opts [String] :storage The document storage.
|
2838
|
+
# @option opts [String] :folder The document folder.
|
2839
|
+
# @return [Array<(CheckBoxFieldsResponse, Fixnum, Hash)>] CheckBoxFieldsResponse data, response status code and response headers
|
2840
|
+
def get_document_check_box_fields_with_http_info(name, opts = {})
|
2841
|
+
if @api_client.config.debugging
|
2842
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_document_check_box_fields ..."
|
2843
|
+
end
|
2844
|
+
# verify the required parameter 'name' is set
|
2845
|
+
if @api_client.config.client_side_validation && name.nil?
|
2846
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_check_box_fields"
|
2847
|
+
end
|
2848
|
+
# resource path
|
2849
|
+
local_var_path = "/pdf/{name}/fields/checkbox".sub('{' + 'name' + '}', name.to_s)
|
2850
|
+
|
2851
|
+
# query parameters
|
2852
|
+
query_params = {}
|
2853
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
2854
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
2855
|
+
|
2856
|
+
# header parameters
|
2857
|
+
header_params = {}
|
2858
|
+
# HTTP header 'Accept' (if needed)
|
2859
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2860
|
+
# HTTP header 'Content-Type'
|
2861
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2862
|
+
|
2863
|
+
# form parameters
|
2864
|
+
form_params = {}
|
2865
|
+
# Fix header in file
|
2866
|
+
post_body = nil
|
2867
|
+
|
2868
|
+
# http body (model)
|
2869
|
+
# Fix header in file
|
2870
|
+
# post_body = nil
|
2871
|
+
auth_names = ['JWT']
|
2872
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2873
|
+
:header_params => header_params,
|
2874
|
+
:query_params => query_params,
|
2875
|
+
:form_params => form_params,
|
2876
|
+
:body => post_body,
|
2877
|
+
:auth_names => auth_names,
|
2878
|
+
:return_type => 'CheckBoxFieldsResponse')
|
2879
|
+
if @api_client.config.debugging
|
2880
|
+
@api_client.config.logger.debug "API called: PdfApi#get_document_check_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2881
|
+
end
|
2882
|
+
return data, status_code, headers
|
2883
|
+
end
|
2884
|
+
|
2735
2885
|
# Read document circle annotations.
|
2736
2886
|
#
|
2737
2887
|
# @param name The document name.
|
@@ -3680,6 +3830,78 @@ module AsposePdfCloud
|
|
3680
3830
|
return data, status_code, headers
|
3681
3831
|
end
|
3682
3832
|
|
3833
|
+
# Read document radiobutton fields.
|
3834
|
+
#
|
3835
|
+
# @param name The document name.
|
3836
|
+
# @param [Hash] opts the optional parameters
|
3837
|
+
# @option opts [String] :storage The document storage.
|
3838
|
+
# @option opts [String] :folder The document folder.
|
3839
|
+
# @return [RadioButtonFieldsResponse]
|
3840
|
+
def get_document_radio_button_fields(name, opts = {})
|
3841
|
+
@api_client.request_token_if_needed
|
3842
|
+
data, _status_code, _headers = get_document_radio_button_fields_with_http_info(name, opts)
|
3843
|
+
rescue ApiError => error
|
3844
|
+
if error.code == 401
|
3845
|
+
@api_client.request_token_if_needed
|
3846
|
+
data, _status_code, _headers = get_document_radio_button_fields_with_http_info(name, opts)
|
3847
|
+
else
|
3848
|
+
raise
|
3849
|
+
end
|
3850
|
+
return data
|
3851
|
+
end
|
3852
|
+
|
3853
|
+
# Read document radiobutton fields.
|
3854
|
+
#
|
3855
|
+
# @param name The document name.
|
3856
|
+
# @param [Hash] opts the optional parameters
|
3857
|
+
# @option opts [String] :storage The document storage.
|
3858
|
+
# @option opts [String] :folder The document folder.
|
3859
|
+
# @return [Array<(RadioButtonFieldsResponse, Fixnum, Hash)>] RadioButtonFieldsResponse data, response status code and response headers
|
3860
|
+
def get_document_radio_button_fields_with_http_info(name, opts = {})
|
3861
|
+
if @api_client.config.debugging
|
3862
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_document_radio_button_fields ..."
|
3863
|
+
end
|
3864
|
+
# verify the required parameter 'name' is set
|
3865
|
+
if @api_client.config.client_side_validation && name.nil?
|
3866
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_radio_button_fields"
|
3867
|
+
end
|
3868
|
+
# resource path
|
3869
|
+
local_var_path = "/pdf/{name}/fields/radiobutton".sub('{' + 'name' + '}', name.to_s)
|
3870
|
+
|
3871
|
+
# query parameters
|
3872
|
+
query_params = {}
|
3873
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
3874
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
3875
|
+
|
3876
|
+
# header parameters
|
3877
|
+
header_params = {}
|
3878
|
+
# HTTP header 'Accept' (if needed)
|
3879
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3880
|
+
# HTTP header 'Content-Type'
|
3881
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3882
|
+
|
3883
|
+
# form parameters
|
3884
|
+
form_params = {}
|
3885
|
+
# Fix header in file
|
3886
|
+
post_body = nil
|
3887
|
+
|
3888
|
+
# http body (model)
|
3889
|
+
# Fix header in file
|
3890
|
+
# post_body = nil
|
3891
|
+
auth_names = ['JWT']
|
3892
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3893
|
+
:header_params => header_params,
|
3894
|
+
:query_params => query_params,
|
3895
|
+
:form_params => form_params,
|
3896
|
+
:body => post_body,
|
3897
|
+
:auth_names => auth_names,
|
3898
|
+
:return_type => 'RadioButtonFieldsResponse')
|
3899
|
+
if @api_client.config.debugging
|
3900
|
+
@api_client.config.logger.debug "API called: PdfApi#get_document_radio_button_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3901
|
+
end
|
3902
|
+
return data, status_code, headers
|
3903
|
+
end
|
3904
|
+
|
3683
3905
|
# Read document redaction annotations.
|
3684
3906
|
#
|
3685
3907
|
# @param name The document name.
|
@@ -7159,6 +7381,84 @@ module AsposePdfCloud
|
|
7159
7381
|
return data, status_code, headers
|
7160
7382
|
end
|
7161
7383
|
|
7384
|
+
# Read document page checkbox fields.
|
7385
|
+
#
|
7386
|
+
# @param name The document name.
|
7387
|
+
# @param page_number The page number.
|
7388
|
+
# @param [Hash] opts the optional parameters
|
7389
|
+
# @option opts [String] :storage The document storage.
|
7390
|
+
# @option opts [String] :folder The document folder.
|
7391
|
+
# @return [CheckBoxFieldsResponse]
|
7392
|
+
def get_page_check_box_fields(name, page_number, opts = {})
|
7393
|
+
@api_client.request_token_if_needed
|
7394
|
+
data, _status_code, _headers = get_page_check_box_fields_with_http_info(name, page_number, opts)
|
7395
|
+
rescue ApiError => error
|
7396
|
+
if error.code == 401
|
7397
|
+
@api_client.request_token_if_needed
|
7398
|
+
data, _status_code, _headers = get_page_check_box_fields_with_http_info(name, page_number, opts)
|
7399
|
+
else
|
7400
|
+
raise
|
7401
|
+
end
|
7402
|
+
return data
|
7403
|
+
end
|
7404
|
+
|
7405
|
+
# Read document page checkbox fields.
|
7406
|
+
#
|
7407
|
+
# @param name The document name.
|
7408
|
+
# @param page_number The page number.
|
7409
|
+
# @param [Hash] opts the optional parameters
|
7410
|
+
# @option opts [String] :storage The document storage.
|
7411
|
+
# @option opts [String] :folder The document folder.
|
7412
|
+
# @return [Array<(CheckBoxFieldsResponse, Fixnum, Hash)>] CheckBoxFieldsResponse data, response status code and response headers
|
7413
|
+
def get_page_check_box_fields_with_http_info(name, page_number, opts = {})
|
7414
|
+
if @api_client.config.debugging
|
7415
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_page_check_box_fields ..."
|
7416
|
+
end
|
7417
|
+
# verify the required parameter 'name' is set
|
7418
|
+
if @api_client.config.client_side_validation && name.nil?
|
7419
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_check_box_fields"
|
7420
|
+
end
|
7421
|
+
# verify the required parameter 'page_number' is set
|
7422
|
+
if @api_client.config.client_side_validation && page_number.nil?
|
7423
|
+
fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_check_box_fields"
|
7424
|
+
end
|
7425
|
+
# resource path
|
7426
|
+
local_var_path = "/pdf/{name}/page/{pageNumber}/fields/checkbox".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
|
7427
|
+
|
7428
|
+
# query parameters
|
7429
|
+
query_params = {}
|
7430
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
7431
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
7432
|
+
|
7433
|
+
# header parameters
|
7434
|
+
header_params = {}
|
7435
|
+
# HTTP header 'Accept' (if needed)
|
7436
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7437
|
+
# HTTP header 'Content-Type'
|
7438
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
7439
|
+
|
7440
|
+
# form parameters
|
7441
|
+
form_params = {}
|
7442
|
+
# Fix header in file
|
7443
|
+
post_body = nil
|
7444
|
+
|
7445
|
+
# http body (model)
|
7446
|
+
# Fix header in file
|
7447
|
+
# post_body = nil
|
7448
|
+
auth_names = ['JWT']
|
7449
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
7450
|
+
:header_params => header_params,
|
7451
|
+
:query_params => query_params,
|
7452
|
+
:form_params => form_params,
|
7453
|
+
:body => post_body,
|
7454
|
+
:auth_names => auth_names,
|
7455
|
+
:return_type => 'CheckBoxFieldsResponse')
|
7456
|
+
if @api_client.config.debugging
|
7457
|
+
@api_client.config.logger.debug "API called: PdfApi#get_page_check_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7458
|
+
end
|
7459
|
+
return data, status_code, headers
|
7460
|
+
end
|
7461
|
+
|
7162
7462
|
# Read document page circle annotations.
|
7163
7463
|
#
|
7164
7464
|
# @param name The document name.
|
@@ -8605,6 +8905,84 @@ module AsposePdfCloud
|
|
8605
8905
|
return data, status_code, headers
|
8606
8906
|
end
|
8607
8907
|
|
8908
|
+
# Read document page radiobutton fields.
|
8909
|
+
#
|
8910
|
+
# @param name The document name.
|
8911
|
+
# @param page_number The page number.
|
8912
|
+
# @param [Hash] opts the optional parameters
|
8913
|
+
# @option opts [String] :storage The document storage.
|
8914
|
+
# @option opts [String] :folder The document folder.
|
8915
|
+
# @return [RadioButtonFieldsResponse]
|
8916
|
+
def get_page_radio_button_fields(name, page_number, opts = {})
|
8917
|
+
@api_client.request_token_if_needed
|
8918
|
+
data, _status_code, _headers = get_page_radio_button_fields_with_http_info(name, page_number, opts)
|
8919
|
+
rescue ApiError => error
|
8920
|
+
if error.code == 401
|
8921
|
+
@api_client.request_token_if_needed
|
8922
|
+
data, _status_code, _headers = get_page_radio_button_fields_with_http_info(name, page_number, opts)
|
8923
|
+
else
|
8924
|
+
raise
|
8925
|
+
end
|
8926
|
+
return data
|
8927
|
+
end
|
8928
|
+
|
8929
|
+
# Read document page radiobutton fields.
|
8930
|
+
#
|
8931
|
+
# @param name The document name.
|
8932
|
+
# @param page_number The page number.
|
8933
|
+
# @param [Hash] opts the optional parameters
|
8934
|
+
# @option opts [String] :storage The document storage.
|
8935
|
+
# @option opts [String] :folder The document folder.
|
8936
|
+
# @return [Array<(RadioButtonFieldsResponse, Fixnum, Hash)>] RadioButtonFieldsResponse data, response status code and response headers
|
8937
|
+
def get_page_radio_button_fields_with_http_info(name, page_number, opts = {})
|
8938
|
+
if @api_client.config.debugging
|
8939
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_page_radio_button_fields ..."
|
8940
|
+
end
|
8941
|
+
# verify the required parameter 'name' is set
|
8942
|
+
if @api_client.config.client_side_validation && name.nil?
|
8943
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_radio_button_fields"
|
8944
|
+
end
|
8945
|
+
# verify the required parameter 'page_number' is set
|
8946
|
+
if @api_client.config.client_side_validation && page_number.nil?
|
8947
|
+
fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_radio_button_fields"
|
8948
|
+
end
|
8949
|
+
# resource path
|
8950
|
+
local_var_path = "/pdf/{name}/page/{pageNumber}/fields/radiobutton".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
|
8951
|
+
|
8952
|
+
# query parameters
|
8953
|
+
query_params = {}
|
8954
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
8955
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
8956
|
+
|
8957
|
+
# header parameters
|
8958
|
+
header_params = {}
|
8959
|
+
# HTTP header 'Accept' (if needed)
|
8960
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8961
|
+
# HTTP header 'Content-Type'
|
8962
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8963
|
+
|
8964
|
+
# form parameters
|
8965
|
+
form_params = {}
|
8966
|
+
# Fix header in file
|
8967
|
+
post_body = nil
|
8968
|
+
|
8969
|
+
# http body (model)
|
8970
|
+
# Fix header in file
|
8971
|
+
# post_body = nil
|
8972
|
+
auth_names = ['JWT']
|
8973
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
8974
|
+
:header_params => header_params,
|
8975
|
+
:query_params => query_params,
|
8976
|
+
:form_params => form_params,
|
8977
|
+
:body => post_body,
|
8978
|
+
:auth_names => auth_names,
|
8979
|
+
:return_type => 'RadioButtonFieldsResponse')
|
8980
|
+
if @api_client.config.debugging
|
8981
|
+
@api_client.config.logger.debug "API called: PdfApi#get_page_radio_button_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8982
|
+
end
|
8983
|
+
return data, status_code, headers
|
8984
|
+
end
|
8985
|
+
|
8608
8986
|
# Read document page redaction annotations.
|
8609
8987
|
#
|
8610
8988
|
# @param name The document name.
|
@@ -11361,6 +11739,84 @@ module AsposePdfCloud
|
|
11361
11739
|
return data, status_code, headers
|
11362
11740
|
end
|
11363
11741
|
|
11742
|
+
# Read document RadioButton field by name.
|
11743
|
+
#
|
11744
|
+
# @param name The document name.
|
11745
|
+
# @param field_name The field name.
|
11746
|
+
# @param [Hash] opts the optional parameters
|
11747
|
+
# @option opts [String] :storage The document storage.
|
11748
|
+
# @option opts [String] :folder The document folder.
|
11749
|
+
# @return [RadioButtonFieldResponse]
|
11750
|
+
def get_radio_button_field(name, field_name, opts = {})
|
11751
|
+
@api_client.request_token_if_needed
|
11752
|
+
data, _status_code, _headers = get_radio_button_field_with_http_info(name, field_name, opts)
|
11753
|
+
rescue ApiError => error
|
11754
|
+
if error.code == 401
|
11755
|
+
@api_client.request_token_if_needed
|
11756
|
+
data, _status_code, _headers = get_radio_button_field_with_http_info(name, field_name, opts)
|
11757
|
+
else
|
11758
|
+
raise
|
11759
|
+
end
|
11760
|
+
return data
|
11761
|
+
end
|
11762
|
+
|
11763
|
+
# Read document RadioButton field by name.
|
11764
|
+
#
|
11765
|
+
# @param name The document name.
|
11766
|
+
# @param field_name The field name.
|
11767
|
+
# @param [Hash] opts the optional parameters
|
11768
|
+
# @option opts [String] :storage The document storage.
|
11769
|
+
# @option opts [String] :folder The document folder.
|
11770
|
+
# @return [Array<(RadioButtonFieldResponse, Fixnum, Hash)>] RadioButtonFieldResponse data, response status code and response headers
|
11771
|
+
def get_radio_button_field_with_http_info(name, field_name, opts = {})
|
11772
|
+
if @api_client.config.debugging
|
11773
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_radio_button_field ..."
|
11774
|
+
end
|
11775
|
+
# verify the required parameter 'name' is set
|
11776
|
+
if @api_client.config.client_side_validation && name.nil?
|
11777
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_radio_button_field"
|
11778
|
+
end
|
11779
|
+
# verify the required parameter 'field_name' is set
|
11780
|
+
if @api_client.config.client_side_validation && field_name.nil?
|
11781
|
+
fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_radio_button_field"
|
11782
|
+
end
|
11783
|
+
# resource path
|
11784
|
+
local_var_path = "/pdf/{name}/fields/radiobutton/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)
|
11785
|
+
|
11786
|
+
# query parameters
|
11787
|
+
query_params = {}
|
11788
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
11789
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
11790
|
+
|
11791
|
+
# header parameters
|
11792
|
+
header_params = {}
|
11793
|
+
# HTTP header 'Accept' (if needed)
|
11794
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
11795
|
+
# HTTP header 'Content-Type'
|
11796
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
11797
|
+
|
11798
|
+
# form parameters
|
11799
|
+
form_params = {}
|
11800
|
+
# Fix header in file
|
11801
|
+
post_body = nil
|
11802
|
+
|
11803
|
+
# http body (model)
|
11804
|
+
# Fix header in file
|
11805
|
+
# post_body = nil
|
11806
|
+
auth_names = ['JWT']
|
11807
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
11808
|
+
:header_params => header_params,
|
11809
|
+
:query_params => query_params,
|
11810
|
+
:form_params => form_params,
|
11811
|
+
:body => post_body,
|
11812
|
+
:auth_names => auth_names,
|
11813
|
+
:return_type => 'RadioButtonFieldResponse')
|
11814
|
+
if @api_client.config.debugging
|
11815
|
+
@api_client.config.logger.debug "API called: PdfApi#get_radio_button_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
11816
|
+
end
|
11817
|
+
return data, status_code, headers
|
11818
|
+
end
|
11819
|
+
|
11364
11820
|
# Read document page redaction annotation by ID.
|
11365
11821
|
#
|
11366
11822
|
# @param name The document name.
|
@@ -13629,8 +14085,100 @@ module AsposePdfCloud
|
|
13629
14085
|
|
13630
14086
|
# query parameters
|
13631
14087
|
query_params = {}
|
13632
|
-
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
14088
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
14089
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
14090
|
+
|
14091
|
+
# header parameters
|
14092
|
+
header_params = {}
|
14093
|
+
# HTTP header 'Accept' (if needed)
|
14094
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
14095
|
+
# HTTP header 'Content-Type'
|
14096
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
14097
|
+
|
14098
|
+
# form parameters
|
14099
|
+
form_params = {}
|
14100
|
+
# Fix header in file
|
14101
|
+
post_body = nil
|
14102
|
+
|
14103
|
+
# http body (model)
|
14104
|
+
post_body = @api_client.object_to_http_body(bookmarks)
|
14105
|
+
auth_names = ['JWT']
|
14106
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
14107
|
+
:header_params => header_params,
|
14108
|
+
:query_params => query_params,
|
14109
|
+
:form_params => form_params,
|
14110
|
+
:body => post_body,
|
14111
|
+
:auth_names => auth_names,
|
14112
|
+
:return_type => 'BookmarksResponse')
|
14113
|
+
if @api_client.config.debugging
|
14114
|
+
@api_client.config.logger.debug "API called: PdfApi#post_bookmark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
14115
|
+
end
|
14116
|
+
return data, status_code, headers
|
14117
|
+
end
|
14118
|
+
|
14119
|
+
# Change document password in storage.
|
14120
|
+
#
|
14121
|
+
# @param name Document name.
|
14122
|
+
# @param owner_password Owner password (encrypted Base64).
|
14123
|
+
# @param new_user_password New user password (encrypted Base64).
|
14124
|
+
# @param new_owner_password New owner password (encrypted Base64).
|
14125
|
+
# @param [Hash] opts the optional parameters
|
14126
|
+
# @option opts [String] :storage The document storage.
|
14127
|
+
# @option opts [String] :folder The document folder.
|
14128
|
+
# @return [AsposeResponse]
|
14129
|
+
def post_change_password_document_in_storage(name, owner_password, new_user_password, new_owner_password, opts = {})
|
14130
|
+
@api_client.request_token_if_needed
|
14131
|
+
data, _status_code, _headers = post_change_password_document_in_storage_with_http_info(name, owner_password, new_user_password, new_owner_password, opts)
|
14132
|
+
rescue ApiError => error
|
14133
|
+
if error.code == 401
|
14134
|
+
@api_client.request_token_if_needed
|
14135
|
+
data, _status_code, _headers = post_change_password_document_in_storage_with_http_info(name, owner_password, new_user_password, new_owner_password, opts)
|
14136
|
+
else
|
14137
|
+
raise
|
14138
|
+
end
|
14139
|
+
return data
|
14140
|
+
end
|
14141
|
+
|
14142
|
+
# Change document password in storage.
|
14143
|
+
#
|
14144
|
+
# @param name Document name.
|
14145
|
+
# @param owner_password Owner password (encrypted Base64).
|
14146
|
+
# @param new_user_password New user password (encrypted Base64).
|
14147
|
+
# @param new_owner_password New owner password (encrypted Base64).
|
14148
|
+
# @param [Hash] opts the optional parameters
|
14149
|
+
# @option opts [String] :storage The document storage.
|
14150
|
+
# @option opts [String] :folder The document folder.
|
14151
|
+
# @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
|
14152
|
+
def post_change_password_document_in_storage_with_http_info(name, owner_password, new_user_password, new_owner_password, opts = {})
|
14153
|
+
if @api_client.config.debugging
|
14154
|
+
@api_client.config.logger.debug "Calling API: PdfApi.post_change_password_document_in_storage ..."
|
14155
|
+
end
|
14156
|
+
# verify the required parameter 'name' is set
|
14157
|
+
if @api_client.config.client_side_validation && name.nil?
|
14158
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_change_password_document_in_storage"
|
14159
|
+
end
|
14160
|
+
# verify the required parameter 'owner_password' is set
|
14161
|
+
if @api_client.config.client_side_validation && owner_password.nil?
|
14162
|
+
fail ArgumentError, "Missing the required parameter 'owner_password' when calling PdfApi.post_change_password_document_in_storage"
|
14163
|
+
end
|
14164
|
+
# verify the required parameter 'new_user_password' is set
|
14165
|
+
if @api_client.config.client_side_validation && new_user_password.nil?
|
14166
|
+
fail ArgumentError, "Missing the required parameter 'new_user_password' when calling PdfApi.post_change_password_document_in_storage"
|
14167
|
+
end
|
14168
|
+
# verify the required parameter 'new_owner_password' is set
|
14169
|
+
if @api_client.config.client_side_validation && new_owner_password.nil?
|
14170
|
+
fail ArgumentError, "Missing the required parameter 'new_owner_password' when calling PdfApi.post_change_password_document_in_storage"
|
14171
|
+
end
|
14172
|
+
# resource path
|
14173
|
+
local_var_path = "/pdf/{name}/changepassword".sub('{' + 'name' + '}', name.to_s)
|
14174
|
+
|
14175
|
+
# query parameters
|
14176
|
+
query_params = {}
|
14177
|
+
query_params[:'ownerPassword'] = owner_password
|
14178
|
+
query_params[:'newUserPassword'] = new_user_password
|
14179
|
+
query_params[:'newOwnerPassword'] = new_owner_password
|
13633
14180
|
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
14181
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
13634
14182
|
|
13635
14183
|
# header parameters
|
13636
14184
|
header_params = {}
|
@@ -13645,7 +14193,8 @@ module AsposePdfCloud
|
|
13645
14193
|
post_body = nil
|
13646
14194
|
|
13647
14195
|
# http body (model)
|
13648
|
-
|
14196
|
+
# Fix header in file
|
14197
|
+
# post_body = nil
|
13649
14198
|
auth_names = ['JWT']
|
13650
14199
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
13651
14200
|
:header_params => header_params,
|
@@ -13653,74 +14202,59 @@ module AsposePdfCloud
|
|
13653
14202
|
:form_params => form_params,
|
13654
14203
|
:body => post_body,
|
13655
14204
|
:auth_names => auth_names,
|
13656
|
-
:return_type => '
|
14205
|
+
:return_type => 'AsposeResponse')
|
13657
14206
|
if @api_client.config.debugging
|
13658
|
-
@api_client.config.logger.debug "API called: PdfApi#
|
14207
|
+
@api_client.config.logger.debug "API called: PdfApi#post_change_password_document_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
13659
14208
|
end
|
13660
14209
|
return data, status_code, headers
|
13661
14210
|
end
|
13662
14211
|
|
13663
|
-
#
|
14212
|
+
# Add document checkbox fields.
|
13664
14213
|
#
|
13665
|
-
# @param name
|
13666
|
-
# @param
|
13667
|
-
# @param new_user_password New user password (encrypted Base64).
|
13668
|
-
# @param new_owner_password New owner password (encrypted Base64).
|
14214
|
+
# @param name The document name.
|
14215
|
+
# @param fields The array of field.
|
13669
14216
|
# @param [Hash] opts the optional parameters
|
13670
14217
|
# @option opts [String] :storage The document storage.
|
13671
14218
|
# @option opts [String] :folder The document folder.
|
13672
14219
|
# @return [AsposeResponse]
|
13673
|
-
def
|
14220
|
+
def post_check_box_fields(name, fields, opts = {})
|
13674
14221
|
@api_client.request_token_if_needed
|
13675
|
-
data, _status_code, _headers =
|
14222
|
+
data, _status_code, _headers = post_check_box_fields_with_http_info(name, fields, opts)
|
13676
14223
|
rescue ApiError => error
|
13677
14224
|
if error.code == 401
|
13678
14225
|
@api_client.request_token_if_needed
|
13679
|
-
data, _status_code, _headers =
|
14226
|
+
data, _status_code, _headers = post_check_box_fields_with_http_info(name, fields, opts)
|
13680
14227
|
else
|
13681
14228
|
raise
|
13682
14229
|
end
|
13683
14230
|
return data
|
13684
14231
|
end
|
13685
14232
|
|
13686
|
-
#
|
14233
|
+
# Add document checkbox fields.
|
13687
14234
|
#
|
13688
|
-
# @param name
|
13689
|
-
# @param
|
13690
|
-
# @param new_user_password New user password (encrypted Base64).
|
13691
|
-
# @param new_owner_password New owner password (encrypted Base64).
|
14235
|
+
# @param name The document name.
|
14236
|
+
# @param fields The array of field.
|
13692
14237
|
# @param [Hash] opts the optional parameters
|
13693
14238
|
# @option opts [String] :storage The document storage.
|
13694
14239
|
# @option opts [String] :folder The document folder.
|
13695
14240
|
# @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
|
13696
|
-
def
|
14241
|
+
def post_check_box_fields_with_http_info(name, fields, opts = {})
|
13697
14242
|
if @api_client.config.debugging
|
13698
|
-
@api_client.config.logger.debug "Calling API: PdfApi.
|
14243
|
+
@api_client.config.logger.debug "Calling API: PdfApi.post_check_box_fields ..."
|
13699
14244
|
end
|
13700
14245
|
# verify the required parameter 'name' is set
|
13701
14246
|
if @api_client.config.client_side_validation && name.nil?
|
13702
|
-
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.
|
13703
|
-
end
|
13704
|
-
# verify the required parameter 'owner_password' is set
|
13705
|
-
if @api_client.config.client_side_validation && owner_password.nil?
|
13706
|
-
fail ArgumentError, "Missing the required parameter 'owner_password' when calling PdfApi.post_change_password_document_in_storage"
|
13707
|
-
end
|
13708
|
-
# verify the required parameter 'new_user_password' is set
|
13709
|
-
if @api_client.config.client_side_validation && new_user_password.nil?
|
13710
|
-
fail ArgumentError, "Missing the required parameter 'new_user_password' when calling PdfApi.post_change_password_document_in_storage"
|
14247
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_check_box_fields"
|
13711
14248
|
end
|
13712
|
-
# verify the required parameter '
|
13713
|
-
if @api_client.config.client_side_validation &&
|
13714
|
-
fail ArgumentError, "Missing the required parameter '
|
14249
|
+
# verify the required parameter 'fields' is set
|
14250
|
+
if @api_client.config.client_side_validation && fields.nil?
|
14251
|
+
fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.post_check_box_fields"
|
13715
14252
|
end
|
13716
14253
|
# resource path
|
13717
|
-
local_var_path = "/pdf/{name}/
|
14254
|
+
local_var_path = "/pdf/{name}/fields/checkbox".sub('{' + 'name' + '}', name.to_s)
|
13718
14255
|
|
13719
14256
|
# query parameters
|
13720
14257
|
query_params = {}
|
13721
|
-
query_params[:'ownerPassword'] = owner_password
|
13722
|
-
query_params[:'newUserPassword'] = new_user_password
|
13723
|
-
query_params[:'newOwnerPassword'] = new_owner_password
|
13724
14258
|
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
13725
14259
|
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
13726
14260
|
|
@@ -13737,8 +14271,7 @@ module AsposePdfCloud
|
|
13737
14271
|
post_body = nil
|
13738
14272
|
|
13739
14273
|
# http body (model)
|
13740
|
-
|
13741
|
-
# post_body = nil
|
14274
|
+
post_body = @api_client.object_to_http_body(fields)
|
13742
14275
|
auth_names = ['JWT']
|
13743
14276
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
13744
14277
|
:header_params => header_params,
|
@@ -13748,7 +14281,7 @@ module AsposePdfCloud
|
|
13748
14281
|
:auth_names => auth_names,
|
13749
14282
|
:return_type => 'AsposeResponse')
|
13750
14283
|
if @api_client.config.debugging
|
13751
|
-
@api_client.config.logger.debug "API called: PdfApi#
|
14284
|
+
@api_client.config.logger.debug "API called: PdfApi#post_check_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
13752
14285
|
end
|
13753
14286
|
return data, status_code, headers
|
13754
14287
|
end
|
@@ -17347,6 +17880,83 @@ module AsposePdfCloud
|
|
17347
17880
|
return data, status_code, headers
|
17348
17881
|
end
|
17349
17882
|
|
17883
|
+
# Add document RadioButton fields.
|
17884
|
+
#
|
17885
|
+
# @param name The document name.
|
17886
|
+
# @param fields The array of field.
|
17887
|
+
# @param [Hash] opts the optional parameters
|
17888
|
+
# @option opts [String] :storage The document storage.
|
17889
|
+
# @option opts [String] :folder The document folder.
|
17890
|
+
# @return [AsposeResponse]
|
17891
|
+
def post_radio_button_fields(name, fields, opts = {})
|
17892
|
+
@api_client.request_token_if_needed
|
17893
|
+
data, _status_code, _headers = post_radio_button_fields_with_http_info(name, fields, opts)
|
17894
|
+
rescue ApiError => error
|
17895
|
+
if error.code == 401
|
17896
|
+
@api_client.request_token_if_needed
|
17897
|
+
data, _status_code, _headers = post_radio_button_fields_with_http_info(name, fields, opts)
|
17898
|
+
else
|
17899
|
+
raise
|
17900
|
+
end
|
17901
|
+
return data
|
17902
|
+
end
|
17903
|
+
|
17904
|
+
# Add document RadioButton fields.
|
17905
|
+
#
|
17906
|
+
# @param name The document name.
|
17907
|
+
# @param fields The array of field.
|
17908
|
+
# @param [Hash] opts the optional parameters
|
17909
|
+
# @option opts [String] :storage The document storage.
|
17910
|
+
# @option opts [String] :folder The document folder.
|
17911
|
+
# @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
|
17912
|
+
def post_radio_button_fields_with_http_info(name, fields, opts = {})
|
17913
|
+
if @api_client.config.debugging
|
17914
|
+
@api_client.config.logger.debug "Calling API: PdfApi.post_radio_button_fields ..."
|
17915
|
+
end
|
17916
|
+
# verify the required parameter 'name' is set
|
17917
|
+
if @api_client.config.client_side_validation && name.nil?
|
17918
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_radio_button_fields"
|
17919
|
+
end
|
17920
|
+
# verify the required parameter 'fields' is set
|
17921
|
+
if @api_client.config.client_side_validation && fields.nil?
|
17922
|
+
fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.post_radio_button_fields"
|
17923
|
+
end
|
17924
|
+
# resource path
|
17925
|
+
local_var_path = "/pdf/{name}/fields/radiobutton".sub('{' + 'name' + '}', name.to_s)
|
17926
|
+
|
17927
|
+
# query parameters
|
17928
|
+
query_params = {}
|
17929
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
17930
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
17931
|
+
|
17932
|
+
# header parameters
|
17933
|
+
header_params = {}
|
17934
|
+
# HTTP header 'Accept' (if needed)
|
17935
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
17936
|
+
# HTTP header 'Content-Type'
|
17937
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
17938
|
+
|
17939
|
+
# form parameters
|
17940
|
+
form_params = {}
|
17941
|
+
# Fix header in file
|
17942
|
+
post_body = nil
|
17943
|
+
|
17944
|
+
# http body (model)
|
17945
|
+
post_body = @api_client.object_to_http_body(fields)
|
17946
|
+
auth_names = ['JWT']
|
17947
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
17948
|
+
:header_params => header_params,
|
17949
|
+
:query_params => query_params,
|
17950
|
+
:form_params => form_params,
|
17951
|
+
:body => post_body,
|
17952
|
+
:auth_names => auth_names,
|
17953
|
+
:return_type => 'AsposeResponse')
|
17954
|
+
if @api_client.config.debugging
|
17955
|
+
@api_client.config.logger.debug "API called: PdfApi#post_radio_button_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
17956
|
+
end
|
17957
|
+
return data, status_code, headers
|
17958
|
+
end
|
17959
|
+
|
17350
17960
|
# Sign document.
|
17351
17961
|
#
|
17352
17962
|
# @param name The document name.
|
@@ -18162,6 +18772,89 @@ module AsposePdfCloud
|
|
18162
18772
|
return data, status_code, headers
|
18163
18773
|
end
|
18164
18774
|
|
18775
|
+
# Replace document checkbox field
|
18776
|
+
#
|
18777
|
+
# @param name The document name.
|
18778
|
+
# @param field_name The field name.
|
18779
|
+
# @param field The field.
|
18780
|
+
# @param [Hash] opts the optional parameters
|
18781
|
+
# @option opts [String] :storage The document storage.
|
18782
|
+
# @option opts [String] :folder The document folder.
|
18783
|
+
# @return [CheckBoxFieldResponse]
|
18784
|
+
def put_check_box_field(name, field_name, field, opts = {})
|
18785
|
+
@api_client.request_token_if_needed
|
18786
|
+
data, _status_code, _headers = put_check_box_field_with_http_info(name, field_name, field, opts)
|
18787
|
+
rescue ApiError => error
|
18788
|
+
if error.code == 401
|
18789
|
+
@api_client.request_token_if_needed
|
18790
|
+
data, _status_code, _headers = put_check_box_field_with_http_info(name, field_name, field, opts)
|
18791
|
+
else
|
18792
|
+
raise
|
18793
|
+
end
|
18794
|
+
return data
|
18795
|
+
end
|
18796
|
+
|
18797
|
+
# Replace document checkbox field
|
18798
|
+
#
|
18799
|
+
# @param name The document name.
|
18800
|
+
# @param field_name The field name.
|
18801
|
+
# @param field The field.
|
18802
|
+
# @param [Hash] opts the optional parameters
|
18803
|
+
# @option opts [String] :storage The document storage.
|
18804
|
+
# @option opts [String] :folder The document folder.
|
18805
|
+
# @return [Array<(CheckBoxFieldResponse, Fixnum, Hash)>] CheckBoxFieldResponse data, response status code and response headers
|
18806
|
+
def put_check_box_field_with_http_info(name, field_name, field, opts = {})
|
18807
|
+
if @api_client.config.debugging
|
18808
|
+
@api_client.config.logger.debug "Calling API: PdfApi.put_check_box_field ..."
|
18809
|
+
end
|
18810
|
+
# verify the required parameter 'name' is set
|
18811
|
+
if @api_client.config.client_side_validation && name.nil?
|
18812
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_check_box_field"
|
18813
|
+
end
|
18814
|
+
# verify the required parameter 'field_name' is set
|
18815
|
+
if @api_client.config.client_side_validation && field_name.nil?
|
18816
|
+
fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_check_box_field"
|
18817
|
+
end
|
18818
|
+
# verify the required parameter 'field' is set
|
18819
|
+
if @api_client.config.client_side_validation && field.nil?
|
18820
|
+
fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_check_box_field"
|
18821
|
+
end
|
18822
|
+
# resource path
|
18823
|
+
local_var_path = "/pdf/{name}/fields/checkbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)
|
18824
|
+
|
18825
|
+
# query parameters
|
18826
|
+
query_params = {}
|
18827
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
18828
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
18829
|
+
|
18830
|
+
# header parameters
|
18831
|
+
header_params = {}
|
18832
|
+
# HTTP header 'Accept' (if needed)
|
18833
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
18834
|
+
# HTTP header 'Content-Type'
|
18835
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
18836
|
+
|
18837
|
+
# form parameters
|
18838
|
+
form_params = {}
|
18839
|
+
# Fix header in file
|
18840
|
+
post_body = nil
|
18841
|
+
|
18842
|
+
# http body (model)
|
18843
|
+
post_body = @api_client.object_to_http_body(field)
|
18844
|
+
auth_names = ['JWT']
|
18845
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
18846
|
+
:header_params => header_params,
|
18847
|
+
:query_params => query_params,
|
18848
|
+
:form_params => form_params,
|
18849
|
+
:body => post_body,
|
18850
|
+
:auth_names => auth_names,
|
18851
|
+
:return_type => 'CheckBoxFieldResponse')
|
18852
|
+
if @api_client.config.debugging
|
18853
|
+
@api_client.config.logger.debug "API called: PdfApi#put_check_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
18854
|
+
end
|
18855
|
+
return data, status_code, headers
|
18856
|
+
end
|
18857
|
+
|
18165
18858
|
# Replace document circle annotation
|
18166
18859
|
#
|
18167
18860
|
# @param name The document name.
|
@@ -24566,6 +25259,89 @@ module AsposePdfCloud
|
|
24566
25259
|
return data, status_code, headers
|
24567
25260
|
end
|
24568
25261
|
|
25262
|
+
# Replace document RadioButton field
|
25263
|
+
#
|
25264
|
+
# @param name The document name.
|
25265
|
+
# @param field_name The field name.
|
25266
|
+
# @param field The field.
|
25267
|
+
# @param [Hash] opts the optional parameters
|
25268
|
+
# @option opts [String] :storage The document storage.
|
25269
|
+
# @option opts [String] :folder The document folder.
|
25270
|
+
# @return [RadioButtonFieldResponse]
|
25271
|
+
def put_radio_button_field(name, field_name, field, opts = {})
|
25272
|
+
@api_client.request_token_if_needed
|
25273
|
+
data, _status_code, _headers = put_radio_button_field_with_http_info(name, field_name, field, opts)
|
25274
|
+
rescue ApiError => error
|
25275
|
+
if error.code == 401
|
25276
|
+
@api_client.request_token_if_needed
|
25277
|
+
data, _status_code, _headers = put_radio_button_field_with_http_info(name, field_name, field, opts)
|
25278
|
+
else
|
25279
|
+
raise
|
25280
|
+
end
|
25281
|
+
return data
|
25282
|
+
end
|
25283
|
+
|
25284
|
+
# Replace document RadioButton field
|
25285
|
+
#
|
25286
|
+
# @param name The document name.
|
25287
|
+
# @param field_name The field name.
|
25288
|
+
# @param field The field.
|
25289
|
+
# @param [Hash] opts the optional parameters
|
25290
|
+
# @option opts [String] :storage The document storage.
|
25291
|
+
# @option opts [String] :folder The document folder.
|
25292
|
+
# @return [Array<(RadioButtonFieldResponse, Fixnum, Hash)>] RadioButtonFieldResponse data, response status code and response headers
|
25293
|
+
def put_radio_button_field_with_http_info(name, field_name, field, opts = {})
|
25294
|
+
if @api_client.config.debugging
|
25295
|
+
@api_client.config.logger.debug "Calling API: PdfApi.put_radio_button_field ..."
|
25296
|
+
end
|
25297
|
+
# verify the required parameter 'name' is set
|
25298
|
+
if @api_client.config.client_side_validation && name.nil?
|
25299
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_radio_button_field"
|
25300
|
+
end
|
25301
|
+
# verify the required parameter 'field_name' is set
|
25302
|
+
if @api_client.config.client_side_validation && field_name.nil?
|
25303
|
+
fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_radio_button_field"
|
25304
|
+
end
|
25305
|
+
# verify the required parameter 'field' is set
|
25306
|
+
if @api_client.config.client_side_validation && field.nil?
|
25307
|
+
fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_radio_button_field"
|
25308
|
+
end
|
25309
|
+
# resource path
|
25310
|
+
local_var_path = "/pdf/{name}/fields/radiobutton/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)
|
25311
|
+
|
25312
|
+
# query parameters
|
25313
|
+
query_params = {}
|
25314
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
25315
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
25316
|
+
|
25317
|
+
# header parameters
|
25318
|
+
header_params = {}
|
25319
|
+
# HTTP header 'Accept' (if needed)
|
25320
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
25321
|
+
# HTTP header 'Content-Type'
|
25322
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
25323
|
+
|
25324
|
+
# form parameters
|
25325
|
+
form_params = {}
|
25326
|
+
# Fix header in file
|
25327
|
+
post_body = nil
|
25328
|
+
|
25329
|
+
# http body (model)
|
25330
|
+
post_body = @api_client.object_to_http_body(field)
|
25331
|
+
auth_names = ['JWT']
|
25332
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
25333
|
+
:header_params => header_params,
|
25334
|
+
:query_params => query_params,
|
25335
|
+
:form_params => form_params,
|
25336
|
+
:body => post_body,
|
25337
|
+
:auth_names => auth_names,
|
25338
|
+
:return_type => 'RadioButtonFieldResponse')
|
25339
|
+
if @api_client.config.debugging
|
25340
|
+
@api_client.config.logger.debug "API called: PdfApi#put_radio_button_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
25341
|
+
end
|
25342
|
+
return data, status_code, headers
|
25343
|
+
end
|
25344
|
+
|
24569
25345
|
# Replace document redaction annotation
|
24570
25346
|
#
|
24571
25347
|
# @param name The document name.
|