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,1049 @@
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, StrictStr
20
+ from typing_extensions import Annotated
21
+ from neurograph.v1.models.lookup_lookup_language_response import LookupLookupLanguageResponse
22
+ from neurograph.v1.models.lookup_lookup_state_response import LookupLookupStateResponse
23
+ from neurograph.v1.models.lookup_state_response import LookupStateResponse
24
+
25
+ from neurograph.v1.api_client import ApiClient, RequestSerialized
26
+ from neurograph.v1.api_response import ApiResponse
27
+ from neurograph.v1.rest import RESTResponseType
28
+
29
+
30
+ class LookupApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ def api_v1_lookup_environments_get(
45
+ self,
46
+ _request_timeout: Union[
47
+ None,
48
+ Annotated[StrictFloat, Field(gt=0)],
49
+ Tuple[
50
+ Annotated[StrictFloat, Field(gt=0)],
51
+ Annotated[StrictFloat, Field(gt=0)]
52
+ ]
53
+ ] = None,
54
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
55
+ _content_type: Optional[StrictStr] = None,
56
+ _headers: Optional[Dict[StrictStr, Any]] = None,
57
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
58
+ ) -> LookupLookupStateResponse:
59
+ """Get Environments
60
+
61
+ Retrieve Environments that are possible for Client's URLs
62
+
63
+ :param _request_timeout: timeout setting for this request. If one
64
+ number provided, it will be total request
65
+ timeout. It can also be a pair (tuple) of
66
+ (connection, read) timeouts.
67
+ :type _request_timeout: int, tuple(int, int), optional
68
+ :param _request_auth: set to override the auth_settings for an a single
69
+ request; this effectively ignores the
70
+ authentication in the spec for a single request.
71
+ :type _request_auth: dict, optional
72
+ :param _content_type: force content-type for the request.
73
+ :type _content_type: str, Optional
74
+ :param _headers: set to override the headers for a single
75
+ request; this effectively ignores the headers
76
+ in the spec for a single request.
77
+ :type _headers: dict, optional
78
+ :param _host_index: set to override the host_index for a single
79
+ request; this effectively ignores the host_index
80
+ in the spec for a single request.
81
+ :type _host_index: int, optional
82
+ :return: Returns the result object.
83
+ """ # noqa: E501
84
+
85
+ _param = self._api_v1_lookup_environments_get_serialize(
86
+ _request_auth=_request_auth,
87
+ _content_type=_content_type,
88
+ _headers=_headers,
89
+ _host_index=_host_index
90
+ )
91
+
92
+ _response_types_map: Dict[str, Optional[str]] = {
93
+ '200': "LookupLookupStateResponse",
94
+ '503': "LookupLookupStateResponse",
95
+ }
96
+ response_data = self.api_client.call_api(
97
+ *_param,
98
+ _request_timeout=_request_timeout
99
+ )
100
+ response_data.read()
101
+ return self.api_client.response_deserialize(
102
+ response_data=response_data,
103
+ response_types_map=_response_types_map,
104
+ ).data
105
+
106
+
107
+ @validate_call
108
+ def api_v1_lookup_environments_get_with_http_info(
109
+ self,
110
+ _request_timeout: Union[
111
+ None,
112
+ Annotated[StrictFloat, Field(gt=0)],
113
+ Tuple[
114
+ Annotated[StrictFloat, Field(gt=0)],
115
+ Annotated[StrictFloat, Field(gt=0)]
116
+ ]
117
+ ] = None,
118
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
119
+ _content_type: Optional[StrictStr] = None,
120
+ _headers: Optional[Dict[StrictStr, Any]] = None,
121
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
122
+ ) -> ApiResponse[LookupLookupStateResponse]:
123
+ """Get Environments
124
+
125
+ Retrieve Environments that are possible for Client's URLs
126
+
127
+ :param _request_timeout: timeout setting for this request. If one
128
+ number provided, it will be total request
129
+ timeout. It can also be a pair (tuple) of
130
+ (connection, read) timeouts.
131
+ :type _request_timeout: int, tuple(int, int), optional
132
+ :param _request_auth: set to override the auth_settings for an a single
133
+ request; this effectively ignores the
134
+ authentication in the spec for a single request.
135
+ :type _request_auth: dict, optional
136
+ :param _content_type: force content-type for the request.
137
+ :type _content_type: str, Optional
138
+ :param _headers: set to override the headers for a single
139
+ request; this effectively ignores the headers
140
+ in the spec for a single request.
141
+ :type _headers: dict, optional
142
+ :param _host_index: set to override the host_index for a single
143
+ request; this effectively ignores the host_index
144
+ in the spec for a single request.
145
+ :type _host_index: int, optional
146
+ :return: Returns the result object.
147
+ """ # noqa: E501
148
+
149
+ _param = self._api_v1_lookup_environments_get_serialize(
150
+ _request_auth=_request_auth,
151
+ _content_type=_content_type,
152
+ _headers=_headers,
153
+ _host_index=_host_index
154
+ )
155
+
156
+ _response_types_map: Dict[str, Optional[str]] = {
157
+ '200': "LookupLookupStateResponse",
158
+ '503': "LookupLookupStateResponse",
159
+ }
160
+ response_data = self.api_client.call_api(
161
+ *_param,
162
+ _request_timeout=_request_timeout
163
+ )
164
+ response_data.read()
165
+ return self.api_client.response_deserialize(
166
+ response_data=response_data,
167
+ response_types_map=_response_types_map,
168
+ )
169
+
170
+
171
+ @validate_call
172
+ def api_v1_lookup_environments_get_without_preload_content(
173
+ self,
174
+ _request_timeout: Union[
175
+ None,
176
+ Annotated[StrictFloat, Field(gt=0)],
177
+ Tuple[
178
+ Annotated[StrictFloat, Field(gt=0)],
179
+ Annotated[StrictFloat, Field(gt=0)]
180
+ ]
181
+ ] = None,
182
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
183
+ _content_type: Optional[StrictStr] = None,
184
+ _headers: Optional[Dict[StrictStr, Any]] = None,
185
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
186
+ ) -> RESTResponseType:
187
+ """Get Environments
188
+
189
+ Retrieve Environments that are possible for Client's URLs
190
+
191
+ :param _request_timeout: timeout setting for this request. If one
192
+ number provided, it will be total request
193
+ timeout. It can also be a pair (tuple) of
194
+ (connection, read) timeouts.
195
+ :type _request_timeout: int, tuple(int, int), optional
196
+ :param _request_auth: set to override the auth_settings for an a single
197
+ request; this effectively ignores the
198
+ authentication in the spec for a single request.
199
+ :type _request_auth: dict, optional
200
+ :param _content_type: force content-type for the request.
201
+ :type _content_type: str, Optional
202
+ :param _headers: set to override the headers for a single
203
+ request; this effectively ignores the headers
204
+ in the spec for a single request.
205
+ :type _headers: dict, optional
206
+ :param _host_index: set to override the host_index for a single
207
+ request; this effectively ignores the host_index
208
+ in the spec for a single request.
209
+ :type _host_index: int, optional
210
+ :return: Returns the result object.
211
+ """ # noqa: E501
212
+
213
+ _param = self._api_v1_lookup_environments_get_serialize(
214
+ _request_auth=_request_auth,
215
+ _content_type=_content_type,
216
+ _headers=_headers,
217
+ _host_index=_host_index
218
+ )
219
+
220
+ _response_types_map: Dict[str, Optional[str]] = {
221
+ '200': "LookupLookupStateResponse",
222
+ '503': "LookupLookupStateResponse",
223
+ }
224
+ response_data = self.api_client.call_api(
225
+ *_param,
226
+ _request_timeout=_request_timeout
227
+ )
228
+ return response_data.response
229
+
230
+
231
+ def _api_v1_lookup_environments_get_serialize(
232
+ self,
233
+ _request_auth,
234
+ _content_type,
235
+ _headers,
236
+ _host_index,
237
+ ) -> RequestSerialized:
238
+
239
+ _host = None
240
+
241
+ _collection_formats: Dict[str, str] = {
242
+ }
243
+
244
+ _path_params: Dict[str, str] = {}
245
+ _query_params: List[Tuple[str, str]] = []
246
+ _header_params: Dict[str, Optional[str]] = _headers or {}
247
+ _form_params: List[Tuple[str, str]] = []
248
+ _files: Dict[
249
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
250
+ ] = {}
251
+ _body_params: Optional[bytes] = None
252
+
253
+ # process the path parameters
254
+ # process the query parameters
255
+ # process the header parameters
256
+ # process the form parameters
257
+ # process the body parameter
258
+
259
+
260
+ # set the HTTP header `Accept`
261
+ if 'Accept' not in _header_params:
262
+ _header_params['Accept'] = self.api_client.select_header_accept(
263
+ [
264
+ 'application/json'
265
+ ]
266
+ )
267
+
268
+
269
+ # authentication setting
270
+ _auth_settings: List[str] = [
271
+ 'ApiKeyAuth'
272
+ ]
273
+
274
+ return self.api_client.param_serialize(
275
+ method='GET',
276
+ resource_path='/api/v1/lookup/environments',
277
+ path_params=_path_params,
278
+ query_params=_query_params,
279
+ header_params=_header_params,
280
+ body=_body_params,
281
+ post_params=_form_params,
282
+ files=_files,
283
+ auth_settings=_auth_settings,
284
+ collection_formats=_collection_formats,
285
+ _host=_host,
286
+ _request_auth=_request_auth
287
+ )
288
+
289
+
290
+
291
+
292
+ @validate_call
293
+ def api_v1_lookup_languages_get(
294
+ self,
295
+ _request_timeout: Union[
296
+ None,
297
+ Annotated[StrictFloat, Field(gt=0)],
298
+ Tuple[
299
+ Annotated[StrictFloat, Field(gt=0)],
300
+ Annotated[StrictFloat, Field(gt=0)]
301
+ ]
302
+ ] = None,
303
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
304
+ _content_type: Optional[StrictStr] = None,
305
+ _headers: Optional[Dict[StrictStr, Any]] = None,
306
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
307
+ ) -> LookupLookupLanguageResponse:
308
+ """Lookup Supported Languages
309
+
310
+ Lookup Supported Languages
311
+
312
+ :param _request_timeout: timeout setting for this request. If one
313
+ number provided, it will be total request
314
+ timeout. It can also be a pair (tuple) of
315
+ (connection, read) timeouts.
316
+ :type _request_timeout: int, tuple(int, int), optional
317
+ :param _request_auth: set to override the auth_settings for an a single
318
+ request; this effectively ignores the
319
+ authentication in the spec for a single request.
320
+ :type _request_auth: dict, optional
321
+ :param _content_type: force content-type for the request.
322
+ :type _content_type: str, Optional
323
+ :param _headers: set to override the headers for a single
324
+ request; this effectively ignores the headers
325
+ in the spec for a single request.
326
+ :type _headers: dict, optional
327
+ :param _host_index: set to override the host_index for a single
328
+ request; this effectively ignores the host_index
329
+ in the spec for a single request.
330
+ :type _host_index: int, optional
331
+ :return: Returns the result object.
332
+ """ # noqa: E501
333
+
334
+ _param = self._api_v1_lookup_languages_get_serialize(
335
+ _request_auth=_request_auth,
336
+ _content_type=_content_type,
337
+ _headers=_headers,
338
+ _host_index=_host_index
339
+ )
340
+
341
+ _response_types_map: Dict[str, Optional[str]] = {
342
+ '200': "LookupLookupLanguageResponse",
343
+ '503': "LookupLookupLanguageResponse",
344
+ }
345
+ response_data = self.api_client.call_api(
346
+ *_param,
347
+ _request_timeout=_request_timeout
348
+ )
349
+ response_data.read()
350
+ return self.api_client.response_deserialize(
351
+ response_data=response_data,
352
+ response_types_map=_response_types_map,
353
+ ).data
354
+
355
+
356
+ @validate_call
357
+ def api_v1_lookup_languages_get_with_http_info(
358
+ self,
359
+ _request_timeout: Union[
360
+ None,
361
+ Annotated[StrictFloat, Field(gt=0)],
362
+ Tuple[
363
+ Annotated[StrictFloat, Field(gt=0)],
364
+ Annotated[StrictFloat, Field(gt=0)]
365
+ ]
366
+ ] = None,
367
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
368
+ _content_type: Optional[StrictStr] = None,
369
+ _headers: Optional[Dict[StrictStr, Any]] = None,
370
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
371
+ ) -> ApiResponse[LookupLookupLanguageResponse]:
372
+ """Lookup Supported Languages
373
+
374
+ Lookup Supported Languages
375
+
376
+ :param _request_timeout: timeout setting for this request. If one
377
+ number provided, it will be total request
378
+ timeout. It can also be a pair (tuple) of
379
+ (connection, read) timeouts.
380
+ :type _request_timeout: int, tuple(int, int), optional
381
+ :param _request_auth: set to override the auth_settings for an a single
382
+ request; this effectively ignores the
383
+ authentication in the spec for a single request.
384
+ :type _request_auth: dict, optional
385
+ :param _content_type: force content-type for the request.
386
+ :type _content_type: str, Optional
387
+ :param _headers: set to override the headers for a single
388
+ request; this effectively ignores the headers
389
+ in the spec for a single request.
390
+ :type _headers: dict, optional
391
+ :param _host_index: set to override the host_index for a single
392
+ request; this effectively ignores the host_index
393
+ in the spec for a single request.
394
+ :type _host_index: int, optional
395
+ :return: Returns the result object.
396
+ """ # noqa: E501
397
+
398
+ _param = self._api_v1_lookup_languages_get_serialize(
399
+ _request_auth=_request_auth,
400
+ _content_type=_content_type,
401
+ _headers=_headers,
402
+ _host_index=_host_index
403
+ )
404
+
405
+ _response_types_map: Dict[str, Optional[str]] = {
406
+ '200': "LookupLookupLanguageResponse",
407
+ '503': "LookupLookupLanguageResponse",
408
+ }
409
+ response_data = self.api_client.call_api(
410
+ *_param,
411
+ _request_timeout=_request_timeout
412
+ )
413
+ response_data.read()
414
+ return self.api_client.response_deserialize(
415
+ response_data=response_data,
416
+ response_types_map=_response_types_map,
417
+ )
418
+
419
+
420
+ @validate_call
421
+ def api_v1_lookup_languages_get_without_preload_content(
422
+ self,
423
+ _request_timeout: Union[
424
+ None,
425
+ Annotated[StrictFloat, Field(gt=0)],
426
+ Tuple[
427
+ Annotated[StrictFloat, Field(gt=0)],
428
+ Annotated[StrictFloat, Field(gt=0)]
429
+ ]
430
+ ] = None,
431
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
432
+ _content_type: Optional[StrictStr] = None,
433
+ _headers: Optional[Dict[StrictStr, Any]] = None,
434
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
435
+ ) -> RESTResponseType:
436
+ """Lookup Supported Languages
437
+
438
+ Lookup Supported Languages
439
+
440
+ :param _request_timeout: timeout setting for this request. If one
441
+ number provided, it will be total request
442
+ timeout. It can also be a pair (tuple) of
443
+ (connection, read) timeouts.
444
+ :type _request_timeout: int, tuple(int, int), optional
445
+ :param _request_auth: set to override the auth_settings for an a single
446
+ request; this effectively ignores the
447
+ authentication in the spec for a single request.
448
+ :type _request_auth: dict, optional
449
+ :param _content_type: force content-type for the request.
450
+ :type _content_type: str, Optional
451
+ :param _headers: set to override the headers for a single
452
+ request; this effectively ignores the headers
453
+ in the spec for a single request.
454
+ :type _headers: dict, optional
455
+ :param _host_index: set to override the host_index for a single
456
+ request; this effectively ignores the host_index
457
+ in the spec for a single request.
458
+ :type _host_index: int, optional
459
+ :return: Returns the result object.
460
+ """ # noqa: E501
461
+
462
+ _param = self._api_v1_lookup_languages_get_serialize(
463
+ _request_auth=_request_auth,
464
+ _content_type=_content_type,
465
+ _headers=_headers,
466
+ _host_index=_host_index
467
+ )
468
+
469
+ _response_types_map: Dict[str, Optional[str]] = {
470
+ '200': "LookupLookupLanguageResponse",
471
+ '503': "LookupLookupLanguageResponse",
472
+ }
473
+ response_data = self.api_client.call_api(
474
+ *_param,
475
+ _request_timeout=_request_timeout
476
+ )
477
+ return response_data.response
478
+
479
+
480
+ def _api_v1_lookup_languages_get_serialize(
481
+ self,
482
+ _request_auth,
483
+ _content_type,
484
+ _headers,
485
+ _host_index,
486
+ ) -> RequestSerialized:
487
+
488
+ _host = None
489
+
490
+ _collection_formats: Dict[str, str] = {
491
+ }
492
+
493
+ _path_params: Dict[str, str] = {}
494
+ _query_params: List[Tuple[str, str]] = []
495
+ _header_params: Dict[str, Optional[str]] = _headers or {}
496
+ _form_params: List[Tuple[str, str]] = []
497
+ _files: Dict[
498
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
499
+ ] = {}
500
+ _body_params: Optional[bytes] = None
501
+
502
+ # process the path parameters
503
+ # process the query parameters
504
+ # process the header parameters
505
+ # process the form parameters
506
+ # process the body parameter
507
+
508
+
509
+ # set the HTTP header `Accept`
510
+ if 'Accept' not in _header_params:
511
+ _header_params['Accept'] = self.api_client.select_header_accept(
512
+ [
513
+ 'application/json'
514
+ ]
515
+ )
516
+
517
+
518
+ # authentication setting
519
+ _auth_settings: List[str] = [
520
+ 'ApiKeyAuth'
521
+ ]
522
+
523
+ return self.api_client.param_serialize(
524
+ method='GET',
525
+ resource_path='/api/v1/lookup/languages',
526
+ path_params=_path_params,
527
+ query_params=_query_params,
528
+ header_params=_header_params,
529
+ body=_body_params,
530
+ post_params=_form_params,
531
+ files=_files,
532
+ auth_settings=_auth_settings,
533
+ collection_formats=_collection_formats,
534
+ _host=_host,
535
+ _request_auth=_request_auth
536
+ )
537
+
538
+
539
+
540
+
541
+ @validate_call
542
+ def api_v1_lookup_states_code_get(
543
+ self,
544
+ code: Annotated[StrictStr, Field(description="State two letter code")],
545
+ _request_timeout: Union[
546
+ None,
547
+ Annotated[StrictFloat, Field(gt=0)],
548
+ Tuple[
549
+ Annotated[StrictFloat, Field(gt=0)],
550
+ Annotated[StrictFloat, Field(gt=0)]
551
+ ]
552
+ ] = None,
553
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
554
+ _content_type: Optional[StrictStr] = None,
555
+ _headers: Optional[Dict[StrictStr, Any]] = None,
556
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
557
+ ) -> LookupStateResponse:
558
+ """Get US State by Code
559
+
560
+ Retrieve a US State by its code
561
+
562
+ :param code: State two letter code (required)
563
+ :type code: str
564
+ :param _request_timeout: timeout setting for this request. If one
565
+ number provided, it will be total request
566
+ timeout. It can also be a pair (tuple) of
567
+ (connection, read) timeouts.
568
+ :type _request_timeout: int, tuple(int, int), optional
569
+ :param _request_auth: set to override the auth_settings for an a single
570
+ request; this effectively ignores the
571
+ authentication in the spec for a single request.
572
+ :type _request_auth: dict, optional
573
+ :param _content_type: force content-type for the request.
574
+ :type _content_type: str, Optional
575
+ :param _headers: set to override the headers for a single
576
+ request; this effectively ignores the headers
577
+ in the spec for a single request.
578
+ :type _headers: dict, optional
579
+ :param _host_index: set to override the host_index for a single
580
+ request; this effectively ignores the host_index
581
+ in the spec for a single request.
582
+ :type _host_index: int, optional
583
+ :return: Returns the result object.
584
+ """ # noqa: E501
585
+
586
+ _param = self._api_v1_lookup_states_code_get_serialize(
587
+ code=code,
588
+ _request_auth=_request_auth,
589
+ _content_type=_content_type,
590
+ _headers=_headers,
591
+ _host_index=_host_index
592
+ )
593
+
594
+ _response_types_map: Dict[str, Optional[str]] = {
595
+ '200': "LookupStateResponse",
596
+ '503': "LookupStateResponse",
597
+ }
598
+ response_data = self.api_client.call_api(
599
+ *_param,
600
+ _request_timeout=_request_timeout
601
+ )
602
+ response_data.read()
603
+ return self.api_client.response_deserialize(
604
+ response_data=response_data,
605
+ response_types_map=_response_types_map,
606
+ ).data
607
+
608
+
609
+ @validate_call
610
+ def api_v1_lookup_states_code_get_with_http_info(
611
+ self,
612
+ code: Annotated[StrictStr, Field(description="State two letter code")],
613
+ _request_timeout: Union[
614
+ None,
615
+ Annotated[StrictFloat, Field(gt=0)],
616
+ Tuple[
617
+ Annotated[StrictFloat, Field(gt=0)],
618
+ Annotated[StrictFloat, Field(gt=0)]
619
+ ]
620
+ ] = None,
621
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
622
+ _content_type: Optional[StrictStr] = None,
623
+ _headers: Optional[Dict[StrictStr, Any]] = None,
624
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
625
+ ) -> ApiResponse[LookupStateResponse]:
626
+ """Get US State by Code
627
+
628
+ Retrieve a US State by its code
629
+
630
+ :param code: State two letter code (required)
631
+ :type code: str
632
+ :param _request_timeout: timeout setting for this request. If one
633
+ number provided, it will be total request
634
+ timeout. It can also be a pair (tuple) of
635
+ (connection, read) timeouts.
636
+ :type _request_timeout: int, tuple(int, int), optional
637
+ :param _request_auth: set to override the auth_settings for an a single
638
+ request; this effectively ignores the
639
+ authentication in the spec for a single request.
640
+ :type _request_auth: dict, optional
641
+ :param _content_type: force content-type for the request.
642
+ :type _content_type: str, Optional
643
+ :param _headers: set to override the headers for a single
644
+ request; this effectively ignores the headers
645
+ in the spec for a single request.
646
+ :type _headers: dict, optional
647
+ :param _host_index: set to override the host_index for a single
648
+ request; this effectively ignores the host_index
649
+ in the spec for a single request.
650
+ :type _host_index: int, optional
651
+ :return: Returns the result object.
652
+ """ # noqa: E501
653
+
654
+ _param = self._api_v1_lookup_states_code_get_serialize(
655
+ code=code,
656
+ _request_auth=_request_auth,
657
+ _content_type=_content_type,
658
+ _headers=_headers,
659
+ _host_index=_host_index
660
+ )
661
+
662
+ _response_types_map: Dict[str, Optional[str]] = {
663
+ '200': "LookupStateResponse",
664
+ '503': "LookupStateResponse",
665
+ }
666
+ response_data = self.api_client.call_api(
667
+ *_param,
668
+ _request_timeout=_request_timeout
669
+ )
670
+ response_data.read()
671
+ return self.api_client.response_deserialize(
672
+ response_data=response_data,
673
+ response_types_map=_response_types_map,
674
+ )
675
+
676
+
677
+ @validate_call
678
+ def api_v1_lookup_states_code_get_without_preload_content(
679
+ self,
680
+ code: Annotated[StrictStr, Field(description="State two letter code")],
681
+ _request_timeout: Union[
682
+ None,
683
+ Annotated[StrictFloat, Field(gt=0)],
684
+ Tuple[
685
+ Annotated[StrictFloat, Field(gt=0)],
686
+ Annotated[StrictFloat, Field(gt=0)]
687
+ ]
688
+ ] = None,
689
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
690
+ _content_type: Optional[StrictStr] = None,
691
+ _headers: Optional[Dict[StrictStr, Any]] = None,
692
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
693
+ ) -> RESTResponseType:
694
+ """Get US State by Code
695
+
696
+ Retrieve a US State by its code
697
+
698
+ :param code: State two letter code (required)
699
+ :type code: str
700
+ :param _request_timeout: timeout setting for this request. If one
701
+ number provided, it will be total request
702
+ timeout. It can also be a pair (tuple) of
703
+ (connection, read) timeouts.
704
+ :type _request_timeout: int, tuple(int, int), optional
705
+ :param _request_auth: set to override the auth_settings for an a single
706
+ request; this effectively ignores the
707
+ authentication in the spec for a single request.
708
+ :type _request_auth: dict, optional
709
+ :param _content_type: force content-type for the request.
710
+ :type _content_type: str, Optional
711
+ :param _headers: set to override the headers for a single
712
+ request; this effectively ignores the headers
713
+ in the spec for a single request.
714
+ :type _headers: dict, optional
715
+ :param _host_index: set to override the host_index for a single
716
+ request; this effectively ignores the host_index
717
+ in the spec for a single request.
718
+ :type _host_index: int, optional
719
+ :return: Returns the result object.
720
+ """ # noqa: E501
721
+
722
+ _param = self._api_v1_lookup_states_code_get_serialize(
723
+ code=code,
724
+ _request_auth=_request_auth,
725
+ _content_type=_content_type,
726
+ _headers=_headers,
727
+ _host_index=_host_index
728
+ )
729
+
730
+ _response_types_map: Dict[str, Optional[str]] = {
731
+ '200': "LookupStateResponse",
732
+ '503': "LookupStateResponse",
733
+ }
734
+ response_data = self.api_client.call_api(
735
+ *_param,
736
+ _request_timeout=_request_timeout
737
+ )
738
+ return response_data.response
739
+
740
+
741
+ def _api_v1_lookup_states_code_get_serialize(
742
+ self,
743
+ code,
744
+ _request_auth,
745
+ _content_type,
746
+ _headers,
747
+ _host_index,
748
+ ) -> RequestSerialized:
749
+
750
+ _host = None
751
+
752
+ _collection_formats: Dict[str, str] = {
753
+ }
754
+
755
+ _path_params: Dict[str, str] = {}
756
+ _query_params: List[Tuple[str, str]] = []
757
+ _header_params: Dict[str, Optional[str]] = _headers or {}
758
+ _form_params: List[Tuple[str, str]] = []
759
+ _files: Dict[
760
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
761
+ ] = {}
762
+ _body_params: Optional[bytes] = None
763
+
764
+ # process the path parameters
765
+ if code is not None:
766
+ _path_params['code'] = code
767
+ # process the query parameters
768
+ # process the header parameters
769
+ # process the form parameters
770
+ # process the body parameter
771
+
772
+
773
+ # set the HTTP header `Accept`
774
+ if 'Accept' not in _header_params:
775
+ _header_params['Accept'] = self.api_client.select_header_accept(
776
+ [
777
+ 'application/json'
778
+ ]
779
+ )
780
+
781
+
782
+ # authentication setting
783
+ _auth_settings: List[str] = [
784
+ ]
785
+
786
+ return self.api_client.param_serialize(
787
+ method='GET',
788
+ resource_path='/api/v1/lookup/states/{code}',
789
+ path_params=_path_params,
790
+ query_params=_query_params,
791
+ header_params=_header_params,
792
+ body=_body_params,
793
+ post_params=_form_params,
794
+ files=_files,
795
+ auth_settings=_auth_settings,
796
+ collection_formats=_collection_formats,
797
+ _host=_host,
798
+ _request_auth=_request_auth
799
+ )
800
+
801
+
802
+
803
+
804
+ @validate_call
805
+ def api_v1_lookup_states_get(
806
+ self,
807
+ _request_timeout: Union[
808
+ None,
809
+ Annotated[StrictFloat, Field(gt=0)],
810
+ Tuple[
811
+ Annotated[StrictFloat, Field(gt=0)],
812
+ Annotated[StrictFloat, Field(gt=0)]
813
+ ]
814
+ ] = None,
815
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
816
+ _content_type: Optional[StrictStr] = None,
817
+ _headers: Optional[Dict[StrictStr, Any]] = None,
818
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
819
+ ) -> LookupLookupStateResponse:
820
+ """Get US States
821
+
822
+ Retrieve US States
823
+
824
+ :param _request_timeout: timeout setting for this request. If one
825
+ number provided, it will be total request
826
+ timeout. It can also be a pair (tuple) of
827
+ (connection, read) timeouts.
828
+ :type _request_timeout: int, tuple(int, int), optional
829
+ :param _request_auth: set to override the auth_settings for an a single
830
+ request; this effectively ignores the
831
+ authentication in the spec for a single request.
832
+ :type _request_auth: dict, optional
833
+ :param _content_type: force content-type for the request.
834
+ :type _content_type: str, Optional
835
+ :param _headers: set to override the headers for a single
836
+ request; this effectively ignores the headers
837
+ in the spec for a single request.
838
+ :type _headers: dict, optional
839
+ :param _host_index: set to override the host_index for a single
840
+ request; this effectively ignores the host_index
841
+ in the spec for a single request.
842
+ :type _host_index: int, optional
843
+ :return: Returns the result object.
844
+ """ # noqa: E501
845
+
846
+ _param = self._api_v1_lookup_states_get_serialize(
847
+ _request_auth=_request_auth,
848
+ _content_type=_content_type,
849
+ _headers=_headers,
850
+ _host_index=_host_index
851
+ )
852
+
853
+ _response_types_map: Dict[str, Optional[str]] = {
854
+ '200': "LookupLookupStateResponse",
855
+ '503': "LookupLookupStateResponse",
856
+ }
857
+ response_data = self.api_client.call_api(
858
+ *_param,
859
+ _request_timeout=_request_timeout
860
+ )
861
+ response_data.read()
862
+ return self.api_client.response_deserialize(
863
+ response_data=response_data,
864
+ response_types_map=_response_types_map,
865
+ ).data
866
+
867
+
868
+ @validate_call
869
+ def api_v1_lookup_states_get_with_http_info(
870
+ self,
871
+ _request_timeout: Union[
872
+ None,
873
+ Annotated[StrictFloat, Field(gt=0)],
874
+ Tuple[
875
+ Annotated[StrictFloat, Field(gt=0)],
876
+ Annotated[StrictFloat, Field(gt=0)]
877
+ ]
878
+ ] = None,
879
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
880
+ _content_type: Optional[StrictStr] = None,
881
+ _headers: Optional[Dict[StrictStr, Any]] = None,
882
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
883
+ ) -> ApiResponse[LookupLookupStateResponse]:
884
+ """Get US States
885
+
886
+ Retrieve US States
887
+
888
+ :param _request_timeout: timeout setting for this request. If one
889
+ number provided, it will be total request
890
+ timeout. It can also be a pair (tuple) of
891
+ (connection, read) timeouts.
892
+ :type _request_timeout: int, tuple(int, int), optional
893
+ :param _request_auth: set to override the auth_settings for an a single
894
+ request; this effectively ignores the
895
+ authentication in the spec for a single request.
896
+ :type _request_auth: dict, optional
897
+ :param _content_type: force content-type for the request.
898
+ :type _content_type: str, Optional
899
+ :param _headers: set to override the headers for a single
900
+ request; this effectively ignores the headers
901
+ in the spec for a single request.
902
+ :type _headers: dict, optional
903
+ :param _host_index: set to override the host_index for a single
904
+ request; this effectively ignores the host_index
905
+ in the spec for a single request.
906
+ :type _host_index: int, optional
907
+ :return: Returns the result object.
908
+ """ # noqa: E501
909
+
910
+ _param = self._api_v1_lookup_states_get_serialize(
911
+ _request_auth=_request_auth,
912
+ _content_type=_content_type,
913
+ _headers=_headers,
914
+ _host_index=_host_index
915
+ )
916
+
917
+ _response_types_map: Dict[str, Optional[str]] = {
918
+ '200': "LookupLookupStateResponse",
919
+ '503': "LookupLookupStateResponse",
920
+ }
921
+ response_data = self.api_client.call_api(
922
+ *_param,
923
+ _request_timeout=_request_timeout
924
+ )
925
+ response_data.read()
926
+ return self.api_client.response_deserialize(
927
+ response_data=response_data,
928
+ response_types_map=_response_types_map,
929
+ )
930
+
931
+
932
+ @validate_call
933
+ def api_v1_lookup_states_get_without_preload_content(
934
+ self,
935
+ _request_timeout: Union[
936
+ None,
937
+ Annotated[StrictFloat, Field(gt=0)],
938
+ Tuple[
939
+ Annotated[StrictFloat, Field(gt=0)],
940
+ Annotated[StrictFloat, Field(gt=0)]
941
+ ]
942
+ ] = None,
943
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
944
+ _content_type: Optional[StrictStr] = None,
945
+ _headers: Optional[Dict[StrictStr, Any]] = None,
946
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
947
+ ) -> RESTResponseType:
948
+ """Get US States
949
+
950
+ Retrieve US States
951
+
952
+ :param _request_timeout: timeout setting for this request. If one
953
+ number provided, it will be total request
954
+ timeout. It can also be a pair (tuple) of
955
+ (connection, read) timeouts.
956
+ :type _request_timeout: int, tuple(int, int), optional
957
+ :param _request_auth: set to override the auth_settings for an a single
958
+ request; this effectively ignores the
959
+ authentication in the spec for a single request.
960
+ :type _request_auth: dict, optional
961
+ :param _content_type: force content-type for the request.
962
+ :type _content_type: str, Optional
963
+ :param _headers: set to override the headers for a single
964
+ request; this effectively ignores the headers
965
+ in the spec for a single request.
966
+ :type _headers: dict, optional
967
+ :param _host_index: set to override the host_index for a single
968
+ request; this effectively ignores the host_index
969
+ in the spec for a single request.
970
+ :type _host_index: int, optional
971
+ :return: Returns the result object.
972
+ """ # noqa: E501
973
+
974
+ _param = self._api_v1_lookup_states_get_serialize(
975
+ _request_auth=_request_auth,
976
+ _content_type=_content_type,
977
+ _headers=_headers,
978
+ _host_index=_host_index
979
+ )
980
+
981
+ _response_types_map: Dict[str, Optional[str]] = {
982
+ '200': "LookupLookupStateResponse",
983
+ '503': "LookupLookupStateResponse",
984
+ }
985
+ response_data = self.api_client.call_api(
986
+ *_param,
987
+ _request_timeout=_request_timeout
988
+ )
989
+ return response_data.response
990
+
991
+
992
+ def _api_v1_lookup_states_get_serialize(
993
+ self,
994
+ _request_auth,
995
+ _content_type,
996
+ _headers,
997
+ _host_index,
998
+ ) -> RequestSerialized:
999
+
1000
+ _host = None
1001
+
1002
+ _collection_formats: Dict[str, str] = {
1003
+ }
1004
+
1005
+ _path_params: Dict[str, str] = {}
1006
+ _query_params: List[Tuple[str, str]] = []
1007
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1008
+ _form_params: List[Tuple[str, str]] = []
1009
+ _files: Dict[
1010
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1011
+ ] = {}
1012
+ _body_params: Optional[bytes] = None
1013
+
1014
+ # process the path parameters
1015
+ # process the query parameters
1016
+ # process the header parameters
1017
+ # process the form parameters
1018
+ # process the body parameter
1019
+
1020
+
1021
+ # set the HTTP header `Accept`
1022
+ if 'Accept' not in _header_params:
1023
+ _header_params['Accept'] = self.api_client.select_header_accept(
1024
+ [
1025
+ 'application/json'
1026
+ ]
1027
+ )
1028
+
1029
+
1030
+ # authentication setting
1031
+ _auth_settings: List[str] = [
1032
+ ]
1033
+
1034
+ return self.api_client.param_serialize(
1035
+ method='GET',
1036
+ resource_path='/api/v1/lookup/states',
1037
+ path_params=_path_params,
1038
+ query_params=_query_params,
1039
+ header_params=_header_params,
1040
+ body=_body_params,
1041
+ post_params=_form_params,
1042
+ files=_files,
1043
+ auth_settings=_auth_settings,
1044
+ collection_formats=_collection_formats,
1045
+ _host=_host,
1046
+ _request_auth=_request_auth
1047
+ )
1048
+
1049
+