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,1684 @@
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.client_client_creat_response import ClientClientCreatResponse
23
+ from neurograph.v1.models.client_client_create_request import ClientClientCreateRequest
24
+ from neurograph.v1.models.client_client_get_detail_response import ClientClientGetDetailResponse
25
+ from neurograph.v1.models.client_client_get_many_response import ClientClientGetManyResponse
26
+ from neurograph.v1.models.client_client_personas_response import ClientClientPersonasResponse
27
+ from neurograph.v1.models.client_client_url_upsert_request import ClientClientUrlUpsertRequest
28
+ from neurograph.v1.models.client_client_url_upsert_response import ClientClientUrlUpsertResponse
29
+ from neurograph.v1.models.client_client_urls_response import ClientClientUrlsResponse
30
+
31
+ from neurograph.v1.api_client import ApiClient, RequestSerialized
32
+ from neurograph.v1.api_response import ApiResponse
33
+ from neurograph.v1.rest import RESTResponseType
34
+
35
+
36
+ class ClientApi:
37
+ """NOTE: This class is auto generated by OpenAPI Generator
38
+ Ref: https://openapi-generator.tech
39
+
40
+ Do not edit the class manually.
41
+ """
42
+
43
+ def __init__(self, api_client=None) -> None:
44
+ if api_client is None:
45
+ api_client = ApiClient.get_default()
46
+ self.api_client = api_client
47
+
48
+
49
+ @validate_call
50
+ def api_v1_client_personas_client_id_get(
51
+ self,
52
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
53
+ _request_timeout: Union[
54
+ None,
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Tuple[
57
+ Annotated[StrictFloat, Field(gt=0)],
58
+ Annotated[StrictFloat, Field(gt=0)]
59
+ ]
60
+ ] = None,
61
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
62
+ _content_type: Optional[StrictStr] = None,
63
+ _headers: Optional[Dict[StrictStr, Any]] = None,
64
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
65
+ ) -> ClientClientPersonasResponse:
66
+ """Get Client's Personas
67
+
68
+ Get all Client Personas
69
+
70
+ :param client_id: Client's ID (required)
71
+ :type client_id: int
72
+ :param _request_timeout: timeout setting for this request. If one
73
+ number provided, it will be total request
74
+ timeout. It can also be a pair (tuple) of
75
+ (connection, read) timeouts.
76
+ :type _request_timeout: int, tuple(int, int), optional
77
+ :param _request_auth: set to override the auth_settings for an a single
78
+ request; this effectively ignores the
79
+ authentication in the spec for a single request.
80
+ :type _request_auth: dict, optional
81
+ :param _content_type: force content-type for the request.
82
+ :type _content_type: str, Optional
83
+ :param _headers: set to override the headers for a single
84
+ request; this effectively ignores the headers
85
+ in the spec for a single request.
86
+ :type _headers: dict, optional
87
+ :param _host_index: set to override the host_index for a single
88
+ request; this effectively ignores the host_index
89
+ in the spec for a single request.
90
+ :type _host_index: int, optional
91
+ :return: Returns the result object.
92
+ """ # noqa: E501
93
+
94
+ _param = self._api_v1_client_personas_client_id_get_serialize(
95
+ client_id=client_id,
96
+ _request_auth=_request_auth,
97
+ _content_type=_content_type,
98
+ _headers=_headers,
99
+ _host_index=_host_index
100
+ )
101
+
102
+ _response_types_map: Dict[str, Optional[str]] = {
103
+ '200': "ClientClientPersonasResponse",
104
+ '400': "ClientClientPersonasResponse",
105
+ '503': "ClientClientPersonasResponse",
106
+ }
107
+ response_data = self.api_client.call_api(
108
+ *_param,
109
+ _request_timeout=_request_timeout
110
+ )
111
+ response_data.read()
112
+ return self.api_client.response_deserialize(
113
+ response_data=response_data,
114
+ response_types_map=_response_types_map,
115
+ ).data
116
+
117
+
118
+ @validate_call
119
+ def api_v1_client_personas_client_id_get_with_http_info(
120
+ self,
121
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
122
+ _request_timeout: Union[
123
+ None,
124
+ Annotated[StrictFloat, Field(gt=0)],
125
+ Tuple[
126
+ Annotated[StrictFloat, Field(gt=0)],
127
+ Annotated[StrictFloat, Field(gt=0)]
128
+ ]
129
+ ] = None,
130
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
131
+ _content_type: Optional[StrictStr] = None,
132
+ _headers: Optional[Dict[StrictStr, Any]] = None,
133
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
134
+ ) -> ApiResponse[ClientClientPersonasResponse]:
135
+ """Get Client's Personas
136
+
137
+ Get all Client Personas
138
+
139
+ :param client_id: Client's ID (required)
140
+ :type client_id: int
141
+ :param _request_timeout: timeout setting for this request. If one
142
+ number provided, it will be total request
143
+ timeout. It can also be a pair (tuple) of
144
+ (connection, read) timeouts.
145
+ :type _request_timeout: int, tuple(int, int), optional
146
+ :param _request_auth: set to override the auth_settings for an a single
147
+ request; this effectively ignores the
148
+ authentication in the spec for a single request.
149
+ :type _request_auth: dict, optional
150
+ :param _content_type: force content-type for the request.
151
+ :type _content_type: str, Optional
152
+ :param _headers: set to override the headers for a single
153
+ request; this effectively ignores the headers
154
+ in the spec for a single request.
155
+ :type _headers: dict, optional
156
+ :param _host_index: set to override the host_index for a single
157
+ request; this effectively ignores the host_index
158
+ in the spec for a single request.
159
+ :type _host_index: int, optional
160
+ :return: Returns the result object.
161
+ """ # noqa: E501
162
+
163
+ _param = self._api_v1_client_personas_client_id_get_serialize(
164
+ client_id=client_id,
165
+ _request_auth=_request_auth,
166
+ _content_type=_content_type,
167
+ _headers=_headers,
168
+ _host_index=_host_index
169
+ )
170
+
171
+ _response_types_map: Dict[str, Optional[str]] = {
172
+ '200': "ClientClientPersonasResponse",
173
+ '400': "ClientClientPersonasResponse",
174
+ '503': "ClientClientPersonasResponse",
175
+ }
176
+ response_data = self.api_client.call_api(
177
+ *_param,
178
+ _request_timeout=_request_timeout
179
+ )
180
+ response_data.read()
181
+ return self.api_client.response_deserialize(
182
+ response_data=response_data,
183
+ response_types_map=_response_types_map,
184
+ )
185
+
186
+
187
+ @validate_call
188
+ def api_v1_client_personas_client_id_get_without_preload_content(
189
+ self,
190
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
191
+ _request_timeout: Union[
192
+ None,
193
+ Annotated[StrictFloat, Field(gt=0)],
194
+ Tuple[
195
+ Annotated[StrictFloat, Field(gt=0)],
196
+ Annotated[StrictFloat, Field(gt=0)]
197
+ ]
198
+ ] = None,
199
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
200
+ _content_type: Optional[StrictStr] = None,
201
+ _headers: Optional[Dict[StrictStr, Any]] = None,
202
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
203
+ ) -> RESTResponseType:
204
+ """Get Client's Personas
205
+
206
+ Get all Client Personas
207
+
208
+ :param client_id: Client's ID (required)
209
+ :type client_id: int
210
+ :param _request_timeout: timeout setting for this request. If one
211
+ number provided, it will be total request
212
+ timeout. It can also be a pair (tuple) of
213
+ (connection, read) timeouts.
214
+ :type _request_timeout: int, tuple(int, int), optional
215
+ :param _request_auth: set to override the auth_settings for an a single
216
+ request; this effectively ignores the
217
+ authentication in the spec for a single request.
218
+ :type _request_auth: dict, optional
219
+ :param _content_type: force content-type for the request.
220
+ :type _content_type: str, Optional
221
+ :param _headers: set to override the headers for a single
222
+ request; this effectively ignores the headers
223
+ in the spec for a single request.
224
+ :type _headers: dict, optional
225
+ :param _host_index: set to override the host_index for a single
226
+ request; this effectively ignores the host_index
227
+ in the spec for a single request.
228
+ :type _host_index: int, optional
229
+ :return: Returns the result object.
230
+ """ # noqa: E501
231
+
232
+ _param = self._api_v1_client_personas_client_id_get_serialize(
233
+ client_id=client_id,
234
+ _request_auth=_request_auth,
235
+ _content_type=_content_type,
236
+ _headers=_headers,
237
+ _host_index=_host_index
238
+ )
239
+
240
+ _response_types_map: Dict[str, Optional[str]] = {
241
+ '200': "ClientClientPersonasResponse",
242
+ '400': "ClientClientPersonasResponse",
243
+ '503': "ClientClientPersonasResponse",
244
+ }
245
+ response_data = self.api_client.call_api(
246
+ *_param,
247
+ _request_timeout=_request_timeout
248
+ )
249
+ return response_data.response
250
+
251
+
252
+ def _api_v1_client_personas_client_id_get_serialize(
253
+ self,
254
+ client_id,
255
+ _request_auth,
256
+ _content_type,
257
+ _headers,
258
+ _host_index,
259
+ ) -> RequestSerialized:
260
+
261
+ _host = None
262
+
263
+ _collection_formats: Dict[str, str] = {
264
+ }
265
+
266
+ _path_params: Dict[str, str] = {}
267
+ _query_params: List[Tuple[str, str]] = []
268
+ _header_params: Dict[str, Optional[str]] = _headers or {}
269
+ _form_params: List[Tuple[str, str]] = []
270
+ _files: Dict[
271
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
272
+ ] = {}
273
+ _body_params: Optional[bytes] = None
274
+
275
+ # process the path parameters
276
+ if client_id is not None:
277
+ _path_params['client_id'] = client_id
278
+ # process the query parameters
279
+ # process the header parameters
280
+ # process the form parameters
281
+ # process the body parameter
282
+
283
+
284
+ # set the HTTP header `Accept`
285
+ if 'Accept' not in _header_params:
286
+ _header_params['Accept'] = self.api_client.select_header_accept(
287
+ [
288
+ 'application/json'
289
+ ]
290
+ )
291
+
292
+
293
+ # authentication setting
294
+ _auth_settings: List[str] = [
295
+ 'ApiKeyAuth'
296
+ ]
297
+
298
+ return self.api_client.param_serialize(
299
+ method='GET',
300
+ resource_path='/api/v1/client/personas/{client_id}',
301
+ path_params=_path_params,
302
+ query_params=_query_params,
303
+ header_params=_header_params,
304
+ body=_body_params,
305
+ post_params=_form_params,
306
+ files=_files,
307
+ auth_settings=_auth_settings,
308
+ collection_formats=_collection_formats,
309
+ _host=_host,
310
+ _request_auth=_request_auth
311
+ )
312
+
313
+
314
+
315
+
316
+ @validate_call
317
+ def api_v1_client_url_client_id_get(
318
+ self,
319
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
320
+ _request_timeout: Union[
321
+ None,
322
+ Annotated[StrictFloat, Field(gt=0)],
323
+ Tuple[
324
+ Annotated[StrictFloat, Field(gt=0)],
325
+ Annotated[StrictFloat, Field(gt=0)]
326
+ ]
327
+ ] = None,
328
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
329
+ _content_type: Optional[StrictStr] = None,
330
+ _headers: Optional[Dict[StrictStr, Any]] = None,
331
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
332
+ ) -> ClientClientUrlsResponse:
333
+ """Get client's URLs
334
+
335
+ Returns all of the client's urls for the given client id
336
+
337
+ :param client_id: Client's ID (required)
338
+ :type client_id: int
339
+ :param _request_timeout: timeout setting for this request. If one
340
+ number provided, it will be total request
341
+ timeout. It can also be a pair (tuple) of
342
+ (connection, read) timeouts.
343
+ :type _request_timeout: int, tuple(int, int), optional
344
+ :param _request_auth: set to override the auth_settings for an a single
345
+ request; this effectively ignores the
346
+ authentication in the spec for a single request.
347
+ :type _request_auth: dict, optional
348
+ :param _content_type: force content-type for the request.
349
+ :type _content_type: str, Optional
350
+ :param _headers: set to override the headers for a single
351
+ request; this effectively ignores the headers
352
+ in the spec for a single request.
353
+ :type _headers: dict, optional
354
+ :param _host_index: set to override the host_index for a single
355
+ request; this effectively ignores the host_index
356
+ in the spec for a single request.
357
+ :type _host_index: int, optional
358
+ :return: Returns the result object.
359
+ """ # noqa: E501
360
+
361
+ _param = self._api_v1_client_url_client_id_get_serialize(
362
+ client_id=client_id,
363
+ _request_auth=_request_auth,
364
+ _content_type=_content_type,
365
+ _headers=_headers,
366
+ _host_index=_host_index
367
+ )
368
+
369
+ _response_types_map: Dict[str, Optional[str]] = {
370
+ '200': "ClientClientUrlsResponse",
371
+ '400': "ClientClientUrlsResponse",
372
+ '503': "ClientClientUrlsResponse",
373
+ }
374
+ response_data = self.api_client.call_api(
375
+ *_param,
376
+ _request_timeout=_request_timeout
377
+ )
378
+ response_data.read()
379
+ return self.api_client.response_deserialize(
380
+ response_data=response_data,
381
+ response_types_map=_response_types_map,
382
+ ).data
383
+
384
+
385
+ @validate_call
386
+ def api_v1_client_url_client_id_get_with_http_info(
387
+ self,
388
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
389
+ _request_timeout: Union[
390
+ None,
391
+ Annotated[StrictFloat, Field(gt=0)],
392
+ Tuple[
393
+ Annotated[StrictFloat, Field(gt=0)],
394
+ Annotated[StrictFloat, Field(gt=0)]
395
+ ]
396
+ ] = None,
397
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
398
+ _content_type: Optional[StrictStr] = None,
399
+ _headers: Optional[Dict[StrictStr, Any]] = None,
400
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
401
+ ) -> ApiResponse[ClientClientUrlsResponse]:
402
+ """Get client's URLs
403
+
404
+ Returns all of the client's urls for the given client id
405
+
406
+ :param client_id: Client's ID (required)
407
+ :type client_id: 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_client_url_client_id_get_serialize(
431
+ client_id=client_id,
432
+ _request_auth=_request_auth,
433
+ _content_type=_content_type,
434
+ _headers=_headers,
435
+ _host_index=_host_index
436
+ )
437
+
438
+ _response_types_map: Dict[str, Optional[str]] = {
439
+ '200': "ClientClientUrlsResponse",
440
+ '400': "ClientClientUrlsResponse",
441
+ '503': "ClientClientUrlsResponse",
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_client_url_client_id_get_without_preload_content(
456
+ self,
457
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
458
+ _request_timeout: Union[
459
+ None,
460
+ Annotated[StrictFloat, Field(gt=0)],
461
+ Tuple[
462
+ Annotated[StrictFloat, Field(gt=0)],
463
+ Annotated[StrictFloat, Field(gt=0)]
464
+ ]
465
+ ] = None,
466
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
467
+ _content_type: Optional[StrictStr] = None,
468
+ _headers: Optional[Dict[StrictStr, Any]] = None,
469
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
470
+ ) -> RESTResponseType:
471
+ """Get client's URLs
472
+
473
+ Returns all of the client's urls for the given client id
474
+
475
+ :param client_id: Client's ID (required)
476
+ :type client_id: int
477
+ :param _request_timeout: timeout setting for this request. If one
478
+ number provided, it will be total request
479
+ timeout. It can also be a pair (tuple) of
480
+ (connection, read) timeouts.
481
+ :type _request_timeout: int, tuple(int, int), optional
482
+ :param _request_auth: set to override the auth_settings for an a single
483
+ request; this effectively ignores the
484
+ authentication in the spec for a single request.
485
+ :type _request_auth: dict, optional
486
+ :param _content_type: force content-type for the request.
487
+ :type _content_type: str, Optional
488
+ :param _headers: set to override the headers for a single
489
+ request; this effectively ignores the headers
490
+ in the spec for a single request.
491
+ :type _headers: dict, optional
492
+ :param _host_index: set to override the host_index for a single
493
+ request; this effectively ignores the host_index
494
+ in the spec for a single request.
495
+ :type _host_index: int, optional
496
+ :return: Returns the result object.
497
+ """ # noqa: E501
498
+
499
+ _param = self._api_v1_client_url_client_id_get_serialize(
500
+ client_id=client_id,
501
+ _request_auth=_request_auth,
502
+ _content_type=_content_type,
503
+ _headers=_headers,
504
+ _host_index=_host_index
505
+ )
506
+
507
+ _response_types_map: Dict[str, Optional[str]] = {
508
+ '200': "ClientClientUrlsResponse",
509
+ '400': "ClientClientUrlsResponse",
510
+ '503': "ClientClientUrlsResponse",
511
+ }
512
+ response_data = self.api_client.call_api(
513
+ *_param,
514
+ _request_timeout=_request_timeout
515
+ )
516
+ return response_data.response
517
+
518
+
519
+ def _api_v1_client_url_client_id_get_serialize(
520
+ self,
521
+ client_id,
522
+ _request_auth,
523
+ _content_type,
524
+ _headers,
525
+ _host_index,
526
+ ) -> RequestSerialized:
527
+
528
+ _host = None
529
+
530
+ _collection_formats: Dict[str, str] = {
531
+ }
532
+
533
+ _path_params: Dict[str, str] = {}
534
+ _query_params: List[Tuple[str, str]] = []
535
+ _header_params: Dict[str, Optional[str]] = _headers or {}
536
+ _form_params: List[Tuple[str, str]] = []
537
+ _files: Dict[
538
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
539
+ ] = {}
540
+ _body_params: Optional[bytes] = None
541
+
542
+ # process the path parameters
543
+ if client_id is not None:
544
+ _path_params['client_id'] = client_id
545
+ # process the query parameters
546
+ # process the header parameters
547
+ # process the form parameters
548
+ # process the body parameter
549
+
550
+
551
+ # set the HTTP header `Accept`
552
+ if 'Accept' not in _header_params:
553
+ _header_params['Accept'] = self.api_client.select_header_accept(
554
+ [
555
+ 'application/json'
556
+ ]
557
+ )
558
+
559
+
560
+ # authentication setting
561
+ _auth_settings: List[str] = [
562
+ 'ApiKeyAuth'
563
+ ]
564
+
565
+ return self.api_client.param_serialize(
566
+ method='GET',
567
+ resource_path='/api/v1/client/url/{client_id}',
568
+ path_params=_path_params,
569
+ query_params=_query_params,
570
+ header_params=_header_params,
571
+ body=_body_params,
572
+ post_params=_form_params,
573
+ files=_files,
574
+ auth_settings=_auth_settings,
575
+ collection_formats=_collection_formats,
576
+ _host=_host,
577
+ _request_auth=_request_auth
578
+ )
579
+
580
+
581
+
582
+
583
+ @validate_call
584
+ def api_v1_client_url_post(
585
+ self,
586
+ request: Annotated[ClientClientUrlUpsertRequest, Field(description="Body")],
587
+ _request_timeout: Union[
588
+ None,
589
+ Annotated[StrictFloat, Field(gt=0)],
590
+ Tuple[
591
+ Annotated[StrictFloat, Field(gt=0)],
592
+ Annotated[StrictFloat, Field(gt=0)]
593
+ ]
594
+ ] = None,
595
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
596
+ _content_type: Optional[StrictStr] = None,
597
+ _headers: Optional[Dict[StrictStr, Any]] = None,
598
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
599
+ ) -> ClientClientUrlUpsertResponse:
600
+ """Upsert a Client Url
601
+
602
+ Inserts a Client Url into the db when the `id` is `0`. Updates when the `id` is `1` or greater.
603
+
604
+ :param request: Body (required)
605
+ :type request: ClientClientUrlUpsertRequest
606
+ :param _request_timeout: timeout setting for this request. If one
607
+ number provided, it will be total request
608
+ timeout. It can also be a pair (tuple) of
609
+ (connection, read) timeouts.
610
+ :type _request_timeout: int, tuple(int, int), optional
611
+ :param _request_auth: set to override the auth_settings for an a single
612
+ request; this effectively ignores the
613
+ authentication in the spec for a single request.
614
+ :type _request_auth: dict, optional
615
+ :param _content_type: force content-type for the request.
616
+ :type _content_type: str, Optional
617
+ :param _headers: set to override the headers for a single
618
+ request; this effectively ignores the headers
619
+ in the spec for a single request.
620
+ :type _headers: dict, optional
621
+ :param _host_index: set to override the host_index for a single
622
+ request; this effectively ignores the host_index
623
+ in the spec for a single request.
624
+ :type _host_index: int, optional
625
+ :return: Returns the result object.
626
+ """ # noqa: E501
627
+
628
+ _param = self._api_v1_client_url_post_serialize(
629
+ request=request,
630
+ _request_auth=_request_auth,
631
+ _content_type=_content_type,
632
+ _headers=_headers,
633
+ _host_index=_host_index
634
+ )
635
+
636
+ _response_types_map: Dict[str, Optional[str]] = {
637
+ '200': "ClientClientUrlUpsertResponse",
638
+ '400': "ClientClientUrlUpsertResponse",
639
+ '503': "ClientClientUrlUpsertResponse",
640
+ }
641
+ response_data = self.api_client.call_api(
642
+ *_param,
643
+ _request_timeout=_request_timeout
644
+ )
645
+ response_data.read()
646
+ return self.api_client.response_deserialize(
647
+ response_data=response_data,
648
+ response_types_map=_response_types_map,
649
+ ).data
650
+
651
+
652
+ @validate_call
653
+ def api_v1_client_url_post_with_http_info(
654
+ self,
655
+ request: Annotated[ClientClientUrlUpsertRequest, Field(description="Body")],
656
+ _request_timeout: Union[
657
+ None,
658
+ Annotated[StrictFloat, Field(gt=0)],
659
+ Tuple[
660
+ Annotated[StrictFloat, Field(gt=0)],
661
+ Annotated[StrictFloat, Field(gt=0)]
662
+ ]
663
+ ] = None,
664
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
665
+ _content_type: Optional[StrictStr] = None,
666
+ _headers: Optional[Dict[StrictStr, Any]] = None,
667
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
668
+ ) -> ApiResponse[ClientClientUrlUpsertResponse]:
669
+ """Upsert a Client Url
670
+
671
+ Inserts a Client Url into the db when the `id` is `0`. Updates when the `id` is `1` or greater.
672
+
673
+ :param request: Body (required)
674
+ :type request: ClientClientUrlUpsertRequest
675
+ :param _request_timeout: timeout setting for this request. If one
676
+ number provided, it will be total request
677
+ timeout. It can also be a pair (tuple) of
678
+ (connection, read) timeouts.
679
+ :type _request_timeout: int, tuple(int, int), optional
680
+ :param _request_auth: set to override the auth_settings for an a single
681
+ request; this effectively ignores the
682
+ authentication in the spec for a single request.
683
+ :type _request_auth: dict, optional
684
+ :param _content_type: force content-type for the request.
685
+ :type _content_type: str, Optional
686
+ :param _headers: set to override the headers for a single
687
+ request; this effectively ignores the headers
688
+ in the spec for a single request.
689
+ :type _headers: dict, optional
690
+ :param _host_index: set to override the host_index for a single
691
+ request; this effectively ignores the host_index
692
+ in the spec for a single request.
693
+ :type _host_index: int, optional
694
+ :return: Returns the result object.
695
+ """ # noqa: E501
696
+
697
+ _param = self._api_v1_client_url_post_serialize(
698
+ request=request,
699
+ _request_auth=_request_auth,
700
+ _content_type=_content_type,
701
+ _headers=_headers,
702
+ _host_index=_host_index
703
+ )
704
+
705
+ _response_types_map: Dict[str, Optional[str]] = {
706
+ '200': "ClientClientUrlUpsertResponse",
707
+ '400': "ClientClientUrlUpsertResponse",
708
+ '503': "ClientClientUrlUpsertResponse",
709
+ }
710
+ response_data = self.api_client.call_api(
711
+ *_param,
712
+ _request_timeout=_request_timeout
713
+ )
714
+ response_data.read()
715
+ return self.api_client.response_deserialize(
716
+ response_data=response_data,
717
+ response_types_map=_response_types_map,
718
+ )
719
+
720
+
721
+ @validate_call
722
+ def api_v1_client_url_post_without_preload_content(
723
+ self,
724
+ request: Annotated[ClientClientUrlUpsertRequest, Field(description="Body")],
725
+ _request_timeout: Union[
726
+ None,
727
+ Annotated[StrictFloat, Field(gt=0)],
728
+ Tuple[
729
+ Annotated[StrictFloat, Field(gt=0)],
730
+ Annotated[StrictFloat, Field(gt=0)]
731
+ ]
732
+ ] = None,
733
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
734
+ _content_type: Optional[StrictStr] = None,
735
+ _headers: Optional[Dict[StrictStr, Any]] = None,
736
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
737
+ ) -> RESTResponseType:
738
+ """Upsert a Client Url
739
+
740
+ Inserts a Client Url into the db when the `id` is `0`. Updates when the `id` is `1` or greater.
741
+
742
+ :param request: Body (required)
743
+ :type request: ClientClientUrlUpsertRequest
744
+ :param _request_timeout: timeout setting for this request. If one
745
+ number provided, it will be total request
746
+ timeout. It can also be a pair (tuple) of
747
+ (connection, read) timeouts.
748
+ :type _request_timeout: int, tuple(int, int), optional
749
+ :param _request_auth: set to override the auth_settings for an a single
750
+ request; this effectively ignores the
751
+ authentication in the spec for a single request.
752
+ :type _request_auth: dict, optional
753
+ :param _content_type: force content-type for the request.
754
+ :type _content_type: str, Optional
755
+ :param _headers: set to override the headers for a single
756
+ request; this effectively ignores the headers
757
+ in the spec for a single request.
758
+ :type _headers: dict, optional
759
+ :param _host_index: set to override the host_index for a single
760
+ request; this effectively ignores the host_index
761
+ in the spec for a single request.
762
+ :type _host_index: int, optional
763
+ :return: Returns the result object.
764
+ """ # noqa: E501
765
+
766
+ _param = self._api_v1_client_url_post_serialize(
767
+ request=request,
768
+ _request_auth=_request_auth,
769
+ _content_type=_content_type,
770
+ _headers=_headers,
771
+ _host_index=_host_index
772
+ )
773
+
774
+ _response_types_map: Dict[str, Optional[str]] = {
775
+ '200': "ClientClientUrlUpsertResponse",
776
+ '400': "ClientClientUrlUpsertResponse",
777
+ '503': "ClientClientUrlUpsertResponse",
778
+ }
779
+ response_data = self.api_client.call_api(
780
+ *_param,
781
+ _request_timeout=_request_timeout
782
+ )
783
+ return response_data.response
784
+
785
+
786
+ def _api_v1_client_url_post_serialize(
787
+ self,
788
+ request,
789
+ _request_auth,
790
+ _content_type,
791
+ _headers,
792
+ _host_index,
793
+ ) -> RequestSerialized:
794
+
795
+ _host = None
796
+
797
+ _collection_formats: Dict[str, str] = {
798
+ }
799
+
800
+ _path_params: Dict[str, str] = {}
801
+ _query_params: List[Tuple[str, str]] = []
802
+ _header_params: Dict[str, Optional[str]] = _headers or {}
803
+ _form_params: List[Tuple[str, str]] = []
804
+ _files: Dict[
805
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
806
+ ] = {}
807
+ _body_params: Optional[bytes] = None
808
+
809
+ # process the path parameters
810
+ # process the query parameters
811
+ # process the header parameters
812
+ # process the form parameters
813
+ # process the body parameter
814
+ if request is not None:
815
+ _body_params = request
816
+
817
+
818
+ # set the HTTP header `Accept`
819
+ if 'Accept' not in _header_params:
820
+ _header_params['Accept'] = self.api_client.select_header_accept(
821
+ [
822
+ 'application/json'
823
+ ]
824
+ )
825
+
826
+
827
+ # authentication setting
828
+ _auth_settings: List[str] = [
829
+ 'ApiKeyAuth'
830
+ ]
831
+
832
+ return self.api_client.param_serialize(
833
+ method='POST',
834
+ resource_path='/api/v1/client/url/',
835
+ path_params=_path_params,
836
+ query_params=_query_params,
837
+ header_params=_header_params,
838
+ body=_body_params,
839
+ post_params=_form_params,
840
+ files=_files,
841
+ auth_settings=_auth_settings,
842
+ collection_formats=_collection_formats,
843
+ _host=_host,
844
+ _request_auth=_request_auth
845
+ )
846
+
847
+
848
+
849
+
850
+ @validate_call
851
+ def api_v1_clients_client_id_get(
852
+ self,
853
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
854
+ _request_timeout: Union[
855
+ None,
856
+ Annotated[StrictFloat, Field(gt=0)],
857
+ Tuple[
858
+ Annotated[StrictFloat, Field(gt=0)],
859
+ Annotated[StrictFloat, Field(gt=0)]
860
+ ]
861
+ ] = None,
862
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
863
+ _content_type: Optional[StrictStr] = None,
864
+ _headers: Optional[Dict[StrictStr, Any]] = None,
865
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
866
+ ) -> ClientClientGetDetailResponse:
867
+ """Get Client by ID
868
+
869
+ Get all Client details by their ID
870
+
871
+ :param client_id: Client's ID (required)
872
+ :type client_id: int
873
+ :param _request_timeout: timeout setting for this request. If one
874
+ number provided, it will be total request
875
+ timeout. It can also be a pair (tuple) of
876
+ (connection, read) timeouts.
877
+ :type _request_timeout: int, tuple(int, int), optional
878
+ :param _request_auth: set to override the auth_settings for an a single
879
+ request; this effectively ignores the
880
+ authentication in the spec for a single request.
881
+ :type _request_auth: dict, optional
882
+ :param _content_type: force content-type for the request.
883
+ :type _content_type: str, Optional
884
+ :param _headers: set to override the headers for a single
885
+ request; this effectively ignores the headers
886
+ in the spec for a single request.
887
+ :type _headers: dict, optional
888
+ :param _host_index: set to override the host_index for a single
889
+ request; this effectively ignores the host_index
890
+ in the spec for a single request.
891
+ :type _host_index: int, optional
892
+ :return: Returns the result object.
893
+ """ # noqa: E501
894
+
895
+ _param = self._api_v1_clients_client_id_get_serialize(
896
+ client_id=client_id,
897
+ _request_auth=_request_auth,
898
+ _content_type=_content_type,
899
+ _headers=_headers,
900
+ _host_index=_host_index
901
+ )
902
+
903
+ _response_types_map: Dict[str, Optional[str]] = {
904
+ '200': "ClientClientGetDetailResponse",
905
+ '400': "ClientClientGetDetailResponse",
906
+ '503': "ClientClientGetDetailResponse",
907
+ }
908
+ response_data = self.api_client.call_api(
909
+ *_param,
910
+ _request_timeout=_request_timeout
911
+ )
912
+ response_data.read()
913
+ return self.api_client.response_deserialize(
914
+ response_data=response_data,
915
+ response_types_map=_response_types_map,
916
+ ).data
917
+
918
+
919
+ @validate_call
920
+ def api_v1_clients_client_id_get_with_http_info(
921
+ self,
922
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
923
+ _request_timeout: Union[
924
+ None,
925
+ Annotated[StrictFloat, Field(gt=0)],
926
+ Tuple[
927
+ Annotated[StrictFloat, Field(gt=0)],
928
+ Annotated[StrictFloat, Field(gt=0)]
929
+ ]
930
+ ] = None,
931
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
932
+ _content_type: Optional[StrictStr] = None,
933
+ _headers: Optional[Dict[StrictStr, Any]] = None,
934
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
935
+ ) -> ApiResponse[ClientClientGetDetailResponse]:
936
+ """Get Client by ID
937
+
938
+ Get all Client details by their ID
939
+
940
+ :param client_id: Client's ID (required)
941
+ :type client_id: int
942
+ :param _request_timeout: timeout setting for this request. If one
943
+ number provided, it will be total request
944
+ timeout. It can also be a pair (tuple) of
945
+ (connection, read) timeouts.
946
+ :type _request_timeout: int, tuple(int, int), optional
947
+ :param _request_auth: set to override the auth_settings for an a single
948
+ request; this effectively ignores the
949
+ authentication in the spec for a single request.
950
+ :type _request_auth: dict, optional
951
+ :param _content_type: force content-type for the request.
952
+ :type _content_type: str, Optional
953
+ :param _headers: set to override the headers for a single
954
+ request; this effectively ignores the headers
955
+ in the spec for a single request.
956
+ :type _headers: dict, optional
957
+ :param _host_index: set to override the host_index for a single
958
+ request; this effectively ignores the host_index
959
+ in the spec for a single request.
960
+ :type _host_index: int, optional
961
+ :return: Returns the result object.
962
+ """ # noqa: E501
963
+
964
+ _param = self._api_v1_clients_client_id_get_serialize(
965
+ client_id=client_id,
966
+ _request_auth=_request_auth,
967
+ _content_type=_content_type,
968
+ _headers=_headers,
969
+ _host_index=_host_index
970
+ )
971
+
972
+ _response_types_map: Dict[str, Optional[str]] = {
973
+ '200': "ClientClientGetDetailResponse",
974
+ '400': "ClientClientGetDetailResponse",
975
+ '503': "ClientClientGetDetailResponse",
976
+ }
977
+ response_data = self.api_client.call_api(
978
+ *_param,
979
+ _request_timeout=_request_timeout
980
+ )
981
+ response_data.read()
982
+ return self.api_client.response_deserialize(
983
+ response_data=response_data,
984
+ response_types_map=_response_types_map,
985
+ )
986
+
987
+
988
+ @validate_call
989
+ def api_v1_clients_client_id_get_without_preload_content(
990
+ self,
991
+ client_id: Annotated[StrictInt, Field(description="Client's ID")],
992
+ _request_timeout: Union[
993
+ None,
994
+ Annotated[StrictFloat, Field(gt=0)],
995
+ Tuple[
996
+ Annotated[StrictFloat, Field(gt=0)],
997
+ Annotated[StrictFloat, Field(gt=0)]
998
+ ]
999
+ ] = None,
1000
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1001
+ _content_type: Optional[StrictStr] = None,
1002
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1003
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1004
+ ) -> RESTResponseType:
1005
+ """Get Client by ID
1006
+
1007
+ Get all Client details by their ID
1008
+
1009
+ :param client_id: Client's ID (required)
1010
+ :type client_id: int
1011
+ :param _request_timeout: timeout setting for this request. If one
1012
+ number provided, it will be total request
1013
+ timeout. It can also be a pair (tuple) of
1014
+ (connection, read) timeouts.
1015
+ :type _request_timeout: int, tuple(int, int), optional
1016
+ :param _request_auth: set to override the auth_settings for an a single
1017
+ request; this effectively ignores the
1018
+ authentication in the spec for a single request.
1019
+ :type _request_auth: dict, optional
1020
+ :param _content_type: force content-type for the request.
1021
+ :type _content_type: str, Optional
1022
+ :param _headers: set to override the headers for a single
1023
+ request; this effectively ignores the headers
1024
+ in the spec for a single request.
1025
+ :type _headers: dict, optional
1026
+ :param _host_index: set to override the host_index for a single
1027
+ request; this effectively ignores the host_index
1028
+ in the spec for a single request.
1029
+ :type _host_index: int, optional
1030
+ :return: Returns the result object.
1031
+ """ # noqa: E501
1032
+
1033
+ _param = self._api_v1_clients_client_id_get_serialize(
1034
+ client_id=client_id,
1035
+ _request_auth=_request_auth,
1036
+ _content_type=_content_type,
1037
+ _headers=_headers,
1038
+ _host_index=_host_index
1039
+ )
1040
+
1041
+ _response_types_map: Dict[str, Optional[str]] = {
1042
+ '200': "ClientClientGetDetailResponse",
1043
+ '400': "ClientClientGetDetailResponse",
1044
+ '503': "ClientClientGetDetailResponse",
1045
+ }
1046
+ response_data = self.api_client.call_api(
1047
+ *_param,
1048
+ _request_timeout=_request_timeout
1049
+ )
1050
+ return response_data.response
1051
+
1052
+
1053
+ def _api_v1_clients_client_id_get_serialize(
1054
+ self,
1055
+ client_id,
1056
+ _request_auth,
1057
+ _content_type,
1058
+ _headers,
1059
+ _host_index,
1060
+ ) -> RequestSerialized:
1061
+
1062
+ _host = None
1063
+
1064
+ _collection_formats: Dict[str, str] = {
1065
+ }
1066
+
1067
+ _path_params: Dict[str, str] = {}
1068
+ _query_params: List[Tuple[str, str]] = []
1069
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1070
+ _form_params: List[Tuple[str, str]] = []
1071
+ _files: Dict[
1072
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1073
+ ] = {}
1074
+ _body_params: Optional[bytes] = None
1075
+
1076
+ # process the path parameters
1077
+ if client_id is not None:
1078
+ _path_params['client_id'] = client_id
1079
+ # process the query parameters
1080
+ # process the header parameters
1081
+ # process the form parameters
1082
+ # process the body parameter
1083
+
1084
+
1085
+ # set the HTTP header `Accept`
1086
+ if 'Accept' not in _header_params:
1087
+ _header_params['Accept'] = self.api_client.select_header_accept(
1088
+ [
1089
+ 'application/json'
1090
+ ]
1091
+ )
1092
+
1093
+
1094
+ # authentication setting
1095
+ _auth_settings: List[str] = [
1096
+ 'ApiKeyAuth'
1097
+ ]
1098
+
1099
+ return self.api_client.param_serialize(
1100
+ method='GET',
1101
+ resource_path='/api/v1/clients/{client_id}',
1102
+ path_params=_path_params,
1103
+ query_params=_query_params,
1104
+ header_params=_header_params,
1105
+ body=_body_params,
1106
+ post_params=_form_params,
1107
+ files=_files,
1108
+ auth_settings=_auth_settings,
1109
+ collection_formats=_collection_formats,
1110
+ _host=_host,
1111
+ _request_auth=_request_auth
1112
+ )
1113
+
1114
+
1115
+
1116
+
1117
+ @validate_call
1118
+ def api_v1_clients_get(
1119
+ self,
1120
+ org_id: Annotated[Optional[StrictInt], Field(description="fitler by the Organization's ID")] = None,
1121
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
1122
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
1123
+ _request_timeout: Union[
1124
+ None,
1125
+ Annotated[StrictFloat, Field(gt=0)],
1126
+ Tuple[
1127
+ Annotated[StrictFloat, Field(gt=0)],
1128
+ Annotated[StrictFloat, Field(gt=0)]
1129
+ ]
1130
+ ] = None,
1131
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1132
+ _content_type: Optional[StrictStr] = None,
1133
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1134
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1135
+ ) -> ClientClientGetManyResponse:
1136
+ """Get Clients
1137
+
1138
+ Get all Clients. Optionally filter for Organization Guid (orgGuid) or Organization Account Id (AccountId).
1139
+
1140
+ :param org_id: fitler by the Organization's ID
1141
+ :type org_id: int
1142
+ :param limit: Maximum number of records
1143
+ :type limit: int
1144
+ :param offset: Record offset
1145
+ :type offset: int
1146
+ :param _request_timeout: timeout setting for this request. If one
1147
+ number provided, it will be total request
1148
+ timeout. It can also be a pair (tuple) of
1149
+ (connection, read) timeouts.
1150
+ :type _request_timeout: int, tuple(int, int), optional
1151
+ :param _request_auth: set to override the auth_settings for an a single
1152
+ request; this effectively ignores the
1153
+ authentication in the spec for a single request.
1154
+ :type _request_auth: dict, optional
1155
+ :param _content_type: force content-type for the request.
1156
+ :type _content_type: str, Optional
1157
+ :param _headers: set to override the headers for a single
1158
+ request; this effectively ignores the headers
1159
+ in the spec for a single request.
1160
+ :type _headers: dict, optional
1161
+ :param _host_index: set to override the host_index for a single
1162
+ request; this effectively ignores the host_index
1163
+ in the spec for a single request.
1164
+ :type _host_index: int, optional
1165
+ :return: Returns the result object.
1166
+ """ # noqa: E501
1167
+
1168
+ _param = self._api_v1_clients_get_serialize(
1169
+ org_id=org_id,
1170
+ limit=limit,
1171
+ offset=offset,
1172
+ _request_auth=_request_auth,
1173
+ _content_type=_content_type,
1174
+ _headers=_headers,
1175
+ _host_index=_host_index
1176
+ )
1177
+
1178
+ _response_types_map: Dict[str, Optional[str]] = {
1179
+ '200': "ClientClientGetManyResponse",
1180
+ '400': "ClientClientGetManyResponse",
1181
+ '503': "ClientClientGetManyResponse",
1182
+ }
1183
+ response_data = self.api_client.call_api(
1184
+ *_param,
1185
+ _request_timeout=_request_timeout
1186
+ )
1187
+ response_data.read()
1188
+ return self.api_client.response_deserialize(
1189
+ response_data=response_data,
1190
+ response_types_map=_response_types_map,
1191
+ ).data
1192
+
1193
+
1194
+ @validate_call
1195
+ def api_v1_clients_get_with_http_info(
1196
+ self,
1197
+ org_id: Annotated[Optional[StrictInt], Field(description="fitler by the Organization's ID")] = None,
1198
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
1199
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
1200
+ _request_timeout: Union[
1201
+ None,
1202
+ Annotated[StrictFloat, Field(gt=0)],
1203
+ Tuple[
1204
+ Annotated[StrictFloat, Field(gt=0)],
1205
+ Annotated[StrictFloat, Field(gt=0)]
1206
+ ]
1207
+ ] = None,
1208
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1209
+ _content_type: Optional[StrictStr] = None,
1210
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1211
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1212
+ ) -> ApiResponse[ClientClientGetManyResponse]:
1213
+ """Get Clients
1214
+
1215
+ Get all Clients. Optionally filter for Organization Guid (orgGuid) or Organization Account Id (AccountId).
1216
+
1217
+ :param org_id: fitler by the Organization's ID
1218
+ :type org_id: int
1219
+ :param limit: Maximum number of records
1220
+ :type limit: int
1221
+ :param offset: Record offset
1222
+ :type offset: int
1223
+ :param _request_timeout: timeout setting for this request. If one
1224
+ number provided, it will be total request
1225
+ timeout. It can also be a pair (tuple) of
1226
+ (connection, read) timeouts.
1227
+ :type _request_timeout: int, tuple(int, int), optional
1228
+ :param _request_auth: set to override the auth_settings for an a single
1229
+ request; this effectively ignores the
1230
+ authentication in the spec for a single request.
1231
+ :type _request_auth: dict, optional
1232
+ :param _content_type: force content-type for the request.
1233
+ :type _content_type: str, Optional
1234
+ :param _headers: set to override the headers for a single
1235
+ request; this effectively ignores the headers
1236
+ in the spec for a single request.
1237
+ :type _headers: dict, optional
1238
+ :param _host_index: set to override the host_index for a single
1239
+ request; this effectively ignores the host_index
1240
+ in the spec for a single request.
1241
+ :type _host_index: int, optional
1242
+ :return: Returns the result object.
1243
+ """ # noqa: E501
1244
+
1245
+ _param = self._api_v1_clients_get_serialize(
1246
+ org_id=org_id,
1247
+ limit=limit,
1248
+ offset=offset,
1249
+ _request_auth=_request_auth,
1250
+ _content_type=_content_type,
1251
+ _headers=_headers,
1252
+ _host_index=_host_index
1253
+ )
1254
+
1255
+ _response_types_map: Dict[str, Optional[str]] = {
1256
+ '200': "ClientClientGetManyResponse",
1257
+ '400': "ClientClientGetManyResponse",
1258
+ '503': "ClientClientGetManyResponse",
1259
+ }
1260
+ response_data = self.api_client.call_api(
1261
+ *_param,
1262
+ _request_timeout=_request_timeout
1263
+ )
1264
+ response_data.read()
1265
+ return self.api_client.response_deserialize(
1266
+ response_data=response_data,
1267
+ response_types_map=_response_types_map,
1268
+ )
1269
+
1270
+
1271
+ @validate_call
1272
+ def api_v1_clients_get_without_preload_content(
1273
+ self,
1274
+ org_id: Annotated[Optional[StrictInt], Field(description="fitler by the Organization's ID")] = None,
1275
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
1276
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
1277
+ _request_timeout: Union[
1278
+ None,
1279
+ Annotated[StrictFloat, Field(gt=0)],
1280
+ Tuple[
1281
+ Annotated[StrictFloat, Field(gt=0)],
1282
+ Annotated[StrictFloat, Field(gt=0)]
1283
+ ]
1284
+ ] = None,
1285
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1286
+ _content_type: Optional[StrictStr] = None,
1287
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1288
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1289
+ ) -> RESTResponseType:
1290
+ """Get Clients
1291
+
1292
+ Get all Clients. Optionally filter for Organization Guid (orgGuid) or Organization Account Id (AccountId).
1293
+
1294
+ :param org_id: fitler by the Organization's ID
1295
+ :type org_id: int
1296
+ :param limit: Maximum number of records
1297
+ :type limit: int
1298
+ :param offset: Record offset
1299
+ :type offset: int
1300
+ :param _request_timeout: timeout setting for this request. If one
1301
+ number provided, it will be total request
1302
+ timeout. It can also be a pair (tuple) of
1303
+ (connection, read) timeouts.
1304
+ :type _request_timeout: int, tuple(int, int), optional
1305
+ :param _request_auth: set to override the auth_settings for an a single
1306
+ request; this effectively ignores the
1307
+ authentication in the spec for a single request.
1308
+ :type _request_auth: dict, optional
1309
+ :param _content_type: force content-type for the request.
1310
+ :type _content_type: str, Optional
1311
+ :param _headers: set to override the headers for a single
1312
+ request; this effectively ignores the headers
1313
+ in the spec for a single request.
1314
+ :type _headers: dict, optional
1315
+ :param _host_index: set to override the host_index for a single
1316
+ request; this effectively ignores the host_index
1317
+ in the spec for a single request.
1318
+ :type _host_index: int, optional
1319
+ :return: Returns the result object.
1320
+ """ # noqa: E501
1321
+
1322
+ _param = self._api_v1_clients_get_serialize(
1323
+ org_id=org_id,
1324
+ limit=limit,
1325
+ offset=offset,
1326
+ _request_auth=_request_auth,
1327
+ _content_type=_content_type,
1328
+ _headers=_headers,
1329
+ _host_index=_host_index
1330
+ )
1331
+
1332
+ _response_types_map: Dict[str, Optional[str]] = {
1333
+ '200': "ClientClientGetManyResponse",
1334
+ '400': "ClientClientGetManyResponse",
1335
+ '503': "ClientClientGetManyResponse",
1336
+ }
1337
+ response_data = self.api_client.call_api(
1338
+ *_param,
1339
+ _request_timeout=_request_timeout
1340
+ )
1341
+ return response_data.response
1342
+
1343
+
1344
+ def _api_v1_clients_get_serialize(
1345
+ self,
1346
+ org_id,
1347
+ limit,
1348
+ offset,
1349
+ _request_auth,
1350
+ _content_type,
1351
+ _headers,
1352
+ _host_index,
1353
+ ) -> RequestSerialized:
1354
+
1355
+ _host = None
1356
+
1357
+ _collection_formats: Dict[str, str] = {
1358
+ }
1359
+
1360
+ _path_params: Dict[str, str] = {}
1361
+ _query_params: List[Tuple[str, str]] = []
1362
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1363
+ _form_params: List[Tuple[str, str]] = []
1364
+ _files: Dict[
1365
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1366
+ ] = {}
1367
+ _body_params: Optional[bytes] = None
1368
+
1369
+ # process the path parameters
1370
+ # process the query parameters
1371
+ if org_id is not None:
1372
+
1373
+ _query_params.append(('orgId', org_id))
1374
+
1375
+ if limit is not None:
1376
+
1377
+ _query_params.append(('limit', limit))
1378
+
1379
+ if offset is not None:
1380
+
1381
+ _query_params.append(('offset', offset))
1382
+
1383
+ # process the header parameters
1384
+ # process the form parameters
1385
+ # process the body parameter
1386
+
1387
+
1388
+ # set the HTTP header `Accept`
1389
+ if 'Accept' not in _header_params:
1390
+ _header_params['Accept'] = self.api_client.select_header_accept(
1391
+ [
1392
+ 'application/json'
1393
+ ]
1394
+ )
1395
+
1396
+
1397
+ # authentication setting
1398
+ _auth_settings: List[str] = [
1399
+ 'ApiKeyAuth'
1400
+ ]
1401
+
1402
+ return self.api_client.param_serialize(
1403
+ method='GET',
1404
+ resource_path='/api/v1/clients/',
1405
+ path_params=_path_params,
1406
+ query_params=_query_params,
1407
+ header_params=_header_params,
1408
+ body=_body_params,
1409
+ post_params=_form_params,
1410
+ files=_files,
1411
+ auth_settings=_auth_settings,
1412
+ collection_formats=_collection_formats,
1413
+ _host=_host,
1414
+ _request_auth=_request_auth
1415
+ )
1416
+
1417
+
1418
+
1419
+
1420
+ @validate_call
1421
+ def api_v1_clients_post(
1422
+ self,
1423
+ request: Annotated[ClientClientCreateRequest, Field(description="Body")],
1424
+ _request_timeout: Union[
1425
+ None,
1426
+ Annotated[StrictFloat, Field(gt=0)],
1427
+ Tuple[
1428
+ Annotated[StrictFloat, Field(gt=0)],
1429
+ Annotated[StrictFloat, Field(gt=0)]
1430
+ ]
1431
+ ] = None,
1432
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1433
+ _content_type: Optional[StrictStr] = None,
1434
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1435
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1436
+ ) -> ClientClientCreatResponse:
1437
+ """Upsert a Client
1438
+
1439
+ Inserts a Client into the db when the `id` is `0`. Updates when the `id` is `1` or greater.
1440
+
1441
+ :param request: Body (required)
1442
+ :type request: ClientClientCreateRequest
1443
+ :param _request_timeout: timeout setting for this request. If one
1444
+ number provided, it will be total request
1445
+ timeout. It can also be a pair (tuple) of
1446
+ (connection, read) timeouts.
1447
+ :type _request_timeout: int, tuple(int, int), optional
1448
+ :param _request_auth: set to override the auth_settings for an a single
1449
+ request; this effectively ignores the
1450
+ authentication in the spec for a single request.
1451
+ :type _request_auth: dict, optional
1452
+ :param _content_type: force content-type for the request.
1453
+ :type _content_type: str, Optional
1454
+ :param _headers: set to override the headers for a single
1455
+ request; this effectively ignores the headers
1456
+ in the spec for a single request.
1457
+ :type _headers: dict, optional
1458
+ :param _host_index: set to override the host_index for a single
1459
+ request; this effectively ignores the host_index
1460
+ in the spec for a single request.
1461
+ :type _host_index: int, optional
1462
+ :return: Returns the result object.
1463
+ """ # noqa: E501
1464
+
1465
+ _param = self._api_v1_clients_post_serialize(
1466
+ request=request,
1467
+ _request_auth=_request_auth,
1468
+ _content_type=_content_type,
1469
+ _headers=_headers,
1470
+ _host_index=_host_index
1471
+ )
1472
+
1473
+ _response_types_map: Dict[str, Optional[str]] = {
1474
+ '200': "ClientClientCreatResponse",
1475
+ '400': "ClientClientCreatResponse",
1476
+ '503': "ClientClientCreatResponse",
1477
+ }
1478
+ response_data = self.api_client.call_api(
1479
+ *_param,
1480
+ _request_timeout=_request_timeout
1481
+ )
1482
+ response_data.read()
1483
+ return self.api_client.response_deserialize(
1484
+ response_data=response_data,
1485
+ response_types_map=_response_types_map,
1486
+ ).data
1487
+
1488
+
1489
+ @validate_call
1490
+ def api_v1_clients_post_with_http_info(
1491
+ self,
1492
+ request: Annotated[ClientClientCreateRequest, Field(description="Body")],
1493
+ _request_timeout: Union[
1494
+ None,
1495
+ Annotated[StrictFloat, Field(gt=0)],
1496
+ Tuple[
1497
+ Annotated[StrictFloat, Field(gt=0)],
1498
+ Annotated[StrictFloat, Field(gt=0)]
1499
+ ]
1500
+ ] = None,
1501
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1502
+ _content_type: Optional[StrictStr] = None,
1503
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1504
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1505
+ ) -> ApiResponse[ClientClientCreatResponse]:
1506
+ """Upsert a Client
1507
+
1508
+ Inserts a Client into the db when the `id` is `0`. Updates when the `id` is `1` or greater.
1509
+
1510
+ :param request: Body (required)
1511
+ :type request: ClientClientCreateRequest
1512
+ :param _request_timeout: timeout setting for this request. If one
1513
+ number provided, it will be total request
1514
+ timeout. It can also be a pair (tuple) of
1515
+ (connection, read) timeouts.
1516
+ :type _request_timeout: int, tuple(int, int), optional
1517
+ :param _request_auth: set to override the auth_settings for an a single
1518
+ request; this effectively ignores the
1519
+ authentication in the spec for a single request.
1520
+ :type _request_auth: dict, optional
1521
+ :param _content_type: force content-type for the request.
1522
+ :type _content_type: str, Optional
1523
+ :param _headers: set to override the headers for a single
1524
+ request; this effectively ignores the headers
1525
+ in the spec for a single request.
1526
+ :type _headers: dict, optional
1527
+ :param _host_index: set to override the host_index for a single
1528
+ request; this effectively ignores the host_index
1529
+ in the spec for a single request.
1530
+ :type _host_index: int, optional
1531
+ :return: Returns the result object.
1532
+ """ # noqa: E501
1533
+
1534
+ _param = self._api_v1_clients_post_serialize(
1535
+ request=request,
1536
+ _request_auth=_request_auth,
1537
+ _content_type=_content_type,
1538
+ _headers=_headers,
1539
+ _host_index=_host_index
1540
+ )
1541
+
1542
+ _response_types_map: Dict[str, Optional[str]] = {
1543
+ '200': "ClientClientCreatResponse",
1544
+ '400': "ClientClientCreatResponse",
1545
+ '503': "ClientClientCreatResponse",
1546
+ }
1547
+ response_data = self.api_client.call_api(
1548
+ *_param,
1549
+ _request_timeout=_request_timeout
1550
+ )
1551
+ response_data.read()
1552
+ return self.api_client.response_deserialize(
1553
+ response_data=response_data,
1554
+ response_types_map=_response_types_map,
1555
+ )
1556
+
1557
+
1558
+ @validate_call
1559
+ def api_v1_clients_post_without_preload_content(
1560
+ self,
1561
+ request: Annotated[ClientClientCreateRequest, Field(description="Body")],
1562
+ _request_timeout: Union[
1563
+ None,
1564
+ Annotated[StrictFloat, Field(gt=0)],
1565
+ Tuple[
1566
+ Annotated[StrictFloat, Field(gt=0)],
1567
+ Annotated[StrictFloat, Field(gt=0)]
1568
+ ]
1569
+ ] = None,
1570
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1571
+ _content_type: Optional[StrictStr] = None,
1572
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1573
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1574
+ ) -> RESTResponseType:
1575
+ """Upsert a Client
1576
+
1577
+ Inserts a Client into the db when the `id` is `0`. Updates when the `id` is `1` or greater.
1578
+
1579
+ :param request: Body (required)
1580
+ :type request: ClientClientCreateRequest
1581
+ :param _request_timeout: timeout setting for this request. If one
1582
+ number provided, it will be total request
1583
+ timeout. It can also be a pair (tuple) of
1584
+ (connection, read) timeouts.
1585
+ :type _request_timeout: int, tuple(int, int), optional
1586
+ :param _request_auth: set to override the auth_settings for an a single
1587
+ request; this effectively ignores the
1588
+ authentication in the spec for a single request.
1589
+ :type _request_auth: dict, optional
1590
+ :param _content_type: force content-type for the request.
1591
+ :type _content_type: str, Optional
1592
+ :param _headers: set to override the headers for a single
1593
+ request; this effectively ignores the headers
1594
+ in the spec for a single request.
1595
+ :type _headers: dict, optional
1596
+ :param _host_index: set to override the host_index for a single
1597
+ request; this effectively ignores the host_index
1598
+ in the spec for a single request.
1599
+ :type _host_index: int, optional
1600
+ :return: Returns the result object.
1601
+ """ # noqa: E501
1602
+
1603
+ _param = self._api_v1_clients_post_serialize(
1604
+ request=request,
1605
+ _request_auth=_request_auth,
1606
+ _content_type=_content_type,
1607
+ _headers=_headers,
1608
+ _host_index=_host_index
1609
+ )
1610
+
1611
+ _response_types_map: Dict[str, Optional[str]] = {
1612
+ '200': "ClientClientCreatResponse",
1613
+ '400': "ClientClientCreatResponse",
1614
+ '503': "ClientClientCreatResponse",
1615
+ }
1616
+ response_data = self.api_client.call_api(
1617
+ *_param,
1618
+ _request_timeout=_request_timeout
1619
+ )
1620
+ return response_data.response
1621
+
1622
+
1623
+ def _api_v1_clients_post_serialize(
1624
+ self,
1625
+ request,
1626
+ _request_auth,
1627
+ _content_type,
1628
+ _headers,
1629
+ _host_index,
1630
+ ) -> RequestSerialized:
1631
+
1632
+ _host = None
1633
+
1634
+ _collection_formats: Dict[str, str] = {
1635
+ }
1636
+
1637
+ _path_params: Dict[str, str] = {}
1638
+ _query_params: List[Tuple[str, str]] = []
1639
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1640
+ _form_params: List[Tuple[str, str]] = []
1641
+ _files: Dict[
1642
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1643
+ ] = {}
1644
+ _body_params: Optional[bytes] = None
1645
+
1646
+ # process the path parameters
1647
+ # process the query parameters
1648
+ # process the header parameters
1649
+ # process the form parameters
1650
+ # process the body parameter
1651
+ if request is not None:
1652
+ _body_params = request
1653
+
1654
+
1655
+ # set the HTTP header `Accept`
1656
+ if 'Accept' not in _header_params:
1657
+ _header_params['Accept'] = self.api_client.select_header_accept(
1658
+ [
1659
+ 'application/json'
1660
+ ]
1661
+ )
1662
+
1663
+
1664
+ # authentication setting
1665
+ _auth_settings: List[str] = [
1666
+ 'ApiKeyAuth'
1667
+ ]
1668
+
1669
+ return self.api_client.param_serialize(
1670
+ method='POST',
1671
+ resource_path='/api/v1/clients/',
1672
+ path_params=_path_params,
1673
+ query_params=_query_params,
1674
+ header_params=_header_params,
1675
+ body=_body_params,
1676
+ post_params=_form_params,
1677
+ files=_files,
1678
+ auth_settings=_auth_settings,
1679
+ collection_formats=_collection_formats,
1680
+ _host=_host,
1681
+ _request_auth=_request_auth
1682
+ )
1683
+
1684
+