groupdocs-conversion-cloud 25.5__py3-none-any.whl → 25.8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -45,35 +45,65 @@ class PdfLoadOptions(LoadOptions):
45
45
  and the value is json key in definition.
46
46
  """
47
47
  swagger_types = {
48
- 'remove_embedded_files': 'bool',
49
- 'password': 'str',
48
+ 'clear_built_in_document_properties': 'bool',
49
+ 'clear_custom_document_properties': 'bool',
50
+ 'page_numbering': 'bool',
51
+ 'flatten_all_fields': 'bool',
50
52
  'hide_pdf_annotations': 'bool',
51
- 'flatten_all_fields': 'bool'
53
+ 'default_font': 'str',
54
+ 'password': 'str',
55
+ 'remove_javascript': 'bool',
56
+ 'remove_embedded_files': 'bool',
57
+ 'font_substitutes': 'dict(str, str)'
52
58
  }
53
59
 
54
60
  attribute_map = {
55
- 'remove_embedded_files': 'RemoveEmbeddedFiles',
56
- 'password': 'Password',
61
+ 'clear_built_in_document_properties': 'ClearBuiltInDocumentProperties',
62
+ 'clear_custom_document_properties': 'ClearCustomDocumentProperties',
63
+ 'page_numbering': 'PageNumbering',
64
+ 'flatten_all_fields': 'FlattenAllFields',
57
65
  'hide_pdf_annotations': 'HidePdfAnnotations',
58
- 'flatten_all_fields': 'FlattenAllFields'
66
+ 'default_font': 'DefaultFont',
67
+ 'password': 'Password',
68
+ 'remove_javascript': 'RemoveJavascript',
69
+ 'remove_embedded_files': 'RemoveEmbeddedFiles',
70
+ 'font_substitutes': 'FontSubstitutes'
59
71
  }
60
72
 
61
- def __init__(self, remove_embedded_files=None, password=None, hide_pdf_annotations=None, flatten_all_fields=None, **kwargs): # noqa: E501
73
+ def __init__(self, clear_built_in_document_properties=None, clear_custom_document_properties=None, page_numbering=None, flatten_all_fields=None, hide_pdf_annotations=None, default_font=None, password=None, remove_javascript=None, remove_embedded_files=None, font_substitutes=None, **kwargs): # noqa: E501
62
74
  """Initializes new instance of PdfLoadOptions""" # noqa: E501
63
75
 
64
- self._remove_embedded_files = None
65
- self._password = None
66
- self._hide_pdf_annotations = None
76
+ self._clear_built_in_document_properties = None
77
+ self._clear_custom_document_properties = None
78
+ self._page_numbering = None
67
79
  self._flatten_all_fields = None
68
-
69
- if remove_embedded_files is not None:
70
- self.remove_embedded_files = remove_embedded_files
71
- if password is not None:
72
- self.password = password
73
- if hide_pdf_annotations is not None:
74
- self.hide_pdf_annotations = hide_pdf_annotations
80
+ self._hide_pdf_annotations = None
81
+ self._default_font = None
82
+ self._password = None
83
+ self._remove_javascript = None
84
+ self._remove_embedded_files = None
85
+ self._font_substitutes = None
86
+
87
+ if clear_built_in_document_properties is not None:
88
+ self.clear_built_in_document_properties = clear_built_in_document_properties
89
+ if clear_custom_document_properties is not None:
90
+ self.clear_custom_document_properties = clear_custom_document_properties
91
+ if page_numbering is not None:
92
+ self.page_numbering = page_numbering
75
93
  if flatten_all_fields is not None:
76
94
  self.flatten_all_fields = flatten_all_fields
95
+ if hide_pdf_annotations is not None:
96
+ self.hide_pdf_annotations = hide_pdf_annotations
97
+ if default_font is not None:
98
+ self.default_font = default_font
99
+ if password is not None:
100
+ self.password = password
101
+ if remove_javascript is not None:
102
+ self.remove_javascript = remove_javascript
103
+ if remove_embedded_files is not None:
104
+ self.remove_embedded_files = remove_embedded_files
105
+ if font_substitutes is not None:
106
+ self.font_substitutes = font_substitutes
77
107
 
78
108
  base = super(PdfLoadOptions, self)
79
109
  base.__init__(**kwargs)
@@ -82,80 +112,82 @@ class PdfLoadOptions(LoadOptions):
82
112
  self.attribute_map.update(base.attribute_map)
83
113
 
84
114
  @property
85
- def remove_embedded_files(self):
115
+ def clear_built_in_document_properties(self):
86
116
  """
