fds.sdk.VectorData 0.0.1__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.
- fds/__init__.py +0 -0
- fds/sdk/VectorData/__init__.py +28 -0
- fds/sdk/VectorData/api/__init__.py +3 -0
- fds/sdk/VectorData/api/meta_api.py +959 -0
- fds/sdk/VectorData/api/vector_api.py +564 -0
- fds/sdk/VectorData/api_client.py +939 -0
- fds/sdk/VectorData/apis/__init__.py +18 -0
- fds/sdk/VectorData/configuration.py +496 -0
- fds/sdk/VectorData/exceptions.py +160 -0
- fds/sdk/VectorData/model/__init__.py +5 -0
- fds/sdk/VectorData/model/chunk_text_response.py +268 -0
- fds/sdk/VectorData/model/chunk_text_response_meta.py +262 -0
- fds/sdk/VectorData/model/chunk_text_response_meta_pagination.py +260 -0
- fds/sdk/VectorData/model/chunk_text_result.py +284 -0
- fds/sdk/VectorData/model/document_types.py +268 -0
- fds/sdk/VectorData/model/document_types_response.py +262 -0
- fds/sdk/VectorData/model/error_object.py +268 -0
- fds/sdk/VectorData/model/error_response.py +262 -0
- fds/sdk/VectorData/model/meta.py +260 -0
- fds/sdk/VectorData/model/schemas.py +274 -0
- fds/sdk/VectorData/model/schemas_response.py +262 -0
- fds/sdk/VectorData/model/source.py +268 -0
- fds/sdk/VectorData/model/source_response.py +262 -0
- fds/sdk/VectorData/model/themes.py +274 -0
- fds/sdk/VectorData/model/themes_response.py +262 -0
- fds/sdk/VectorData/model/vector_data_request.py +274 -0
- fds/sdk/VectorData/model/vector_data_request_data.py +313 -0
- fds/sdk/VectorData/model/vector_data_response.py +268 -0
- fds/sdk/VectorData/model/vector_data_response_meta.py +256 -0
- fds/sdk/VectorData/model/vector_data_result.py +296 -0
- fds/sdk/VectorData/model_utils.py +2062 -0
- fds/sdk/VectorData/models/__init__.py +31 -0
- fds/sdk/VectorData/rest.py +347 -0
- fds/sdk/__init__.py +0 -0
- fds_sdk_vectordata-0.0.1.dist-info/METADATA +349 -0
- fds_sdk_vectordata-0.0.1.dist-info/RECORD +39 -0
- fds_sdk_vectordata-0.0.1.dist-info/WHEEL +5 -0
- fds_sdk_vectordata-0.0.1.dist-info/licenses/LICENSE +202 -0
- fds_sdk_vectordata-0.0.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,959 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Vector Data API
|
|
3
|
+
|
|
4
|
+
The Vector Data API provides streamlined access to vector data through its defined endpoints. It supports functionalities such as: Retrieving detailed vector data based on user-defined parameters. Efficiently processing associated text data for enhanced performance. This API is designed to enable developers to integrate vector data into their applications, ensuring flexibility and performance while leveraging the specified endpoint functionalities. # noqa: E501
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 0.0.0
|
|
7
|
+
Contact: api@factset.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
import re # noqa: F401
|
|
13
|
+
import sys # noqa: F401
|
|
14
|
+
from multiprocessing.pool import ApplyResult
|
|
15
|
+
import typing
|
|
16
|
+
|
|
17
|
+
from fds.sdk.VectorData.api_client import ApiClient, Endpoint as _Endpoint
|
|
18
|
+
from fds.sdk.VectorData.model_utils import ( # noqa: F401
|
|
19
|
+
check_allowed_values,
|
|
20
|
+
check_validations,
|
|
21
|
+
date,
|
|
22
|
+
datetime,
|
|
23
|
+
file_type,
|
|
24
|
+
none_type,
|
|
25
|
+
validate_and_convert_types
|
|
26
|
+
)
|
|
27
|
+
from fds.sdk.VectorData.exceptions import ApiException
|
|
28
|
+
from fds.sdk.VectorData.model.document_types_response import DocumentTypesResponse
|
|
29
|
+
from fds.sdk.VectorData.model.error_response import ErrorResponse
|
|
30
|
+
from fds.sdk.VectorData.model.schemas_response import SchemasResponse
|
|
31
|
+
from fds.sdk.VectorData.model.source_response import SourceResponse
|
|
32
|
+
from fds.sdk.VectorData.model.themes_response import ThemesResponse
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
class MetaApi(object):
|
|
39
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
40
|
+
Ref: https://openapi-generator.tech
|
|
41
|
+
|
|
42
|
+
Do not edit the class manually.
|
|
43
|
+
"""
|
|
44
|
+
|
|
45
|
+
def __init__(self, api_client=None):
|
|
46
|
+
if api_client is None:
|
|
47
|
+
api_client = ApiClient()
|
|
48
|
+
self.api_client = api_client
|
|
49
|
+
|
|
50
|
+
self.get_document_types_endpoint = _Endpoint(
|
|
51
|
+
settings={
|
|
52
|
+
'response_type': (
|
|
53
|
+
{ 200: (DocumentTypesResponse,), 400: (ErrorResponse,), 401: (ErrorResponse,), 403: (ErrorResponse,), 500: (ErrorResponse,), },
|
|
54
|
+
None
|
|
55
|
+
),
|
|
56
|
+
'auth': [
|
|
57
|
+
'FactSetApiKey',
|
|
58
|
+
'FactSetOAuth2'
|
|
59
|
+
],
|
|
60
|
+
'endpoint_path': '/meta/document-types',
|
|
61
|
+
'operation_id': 'get_document_types',
|
|
62
|
+
'http_method': 'GET',
|
|
63
|
+
'servers': None,
|
|
64
|
+
},
|
|
65
|
+
params_map={
|
|
66
|
+
'all': [
|
|
67
|
+
],
|
|
68
|
+
'required': [],
|
|
69
|
+
'nullable': [
|
|
70
|
+
],
|
|
71
|
+
'enum': [
|
|
72
|
+
],
|
|
73
|
+
'validation': [
|
|
74
|
+
]
|
|
75
|
+
},
|
|
76
|
+
root_map={
|
|
77
|
+
'validations': {
|
|
78
|
+
},
|
|
79
|
+
'allowed_values': {
|
|
80
|
+
},
|
|
81
|
+
'openapi_types': {
|
|
82
|
+
},
|
|
83
|
+
'attribute_map': {
|
|
84
|
+
},
|
|
85
|
+
'location_map': {
|
|
86
|
+
},
|
|
87
|
+
'collection_format_map': {
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
headers_map={
|
|
91
|
+
'accept': [
|
|
92
|
+
'application/json'
|
|
93
|
+
],
|
|
94
|
+
'content_type': [],
|
|
95
|
+
},
|
|
96
|
+
api_client=api_client
|
|
97
|
+
)
|
|
98
|
+
|
|
99
|
+
self.get_sources_endpoint = _Endpoint(
|
|
100
|
+
settings={
|
|
101
|
+
'response_type': (
|
|
102
|
+
{ 200: (SourceResponse,), 400: (ErrorResponse,), 401: (ErrorResponse,), 403: (ErrorResponse,), 500: (ErrorResponse,), },
|
|
103
|
+
None
|
|
104
|
+
),
|
|
105
|
+
'auth': [
|
|
106
|
+
'FactSetApiKey',
|
|
107
|
+
'FactSetOAuth2'
|
|
108
|
+
],
|
|
109
|
+
'endpoint_path': '/meta/sources',
|
|
110
|
+
'operation_id': 'get_sources',
|
|
111
|
+
'http_method': 'GET',
|
|
112
|
+
'servers': None,
|
|
113
|
+
},
|
|
114
|
+
params_map={
|
|
115
|
+
'all': [
|
|
116
|
+
],
|
|
117
|
+
'required': [],
|
|
118
|
+
'nullable': [
|
|
119
|
+
],
|
|
120
|
+
'enum': [
|
|
121
|
+
],
|
|
122
|
+
'validation': [
|
|
123
|
+
]
|
|
124
|
+
},
|
|
125
|
+
root_map={
|
|
126
|
+
'validations': {
|
|
127
|
+
},
|
|
128
|
+
'allowed_values': {
|
|
129
|
+
},
|
|
130
|
+
'openapi_types': {
|
|
131
|
+
},
|
|
132
|
+
'attribute_map': {
|
|
133
|
+
},
|
|
134
|
+
'location_map': {
|
|
135
|
+
},
|
|
136
|
+
'collection_format_map': {
|
|
137
|
+
}
|
|
138
|
+
},
|
|
139
|
+
headers_map={
|
|
140
|
+
'accept': [
|
|
141
|
+
'application/json'
|
|
142
|
+
],
|
|
143
|
+
'content_type': [],
|
|
144
|
+
},
|
|
145
|
+
api_client=api_client
|
|
146
|
+
)
|
|
147
|
+
|
|
148
|
+
self.get_themes_endpoint = _Endpoint(
|
|
149
|
+
settings={
|
|
150
|
+
'response_type': (
|
|
151
|
+
{ 200: (ThemesResponse,), 400: (ErrorResponse,), 401: (ErrorResponse,), 403: (ErrorResponse,), 500: (ErrorResponse,), },
|
|
152
|
+
None
|
|
153
|
+
),
|
|
154
|
+
'auth': [
|
|
155
|
+
'FactSetApiKey',
|
|
156
|
+
'FactSetOAuth2'
|
|
157
|
+
],
|
|
158
|
+
'endpoint_path': '/meta/themes',
|
|
159
|
+
'operation_id': 'get_themes',
|
|
160
|
+
'http_method': 'GET',
|
|
161
|
+
'servers': None,
|
|
162
|
+
},
|
|
163
|
+
params_map={
|
|
164
|
+
'all': [
|
|
165
|
+
],
|
|
166
|
+
'required': [],
|
|
167
|
+
'nullable': [
|
|
168
|
+
],
|
|
169
|
+
'enum': [
|
|
170
|
+
],
|
|
171
|
+
'validation': [
|
|
172
|
+
]
|
|
173
|
+
},
|
|
174
|
+
root_map={
|
|
175
|
+
'validations': {
|
|
176
|
+
},
|
|
177
|
+
'allowed_values': {
|
|
178
|
+
},
|
|
179
|
+
'openapi_types': {
|
|
180
|
+
},
|
|
181
|
+
'attribute_map': {
|
|
182
|
+
},
|
|
183
|
+
'location_map': {
|
|
184
|
+
},
|
|
185
|
+
'collection_format_map': {
|
|
186
|
+
}
|
|
187
|
+
},
|
|
188
|
+
headers_map={
|
|
189
|
+
'accept': [
|
|
190
|
+
'application/json'
|
|
191
|
+
],
|
|
192
|
+
'content_type': [],
|
|
193
|
+
},
|
|
194
|
+
api_client=api_client
|
|
195
|
+
)
|
|
196
|
+
|
|
197
|
+
self.getschemas_endpoint = _Endpoint(
|
|
198
|
+
settings={
|
|
199
|
+
'response_type': (
|
|
200
|
+
{ 200: (SchemasResponse,), 400: (ErrorResponse,), 401: (ErrorResponse,), 403: (ErrorResponse,), 500: (ErrorResponse,), },
|
|
201
|
+
None
|
|
202
|
+
),
|
|
203
|
+
'auth': [
|
|
204
|
+
'FactSetApiKey',
|
|
205
|
+
'FactSetOAuth2'
|
|
206
|
+
],
|
|
207
|
+
'endpoint_path': '/meta/schemas',
|
|
208
|
+
'operation_id': 'getschemas',
|
|
209
|
+
'http_method': 'GET',
|
|
210
|
+
'servers': None,
|
|
211
|
+
},
|
|
212
|
+
params_map={
|
|
213
|
+
'all': [
|
|
214
|
+
'sources',
|
|
215
|
+
],
|
|
216
|
+
'required': [],
|
|
217
|
+
'nullable': [
|
|
218
|
+
],
|
|
219
|
+
'enum': [
|
|
220
|
+
],
|
|
221
|
+
'validation': [
|
|
222
|
+
'sources',
|
|
223
|
+
]
|
|
224
|
+
},
|
|
225
|
+
root_map={
|
|
226
|
+
'validations': {
|
|
227
|
+
('sources',): {
|
|
228
|
+
|
|
229
|
+
'max_items': 3,
|
|
230
|
+
'min_items': 1,
|
|
231
|
+
},
|
|
232
|
+
},
|
|
233
|
+
'allowed_values': {
|
|
234
|
+
},
|
|
235
|
+
'openapi_types': {
|
|
236
|
+
'sources':
|
|
237
|
+
([str],),
|
|
238
|
+
},
|
|
239
|
+
'attribute_map': {
|
|
240
|
+
'sources': 'sources',
|
|
241
|
+
},
|
|
242
|
+
'location_map': {
|
|
243
|
+
'sources': 'query',
|
|
244
|
+
},
|
|
245
|
+
'collection_format_map': {
|
|
246
|
+
'sources': 'csv',
|
|
247
|
+
}
|
|
248
|
+
},
|
|
249
|
+
headers_map={
|
|
250
|
+
'accept': [
|
|
251
|
+
'application/json'
|
|
252
|
+
],
|
|
253
|
+
'content_type': [],
|
|
254
|
+
},
|
|
255
|
+
api_client=api_client
|
|
256
|
+
)
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
@staticmethod
|
|
260
|
+
def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
|
|
261
|
+
kwargs["async_req"] = async_req
|
|
262
|
+
kwargs["_return_http_data_only"] = return_http_data_only
|
|
263
|
+
kwargs["_preload_content"] = kwargs.get("_preload_content", True)
|
|
264
|
+
kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
|
|
265
|
+
kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
|
|
266
|
+
kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
|
|
267
|
+
kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
|
|
268
|
+
kwargs["_content_type"] = kwargs.get("_content_type")
|
|
269
|
+
kwargs["_host_index"] = kwargs.get("_host_index")
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
def get_document_types(
|
|
273
|
+
self,
|
|
274
|
+
**kwargs
|
|
275
|
+
) -> DocumentTypesResponse:
|
|
276
|
+
"""Returns the document types. # noqa: E501
|
|
277
|
+
|
|
278
|
+
Retrieves and delivers a comprehensive list of all available `documentTypes`. # noqa: E501
|
|
279
|
+
This method makes a synchronous HTTP request. Returns the http data only
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
Keyword Args:
|
|
283
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
284
|
+
will be returned without reading/decoding response data.
|
|
285
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
286
|
+
of the caller to close the file stream.
|
|
287
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
288
|
+
one number provided, it will be total request timeout. It can also
|
|
289
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
290
|
+
Default is None.
|
|
291
|
+
_check_input_type (bool): specifies if type checking
|
|
292
|
+
should be done one the data sent to the server.
|
|
293
|
+
Default is True.
|
|
294
|
+
_check_return_type (bool): specifies if type checking
|
|
295
|
+
should be done one the data received from the server.
|
|
296
|
+
Default is True.
|
|
297
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
298
|
+
are serialized names, as specified in the OpenAPI document.
|
|
299
|
+
False if the variable names in the input data
|
|
300
|
+
are pythonic names, e.g. snake case (default)
|
|
301
|
+
_content_type (str/None): force body content-type.
|
|
302
|
+
Default is None and content-type will be predicted by allowed
|
|
303
|
+
content-types and body.
|
|
304
|
+
_host_index (int/None): specifies the index of the server
|
|
305
|
+
that we want to use.
|
|
306
|
+
Default is read from the configuration.
|
|
307
|
+
Returns:
|
|
308
|
+
DocumentTypesResponse
|
|
309
|
+
Response Object
|
|
310
|
+
"""
|
|
311
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
|
|
312
|
+
return self.get_document_types_endpoint.call_with_http_info(**kwargs)
|
|
313
|
+
|
|
314
|
+
def get_document_types_with_http_info(
|
|
315
|
+
self,
|
|
316
|
+
**kwargs
|
|
317
|
+
) -> typing.Tuple[DocumentTypesResponse, int, typing.MutableMapping]:
|
|
318
|
+
"""Returns the document types. # noqa: E501
|
|
319
|
+
|
|
320
|
+
Retrieves and delivers a comprehensive list of all available `documentTypes`. # noqa: E501
|
|
321
|
+
This method makes a synchronous HTTP request. Returns http data, http status and headers
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
Keyword Args:
|
|
325
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
326
|
+
will be returned without reading/decoding response data.
|
|
327
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
328
|
+
of the caller to close the file stream.
|
|
329
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
330
|
+
one number provided, it will be total request timeout. It can also
|
|
331
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
332
|
+
Default is None.
|
|
333
|
+
_check_input_type (bool): specifies if type checking
|
|
334
|
+
should be done one the data sent to the server.
|
|
335
|
+
Default is True.
|
|
336
|
+
_check_return_type (bool): specifies if type checking
|
|
337
|
+
should be done one the data received from the server.
|
|
338
|
+
Default is True.
|
|
339
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
340
|
+
are serialized names, as specified in the OpenAPI document.
|
|
341
|
+
False if the variable names in the input data
|
|
342
|
+
are pythonic names, e.g. snake case (default)
|
|
343
|
+
_content_type (str/None): force body content-type.
|
|
344
|
+
Default is None and content-type will be predicted by allowed
|
|
345
|
+
content-types and body.
|
|
346
|
+
_host_index (int/None): specifies the index of the server
|
|
347
|
+
that we want to use.
|
|
348
|
+
Default is read from the configuration.
|
|
349
|
+
Returns:
|
|
350
|
+
DocumentTypesResponse
|
|
351
|
+
Response Object
|
|
352
|
+
int
|
|
353
|
+
Http Status Code
|
|
354
|
+
dict
|
|
355
|
+
Dictionary of the response headers
|
|
356
|
+
"""
|
|
357
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
|
|
358
|
+
return self.get_document_types_endpoint.call_with_http_info(**kwargs)
|
|
359
|
+
|
|
360
|
+
def get_document_types_async(
|
|
361
|
+
self,
|
|
362
|
+
**kwargs
|
|
363
|
+
) -> "ApplyResult[DocumentTypesResponse]":
|
|
364
|
+
"""Returns the document types. # noqa: E501
|
|
365
|
+
|
|
366
|
+
Retrieves and delivers a comprehensive list of all available `documentTypes`. # noqa: E501
|
|
367
|
+
This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
Keyword Args:
|
|
371
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
372
|
+
will be returned without reading/decoding response data.
|
|
373
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
374
|
+
of the caller to close the file stream.
|
|
375
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
376
|
+
one number provided, it will be total request timeout. It can also
|
|
377
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
378
|
+
Default is None.
|
|
379
|
+
_check_input_type (bool): specifies if type checking
|
|
380
|
+
should be done one the data sent to the server.
|
|
381
|
+
Default is True.
|
|
382
|
+
_check_return_type (bool): specifies if type checking
|
|
383
|
+
should be done one the data received from the server.
|
|
384
|
+
Default is True.
|
|
385
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
386
|
+
are serialized names, as specified in the OpenAPI document.
|
|
387
|
+
False if the variable names in the input data
|
|
388
|
+
are pythonic names, e.g. snake case (default)
|
|
389
|
+
_content_type (str/None): force body content-type.
|
|
390
|
+
Default is None and content-type will be predicted by allowed
|
|
391
|
+
content-types and body.
|
|
392
|
+
_host_index (int/None): specifies the index of the server
|
|
393
|
+
that we want to use.
|
|
394
|
+
Default is read from the configuration.
|
|
395
|
+
Returns:
|
|
396
|
+
ApplyResult[DocumentTypesResponse]
|
|
397
|
+
"""
|
|
398
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
|
|
399
|
+
return self.get_document_types_endpoint.call_with_http_info(**kwargs)
|
|
400
|
+
|
|
401
|
+
def get_document_types_with_http_info_async(
|
|
402
|
+
self,
|
|
403
|
+
**kwargs
|
|
404
|
+
) -> "ApplyResult[typing.Tuple[DocumentTypesResponse, int, typing.MutableMapping]]":
|
|
405
|
+
"""Returns the document types. # noqa: E501
|
|
406
|
+
|
|
407
|
+
Retrieves and delivers a comprehensive list of all available `documentTypes`. # noqa: E501
|
|
408
|
+
This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
Keyword Args:
|
|
412
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
413
|
+
will be returned without reading/decoding response data.
|
|
414
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
415
|
+
of the caller to close the file stream.
|
|
416
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
417
|
+
one number provided, it will be total request timeout. It can also
|
|
418
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
419
|
+
Default is None.
|
|
420
|
+
_check_input_type (bool): specifies if type checking
|
|
421
|
+
should be done one the data sent to the server.
|
|
422
|
+
Default is True.
|
|
423
|
+
_check_return_type (bool): specifies if type checking
|
|
424
|
+
should be done one the data received from the server.
|
|
425
|
+
Default is True.
|
|
426
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
427
|
+
are serialized names, as specified in the OpenAPI document.
|
|
428
|
+
False if the variable names in the input data
|
|
429
|
+
are pythonic names, e.g. snake case (default)
|
|
430
|
+
_content_type (str/None): force body content-type.
|
|
431
|
+
Default is None and content-type will be predicted by allowed
|
|
432
|
+
content-types and body.
|
|
433
|
+
_host_index (int/None): specifies the index of the server
|
|
434
|
+
that we want to use.
|
|
435
|
+
Default is read from the configuration.
|
|
436
|
+
Returns:
|
|
437
|
+
ApplyResult[(DocumentTypesResponse, int, typing.Dict)]
|
|
438
|
+
"""
|
|
439
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
|
|
440
|
+
return self.get_document_types_endpoint.call_with_http_info(**kwargs)
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
def get_sources(
|
|
444
|
+
self,
|
|
445
|
+
**kwargs
|
|
446
|
+
) -> SourceResponse:
|
|
447
|
+
"""Returns the sources. # noqa: E501
|
|
448
|
+
|
|
449
|
+
Retrieves and delivers a comprehensive list of all available `sources`. # noqa: E501
|
|
450
|
+
This method makes a synchronous HTTP request. Returns the http data only
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
Keyword Args:
|
|
454
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
455
|
+
will be returned without reading/decoding response data.
|
|
456
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
457
|
+
of the caller to close the file stream.
|
|
458
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
459
|
+
one number provided, it will be total request timeout. It can also
|
|
460
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
461
|
+
Default is None.
|
|
462
|
+
_check_input_type (bool): specifies if type checking
|
|
463
|
+
should be done one the data sent to the server.
|
|
464
|
+
Default is True.
|
|
465
|
+
_check_return_type (bool): specifies if type checking
|
|
466
|
+
should be done one the data received from the server.
|
|
467
|
+
Default is True.
|
|
468
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
469
|
+
are serialized names, as specified in the OpenAPI document.
|
|
470
|
+
False if the variable names in the input data
|
|
471
|
+
are pythonic names, e.g. snake case (default)
|
|
472
|
+
_content_type (str/None): force body content-type.
|
|
473
|
+
Default is None and content-type will be predicted by allowed
|
|
474
|
+
content-types and body.
|
|
475
|
+
_host_index (int/None): specifies the index of the server
|
|
476
|
+
that we want to use.
|
|
477
|
+
Default is read from the configuration.
|
|
478
|
+
Returns:
|
|
479
|
+
SourceResponse
|
|
480
|
+
Response Object
|
|
481
|
+
"""
|
|
482
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
|
|
483
|
+
return self.get_sources_endpoint.call_with_http_info(**kwargs)
|
|
484
|
+
|
|
485
|
+
def get_sources_with_http_info(
|
|
486
|
+
self,
|
|
487
|
+
**kwargs
|
|
488
|
+
) -> typing.Tuple[SourceResponse, int, typing.MutableMapping]:
|
|
489
|
+
"""Returns the sources. # noqa: E501
|
|
490
|
+
|
|
491
|
+
Retrieves and delivers a comprehensive list of all available `sources`. # noqa: E501
|
|
492
|
+
This method makes a synchronous HTTP request. Returns http data, http status and headers
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
Keyword Args:
|
|
496
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
497
|
+
will be returned without reading/decoding response data.
|
|
498
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
499
|
+
of the caller to close the file stream.
|
|
500
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
501
|
+
one number provided, it will be total request timeout. It can also
|
|
502
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
503
|
+
Default is None.
|
|
504
|
+
_check_input_type (bool): specifies if type checking
|
|
505
|
+
should be done one the data sent to the server.
|
|
506
|
+
Default is True.
|
|
507
|
+
_check_return_type (bool): specifies if type checking
|
|
508
|
+
should be done one the data received from the server.
|
|
509
|
+
Default is True.
|
|
510
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
511
|
+
are serialized names, as specified in the OpenAPI document.
|
|
512
|
+
False if the variable names in the input data
|
|
513
|
+
are pythonic names, e.g. snake case (default)
|
|
514
|
+
_content_type (str/None): force body content-type.
|
|
515
|
+
Default is None and content-type will be predicted by allowed
|
|
516
|
+
content-types and body.
|
|
517
|
+
_host_index (int/None): specifies the index of the server
|
|
518
|
+
that we want to use.
|
|
519
|
+
Default is read from the configuration.
|
|
520
|
+
Returns:
|
|
521
|
+
SourceResponse
|
|
522
|
+
Response Object
|
|
523
|
+
int
|
|
524
|
+
Http Status Code
|
|
525
|
+
dict
|
|
526
|
+
Dictionary of the response headers
|
|
527
|
+
"""
|
|
528
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
|
|
529
|
+
return self.get_sources_endpoint.call_with_http_info(**kwargs)
|
|
530
|
+
|
|
531
|
+
def get_sources_async(
|
|
532
|
+
self,
|
|
533
|
+
**kwargs
|
|
534
|
+
) -> "ApplyResult[SourceResponse]":
|
|
535
|
+
"""Returns the sources. # noqa: E501
|
|
536
|
+
|
|
537
|
+
Retrieves and delivers a comprehensive list of all available `sources`. # noqa: E501
|
|
538
|
+
This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
Keyword Args:
|
|
542
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
543
|
+
will be returned without reading/decoding response data.
|
|
544
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
545
|
+
of the caller to close the file stream.
|
|
546
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
547
|
+
one number provided, it will be total request timeout. It can also
|
|
548
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
549
|
+
Default is None.
|
|
550
|
+
_check_input_type (bool): specifies if type checking
|
|
551
|
+
should be done one the data sent to the server.
|
|
552
|
+
Default is True.
|
|
553
|
+
_check_return_type (bool): specifies if type checking
|
|
554
|
+
should be done one the data received from the server.
|
|
555
|
+
Default is True.
|
|
556
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
557
|
+
are serialized names, as specified in the OpenAPI document.
|
|
558
|
+
False if the variable names in the input data
|
|
559
|
+
are pythonic names, e.g. snake case (default)
|
|
560
|
+
_content_type (str/None): force body content-type.
|
|
561
|
+
Default is None and content-type will be predicted by allowed
|
|
562
|
+
content-types and body.
|
|
563
|
+
_host_index (int/None): specifies the index of the server
|
|
564
|
+
that we want to use.
|
|
565
|
+
Default is read from the configuration.
|
|
566
|
+
Returns:
|
|
567
|
+
ApplyResult[SourceResponse]
|
|
568
|
+
"""
|
|
569
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
|
|
570
|
+
return self.get_sources_endpoint.call_with_http_info(**kwargs)
|
|
571
|
+
|
|
572
|
+
def get_sources_with_http_info_async(
|
|
573
|
+
self,
|
|
574
|
+
**kwargs
|
|
575
|
+
) -> "ApplyResult[typing.Tuple[SourceResponse, int, typing.MutableMapping]]":
|
|
576
|
+
"""Returns the sources. # noqa: E501
|
|
577
|
+
|
|
578
|
+
Retrieves and delivers a comprehensive list of all available `sources`. # noqa: E501
|
|
579
|
+
This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
Keyword Args:
|
|
583
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
584
|
+
will be returned without reading/decoding response data.
|
|
585
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
586
|
+
of the caller to close the file stream.
|
|
587
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
588
|
+
one number provided, it will be total request timeout. It can also
|
|
589
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
590
|
+
Default is None.
|
|
591
|
+
_check_input_type (bool): specifies if type checking
|
|
592
|
+
should be done one the data sent to the server.
|
|
593
|
+
Default is True.
|
|
594
|
+
_check_return_type (bool): specifies if type checking
|
|
595
|
+
should be done one the data received from the server.
|
|
596
|
+
Default is True.
|
|
597
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
598
|
+
are serialized names, as specified in the OpenAPI document.
|
|
599
|
+
False if the variable names in the input data
|
|
600
|
+
are pythonic names, e.g. snake case (default)
|
|
601
|
+
_content_type (str/None): force body content-type.
|
|
602
|
+
Default is None and content-type will be predicted by allowed
|
|
603
|
+
content-types and body.
|
|
604
|
+
_host_index (int/None): specifies the index of the server
|
|
605
|
+
that we want to use.
|
|
606
|
+
Default is read from the configuration.
|
|
607
|
+
Returns:
|
|
608
|
+
ApplyResult[(SourceResponse, int, typing.Dict)]
|
|
609
|
+
"""
|
|
610
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
|
|
611
|
+
return self.get_sources_endpoint.call_with_http_info(**kwargs)
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
def get_themes(
|
|
615
|
+
self,
|
|
616
|
+
**kwargs
|
|
617
|
+
) -> ThemesResponse:
|
|
618
|
+
"""Returns the themes. # noqa: E501
|
|
619
|
+
|
|
620
|
+
Retrieves and delivers a comprehensive list of all available `themes`. # noqa: E501
|
|
621
|
+
This method makes a synchronous HTTP request. Returns the http data only
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
Keyword Args:
|
|
625
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
626
|
+
will be returned without reading/decoding response data.
|
|
627
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
628
|
+
of the caller to close the file stream.
|
|
629
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
630
|
+
one number provided, it will be total request timeout. It can also
|
|
631
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
632
|
+
Default is None.
|
|
633
|
+
_check_input_type (bool): specifies if type checking
|
|
634
|
+
should be done one the data sent to the server.
|
|
635
|
+
Default is True.
|
|
636
|
+
_check_return_type (bool): specifies if type checking
|
|
637
|
+
should be done one the data received from the server.
|
|
638
|
+
Default is True.
|
|
639
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
640
|
+
are serialized names, as specified in the OpenAPI document.
|
|
641
|
+
False if the variable names in the input data
|
|
642
|
+
are pythonic names, e.g. snake case (default)
|
|
643
|
+
_content_type (str/None): force body content-type.
|
|
644
|
+
Default is None and content-type will be predicted by allowed
|
|
645
|
+
content-types and body.
|
|
646
|
+
_host_index (int/None): specifies the index of the server
|
|
647
|
+
that we want to use.
|
|
648
|
+
Default is read from the configuration.
|
|
649
|
+
Returns:
|
|
650
|
+
ThemesResponse
|
|
651
|
+
Response Object
|
|
652
|
+
"""
|
|
653
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
|
|
654
|
+
return self.get_themes_endpoint.call_with_http_info(**kwargs)
|
|
655
|
+
|
|
656
|
+
def get_themes_with_http_info(
|
|
657
|
+
self,
|
|
658
|
+
**kwargs
|
|
659
|
+
) -> typing.Tuple[ThemesResponse, int, typing.MutableMapping]:
|
|
660
|
+
"""Returns the themes. # noqa: E501
|
|
661
|
+
|
|
662
|
+
Retrieves and delivers a comprehensive list of all available `themes`. # noqa: E501
|
|
663
|
+
This method makes a synchronous HTTP request. Returns http data, http status and headers
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
Keyword Args:
|
|
667
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
668
|
+
will be returned without reading/decoding response data.
|
|
669
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
670
|
+
of the caller to close the file stream.
|
|
671
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
672
|
+
one number provided, it will be total request timeout. It can also
|
|
673
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
674
|
+
Default is None.
|
|
675
|
+
_check_input_type (bool): specifies if type checking
|
|
676
|
+
should be done one the data sent to the server.
|
|
677
|
+
Default is True.
|
|
678
|
+
_check_return_type (bool): specifies if type checking
|
|
679
|
+
should be done one the data received from the server.
|
|
680
|
+
Default is True.
|
|
681
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
682
|
+
are serialized names, as specified in the OpenAPI document.
|
|
683
|
+
False if the variable names in the input data
|
|
684
|
+
are pythonic names, e.g. snake case (default)
|
|
685
|
+
_content_type (str/None): force body content-type.
|
|
686
|
+
Default is None and content-type will be predicted by allowed
|
|
687
|
+
content-types and body.
|
|
688
|
+
_host_index (int/None): specifies the index of the server
|
|
689
|
+
that we want to use.
|
|
690
|
+
Default is read from the configuration.
|
|
691
|
+
Returns:
|
|
692
|
+
ThemesResponse
|
|
693
|
+
Response Object
|
|
694
|
+
int
|
|
695
|
+
Http Status Code
|
|
696
|
+
dict
|
|
697
|
+
Dictionary of the response headers
|
|
698
|
+
"""
|
|
699
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
|
|
700
|
+
return self.get_themes_endpoint.call_with_http_info(**kwargs)
|
|
701
|
+
|
|
702
|
+
def get_themes_async(
|
|
703
|
+
self,
|
|
704
|
+
**kwargs
|
|
705
|
+
) -> "ApplyResult[ThemesResponse]":
|
|
706
|
+
"""Returns the themes. # noqa: E501
|
|
707
|
+
|
|
708
|
+
Retrieves and delivers a comprehensive list of all available `themes`. # noqa: E501
|
|
709
|
+
This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
Keyword Args:
|
|
713
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
714
|
+
will be returned without reading/decoding response data.
|
|
715
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
716
|
+
of the caller to close the file stream.
|
|
717
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
718
|
+
one number provided, it will be total request timeout. It can also
|
|
719
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
720
|
+
Default is None.
|
|
721
|
+
_check_input_type (bool): specifies if type checking
|
|
722
|
+
should be done one the data sent to the server.
|
|
723
|
+
Default is True.
|
|
724
|
+
_check_return_type (bool): specifies if type checking
|
|
725
|
+
should be done one the data received from the server.
|
|
726
|
+
Default is True.
|
|
727
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
728
|
+
are serialized names, as specified in the OpenAPI document.
|
|
729
|
+
False if the variable names in the input data
|
|
730
|
+
are pythonic names, e.g. snake case (default)
|
|
731
|
+
_content_type (str/None): force body content-type.
|
|
732
|
+
Default is None and content-type will be predicted by allowed
|
|
733
|
+
content-types and body.
|
|
734
|
+
_host_index (int/None): specifies the index of the server
|
|
735
|
+
that we want to use.
|
|
736
|
+
Default is read from the configuration.
|
|
737
|
+
Returns:
|
|
738
|
+
ApplyResult[ThemesResponse]
|
|
739
|
+
"""
|
|
740
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
|
|
741
|
+
return self.get_themes_endpoint.call_with_http_info(**kwargs)
|
|
742
|
+
|
|
743
|
+
def get_themes_with_http_info_async(
|
|
744
|
+
self,
|
|
745
|
+
**kwargs
|
|
746
|
+
) -> "ApplyResult[typing.Tuple[ThemesResponse, int, typing.MutableMapping]]":
|
|
747
|
+
"""Returns the themes. # noqa: E501
|
|
748
|
+
|
|
749
|
+
Retrieves and delivers a comprehensive list of all available `themes`. # noqa: E501
|
|
750
|
+
This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
Keyword Args:
|
|
754
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
755
|
+
will be returned without reading/decoding response data.
|
|
756
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
757
|
+
of the caller to close the file stream.
|
|
758
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
759
|
+
one number provided, it will be total request timeout. It can also
|
|
760
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
761
|
+
Default is None.
|
|
762
|
+
_check_input_type (bool): specifies if type checking
|
|
763
|
+
should be done one the data sent to the server.
|
|
764
|
+
Default is True.
|
|
765
|
+
_check_return_type (bool): specifies if type checking
|
|
766
|
+
should be done one the data received from the server.
|
|
767
|
+
Default is True.
|
|
768
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
769
|
+
are serialized names, as specified in the OpenAPI document.
|
|
770
|
+
False if the variable names in the input data
|
|
771
|
+
are pythonic names, e.g. snake case (default)
|
|
772
|
+
_content_type (str/None): force body content-type.
|
|
773
|
+
Default is None and content-type will be predicted by allowed
|
|
774
|
+
content-types and body.
|
|
775
|
+
_host_index (int/None): specifies the index of the server
|
|
776
|
+
that we want to use.
|
|
777
|
+
Default is read from the configuration.
|
|
778
|
+
Returns:
|
|
779
|
+
ApplyResult[(ThemesResponse, int, typing.Dict)]
|
|
780
|
+
"""
|
|
781
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
|
|
782
|
+
return self.get_themes_endpoint.call_with_http_info(**kwargs)
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
def getschemas(
|
|
786
|
+
self,
|
|
787
|
+
**kwargs
|
|
788
|
+
) -> SchemasResponse:
|
|
789
|
+
"""Returns the schemas. # noqa: E501
|
|
790
|
+
|
|
791
|
+
Retrieves and delivers a comprehensive list of all available `schemas`. # noqa: E501
|
|
792
|
+
This method makes a synchronous HTTP request. Returns the http data only
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
Keyword Args:
|
|
796
|
+
sources ([str]): Code for document source to include. This is a comma-separated list. Use the `/meta/sources` endpoint to get the list of available sources.. [optional]
|
|
797
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
798
|
+
will be returned without reading/decoding response data.
|
|
799
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
800
|
+
of the caller to close the file stream.
|
|
801
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
802
|
+
one number provided, it will be total request timeout. It can also
|
|
803
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
804
|
+
Default is None.
|
|
805
|
+
_check_input_type (bool): specifies if type checking
|
|
806
|
+
should be done one the data sent to the server.
|
|
807
|
+
Default is True.
|
|
808
|
+
_check_return_type (bool): specifies if type checking
|
|
809
|
+
should be done one the data received from the server.
|
|
810
|
+
Default is True.
|
|
811
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
812
|
+
are serialized names, as specified in the OpenAPI document.
|
|
813
|
+
False if the variable names in the input data
|
|
814
|
+
are pythonic names, e.g. snake case (default)
|
|
815
|
+
_content_type (str/None): force body content-type.
|
|
816
|
+
Default is None and content-type will be predicted by allowed
|
|
817
|
+
content-types and body.
|
|
818
|
+
_host_index (int/None): specifies the index of the server
|
|
819
|
+
that we want to use.
|
|
820
|
+
Default is read from the configuration.
|
|
821
|
+
Returns:
|
|
822
|
+
SchemasResponse
|
|
823
|
+
Response Object
|
|
824
|
+
"""
|
|
825
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
|
|
826
|
+
return self.getschemas_endpoint.call_with_http_info(**kwargs)
|
|
827
|
+
|
|
828
|
+
def getschemas_with_http_info(
|
|
829
|
+
self,
|
|
830
|
+
**kwargs
|
|
831
|
+
) -> typing.Tuple[SchemasResponse, int, typing.MutableMapping]:
|
|
832
|
+
"""Returns the schemas. # noqa: E501
|
|
833
|
+
|
|
834
|
+
Retrieves and delivers a comprehensive list of all available `schemas`. # noqa: E501
|
|
835
|
+
This method makes a synchronous HTTP request. Returns http data, http status and headers
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
Keyword Args:
|
|
839
|
+
sources ([str]): Code for document source to include. This is a comma-separated list. Use the `/meta/sources` endpoint to get the list of available sources.. [optional]
|
|
840
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
841
|
+
will be returned without reading/decoding response data.
|
|
842
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
843
|
+
of the caller to close the file stream.
|
|
844
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
845
|
+
one number provided, it will be total request timeout. It can also
|
|
846
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
847
|
+
Default is None.
|
|
848
|
+
_check_input_type (bool): specifies if type checking
|
|
849
|
+
should be done one the data sent to the server.
|
|
850
|
+
Default is True.
|
|
851
|
+
_check_return_type (bool): specifies if type checking
|
|
852
|
+
should be done one the data received from the server.
|
|
853
|
+
Default is True.
|
|
854
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
855
|
+
are serialized names, as specified in the OpenAPI document.
|
|
856
|
+
False if the variable names in the input data
|
|
857
|
+
are pythonic names, e.g. snake case (default)
|
|
858
|
+
_content_type (str/None): force body content-type.
|
|
859
|
+
Default is None and content-type will be predicted by allowed
|
|
860
|
+
content-types and body.
|
|
861
|
+
_host_index (int/None): specifies the index of the server
|
|
862
|
+
that we want to use.
|
|
863
|
+
Default is read from the configuration.
|
|
864
|
+
Returns:
|
|
865
|
+
SchemasResponse
|
|
866
|
+
Response Object
|
|
867
|
+
int
|
|
868
|
+
Http Status Code
|
|
869
|
+
dict
|
|
870
|
+
Dictionary of the response headers
|
|
871
|
+
"""
|
|
872
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
|
|
873
|
+
return self.getschemas_endpoint.call_with_http_info(**kwargs)
|
|
874
|
+
|
|
875
|
+
def getschemas_async(
|
|
876
|
+
self,
|
|
877
|
+
**kwargs
|
|
878
|
+
) -> "ApplyResult[SchemasResponse]":
|
|
879
|
+
"""Returns the schemas. # noqa: E501
|
|
880
|
+
|
|
881
|
+
Retrieves and delivers a comprehensive list of all available `schemas`. # noqa: E501
|
|
882
|
+
This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
Keyword Args:
|
|
886
|
+
sources ([str]): Code for document source to include. This is a comma-separated list. Use the `/meta/sources` endpoint to get the list of available sources.. [optional]
|
|
887
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
888
|
+
will be returned without reading/decoding response data.
|
|
889
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
890
|
+
of the caller to close the file stream.
|
|
891
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
892
|
+
one number provided, it will be total request timeout. It can also
|
|
893
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
894
|
+
Default is None.
|
|
895
|
+
_check_input_type (bool): specifies if type checking
|
|
896
|
+
should be done one the data sent to the server.
|
|
897
|
+
Default is True.
|
|
898
|
+
_check_return_type (bool): specifies if type checking
|
|
899
|
+
should be done one the data received from the server.
|
|
900
|
+
Default is True.
|
|
901
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
902
|
+
are serialized names, as specified in the OpenAPI document.
|
|
903
|
+
False if the variable names in the input data
|
|
904
|
+
are pythonic names, e.g. snake case (default)
|
|
905
|
+
_content_type (str/None): force body content-type.
|
|
906
|
+
Default is None and content-type will be predicted by allowed
|
|
907
|
+
content-types and body.
|
|
908
|
+
_host_index (int/None): specifies the index of the server
|
|
909
|
+
that we want to use.
|
|
910
|
+
Default is read from the configuration.
|
|
911
|
+
Returns:
|
|
912
|
+
ApplyResult[SchemasResponse]
|
|
913
|
+
"""
|
|
914
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
|
|
915
|
+
return self.getschemas_endpoint.call_with_http_info(**kwargs)
|
|
916
|
+
|
|
917
|
+
def getschemas_with_http_info_async(
|
|
918
|
+
self,
|
|
919
|
+
**kwargs
|
|
920
|
+
) -> "ApplyResult[typing.Tuple[SchemasResponse, int, typing.MutableMapping]]":
|
|
921
|
+
"""Returns the schemas. # noqa: E501
|
|
922
|
+
|
|
923
|
+
Retrieves and delivers a comprehensive list of all available `schemas`. # noqa: E501
|
|
924
|
+
This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
Keyword Args:
|
|
928
|
+
sources ([str]): Code for document source to include. This is a comma-separated list. Use the `/meta/sources` endpoint to get the list of available sources.. [optional]
|
|
929
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
930
|
+
will be returned without reading/decoding response data.
|
|
931
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
932
|
+
of the caller to close the file stream.
|
|
933
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
934
|
+
one number provided, it will be total request timeout. It can also
|
|
935
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
936
|
+
Default is None.
|
|
937
|
+
_check_input_type (bool): specifies if type checking
|
|
938
|
+
should be done one the data sent to the server.
|
|
939
|
+
Default is True.
|
|
940
|
+
_check_return_type (bool): specifies if type checking
|
|
941
|
+
should be done one the data received from the server.
|
|
942
|
+
Default is True.
|
|
943
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
944
|
+
are serialized names, as specified in the OpenAPI document.
|
|
945
|
+
False if the variable names in the input data
|
|
946
|
+
are pythonic names, e.g. snake case (default)
|
|
947
|
+
_content_type (str/None): force body content-type.
|
|
948
|
+
Default is None and content-type will be predicted by allowed
|
|
949
|
+
content-types and body.
|
|
950
|
+
_host_index (int/None): specifies the index of the server
|
|
951
|
+
that we want to use.
|
|
952
|
+
Default is read from the configuration.
|
|
953
|
+
Returns:
|
|
954
|
+
ApplyResult[(SchemasResponse, int, typing.Dict)]
|
|
955
|
+
"""
|
|
956
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
|
|
957
|
+
return self.getschemas_endpoint.call_with_http_info(**kwargs)
|
|
958
|
+
|
|
959
|
+
|