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,1975 @@
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.organizations_brand_detail_response import OrganizationsBrandDetailResponse
23
+ from neurograph.v1.models.organizations_brand_upsert_request import OrganizationsBrandUpsertRequest
24
+ from neurograph.v1.models.organizations_organization_create_request import OrganizationsOrganizationCreateRequest
25
+ from neurograph.v1.models.organizations_organization_detail_response import OrganizationsOrganizationDetailResponse
26
+ from neurograph.v1.models.organizations_organization_get_many_response import OrganizationsOrganizationGetManyResponse
27
+ from neurograph.v1.models.organizations_organization_set_atlas_request import OrganizationsOrganizationSetAtlasRequest
28
+ from neurograph.v1.models.organizations_organization_set_atlas_response import OrganizationsOrganizationSetAtlasResponse
29
+ from neurograph.v1.models.organizations_organization_set_workbench_request import OrganizationsOrganizationSetWorkbenchRequest
30
+ from neurograph.v1.models.organizations_organization_set_workbench_response import OrganizationsOrganizationSetWorkbenchResponse
31
+ from neurograph.v1.models.organizations_organization_update_request import OrganizationsOrganizationUpdateRequest
32
+
33
+ from neurograph.v1.api_client import ApiClient, RequestSerialized
34
+ from neurograph.v1.api_response import ApiResponse
35
+ from neurograph.v1.rest import RESTResponseType
36
+
37
+
38
+ class OrganizationApi:
39
+ """NOTE: This class is auto generated by OpenAPI Generator
40
+ Ref: https://openapi-generator.tech
41
+
42
+ Do not edit the class manually.
43
+ """
44
+
45
+ def __init__(self, api_client=None) -> None:
46
+ if api_client is None:
47
+ api_client = ApiClient.get_default()
48
+ self.api_client = api_client
49
+
50
+
51
+ @validate_call
52
+ def api_v1_organizations_atlas_post(
53
+ self,
54
+ request: Annotated[OrganizationsOrganizationSetAtlasRequest, Field(description="Body")],
55
+ _request_timeout: Union[
56
+ None,
57
+ Annotated[StrictFloat, Field(gt=0)],
58
+ Tuple[
59
+ Annotated[StrictFloat, Field(gt=0)],
60
+ Annotated[StrictFloat, Field(gt=0)]
61
+ ]
62
+ ] = None,
63
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
64
+ _content_type: Optional[StrictStr] = None,
65
+ _headers: Optional[Dict[StrictStr, Any]] = None,
66
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
67
+ ) -> OrganizationsOrganizationSetAtlasResponse:
68
+ """Set Organization's Atlas Version
69
+
70
+ Set Organization's Atlas Version
71
+
72
+ :param request: Body (required)
73
+ :type request: OrganizationsOrganizationSetAtlasRequest
74
+ :param _request_timeout: timeout setting for this request. If one
75
+ number provided, it will be total request
76
+ timeout. It can also be a pair (tuple) of
77
+ (connection, read) timeouts.
78
+ :type _request_timeout: int, tuple(int, int), optional
79
+ :param _request_auth: set to override the auth_settings for an a single
80
+ request; this effectively ignores the
81
+ authentication in the spec for a single request.
82
+ :type _request_auth: dict, optional
83
+ :param _content_type: force content-type for the request.
84
+ :type _content_type: str, Optional
85
+ :param _headers: set to override the headers for a single
86
+ request; this effectively ignores the headers
87
+ in the spec for a single request.
88
+ :type _headers: dict, optional
89
+ :param _host_index: set to override the host_index for a single
90
+ request; this effectively ignores the host_index
91
+ in the spec for a single request.
92
+ :type _host_index: int, optional
93
+ :return: Returns the result object.
94
+ """ # noqa: E501
95
+
96
+ _param = self._api_v1_organizations_atlas_post_serialize(
97
+ request=request,
98
+ _request_auth=_request_auth,
99
+ _content_type=_content_type,
100
+ _headers=_headers,
101
+ _host_index=_host_index
102
+ )
103
+
104
+ _response_types_map: Dict[str, Optional[str]] = {
105
+ '200': "OrganizationsOrganizationSetAtlasResponse",
106
+ '400': "OrganizationsOrganizationSetAtlasResponse",
107
+ '503': "OrganizationsOrganizationSetAtlasResponse",
108
+ }
109
+ response_data = self.api_client.call_api(
110
+ *_param,
111
+ _request_timeout=_request_timeout
112
+ )
113
+ response_data.read()
114
+ return self.api_client.response_deserialize(
115
+ response_data=response_data,
116
+ response_types_map=_response_types_map,
117
+ ).data
118
+
119
+
120
+ @validate_call
121
+ def api_v1_organizations_atlas_post_with_http_info(
122
+ self,
123
+ request: Annotated[OrganizationsOrganizationSetAtlasRequest, Field(description="Body")],
124
+ _request_timeout: Union[
125
+ None,
126
+ Annotated[StrictFloat, Field(gt=0)],
127
+ Tuple[
128
+ Annotated[StrictFloat, Field(gt=0)],
129
+ Annotated[StrictFloat, Field(gt=0)]
130
+ ]
131
+ ] = None,
132
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
133
+ _content_type: Optional[StrictStr] = None,
134
+ _headers: Optional[Dict[StrictStr, Any]] = None,
135
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
136
+ ) -> ApiResponse[OrganizationsOrganizationSetAtlasResponse]:
137
+ """Set Organization's Atlas Version
138
+
139
+ Set Organization's Atlas Version
140
+
141
+ :param request: Body (required)
142
+ :type request: OrganizationsOrganizationSetAtlasRequest
143
+ :param _request_timeout: timeout setting for this request. If one
144
+ number provided, it will be total request
145
+ timeout. It can also be a pair (tuple) of
146
+ (connection, read) timeouts.
147
+ :type _request_timeout: int, tuple(int, int), optional
148
+ :param _request_auth: set to override the auth_settings for an a single
149
+ request; this effectively ignores the
150
+ authentication in the spec for a single request.
151
+ :type _request_auth: dict, optional
152
+ :param _content_type: force content-type for the request.
153
+ :type _content_type: str, Optional
154
+ :param _headers: set to override the headers for a single
155
+ request; this effectively ignores the headers
156
+ in the spec for a single request.
157
+ :type _headers: dict, optional
158
+ :param _host_index: set to override the host_index for a single
159
+ request; this effectively ignores the host_index
160
+ in the spec for a single request.
161
+ :type _host_index: int, optional
162
+ :return: Returns the result object.
163
+ """ # noqa: E501
164
+
165
+ _param = self._api_v1_organizations_atlas_post_serialize(
166
+ request=request,
167
+ _request_auth=_request_auth,
168
+ _content_type=_content_type,
169
+ _headers=_headers,
170
+ _host_index=_host_index
171
+ )
172
+
173
+ _response_types_map: Dict[str, Optional[str]] = {
174
+ '200': "OrganizationsOrganizationSetAtlasResponse",
175
+ '400': "OrganizationsOrganizationSetAtlasResponse",
176
+ '503': "OrganizationsOrganizationSetAtlasResponse",
177
+ }
178
+ response_data = self.api_client.call_api(
179
+ *_param,
180
+ _request_timeout=_request_timeout
181
+ )
182
+ response_data.read()
183
+ return self.api_client.response_deserialize(
184
+ response_data=response_data,
185
+ response_types_map=_response_types_map,
186
+ )
187
+
188
+
189
+ @validate_call
190
+ def api_v1_organizations_atlas_post_without_preload_content(
191
+ self,
192
+ request: Annotated[OrganizationsOrganizationSetAtlasRequest, Field(description="Body")],
193
+ _request_timeout: Union[
194
+ None,
195
+ Annotated[StrictFloat, Field(gt=0)],
196
+ Tuple[
197
+ Annotated[StrictFloat, Field(gt=0)],
198
+ Annotated[StrictFloat, Field(gt=0)]
199
+ ]
200
+ ] = None,
201
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
202
+ _content_type: Optional[StrictStr] = None,
203
+ _headers: Optional[Dict[StrictStr, Any]] = None,
204
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
205
+ ) -> RESTResponseType:
206
+ """Set Organization's Atlas Version
207
+
208
+ Set Organization's Atlas Version
209
+
210
+ :param request: Body (required)
211
+ :type request: OrganizationsOrganizationSetAtlasRequest
212
+ :param _request_timeout: timeout setting for this request. If one
213
+ number provided, it will be total request
214
+ timeout. It can also be a pair (tuple) of
215
+ (connection, read) timeouts.
216
+ :type _request_timeout: int, tuple(int, int), optional
217
+ :param _request_auth: set to override the auth_settings for an a single
218
+ request; this effectively ignores the
219
+ authentication in the spec for a single request.
220
+ :type _request_auth: dict, optional
221
+ :param _content_type: force content-type for the request.
222
+ :type _content_type: str, Optional
223
+ :param _headers: set to override the headers for a single
224
+ request; this effectively ignores the headers
225
+ in the spec for a single request.
226
+ :type _headers: dict, optional
227
+ :param _host_index: set to override the host_index for a single
228
+ request; this effectively ignores the host_index
229
+ in the spec for a single request.
230
+ :type _host_index: int, optional
231
+ :return: Returns the result object.
232
+ """ # noqa: E501
233
+
234
+ _param = self._api_v1_organizations_atlas_post_serialize(
235
+ request=request,
236
+ _request_auth=_request_auth,
237
+ _content_type=_content_type,
238
+ _headers=_headers,
239
+ _host_index=_host_index
240
+ )
241
+
242
+ _response_types_map: Dict[str, Optional[str]] = {
243
+ '200': "OrganizationsOrganizationSetAtlasResponse",
244
+ '400': "OrganizationsOrganizationSetAtlasResponse",
245
+ '503': "OrganizationsOrganizationSetAtlasResponse",
246
+ }
247
+ response_data = self.api_client.call_api(
248
+ *_param,
249
+ _request_timeout=_request_timeout
250
+ )
251
+ return response_data.response
252
+
253
+
254
+ def _api_v1_organizations_atlas_post_serialize(
255
+ self,
256
+ request,
257
+ _request_auth,
258
+ _content_type,
259
+ _headers,
260
+ _host_index,
261
+ ) -> RequestSerialized:
262
+
263
+ _host = None
264
+
265
+ _collection_formats: Dict[str, str] = {
266
+ }
267
+
268
+ _path_params: Dict[str, str] = {}
269
+ _query_params: List[Tuple[str, str]] = []
270
+ _header_params: Dict[str, Optional[str]] = _headers or {}
271
+ _form_params: List[Tuple[str, str]] = []
272
+ _files: Dict[
273
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
274
+ ] = {}
275
+ _body_params: Optional[bytes] = None
276
+
277
+ # process the path parameters
278
+ # process the query parameters
279
+ # process the header parameters
280
+ # process the form parameters
281
+ # process the body parameter
282
+ if request is not None:
283
+ _body_params = request
284
+
285
+
286
+ # set the HTTP header `Accept`
287
+ if 'Accept' not in _header_params:
288
+ _header_params['Accept'] = self.api_client.select_header_accept(
289
+ [
290
+ 'application/json'
291
+ ]
292
+ )
293
+
294
+
295
+ # authentication setting
296
+ _auth_settings: List[str] = [
297
+ 'ApiKeyAuth'
298
+ ]
299
+
300
+ return self.api_client.param_serialize(
301
+ method='POST',
302
+ resource_path='/api/v1/organizations/atlas/',
303
+ path_params=_path_params,
304
+ query_params=_query_params,
305
+ header_params=_header_params,
306
+ body=_body_params,
307
+ post_params=_form_params,
308
+ files=_files,
309
+ auth_settings=_auth_settings,
310
+ collection_formats=_collection_formats,
311
+ _host=_host,
312
+ _request_auth=_request_auth
313
+ )
314
+
315
+
316
+
317
+
318
+ @validate_call
319
+ def api_v1_organizations_branding_post(
320
+ self,
321
+ payload: Annotated[OrganizationsBrandUpsertRequest, Field(description="Brand details")],
322
+ _request_timeout: Union[
323
+ None,
324
+ Annotated[StrictFloat, Field(gt=0)],
325
+ Tuple[
326
+ Annotated[StrictFloat, Field(gt=0)],
327
+ Annotated[StrictFloat, Field(gt=0)]
328
+ ]
329
+ ] = None,
330
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
331
+ _content_type: Optional[StrictStr] = None,
332
+ _headers: Optional[Dict[StrictStr, Any]] = None,
333
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
334
+ ) -> OrganizationsBrandDetailResponse:
335
+ """Set Organization's Branding
336
+
337
+ UpsertCustomer branding for a specific organization
338
+
339
+ :param payload: Brand details (required)
340
+ :type payload: OrganizationsBrandUpsertRequest
341
+ :param _request_timeout: timeout setting for this request. If one
342
+ number provided, it will be total request
343
+ timeout. It can also be a pair (tuple) of
344
+ (connection, read) timeouts.
345
+ :type _request_timeout: int, tuple(int, int), optional
346
+ :param _request_auth: set to override the auth_settings for an a single
347
+ request; this effectively ignores the
348
+ authentication in the spec for a single request.
349
+ :type _request_auth: dict, optional
350
+ :param _content_type: force content-type for the request.
351
+ :type _content_type: str, Optional
352
+ :param _headers: set to override the headers for a single
353
+ request; this effectively ignores the headers
354
+ in the spec for a single request.
355
+ :type _headers: dict, optional
356
+ :param _host_index: set to override the host_index for a single
357
+ request; this effectively ignores the host_index
358
+ in the spec for a single request.
359
+ :type _host_index: int, optional
360
+ :return: Returns the result object.
361
+ """ # noqa: E501
362
+
363
+ _param = self._api_v1_organizations_branding_post_serialize(
364
+ payload=payload,
365
+ _request_auth=_request_auth,
366
+ _content_type=_content_type,
367
+ _headers=_headers,
368
+ _host_index=_host_index
369
+ )
370
+
371
+ _response_types_map: Dict[str, Optional[str]] = {
372
+ '200': "OrganizationsBrandDetailResponse",
373
+ '400': "OrganizationsBrandDetailResponse",
374
+ '503': "OrganizationsBrandDetailResponse",
375
+ }
376
+ response_data = self.api_client.call_api(
377
+ *_param,
378
+ _request_timeout=_request_timeout
379
+ )
380
+ response_data.read()
381
+ return self.api_client.response_deserialize(
382
+ response_data=response_data,
383
+ response_types_map=_response_types_map,
384
+ ).data
385
+
386
+
387
+ @validate_call
388
+ def api_v1_organizations_branding_post_with_http_info(
389
+ self,
390
+ payload: Annotated[OrganizationsBrandUpsertRequest, Field(description="Brand details")],
391
+ _request_timeout: Union[
392
+ None,
393
+ Annotated[StrictFloat, Field(gt=0)],
394
+ Tuple[
395
+ Annotated[StrictFloat, Field(gt=0)],
396
+ Annotated[StrictFloat, Field(gt=0)]
397
+ ]
398
+ ] = None,
399
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
400
+ _content_type: Optional[StrictStr] = None,
401
+ _headers: Optional[Dict[StrictStr, Any]] = None,
402
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
403
+ ) -> ApiResponse[OrganizationsBrandDetailResponse]:
404
+ """Set Organization's Branding
405
+
406
+ UpsertCustomer branding for a specific organization
407
+
408
+ :param payload: Brand details (required)
409
+ :type payload: OrganizationsBrandUpsertRequest
410
+ :param _request_timeout: timeout setting for this request. If one
411
+ number provided, it will be total request
412
+ timeout. It can also be a pair (tuple) of
413
+ (connection, read) timeouts.
414
+ :type _request_timeout: int, tuple(int, int), optional
415
+ :param _request_auth: set to override the auth_settings for an a single
416
+ request; this effectively ignores the
417
+ authentication in the spec for a single request.
418
+ :type _request_auth: dict, optional
419
+ :param _content_type: force content-type for the request.
420
+ :type _content_type: str, Optional
421
+ :param _headers: set to override the headers for a single
422
+ request; this effectively ignores the headers
423
+ in the spec for a single request.
424
+ :type _headers: dict, optional
425
+ :param _host_index: set to override the host_index for a single
426
+ request; this effectively ignores the host_index
427
+ in the spec for a single request.
428
+ :type _host_index: int, optional
429
+ :return: Returns the result object.
430
+ """ # noqa: E501
431
+
432
+ _param = self._api_v1_organizations_branding_post_serialize(
433
+ payload=payload,
434
+ _request_auth=_request_auth,
435
+ _content_type=_content_type,
436
+ _headers=_headers,
437
+ _host_index=_host_index
438
+ )
439
+
440
+ _response_types_map: Dict[str, Optional[str]] = {
441
+ '200': "OrganizationsBrandDetailResponse",
442
+ '400': "OrganizationsBrandDetailResponse",
443
+ '503': "OrganizationsBrandDetailResponse",
444
+ }
445
+ response_data = self.api_client.call_api(
446
+ *_param,
447
+ _request_timeout=_request_timeout
448
+ )
449
+ response_data.read()
450
+ return self.api_client.response_deserialize(
451
+ response_data=response_data,
452
+ response_types_map=_response_types_map,
453
+ )
454
+
455
+
456
+ @validate_call
457
+ def api_v1_organizations_branding_post_without_preload_content(
458
+ self,
459
+ payload: Annotated[OrganizationsBrandUpsertRequest, Field(description="Brand details")],
460
+ _request_timeout: Union[
461
+ None,
462
+ Annotated[StrictFloat, Field(gt=0)],
463
+ Tuple[
464
+ Annotated[StrictFloat, Field(gt=0)],
465
+ Annotated[StrictFloat, Field(gt=0)]
466
+ ]
467
+ ] = None,
468
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
469
+ _content_type: Optional[StrictStr] = None,
470
+ _headers: Optional[Dict[StrictStr, Any]] = None,
471
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
472
+ ) -> RESTResponseType:
473
+ """Set Organization's Branding
474
+
475
+ UpsertCustomer branding for a specific organization
476
+
477
+ :param payload: Brand details (required)
478
+ :type payload: OrganizationsBrandUpsertRequest
479
+ :param _request_timeout: timeout setting for this request. If one
480
+ number provided, it will be total request
481
+ timeout. It can also be a pair (tuple) of
482
+ (connection, read) timeouts.
483
+ :type _request_timeout: int, tuple(int, int), optional
484
+ :param _request_auth: set to override the auth_settings for an a single
485
+ request; this effectively ignores the
486
+ authentication in the spec for a single request.
487
+ :type _request_auth: dict, optional
488
+ :param _content_type: force content-type for the request.
489
+ :type _content_type: str, Optional
490
+ :param _headers: set to override the headers for a single
491
+ request; this effectively ignores the headers
492
+ in the spec for a single request.
493
+ :type _headers: dict, optional
494
+ :param _host_index: set to override the host_index for a single
495
+ request; this effectively ignores the host_index
496
+ in the spec for a single request.
497
+ :type _host_index: int, optional
498
+ :return: Returns the result object.
499
+ """ # noqa: E501
500
+
501
+ _param = self._api_v1_organizations_branding_post_serialize(
502
+ payload=payload,
503
+ _request_auth=_request_auth,
504
+ _content_type=_content_type,
505
+ _headers=_headers,
506
+ _host_index=_host_index
507
+ )
508
+
509
+ _response_types_map: Dict[str, Optional[str]] = {
510
+ '200': "OrganizationsBrandDetailResponse",
511
+ '400': "OrganizationsBrandDetailResponse",
512
+ '503': "OrganizationsBrandDetailResponse",
513
+ }
514
+ response_data = self.api_client.call_api(
515
+ *_param,
516
+ _request_timeout=_request_timeout
517
+ )
518
+ return response_data.response
519
+
520
+
521
+ def _api_v1_organizations_branding_post_serialize(
522
+ self,
523
+ payload,
524
+ _request_auth,
525
+ _content_type,
526
+ _headers,
527
+ _host_index,
528
+ ) -> RequestSerialized:
529
+
530
+ _host = None
531
+
532
+ _collection_formats: Dict[str, str] = {
533
+ }
534
+
535
+ _path_params: Dict[str, str] = {}
536
+ _query_params: List[Tuple[str, str]] = []
537
+ _header_params: Dict[str, Optional[str]] = _headers or {}
538
+ _form_params: List[Tuple[str, str]] = []
539
+ _files: Dict[
540
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
541
+ ] = {}
542
+ _body_params: Optional[bytes] = None
543
+
544
+ # process the path parameters
545
+ # process the query parameters
546
+ # process the header parameters
547
+ # process the form parameters
548
+ # process the body parameter
549
+ if payload is not None:
550
+ _body_params = payload
551
+
552
+
553
+ # set the HTTP header `Accept`
554
+ if 'Accept' not in _header_params:
555
+ _header_params['Accept'] = self.api_client.select_header_accept(
556
+ [
557
+ 'application/json'
558
+ ]
559
+ )
560
+
561
+ # set the HTTP header `Content-Type`
562
+ if _content_type:
563
+ _header_params['Content-Type'] = _content_type
564
+ else:
565
+ _default_content_type = (
566
+ self.api_client.select_header_content_type(
567
+ [
568
+ 'application/json'
569
+ ]
570
+ )
571
+ )
572
+ if _default_content_type is not None:
573
+ _header_params['Content-Type'] = _default_content_type
574
+
575
+ # authentication setting
576
+ _auth_settings: List[str] = [
577
+ 'ApiKeyAuth'
578
+ ]
579
+
580
+ return self.api_client.param_serialize(
581
+ method='POST',
582
+ resource_path='/api/v1/organizations/branding',
583
+ path_params=_path_params,
584
+ query_params=_query_params,
585
+ header_params=_header_params,
586
+ body=_body_params,
587
+ post_params=_form_params,
588
+ files=_files,
589
+ auth_settings=_auth_settings,
590
+ collection_formats=_collection_formats,
591
+ _host=_host,
592
+ _request_auth=_request_auth
593
+ )
594
+
595
+
596
+
597
+
598
+ @validate_call
599
+ def api_v1_organizations_get(
600
+ self,
601
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
602
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
603
+ _request_timeout: Union[
604
+ None,
605
+ Annotated[StrictFloat, Field(gt=0)],
606
+ Tuple[
607
+ Annotated[StrictFloat, Field(gt=0)],
608
+ Annotated[StrictFloat, Field(gt=0)]
609
+ ]
610
+ ] = None,
611
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
612
+ _content_type: Optional[StrictStr] = None,
613
+ _headers: Optional[Dict[StrictStr, Any]] = None,
614
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
615
+ ) -> OrganizationsOrganizationGetManyResponse:
616
+ """Get Organizations
617
+
618
+ Get all Organizations
619
+
620
+ :param limit: Maximum number of records
621
+ :type limit: int
622
+ :param offset: Record offset
623
+ :type offset: int
624
+ :param _request_timeout: timeout setting for this request. If one
625
+ number provided, it will be total request
626
+ timeout. It can also be a pair (tuple) of
627
+ (connection, read) timeouts.
628
+ :type _request_timeout: int, tuple(int, int), optional
629
+ :param _request_auth: set to override the auth_settings for an a single
630
+ request; this effectively ignores the
631
+ authentication in the spec for a single request.
632
+ :type _request_auth: dict, optional
633
+ :param _content_type: force content-type for the request.
634
+ :type _content_type: str, Optional
635
+ :param _headers: set to override the headers for a single
636
+ request; this effectively ignores the headers
637
+ in the spec for a single request.
638
+ :type _headers: dict, optional
639
+ :param _host_index: set to override the host_index for a single
640
+ request; this effectively ignores the host_index
641
+ in the spec for a single request.
642
+ :type _host_index: int, optional
643
+ :return: Returns the result object.
644
+ """ # noqa: E501
645
+
646
+ _param = self._api_v1_organizations_get_serialize(
647
+ limit=limit,
648
+ offset=offset,
649
+ _request_auth=_request_auth,
650
+ _content_type=_content_type,
651
+ _headers=_headers,
652
+ _host_index=_host_index
653
+ )
654
+
655
+ _response_types_map: Dict[str, Optional[str]] = {
656
+ '200': "OrganizationsOrganizationGetManyResponse",
657
+ '400': "OrganizationsOrganizationGetManyResponse",
658
+ '503': "OrganizationsOrganizationGetManyResponse",
659
+ }
660
+ response_data = self.api_client.call_api(
661
+ *_param,
662
+ _request_timeout=_request_timeout
663
+ )
664
+ response_data.read()
665
+ return self.api_client.response_deserialize(
666
+ response_data=response_data,
667
+ response_types_map=_response_types_map,
668
+ ).data
669
+
670
+
671
+ @validate_call
672
+ def api_v1_organizations_get_with_http_info(
673
+ self,
674
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
675
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
676
+ _request_timeout: Union[
677
+ None,
678
+ Annotated[StrictFloat, Field(gt=0)],
679
+ Tuple[
680
+ Annotated[StrictFloat, Field(gt=0)],
681
+ Annotated[StrictFloat, Field(gt=0)]
682
+ ]
683
+ ] = None,
684
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
685
+ _content_type: Optional[StrictStr] = None,
686
+ _headers: Optional[Dict[StrictStr, Any]] = None,
687
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
688
+ ) -> ApiResponse[OrganizationsOrganizationGetManyResponse]:
689
+ """Get Organizations
690
+
691
+ Get all Organizations
692
+
693
+ :param limit: Maximum number of records
694
+ :type limit: int
695
+ :param offset: Record offset
696
+ :type offset: int
697
+ :param _request_timeout: timeout setting for this request. If one
698
+ number provided, it will be total request
699
+ timeout. It can also be a pair (tuple) of
700
+ (connection, read) timeouts.
701
+ :type _request_timeout: int, tuple(int, int), optional
702
+ :param _request_auth: set to override the auth_settings for an a single
703
+ request; this effectively ignores the
704
+ authentication in the spec for a single request.
705
+ :type _request_auth: dict, optional
706
+ :param _content_type: force content-type for the request.
707
+ :type _content_type: str, Optional
708
+ :param _headers: set to override the headers for a single
709
+ request; this effectively ignores the headers
710
+ in the spec for a single request.
711
+ :type _headers: dict, optional
712
+ :param _host_index: set to override the host_index for a single
713
+ request; this effectively ignores the host_index
714
+ in the spec for a single request.
715
+ :type _host_index: int, optional
716
+ :return: Returns the result object.
717
+ """ # noqa: E501
718
+
719
+ _param = self._api_v1_organizations_get_serialize(
720
+ limit=limit,
721
+ offset=offset,
722
+ _request_auth=_request_auth,
723
+ _content_type=_content_type,
724
+ _headers=_headers,
725
+ _host_index=_host_index
726
+ )
727
+
728
+ _response_types_map: Dict[str, Optional[str]] = {
729
+ '200': "OrganizationsOrganizationGetManyResponse",
730
+ '400': "OrganizationsOrganizationGetManyResponse",
731
+ '503': "OrganizationsOrganizationGetManyResponse",
732
+ }
733
+ response_data = self.api_client.call_api(
734
+ *_param,
735
+ _request_timeout=_request_timeout
736
+ )
737
+ response_data.read()
738
+ return self.api_client.response_deserialize(
739
+ response_data=response_data,
740
+ response_types_map=_response_types_map,
741
+ )
742
+
743
+
744
+ @validate_call
745
+ def api_v1_organizations_get_without_preload_content(
746
+ self,
747
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of records")] = None,
748
+ offset: Annotated[Optional[StrictInt], Field(description="Record offset")] = None,
749
+ _request_timeout: Union[
750
+ None,
751
+ Annotated[StrictFloat, Field(gt=0)],
752
+ Tuple[
753
+ Annotated[StrictFloat, Field(gt=0)],
754
+ Annotated[StrictFloat, Field(gt=0)]
755
+ ]
756
+ ] = None,
757
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
758
+ _content_type: Optional[StrictStr] = None,
759
+ _headers: Optional[Dict[StrictStr, Any]] = None,
760
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
761
+ ) -> RESTResponseType:
762
+ """Get Organizations
763
+
764
+ Get all Organizations
765
+
766
+ :param limit: Maximum number of records
767
+ :type limit: int
768
+ :param offset: Record offset
769
+ :type offset: int
770
+ :param _request_timeout: timeout setting for this request. If one
771
+ number provided, it will be total request
772
+ timeout. It can also be a pair (tuple) of
773
+ (connection, read) timeouts.
774
+ :type _request_timeout: int, tuple(int, int), optional
775
+ :param _request_auth: set to override the auth_settings for an a single
776
+ request; this effectively ignores the
777
+ authentication in the spec for a single request.
778
+ :type _request_auth: dict, optional
779
+ :param _content_type: force content-type for the request.
780
+ :type _content_type: str, Optional
781
+ :param _headers: set to override the headers for a single
782
+ request; this effectively ignores the headers
783
+ in the spec for a single request.
784
+ :type _headers: dict, optional
785
+ :param _host_index: set to override the host_index for a single
786
+ request; this effectively ignores the host_index
787
+ in the spec for a single request.
788
+ :type _host_index: int, optional
789
+ :return: Returns the result object.
790
+ """ # noqa: E501
791
+
792
+ _param = self._api_v1_organizations_get_serialize(
793
+ limit=limit,
794
+ offset=offset,
795
+ _request_auth=_request_auth,
796
+ _content_type=_content_type,
797
+ _headers=_headers,
798
+ _host_index=_host_index
799
+ )
800
+
801
+ _response_types_map: Dict[str, Optional[str]] = {
802
+ '200': "OrganizationsOrganizationGetManyResponse",
803
+ '400': "OrganizationsOrganizationGetManyResponse",
804
+ '503': "OrganizationsOrganizationGetManyResponse",
805
+ }
806
+ response_data = self.api_client.call_api(
807
+ *_param,
808
+ _request_timeout=_request_timeout
809
+ )
810
+ return response_data.response
811
+
812
+
813
+ def _api_v1_organizations_get_serialize(
814
+ self,
815
+ limit,
816
+ offset,
817
+ _request_auth,
818
+ _content_type,
819
+ _headers,
820
+ _host_index,
821
+ ) -> RequestSerialized:
822
+
823
+ _host = None
824
+
825
+ _collection_formats: Dict[str, str] = {
826
+ }
827
+
828
+ _path_params: Dict[str, str] = {}
829
+ _query_params: List[Tuple[str, str]] = []
830
+ _header_params: Dict[str, Optional[str]] = _headers or {}
831
+ _form_params: List[Tuple[str, str]] = []
832
+ _files: Dict[
833
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
834
+ ] = {}
835
+ _body_params: Optional[bytes] = None
836
+
837
+ # process the path parameters
838
+ # process the query parameters
839
+ if limit is not None:
840
+
841
+ _query_params.append(('limit', limit))
842
+
843
+ if offset is not None:
844
+
845
+ _query_params.append(('offset', offset))
846
+
847
+ # process the header parameters
848
+ # process the form parameters
849
+ # process the body parameter
850
+
851
+
852
+ # set the HTTP header `Accept`
853
+ if 'Accept' not in _header_params:
854
+ _header_params['Accept'] = self.api_client.select_header_accept(
855
+ [
856
+ 'application/json'
857
+ ]
858
+ )
859
+
860
+
861
+ # authentication setting
862
+ _auth_settings: List[str] = [
863
+ 'ApiKeyAuth'
864
+ ]
865
+
866
+ return self.api_client.param_serialize(
867
+ method='GET',
868
+ resource_path='/api/v1/organizations/',
869
+ path_params=_path_params,
870
+ query_params=_query_params,
871
+ header_params=_header_params,
872
+ body=_body_params,
873
+ post_params=_form_params,
874
+ files=_files,
875
+ auth_settings=_auth_settings,
876
+ collection_formats=_collection_formats,
877
+ _host=_host,
878
+ _request_auth=_request_auth
879
+ )
880
+
881
+
882
+
883
+
884
+ @validate_call
885
+ def api_v1_organizations_id_get(
886
+ self,
887
+ id: Annotated[StrictInt, Field(description="Organization's ID")],
888
+ _request_timeout: Union[
889
+ None,
890
+ Annotated[StrictFloat, Field(gt=0)],
891
+ Tuple[
892
+ Annotated[StrictFloat, Field(gt=0)],
893
+ Annotated[StrictFloat, Field(gt=0)]
894
+ ]
895
+ ] = None,
896
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
897
+ _content_type: Optional[StrictStr] = None,
898
+ _headers: Optional[Dict[StrictStr, Any]] = None,
899
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
900
+ ) -> OrganizationsOrganizationDetailResponse:
901
+ """Get Organization by it's ID
902
+
903
+ Get Organization by it's ID
904
+
905
+ :param id: Organization's ID (required)
906
+ :type id: int
907
+ :param _request_timeout: timeout setting for this request. If one
908
+ number provided, it will be total request
909
+ timeout. It can also be a pair (tuple) of
910
+ (connection, read) timeouts.
911
+ :type _request_timeout: int, tuple(int, int), optional
912
+ :param _request_auth: set to override the auth_settings for an a single
913
+ request; this effectively ignores the
914
+ authentication in the spec for a single request.
915
+ :type _request_auth: dict, optional
916
+ :param _content_type: force content-type for the request.
917
+ :type _content_type: str, Optional
918
+ :param _headers: set to override the headers for a single
919
+ request; this effectively ignores the headers
920
+ in the spec for a single request.
921
+ :type _headers: dict, optional
922
+ :param _host_index: set to override the host_index for a single
923
+ request; this effectively ignores the host_index
924
+ in the spec for a single request.
925
+ :type _host_index: int, optional
926
+ :return: Returns the result object.
927
+ """ # noqa: E501
928
+
929
+ _param = self._api_v1_organizations_id_get_serialize(
930
+ id=id,
931
+ _request_auth=_request_auth,
932
+ _content_type=_content_type,
933
+ _headers=_headers,
934
+ _host_index=_host_index
935
+ )
936
+
937
+ _response_types_map: Dict[str, Optional[str]] = {
938
+ '200': "OrganizationsOrganizationDetailResponse",
939
+ '400': "OrganizationsOrganizationDetailResponse",
940
+ '503': "OrganizationsOrganizationDetailResponse",
941
+ }
942
+ response_data = self.api_client.call_api(
943
+ *_param,
944
+ _request_timeout=_request_timeout
945
+ )
946
+ response_data.read()
947
+ return self.api_client.response_deserialize(
948
+ response_data=response_data,
949
+ response_types_map=_response_types_map,
950
+ ).data
951
+
952
+
953
+ @validate_call
954
+ def api_v1_organizations_id_get_with_http_info(
955
+ self,
956
+ id: Annotated[StrictInt, Field(description="Organization's ID")],
957
+ _request_timeout: Union[
958
+ None,
959
+ Annotated[StrictFloat, Field(gt=0)],
960
+ Tuple[
961
+ Annotated[StrictFloat, Field(gt=0)],
962
+ Annotated[StrictFloat, Field(gt=0)]
963
+ ]
964
+ ] = None,
965
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
966
+ _content_type: Optional[StrictStr] = None,
967
+ _headers: Optional[Dict[StrictStr, Any]] = None,
968
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
969
+ ) -> ApiResponse[OrganizationsOrganizationDetailResponse]:
970
+ """Get Organization by it's ID
971
+
972
+ Get Organization by it's ID
973
+
974
+ :param id: Organization's ID (required)
975
+ :type id: int
976
+ :param _request_timeout: timeout setting for this request. If one
977
+ number provided, it will be total request
978
+ timeout. It can also be a pair (tuple) of
979
+ (connection, read) timeouts.
980
+ :type _request_timeout: int, tuple(int, int), optional
981
+ :param _request_auth: set to override the auth_settings for an a single
982
+ request; this effectively ignores the
983
+ authentication in the spec for a single request.
984
+ :type _request_auth: dict, optional
985
+ :param _content_type: force content-type for the request.
986
+ :type _content_type: str, Optional
987
+ :param _headers: set to override the headers for a single
988
+ request; this effectively ignores the headers
989
+ in the spec for a single request.
990
+ :type _headers: dict, optional
991
+ :param _host_index: set to override the host_index for a single
992
+ request; this effectively ignores the host_index
993
+ in the spec for a single request.
994
+ :type _host_index: int, optional
995
+ :return: Returns the result object.
996
+ """ # noqa: E501
997
+
998
+ _param = self._api_v1_organizations_id_get_serialize(
999
+ id=id,
1000
+ _request_auth=_request_auth,
1001
+ _content_type=_content_type,
1002
+ _headers=_headers,
1003
+ _host_index=_host_index
1004
+ )
1005
+
1006
+ _response_types_map: Dict[str, Optional[str]] = {
1007
+ '200': "OrganizationsOrganizationDetailResponse",
1008
+ '400': "OrganizationsOrganizationDetailResponse",
1009
+ '503': "OrganizationsOrganizationDetailResponse",
1010
+ }
1011
+ response_data = self.api_client.call_api(
1012
+ *_param,
1013
+ _request_timeout=_request_timeout
1014
+ )
1015
+ response_data.read()
1016
+ return self.api_client.response_deserialize(
1017
+ response_data=response_data,
1018
+ response_types_map=_response_types_map,
1019
+ )
1020
+
1021
+
1022
+ @validate_call
1023
+ def api_v1_organizations_id_get_without_preload_content(
1024
+ self,
1025
+ id: Annotated[StrictInt, Field(description="Organization's ID")],
1026
+ _request_timeout: Union[
1027
+ None,
1028
+ Annotated[StrictFloat, Field(gt=0)],
1029
+ Tuple[
1030
+ Annotated[StrictFloat, Field(gt=0)],
1031
+ Annotated[StrictFloat, Field(gt=0)]
1032
+ ]
1033
+ ] = None,
1034
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1035
+ _content_type: Optional[StrictStr] = None,
1036
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1037
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1038
+ ) -> RESTResponseType:
1039
+ """Get Organization by it's ID
1040
+
1041
+ Get Organization by it's ID
1042
+
1043
+ :param id: Organization's ID (required)
1044
+ :type id: int
1045
+ :param _request_timeout: timeout setting for this request. If one
1046
+ number provided, it will be total request
1047
+ timeout. It can also be a pair (tuple) of
1048
+ (connection, read) timeouts.
1049
+ :type _request_timeout: int, tuple(int, int), optional
1050
+ :param _request_auth: set to override the auth_settings for an a single
1051
+ request; this effectively ignores the
1052
+ authentication in the spec for a single request.
1053
+ :type _request_auth: dict, optional
1054
+ :param _content_type: force content-type for the request.
1055
+ :type _content_type: str, Optional
1056
+ :param _headers: set to override the headers for a single
1057
+ request; this effectively ignores the headers
1058
+ in the spec for a single request.
1059
+ :type _headers: dict, optional
1060
+ :param _host_index: set to override the host_index for a single
1061
+ request; this effectively ignores the host_index
1062
+ in the spec for a single request.
1063
+ :type _host_index: int, optional
1064
+ :return: Returns the result object.
1065
+ """ # noqa: E501
1066
+
1067
+ _param = self._api_v1_organizations_id_get_serialize(
1068
+ id=id,
1069
+ _request_auth=_request_auth,
1070
+ _content_type=_content_type,
1071
+ _headers=_headers,
1072
+ _host_index=_host_index
1073
+ )
1074
+
1075
+ _response_types_map: Dict[str, Optional[str]] = {
1076
+ '200': "OrganizationsOrganizationDetailResponse",
1077
+ '400': "OrganizationsOrganizationDetailResponse",
1078
+ '503': "OrganizationsOrganizationDetailResponse",
1079
+ }
1080
+ response_data = self.api_client.call_api(
1081
+ *_param,
1082
+ _request_timeout=_request_timeout
1083
+ )
1084
+ return response_data.response
1085
+
1086
+
1087
+ def _api_v1_organizations_id_get_serialize(
1088
+ self,
1089
+ id,
1090
+ _request_auth,
1091
+ _content_type,
1092
+ _headers,
1093
+ _host_index,
1094
+ ) -> RequestSerialized:
1095
+
1096
+ _host = None
1097
+
1098
+ _collection_formats: Dict[str, str] = {
1099
+ }
1100
+
1101
+ _path_params: Dict[str, str] = {}
1102
+ _query_params: List[Tuple[str, str]] = []
1103
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1104
+ _form_params: List[Tuple[str, str]] = []
1105
+ _files: Dict[
1106
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1107
+ ] = {}
1108
+ _body_params: Optional[bytes] = None
1109
+
1110
+ # process the path parameters
1111
+ if id is not None:
1112
+ _path_params['id'] = id
1113
+ # process the query parameters
1114
+ # process the header parameters
1115
+ # process the form parameters
1116
+ # process the body parameter
1117
+
1118
+
1119
+ # set the HTTP header `Accept`
1120
+ if 'Accept' not in _header_params:
1121
+ _header_params['Accept'] = self.api_client.select_header_accept(
1122
+ [
1123
+ 'application/json'
1124
+ ]
1125
+ )
1126
+
1127
+
1128
+ # authentication setting
1129
+ _auth_settings: List[str] = [
1130
+ 'ApiKeyAuth'
1131
+ ]
1132
+
1133
+ return self.api_client.param_serialize(
1134
+ method='GET',
1135
+ resource_path='/api/v1/organizations/{id}',
1136
+ path_params=_path_params,
1137
+ query_params=_query_params,
1138
+ header_params=_header_params,
1139
+ body=_body_params,
1140
+ post_params=_form_params,
1141
+ files=_files,
1142
+ auth_settings=_auth_settings,
1143
+ collection_formats=_collection_formats,
1144
+ _host=_host,
1145
+ _request_auth=_request_auth
1146
+ )
1147
+
1148
+
1149
+
1150
+
1151
+ @validate_call
1152
+ def api_v1_organizations_post(
1153
+ self,
1154
+ request: Annotated[OrganizationsOrganizationCreateRequest, Field(description="Body")],
1155
+ _request_timeout: Union[
1156
+ None,
1157
+ Annotated[StrictFloat, Field(gt=0)],
1158
+ Tuple[
1159
+ Annotated[StrictFloat, Field(gt=0)],
1160
+ Annotated[StrictFloat, Field(gt=0)]
1161
+ ]
1162
+ ] = None,
1163
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1164
+ _content_type: Optional[StrictStr] = None,
1165
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1166
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1167
+ ) -> OrganizationsOrganizationDetailResponse:
1168
+ """Create an Organization
1169
+
1170
+ Create an Organization
1171
+
1172
+ :param request: Body (required)
1173
+ :type request: OrganizationsOrganizationCreateRequest
1174
+ :param _request_timeout: timeout setting for this request. If one
1175
+ number provided, it will be total request
1176
+ timeout. It can also be a pair (tuple) of
1177
+ (connection, read) timeouts.
1178
+ :type _request_timeout: int, tuple(int, int), optional
1179
+ :param _request_auth: set to override the auth_settings for an a single
1180
+ request; this effectively ignores the
1181
+ authentication in the spec for a single request.
1182
+ :type _request_auth: dict, optional
1183
+ :param _content_type: force content-type for the request.
1184
+ :type _content_type: str, Optional
1185
+ :param _headers: set to override the headers for a single
1186
+ request; this effectively ignores the headers
1187
+ in the spec for a single request.
1188
+ :type _headers: dict, optional
1189
+ :param _host_index: set to override the host_index for a single
1190
+ request; this effectively ignores the host_index
1191
+ in the spec for a single request.
1192
+ :type _host_index: int, optional
1193
+ :return: Returns the result object.
1194
+ """ # noqa: E501
1195
+
1196
+ _param = self._api_v1_organizations_post_serialize(
1197
+ request=request,
1198
+ _request_auth=_request_auth,
1199
+ _content_type=_content_type,
1200
+ _headers=_headers,
1201
+ _host_index=_host_index
1202
+ )
1203
+
1204
+ _response_types_map: Dict[str, Optional[str]] = {
1205
+ '200': "OrganizationsOrganizationDetailResponse",
1206
+ '400': "OrganizationsOrganizationDetailResponse",
1207
+ '503': "OrganizationsOrganizationDetailResponse",
1208
+ }
1209
+ response_data = self.api_client.call_api(
1210
+ *_param,
1211
+ _request_timeout=_request_timeout
1212
+ )
1213
+ response_data.read()
1214
+ return self.api_client.response_deserialize(
1215
+ response_data=response_data,
1216
+ response_types_map=_response_types_map,
1217
+ ).data
1218
+
1219
+
1220
+ @validate_call
1221
+ def api_v1_organizations_post_with_http_info(
1222
+ self,
1223
+ request: Annotated[OrganizationsOrganizationCreateRequest, Field(description="Body")],
1224
+ _request_timeout: Union[
1225
+ None,
1226
+ Annotated[StrictFloat, Field(gt=0)],
1227
+ Tuple[
1228
+ Annotated[StrictFloat, Field(gt=0)],
1229
+ Annotated[StrictFloat, Field(gt=0)]
1230
+ ]
1231
+ ] = None,
1232
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1233
+ _content_type: Optional[StrictStr] = None,
1234
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1235
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1236
+ ) -> ApiResponse[OrganizationsOrganizationDetailResponse]:
1237
+ """Create an Organization
1238
+
1239
+ Create an Organization
1240
+
1241
+ :param request: Body (required)
1242
+ :type request: OrganizationsOrganizationCreateRequest
1243
+ :param _request_timeout: timeout setting for this request. If one
1244
+ number provided, it will be total request
1245
+ timeout. It can also be a pair (tuple) of
1246
+ (connection, read) timeouts.
1247
+ :type _request_timeout: int, tuple(int, int), optional
1248
+ :param _request_auth: set to override the auth_settings for an a single
1249
+ request; this effectively ignores the
1250
+ authentication in the spec for a single request.
1251
+ :type _request_auth: dict, optional
1252
+ :param _content_type: force content-type for the request.
1253
+ :type _content_type: str, Optional
1254
+ :param _headers: set to override the headers for a single
1255
+ request; this effectively ignores the headers
1256
+ in the spec for a single request.
1257
+ :type _headers: dict, optional
1258
+ :param _host_index: set to override the host_index for a single
1259
+ request; this effectively ignores the host_index
1260
+ in the spec for a single request.
1261
+ :type _host_index: int, optional
1262
+ :return: Returns the result object.
1263
+ """ # noqa: E501
1264
+
1265
+ _param = self._api_v1_organizations_post_serialize(
1266
+ request=request,
1267
+ _request_auth=_request_auth,
1268
+ _content_type=_content_type,
1269
+ _headers=_headers,
1270
+ _host_index=_host_index
1271
+ )
1272
+
1273
+ _response_types_map: Dict[str, Optional[str]] = {
1274
+ '200': "OrganizationsOrganizationDetailResponse",
1275
+ '400': "OrganizationsOrganizationDetailResponse",
1276
+ '503': "OrganizationsOrganizationDetailResponse",
1277
+ }
1278
+ response_data = self.api_client.call_api(
1279
+ *_param,
1280
+ _request_timeout=_request_timeout
1281
+ )
1282
+ response_data.read()
1283
+ return self.api_client.response_deserialize(
1284
+ response_data=response_data,
1285
+ response_types_map=_response_types_map,
1286
+ )
1287
+
1288
+
1289
+ @validate_call
1290
+ def api_v1_organizations_post_without_preload_content(
1291
+ self,
1292
+ request: Annotated[OrganizationsOrganizationCreateRequest, Field(description="Body")],
1293
+ _request_timeout: Union[
1294
+ None,
1295
+ Annotated[StrictFloat, Field(gt=0)],
1296
+ Tuple[
1297
+ Annotated[StrictFloat, Field(gt=0)],
1298
+ Annotated[StrictFloat, Field(gt=0)]
1299
+ ]
1300
+ ] = None,
1301
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1302
+ _content_type: Optional[StrictStr] = None,
1303
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1304
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1305
+ ) -> RESTResponseType:
1306
+ """Create an Organization
1307
+
1308
+ Create an Organization
1309
+
1310
+ :param request: Body (required)
1311
+ :type request: OrganizationsOrganizationCreateRequest
1312
+ :param _request_timeout: timeout setting for this request. If one
1313
+ number provided, it will be total request
1314
+ timeout. It can also be a pair (tuple) of
1315
+ (connection, read) timeouts.
1316
+ :type _request_timeout: int, tuple(int, int), optional
1317
+ :param _request_auth: set to override the auth_settings for an a single
1318
+ request; this effectively ignores the
1319
+ authentication in the spec for a single request.
1320
+ :type _request_auth: dict, optional
1321
+ :param _content_type: force content-type for the request.
1322
+ :type _content_type: str, Optional
1323
+ :param _headers: set to override the headers for a single
1324
+ request; this effectively ignores the headers
1325
+ in the spec for a single request.
1326
+ :type _headers: dict, optional
1327
+ :param _host_index: set to override the host_index for a single
1328
+ request; this effectively ignores the host_index
1329
+ in the spec for a single request.
1330
+ :type _host_index: int, optional
1331
+ :return: Returns the result object.
1332
+ """ # noqa: E501
1333
+
1334
+ _param = self._api_v1_organizations_post_serialize(
1335
+ request=request,
1336
+ _request_auth=_request_auth,
1337
+ _content_type=_content_type,
1338
+ _headers=_headers,
1339
+ _host_index=_host_index
1340
+ )
1341
+
1342
+ _response_types_map: Dict[str, Optional[str]] = {
1343
+ '200': "OrganizationsOrganizationDetailResponse",
1344
+ '400': "OrganizationsOrganizationDetailResponse",
1345
+ '503': "OrganizationsOrganizationDetailResponse",
1346
+ }
1347
+ response_data = self.api_client.call_api(
1348
+ *_param,
1349
+ _request_timeout=_request_timeout
1350
+ )
1351
+ return response_data.response
1352
+
1353
+
1354
+ def _api_v1_organizations_post_serialize(
1355
+ self,
1356
+ request,
1357
+ _request_auth,
1358
+ _content_type,
1359
+ _headers,
1360
+ _host_index,
1361
+ ) -> RequestSerialized:
1362
+
1363
+ _host = None
1364
+
1365
+ _collection_formats: Dict[str, str] = {
1366
+ }
1367
+
1368
+ _path_params: Dict[str, str] = {}
1369
+ _query_params: List[Tuple[str, str]] = []
1370
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1371
+ _form_params: List[Tuple[str, str]] = []
1372
+ _files: Dict[
1373
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1374
+ ] = {}
1375
+ _body_params: Optional[bytes] = None
1376
+
1377
+ # process the path parameters
1378
+ # process the query parameters
1379
+ # process the header parameters
1380
+ # process the form parameters
1381
+ # process the body parameter
1382
+ if request is not None:
1383
+ _body_params = request
1384
+
1385
+
1386
+ # set the HTTP header `Accept`
1387
+ if 'Accept' not in _header_params:
1388
+ _header_params['Accept'] = self.api_client.select_header_accept(
1389
+ [
1390
+ 'application/json'
1391
+ ]
1392
+ )
1393
+
1394
+ # set the HTTP header `Content-Type`
1395
+ if _content_type:
1396
+ _header_params['Content-Type'] = _content_type
1397
+ else:
1398
+ _default_content_type = (
1399
+ self.api_client.select_header_content_type(
1400
+ [
1401
+ 'application/json'
1402
+ ]
1403
+ )
1404
+ )
1405
+ if _default_content_type is not None:
1406
+ _header_params['Content-Type'] = _default_content_type
1407
+
1408
+ # authentication setting
1409
+ _auth_settings: List[str] = [
1410
+ 'ApiKeyAuth'
1411
+ ]
1412
+
1413
+ return self.api_client.param_serialize(
1414
+ method='POST',
1415
+ resource_path='/api/v1/organizations/',
1416
+ path_params=_path_params,
1417
+ query_params=_query_params,
1418
+ header_params=_header_params,
1419
+ body=_body_params,
1420
+ post_params=_form_params,
1421
+ files=_files,
1422
+ auth_settings=_auth_settings,
1423
+ collection_formats=_collection_formats,
1424
+ _host=_host,
1425
+ _request_auth=_request_auth
1426
+ )
1427
+
1428
+
1429
+
1430
+
1431
+ @validate_call
1432
+ def api_v1_organizations_put(
1433
+ self,
1434
+ request: Annotated[OrganizationsOrganizationUpdateRequest, Field(description="Body")],
1435
+ _request_timeout: Union[
1436
+ None,
1437
+ Annotated[StrictFloat, Field(gt=0)],
1438
+ Tuple[
1439
+ Annotated[StrictFloat, Field(gt=0)],
1440
+ Annotated[StrictFloat, Field(gt=0)]
1441
+ ]
1442
+ ] = None,
1443
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1444
+ _content_type: Optional[StrictStr] = None,
1445
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1446
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1447
+ ) -> OrganizationsOrganizationDetailResponse:
1448
+ """Update an Organization
1449
+
1450
+ Update an Organization
1451
+
1452
+ :param request: Body (required)
1453
+ :type request: OrganizationsOrganizationUpdateRequest
1454
+ :param _request_timeout: timeout setting for this request. If one
1455
+ number provided, it will be total request
1456
+ timeout. It can also be a pair (tuple) of
1457
+ (connection, read) timeouts.
1458
+ :type _request_timeout: int, tuple(int, int), optional
1459
+ :param _request_auth: set to override the auth_settings for an a single
1460
+ request; this effectively ignores the
1461
+ authentication in the spec for a single request.
1462
+ :type _request_auth: dict, optional
1463
+ :param _content_type: force content-type for the request.
1464
+ :type _content_type: str, Optional
1465
+ :param _headers: set to override the headers for a single
1466
+ request; this effectively ignores the headers
1467
+ in the spec for a single request.
1468
+ :type _headers: dict, optional
1469
+ :param _host_index: set to override the host_index for a single
1470
+ request; this effectively ignores the host_index
1471
+ in the spec for a single request.
1472
+ :type _host_index: int, optional
1473
+ :return: Returns the result object.
1474
+ """ # noqa: E501
1475
+
1476
+ _param = self._api_v1_organizations_put_serialize(
1477
+ request=request,
1478
+ _request_auth=_request_auth,
1479
+ _content_type=_content_type,
1480
+ _headers=_headers,
1481
+ _host_index=_host_index
1482
+ )
1483
+
1484
+ _response_types_map: Dict[str, Optional[str]] = {
1485
+ '200': "OrganizationsOrganizationDetailResponse",
1486
+ '400': "OrganizationsOrganizationDetailResponse",
1487
+ '503': "OrganizationsOrganizationDetailResponse",
1488
+ }
1489
+ response_data = self.api_client.call_api(
1490
+ *_param,
1491
+ _request_timeout=_request_timeout
1492
+ )
1493
+ response_data.read()
1494
+ return self.api_client.response_deserialize(
1495
+ response_data=response_data,
1496
+ response_types_map=_response_types_map,
1497
+ ).data
1498
+
1499
+
1500
+ @validate_call
1501
+ def api_v1_organizations_put_with_http_info(
1502
+ self,
1503
+ request: Annotated[OrganizationsOrganizationUpdateRequest, Field(description="Body")],
1504
+ _request_timeout: Union[
1505
+ None,
1506
+ Annotated[StrictFloat, Field(gt=0)],
1507
+ Tuple[
1508
+ Annotated[StrictFloat, Field(gt=0)],
1509
+ Annotated[StrictFloat, Field(gt=0)]
1510
+ ]
1511
+ ] = None,
1512
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1513
+ _content_type: Optional[StrictStr] = None,
1514
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1515
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1516
+ ) -> ApiResponse[OrganizationsOrganizationDetailResponse]:
1517
+ """Update an Organization
1518
+
1519
+ Update an Organization
1520
+
1521
+ :param request: Body (required)
1522
+ :type request: OrganizationsOrganizationUpdateRequest
1523
+ :param _request_timeout: timeout setting for this request. If one
1524
+ number provided, it will be total request
1525
+ timeout. It can also be a pair (tuple) of
1526
+ (connection, read) timeouts.
1527
+ :type _request_timeout: int, tuple(int, int), optional
1528
+ :param _request_auth: set to override the auth_settings for an a single
1529
+ request; this effectively ignores the
1530
+ authentication in the spec for a single request.
1531
+ :type _request_auth: dict, optional
1532
+ :param _content_type: force content-type for the request.
1533
+ :type _content_type: str, Optional
1534
+ :param _headers: set to override the headers for a single
1535
+ request; this effectively ignores the headers
1536
+ in the spec for a single request.
1537
+ :type _headers: dict, optional
1538
+ :param _host_index: set to override the host_index for a single
1539
+ request; this effectively ignores the host_index
1540
+ in the spec for a single request.
1541
+ :type _host_index: int, optional
1542
+ :return: Returns the result object.
1543
+ """ # noqa: E501
1544
+
1545
+ _param = self._api_v1_organizations_put_serialize(
1546
+ request=request,
1547
+ _request_auth=_request_auth,
1548
+ _content_type=_content_type,
1549
+ _headers=_headers,
1550
+ _host_index=_host_index
1551
+ )
1552
+
1553
+ _response_types_map: Dict[str, Optional[str]] = {
1554
+ '200': "OrganizationsOrganizationDetailResponse",
1555
+ '400': "OrganizationsOrganizationDetailResponse",
1556
+ '503': "OrganizationsOrganizationDetailResponse",
1557
+ }
1558
+ response_data = self.api_client.call_api(
1559
+ *_param,
1560
+ _request_timeout=_request_timeout
1561
+ )
1562
+ response_data.read()
1563
+ return self.api_client.response_deserialize(
1564
+ response_data=response_data,
1565
+ response_types_map=_response_types_map,
1566
+ )
1567
+
1568
+
1569
+ @validate_call
1570
+ def api_v1_organizations_put_without_preload_content(
1571
+ self,
1572
+ request: Annotated[OrganizationsOrganizationUpdateRequest, Field(description="Body")],
1573
+ _request_timeout: Union[
1574
+ None,
1575
+ Annotated[StrictFloat, Field(gt=0)],
1576
+ Tuple[
1577
+ Annotated[StrictFloat, Field(gt=0)],
1578
+ Annotated[StrictFloat, Field(gt=0)]
1579
+ ]
1580
+ ] = None,
1581
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1582
+ _content_type: Optional[StrictStr] = None,
1583
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1584
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1585
+ ) -> RESTResponseType:
1586
+ """Update an Organization
1587
+
1588
+ Update an Organization
1589
+
1590
+ :param request: Body (required)
1591
+ :type request: OrganizationsOrganizationUpdateRequest
1592
+ :param _request_timeout: timeout setting for this request. If one
1593
+ number provided, it will be total request
1594
+ timeout. It can also be a pair (tuple) of
1595
+ (connection, read) timeouts.
1596
+ :type _request_timeout: int, tuple(int, int), optional
1597
+ :param _request_auth: set to override the auth_settings for an a single
1598
+ request; this effectively ignores the
1599
+ authentication in the spec for a single request.
1600
+ :type _request_auth: dict, optional
1601
+ :param _content_type: force content-type for the request.
1602
+ :type _content_type: str, Optional
1603
+ :param _headers: set to override the headers for a single
1604
+ request; this effectively ignores the headers
1605
+ in the spec for a single request.
1606
+ :type _headers: dict, optional
1607
+ :param _host_index: set to override the host_index for a single
1608
+ request; this effectively ignores the host_index
1609
+ in the spec for a single request.
1610
+ :type _host_index: int, optional
1611
+ :return: Returns the result object.
1612
+ """ # noqa: E501
1613
+
1614
+ _param = self._api_v1_organizations_put_serialize(
1615
+ request=request,
1616
+ _request_auth=_request_auth,
1617
+ _content_type=_content_type,
1618
+ _headers=_headers,
1619
+ _host_index=_host_index
1620
+ )
1621
+
1622
+ _response_types_map: Dict[str, Optional[str]] = {
1623
+ '200': "OrganizationsOrganizationDetailResponse",
1624
+ '400': "OrganizationsOrganizationDetailResponse",
1625
+ '503': "OrganizationsOrganizationDetailResponse",
1626
+ }
1627
+ response_data = self.api_client.call_api(
1628
+ *_param,
1629
+ _request_timeout=_request_timeout
1630
+ )
1631
+ return response_data.response
1632
+
1633
+
1634
+ def _api_v1_organizations_put_serialize(
1635
+ self,
1636
+ request,
1637
+ _request_auth,
1638
+ _content_type,
1639
+ _headers,
1640
+ _host_index,
1641
+ ) -> RequestSerialized:
1642
+
1643
+ _host = None
1644
+
1645
+ _collection_formats: Dict[str, str] = {
1646
+ }
1647
+
1648
+ _path_params: Dict[str, str] = {}
1649
+ _query_params: List[Tuple[str, str]] = []
1650
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1651
+ _form_params: List[Tuple[str, str]] = []
1652
+ _files: Dict[
1653
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1654
+ ] = {}
1655
+ _body_params: Optional[bytes] = None
1656
+
1657
+ # process the path parameters
1658
+ # process the query parameters
1659
+ # process the header parameters
1660
+ # process the form parameters
1661
+ # process the body parameter
1662
+ if request is not None:
1663
+ _body_params = request
1664
+
1665
+
1666
+ # set the HTTP header `Accept`
1667
+ if 'Accept' not in _header_params:
1668
+ _header_params['Accept'] = self.api_client.select_header_accept(
1669
+ [
1670
+ 'application/json'
1671
+ ]
1672
+ )
1673
+
1674
+ # set the HTTP header `Content-Type`
1675
+ if _content_type:
1676
+ _header_params['Content-Type'] = _content_type
1677
+ else:
1678
+ _default_content_type = (
1679
+ self.api_client.select_header_content_type(
1680
+ [
1681
+ 'application/json'
1682
+ ]
1683
+ )
1684
+ )
1685
+ if _default_content_type is not None:
1686
+ _header_params['Content-Type'] = _default_content_type
1687
+
1688
+ # authentication setting
1689
+ _auth_settings: List[str] = [
1690
+ 'ApiKeyAuth'
1691
+ ]
1692
+
1693
+ return self.api_client.param_serialize(
1694
+ method='PUT',
1695
+ resource_path='/api/v1/organizations/',
1696
+ path_params=_path_params,
1697
+ query_params=_query_params,
1698
+ header_params=_header_params,
1699
+ body=_body_params,
1700
+ post_params=_form_params,
1701
+ files=_files,
1702
+ auth_settings=_auth_settings,
1703
+ collection_formats=_collection_formats,
1704
+ _host=_host,
1705
+ _request_auth=_request_auth
1706
+ )
1707
+
1708
+
1709
+
1710
+
1711
+ @validate_call
1712
+ def api_v1_organizations_workbench_post(
1713
+ self,
1714
+ request: Annotated[OrganizationsOrganizationSetWorkbenchRequest, Field(description="Body")],
1715
+ _request_timeout: Union[
1716
+ None,
1717
+ Annotated[StrictFloat, Field(gt=0)],
1718
+ Tuple[
1719
+ Annotated[StrictFloat, Field(gt=0)],
1720
+ Annotated[StrictFloat, Field(gt=0)]
1721
+ ]
1722
+ ] = None,
1723
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1724
+ _content_type: Optional[StrictStr] = None,
1725
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1726
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1727
+ ) -> OrganizationsOrganizationSetWorkbenchResponse:
1728
+ """Set Organization's Workbench Version
1729
+
1730
+ Set Organization's Workbench Version
1731
+
1732
+ :param request: Body (required)
1733
+ :type request: OrganizationsOrganizationSetWorkbenchRequest
1734
+ :param _request_timeout: timeout setting for this request. If one
1735
+ number provided, it will be total request
1736
+ timeout. It can also be a pair (tuple) of
1737
+ (connection, read) timeouts.
1738
+ :type _request_timeout: int, tuple(int, int), optional
1739
+ :param _request_auth: set to override the auth_settings for an a single
1740
+ request; this effectively ignores the
1741
+ authentication in the spec for a single request.
1742
+ :type _request_auth: dict, optional
1743
+ :param _content_type: force content-type for the request.
1744
+ :type _content_type: str, Optional
1745
+ :param _headers: set to override the headers for a single
1746
+ request; this effectively ignores the headers
1747
+ in the spec for a single request.
1748
+ :type _headers: dict, optional
1749
+ :param _host_index: set to override the host_index for a single
1750
+ request; this effectively ignores the host_index
1751
+ in the spec for a single request.
1752
+ :type _host_index: int, optional
1753
+ :return: Returns the result object.
1754
+ """ # noqa: E501
1755
+
1756
+ _param = self._api_v1_organizations_workbench_post_serialize(
1757
+ request=request,
1758
+ _request_auth=_request_auth,
1759
+ _content_type=_content_type,
1760
+ _headers=_headers,
1761
+ _host_index=_host_index
1762
+ )
1763
+
1764
+ _response_types_map: Dict[str, Optional[str]] = {
1765
+ '200': "OrganizationsOrganizationSetWorkbenchResponse",
1766
+ '400': "OrganizationsOrganizationSetWorkbenchResponse",
1767
+ '503': "OrganizationsOrganizationSetWorkbenchResponse",
1768
+ }
1769
+ response_data = self.api_client.call_api(
1770
+ *_param,
1771
+ _request_timeout=_request_timeout
1772
+ )
1773
+ response_data.read()
1774
+ return self.api_client.response_deserialize(
1775
+ response_data=response_data,
1776
+ response_types_map=_response_types_map,
1777
+ ).data
1778
+
1779
+
1780
+ @validate_call
1781
+ def api_v1_organizations_workbench_post_with_http_info(
1782
+ self,
1783
+ request: Annotated[OrganizationsOrganizationSetWorkbenchRequest, Field(description="Body")],
1784
+ _request_timeout: Union[
1785
+ None,
1786
+ Annotated[StrictFloat, Field(gt=0)],
1787
+ Tuple[
1788
+ Annotated[StrictFloat, Field(gt=0)],
1789
+ Annotated[StrictFloat, Field(gt=0)]
1790
+ ]
1791
+ ] = None,
1792
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1793
+ _content_type: Optional[StrictStr] = None,
1794
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1795
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1796
+ ) -> ApiResponse[OrganizationsOrganizationSetWorkbenchResponse]:
1797
+ """Set Organization's Workbench Version
1798
+
1799
+ Set Organization's Workbench Version
1800
+
1801
+ :param request: Body (required)
1802
+ :type request: OrganizationsOrganizationSetWorkbenchRequest
1803
+ :param _request_timeout: timeout setting for this request. If one
1804
+ number provided, it will be total request
1805
+ timeout. It can also be a pair (tuple) of
1806
+ (connection, read) timeouts.
1807
+ :type _request_timeout: int, tuple(int, int), optional
1808
+ :param _request_auth: set to override the auth_settings for an a single
1809
+ request; this effectively ignores the
1810
+ authentication in the spec for a single request.
1811
+ :type _request_auth: dict, optional
1812
+ :param _content_type: force content-type for the request.
1813
+ :type _content_type: str, Optional
1814
+ :param _headers: set to override the headers for a single
1815
+ request; this effectively ignores the headers
1816
+ in the spec for a single request.
1817
+ :type _headers: dict, optional
1818
+ :param _host_index: set to override the host_index for a single
1819
+ request; this effectively ignores the host_index
1820
+ in the spec for a single request.
1821
+ :type _host_index: int, optional
1822
+ :return: Returns the result object.
1823
+ """ # noqa: E501
1824
+
1825
+ _param = self._api_v1_organizations_workbench_post_serialize(
1826
+ request=request,
1827
+ _request_auth=_request_auth,
1828
+ _content_type=_content_type,
1829
+ _headers=_headers,
1830
+ _host_index=_host_index
1831
+ )
1832
+
1833
+ _response_types_map: Dict[str, Optional[str]] = {
1834
+ '200': "OrganizationsOrganizationSetWorkbenchResponse",
1835
+ '400': "OrganizationsOrganizationSetWorkbenchResponse",
1836
+ '503': "OrganizationsOrganizationSetWorkbenchResponse",
1837
+ }
1838
+ response_data = self.api_client.call_api(
1839
+ *_param,
1840
+ _request_timeout=_request_timeout
1841
+ )
1842
+ response_data.read()
1843
+ return self.api_client.response_deserialize(
1844
+ response_data=response_data,
1845
+ response_types_map=_response_types_map,
1846
+ )
1847
+
1848
+
1849
+ @validate_call
1850
+ def api_v1_organizations_workbench_post_without_preload_content(
1851
+ self,
1852
+ request: Annotated[OrganizationsOrganizationSetWorkbenchRequest, Field(description="Body")],
1853
+ _request_timeout: Union[
1854
+ None,
1855
+ Annotated[StrictFloat, Field(gt=0)],
1856
+ Tuple[
1857
+ Annotated[StrictFloat, Field(gt=0)],
1858
+ Annotated[StrictFloat, Field(gt=0)]
1859
+ ]
1860
+ ] = None,
1861
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1862
+ _content_type: Optional[StrictStr] = None,
1863
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1864
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1865
+ ) -> RESTResponseType:
1866
+ """Set Organization's Workbench Version
1867
+
1868
+ Set Organization's Workbench Version
1869
+
1870
+ :param request: Body (required)
1871
+ :type request: OrganizationsOrganizationSetWorkbenchRequest
1872
+ :param _request_timeout: timeout setting for this request. If one
1873
+ number provided, it will be total request
1874
+ timeout. It can also be a pair (tuple) of
1875
+ (connection, read) timeouts.
1876
+ :type _request_timeout: int, tuple(int, int), optional
1877
+ :param _request_auth: set to override the auth_settings for an a single
1878
+ request; this effectively ignores the
1879
+ authentication in the spec for a single request.
1880
+ :type _request_auth: dict, optional
1881
+ :param _content_type: force content-type for the request.
1882
+ :type _content_type: str, Optional
1883
+ :param _headers: set to override the headers for a single
1884
+ request; this effectively ignores the headers
1885
+ in the spec for a single request.
1886
+ :type _headers: dict, optional
1887
+ :param _host_index: set to override the host_index for a single
1888
+ request; this effectively ignores the host_index
1889
+ in the spec for a single request.
1890
+ :type _host_index: int, optional
1891
+ :return: Returns the result object.
1892
+ """ # noqa: E501
1893
+
1894
+ _param = self._api_v1_organizations_workbench_post_serialize(
1895
+ request=request,
1896
+ _request_auth=_request_auth,
1897
+ _content_type=_content_type,
1898
+ _headers=_headers,
1899
+ _host_index=_host_index
1900
+ )
1901
+
1902
+ _response_types_map: Dict[str, Optional[str]] = {
1903
+ '200': "OrganizationsOrganizationSetWorkbenchResponse",
1904
+ '400': "OrganizationsOrganizationSetWorkbenchResponse",
1905
+ '503': "OrganizationsOrganizationSetWorkbenchResponse",
1906
+ }
1907
+ response_data = self.api_client.call_api(
1908
+ *_param,
1909
+ _request_timeout=_request_timeout
1910
+ )
1911
+ return response_data.response
1912
+
1913
+
1914
+ def _api_v1_organizations_workbench_post_serialize(
1915
+ self,
1916
+ request,
1917
+ _request_auth,
1918
+ _content_type,
1919
+ _headers,
1920
+ _host_index,
1921
+ ) -> RequestSerialized:
1922
+
1923
+ _host = None
1924
+
1925
+ _collection_formats: Dict[str, str] = {
1926
+ }
1927
+
1928
+ _path_params: Dict[str, str] = {}
1929
+ _query_params: List[Tuple[str, str]] = []
1930
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1931
+ _form_params: List[Tuple[str, str]] = []
1932
+ _files: Dict[
1933
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1934
+ ] = {}
1935
+ _body_params: Optional[bytes] = None
1936
+
1937
+ # process the path parameters
1938
+ # process the query parameters
1939
+ # process the header parameters
1940
+ # process the form parameters
1941
+ # process the body parameter
1942
+ if request is not None:
1943
+ _body_params = request
1944
+
1945
+
1946
+ # set the HTTP header `Accept`
1947
+ if 'Accept' not in _header_params:
1948
+ _header_params['Accept'] = self.api_client.select_header_accept(
1949
+ [
1950
+ 'application/json'
1951
+ ]
1952
+ )
1953
+
1954
+
1955
+ # authentication setting
1956
+ _auth_settings: List[str] = [
1957
+ 'ApiKeyAuth'
1958
+ ]
1959
+
1960
+ return self.api_client.param_serialize(
1961
+ method='POST',
1962
+ resource_path='/api/v1/organizations/workbench/',
1963
+ path_params=_path_params,
1964
+ query_params=_query_params,
1965
+ header_params=_header_params,
1966
+ body=_body_params,
1967
+ post_params=_form_params,
1968
+ files=_files,
1969
+ auth_settings=_auth_settings,
1970
+ collection_formats=_collection_formats,
1971
+ _host=_host,
1972
+ _request_auth=_request_auth
1973
+ )
1974
+
1975
+