87
- Gets the remove_embedded_files. # noqa: E501
117
+ Gets the clear_built_in_document_properties. # noqa: E501
88
118
 
89
- Remove embedded files # noqa: E501
119
+ Clear built-in document properties # noqa: E501
90
120
 
91
- :return: The remove_embedded_files. # noqa: E501
121
+ :return: The clear_built_in_document_properties. # noqa: E501
92
122
  :rtype: bool
93
123
  """
94
- return self._remove_embedded_files
124
+ return self._clear_built_in_document_properties
95
125
 
96
- @remove_embedded_files.setter
97
- def remove_embedded_files(self, remove_embedded_files):
126
+ @clear_built_in_document_properties.setter
127
+ def clear_built_in_document_properties(self, clear_built_in_document_properties):
98
128
  """
99
- Sets the remove_embedded_files.
129
+ Sets the clear_built_in_document_properties.
100
130
 
101
- Remove embedded files # noqa: E501
131
+ Clear built-in document properties # noqa: E501
102
132
 
103
- :param remove_embedded_files: The remove_embedded_files. # noqa: E501
133
+ :param clear_built_in_document_properties: The clear_built_in_document_properties. # noqa: E501
104
134
  :type: bool
105
135
  """
106
- if remove_embedded_files is None:
107
- raise ValueError("Invalid value for `remove_embedded_files`, must not be `None`") # noqa: E501
108
- self._remove_embedded_files = remove_embedded_files
136
+ if clear_built_in_document_properties is None:
137
+ raise ValueError("Invalid value for `clear_built_in_document_properties`, must not be `None`") # noqa: E501
138
+ self._clear_built_in_document_properties = clear_built_in_document_properties
109
139
 
110
140
  @property
111
- def password(self):
141
+ def clear_custom_document_properties(self):
112
142
  """
113
- Gets the password. # noqa: E501
143
+ Gets the clear_custom_document_properties. # noqa: E501
114
144
 
115
- Set password to unprotect protected document # noqa: E501
145
+ Clear custom document properties # noqa: E501
116
146
 
117
- :return: The password. # noqa: E501
118
- :rtype: str
147
+ :return: The clear_custom_document_properties. # noqa: E501
148
+ :rtype: bool
119
149
  """
120
- return self._password
150
+ return self._clear_custom_document_properties
121
151
 
122
- @password.setter
123
- def password(self, password):
152
+ @clear_custom_document_properties.setter
153
+ def clear_custom_document_properties(self, clear_custom_document_properties):
124
154
  """
125
- Sets the password.
155
+ Sets the clear_custom_document_properties.
126
156
 
127
- Set password to unprotect protected document # noqa: E501
157
+ Clear custom document properties # noqa: E501
128
158
 
129
- :param password: The password. # noqa: E501
130
- :type: str
159
+ :param clear_custom_document_properties: The clear_custom_document_properties. # noqa: E501
160
+ :type: bool
131
161
  """
132
- self._password = password
162
+ if clear_custom_document_properties is None:
163
+ raise ValueError("Invalid value for `clear_custom_document_properties`, must not be `None`") # noqa: E501
164
+ self._clear_custom_document_properties = clear_custom_document_properties
133
165
 
134
166
  @property
135
- def hide_pdf_annotations(self):
167
+ def page_numbering(self):
136
168
  """
137
- Gets the hide_pdf_annotations. # noqa: E501
169
+ Gets the page_numbering. # noqa: E501
138
170
 
139
- Hide annotations in Pdf documents # noqa: E501
171
+ Enable or disable generation of page numbering in converted document. Default: false # noqa: E501
140
172
 
141
- :return: The hide_pdf_annotations. # noqa: E501
173
+ :return: The page_numbering. # noqa: E501
142
174
  :rtype: bool
143
175
  """
144
- return self._hide_pdf_annotations
176
+ return self._page_numbering
145
177
 
146
- @hide_pdf_annotations.setter
147
- def hide_pdf_annotations(self, hide_pdf_annotations):
178
+ @page_numbering.setter
179
+ def page_numbering(self, page_numbering):
148
180
  """
149
- Sets the hide_pdf_annotations.
181
+ Sets the page_numbering.
150
182
 
151
- Hide annotations in Pdf documents # noqa: E501
183
+ Enable or disable generation of page numbering in converted document. Default: false # noqa: E501
152
184
 
