neurograph-core 1.202508112256__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.
Files changed (105) hide show
  1. neurograph/__init__.py +0 -0
  2. neurograph/v1/__init__.py +227 -0
  3. neurograph/v1/api/__init__.py +15 -0
  4. neurograph/v1/api/atlas_api.py +588 -0
  5. neurograph/v1/api/authentication_api.py +830 -0
  6. neurograph/v1/api/client_api.py +1684 -0
  7. neurograph/v1/api/client_metadata_api.py +871 -0
  8. neurograph/v1/api/lookup_api.py +1049 -0
  9. neurograph/v1/api/organization_api.py +1975 -0
  10. neurograph/v1/api/organization_metadata_api.py +872 -0
  11. neurograph/v1/api/persona_api.py +1920 -0
  12. neurograph/v1/api/system_api.py +293 -0
  13. neurograph/v1/api/tasks_api.py +285 -0
  14. neurograph/v1/api/workbench_api.py +857 -0
  15. neurograph/v1/api_client.py +801 -0
  16. neurograph/v1/api_response.py +21 -0
  17. neurograph/v1/configuration.py +612 -0
  18. neurograph/v1/exceptions.py +216 -0
  19. neurograph/v1/models/__init__.py +96 -0
  20. neurograph/v1/models/atlas_atlas_version.py +99 -0
  21. neurograph/v1/models/atlas_atlas_version_many_response.py +97 -0
  22. neurograph/v1/models/atlas_atlas_version_response.py +101 -0
  23. neurograph/v1/models/atlas_atlas_version_upsert_request.py +95 -0
  24. neurograph/v1/models/auth_service_token_request.py +87 -0
  25. neurograph/v1/models/auth_test_service_token_response.py +89 -0
  26. neurograph/v1/models/auth_test_token_response.py +87 -0
  27. neurograph/v1/models/client_client.py +109 -0
  28. neurograph/v1/models/client_client_creat_response.py +111 -0
  29. neurograph/v1/models/client_client_create_request.py +95 -0
  30. neurograph/v1/models/client_client_get_detail_response.py +93 -0
  31. neurograph/v1/models/client_client_get_many_response.py +105 -0
  32. neurograph/v1/models/client_client_metadata_request.py +89 -0
  33. neurograph/v1/models/client_client_metadata_response.py +97 -0
  34. neurograph/v1/models/client_client_personas_response.py +99 -0
  35. neurograph/v1/models/client_client_url_upsert_request.py +99 -0
  36. neurograph/v1/models/client_client_url_upsert_response.py +101 -0
  37. neurograph/v1/models/client_client_urls_response.py +101 -0
  38. neurograph/v1/models/client_delete_metadata_request.py +87 -0
  39. neurograph/v1/models/client_kpi.py +93 -0
  40. neurograph/v1/models/client_metadata.py +93 -0
  41. neurograph/v1/models/client_persona.py +171 -0
  42. neurograph/v1/models/client_persona_factor.py +99 -0
  43. neurograph/v1/models/client_persona_insight.py +93 -0
  44. neurograph/v1/models/client_persona_personality_trait.py +93 -0
  45. neurograph/v1/models/client_query.py +93 -0
  46. neurograph/v1/models/db_client_url.py +99 -0
  47. neurograph/v1/models/db_persona_factor_create_params.py +97 -0
  48. neurograph/v1/models/lookup_language.py +97 -0
  49. neurograph/v1/models/lookup_lookup_language_response.py +97 -0
  50. neurograph/v1/models/lookup_lookup_state_response.py +97 -0
  51. neurograph/v1/models/lookup_state.py +91 -0
  52. neurograph/v1/models/lookup_state_response.py +93 -0
  53. neurograph/v1/models/organizations_atlas_config.py +97 -0
  54. neurograph/v1/models/organizations_brand_detail_response.py +109 -0
  55. neurograph/v1/models/organizations_brand_upsert_request.py +107 -0
  56. neurograph/v1/models/organizations_delete_metadata_request.py +87 -0
  57. neurograph/v1/models/organizations_delete_metadata_response.py +97 -0
  58. neurograph/v1/models/organizations_metadata.py +93 -0
  59. neurograph/v1/models/organizations_organization.py +103 -0
  60. neurograph/v1/models/organizations_organization_brand.py +107 -0
  61. neurograph/v1/models/organizations_organization_create_request.py +97 -0
  62. neurograph/v1/models/organizations_organization_detail_response.py +123 -0
  63. neurograph/v1/models/organizations_organization_get_many_response.py +103 -0
  64. neurograph/v1/models/organizations_organization_metadata_request.py +89 -0
  65. neurograph/v1/models/organizations_organization_metadata_response.py +97 -0
  66. neurograph/v1/models/organizations_organization_set_atlas_request.py +93 -0
  67. neurograph/v1/models/organizations_organization_set_atlas_response.py +99 -0
  68. neurograph/v1/models/organizations_organization_set_workbench_request.py +93 -0
  69. neurograph/v1/models/organizations_organization_set_workbench_response.py +99 -0
  70. neurograph/v1/models/organizations_organization_update_request.py +99 -0
  71. neurograph/v1/models/organizations_workbench_config.py +97 -0
  72. neurograph/v1/models/personas_match_criteria_row.py +97 -0
  73. neurograph/v1/models/personas_match_criteria_row_in.py +93 -0
  74. neurograph/v1/models/personas_persona_factor.py +101 -0
  75. neurograph/v1/models/personas_persona_factor_create_request.py +95 -0
  76. neurograph/v1/models/personas_persona_factor_create_response.py +97 -0
  77. neurograph/v1/models/personas_persona_insight_create_request.py +91 -0
  78. neurograph/v1/models/personas_persona_insight_create_response.py +95 -0
  79. neurograph/v1/models/personas_persona_instance_create_request.py +123 -0
  80. neurograph/v1/models/personas_persona_instance_create_response.py +127 -0
  81. neurograph/v1/models/personas_persona_kpi_create_request.py +95 -0
  82. neurograph/v1/models/personas_persona_kpi_create_response.py +97 -0
  83. neurograph/v1/models/personas_persona_kpi_req.py +91 -0
  84. neurograph/v1/models/personas_persona_kpi_resp.py +95 -0
  85. neurograph/v1/models/personas_persona_match_criteria_request.py +95 -0
  86. neurograph/v1/models/personas_persona_match_criteria_response.py +97 -0
  87. neurograph/v1/models/personas_persona_seed_create_request.py +89 -0
  88. neurograph/v1/models/personas_persona_seed_create_response.py +97 -0
  89. neurograph/v1/models/personas_persona_trait_create_request.py +95 -0
  90. neurograph/v1/models/personas_persona_trait_create_response.py +97 -0
  91. neurograph/v1/models/personas_personality_trait_in.py +91 -0
  92. neurograph/v1/models/personas_personality_trait_out.py +95 -0
  93. neurograph/v1/models/tasks_sync_from_firebase_result.py +87 -0
  94. neurograph/v1/models/workbench_workbench_url_check_request.py +87 -0
  95. neurograph/v1/models/workbench_workbench_url_check_response.py +111 -0
  96. neurograph/v1/models/workbench_workbench_version.py +99 -0
  97. neurograph/v1/models/workbench_workbench_version_many_response.py +97 -0
  98. neurograph/v1/models/workbench_workbench_version_response.py +101 -0
  99. neurograph/v1/models/workbench_workbench_version_upsert_request.py +95 -0
  100. neurograph/v1/py.typed +0 -0
  101. neurograph/v1/rest.py +258 -0
  102. neurograph_core-1.202508112256.dist-info/METADATA +62 -0
  103. neurograph_core-1.202508112256.dist-info/RECORD +105 -0
  104. neurograph_core-1.202508112256.dist-info/WHEEL +5 -0
  105. neurograph_core-1.202508112256.dist-info/top_level.txt +1 -0