153
- :param hide_pdf_annotations: The hide_pdf_annotations. # noqa: E501
185
+ :param page_numbering: The page_numbering. # noqa: E501
154
186
  :type: bool
155
187
  """
156
- if hide_pdf_annotations is None:
157
- raise ValueError("Invalid value for `hide_pdf_annotations`, must not be `None`") # noqa: E501
158
- self._hide_pdf_annotations = hide_pdf_annotations
188
+ if page_numbering is None:
189
+ raise ValueError("Invalid value for `page_numbering`, must not be `None`") # noqa: E501
190
+ self._page_numbering = page_numbering
159
191
 
160
192
  @property
161
193
  def flatten_all_fields(self):
@@ -182,6 +214,156 @@ class PdfLoadOptions(LoadOptions):
182
214
  if flatten_all_fields is None:
183
215
  raise ValueError("Invalid value for `flatten_all_fields`, must not be `None`") # noqa: E501
184
216
  self._flatten_all_fields = flatten_all_fields
217
+
218
+ @property
219
+ def hide_pdf_annotations(self):
220
+ """
221
+ Gets the hide_pdf_annotations. # noqa: E501
222
+
223
+ Hide annotations in Pdf documents # noqa: E501
224
+
225
+ :return: The hide_pdf_annotations. # noqa: E501
226
+ :rtype: bool
227
+ """
228
+ return self._hide_pdf_annotations
229
+
230
+ @hide_pdf_annotations.setter
231
+ def hide_pdf_annotations(self, hide_pdf_annotations):
232
+ """
233
+ Sets the hide_pdf_annotations.
234
+
235
+ Hide annotations in Pdf documents # noqa: E501
236
+
237
+ :param hide_pdf_annotations: The hide_pdf_annotations. # noqa: E501
238
+ :type: bool
239
+ """
240
+ if hide_pdf_annotations is None:
241
+ raise ValueError("Invalid value for `hide_pdf_annotations`, must not be `None`") # noqa: E501
242
+ self._hide_pdf_annotations = hide_pdf_annotations
243
+
244
+ @property
245
+ def default_font(self):
246
+ """
247
+ Gets the default_font. # noqa: E501
248
+
249
+ Default font for Pdf document. The following font will be used if a font is missing. # noqa: E501
250
+
251
+ :return: The default_font. # noqa: E501
252
+ :rtype: str
253
+ """
254
+ return self._default_font
255
+
256
+ @default_font.setter
257
+ def default_font(self, default_font):
258
+ """
259
+ Sets the default_font.
260
+
261
+ Default font for Pdf document. The following font will be used if a font is missing. # noqa: E501
262
+
263
+ :param default_font: The default_font. # noqa: E501
264
+ :type: str
265
+ """
266
+ self._default_font = default_font
267
+
268
+ @property
269
+ def password(self):
270
+ """
271
+ Gets the password. # noqa: E501
272
+
273
+ Set password to unprotect protected document # noqa: E501
274
+
275
+ :return: The password. # noqa: E501
276
+ :rtype: str
277
+ """
278
+ return self._password
279
+
280
+ @password.setter
281
+ def password(self, password):
282
+ """
283
+ Sets the password.
284
+
285
+ Set password to unprotect protected document # noqa: E501
286
+
287
+ :param password: The password. # noqa: E501
288
+ :type: str
289
+ """
290
+ self._password = password
291
+
292
+ @property
293
+ def remove_javascript(self):
294
+ """
295
+ Gets the remove_javascript. # noqa: E501
296
+
297
+ Remove javascript # noqa: E501
298
+
299
+ :return: The remove_javascript. # noqa: E501
300
+ :rtype: bool
301
+ """
302
+ return self._remove_javascript
303
+
304
+ @remove_javascript.setter
305
+ def remove_javascript(self, remove_javascript):
306
+ """
307
+ Sets the remove_javascript.
308
+
309
+ Remove javascript # noqa: E501
310
+
311
+ :param remove_javascript: The remove_javascript. # noqa: E501
312
+ :type: bool
313
+ """
314
+ if remove_javascript is None:
315
+ raise ValueError("Invalid value for `remove_javascript`, must not be `None`") # noqa: E501
316
+ self._remove_javascript = remove_javascript
317
+
318
+ @property
319
+ def remove_embedded_files(self):
320
+ """
321
+ Gets the remove_embedded_files. # noqa: E501
322
+
323
+ Remove embedded files # noqa: E501
324
+
325
+ :return: The remove_embedded_files. # noqa: E501
326
+ :rtype: bool
327
+ """
328
+ return self._remove_embedded_files
329
+
330
+ @remove_embedded_files.setter
331
+ def remove_embedded_files(self, remove_embedded_files):
332
+ """
333
+ Sets the remove_embedded_files.
334
+
335
+ Remove embedded files # noqa: E501
336
+
337
+ :param remove_embedded_files: The remove_embedded_files. # noqa: E501
338
+ :type: bool
339
+ """
340
+ if remove_embedded_files is None:
341
+ raise ValueError("Invalid value for `remove_embedded_files`, must not be `None`") # noqa: E501
342
+ self._remove_embedded_files = remove_embedded_files
343
+
344
+ @property
345
+ def font_substitutes(self):
346
+ """
347
+ Gets the font_substitutes. # noqa: E501
348
+
349
+ Substitute specific fonts when converting Words document. # noqa: E501
350
+
351
+ :return: The font_substitutes. # noqa: E501
352
+ :rtype: dict(str, str)
353
+ """
354
+ return self._font_substitutes
355
+
356
+ @font_substitutes.setter
357
+ def font_substitutes(self, font_substitutes):
358
+ """
359
+ Sets the font_substitutes.
360
+
361
+ Substitute specific fonts when converting Words document. # noqa: E501
362
+
363
+ :param font_substitutes: The font_substitutes. # noqa: E501
364
+ :type: dict(str, str)
365
+ """
366
+ self._font_substitutes = font_substitutes
185
367
 
186
368
  def to_dict(self):
187
369
  """Returns the model properties as a dict"""
@@ -204,7 +204,7 @@ class PresentationLoadOptions(LoadOptions):
204
204
  """
205
205
  Gets the depth. # noqa: E501
206
206
 
207
- Implements GroupDocs.Conversion.Contracts.IDocumentsContainerLoadOptions.Depth Default: 1 # noqa: E501
207
+ Option to control how many levels in depth to perform conversion Default: 1 # noqa: E501
208
208
 
209
209
  :return: The depth. # noqa: E501
210
210
  :rtype: int
@@ -216,7 +216,7 @@ class PresentationLoadOptions(LoadOptions):
216
216
  """
217
217
  Sets the depth.
218
218
 
219
- Implements GroupDocs.Conversion.Contracts.IDocumentsContainerLoadOptions.Depth Default: 1 # noqa: E501
219
+ Option to control how many levels in depth to perform conversion Default: 1 # noqa: E501
220
220
 
221
221
  :param depth: The depth. # noqa: E501
222
222
  :type: int
@@ -230,7 +230,7 @@ class PresentationLoadOptions(LoadOptions):
230
230
  """
231
231
  Gets the convert_owned. # noqa: E501
232
232
 
233
- Implements GroupDocs.Conversion.Contracts.IDocumentsContainerLoadOptions.ConvertOwned Default is false # noqa: E501
233
+ Option to control whether the owned documents in the documents container must be converted # noqa: E501
234
234
 
235
235
  :return: The convert_owned. # noqa: E501
236
236
  :rtype: bool
@@ -242,7 +242,7 @@ class PresentationLoadOptions(LoadOptions):
242
242
  """
243
243
  Sets the convert_owned.
244
244
 
245
- Implements GroupDocs.Conversion.Contracts.IDocumentsContainerLoadOptions.ConvertOwned Default is false # noqa: E501
245
+ Option to control whether the owned documents in the documents container must be converted # noqa: E501
246
246
 
247
247
  :param convert_owned: The convert_owned. # noqa: E501
248
248
  :type: bool
@@ -256,7 +256,7 @@ class PresentationLoadOptions(LoadOptions):
256
256
  """
257
257
  Gets the convert_owner. # noqa: E501
258
258
 
259
- Implements GroupDocs.Conversion.Contracts.IDocumentsContainerLoadOptions.ConvertOwner Default is true # noqa: E501
259
+ Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document Default is true # noqa: E501
260
260
 
261
261
  :return: The convert_owner. # noqa: E501
262
262
  :rtype: bool
@@ -268,7 +268,7 @@ class PresentationLoadOptions(LoadOptions):
268
268
  """
269
269
  Sets the convert_owner.
270
270
 
271
- Implements GroupDocs.Conversion.Contracts.IDocumentsContainerLoadOptions.ConvertOwner Default is true # noqa: E501
271
+ Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document Default is true # noqa: E501
272
272
 
273
273
  :param convert_owner: The convert_owner. # noqa: E501
274
274
  :type: bool