@@ -0,0 +1,857 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Neurograph Core
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: 1.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictInt
20
+ from typing import Optional
21
+ from typing_extensions import Annotated
22
+ from neurograph.v1.models.workbench_workbench_url_check_request import WorkbenchWorkbenchUrlCheckRequest
23
+ from neurograph.v1.models.workbench_workbench_url_check_response import WorkbenchWorkbenchUrlCheckResponse
24
+ from neurograph.v1.models.workbench_workbench_version_many_response import WorkbenchWorkbenchVersionManyResponse
25
+ from neurograph.v1.models.workbench_workbench_version_response import WorkbenchWorkbenchVersionResponse
26
+ from neurograph.v1.models.workbench_workbench_version_upsert_request import WorkbenchWorkbenchVersionUpsertRequest
27
+
28
+ from neurograph.v1.api_client import ApiClient, RequestSerialized
29
+ from neurograph.v1.api_response import ApiResponse
30
+ from neurograph.v1.rest import RESTResponseType
31
+
32
+
33
+ class WorkbenchApi:
34
+ """NOTE: This class is auto generated by OpenAPI Generator
35
+ Ref: https://openapi-generator.tech
36
+
37
+ Do not edit the class manually.
38
+ """
39
+
40
+ def __init__(self, api_client=None) -> None:
41
+ if api_client is None:
42
+ api_client = ApiClient.get_default()
43
+ self.api_client = api_client
44
+
45
+
46
+ @validate_call
47
+ def api_v1_workbench_urls_post(
48
+ self,
49
+ request: Annotated[WorkbenchWorkbenchUrlCheckRequest, Field(description="Body")],
50
+ _request_timeout: Union[
51
+ None,
52
+ Annotated[StrictFloat, Field(gt=0)],
53
+ Tuple[
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Annotated[StrictFloat, Field(gt=0)]
56
+ ]
57
+ ] = None,
58
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
59
+ _content_type: Optional[StrictStr] = None,
60
+ _headers: Optional[Dict[StrictStr, Any]] = None,
61
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
62
+ ) -> WorkbenchWorkbenchUrlCheckResponse:
63
+ """Get Branding for a Workbench Url
64
+
65
+ Check a workbench url slug for branding
66
+
67
+ :param request: Body (required)
68
+ :type request: WorkbenchWorkbenchUrlCheckRequest
69
+ :param _request_timeout: timeout setting for this request. If one
70
+ number provided, it will be total request
71
+ timeout. It can also be a pair (tuple) of
72
+ (connection, read) timeouts.
73
+ :type _request_timeout: int, tuple(int, int), optional
74
+ :param _request_auth: set to override the auth_settings for an a single
75
+ request; this effectively ignores the
76
+ authentication in the spec for a single request.
77
+ :type _request_auth: dict, optional
78
+ :param _content_type: force content-type for the request.
79
+ :type _content_type: str, Optional
80
+ :param _headers: set to override the headers for a single
81
+ request; this effectively ignores the headers
82
+ in the spec for a single request.
83
+ :type _headers: dict, optional
84
+ :param _host_index: set to override the host_index for a single
85
+ request; this effectively ignores the host_index
86
+ in the spec for a single request.
87
+ :type _host_index: int, optional
88
+ :return: Returns the result object.
89
+ """ # noqa: E501
90
+
91
+ _param = self._api_v1_workbench_urls_post_serialize(
92
+ request=request,
93
+ _request_auth=_request_auth,
94
+ _content_type=_content_type,
95
+ _headers=_headers,
96
+ _host_index=_host_index
97
+ )
98
+
99
+ _response_types_map: Dict[str, Optional[str]] = {
100
+ '200': "WorkbenchWorkbenchUrlCheckResponse",
101
+ '503': "WorkbenchWorkbenchUrlCheckResponse",
102
+ }
103
+ response_data = self.api_client.call_api(
104
+ *_param,
105
+ _request_timeout=_request_timeout
106
+ )
107
+ response_data.read()
108
+ return self.api_client.response_deserialize(
109
+ response_data=response_data,
110
+ response_types_map=_response_types_map,
111
+ ).data
112
+
113
+
114
+ @validate_call
115
+ def api_v1_workbench_urls_post_with_http_info(
116
+ self,
117
+ request: Annotated[WorkbenchWorkbenchUrlCheckRequest, Field(description="Body")],
118
+ _request_timeout: Union[
119
+ None,
120
+ Annotated[StrictFloat, Field(gt=0)],
121
+ Tuple[
122
+ Annotated[StrictFloat, Field(gt=0)],
123
+ Annotated[StrictFloat, Field(gt=0)]
124
+ ]
125
+ ] = None,
126
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
127
+ _content_type: Optional[StrictStr] = None,
128
+ _headers: Optional[Dict[StrictStr, Any]] = None,
129
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
130
+ ) -> ApiResponse[WorkbenchWorkbenchUrlCheckResponse]:
131
+ """Get Branding for a Workbench Url
132
+
133
+ Check a workbench url slug for branding
134
+
135
+ :param request: Body (required)
136
+ :type request: WorkbenchWorkbenchUrlCheckRequest
137
+ :param _request_timeout: timeout setting for this request. If one
138
+ number provided, it will be total request
139
+ timeout. It can also be a pair (tuple) of
140
+ (connection, read) timeouts.
141
+ :type _request_timeout: int, tuple(int, int), optional
142
+ :param _request_auth: set to override the auth_settings for an a single
143
+ request; this effectively ignores the
144
+ authentication in the spec for a single request.
145
+ :type _request_auth: dict, optional
146
+ :param _content_type: force content-type for the request.
147
+ :type _content_type: str, Optional
148
+ :param _headers: set to override the headers for a single
149
+ request; this effectively ignores the headers
150
+ in the spec for a single request.
151
+ :type _headers: dict, optional
152
+ :param _host_index: set to override the host_index for a single
153
+ request; this effectively ignores the host_index
154
+ in the spec for a single request.
155
+ :type _host_index: int, optional
156
+ :return: Returns the result object.
157
+ """ # noqa: E501
158
+
159
+ _param = self._api_v1_workbench_urls_post_serialize(
160
+ request=request,
161
+ _request_auth=_request_auth,
162
+ _content_type=_content_type,
163
+ _headers=_headers,
164
+ _host_index=_host_index
165
+ )
166
+
167
+ _response_types_map: Dict[str, Optional[str]] = {
168
+ '200': "WorkbenchWorkbenchUrlCheckResponse",
169
+ '503': "WorkbenchWorkbenchUrlCheckResponse",
170
+ }
171
+ response_data = self.api_client.call_api(
172
+ *_param,
173
+ _request_timeout=_request_timeout
174
+ )
175
+ response_data.read()
176
+ return self.api_client.response_deserialize(
177
+ response_data=response_data,
178
+ response_types_map=_response_types_map,
179
+ )
180
+
181
+
182
+ @validate_call
183
+ def api_v1_workbench_urls_post_without_preload_content(
184
+ self,
185
+ request: Annotated[WorkbenchWorkbenchUrlCheckRequest, Field(description="Body")],
186
+ _request_timeout: Union[
187
+ None,
188
+ Annotated[StrictFloat, Field(gt=0)],
189
+ Tuple[
190
+ Annotated[StrictFloat, Field(gt=0)],
191
+ Annotated[StrictFloat, Field(gt=0)]
192
+ ]
193
+ ] = None,
194
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
195
+ _content_type: Optional[StrictStr] = None,
196
+ _headers: Optional[Dict[StrictStr, Any]] = None,
197
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
198
+ ) -> RESTResponseType:
199
+ """Get Branding for a Workbench Url
200
+
201
+ Check a workbench url slug for branding
202
+
203
+ :param request: Body (required)
204
+ :type request: WorkbenchWorkbenchUrlCheckRequest
205
+ :param _request_timeout: timeout setting for this request. If one
206
+ number provided, it will be total request
207
+ timeout. It can also be a pair (tuple) of
208
+ (connection, read) timeouts.
209
+ :type _request_timeout: int, tuple(int, int), optional
210
+ :param _request_auth: set to override the auth_settings for an a single
211
+ request; this effectively ignores the
212
+ authentication in the spec for a single request.
213
+ :type _request_auth: dict, optional
214
+ :param _content_type: force content-type for the request.
215
+ :type _content_type: str, Optional
216
+ :param _headers: set to override the headers for a single
217
+ request; this effectively ignores the headers
218
+ in the spec for a single request.
219
+ :type _headers: dict, optional
220
+ :param _host_index: set to override the host_index for a single
221
+ request; this effectively ignores the host_index
222
+ in the spec for a single request.
223
+ :type _host_index: int, optional
224
+ :return: Returns the result object.
225
+ """ # noqa: E501
226
+
227
+ _param = self._api_v1_workbench_urls_post_serialize(
228
+ request=request,
229
+ _request_auth=_request_auth,
230
+ _content_type=_content_type,
231
+ _headers=_headers,
232
+ _host_index=_host_index
233
+ )
234
+
235
+ _response_types_map: Dict[str, Optional[str]] = {
236
+ '200': "WorkbenchWorkbenchUrlCheckResponse",
237
+ '503': "WorkbenchWorkbenchUrlCheckResponse",
238
+ }
239
+ response_data = self.api_client.call_api(
240
+ *_param,
241
+ _request_timeout=_request_timeout
242
+ )
243
+ return response_data.response
244
+
245
+
246
+ def _api_v1_workbench_urls_post_serialize(
247
+ self,
248
+ request,
249
+ _request_auth,
250
+ _content_type,
251
+ _headers,
252
+ _host_index,
253
+ ) -> RequestSerialized:
254
+
255
+ _host = None
256
+
257
+ _collection_formats: Dict[str, str] = {
258
+ }
259
+
260
+ _path_params: Dict[str, str] = {}
261
+ _query_params: List[Tuple[str, str]] = []
262
+ _header_params: Dict[str, Optional[str]] = _headers or {}
263
+ _form_params: List[Tuple[str, str]] = []
264
+ _files: Dict[
265
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
266
+ ] = {}
267
+ _body_params: Optional[bytes] = None
268
+
269
+ # process the path parameters
270
+ # process the query parameters
271
+ # process the header parameters
272
+ # process the form parameters
273
+ # process the body parameter
274
+ if request is not None:
275
+ _body_params = request
276
+
277
+
278
+ # set the HTTP header `Accept`
279
+ if 'Accept' not in _header_params:
280
+ _header_params['Accept'] = self.api_client.select_header_accept(
281
+ [
282
+ 'application/json'
283
+ ]
284
+ )
285
+
286
+
287
+ # authentication setting
288
+ _auth_settings: List[str] = [
289
+ 'ApiKeyAuth'
290
+ ]
291
+
292
+ return self.api_client.param_serialize(
293
+ method='POST',
294
+ resource_path='/api/v1/workbench/urls',
295
+ path_params=_path_params,
296
+ query_params=_query_params,
297
+ header_params=_header_params,
298
+ body=_body_params,
299
+ post_params=_form_params,
300
+ files=_files,
301
+ auth_settings=_auth_settings,
302
+ collection_formats=_collection_formats,
303
+ _host=_host,
304
+ _request_auth=_request_auth
305
+ )
306
+
307
+
308
+
309
+
310
+ @validate_call
311
+ def api_v1_workbench_versions_get(
312
+ self,
313
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
314
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
315
+ _request_timeout: Union[
316
+ None,
317
+ Annotated[StrictFloat, Field(gt=0)],
318
+ Tuple[
319
+ Annotated[StrictFloat, Field(gt=0)],
320
+ Annotated[StrictFloat, Field(gt=0)]
321
+ ]
322
+ ] = None,
323
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
324
+ _content_type: Optional[StrictStr] = None,
325
+ _headers: Optional[Dict[StrictStr, Any]] = None,
326
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
327
+ ) -> WorkbenchWorkbenchVersionManyResponse:
328
+ """Get Workbench Versions
329
+
330
+ Retrieve Workbench Versions
331
+
332
+ :param limit: Maximum number of records
333
+ :type limit: int
334
+ :param offset: Record offset
335
+ :type offset: int
336
+ :param _request_timeout: timeout setting for this request. If one
337
+ number provided, it will be total request
338
+ timeout. It can also be a pair (tuple) of
339
+ (connection, read) timeouts.
340
+ :type _request_timeout: int, tuple(int, int), optional
341
+ :param _request_auth: set to override the auth_settings for an a single
342
+ request; this effectively ignores the
343
+ authentication in the spec for a single request.
344
+ :type _request_auth: dict, optional
345
+ :param _content_type: force content-type for the request.
346
+ :type _content_type: str, Optional
347
+ :param _headers: set to override the headers for a single
348
+ request; this effectively ignores the headers
349
+ in the spec for a single request.
350
+ :type _headers: dict, optional
351
+ :param _host_index: set to override the host_index for a single
352
+ request; this effectively ignores the host_index
353
+ in the spec for a single request.
354
+ :type _host_index: int, optional
355
+ :return: Returns the result object.
356
+ """ # noqa: E501
357
+
358
+ _param = self._api_v1_workbench_versions_get_serialize(
359
+ limit=limit,
360
+ offset=offset,
361
+ _request_auth=_request_auth,
362
+ _content_type=_content_type,
363
+ _headers=_headers,
364
+ _host_index=_host_index
365
+ )
366
+
367
+ _response_types_map: Dict[str, Optional[str]] = {
368
+ '200': "WorkbenchWorkbenchVersionManyResponse",
369
+ '503': "WorkbenchWorkbenchVersionManyResponse",
370
+ }
371
+ response_data = self.api_client.call_api(
372
+ *_param,
373
+ _request_timeout=_request_timeout
374
+ )
375
+ response_data.read()
376
+ return self.api_client.response_deserialize(
377
+ response_data=response_data,
378
+ response_types_map=_response_types_map,
379
+ ).data
380
+
381
+
382
+ @validate_call
383
+ def api_v1_workbench_versions_get_with_http_info(
384
+ self,
385
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
386
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
387
+ _request_timeout: Union[
388
+ None,
389
+ Annotated[StrictFloat, Field(gt=0)],
390
+ Tuple[
391
+ Annotated[StrictFloat, Field(gt=0)],
392
+ Annotated[StrictFloat, Field(gt=0)]
393
+ ]
394
+ ] = None,
395
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
396
+ _content_type: Optional[StrictStr] = None,
397
+ _headers: Optional[Dict[StrictStr, Any]] = None,
398
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
399
+ ) -> ApiResponse[WorkbenchWorkbenchVersionManyResponse]:
400
+ """Get Workbench Versions
401
+
402
+ Retrieve Workbench Versions
403
+
404
+ :param limit: Maximum number of records
405
+ :type limit: int
406
+ :param offset: Record offset
407
+ :type offset: int
408
+ :param _request_timeout: timeout setting for this request. If one
409
+ number provided, it will be total request
410
+ timeout. It can also be a pair (tuple) of
411
+ (connection, read) timeouts.
412
+ :type _request_timeout: int, tuple(int, int), optional
413
+ :param _request_auth: set to override the auth_settings for an a single
414
+ request; this effectively ignores the
415
+ authentication in the spec for a single request.
416
+ :type _request_auth: dict, optional
417
+ :param _content_type: force content-type for the request.
418
+ :type _content_type: str, Optional
419
+ :param _headers: set to override the headers for a single
420
+ request; this effectively ignores the headers
421
+ in the spec for a single request.
422
+ :type _headers: dict, optional
423
+ :param _host_index: set to override the host_index for a single
424
+ request; this effectively ignores the host_index
425
+ in the spec for a single request.
426
+ :type _host_index: int, optional
427
+ :return: Returns the result object.
428
+ """ # noqa: E501
429
+
430
+ _param = self._api_v1_workbench_versions_get_serialize(
431
+ limit=limit,
432
+ offset=offset,
433
+ _request_auth=_request_auth,
434
+ _content_type=_content_type,
435
+ _headers=_headers,
436
+ _host_index=_host_index
437
+ )
438
+
439
+ _response_types_map: Dict[str, Optional[str]] = {
440
+ '200': "WorkbenchWorkbenchVersionManyResponse",
441
+ '503': "WorkbenchWorkbenchVersionManyResponse",
442
+ }
443
+ response_data = self.api_client.call_api(
444
+ *_param,
445
+ _request_timeout=_request_timeout
446
+ )
447
+ response_data.read()
448
+ return self.api_client.response_deserialize(
449
+ response_data=response_data,
450
+ response_types_map=_response_types_map,
451
+ )
452
+
453
+
454
+ @validate_call
455
+ def api_v1_workbench_versions_get_without_preload_content(
456
+ self,
457
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
458
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
459
+ _request_timeout: Union[
460
+ None,
461
+ Annotated[StrictFloat, Field(gt=0)],
462
+ Tuple[
463
+ Annotated[StrictFloat, Field(gt=0)],
464
+ Annotated[StrictFloat, Field(gt=0)]
465
+ ]
466
+ ] = None,
467
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
468
+ _content_type: Optional[StrictStr] = None,
469
+ _headers: Optional[Dict[StrictStr, Any]] = None,
470
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
471
+ ) -> RESTResponseType:
472
+ """Get Workbench Versions
473
+
474
+ Retrieve Workbench Versions
475
+
476
+ :param limit: Maximum number of records
477
+ :type limit: int
478
+ :param offset: Record offset
479
+ :type offset: int
480
+ :param _request_timeout: timeout setting for this request. If one
481
+ number provided, it will be total request
482
+ timeout. It can also be a pair (tuple) of
483
+ (connection, read) timeouts.
484
+ :type _request_timeout: int, tuple(int, int), optional
485
+ :param _request_auth: set to override the auth_settings for an a single
486
+ request; this effectively ignores the
487
+ authentication in the spec for a single request.
488
+ :type _request_auth: dict, optional
489
+ :param _content_type: force content-type for the request.
490
+ :type _content_type: str, Optional
491
+ :param _headers: set to override the headers for a single
492
+ request; this effectively ignores the headers
493
+ in the spec for a single request.
494
+ :type _headers: dict, optional
495
+ :param _host_index: set to override the host_index for a single
496
+ request; this effectively ignores the host_index
497
+ in the spec for a single request.
498
+ :type _host_index: int, optional
499
+ :return: Returns the result object.
500
+ """ # noqa: E501
501
+
502
+ _param = self._api_v1_workbench_versions_get_serialize(
503
+ limit=limit,
504
+ offset=offset,
505
+ _request_auth=_request_auth,
506
+ _content_type=_content_type,
507
+ _headers=_headers,
508
+ _host_index=_host_index
509
+ )
510
+
511
+ _response_types_map: Dict[str, Optional[str]] = {
512
+ '200': "WorkbenchWorkbenchVersionManyResponse",
513
+ '503': "WorkbenchWorkbenchVersionManyResponse",
514
+ }
515
+ response_data = self.api_client.call_api(
516
+ *_param,
517
+ _request_timeout=_request_timeout
518
+ )
519
+ return response_data.response
520
+
521
+
522
+ def _api_v1_workbench_versions_get_serialize(
523
+ self,
524
+ limit,
525
+ offset,
526
+ _request_auth,
527
+ _content_type,
528
+ _headers,
529
+ _host_index,
530
+ ) -> RequestSerialized:
531
+
532
+ _host = None
533
+
534
+ _collection_formats: Dict[str, str] = {
535
+ }
536
+
537
+ _path_params: Dict[str, str] = {}
538
+ _query_params: List[Tuple[str, str]] = []
539
+ _header_params: Dict[str, Optional[str]] = _headers or {}
540
+ _form_params: List[Tuple[str, str]] = []
541
+ _files: Dict[
542
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
543
+ ] = {}
544
+ _body_params: Optional[bytes] = None
545
+
546
+ # process the path parameters
547
+ # process the query parameters
548
+ if limit is not None:
549
+
550
+ _query_params.append(('limit', limit))
551
+
552
+ if offset is not None:
553
+
554
+ _query_params.append(('offset', offset))
555
+
556
+ # process the header parameters
557
+ # process the form parameters
558
+ # process the body parameter
559
+
560
+
561
+ # set the HTTP header `Accept`
562
+ if 'Accept' not in _header_params:
563
+ _header_params['Accept'] = self.api_client.select_header_accept(
564
+ [
565
+ 'application/json'
566
+ ]
567
+ )
568
+
569
+
570
+ # authentication setting
571
+ _auth_settings: List[str] = [
572
+ 'ApiKeyAuth'
573
+ ]
574
+
575
+ return self.api_client.param_serialize(
576
+ method='GET',
577
+ resource_path='/api/v1/workbench/versions',
578
+ path_params=_path_params,
579
+ query_params=_query_params,
580
+ header_params=_header_params,
581
+ body=_body_params,
582
+ post_params=_form_params,
583
+ files=_files,
584
+ auth_settings=_auth_settings,
585
+ collection_formats=_collection_formats,
586
+ _host=_host,
587
+ _request_auth=_request_auth
588
+ )
589
+
590
+
591
+
592
+
593
+ @validate_call
594
+ def api_v1_workbench_versions_post(
595
+ self,
596
+ request: Annotated[WorkbenchWorkbenchVersionUpsertRequest, Field(description="Body")],
597
+ _request_timeout: Union[
598
+ None,
599
+ Annotated[StrictFloat, Field(gt=0)],
600
+ Tuple[
601
+ Annotated[StrictFloat, Field(gt=0)],
602
+ Annotated[StrictFloat, Field(gt=0)]
603
+ ]
604
+ ] = None,
605
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
606
+ _content_type: Optional[StrictStr] = None,
607
+ _headers: Optional[Dict[StrictStr, Any]] = None,
608
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
609
+ ) -> WorkbenchWorkbenchVersionResponse:
610
+ """UpsertCustomer a Workbench Version
611
+
612
+ Inserts a Workbench Version into the db when the `id` is `0`. Updates when the `id` is `1` or greater. Config is intended to be a JSON object, or null.
613
+
614
+ :param request: Body (required)
615
+ :type request: WorkbenchWorkbenchVersionUpsertRequest
616
+ :param _request_timeout: timeout setting for this request. If one
617
+ number provided, it will be total request
618
+ timeout. It can also be a pair (tuple) of
619
+ (connection, read) timeouts.
620
+ :type _request_timeout: int, tuple(int, int), optional
621
+ :param _request_auth: set to override the auth_settings for an a single
622
+ request; this effectively ignores the
623
+ authentication in the spec for a single request.
624
+ :type _request_auth: dict, optional
625
+ :param _content_type: force content-type for the request.
626
+ :type _content_type: str, Optional
627
+ :param _headers: set to override the headers for a single
628
+ request; this effectively ignores the headers
629
+ in the spec for a single request.
630
+ :type _headers: dict, optional
631
+ :param _host_index: set to override the host_index for a single
632
+ request; this effectively ignores the host_index
633
+ in the spec for a single request.
634
+ :type _host_index: int, optional
635
+ :return: Returns the result object.
636
+ """ # noqa: E501
637
+
638
+ _param = self._api_v1_workbench_versions_post_serialize(
639
+ request=request,
640
+ _request_auth=_request_auth,
641
+ _content_type=_content_type,
642
+ _headers=_headers,
643
+ _host_index=_host_index
644
+ )
645
+
646
+ _response_types_map: Dict[str, Optional[str]] = {
647
+ '200': "WorkbenchWorkbenchVersionResponse",
648
+ '400': "WorkbenchWorkbenchVersionResponse",
649
+ '503': "WorkbenchWorkbenchVersionResponse",
650
+ }
651
+ response_data = self.api_client.call_api(
652
+ *_param,
653
+ _request_timeout=_request_timeout
654
+ )
655
+ response_data.read()
656
+ return self.api_client.response_deserialize(
657
+ response_data=response_data,
658
+ response_types_map=_response_types_map,
659
+ ).data
660
+
661
+
662
+ @validate_call
663
+ def api_v1_workbench_versions_post_with_http_info(
664
+ self,
665
+ request: Annotated[WorkbenchWorkbenchVersionUpsertRequest, Field(description="Body")],
666
+ _request_timeout: Union[
667
+ None,
668
+ Annotated[StrictFloat, Field(gt=0)],
669
+ Tuple[
670
+ Annotated[StrictFloat, Field(gt=0)],
671
+ Annotated[StrictFloat, Field(gt=0)]
672
+ ]
673
+ ] = None,
674
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
675
+ _content_type: Optional[StrictStr] = None,
676
+ _headers: Optional[Dict[StrictStr, Any]] = None,
677
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
678
+ ) -> ApiResponse[WorkbenchWorkbenchVersionResponse]:
679
+ """UpsertCustomer a Workbench Version
680
+
681
+ Inserts a Workbench Version into the db when the `id` is `0`. Updates when the `id` is `1` or greater. Config is intended to be a JSON object, or null.
682
+
683
+ :param request: Body (required)
684
+ :type request: WorkbenchWorkbenchVersionUpsertRequest
685
+ :param _request_timeout: timeout setting for this request. If one
686
+ number provided, it will be total request
687
+ timeout. It can also be a pair (tuple) of
688
+ (connection, read) timeouts.
689
+ :type _request_timeout: int, tuple(int, int), optional
690
+ :param _request_auth: set to override the auth_settings for an a single
691
+ request; this effectively ignores the
692
+ authentication in the spec for a single request.
693
+ :type _request_auth: dict, optional
694
+ :param _content_type: force content-type for the request.
695
+ :type _content_type: str, Optional
696
+ :param _headers: set to override the headers for a single
697
+ request; this effectively ignores the headers
698
+ in the spec for a single request.
699
+ :type _headers: dict, optional
700
+ :param _host_index: set to override the host_index for a single
701
+ request; this effectively ignores the host_index
702
+ in the spec for a single request.
703
+ :type _host_index: int, optional
704
+ :return: Returns the result object.
705
+ """ # noqa: E501
706
+
707
+ _param = self._api_v1_workbench_versions_post_serialize(
708
+ request=request,
709
+ _request_auth=_request_auth,
710
+ _content_type=_content_type,
711
+ _headers=_headers,
712
+ _host_index=_host_index
713
+ )
714
+
715
+ _response_types_map: Dict[str, Optional[str]] = {
716
+ '200': "WorkbenchWorkbenchVersionResponse",
717
+ '400': "WorkbenchWorkbenchVersionResponse",
718
+ '503': "WorkbenchWorkbenchVersionResponse",
719
+ }
720
+ response_data = self.api_client.call_api(
721
+ *_param,
722
+ _request_timeout=_request_timeout
723
+ )
724
+ response_data.read()
725
+ return self.api_client.response_deserialize(
726
+ response_data=response_data,
727
+ response_types_map=_response_types_map,
728
+ )
729
+
730
+
731
+ @validate_call
732
+ def api_v1_workbench_versions_post_without_preload_content(
733
+ self,
734
+ request: Annotated[WorkbenchWorkbenchVersionUpsertRequest, Field(description="Body")],
735
+ _request_timeout: Union[
736
+ None,
737
+ Annotated[StrictFloat, Field(gt=0)],
738
+ Tuple[
739
+ Annotated[StrictFloat, Field(gt=0)],
740
+ Annotated[StrictFloat, Field(gt=0)]
741
+ ]
742
+ ] = None,
743
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
744
+ _content_type: Optional[StrictStr] = None,
745
+ _headers: Optional[Dict[StrictStr, Any]] = None,
746
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
747
+ ) -> RESTResponseType:
748
+ """UpsertCustomer a Workbench Version
749
+
750
+ Inserts a Workbench Version into the db when the `id` is `0`. Updates when the `id` is `1` or greater. Config is intended to be a JSON object, or null.
751
+
752
+ :param request: Body (required)
753
+ :type request: WorkbenchWorkbenchVersionUpsertRequest
754
+ :param _request_timeout: timeout setting for this request. If one
755
+ number provided, it will be total request
756
+ timeout. It can also be a pair (tuple) of
757
+ (connection, read) timeouts.
758
+ :type _request_timeout: int, tuple(int, int), optional
759
+ :param _request_auth: set to override the auth_settings for an a single
760
+ request; this effectively ignores the
761
+ authentication in the spec for a single request.
762
+ :type _request_auth: dict, optional
763
+ :param _content_type: force content-type for the request.
764
+ :type _content_type: str, Optional
765
+ :param _headers: set to override the headers for a single
766
+ request; this effectively ignores the headers
767
+ in the spec for a single request.
768
+ :type _headers: dict, optional
769
+ :param _host_index: set to override the host_index for a single
770
+ request; this effectively ignores the host_index
771
+ in the spec for a single request.
772
+ :type _host_index: int, optional
773
+ :return: Returns the result object.
774
+ """ # noqa: E501
775
+
776
+ _param = self._api_v1_workbench_versions_post_serialize(
777
+ request=request,
778
+ _request_auth=_request_auth,
779
+ _content_type=_content_type,
780
+ _headers=_headers,
781
+ _host_index=_host_index
782
+ )
783
+
784
+ _response_types_map: Dict[str, Optional[str]] = {
785
+ '200': "WorkbenchWorkbenchVersionResponse",
786
+ '400': "WorkbenchWorkbenchVersionResponse",
787
+ '503': "WorkbenchWorkbenchVersionResponse",
788
+ }
789
+ response_data = self.api_client.call_api(
790
+ *_param,
791
+ _request_timeout=_request_timeout
792
+ )
793
+ return response_data.response
794
+
795
+
796
+ def _api_v1_workbench_versions_post_serialize(
797
+ self,
798
+ request,
799
+ _request_auth,
800
+ _content_type,
801
+ _headers,
802
+ _host_index,
803
+ ) -> RequestSerialized:
804
+
805
+ _host = None
806
+
807
+ _collection_formats: Dict[str, str] = {
808
+ }
809
+
810
+ _path_params: Dict[str, str] = {}
811
+ _query_params: List[Tuple[str, str]] = []
812
+ _header_params: Dict[str, Optional[str]] = _headers or {}
813
+ _form_params: List[Tuple[str, str]] = []
814
+ _files: Dict[
815
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
816
+ ] = {}
817
+ _body_params: Optional[bytes] = None
818
+
819
+ # process the path parameters
820
+ # process the query parameters
821
+ # process the header parameters
822
+ # process the form parameters
823
+ # process the body parameter
824
+ if request is not None:
825
+ _body_params = request
826
+
827
+
828
+ # set the HTTP header `Accept`
829
+ if 'Accept' not in _header_params:
830
+ _header_params['Accept'] = self.api_client.select_header_accept(
831
+ [
832
+ 'application/json'
833
+ ]
834
+ )
835
+
836
+
837
+ # authentication setting
838
+ _auth_settings: List[str] = [
839
+ 'ApiKeyAuth'
840
+ ]
841
+
842
+ return self.api_client.param_serialize(
843
+ method='POST',
844
+ resource_path='/api/v1/workbench/versions',
845
+ path_params=_path_params,
846
+ query_params=_query_params,
847
+ header_params=_header_params,
848
+ body=_body_params,
849
+ post_params=_form_params,
850
+ files=_files,
851
+ auth_settings=_auth_settings,
852
+ collection_formats=_collection_formats,
853
+ _host=_host,
854
+ _request_auth=_request_auth
855
+ )
856
+
857
+