qanswer_sdk 3.1212.0__py3-none-any.whl → 3.1244.0__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 (140) hide show
  1. qanswer_sdk/__init__.py +66 -43
  2. qanswer_sdk/api/__init__.py +7 -4
  3. qanswer_sdk/api/admin_api.py +590 -7695
  4. qanswer_sdk/api/ai_assistant_access_rights_api.py +72 -73
  5. qanswer_sdk/api/ai_assistant_api.py +567 -46
  6. qanswer_sdk/api/branding_api.py +4578 -0
  7. qanswer_sdk/api/chatbot_api.py +72 -87
  8. qanswer_sdk/api/{tag_api.py → connector_imap_connector_api.py} +415 -997
  9. qanswer_sdk/api/connector_rdf_api.py +30 -31
  10. qanswer_sdk/api/connectors_api.py +183 -166
  11. qanswer_sdk/api/connectors_data_api.py +345 -1
  12. qanswer_sdk/api/dataset_config_api.py +0 -245
  13. qanswer_sdk/api/llm_api.py +30 -30
  14. qanswer_sdk/api/payment_api.py +17 -16
  15. qanswer_sdk/api/speech_to_text_api.py +2 -2
  16. qanswer_sdk/api/task_chat_api.py +8 -7
  17. qanswer_sdk/api/task_rdf_linker_api.py +35 -36
  18. qanswer_sdk/api/task_rdf_sparql_endpoint_api.py +16 -16
  19. qanswer_sdk/api/task_report_copilot_api.py +895 -281
  20. qanswer_sdk/api/task_search_api.py +8 -7
  21. qanswer_sdk/api/tool_embedder_api.py +4040 -0
  22. qanswer_sdk/api/{user_api.py → tool_llm_api.py} +735 -2749
  23. qanswer_sdk/api/unit_organizations_api.py +4547 -0
  24. qanswer_sdk/api/unit_teams_api.py +3906 -0
  25. qanswer_sdk/api/{organizations_teams_api.py → unit_user_api.py} +1345 -1394
  26. qanswer_sdk/api_client.py +1 -1
  27. qanswer_sdk/configuration.py +1 -1
  28. qanswer_sdk/models/__init__.py +58 -38
  29. qanswer_sdk/models/aggregation.py +2 -2
  30. qanswer_sdk/models/ai_assistant_filter_dto.py +105 -0
  31. qanswer_sdk/models/{user_profile_paginated.py → ai_assistant_list.py} +18 -18
  32. qanswer_sdk/models/{embedding_model.py → available_aggregation.py} +13 -11
  33. qanswer_sdk/models/available_connectors_response.py +2 -2
  34. qanswer_sdk/models/{branding_data.py → branding_app_title.py} +4 -4
  35. qanswer_sdk/models/{api_response.py → branding_system_message.py} +8 -8
  36. qanswer_sdk/models/chat_task_settings.py +12 -12
  37. qanswer_sdk/models/chat_task_update.py +13 -5
  38. qanswer_sdk/models/chatbot_chat_payload.py +19 -2
  39. qanswer_sdk/models/chatbot_conversation_model.py +10 -0
  40. qanswer_sdk/models/chatbot_response.py +22 -2
  41. qanswer_sdk/models/{user_chatbot_setting_payload.py → chatbot_setting_dto.py} +12 -13
  42. qanswer_sdk/models/chatbot_setting_request.py +96 -0
  43. qanswer_sdk/models/{question_completion.py → clip_connector_file_structure.py} +9 -9
  44. qanswer_sdk/models/clip_connector_structure.py +97 -0
  45. qanswer_sdk/models/connector_model.py +2 -2
  46. qanswer_sdk/models/conversation_message.py +4 -12
  47. qanswer_sdk/models/{cost_summary.py → cost_summary_dto.py} +4 -4
  48. qanswer_sdk/models/create_connector_request.py +4 -2
  49. qanswer_sdk/models/create_imap_connector_request.py +105 -0
  50. qanswer_sdk/models/create_pinecone_connector_request.py +3 -1
  51. qanswer_sdk/models/create_sharepoint_connector_from_certificate_request.py +3 -1
  52. qanswer_sdk/models/create_sharepoint_connector_request.py +3 -1
  53. qanswer_sdk/models/dataset_detail_kg.py +27 -1
  54. qanswer_sdk/models/dataset_schema.py +4 -2
  55. qanswer_sdk/models/dataset_update_object.py +3 -1
  56. qanswer_sdk/models/delete_connector_model.py +2 -2
  57. qanswer_sdk/models/delete_connectors_response.py +2 -4
  58. qanswer_sdk/models/{json_nullable_source_metadata.py → duplicate_report_template_response.py} +11 -9
  59. qanswer_sdk/models/{json_nullable_file_failure_reason.py → email_folder.py} +12 -8
  60. qanswer_sdk/models/{embedding_endpoint.py → embedder_detailed_dto.py} +16 -8
  61. qanswer_sdk/models/{tag_payload.py → embedder_dto.py} +11 -7
  62. qanswer_sdk/models/{pageable_object.py → embedder_list_dto.py} +20 -20
  63. qanswer_sdk/models/embedding_endpoint_create.py +3 -1
  64. qanswer_sdk/models/embedding_endpoint_update.py +4 -2
  65. qanswer_sdk/models/{sort_object.py → entity_description.py} +16 -12
  66. qanswer_sdk/models/{dataset_description.py → entity_description_dto.py} +9 -7
  67. qanswer_sdk/models/file_model.py +2 -2
  68. qanswer_sdk/models/imap_add_payload.py +103 -0
  69. qanswer_sdk/models/imap_additional_fields.py +101 -0
  70. qanswer_sdk/models/imap_file_metadata.py +114 -0
  71. qanswer_sdk/models/imap_search_response.py +113 -0
  72. qanswer_sdk/models/llm.py +129 -0
  73. qanswer_sdk/models/llm_consumption.py +118 -0
  74. qanswer_sdk/models/{pageable.py → llm_context_ranges.py} +14 -13
  75. qanswer_sdk/models/{llm_cost.py → llm_cost_filter.py} +11 -7
  76. qanswer_sdk/models/llm_cost_list.py +101 -0
  77. qanswer_sdk/models/llm_detailed_dto.py +179 -0
  78. qanswer_sdk/models/{llm_details.py → llm_dto.py} +14 -18
  79. qanswer_sdk/models/llm_endpoint.py +8 -2
  80. qanswer_sdk/models/llm_endpoint_read_input.py +173 -0
  81. qanswer_sdk/models/llm_endpoint_read_output.py +173 -0
  82. qanswer_sdk/models/llm_filter_dto.py +99 -0
  83. qanswer_sdk/models/llm_list_detailed_dto.py +101 -0
  84. qanswer_sdk/models/llm_list_dto.py +101 -0
  85. qanswer_sdk/models/modify_connector_request.py +5 -11
  86. qanswer_sdk/models/{o_auth_service.py → o_auth_service_dto.py} +4 -4
  87. qanswer_sdk/models/organization_admin.py +95 -0
  88. qanswer_sdk/models/organization_filter_dto.py +97 -0
  89. qanswer_sdk/models/organization_list_dto.py +101 -0
  90. qanswer_sdk/models/organization_llm.py +103 -0
  91. qanswer_sdk/models/{plan.py → plan_dto.py} +4 -4
  92. qanswer_sdk/models/prompt_token_count_details.py +3 -3
  93. qanswer_sdk/models/rag_payload.py +4 -4
  94. qanswer_sdk/models/rag_response.py +4 -2
  95. qanswer_sdk/models/relation_extraction_task_settings.py +12 -10
  96. qanswer_sdk/models/relation_extraction_task_update.py +14 -4
  97. qanswer_sdk/models/report_copilot_slot_task_settings.py +12 -10
  98. qanswer_sdk/models/report_copilot_slot_task_update.py +13 -3
  99. qanswer_sdk/models/report_copilot_task_settings.py +12 -10
  100. qanswer_sdk/models/report_copilot_task_update.py +14 -4
  101. qanswer_sdk/models/{report_copilot_template.py → report_template.py} +17 -7
  102. qanswer_sdk/models/{report_copilot_create_payload.py → report_template_create_payload.py} +4 -4
  103. qanswer_sdk/models/{report_copilot_template_simplified.py → report_template_simplified.py} +11 -7
  104. qanswer_sdk/models/{report_copilot_export_template_as_docx_payload_simplified.py → report_template_simplified_payload.py} +4 -4
  105. qanswer_sdk/models/{report_copilot_update_payload.py → report_template_update_payload.py} +15 -9
  106. qanswer_sdk/models/search_task_settings.py +12 -12
  107. qanswer_sdk/models/search_task_update.py +13 -3
  108. qanswer_sdk/models/{set_logo1_request.py → set_logo2_request.py} +4 -4
  109. qanswer_sdk/models/shared_organization_access.py +7 -3
  110. qanswer_sdk/models/shared_team_access.py +10 -4
  111. qanswer_sdk/models/slot.py +5 -1
  112. qanswer_sdk/models/slot_update.py +5 -1
  113. qanswer_sdk/models/socket_conversation_message.py +3 -11
  114. qanswer_sdk/models/socket_file_metadata.py +17 -11
  115. qanswer_sdk/models/source_metadata.py +109 -0
  116. qanswer_sdk/models/{tag_qa_list_payload.py → subscription_response.py} +22 -21
  117. qanswer_sdk/models/{team_with_count.py → team_admin.py} +8 -8
  118. qanswer_sdk/models/{team_filter.py → team_filter_dto.py} +16 -6
  119. qanswer_sdk/models/team_list_dto.py +101 -0
  120. qanswer_sdk/models/{available_endpoints_response.py → template_clip_structure_input.py} +14 -14
  121. qanswer_sdk/models/{available_embedding_models_response.py → template_clip_structure_output.py} +14 -14
  122. qanswer_sdk/models/test_imap_connection_payload.py +95 -0
  123. qanswer_sdk/models/text2_sparql_payload.py +4 -4
  124. qanswer_sdk/models/text2_sparql_task_settings.py +12 -10
  125. qanswer_sdk/models/text2_sparql_task_update.py +14 -4
  126. qanswer_sdk/models/{user_chatbot_setting_response.py → user_chatbot_setting.py} +24 -24
  127. qanswer_sdk/models/user_dataset.py +38 -2
  128. qanswer_sdk/models/{qa_metadata_payload.py → user_dataset_shared.py} +27 -37
  129. qanswer_sdk/models/{user_filter.py → user_filter_dto.py} +4 -4
  130. qanswer_sdk/models/{user_profile.py → user_profile_dto.py} +10 -10
  131. qanswer_sdk/models/user_profile_list_dto.py +3 -3
  132. qanswer_sdk/models/widget_configs.py +4 -2
  133. {qanswer_sdk-3.1212.0.dist-info → qanswer_sdk-3.1244.0.dist-info}/METADATA +2 -2
  134. {qanswer_sdk-3.1212.0.dist-info → qanswer_sdk-3.1244.0.dist-info}/RECORD +135 -112
  135. qanswer_sdk/api/llm_consumption_controller_api.py +0 -310
  136. qanswer_sdk/models/organization_filter.py +0 -87
  137. qanswer_sdk/models/page_organization.py +0 -123
  138. qanswer_sdk/models/page_team_with_count.py +0 -123
  139. qanswer_sdk/models/tag_qa_payload.py +0 -91
  140. {qanswer_sdk-3.1212.0.dist-info → qanswer_sdk-3.1244.0.dist-info}/WHEEL +0 -0
@@ -0,0 +1,4578 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ QAnswer: Api Documentation
5
+
6
+ APIs provided by QAnswer
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 StrictBytes, StrictInt, StrictStr
20
+ from typing import Optional, Tuple, Union
21
+ from qanswer_sdk.models.branding_app_title import BrandingAppTitle
22
+ from qanswer_sdk.models.branding_system_message import BrandingSystemMessage
23
+ from qanswer_sdk.models.entity_description_dto import EntityDescriptionDto
24
+
25
+ from qanswer_sdk.api_client import ApiClient, RequestSerialized
26
+ from qanswer_sdk.api_response import ApiResponse
27
+ from qanswer_sdk.rest import RESTResponseType
28
+
29
+
30
+ class BrandingApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ def get_app_title(
45
+ self,
46
+ organization_id: Optional[StrictInt] = None,
47
+ _request_timeout: Union[
48
+ None,
49
+ Annotated[StrictFloat, Field(gt=0)],
50
+ Tuple[
51
+ Annotated[StrictFloat, Field(gt=0)],
52
+ Annotated[StrictFloat, Field(gt=0)]
53
+ ]
54
+ ] = None,
55
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
56
+ _content_type: Optional[StrictStr] = None,
57
+ _headers: Optional[Dict[StrictStr, Any]] = None,
58
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
59
+ ) -> BrandingAppTitle:
60
+ """Retrieves the app title
61
+
62
+
63
+ :param organization_id:
64
+ :type organization_id: int
65
+ :param _request_timeout: timeout setting for this request. If one
66
+ number provided, it will be total request
67
+ timeout. It can also be a pair (tuple) of
68
+ (connection, read) timeouts.
69
+ :type _request_timeout: int, tuple(int, int), optional
70
+ :param _request_auth: set to override the auth_settings for an a single
71
+ request; this effectively ignores the
72
+ authentication in the spec for a single request.
73
+ :type _request_auth: dict, optional
74
+ :param _content_type: force content-type for the request.
75
+ :type _content_type: str, Optional
76
+ :param _headers: set to override the headers for a single
77
+ request; this effectively ignores the headers
78
+ in the spec for a single request.
79
+ :type _headers: dict, optional
80
+ :param _host_index: set to override the host_index for a single
81
+ request; this effectively ignores the host_index
82
+ in the spec for a single request.
83
+ :type _host_index: int, optional
84
+ :return: Returns the result object.
85
+ """ # noqa: E501
86
+
87
+ _param = self._get_app_title_serialize(
88
+ organization_id=organization_id,
89
+ _request_auth=_request_auth,
90
+ _content_type=_content_type,
91
+ _headers=_headers,
92
+ _host_index=_host_index
93
+ )
94
+
95
+ _response_types_map: Dict[str, Optional[str]] = {
96
+ '200': "BrandingAppTitle",
97
+ }
98
+ response_data = self.api_client.call_api(
99
+ *_param,
100
+ _request_timeout=_request_timeout
101
+ )
102
+ response_data.read()
103
+ return self.api_client.response_deserialize(
104
+ response_data=response_data,
105
+ response_types_map=_response_types_map,
106
+ ).data
107
+
108
+
109
+ @validate_call
110
+ def get_app_title_with_http_info(
111
+ self,
112
+ organization_id: Optional[StrictInt] = None,
113
+ _request_timeout: Union[
114
+ None,
115
+ Annotated[StrictFloat, Field(gt=0)],
116
+ Tuple[
117
+ Annotated[StrictFloat, Field(gt=0)],
118
+ Annotated[StrictFloat, Field(gt=0)]
119
+ ]
120
+ ] = None,
121
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
122
+ _content_type: Optional[StrictStr] = None,
123
+ _headers: Optional[Dict[StrictStr, Any]] = None,
124
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
125
+ ) -> ApiResponse[BrandingAppTitle]:
126
+ """Retrieves the app title
127
+
128
+
129
+ :param organization_id:
130
+ :type organization_id: int
131
+ :param _request_timeout: timeout setting for this request. If one
132
+ number provided, it will be total request
133
+ timeout. It can also be a pair (tuple) of
134
+ (connection, read) timeouts.
135
+ :type _request_timeout: int, tuple(int, int), optional
136
+ :param _request_auth: set to override the auth_settings for an a single
137
+ request; this effectively ignores the
138
+ authentication in the spec for a single request.
139
+ :type _request_auth: dict, optional
140
+ :param _content_type: force content-type for the request.
141
+ :type _content_type: str, Optional
142
+ :param _headers: set to override the headers for a single
143
+ request; this effectively ignores the headers
144
+ in the spec for a single request.
145
+ :type _headers: dict, optional
146
+ :param _host_index: set to override the host_index for a single
147
+ request; this effectively ignores the host_index
148
+ in the spec for a single request.
149
+ :type _host_index: int, optional
150
+ :return: Returns the result object.
151
+ """ # noqa: E501
152
+
153
+ _param = self._get_app_title_serialize(
154
+ organization_id=organization_id,
155
+ _request_auth=_request_auth,
156
+ _content_type=_content_type,
157
+ _headers=_headers,
158
+ _host_index=_host_index
159
+ )
160
+
161
+ _response_types_map: Dict[str, Optional[str]] = {
162
+ '200': "BrandingAppTitle",
163
+ }
164
+ response_data = self.api_client.call_api(
165
+ *_param,
166
+ _request_timeout=_request_timeout
167
+ )
168
+ response_data.read()
169
+ return self.api_client.response_deserialize(
170
+ response_data=response_data,
171
+ response_types_map=_response_types_map,
172
+ )
173
+
174
+
175
+ @validate_call
176
+ def get_app_title_without_preload_content(
177
+ self,
178
+ organization_id: Optional[StrictInt] = None,
179
+ _request_timeout: Union[
180
+ None,
181
+ Annotated[StrictFloat, Field(gt=0)],
182
+ Tuple[
183
+ Annotated[StrictFloat, Field(gt=0)],
184
+ Annotated[StrictFloat, Field(gt=0)]
185
+ ]
186
+ ] = None,
187
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
188
+ _content_type: Optional[StrictStr] = None,
189
+ _headers: Optional[Dict[StrictStr, Any]] = None,
190
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
191
+ ) -> RESTResponseType:
192
+ """Retrieves the app title
193
+
194
+
195
+ :param organization_id:
196
+ :type organization_id: int
197
+ :param _request_timeout: timeout setting for this request. If one
198
+ number provided, it will be total request
199
+ timeout. It can also be a pair (tuple) of
200
+ (connection, read) timeouts.
201
+ :type _request_timeout: int, tuple(int, int), optional
202
+ :param _request_auth: set to override the auth_settings for an a single
203
+ request; this effectively ignores the
204
+ authentication in the spec for a single request.
205
+ :type _request_auth: dict, optional
206
+ :param _content_type: force content-type for the request.
207
+ :type _content_type: str, Optional
208
+ :param _headers: set to override the headers for a single
209
+ request; this effectively ignores the headers
210
+ in the spec for a single request.
211
+ :type _headers: dict, optional
212
+ :param _host_index: set to override the host_index for a single
213
+ request; this effectively ignores the host_index
214
+ in the spec for a single request.
215
+ :type _host_index: int, optional
216
+ :return: Returns the result object.
217
+ """ # noqa: E501
218
+
219
+ _param = self._get_app_title_serialize(
220
+ organization_id=organization_id,
221
+ _request_auth=_request_auth,
222
+ _content_type=_content_type,
223
+ _headers=_headers,
224
+ _host_index=_host_index
225
+ )
226
+
227
+ _response_types_map: Dict[str, Optional[str]] = {
228
+ '200': "BrandingAppTitle",
229
+ }
230
+ response_data = self.api_client.call_api(
231
+ *_param,
232
+ _request_timeout=_request_timeout
233
+ )
234
+ return response_data.response
235
+
236
+
237
+ def _get_app_title_serialize(
238
+ self,
239
+ organization_id,
240
+ _request_auth,
241
+ _content_type,
242
+ _headers,
243
+ _host_index,
244
+ ) -> RequestSerialized:
245
+
246
+ _host = None
247
+
248
+ _collection_formats: Dict[str, str] = {
249
+ }
250
+
251
+ _path_params: Dict[str, str] = {}
252
+ _query_params: List[Tuple[str, str]] = []
253
+ _header_params: Dict[str, Optional[str]] = _headers or {}
254
+ _form_params: List[Tuple[str, str]] = []
255
+ _files: Dict[
256
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
257
+ ] = {}
258
+ _body_params: Optional[bytes] = None
259
+
260
+ # process the path parameters
261
+ # process the query parameters
262
+ if organization_id is not None:
263
+
264
+ _query_params.append(('organization_id', organization_id))
265
+
266
+ # process the header parameters
267
+ # process the form parameters
268
+ # process the body parameter
269
+
270
+
271
+ # set the HTTP header `Accept`
272
+ if 'Accept' not in _header_params:
273
+ _header_params['Accept'] = self.api_client.select_header_accept(
274
+ [
275
+ '*/*'
276
+ ]
277
+ )
278
+
279
+
280
+ # authentication setting
281
+ _auth_settings: List[str] = [
282
+ 'QAnswer-Api-Key',
283
+ 'Bearer'
284
+ ]
285
+
286
+ return self.api_client.param_serialize(
287
+ method='GET',
288
+ resource_path='/api/branding/app-title',
289
+ path_params=_path_params,
290
+ query_params=_query_params,
291
+ header_params=_header_params,
292
+ body=_body_params,
293
+ post_params=_form_params,
294
+ files=_files,
295
+ auth_settings=_auth_settings,
296
+ collection_formats=_collection_formats,
297
+ _host=_host,
298
+ _request_auth=_request_auth
299
+ )
300
+
301
+
302
+
303
+
304
+ @validate_call
305
+ def get_entity_description(
306
+ self,
307
+ organization_id: Optional[StrictInt] = None,
308
+ _request_timeout: Union[
309
+ None,
310
+ Annotated[StrictFloat, Field(gt=0)],
311
+ Tuple[
312
+ Annotated[StrictFloat, Field(gt=0)],
313
+ Annotated[StrictFloat, Field(gt=0)]
314
+ ]
315
+ ] = None,
316
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
317
+ _content_type: Optional[StrictStr] = None,
318
+ _headers: Optional[Dict[StrictStr, Any]] = None,
319
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
320
+ ) -> EntityDescriptionDto:
321
+ """Get the entity description accross the application
322
+
323
+
324
+ :param organization_id:
325
+ :type organization_id: int
326
+ :param _request_timeout: timeout setting for this request. If one
327
+ number provided, it will be total request
328
+ timeout. It can also be a pair (tuple) of
329
+ (connection, read) timeouts.
330
+ :type _request_timeout: int, tuple(int, int), optional
331
+ :param _request_auth: set to override the auth_settings for an a single
332
+ request; this effectively ignores the
333
+ authentication in the spec for a single request.
334
+ :type _request_auth: dict, optional
335
+ :param _content_type: force content-type for the request.
336
+ :type _content_type: str, Optional
337
+ :param _headers: set to override the headers for a single
338
+ request; this effectively ignores the headers
339
+ in the spec for a single request.
340
+ :type _headers: dict, optional
341
+ :param _host_index: set to override the host_index for a single
342
+ request; this effectively ignores the host_index
343
+ in the spec for a single request.
344
+ :type _host_index: int, optional
345
+ :return: Returns the result object.
346
+ """ # noqa: E501
347
+
348
+ _param = self._get_entity_description_serialize(
349
+ organization_id=organization_id,
350
+ _request_auth=_request_auth,
351
+ _content_type=_content_type,
352
+ _headers=_headers,
353
+ _host_index=_host_index
354
+ )
355
+
356
+ _response_types_map: Dict[str, Optional[str]] = {
357
+ '200': "EntityDescriptionDto",
358
+ }
359
+ response_data = self.api_client.call_api(
360
+ *_param,
361
+ _request_timeout=_request_timeout
362
+ )
363
+ response_data.read()
364
+ return self.api_client.response_deserialize(
365
+ response_data=response_data,
366
+ response_types_map=_response_types_map,
367
+ ).data
368
+
369
+
370
+ @validate_call
371
+ def get_entity_description_with_http_info(
372
+ self,
373
+ organization_id: Optional[StrictInt] = None,
374
+ _request_timeout: Union[
375
+ None,
376
+ Annotated[StrictFloat, Field(gt=0)],
377
+ Tuple[
378
+ Annotated[StrictFloat, Field(gt=0)],
379
+ Annotated[StrictFloat, Field(gt=0)]
380
+ ]
381
+ ] = None,
382
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
383
+ _content_type: Optional[StrictStr] = None,
384
+ _headers: Optional[Dict[StrictStr, Any]] = None,
385
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
386
+ ) -> ApiResponse[EntityDescriptionDto]:
387
+ """Get the entity description accross the application
388
+
389
+
390
+ :param organization_id:
391
+ :type organization_id: int
392
+ :param _request_timeout: timeout setting for this request. If one
393
+ number provided, it will be total request
394
+ timeout. It can also be a pair (tuple) of
395
+ (connection, read) timeouts.
396
+ :type _request_timeout: int, tuple(int, int), optional
397
+ :param _request_auth: set to override the auth_settings for an a single
398
+ request; this effectively ignores the
399
+ authentication in the spec for a single request.
400
+ :type _request_auth: dict, optional
401
+ :param _content_type: force content-type for the request.
402
+ :type _content_type: str, Optional
403
+ :param _headers: set to override the headers for a single
404
+ request; this effectively ignores the headers
405
+ in the spec for a single request.
406
+ :type _headers: dict, optional
407
+ :param _host_index: set to override the host_index for a single
408
+ request; this effectively ignores the host_index
409
+ in the spec for a single request.
410
+ :type _host_index: int, optional
411
+ :return: Returns the result object.
412
+ """ # noqa: E501
413
+
414
+ _param = self._get_entity_description_serialize(
415
+ organization_id=organization_id,
416
+ _request_auth=_request_auth,
417
+ _content_type=_content_type,
418
+ _headers=_headers,
419
+ _host_index=_host_index
420
+ )
421
+
422
+ _response_types_map: Dict[str, Optional[str]] = {
423
+ '200': "EntityDescriptionDto",
424
+ }
425
+ response_data = self.api_client.call_api(
426
+ *_param,
427
+ _request_timeout=_request_timeout
428
+ )
429
+ response_data.read()
430
+ return self.api_client.response_deserialize(
431
+ response_data=response_data,
432
+ response_types_map=_response_types_map,
433
+ )
434
+
435
+
436
+ @validate_call
437
+ def get_entity_description_without_preload_content(
438
+ self,
439
+ organization_id: Optional[StrictInt] = None,
440
+ _request_timeout: Union[
441
+ None,
442
+ Annotated[StrictFloat, Field(gt=0)],
443
+ Tuple[
444
+ Annotated[StrictFloat, Field(gt=0)],
445
+ Annotated[StrictFloat, Field(gt=0)]
446
+ ]
447
+ ] = None,
448
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
449
+ _content_type: Optional[StrictStr] = None,
450
+ _headers: Optional[Dict[StrictStr, Any]] = None,
451
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
452
+ ) -> RESTResponseType:
453
+ """Get the entity description accross the application
454
+
455
+
456
+ :param organization_id:
457
+ :type organization_id: int
458
+ :param _request_timeout: timeout setting for this request. If one
459
+ number provided, it will be total request
460
+ timeout. It can also be a pair (tuple) of
461
+ (connection, read) timeouts.
462
+ :type _request_timeout: int, tuple(int, int), optional
463
+ :param _request_auth: set to override the auth_settings for an a single
464
+ request; this effectively ignores the
465
+ authentication in the spec for a single request.
466
+ :type _request_auth: dict, optional
467
+ :param _content_type: force content-type for the request.
468
+ :type _content_type: str, Optional
469
+ :param _headers: set to override the headers for a single
470
+ request; this effectively ignores the headers
471
+ in the spec for a single request.
472
+ :type _headers: dict, optional
473
+ :param _host_index: set to override the host_index for a single
474
+ request; this effectively ignores the host_index
475
+ in the spec for a single request.
476
+ :type _host_index: int, optional
477
+ :return: Returns the result object.
478
+ """ # noqa: E501
479
+
480
+ _param = self._get_entity_description_serialize(
481
+ organization_id=organization_id,
482
+ _request_auth=_request_auth,
483
+ _content_type=_content_type,
484
+ _headers=_headers,
485
+ _host_index=_host_index
486
+ )
487
+
488
+ _response_types_map: Dict[str, Optional[str]] = {
489
+ '200': "EntityDescriptionDto",
490
+ }
491
+ response_data = self.api_client.call_api(
492
+ *_param,
493
+ _request_timeout=_request_timeout
494
+ )
495
+ return response_data.response
496
+
497
+
498
+ def _get_entity_description_serialize(
499
+ self,
500
+ organization_id,
501
+ _request_auth,
502
+ _content_type,
503
+ _headers,
504
+ _host_index,
505
+ ) -> RequestSerialized:
506
+
507
+ _host = None
508
+
509
+ _collection_formats: Dict[str, str] = {
510
+ }
511
+
512
+ _path_params: Dict[str, str] = {}
513
+ _query_params: List[Tuple[str, str]] = []
514
+ _header_params: Dict[str, Optional[str]] = _headers or {}
515
+ _form_params: List[Tuple[str, str]] = []
516
+ _files: Dict[
517
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
518
+ ] = {}
519
+ _body_params: Optional[bytes] = None
520
+
521
+ # process the path parameters
522
+ # process the query parameters
523
+ if organization_id is not None:
524
+
525
+ _query_params.append(('organization_id', organization_id))
526
+
527
+ # process the header parameters
528
+ # process the form parameters
529
+ # process the body parameter
530
+
531
+
532
+ # set the HTTP header `Accept`
533
+ if 'Accept' not in _header_params:
534
+ _header_params['Accept'] = self.api_client.select_header_accept(
535
+ [
536
+ '*/*'
537
+ ]
538
+ )
539
+
540
+
541
+ # authentication setting
542
+ _auth_settings: List[str] = [
543
+ 'QAnswer-Api-Key',
544
+ 'Bearer'
545
+ ]
546
+
547
+ return self.api_client.param_serialize(
548
+ method='GET',
549
+ resource_path='/api/branding/description',
550
+ path_params=_path_params,
551
+ query_params=_query_params,
552
+ header_params=_header_params,
553
+ body=_body_params,
554
+ post_params=_form_params,
555
+ files=_files,
556
+ auth_settings=_auth_settings,
557
+ collection_formats=_collection_formats,
558
+ _host=_host,
559
+ _request_auth=_request_auth
560
+ )
561
+
562
+
563
+
564
+
565
+ @validate_call
566
+ def get_favicon(
567
+ self,
568
+ organization_id: Optional[StrictInt] = None,
569
+ _request_timeout: Union[
570
+ None,
571
+ Annotated[StrictFloat, Field(gt=0)],
572
+ Tuple[
573
+ Annotated[StrictFloat, Field(gt=0)],
574
+ Annotated[StrictFloat, Field(gt=0)]
575
+ ]
576
+ ] = None,
577
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
578
+ _content_type: Optional[StrictStr] = None,
579
+ _headers: Optional[Dict[StrictStr, Any]] = None,
580
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
581
+ ) -> bytearray:
582
+ """Returns the favicon that should be used.
583
+
584
+
585
+ :param organization_id:
586
+ :type organization_id: int
587
+ :param _request_timeout: timeout setting for this request. If one
588
+ number provided, it will be total request
589
+ timeout. It can also be a pair (tuple) of
590
+ (connection, read) timeouts.
591
+ :type _request_timeout: int, tuple(int, int), optional
592
+ :param _request_auth: set to override the auth_settings for an a single
593
+ request; this effectively ignores the
594
+ authentication in the spec for a single request.
595
+ :type _request_auth: dict, optional
596
+ :param _content_type: force content-type for the request.
597
+ :type _content_type: str, Optional
598
+ :param _headers: set to override the headers for a single
599
+ request; this effectively ignores the headers
600
+ in the spec for a single request.
601
+ :type _headers: dict, optional
602
+ :param _host_index: set to override the host_index for a single
603
+ request; this effectively ignores the host_index
604
+ in the spec for a single request.
605
+ :type _host_index: int, optional
606
+ :return: Returns the result object.
607
+ """ # noqa: E501
608
+
609
+ _param = self._get_favicon_serialize(
610
+ organization_id=organization_id,
611
+ _request_auth=_request_auth,
612
+ _content_type=_content_type,
613
+ _headers=_headers,
614
+ _host_index=_host_index
615
+ )
616
+
617
+ _response_types_map: Dict[str, Optional[str]] = {
618
+ '200': "bytearray",
619
+ }
620
+ response_data = self.api_client.call_api(
621
+ *_param,
622
+ _request_timeout=_request_timeout
623
+ )
624
+ response_data.read()
625
+ return self.api_client.response_deserialize(
626
+ response_data=response_data,
627
+ response_types_map=_response_types_map,
628
+ ).data
629
+
630
+
631
+ @validate_call
632
+ def get_favicon_with_http_info(
633
+ self,
634
+ organization_id: Optional[StrictInt] = None,
635
+ _request_timeout: Union[
636
+ None,
637
+ Annotated[StrictFloat, Field(gt=0)],
638
+ Tuple[
639
+ Annotated[StrictFloat, Field(gt=0)],
640
+ Annotated[StrictFloat, Field(gt=0)]
641
+ ]
642
+ ] = None,
643
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
644
+ _content_type: Optional[StrictStr] = None,
645
+ _headers: Optional[Dict[StrictStr, Any]] = None,
646
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
647
+ ) -> ApiResponse[bytearray]:
648
+ """Returns the favicon that should be used.
649
+
650
+
651
+ :param organization_id:
652
+ :type organization_id: int
653
+ :param _request_timeout: timeout setting for this request. If one
654
+ number provided, it will be total request
655
+ timeout. It can also be a pair (tuple) of
656
+ (connection, read) timeouts.
657
+ :type _request_timeout: int, tuple(int, int), optional
658
+ :param _request_auth: set to override the auth_settings for an a single
659
+ request; this effectively ignores the
660
+ authentication in the spec for a single request.
661
+ :type _request_auth: dict, optional
662
+ :param _content_type: force content-type for the request.
663
+ :type _content_type: str, Optional
664
+ :param _headers: set to override the headers for a single
665
+ request; this effectively ignores the headers
666
+ in the spec for a single request.
667
+ :type _headers: dict, optional
668
+ :param _host_index: set to override the host_index for a single
669
+ request; this effectively ignores the host_index
670
+ in the spec for a single request.
671
+ :type _host_index: int, optional
672
+ :return: Returns the result object.
673
+ """ # noqa: E501
674
+
675
+ _param = self._get_favicon_serialize(
676
+ organization_id=organization_id,
677
+ _request_auth=_request_auth,
678
+ _content_type=_content_type,
679
+ _headers=_headers,
680
+ _host_index=_host_index
681
+ )
682
+
683
+ _response_types_map: Dict[str, Optional[str]] = {
684
+ '200': "bytearray",
685
+ }
686
+ response_data = self.api_client.call_api(
687
+ *_param,
688
+ _request_timeout=_request_timeout
689
+ )
690
+ response_data.read()
691
+ return self.api_client.response_deserialize(
692
+ response_data=response_data,
693
+ response_types_map=_response_types_map,
694
+ )
695
+
696
+
697
+ @validate_call
698
+ def get_favicon_without_preload_content(
699
+ self,
700
+ organization_id: Optional[StrictInt] = None,
701
+ _request_timeout: Union[
702
+ None,
703
+ Annotated[StrictFloat, Field(gt=0)],
704
+ Tuple[
705
+ Annotated[StrictFloat, Field(gt=0)],
706
+ Annotated[StrictFloat, Field(gt=0)]
707
+ ]
708
+ ] = None,
709
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
710
+ _content_type: Optional[StrictStr] = None,
711
+ _headers: Optional[Dict[StrictStr, Any]] = None,
712
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
713
+ ) -> RESTResponseType:
714
+ """Returns the favicon that should be used.
715
+
716
+
717
+ :param organization_id:
718
+ :type organization_id: int
719
+ :param _request_timeout: timeout setting for this request. If one
720
+ number provided, it will be total request
721
+ timeout. It can also be a pair (tuple) of
722
+ (connection, read) timeouts.
723
+ :type _request_timeout: int, tuple(int, int), optional
724
+ :param _request_auth: set to override the auth_settings for an a single
725
+ request; this effectively ignores the
726
+ authentication in the spec for a single request.
727
+ :type _request_auth: dict, optional
728
+ :param _content_type: force content-type for the request.
729
+ :type _content_type: str, Optional
730
+ :param _headers: set to override the headers for a single
731
+ request; this effectively ignores the headers
732
+ in the spec for a single request.
733
+ :type _headers: dict, optional
734
+ :param _host_index: set to override the host_index for a single
735
+ request; this effectively ignores the host_index
736
+ in the spec for a single request.
737
+ :type _host_index: int, optional
738
+ :return: Returns the result object.
739
+ """ # noqa: E501
740
+
741
+ _param = self._get_favicon_serialize(
742
+ organization_id=organization_id,
743
+ _request_auth=_request_auth,
744
+ _content_type=_content_type,
745
+ _headers=_headers,
746
+ _host_index=_host_index
747
+ )
748
+
749
+ _response_types_map: Dict[str, Optional[str]] = {
750
+ '200': "bytearray",
751
+ }
752
+ response_data = self.api_client.call_api(
753
+ *_param,
754
+ _request_timeout=_request_timeout
755
+ )
756
+ return response_data.response
757
+
758
+
759
+ def _get_favicon_serialize(
760
+ self,
761
+ organization_id,
762
+ _request_auth,
763
+ _content_type,
764
+ _headers,
765
+ _host_index,
766
+ ) -> RequestSerialized:
767
+
768
+ _host = None
769
+
770
+ _collection_formats: Dict[str, str] = {
771
+ }
772
+
773
+ _path_params: Dict[str, str] = {}
774
+ _query_params: List[Tuple[str, str]] = []
775
+ _header_params: Dict[str, Optional[str]] = _headers or {}
776
+ _form_params: List[Tuple[str, str]] = []
777
+ _files: Dict[
778
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
779
+ ] = {}
780
+ _body_params: Optional[bytes] = None
781
+
782
+ # process the path parameters
783
+ # process the query parameters
784
+ if organization_id is not None:
785
+
786
+ _query_params.append(('organization_id', organization_id))
787
+
788
+ # process the header parameters
789
+ # process the form parameters
790
+ # process the body parameter
791
+
792
+
793
+ # set the HTTP header `Accept`
794
+ if 'Accept' not in _header_params:
795
+ _header_params['Accept'] = self.api_client.select_header_accept(
796
+ [
797
+ '*/*'
798
+ ]
799
+ )
800
+
801
+
802
+ # authentication setting
803
+ _auth_settings: List[str] = [
804
+ 'QAnswer-Api-Key',
805
+ 'Bearer'
806
+ ]
807
+
808
+ return self.api_client.param_serialize(
809
+ method='GET',
810
+ resource_path='/api/branding/favicon',
811
+ path_params=_path_params,
812
+ query_params=_query_params,
813
+ header_params=_header_params,
814
+ body=_body_params,
815
+ post_params=_form_params,
816
+ files=_files,
817
+ auth_settings=_auth_settings,
818
+ collection_formats=_collection_formats,
819
+ _host=_host,
820
+ _request_auth=_request_auth
821
+ )
822
+
823
+
824
+
825
+
826
+ @validate_call
827
+ def get_logo1(
828
+ self,
829
+ organization_id: Optional[StrictInt] = None,
830
+ _request_timeout: Union[
831
+ None,
832
+ Annotated[StrictFloat, Field(gt=0)],
833
+ Tuple[
834
+ Annotated[StrictFloat, Field(gt=0)],
835
+ Annotated[StrictFloat, Field(gt=0)]
836
+ ]
837
+ ] = None,
838
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
839
+ _content_type: Optional[StrictStr] = None,
840
+ _headers: Optional[Dict[StrictStr, Any]] = None,
841
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
842
+ ) -> bytearray:
843
+ """Retrieves the logo that is used across the application
844
+
845
+
846
+ :param organization_id:
847
+ :type organization_id: int
848
+ :param _request_timeout: timeout setting for this request. If one
849
+ number provided, it will be total request
850
+ timeout. It can also be a pair (tuple) of
851
+ (connection, read) timeouts.
852
+ :type _request_timeout: int, tuple(int, int), optional
853
+ :param _request_auth: set to override the auth_settings for an a single
854
+ request; this effectively ignores the
855
+ authentication in the spec for a single request.
856
+ :type _request_auth: dict, optional
857
+ :param _content_type: force content-type for the request.
858
+ :type _content_type: str, Optional
859
+ :param _headers: set to override the headers for a single
860
+ request; this effectively ignores the headers
861
+ in the spec for a single request.
862
+ :type _headers: dict, optional
863
+ :param _host_index: set to override the host_index for a single
864
+ request; this effectively ignores the host_index
865
+ in the spec for a single request.
866
+ :type _host_index: int, optional
867
+ :return: Returns the result object.
868
+ """ # noqa: E501
869
+
870
+ _param = self._get_logo1_serialize(
871
+ organization_id=organization_id,
872
+ _request_auth=_request_auth,
873
+ _content_type=_content_type,
874
+ _headers=_headers,
875
+ _host_index=_host_index
876
+ )
877
+
878
+ _response_types_map: Dict[str, Optional[str]] = {
879
+ '200': "bytearray",
880
+ }
881
+ response_data = self.api_client.call_api(
882
+ *_param,
883
+ _request_timeout=_request_timeout
884
+ )
885
+ response_data.read()
886
+ return self.api_client.response_deserialize(
887
+ response_data=response_data,
888
+ response_types_map=_response_types_map,
889
+ ).data
890
+
891
+
892
+ @validate_call
893
+ def get_logo1_with_http_info(
894
+ self,
895
+ organization_id: Optional[StrictInt] = None,
896
+ _request_timeout: Union[
897
+ None,
898
+ Annotated[StrictFloat, Field(gt=0)],
899
+ Tuple[
900
+ Annotated[StrictFloat, Field(gt=0)],
901
+ Annotated[StrictFloat, Field(gt=0)]
902
+ ]
903
+ ] = None,
904
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
905
+ _content_type: Optional[StrictStr] = None,
906
+ _headers: Optional[Dict[StrictStr, Any]] = None,
907
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
908
+ ) -> ApiResponse[bytearray]:
909
+ """Retrieves the logo that is used across the application
910
+
911
+
912
+ :param organization_id:
913
+ :type organization_id: int
914
+ :param _request_timeout: timeout setting for this request. If one
915
+ number provided, it will be total request
916
+ timeout. It can also be a pair (tuple) of
917
+ (connection, read) timeouts.
918
+ :type _request_timeout: int, tuple(int, int), optional
919
+ :param _request_auth: set to override the auth_settings for an a single
920
+ request; this effectively ignores the
921
+ authentication in the spec for a single request.
922
+ :type _request_auth: dict, optional
923
+ :param _content_type: force content-type for the request.
924
+ :type _content_type: str, Optional
925
+ :param _headers: set to override the headers for a single
926
+ request; this effectively ignores the headers
927
+ in the spec for a single request.
928
+ :type _headers: dict, optional
929
+ :param _host_index: set to override the host_index for a single
930
+ request; this effectively ignores the host_index
931
+ in the spec for a single request.
932
+ :type _host_index: int, optional
933
+ :return: Returns the result object.
934
+ """ # noqa: E501
935
+
936
+ _param = self._get_logo1_serialize(
937
+ organization_id=organization_id,
938
+ _request_auth=_request_auth,
939
+ _content_type=_content_type,
940
+ _headers=_headers,
941
+ _host_index=_host_index
942
+ )
943
+
944
+ _response_types_map: Dict[str, Optional[str]] = {
945
+ '200': "bytearray",
946
+ }
947
+ response_data = self.api_client.call_api(
948
+ *_param,
949
+ _request_timeout=_request_timeout
950
+ )
951
+ response_data.read()
952
+ return self.api_client.response_deserialize(
953
+ response_data=response_data,
954
+ response_types_map=_response_types_map,
955
+ )
956
+
957
+
958
+ @validate_call
959
+ def get_logo1_without_preload_content(
960
+ self,
961
+ organization_id: Optional[StrictInt] = None,
962
+ _request_timeout: Union[
963
+ None,
964
+ Annotated[StrictFloat, Field(gt=0)],
965
+ Tuple[
966
+ Annotated[StrictFloat, Field(gt=0)],
967
+ Annotated[StrictFloat, Field(gt=0)]
968
+ ]
969
+ ] = None,
970
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
971
+ _content_type: Optional[StrictStr] = None,
972
+ _headers: Optional[Dict[StrictStr, Any]] = None,
973
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
974
+ ) -> RESTResponseType:
975
+ """Retrieves the logo that is used across the application
976
+
977
+
978
+ :param organization_id:
979
+ :type organization_id: int
980
+ :param _request_timeout: timeout setting for this request. If one
981
+ number provided, it will be total request
982
+ timeout. It can also be a pair (tuple) of
983
+ (connection, read) timeouts.
984
+ :type _request_timeout: int, tuple(int, int), optional
985
+ :param _request_auth: set to override the auth_settings for an a single
986
+ request; this effectively ignores the
987
+ authentication in the spec for a single request.
988
+ :type _request_auth: dict, optional
989
+ :param _content_type: force content-type for the request.
990
+ :type _content_type: str, Optional
991
+ :param _headers: set to override the headers for a single
992
+ request; this effectively ignores the headers
993
+ in the spec for a single request.
994
+ :type _headers: dict, optional
995
+ :param _host_index: set to override the host_index for a single
996
+ request; this effectively ignores the host_index
997
+ in the spec for a single request.
998
+ :type _host_index: int, optional
999
+ :return: Returns the result object.
1000
+ """ # noqa: E501
1001
+
1002
+ _param = self._get_logo1_serialize(
1003
+ organization_id=organization_id,
1004
+ _request_auth=_request_auth,
1005
+ _content_type=_content_type,
1006
+ _headers=_headers,
1007
+ _host_index=_host_index
1008
+ )
1009
+
1010
+ _response_types_map: Dict[str, Optional[str]] = {
1011
+ '200': "bytearray",
1012
+ }
1013
+ response_data = self.api_client.call_api(
1014
+ *_param,
1015
+ _request_timeout=_request_timeout
1016
+ )
1017
+ return response_data.response
1018
+
1019
+
1020
+ def _get_logo1_serialize(
1021
+ self,
1022
+ organization_id,
1023
+ _request_auth,
1024
+ _content_type,
1025
+ _headers,
1026
+ _host_index,
1027
+ ) -> RequestSerialized:
1028
+
1029
+ _host = None
1030
+
1031
+ _collection_formats: Dict[str, str] = {
1032
+ }
1033
+
1034
+ _path_params: Dict[str, str] = {}
1035
+ _query_params: List[Tuple[str, str]] = []
1036
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1037
+ _form_params: List[Tuple[str, str]] = []
1038
+ _files: Dict[
1039
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1040
+ ] = {}
1041
+ _body_params: Optional[bytes] = None
1042
+
1043
+ # process the path parameters
1044
+ # process the query parameters
1045
+ if organization_id is not None:
1046
+
1047
+ _query_params.append(('organization_id', organization_id))
1048
+
1049
+ # process the header parameters
1050
+ # process the form parameters
1051
+ # process the body parameter
1052
+
1053
+
1054
+ # set the HTTP header `Accept`
1055
+ if 'Accept' not in _header_params:
1056
+ _header_params['Accept'] = self.api_client.select_header_accept(
1057
+ [
1058
+ '*/*'
1059
+ ]
1060
+ )
1061
+
1062
+
1063
+ # authentication setting
1064
+ _auth_settings: List[str] = [
1065
+ 'QAnswer-Api-Key',
1066
+ 'Bearer'
1067
+ ]
1068
+
1069
+ return self.api_client.param_serialize(
1070
+ method='GET',
1071
+ resource_path='/api/branding/logo',
1072
+ path_params=_path_params,
1073
+ query_params=_query_params,
1074
+ header_params=_header_params,
1075
+ body=_body_params,
1076
+ post_params=_form_params,
1077
+ files=_files,
1078
+ auth_settings=_auth_settings,
1079
+ collection_formats=_collection_formats,
1080
+ _host=_host,
1081
+ _request_auth=_request_auth
1082
+ )
1083
+
1084
+
1085
+
1086
+
1087
+ @validate_call
1088
+ def get_logo_with_text(
1089
+ self,
1090
+ organization_id: Optional[StrictInt] = None,
1091
+ _request_timeout: Union[
1092
+ None,
1093
+ Annotated[StrictFloat, Field(gt=0)],
1094
+ Tuple[
1095
+ Annotated[StrictFloat, Field(gt=0)],
1096
+ Annotated[StrictFloat, Field(gt=0)]
1097
+ ]
1098
+ ] = None,
1099
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1100
+ _content_type: Optional[StrictStr] = None,
1101
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1102
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1103
+ ) -> bytearray:
1104
+ """Retrieves the logo with text that is used across the application
1105
+
1106
+
1107
+ :param organization_id:
1108
+ :type organization_id: int
1109
+ :param _request_timeout: timeout setting for this request. If one
1110
+ number provided, it will be total request
1111
+ timeout. It can also be a pair (tuple) of
1112
+ (connection, read) timeouts.
1113
+ :type _request_timeout: int, tuple(int, int), optional
1114
+ :param _request_auth: set to override the auth_settings for an a single
1115
+ request; this effectively ignores the
1116
+ authentication in the spec for a single request.
1117
+ :type _request_auth: dict, optional
1118
+ :param _content_type: force content-type for the request.
1119
+ :type _content_type: str, Optional
1120
+ :param _headers: set to override the headers for a single
1121
+ request; this effectively ignores the headers
1122
+ in the spec for a single request.
1123
+ :type _headers: dict, optional
1124
+ :param _host_index: set to override the host_index for a single
1125
+ request; this effectively ignores the host_index
1126
+ in the spec for a single request.
1127
+ :type _host_index: int, optional
1128
+ :return: Returns the result object.
1129
+ """ # noqa: E501
1130
+
1131
+ _param = self._get_logo_with_text_serialize(
1132
+ organization_id=organization_id,
1133
+ _request_auth=_request_auth,
1134
+ _content_type=_content_type,
1135
+ _headers=_headers,
1136
+ _host_index=_host_index
1137
+ )
1138
+
1139
+ _response_types_map: Dict[str, Optional[str]] = {
1140
+ '200': "bytearray",
1141
+ }
1142
+ response_data = self.api_client.call_api(
1143
+ *_param,
1144
+ _request_timeout=_request_timeout
1145
+ )
1146
+ response_data.read()
1147
+ return self.api_client.response_deserialize(
1148
+ response_data=response_data,
1149
+ response_types_map=_response_types_map,
1150
+ ).data
1151
+
1152
+
1153
+ @validate_call
1154
+ def get_logo_with_text_with_http_info(
1155
+ self,
1156
+ organization_id: Optional[StrictInt] = None,
1157
+ _request_timeout: Union[
1158
+ None,
1159
+ Annotated[StrictFloat, Field(gt=0)],
1160
+ Tuple[
1161
+ Annotated[StrictFloat, Field(gt=0)],
1162
+ Annotated[StrictFloat, Field(gt=0)]
1163
+ ]
1164
+ ] = None,
1165
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1166
+ _content_type: Optional[StrictStr] = None,
1167
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1168
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1169
+ ) -> ApiResponse[bytearray]:
1170
+ """Retrieves the logo with text that is used across the application
1171
+
1172
+
1173
+ :param organization_id:
1174
+ :type organization_id: int
1175
+ :param _request_timeout: timeout setting for this request. If one
1176
+ number provided, it will be total request
1177
+ timeout. It can also be a pair (tuple) of
1178
+ (connection, read) timeouts.
1179
+ :type _request_timeout: int, tuple(int, int), optional
1180
+ :param _request_auth: set to override the auth_settings for an a single
1181
+ request; this effectively ignores the
1182
+ authentication in the spec for a single request.
1183
+ :type _request_auth: dict, optional
1184
+ :param _content_type: force content-type for the request.
1185
+ :type _content_type: str, Optional
1186
+ :param _headers: set to override the headers for a single
1187
+ request; this effectively ignores the headers
1188
+ in the spec for a single request.
1189
+ :type _headers: dict, optional
1190
+ :param _host_index: set to override the host_index for a single
1191
+ request; this effectively ignores the host_index
1192
+ in the spec for a single request.
1193
+ :type _host_index: int, optional
1194
+ :return: Returns the result object.
1195
+ """ # noqa: E501
1196
+
1197
+ _param = self._get_logo_with_text_serialize(
1198
+ organization_id=organization_id,
1199
+ _request_auth=_request_auth,
1200
+ _content_type=_content_type,
1201
+ _headers=_headers,
1202
+ _host_index=_host_index
1203
+ )
1204
+
1205
+ _response_types_map: Dict[str, Optional[str]] = {
1206
+ '200': "bytearray",
1207
+ }
1208
+ response_data = self.api_client.call_api(
1209
+ *_param,
1210
+ _request_timeout=_request_timeout
1211
+ )
1212
+ response_data.read()
1213
+ return self.api_client.response_deserialize(
1214
+ response_data=response_data,
1215
+ response_types_map=_response_types_map,
1216
+ )
1217
+
1218
+
1219
+ @validate_call
1220
+ def get_logo_with_text_without_preload_content(
1221
+ self,
1222
+ organization_id: Optional[StrictInt] = None,
1223
+ _request_timeout: Union[
1224
+ None,
1225
+ Annotated[StrictFloat, Field(gt=0)],
1226
+ Tuple[
1227
+ Annotated[StrictFloat, Field(gt=0)],
1228
+ Annotated[StrictFloat, Field(gt=0)]
1229
+ ]
1230
+ ] = None,
1231
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1232
+ _content_type: Optional[StrictStr] = None,
1233
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1234
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1235
+ ) -> RESTResponseType:
1236
+ """Retrieves the logo with text that is used across the application
1237
+
1238
+
1239
+ :param organization_id:
1240
+ :type organization_id: int
1241
+ :param _request_timeout: timeout setting for this request. If one
1242
+ number provided, it will be total request
1243
+ timeout. It can also be a pair (tuple) of
1244
+ (connection, read) timeouts.
1245
+ :type _request_timeout: int, tuple(int, int), optional
1246
+ :param _request_auth: set to override the auth_settings for an a single
1247
+ request; this effectively ignores the
1248
+ authentication in the spec for a single request.
1249
+ :type _request_auth: dict, optional
1250
+ :param _content_type: force content-type for the request.
1251
+ :type _content_type: str, Optional
1252
+ :param _headers: set to override the headers for a single
1253
+ request; this effectively ignores the headers
1254
+ in the spec for a single request.
1255
+ :type _headers: dict, optional
1256
+ :param _host_index: set to override the host_index for a single
1257
+ request; this effectively ignores the host_index
1258
+ in the spec for a single request.
1259
+ :type _host_index: int, optional
1260
+ :return: Returns the result object.
1261
+ """ # noqa: E501
1262
+
1263
+ _param = self._get_logo_with_text_serialize(
1264
+ organization_id=organization_id,
1265
+ _request_auth=_request_auth,
1266
+ _content_type=_content_type,
1267
+ _headers=_headers,
1268
+ _host_index=_host_index
1269
+ )
1270
+
1271
+ _response_types_map: Dict[str, Optional[str]] = {
1272
+ '200': "bytearray",
1273
+ }
1274
+ response_data = self.api_client.call_api(
1275
+ *_param,
1276
+ _request_timeout=_request_timeout
1277
+ )
1278
+ return response_data.response
1279
+
1280
+
1281
+ def _get_logo_with_text_serialize(
1282
+ self,
1283
+ organization_id,
1284
+ _request_auth,
1285
+ _content_type,
1286
+ _headers,
1287
+ _host_index,
1288
+ ) -> RequestSerialized:
1289
+
1290
+ _host = None
1291
+
1292
+ _collection_formats: Dict[str, str] = {
1293
+ }
1294
+
1295
+ _path_params: Dict[str, str] = {}
1296
+ _query_params: List[Tuple[str, str]] = []
1297
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1298
+ _form_params: List[Tuple[str, str]] = []
1299
+ _files: Dict[
1300
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1301
+ ] = {}
1302
+ _body_params: Optional[bytes] = None
1303
+
1304
+ # process the path parameters
1305
+ # process the query parameters
1306
+ if organization_id is not None:
1307
+
1308
+ _query_params.append(('organization_id', organization_id))
1309
+
1310
+ # process the header parameters
1311
+ # process the form parameters
1312
+ # process the body parameter
1313
+
1314
+
1315
+ # set the HTTP header `Accept`
1316
+ if 'Accept' not in _header_params:
1317
+ _header_params['Accept'] = self.api_client.select_header_accept(
1318
+ [
1319
+ '*/*'
1320
+ ]
1321
+ )
1322
+
1323
+
1324
+ # authentication setting
1325
+ _auth_settings: List[str] = [
1326
+ 'QAnswer-Api-Key',
1327
+ 'Bearer'
1328
+ ]
1329
+
1330
+ return self.api_client.param_serialize(
1331
+ method='GET',
1332
+ resource_path='/api/branding/logo-with-text',
1333
+ path_params=_path_params,
1334
+ query_params=_query_params,
1335
+ header_params=_header_params,
1336
+ body=_body_params,
1337
+ post_params=_form_params,
1338
+ files=_files,
1339
+ auth_settings=_auth_settings,
1340
+ collection_formats=_collection_formats,
1341
+ _host=_host,
1342
+ _request_auth=_request_auth
1343
+ )
1344
+
1345
+
1346
+
1347
+
1348
+ @validate_call
1349
+ def get_system_message(
1350
+ self,
1351
+ organization_id: Optional[StrictInt] = None,
1352
+ _request_timeout: Union[
1353
+ None,
1354
+ Annotated[StrictFloat, Field(gt=0)],
1355
+ Tuple[
1356
+ Annotated[StrictFloat, Field(gt=0)],
1357
+ Annotated[StrictFloat, Field(gt=0)]
1358
+ ]
1359
+ ] = None,
1360
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1361
+ _content_type: Optional[StrictStr] = None,
1362
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1363
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1364
+ ) -> BrandingSystemMessage:
1365
+ """Retrieves the system message
1366
+
1367
+
1368
+ :param organization_id:
1369
+ :type organization_id: int
1370
+ :param _request_timeout: timeout setting for this request. If one
1371
+ number provided, it will be total request
1372
+ timeout. It can also be a pair (tuple) of
1373
+ (connection, read) timeouts.
1374
+ :type _request_timeout: int, tuple(int, int), optional
1375
+ :param _request_auth: set to override the auth_settings for an a single
1376
+ request; this effectively ignores the
1377
+ authentication in the spec for a single request.
1378
+ :type _request_auth: dict, optional
1379
+ :param _content_type: force content-type for the request.
1380
+ :type _content_type: str, Optional
1381
+ :param _headers: set to override the headers for a single
1382
+ request; this effectively ignores the headers
1383
+ in the spec for a single request.
1384
+ :type _headers: dict, optional
1385
+ :param _host_index: set to override the host_index for a single
1386
+ request; this effectively ignores the host_index
1387
+ in the spec for a single request.
1388
+ :type _host_index: int, optional
1389
+ :return: Returns the result object.
1390
+ """ # noqa: E501
1391
+
1392
+ _param = self._get_system_message_serialize(
1393
+ organization_id=organization_id,
1394
+ _request_auth=_request_auth,
1395
+ _content_type=_content_type,
1396
+ _headers=_headers,
1397
+ _host_index=_host_index
1398
+ )
1399
+
1400
+ _response_types_map: Dict[str, Optional[str]] = {
1401
+ '200': "BrandingSystemMessage",
1402
+ }
1403
+ response_data = self.api_client.call_api(
1404
+ *_param,
1405
+ _request_timeout=_request_timeout
1406
+ )
1407
+ response_data.read()
1408
+ return self.api_client.response_deserialize(
1409
+ response_data=response_data,
1410
+ response_types_map=_response_types_map,
1411
+ ).data
1412
+
1413
+
1414
+ @validate_call
1415
+ def get_system_message_with_http_info(
1416
+ self,
1417
+ organization_id: Optional[StrictInt] = None,
1418
+ _request_timeout: Union[
1419
+ None,
1420
+ Annotated[StrictFloat, Field(gt=0)],
1421
+ Tuple[
1422
+ Annotated[StrictFloat, Field(gt=0)],
1423
+ Annotated[StrictFloat, Field(gt=0)]
1424
+ ]
1425
+ ] = None,
1426
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1427
+ _content_type: Optional[StrictStr] = None,
1428
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1429
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1430
+ ) -> ApiResponse[BrandingSystemMessage]:
1431
+ """Retrieves the system message
1432
+
1433
+
1434
+ :param organization_id:
1435
+ :type organization_id: int
1436
+ :param _request_timeout: timeout setting for this request. If one
1437
+ number provided, it will be total request
1438
+ timeout. It can also be a pair (tuple) of
1439
+ (connection, read) timeouts.
1440
+ :type _request_timeout: int, tuple(int, int), optional
1441
+ :param _request_auth: set to override the auth_settings for an a single
1442
+ request; this effectively ignores the
1443
+ authentication in the spec for a single request.
1444
+ :type _request_auth: dict, optional
1445
+ :param _content_type: force content-type for the request.
1446
+ :type _content_type: str, Optional
1447
+ :param _headers: set to override the headers for a single
1448
+ request; this effectively ignores the headers
1449
+ in the spec for a single request.
1450
+ :type _headers: dict, optional
1451
+ :param _host_index: set to override the host_index for a single
1452
+ request; this effectively ignores the host_index
1453
+ in the spec for a single request.
1454
+ :type _host_index: int, optional
1455
+ :return: Returns the result object.
1456
+ """ # noqa: E501
1457
+
1458
+ _param = self._get_system_message_serialize(
1459
+ organization_id=organization_id,
1460
+ _request_auth=_request_auth,
1461
+ _content_type=_content_type,
1462
+ _headers=_headers,
1463
+ _host_index=_host_index
1464
+ )
1465
+
1466
+ _response_types_map: Dict[str, Optional[str]] = {
1467
+ '200': "BrandingSystemMessage",
1468
+ }
1469
+ response_data = self.api_client.call_api(
1470
+ *_param,
1471
+ _request_timeout=_request_timeout
1472
+ )
1473
+ response_data.read()
1474
+ return self.api_client.response_deserialize(
1475
+ response_data=response_data,
1476
+ response_types_map=_response_types_map,
1477
+ )
1478
+
1479
+
1480
+ @validate_call
1481
+ def get_system_message_without_preload_content(
1482
+ self,
1483
+ organization_id: Optional[StrictInt] = None,
1484
+ _request_timeout: Union[
1485
+ None,
1486
+ Annotated[StrictFloat, Field(gt=0)],
1487
+ Tuple[
1488
+ Annotated[StrictFloat, Field(gt=0)],
1489
+ Annotated[StrictFloat, Field(gt=0)]
1490
+ ]
1491
+ ] = None,
1492
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1493
+ _content_type: Optional[StrictStr] = None,
1494
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1495
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1496
+ ) -> RESTResponseType:
1497
+ """Retrieves the system message
1498
+
1499
+
1500
+ :param organization_id:
1501
+ :type organization_id: int
1502
+ :param _request_timeout: timeout setting for this request. If one
1503
+ number provided, it will be total request
1504
+ timeout. It can also be a pair (tuple) of
1505
+ (connection, read) timeouts.
1506
+ :type _request_timeout: int, tuple(int, int), optional
1507
+ :param _request_auth: set to override the auth_settings for an a single
1508
+ request; this effectively ignores the
1509
+ authentication in the spec for a single request.
1510
+ :type _request_auth: dict, optional
1511
+ :param _content_type: force content-type for the request.
1512
+ :type _content_type: str, Optional
1513
+ :param _headers: set to override the headers for a single
1514
+ request; this effectively ignores the headers
1515
+ in the spec for a single request.
1516
+ :type _headers: dict, optional
1517
+ :param _host_index: set to override the host_index for a single
1518
+ request; this effectively ignores the host_index
1519
+ in the spec for a single request.
1520
+ :type _host_index: int, optional
1521
+ :return: Returns the result object.
1522
+ """ # noqa: E501
1523
+
1524
+ _param = self._get_system_message_serialize(
1525
+ organization_id=organization_id,
1526
+ _request_auth=_request_auth,
1527
+ _content_type=_content_type,
1528
+ _headers=_headers,
1529
+ _host_index=_host_index
1530
+ )
1531
+
1532
+ _response_types_map: Dict[str, Optional[str]] = {
1533
+ '200': "BrandingSystemMessage",
1534
+ }
1535
+ response_data = self.api_client.call_api(
1536
+ *_param,
1537
+ _request_timeout=_request_timeout
1538
+ )
1539
+ return response_data.response
1540
+
1541
+
1542
+ def _get_system_message_serialize(
1543
+ self,
1544
+ organization_id,
1545
+ _request_auth,
1546
+ _content_type,
1547
+ _headers,
1548
+ _host_index,
1549
+ ) -> RequestSerialized:
1550
+
1551
+ _host = None
1552
+
1553
+ _collection_formats: Dict[str, str] = {
1554
+ }
1555
+
1556
+ _path_params: Dict[str, str] = {}
1557
+ _query_params: List[Tuple[str, str]] = []
1558
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1559
+ _form_params: List[Tuple[str, str]] = []
1560
+ _files: Dict[
1561
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1562
+ ] = {}
1563
+ _body_params: Optional[bytes] = None
1564
+
1565
+ # process the path parameters
1566
+ # process the query parameters
1567
+ if organization_id is not None:
1568
+
1569
+ _query_params.append(('organization_id', organization_id))
1570
+
1571
+ # process the header parameters
1572
+ # process the form parameters
1573
+ # process the body parameter
1574
+
1575
+
1576
+ # set the HTTP header `Accept`
1577
+ if 'Accept' not in _header_params:
1578
+ _header_params['Accept'] = self.api_client.select_header_accept(
1579
+ [
1580
+ '*/*'
1581
+ ]
1582
+ )
1583
+
1584
+
1585
+ # authentication setting
1586
+ _auth_settings: List[str] = [
1587
+ 'QAnswer-Api-Key',
1588
+ 'Bearer'
1589
+ ]
1590
+
1591
+ return self.api_client.param_serialize(
1592
+ method='GET',
1593
+ resource_path='/api/branding/system-message',
1594
+ path_params=_path_params,
1595
+ query_params=_query_params,
1596
+ header_params=_header_params,
1597
+ body=_body_params,
1598
+ post_params=_form_params,
1599
+ files=_files,
1600
+ auth_settings=_auth_settings,
1601
+ collection_formats=_collection_formats,
1602
+ _host=_host,
1603
+ _request_auth=_request_auth
1604
+ )
1605
+
1606
+
1607
+
1608
+
1609
+ @validate_call
1610
+ def reset_app_title(
1611
+ self,
1612
+ organization_id: Optional[StrictInt] = None,
1613
+ _request_timeout: Union[
1614
+ None,
1615
+ Annotated[StrictFloat, Field(gt=0)],
1616
+ Tuple[
1617
+ Annotated[StrictFloat, Field(gt=0)],
1618
+ Annotated[StrictFloat, Field(gt=0)]
1619
+ ]
1620
+ ] = None,
1621
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1622
+ _content_type: Optional[StrictStr] = None,
1623
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1624
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1625
+ ) -> str:
1626
+ """Reset the branding data and the system message that is used for this organization
1627
+
1628
+
1629
+ :param organization_id:
1630
+ :type organization_id: int
1631
+ :param _request_timeout: timeout setting for this request. If one
1632
+ number provided, it will be total request
1633
+ timeout. It can also be a pair (tuple) of
1634
+ (connection, read) timeouts.
1635
+ :type _request_timeout: int, tuple(int, int), optional
1636
+ :param _request_auth: set to override the auth_settings for an a single
1637
+ request; this effectively ignores the
1638
+ authentication in the spec for a single request.
1639
+ :type _request_auth: dict, optional
1640
+ :param _content_type: force content-type for the request.
1641
+ :type _content_type: str, Optional
1642
+ :param _headers: set to override the headers for a single
1643
+ request; this effectively ignores the headers
1644
+ in the spec for a single request.
1645
+ :type _headers: dict, optional
1646
+ :param _host_index: set to override the host_index for a single
1647
+ request; this effectively ignores the host_index
1648
+ in the spec for a single request.
1649
+ :type _host_index: int, optional
1650
+ :return: Returns the result object.
1651
+ """ # noqa: E501
1652
+
1653
+ _param = self._reset_app_title_serialize(
1654
+ organization_id=organization_id,
1655
+ _request_auth=_request_auth,
1656
+ _content_type=_content_type,
1657
+ _headers=_headers,
1658
+ _host_index=_host_index
1659
+ )
1660
+
1661
+ _response_types_map: Dict[str, Optional[str]] = {
1662
+ '200': "str",
1663
+ }
1664
+ response_data = self.api_client.call_api(
1665
+ *_param,
1666
+ _request_timeout=_request_timeout
1667
+ )
1668
+ response_data.read()
1669
+ return self.api_client.response_deserialize(
1670
+ response_data=response_data,
1671
+ response_types_map=_response_types_map,
1672
+ ).data
1673
+
1674
+
1675
+ @validate_call
1676
+ def reset_app_title_with_http_info(
1677
+ self,
1678
+ organization_id: Optional[StrictInt] = None,
1679
+ _request_timeout: Union[
1680
+ None,
1681
+ Annotated[StrictFloat, Field(gt=0)],
1682
+ Tuple[
1683
+ Annotated[StrictFloat, Field(gt=0)],
1684
+ Annotated[StrictFloat, Field(gt=0)]
1685
+ ]
1686
+ ] = None,
1687
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1688
+ _content_type: Optional[StrictStr] = None,
1689
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1690
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1691
+ ) -> ApiResponse[str]:
1692
+ """Reset the branding data and the system message that is used for this organization
1693
+
1694
+
1695
+ :param organization_id:
1696
+ :type organization_id: int
1697
+ :param _request_timeout: timeout setting for this request. If one
1698
+ number provided, it will be total request
1699
+ timeout. It can also be a pair (tuple) of
1700
+ (connection, read) timeouts.
1701
+ :type _request_timeout: int, tuple(int, int), optional
1702
+ :param _request_auth: set to override the auth_settings for an a single
1703
+ request; this effectively ignores the
1704
+ authentication in the spec for a single request.
1705
+ :type _request_auth: dict, optional
1706
+ :param _content_type: force content-type for the request.
1707
+ :type _content_type: str, Optional
1708
+ :param _headers: set to override the headers for a single
1709
+ request; this effectively ignores the headers
1710
+ in the spec for a single request.
1711
+ :type _headers: dict, optional
1712
+ :param _host_index: set to override the host_index for a single
1713
+ request; this effectively ignores the host_index
1714
+ in the spec for a single request.
1715
+ :type _host_index: int, optional
1716
+ :return: Returns the result object.
1717
+ """ # noqa: E501
1718
+
1719
+ _param = self._reset_app_title_serialize(
1720
+ organization_id=organization_id,
1721
+ _request_auth=_request_auth,
1722
+ _content_type=_content_type,
1723
+ _headers=_headers,
1724
+ _host_index=_host_index
1725
+ )
1726
+
1727
+ _response_types_map: Dict[str, Optional[str]] = {
1728
+ '200': "str",
1729
+ }
1730
+ response_data = self.api_client.call_api(
1731
+ *_param,
1732
+ _request_timeout=_request_timeout
1733
+ )
1734
+ response_data.read()
1735
+ return self.api_client.response_deserialize(
1736
+ response_data=response_data,
1737
+ response_types_map=_response_types_map,
1738
+ )
1739
+
1740
+
1741
+ @validate_call
1742
+ def reset_app_title_without_preload_content(
1743
+ self,
1744
+ organization_id: Optional[StrictInt] = None,
1745
+ _request_timeout: Union[
1746
+ None,
1747
+ Annotated[StrictFloat, Field(gt=0)],
1748
+ Tuple[
1749
+ Annotated[StrictFloat, Field(gt=0)],
1750
+ Annotated[StrictFloat, Field(gt=0)]
1751
+ ]
1752
+ ] = None,
1753
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1754
+ _content_type: Optional[StrictStr] = None,
1755
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1756
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1757
+ ) -> RESTResponseType:
1758
+ """Reset the branding data and the system message that is used for this organization
1759
+
1760
+
1761
+ :param organization_id:
1762
+ :type organization_id: int
1763
+ :param _request_timeout: timeout setting for this request. If one
1764
+ number provided, it will be total request
1765
+ timeout. It can also be a pair (tuple) of
1766
+ (connection, read) timeouts.
1767
+ :type _request_timeout: int, tuple(int, int), optional
1768
+ :param _request_auth: set to override the auth_settings for an a single
1769
+ request; this effectively ignores the
1770
+ authentication in the spec for a single request.
1771
+ :type _request_auth: dict, optional
1772
+ :param _content_type: force content-type for the request.
1773
+ :type _content_type: str, Optional
1774
+ :param _headers: set to override the headers for a single
1775
+ request; this effectively ignores the headers
1776
+ in the spec for a single request.
1777
+ :type _headers: dict, optional
1778
+ :param _host_index: set to override the host_index for a single
1779
+ request; this effectively ignores the host_index
1780
+ in the spec for a single request.
1781
+ :type _host_index: int, optional
1782
+ :return: Returns the result object.
1783
+ """ # noqa: E501
1784
+
1785
+ _param = self._reset_app_title_serialize(
1786
+ organization_id=organization_id,
1787
+ _request_auth=_request_auth,
1788
+ _content_type=_content_type,
1789
+ _headers=_headers,
1790
+ _host_index=_host_index
1791
+ )
1792
+
1793
+ _response_types_map: Dict[str, Optional[str]] = {
1794
+ '200': "str",
1795
+ }
1796
+ response_data = self.api_client.call_api(
1797
+ *_param,
1798
+ _request_timeout=_request_timeout
1799
+ )
1800
+ return response_data.response
1801
+
1802
+
1803
+ def _reset_app_title_serialize(
1804
+ self,
1805
+ organization_id,
1806
+ _request_auth,
1807
+ _content_type,
1808
+ _headers,
1809
+ _host_index,
1810
+ ) -> RequestSerialized:
1811
+
1812
+ _host = None
1813
+
1814
+ _collection_formats: Dict[str, str] = {
1815
+ }
1816
+
1817
+ _path_params: Dict[str, str] = {}
1818
+ _query_params: List[Tuple[str, str]] = []
1819
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1820
+ _form_params: List[Tuple[str, str]] = []
1821
+ _files: Dict[
1822
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1823
+ ] = {}
1824
+ _body_params: Optional[bytes] = None
1825
+
1826
+ # process the path parameters
1827
+ # process the query parameters
1828
+ if organization_id is not None:
1829
+
1830
+ _query_params.append(('organization_id', organization_id))
1831
+
1832
+ # process the header parameters
1833
+ # process the form parameters
1834
+ # process the body parameter
1835
+
1836
+
1837
+ # set the HTTP header `Accept`
1838
+ if 'Accept' not in _header_params:
1839
+ _header_params['Accept'] = self.api_client.select_header_accept(
1840
+ [
1841
+ '*/*'
1842
+ ]
1843
+ )
1844
+
1845
+
1846
+ # authentication setting
1847
+ _auth_settings: List[str] = [
1848
+ 'QAnswer-Api-Key',
1849
+ 'Bearer'
1850
+ ]
1851
+
1852
+ return self.api_client.param_serialize(
1853
+ method='PUT',
1854
+ resource_path='/api/branding/app-title/reset',
1855
+ path_params=_path_params,
1856
+ query_params=_query_params,
1857
+ header_params=_header_params,
1858
+ body=_body_params,
1859
+ post_params=_form_params,
1860
+ files=_files,
1861
+ auth_settings=_auth_settings,
1862
+ collection_formats=_collection_formats,
1863
+ _host=_host,
1864
+ _request_auth=_request_auth
1865
+ )
1866
+
1867
+
1868
+
1869
+
1870
+ @validate_call
1871
+ def reset_favicon(
1872
+ self,
1873
+ organization_id: Optional[StrictInt] = None,
1874
+ _request_timeout: Union[
1875
+ None,
1876
+ Annotated[StrictFloat, Field(gt=0)],
1877
+ Tuple[
1878
+ Annotated[StrictFloat, Field(gt=0)],
1879
+ Annotated[StrictFloat, Field(gt=0)]
1880
+ ]
1881
+ ] = None,
1882
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1883
+ _content_type: Optional[StrictStr] = None,
1884
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1885
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1886
+ ) -> None:
1887
+ """Set the favicon across the application
1888
+
1889
+ The favicon needs to be an image.
1890
+
1891
+ :param organization_id:
1892
+ :type organization_id: int
1893
+ :param _request_timeout: timeout setting for this request. If one
1894
+ number provided, it will be total request
1895
+ timeout. It can also be a pair (tuple) of
1896
+ (connection, read) timeouts.
1897
+ :type _request_timeout: int, tuple(int, int), optional
1898
+ :param _request_auth: set to override the auth_settings for an a single
1899
+ request; this effectively ignores the
1900
+ authentication in the spec for a single request.
1901
+ :type _request_auth: dict, optional
1902
+ :param _content_type: force content-type for the request.
1903
+ :type _content_type: str, Optional
1904
+ :param _headers: set to override the headers for a single
1905
+ request; this effectively ignores the headers
1906
+ in the spec for a single request.
1907
+ :type _headers: dict, optional
1908
+ :param _host_index: set to override the host_index for a single
1909
+ request; this effectively ignores the host_index
1910
+ in the spec for a single request.
1911
+ :type _host_index: int, optional
1912
+ :return: Returns the result object.
1913
+ """ # noqa: E501
1914
+
1915
+ _param = self._reset_favicon_serialize(
1916
+ organization_id=organization_id,
1917
+ _request_auth=_request_auth,
1918
+ _content_type=_content_type,
1919
+ _headers=_headers,
1920
+ _host_index=_host_index
1921
+ )
1922
+
1923
+ _response_types_map: Dict[str, Optional[str]] = {
1924
+ '200': None,
1925
+ }
1926
+ response_data = self.api_client.call_api(
1927
+ *_param,
1928
+ _request_timeout=_request_timeout
1929
+ )
1930
+ response_data.read()
1931
+ return self.api_client.response_deserialize(
1932
+ response_data=response_data,
1933
+ response_types_map=_response_types_map,
1934
+ ).data
1935
+
1936
+
1937
+ @validate_call
1938
+ def reset_favicon_with_http_info(
1939
+ self,
1940
+ organization_id: Optional[StrictInt] = None,
1941
+ _request_timeout: Union[
1942
+ None,
1943
+ Annotated[StrictFloat, Field(gt=0)],
1944
+ Tuple[
1945
+ Annotated[StrictFloat, Field(gt=0)],
1946
+ Annotated[StrictFloat, Field(gt=0)]
1947
+ ]
1948
+ ] = None,
1949
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1950
+ _content_type: Optional[StrictStr] = None,
1951
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1952
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1953
+ ) -> ApiResponse[None]:
1954
+ """Set the favicon across the application
1955
+
1956
+ The favicon needs to be an image.
1957
+
1958
+ :param organization_id:
1959
+ :type organization_id: int
1960
+ :param _request_timeout: timeout setting for this request. If one
1961
+ number provided, it will be total request
1962
+ timeout. It can also be a pair (tuple) of
1963
+ (connection, read) timeouts.
1964
+ :type _request_timeout: int, tuple(int, int), optional
1965
+ :param _request_auth: set to override the auth_settings for an a single
1966
+ request; this effectively ignores the
1967
+ authentication in the spec for a single request.
1968
+ :type _request_auth: dict, optional
1969
+ :param _content_type: force content-type for the request.
1970
+ :type _content_type: str, Optional
1971
+ :param _headers: set to override the headers for a single
1972
+ request; this effectively ignores the headers
1973
+ in the spec for a single request.
1974
+ :type _headers: dict, optional
1975
+ :param _host_index: set to override the host_index for a single
1976
+ request; this effectively ignores the host_index
1977
+ in the spec for a single request.
1978
+ :type _host_index: int, optional
1979
+ :return: Returns the result object.
1980
+ """ # noqa: E501
1981
+
1982
+ _param = self._reset_favicon_serialize(
1983
+ organization_id=organization_id,
1984
+ _request_auth=_request_auth,
1985
+ _content_type=_content_type,
1986
+ _headers=_headers,
1987
+ _host_index=_host_index
1988
+ )
1989
+
1990
+ _response_types_map: Dict[str, Optional[str]] = {
1991
+ '200': None,
1992
+ }
1993
+ response_data = self.api_client.call_api(
1994
+ *_param,
1995
+ _request_timeout=_request_timeout
1996
+ )
1997
+ response_data.read()
1998
+ return self.api_client.response_deserialize(
1999
+ response_data=response_data,
2000
+ response_types_map=_response_types_map,
2001
+ )
2002
+
2003
+
2004
+ @validate_call
2005
+ def reset_favicon_without_preload_content(
2006
+ self,
2007
+ organization_id: Optional[StrictInt] = None,
2008
+ _request_timeout: Union[
2009
+ None,
2010
+ Annotated[StrictFloat, Field(gt=0)],
2011
+ Tuple[
2012
+ Annotated[StrictFloat, Field(gt=0)],
2013
+ Annotated[StrictFloat, Field(gt=0)]
2014
+ ]
2015
+ ] = None,
2016
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2017
+ _content_type: Optional[StrictStr] = None,
2018
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2019
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2020
+ ) -> RESTResponseType:
2021
+ """Set the favicon across the application
2022
+
2023
+ The favicon needs to be an image.
2024
+
2025
+ :param organization_id:
2026
+ :type organization_id: int
2027
+ :param _request_timeout: timeout setting for this request. If one
2028
+ number provided, it will be total request
2029
+ timeout. It can also be a pair (tuple) of
2030
+ (connection, read) timeouts.
2031
+ :type _request_timeout: int, tuple(int, int), optional
2032
+ :param _request_auth: set to override the auth_settings for an a single
2033
+ request; this effectively ignores the
2034
+ authentication in the spec for a single request.
2035
+ :type _request_auth: dict, optional
2036
+ :param _content_type: force content-type for the request.
2037
+ :type _content_type: str, Optional
2038
+ :param _headers: set to override the headers for a single
2039
+ request; this effectively ignores the headers
2040
+ in the spec for a single request.
2041
+ :type _headers: dict, optional
2042
+ :param _host_index: set to override the host_index for a single
2043
+ request; this effectively ignores the host_index
2044
+ in the spec for a single request.
2045
+ :type _host_index: int, optional
2046
+ :return: Returns the result object.
2047
+ """ # noqa: E501
2048
+
2049
+ _param = self._reset_favicon_serialize(
2050
+ organization_id=organization_id,
2051
+ _request_auth=_request_auth,
2052
+ _content_type=_content_type,
2053
+ _headers=_headers,
2054
+ _host_index=_host_index
2055
+ )
2056
+
2057
+ _response_types_map: Dict[str, Optional[str]] = {
2058
+ '200': None,
2059
+ }
2060
+ response_data = self.api_client.call_api(
2061
+ *_param,
2062
+ _request_timeout=_request_timeout
2063
+ )
2064
+ return response_data.response
2065
+
2066
+
2067
+ def _reset_favicon_serialize(
2068
+ self,
2069
+ organization_id,
2070
+ _request_auth,
2071
+ _content_type,
2072
+ _headers,
2073
+ _host_index,
2074
+ ) -> RequestSerialized:
2075
+
2076
+ _host = None
2077
+
2078
+ _collection_formats: Dict[str, str] = {
2079
+ }
2080
+
2081
+ _path_params: Dict[str, str] = {}
2082
+ _query_params: List[Tuple[str, str]] = []
2083
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2084
+ _form_params: List[Tuple[str, str]] = []
2085
+ _files: Dict[
2086
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2087
+ ] = {}
2088
+ _body_params: Optional[bytes] = None
2089
+
2090
+ # process the path parameters
2091
+ # process the query parameters
2092
+ if organization_id is not None:
2093
+
2094
+ _query_params.append(('organization_id', organization_id))
2095
+
2096
+ # process the header parameters
2097
+ # process the form parameters
2098
+ # process the body parameter
2099
+
2100
+
2101
+
2102
+
2103
+ # authentication setting
2104
+ _auth_settings: List[str] = [
2105
+ 'QAnswer-Api-Key',
2106
+ 'Bearer'
2107
+ ]
2108
+
2109
+ return self.api_client.param_serialize(
2110
+ method='POST',
2111
+ resource_path='/api/branding/favicon/reset',
2112
+ path_params=_path_params,
2113
+ query_params=_query_params,
2114
+ header_params=_header_params,
2115
+ body=_body_params,
2116
+ post_params=_form_params,
2117
+ files=_files,
2118
+ auth_settings=_auth_settings,
2119
+ collection_formats=_collection_formats,
2120
+ _host=_host,
2121
+ _request_auth=_request_auth
2122
+ )
2123
+
2124
+
2125
+
2126
+
2127
+ @validate_call
2128
+ def reset_logo2(
2129
+ self,
2130
+ organization_id: Optional[StrictInt] = None,
2131
+ _request_timeout: Union[
2132
+ None,
2133
+ Annotated[StrictFloat, Field(gt=0)],
2134
+ Tuple[
2135
+ Annotated[StrictFloat, Field(gt=0)],
2136
+ Annotated[StrictFloat, Field(gt=0)]
2137
+ ]
2138
+ ] = None,
2139
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2140
+ _content_type: Optional[StrictStr] = None,
2141
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2142
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2143
+ ) -> None:
2144
+ """Set the logo across the application
2145
+
2146
+ The logo needs to be an image.
2147
+
2148
+ :param organization_id:
2149
+ :type organization_id: int
2150
+ :param _request_timeout: timeout setting for this request. If one
2151
+ number provided, it will be total request
2152
+ timeout. It can also be a pair (tuple) of
2153
+ (connection, read) timeouts.
2154
+ :type _request_timeout: int, tuple(int, int), optional
2155
+ :param _request_auth: set to override the auth_settings for an a single
2156
+ request; this effectively ignores the
2157
+ authentication in the spec for a single request.
2158
+ :type _request_auth: dict, optional
2159
+ :param _content_type: force content-type for the request.
2160
+ :type _content_type: str, Optional
2161
+ :param _headers: set to override the headers for a single
2162
+ request; this effectively ignores the headers
2163
+ in the spec for a single request.
2164
+ :type _headers: dict, optional
2165
+ :param _host_index: set to override the host_index for a single
2166
+ request; this effectively ignores the host_index
2167
+ in the spec for a single request.
2168
+ :type _host_index: int, optional
2169
+ :return: Returns the result object.
2170
+ """ # noqa: E501
2171
+
2172
+ _param = self._reset_logo2_serialize(
2173
+ organization_id=organization_id,
2174
+ _request_auth=_request_auth,
2175
+ _content_type=_content_type,
2176
+ _headers=_headers,
2177
+ _host_index=_host_index
2178
+ )
2179
+
2180
+ _response_types_map: Dict[str, Optional[str]] = {
2181
+ '200': None,
2182
+ }
2183
+ response_data = self.api_client.call_api(
2184
+ *_param,
2185
+ _request_timeout=_request_timeout
2186
+ )
2187
+ response_data.read()
2188
+ return self.api_client.response_deserialize(
2189
+ response_data=response_data,
2190
+ response_types_map=_response_types_map,
2191
+ ).data
2192
+
2193
+
2194
+ @validate_call
2195
+ def reset_logo2_with_http_info(
2196
+ self,
2197
+ organization_id: Optional[StrictInt] = None,
2198
+ _request_timeout: Union[
2199
+ None,
2200
+ Annotated[StrictFloat, Field(gt=0)],
2201
+ Tuple[
2202
+ Annotated[StrictFloat, Field(gt=0)],
2203
+ Annotated[StrictFloat, Field(gt=0)]
2204
+ ]
2205
+ ] = None,
2206
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2207
+ _content_type: Optional[StrictStr] = None,
2208
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2209
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2210
+ ) -> ApiResponse[None]:
2211
+ """Set the logo across the application
2212
+
2213
+ The logo needs to be an image.
2214
+
2215
+ :param organization_id:
2216
+ :type organization_id: int
2217
+ :param _request_timeout: timeout setting for this request. If one
2218
+ number provided, it will be total request
2219
+ timeout. It can also be a pair (tuple) of
2220
+ (connection, read) timeouts.
2221
+ :type _request_timeout: int, tuple(int, int), optional
2222
+ :param _request_auth: set to override the auth_settings for an a single
2223
+ request; this effectively ignores the
2224
+ authentication in the spec for a single request.
2225
+ :type _request_auth: dict, optional
2226
+ :param _content_type: force content-type for the request.
2227
+ :type _content_type: str, Optional
2228
+ :param _headers: set to override the headers for a single
2229
+ request; this effectively ignores the headers
2230
+ in the spec for a single request.
2231
+ :type _headers: dict, optional
2232
+ :param _host_index: set to override the host_index for a single
2233
+ request; this effectively ignores the host_index
2234
+ in the spec for a single request.
2235
+ :type _host_index: int, optional
2236
+ :return: Returns the result object.
2237
+ """ # noqa: E501
2238
+
2239
+ _param = self._reset_logo2_serialize(
2240
+ organization_id=organization_id,
2241
+ _request_auth=_request_auth,
2242
+ _content_type=_content_type,
2243
+ _headers=_headers,
2244
+ _host_index=_host_index
2245
+ )
2246
+
2247
+ _response_types_map: Dict[str, Optional[str]] = {
2248
+ '200': None,
2249
+ }
2250
+ response_data = self.api_client.call_api(
2251
+ *_param,
2252
+ _request_timeout=_request_timeout
2253
+ )
2254
+ response_data.read()
2255
+ return self.api_client.response_deserialize(
2256
+ response_data=response_data,
2257
+ response_types_map=_response_types_map,
2258
+ )
2259
+
2260
+
2261
+ @validate_call
2262
+ def reset_logo2_without_preload_content(
2263
+ self,
2264
+ organization_id: Optional[StrictInt] = None,
2265
+ _request_timeout: Union[
2266
+ None,
2267
+ Annotated[StrictFloat, Field(gt=0)],
2268
+ Tuple[
2269
+ Annotated[StrictFloat, Field(gt=0)],
2270
+ Annotated[StrictFloat, Field(gt=0)]
2271
+ ]
2272
+ ] = None,
2273
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2274
+ _content_type: Optional[StrictStr] = None,
2275
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2276
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2277
+ ) -> RESTResponseType:
2278
+ """Set the logo across the application
2279
+
2280
+ The logo needs to be an image.
2281
+
2282
+ :param organization_id:
2283
+ :type organization_id: int
2284
+ :param _request_timeout: timeout setting for this request. If one
2285
+ number provided, it will be total request
2286
+ timeout. It can also be a pair (tuple) of
2287
+ (connection, read) timeouts.
2288
+ :type _request_timeout: int, tuple(int, int), optional
2289
+ :param _request_auth: set to override the auth_settings for an a single
2290
+ request; this effectively ignores the
2291
+ authentication in the spec for a single request.
2292
+ :type _request_auth: dict, optional
2293
+ :param _content_type: force content-type for the request.
2294
+ :type _content_type: str, Optional
2295
+ :param _headers: set to override the headers for a single
2296
+ request; this effectively ignores the headers
2297
+ in the spec for a single request.
2298
+ :type _headers: dict, optional
2299
+ :param _host_index: set to override the host_index for a single
2300
+ request; this effectively ignores the host_index
2301
+ in the spec for a single request.
2302
+ :type _host_index: int, optional
2303
+ :return: Returns the result object.
2304
+ """ # noqa: E501
2305
+
2306
+ _param = self._reset_logo2_serialize(
2307
+ organization_id=organization_id,
2308
+ _request_auth=_request_auth,
2309
+ _content_type=_content_type,
2310
+ _headers=_headers,
2311
+ _host_index=_host_index
2312
+ )
2313
+
2314
+ _response_types_map: Dict[str, Optional[str]] = {
2315
+ '200': None,
2316
+ }
2317
+ response_data = self.api_client.call_api(
2318
+ *_param,
2319
+ _request_timeout=_request_timeout
2320
+ )
2321
+ return response_data.response
2322
+
2323
+
2324
+ def _reset_logo2_serialize(
2325
+ self,
2326
+ organization_id,
2327
+ _request_auth,
2328
+ _content_type,
2329
+ _headers,
2330
+ _host_index,
2331
+ ) -> RequestSerialized:
2332
+
2333
+ _host = None
2334
+
2335
+ _collection_formats: Dict[str, str] = {
2336
+ }
2337
+
2338
+ _path_params: Dict[str, str] = {}
2339
+ _query_params: List[Tuple[str, str]] = []
2340
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2341
+ _form_params: List[Tuple[str, str]] = []
2342
+ _files: Dict[
2343
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2344
+ ] = {}
2345
+ _body_params: Optional[bytes] = None
2346
+
2347
+ # process the path parameters
2348
+ # process the query parameters
2349
+ if organization_id is not None:
2350
+
2351
+ _query_params.append(('organization_id', organization_id))
2352
+
2353
+ # process the header parameters
2354
+ # process the form parameters
2355
+ # process the body parameter
2356
+
2357
+
2358
+
2359
+
2360
+ # authentication setting
2361
+ _auth_settings: List[str] = [
2362
+ 'QAnswer-Api-Key',
2363
+ 'Bearer'
2364
+ ]
2365
+
2366
+ return self.api_client.param_serialize(
2367
+ method='POST',
2368
+ resource_path='/api/branding/logo/reset',
2369
+ path_params=_path_params,
2370
+ query_params=_query_params,
2371
+ header_params=_header_params,
2372
+ body=_body_params,
2373
+ post_params=_form_params,
2374
+ files=_files,
2375
+ auth_settings=_auth_settings,
2376
+ collection_formats=_collection_formats,
2377
+ _host=_host,
2378
+ _request_auth=_request_auth
2379
+ )
2380
+
2381
+
2382
+
2383
+
2384
+ @validate_call
2385
+ def reset_logo_with_text(
2386
+ self,
2387
+ organization_id: Optional[StrictInt] = None,
2388
+ _request_timeout: Union[
2389
+ None,
2390
+ Annotated[StrictFloat, Field(gt=0)],
2391
+ Tuple[
2392
+ Annotated[StrictFloat, Field(gt=0)],
2393
+ Annotated[StrictFloat, Field(gt=0)]
2394
+ ]
2395
+ ] = None,
2396
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2397
+ _content_type: Optional[StrictStr] = None,
2398
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2399
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2400
+ ) -> None:
2401
+ """Set the logo with text across the application
2402
+
2403
+ The logo with text needs to be an image.
2404
+
2405
+ :param organization_id:
2406
+ :type organization_id: int
2407
+ :param _request_timeout: timeout setting for this request. If one
2408
+ number provided, it will be total request
2409
+ timeout. It can also be a pair (tuple) of
2410
+ (connection, read) timeouts.
2411
+ :type _request_timeout: int, tuple(int, int), optional
2412
+ :param _request_auth: set to override the auth_settings for an a single
2413
+ request; this effectively ignores the
2414
+ authentication in the spec for a single request.
2415
+ :type _request_auth: dict, optional
2416
+ :param _content_type: force content-type for the request.
2417
+ :type _content_type: str, Optional
2418
+ :param _headers: set to override the headers for a single
2419
+ request; this effectively ignores the headers
2420
+ in the spec for a single request.
2421
+ :type _headers: dict, optional
2422
+ :param _host_index: set to override the host_index for a single
2423
+ request; this effectively ignores the host_index
2424
+ in the spec for a single request.
2425
+ :type _host_index: int, optional
2426
+ :return: Returns the result object.
2427
+ """ # noqa: E501
2428
+
2429
+ _param = self._reset_logo_with_text_serialize(
2430
+ organization_id=organization_id,
2431
+ _request_auth=_request_auth,
2432
+ _content_type=_content_type,
2433
+ _headers=_headers,
2434
+ _host_index=_host_index
2435
+ )
2436
+
2437
+ _response_types_map: Dict[str, Optional[str]] = {
2438
+ '200': None,
2439
+ }
2440
+ response_data = self.api_client.call_api(
2441
+ *_param,
2442
+ _request_timeout=_request_timeout
2443
+ )
2444
+ response_data.read()
2445
+ return self.api_client.response_deserialize(
2446
+ response_data=response_data,
2447
+ response_types_map=_response_types_map,
2448
+ ).data
2449
+
2450
+
2451
+ @validate_call
2452
+ def reset_logo_with_text_with_http_info(
2453
+ self,
2454
+ organization_id: Optional[StrictInt] = None,
2455
+ _request_timeout: Union[
2456
+ None,
2457
+ Annotated[StrictFloat, Field(gt=0)],
2458
+ Tuple[
2459
+ Annotated[StrictFloat, Field(gt=0)],
2460
+ Annotated[StrictFloat, Field(gt=0)]
2461
+ ]
2462
+ ] = None,
2463
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2464
+ _content_type: Optional[StrictStr] = None,
2465
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2466
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2467
+ ) -> ApiResponse[None]:
2468
+ """Set the logo with text across the application
2469
+
2470
+ The logo with text needs to be an image.
2471
+
2472
+ :param organization_id:
2473
+ :type organization_id: int
2474
+ :param _request_timeout: timeout setting for this request. If one
2475
+ number provided, it will be total request
2476
+ timeout. It can also be a pair (tuple) of
2477
+ (connection, read) timeouts.
2478
+ :type _request_timeout: int, tuple(int, int), optional
2479
+ :param _request_auth: set to override the auth_settings for an a single
2480
+ request; this effectively ignores the
2481
+ authentication in the spec for a single request.
2482
+ :type _request_auth: dict, optional
2483
+ :param _content_type: force content-type for the request.
2484
+ :type _content_type: str, Optional
2485
+ :param _headers: set to override the headers for a single
2486
+ request; this effectively ignores the headers
2487
+ in the spec for a single request.
2488
+ :type _headers: dict, optional
2489
+ :param _host_index: set to override the host_index for a single
2490
+ request; this effectively ignores the host_index
2491
+ in the spec for a single request.
2492
+ :type _host_index: int, optional
2493
+ :return: Returns the result object.
2494
+ """ # noqa: E501
2495
+
2496
+ _param = self._reset_logo_with_text_serialize(
2497
+ organization_id=organization_id,
2498
+ _request_auth=_request_auth,
2499
+ _content_type=_content_type,
2500
+ _headers=_headers,
2501
+ _host_index=_host_index
2502
+ )
2503
+
2504
+ _response_types_map: Dict[str, Optional[str]] = {
2505
+ '200': None,
2506
+ }
2507
+ response_data = self.api_client.call_api(
2508
+ *_param,
2509
+ _request_timeout=_request_timeout
2510
+ )
2511
+ response_data.read()
2512
+ return self.api_client.response_deserialize(
2513
+ response_data=response_data,
2514
+ response_types_map=_response_types_map,
2515
+ )
2516
+
2517
+
2518
+ @validate_call
2519
+ def reset_logo_with_text_without_preload_content(
2520
+ self,
2521
+ organization_id: Optional[StrictInt] = None,
2522
+ _request_timeout: Union[
2523
+ None,
2524
+ Annotated[StrictFloat, Field(gt=0)],
2525
+ Tuple[
2526
+ Annotated[StrictFloat, Field(gt=0)],
2527
+ Annotated[StrictFloat, Field(gt=0)]
2528
+ ]
2529
+ ] = None,
2530
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2531
+ _content_type: Optional[StrictStr] = None,
2532
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2533
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2534
+ ) -> RESTResponseType:
2535
+ """Set the logo with text across the application
2536
+
2537
+ The logo with text needs to be an image.
2538
+
2539
+ :param organization_id:
2540
+ :type organization_id: int
2541
+ :param _request_timeout: timeout setting for this request. If one
2542
+ number provided, it will be total request
2543
+ timeout. It can also be a pair (tuple) of
2544
+ (connection, read) timeouts.
2545
+ :type _request_timeout: int, tuple(int, int), optional
2546
+ :param _request_auth: set to override the auth_settings for an a single
2547
+ request; this effectively ignores the
2548
+ authentication in the spec for a single request.
2549
+ :type _request_auth: dict, optional
2550
+ :param _content_type: force content-type for the request.
2551
+ :type _content_type: str, Optional
2552
+ :param _headers: set to override the headers for a single
2553
+ request; this effectively ignores the headers
2554
+ in the spec for a single request.
2555
+ :type _headers: dict, optional
2556
+ :param _host_index: set to override the host_index for a single
2557
+ request; this effectively ignores the host_index
2558
+ in the spec for a single request.
2559
+ :type _host_index: int, optional
2560
+ :return: Returns the result object.
2561
+ """ # noqa: E501
2562
+
2563
+ _param = self._reset_logo_with_text_serialize(
2564
+ organization_id=organization_id,
2565
+ _request_auth=_request_auth,
2566
+ _content_type=_content_type,
2567
+ _headers=_headers,
2568
+ _host_index=_host_index
2569
+ )
2570
+
2571
+ _response_types_map: Dict[str, Optional[str]] = {
2572
+ '200': None,
2573
+ }
2574
+ response_data = self.api_client.call_api(
2575
+ *_param,
2576
+ _request_timeout=_request_timeout
2577
+ )
2578
+ return response_data.response
2579
+
2580
+
2581
+ def _reset_logo_with_text_serialize(
2582
+ self,
2583
+ organization_id,
2584
+ _request_auth,
2585
+ _content_type,
2586
+ _headers,
2587
+ _host_index,
2588
+ ) -> RequestSerialized:
2589
+
2590
+ _host = None
2591
+
2592
+ _collection_formats: Dict[str, str] = {
2593
+ }
2594
+
2595
+ _path_params: Dict[str, str] = {}
2596
+ _query_params: List[Tuple[str, str]] = []
2597
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2598
+ _form_params: List[Tuple[str, str]] = []
2599
+ _files: Dict[
2600
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2601
+ ] = {}
2602
+ _body_params: Optional[bytes] = None
2603
+
2604
+ # process the path parameters
2605
+ # process the query parameters
2606
+ if organization_id is not None:
2607
+
2608
+ _query_params.append(('organization_id', organization_id))
2609
+
2610
+ # process the header parameters
2611
+ # process the form parameters
2612
+ # process the body parameter
2613
+
2614
+
2615
+
2616
+
2617
+ # authentication setting
2618
+ _auth_settings: List[str] = [
2619
+ 'QAnswer-Api-Key',
2620
+ 'Bearer'
2621
+ ]
2622
+
2623
+ return self.api_client.param_serialize(
2624
+ method='POST',
2625
+ resource_path='/api/branding/logo-with-text/reset',
2626
+ path_params=_path_params,
2627
+ query_params=_query_params,
2628
+ header_params=_header_params,
2629
+ body=_body_params,
2630
+ post_params=_form_params,
2631
+ files=_files,
2632
+ auth_settings=_auth_settings,
2633
+ collection_formats=_collection_formats,
2634
+ _host=_host,
2635
+ _request_auth=_request_auth
2636
+ )
2637
+
2638
+
2639
+
2640
+
2641
+ @validate_call
2642
+ def reset_system_message(
2643
+ self,
2644
+ organization_id: Optional[StrictInt] = None,
2645
+ _request_timeout: Union[
2646
+ None,
2647
+ Annotated[StrictFloat, Field(gt=0)],
2648
+ Tuple[
2649
+ Annotated[StrictFloat, Field(gt=0)],
2650
+ Annotated[StrictFloat, Field(gt=0)]
2651
+ ]
2652
+ ] = None,
2653
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2654
+ _content_type: Optional[StrictStr] = None,
2655
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2656
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2657
+ ) -> str:
2658
+ """Reset the the system message that is used for this organization
2659
+
2660
+
2661
+ :param organization_id:
2662
+ :type organization_id: int
2663
+ :param _request_timeout: timeout setting for this request. If one
2664
+ number provided, it will be total request
2665
+ timeout. It can also be a pair (tuple) of
2666
+ (connection, read) timeouts.
2667
+ :type _request_timeout: int, tuple(int, int), optional
2668
+ :param _request_auth: set to override the auth_settings for an a single
2669
+ request; this effectively ignores the
2670
+ authentication in the spec for a single request.
2671
+ :type _request_auth: dict, optional
2672
+ :param _content_type: force content-type for the request.
2673
+ :type _content_type: str, Optional
2674
+ :param _headers: set to override the headers for a single
2675
+ request; this effectively ignores the headers
2676
+ in the spec for a single request.
2677
+ :type _headers: dict, optional
2678
+ :param _host_index: set to override the host_index for a single
2679
+ request; this effectively ignores the host_index
2680
+ in the spec for a single request.
2681
+ :type _host_index: int, optional
2682
+ :return: Returns the result object.
2683
+ """ # noqa: E501
2684
+
2685
+ _param = self._reset_system_message_serialize(
2686
+ organization_id=organization_id,
2687
+ _request_auth=_request_auth,
2688
+ _content_type=_content_type,
2689
+ _headers=_headers,
2690
+ _host_index=_host_index
2691
+ )
2692
+
2693
+ _response_types_map: Dict[str, Optional[str]] = {
2694
+ '200': "str",
2695
+ }
2696
+ response_data = self.api_client.call_api(
2697
+ *_param,
2698
+ _request_timeout=_request_timeout
2699
+ )
2700
+ response_data.read()
2701
+ return self.api_client.response_deserialize(
2702
+ response_data=response_data,
2703
+ response_types_map=_response_types_map,
2704
+ ).data
2705
+
2706
+
2707
+ @validate_call
2708
+ def reset_system_message_with_http_info(
2709
+ self,
2710
+ organization_id: Optional[StrictInt] = None,
2711
+ _request_timeout: Union[
2712
+ None,
2713
+ Annotated[StrictFloat, Field(gt=0)],
2714
+ Tuple[
2715
+ Annotated[StrictFloat, Field(gt=0)],
2716
+ Annotated[StrictFloat, Field(gt=0)]
2717
+ ]
2718
+ ] = None,
2719
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2720
+ _content_type: Optional[StrictStr] = None,
2721
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2722
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2723
+ ) -> ApiResponse[str]:
2724
+ """Reset the the system message that is used for this organization
2725
+
2726
+
2727
+ :param organization_id:
2728
+ :type organization_id: int
2729
+ :param _request_timeout: timeout setting for this request. If one
2730
+ number provided, it will be total request
2731
+ timeout. It can also be a pair (tuple) of
2732
+ (connection, read) timeouts.
2733
+ :type _request_timeout: int, tuple(int, int), optional
2734
+ :param _request_auth: set to override the auth_settings for an a single
2735
+ request; this effectively ignores the
2736
+ authentication in the spec for a single request.
2737
+ :type _request_auth: dict, optional
2738
+ :param _content_type: force content-type for the request.
2739
+ :type _content_type: str, Optional
2740
+ :param _headers: set to override the headers for a single
2741
+ request; this effectively ignores the headers
2742
+ in the spec for a single request.
2743
+ :type _headers: dict, optional
2744
+ :param _host_index: set to override the host_index for a single
2745
+ request; this effectively ignores the host_index
2746
+ in the spec for a single request.
2747
+ :type _host_index: int, optional
2748
+ :return: Returns the result object.
2749
+ """ # noqa: E501
2750
+
2751
+ _param = self._reset_system_message_serialize(
2752
+ organization_id=organization_id,
2753
+ _request_auth=_request_auth,
2754
+ _content_type=_content_type,
2755
+ _headers=_headers,
2756
+ _host_index=_host_index
2757
+ )
2758
+
2759
+ _response_types_map: Dict[str, Optional[str]] = {
2760
+ '200': "str",
2761
+ }
2762
+ response_data = self.api_client.call_api(
2763
+ *_param,
2764
+ _request_timeout=_request_timeout
2765
+ )
2766
+ response_data.read()
2767
+ return self.api_client.response_deserialize(
2768
+ response_data=response_data,
2769
+ response_types_map=_response_types_map,
2770
+ )
2771
+
2772
+
2773
+ @validate_call
2774
+ def reset_system_message_without_preload_content(
2775
+ self,
2776
+ organization_id: Optional[StrictInt] = None,
2777
+ _request_timeout: Union[
2778
+ None,
2779
+ Annotated[StrictFloat, Field(gt=0)],
2780
+ Tuple[
2781
+ Annotated[StrictFloat, Field(gt=0)],
2782
+ Annotated[StrictFloat, Field(gt=0)]
2783
+ ]
2784
+ ] = None,
2785
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2786
+ _content_type: Optional[StrictStr] = None,
2787
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2788
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2789
+ ) -> RESTResponseType:
2790
+ """Reset the the system message that is used for this organization
2791
+
2792
+
2793
+ :param organization_id:
2794
+ :type organization_id: int
2795
+ :param _request_timeout: timeout setting for this request. If one
2796
+ number provided, it will be total request
2797
+ timeout. It can also be a pair (tuple) of
2798
+ (connection, read) timeouts.
2799
+ :type _request_timeout: int, tuple(int, int), optional
2800
+ :param _request_auth: set to override the auth_settings for an a single
2801
+ request; this effectively ignores the
2802
+ authentication in the spec for a single request.
2803
+ :type _request_auth: dict, optional
2804
+ :param _content_type: force content-type for the request.
2805
+ :type _content_type: str, Optional
2806
+ :param _headers: set to override the headers for a single
2807
+ request; this effectively ignores the headers
2808
+ in the spec for a single request.
2809
+ :type _headers: dict, optional
2810
+ :param _host_index: set to override the host_index for a single
2811
+ request; this effectively ignores the host_index
2812
+ in the spec for a single request.
2813
+ :type _host_index: int, optional
2814
+ :return: Returns the result object.
2815
+ """ # noqa: E501
2816
+
2817
+ _param = self._reset_system_message_serialize(
2818
+ organization_id=organization_id,
2819
+ _request_auth=_request_auth,
2820
+ _content_type=_content_type,
2821
+ _headers=_headers,
2822
+ _host_index=_host_index
2823
+ )
2824
+
2825
+ _response_types_map: Dict[str, Optional[str]] = {
2826
+ '200': "str",
2827
+ }
2828
+ response_data = self.api_client.call_api(
2829
+ *_param,
2830
+ _request_timeout=_request_timeout
2831
+ )
2832
+ return response_data.response
2833
+
2834
+
2835
+ def _reset_system_message_serialize(
2836
+ self,
2837
+ organization_id,
2838
+ _request_auth,
2839
+ _content_type,
2840
+ _headers,
2841
+ _host_index,
2842
+ ) -> RequestSerialized:
2843
+
2844
+ _host = None
2845
+
2846
+ _collection_formats: Dict[str, str] = {
2847
+ }
2848
+
2849
+ _path_params: Dict[str, str] = {}
2850
+ _query_params: List[Tuple[str, str]] = []
2851
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2852
+ _form_params: List[Tuple[str, str]] = []
2853
+ _files: Dict[
2854
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2855
+ ] = {}
2856
+ _body_params: Optional[bytes] = None
2857
+
2858
+ # process the path parameters
2859
+ # process the query parameters
2860
+ if organization_id is not None:
2861
+
2862
+ _query_params.append(('organization_id', organization_id))
2863
+
2864
+ # process the header parameters
2865
+ # process the form parameters
2866
+ # process the body parameter
2867
+
2868
+
2869
+ # set the HTTP header `Accept`
2870
+ if 'Accept' not in _header_params:
2871
+ _header_params['Accept'] = self.api_client.select_header_accept(
2872
+ [
2873
+ '*/*'
2874
+ ]
2875
+ )
2876
+
2877
+
2878
+ # authentication setting
2879
+ _auth_settings: List[str] = [
2880
+ 'QAnswer-Api-Key',
2881
+ 'Bearer'
2882
+ ]
2883
+
2884
+ return self.api_client.param_serialize(
2885
+ method='POST',
2886
+ resource_path='/api/branding/system-message/reset',
2887
+ path_params=_path_params,
2888
+ query_params=_query_params,
2889
+ header_params=_header_params,
2890
+ body=_body_params,
2891
+ post_params=_form_params,
2892
+ files=_files,
2893
+ auth_settings=_auth_settings,
2894
+ collection_formats=_collection_formats,
2895
+ _host=_host,
2896
+ _request_auth=_request_auth
2897
+ )
2898
+
2899
+
2900
+
2901
+
2902
+ @validate_call
2903
+ def set_app_title(
2904
+ self,
2905
+ app_title: StrictStr,
2906
+ organization_id: Optional[StrictInt] = None,
2907
+ _request_timeout: Union[
2908
+ None,
2909
+ Annotated[StrictFloat, Field(gt=0)],
2910
+ Tuple[
2911
+ Annotated[StrictFloat, Field(gt=0)],
2912
+ Annotated[StrictFloat, Field(gt=0)]
2913
+ ]
2914
+ ] = None,
2915
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2916
+ _content_type: Optional[StrictStr] = None,
2917
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2918
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2919
+ ) -> None:
2920
+ """Set the app title and the system message that is used for this organization
2921
+
2922
+
2923
+ :param app_title: (required)
2924
+ :type app_title: str
2925
+ :param organization_id:
2926
+ :type organization_id: int
2927
+ :param _request_timeout: timeout setting for this request. If one
2928
+ number provided, it will be total request
2929
+ timeout. It can also be a pair (tuple) of
2930
+ (connection, read) timeouts.
2931
+ :type _request_timeout: int, tuple(int, int), optional
2932
+ :param _request_auth: set to override the auth_settings for an a single
2933
+ request; this effectively ignores the
2934
+ authentication in the spec for a single request.
2935
+ :type _request_auth: dict, optional
2936
+ :param _content_type: force content-type for the request.
2937
+ :type _content_type: str, Optional
2938
+ :param _headers: set to override the headers for a single
2939
+ request; this effectively ignores the headers
2940
+ in the spec for a single request.
2941
+ :type _headers: dict, optional
2942
+ :param _host_index: set to override the host_index for a single
2943
+ request; this effectively ignores the host_index
2944
+ in the spec for a single request.
2945
+ :type _host_index: int, optional
2946
+ :return: Returns the result object.
2947
+ """ # noqa: E501
2948
+
2949
+ _param = self._set_app_title_serialize(
2950
+ app_title=app_title,
2951
+ organization_id=organization_id,
2952
+ _request_auth=_request_auth,
2953
+ _content_type=_content_type,
2954
+ _headers=_headers,
2955
+ _host_index=_host_index
2956
+ )
2957
+
2958
+ _response_types_map: Dict[str, Optional[str]] = {
2959
+ '200': None,
2960
+ }
2961
+ response_data = self.api_client.call_api(
2962
+ *_param,
2963
+ _request_timeout=_request_timeout
2964
+ )
2965
+ response_data.read()
2966
+ return self.api_client.response_deserialize(
2967
+ response_data=response_data,
2968
+ response_types_map=_response_types_map,
2969
+ ).data
2970
+
2971
+
2972
+ @validate_call
2973
+ def set_app_title_with_http_info(
2974
+ self,
2975
+ app_title: StrictStr,
2976
+ organization_id: Optional[StrictInt] = None,
2977
+ _request_timeout: Union[
2978
+ None,
2979
+ Annotated[StrictFloat, Field(gt=0)],
2980
+ Tuple[
2981
+ Annotated[StrictFloat, Field(gt=0)],
2982
+ Annotated[StrictFloat, Field(gt=0)]
2983
+ ]
2984
+ ] = None,
2985
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2986
+ _content_type: Optional[StrictStr] = None,
2987
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2988
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2989
+ ) -> ApiResponse[None]:
2990
+ """Set the app title and the system message that is used for this organization
2991
+
2992
+
2993
+ :param app_title: (required)
2994
+ :type app_title: str
2995
+ :param organization_id:
2996
+ :type organization_id: int
2997
+ :param _request_timeout: timeout setting for this request. If one
2998
+ number provided, it will be total request
2999
+ timeout. It can also be a pair (tuple) of
3000
+ (connection, read) timeouts.
3001
+ :type _request_timeout: int, tuple(int, int), optional
3002
+ :param _request_auth: set to override the auth_settings for an a single
3003
+ request; this effectively ignores the
3004
+ authentication in the spec for a single request.
3005
+ :type _request_auth: dict, optional
3006
+ :param _content_type: force content-type for the request.
3007
+ :type _content_type: str, Optional
3008
+ :param _headers: set to override the headers for a single
3009
+ request; this effectively ignores the headers
3010
+ in the spec for a single request.
3011
+ :type _headers: dict, optional
3012
+ :param _host_index: set to override the host_index for a single
3013
+ request; this effectively ignores the host_index
3014
+ in the spec for a single request.
3015
+ :type _host_index: int, optional
3016
+ :return: Returns the result object.
3017
+ """ # noqa: E501
3018
+
3019
+ _param = self._set_app_title_serialize(
3020
+ app_title=app_title,
3021
+ organization_id=organization_id,
3022
+ _request_auth=_request_auth,
3023
+ _content_type=_content_type,
3024
+ _headers=_headers,
3025
+ _host_index=_host_index
3026
+ )
3027
+
3028
+ _response_types_map: Dict[str, Optional[str]] = {
3029
+ '200': None,
3030
+ }
3031
+ response_data = self.api_client.call_api(
3032
+ *_param,
3033
+ _request_timeout=_request_timeout
3034
+ )
3035
+ response_data.read()
3036
+ return self.api_client.response_deserialize(
3037
+ response_data=response_data,
3038
+ response_types_map=_response_types_map,
3039
+ )
3040
+
3041
+
3042
+ @validate_call
3043
+ def set_app_title_without_preload_content(
3044
+ self,
3045
+ app_title: StrictStr,
3046
+ organization_id: Optional[StrictInt] = None,
3047
+ _request_timeout: Union[
3048
+ None,
3049
+ Annotated[StrictFloat, Field(gt=0)],
3050
+ Tuple[
3051
+ Annotated[StrictFloat, Field(gt=0)],
3052
+ Annotated[StrictFloat, Field(gt=0)]
3053
+ ]
3054
+ ] = None,
3055
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3056
+ _content_type: Optional[StrictStr] = None,
3057
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3058
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3059
+ ) -> RESTResponseType:
3060
+ """Set the app title and the system message that is used for this organization
3061
+
3062
+
3063
+ :param app_title: (required)
3064
+ :type app_title: str
3065
+ :param organization_id:
3066
+ :type organization_id: int
3067
+ :param _request_timeout: timeout setting for this request. If one
3068
+ number provided, it will be total request
3069
+ timeout. It can also be a pair (tuple) of
3070
+ (connection, read) timeouts.
3071
+ :type _request_timeout: int, tuple(int, int), optional
3072
+ :param _request_auth: set to override the auth_settings for an a single
3073
+ request; this effectively ignores the
3074
+ authentication in the spec for a single request.
3075
+ :type _request_auth: dict, optional
3076
+ :param _content_type: force content-type for the request.
3077
+ :type _content_type: str, Optional
3078
+ :param _headers: set to override the headers for a single
3079
+ request; this effectively ignores the headers
3080
+ in the spec for a single request.
3081
+ :type _headers: dict, optional
3082
+ :param _host_index: set to override the host_index for a single
3083
+ request; this effectively ignores the host_index
3084
+ in the spec for a single request.
3085
+ :type _host_index: int, optional
3086
+ :return: Returns the result object.
3087
+ """ # noqa: E501
3088
+
3089
+ _param = self._set_app_title_serialize(
3090
+ app_title=app_title,
3091
+ organization_id=organization_id,
3092
+ _request_auth=_request_auth,
3093
+ _content_type=_content_type,
3094
+ _headers=_headers,
3095
+ _host_index=_host_index
3096
+ )
3097
+
3098
+ _response_types_map: Dict[str, Optional[str]] = {
3099
+ '200': None,
3100
+ }
3101
+ response_data = self.api_client.call_api(
3102
+ *_param,
3103
+ _request_timeout=_request_timeout
3104
+ )
3105
+ return response_data.response
3106
+
3107
+
3108
+ def _set_app_title_serialize(
3109
+ self,
3110
+ app_title,
3111
+ organization_id,
3112
+ _request_auth,
3113
+ _content_type,
3114
+ _headers,
3115
+ _host_index,
3116
+ ) -> RequestSerialized:
3117
+
3118
+ _host = None
3119
+
3120
+ _collection_formats: Dict[str, str] = {
3121
+ }
3122
+
3123
+ _path_params: Dict[str, str] = {}
3124
+ _query_params: List[Tuple[str, str]] = []
3125
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3126
+ _form_params: List[Tuple[str, str]] = []
3127
+ _files: Dict[
3128
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3129
+ ] = {}
3130
+ _body_params: Optional[bytes] = None
3131
+
3132
+ # process the path parameters
3133
+ # process the query parameters
3134
+ if organization_id is not None:
3135
+
3136
+ _query_params.append(('organization_id', organization_id))
3137
+
3138
+ if app_title is not None:
3139
+
3140
+ _query_params.append(('app_title', app_title))
3141
+
3142
+ # process the header parameters
3143
+ # process the form parameters
3144
+ # process the body parameter
3145
+
3146
+
3147
+
3148
+
3149
+ # authentication setting
3150
+ _auth_settings: List[str] = [
3151
+ 'QAnswer-Api-Key',
3152
+ 'Bearer'
3153
+ ]
3154
+
3155
+ return self.api_client.param_serialize(
3156
+ method='POST',
3157
+ resource_path='/api/branding/app-title',
3158
+ path_params=_path_params,
3159
+ query_params=_query_params,
3160
+ header_params=_header_params,
3161
+ body=_body_params,
3162
+ post_params=_form_params,
3163
+ files=_files,
3164
+ auth_settings=_auth_settings,
3165
+ collection_formats=_collection_formats,
3166
+ _host=_host,
3167
+ _request_auth=_request_auth
3168
+ )
3169
+
3170
+
3171
+
3172
+
3173
+ @validate_call
3174
+ def set_entity_description(
3175
+ self,
3176
+ entity_description_dto: EntityDescriptionDto,
3177
+ organization_id: Optional[StrictInt] = None,
3178
+ _request_timeout: Union[
3179
+ None,
3180
+ Annotated[StrictFloat, Field(gt=0)],
3181
+ Tuple[
3182
+ Annotated[StrictFloat, Field(gt=0)],
3183
+ Annotated[StrictFloat, Field(gt=0)]
3184
+ ]
3185
+ ] = None,
3186
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3187
+ _content_type: Optional[StrictStr] = None,
3188
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3189
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3190
+ ) -> None:
3191
+ """Set the entity description accross the application
3192
+
3193
+
3194
+ :param entity_description_dto: (required)
3195
+ :type entity_description_dto: EntityDescriptionDto
3196
+ :param organization_id:
3197
+ :type organization_id: int
3198
+ :param _request_timeout: timeout setting for this request. If one
3199
+ number provided, it will be total request
3200
+ timeout. It can also be a pair (tuple) of
3201
+ (connection, read) timeouts.
3202
+ :type _request_timeout: int, tuple(int, int), optional
3203
+ :param _request_auth: set to override the auth_settings for an a single
3204
+ request; this effectively ignores the
3205
+ authentication in the spec for a single request.
3206
+ :type _request_auth: dict, optional
3207
+ :param _content_type: force content-type for the request.
3208
+ :type _content_type: str, Optional
3209
+ :param _headers: set to override the headers for a single
3210
+ request; this effectively ignores the headers
3211
+ in the spec for a single request.
3212
+ :type _headers: dict, optional
3213
+ :param _host_index: set to override the host_index for a single
3214
+ request; this effectively ignores the host_index
3215
+ in the spec for a single request.
3216
+ :type _host_index: int, optional
3217
+ :return: Returns the result object.
3218
+ """ # noqa: E501
3219
+
3220
+ _param = self._set_entity_description_serialize(
3221
+ entity_description_dto=entity_description_dto,
3222
+ organization_id=organization_id,
3223
+ _request_auth=_request_auth,
3224
+ _content_type=_content_type,
3225
+ _headers=_headers,
3226
+ _host_index=_host_index
3227
+ )
3228
+
3229
+ _response_types_map: Dict[str, Optional[str]] = {
3230
+ '200': None,
3231
+ }
3232
+ response_data = self.api_client.call_api(
3233
+ *_param,
3234
+ _request_timeout=_request_timeout
3235
+ )
3236
+ response_data.read()
3237
+ return self.api_client.response_deserialize(
3238
+ response_data=response_data,
3239
+ response_types_map=_response_types_map,
3240
+ ).data
3241
+
3242
+
3243
+ @validate_call
3244
+ def set_entity_description_with_http_info(
3245
+ self,
3246
+ entity_description_dto: EntityDescriptionDto,
3247
+ organization_id: Optional[StrictInt] = None,
3248
+ _request_timeout: Union[
3249
+ None,
3250
+ Annotated[StrictFloat, Field(gt=0)],
3251
+ Tuple[
3252
+ Annotated[StrictFloat, Field(gt=0)],
3253
+ Annotated[StrictFloat, Field(gt=0)]
3254
+ ]
3255
+ ] = None,
3256
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3257
+ _content_type: Optional[StrictStr] = None,
3258
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3259
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3260
+ ) -> ApiResponse[None]:
3261
+ """Set the entity description accross the application
3262
+
3263
+
3264
+ :param entity_description_dto: (required)
3265
+ :type entity_description_dto: EntityDescriptionDto
3266
+ :param organization_id:
3267
+ :type organization_id: int
3268
+ :param _request_timeout: timeout setting for this request. If one
3269
+ number provided, it will be total request
3270
+ timeout. It can also be a pair (tuple) of
3271
+ (connection, read) timeouts.
3272
+ :type _request_timeout: int, tuple(int, int), optional
3273
+ :param _request_auth: set to override the auth_settings for an a single
3274
+ request; this effectively ignores the
3275
+ authentication in the spec for a single request.
3276
+ :type _request_auth: dict, optional
3277
+ :param _content_type: force content-type for the request.
3278
+ :type _content_type: str, Optional
3279
+ :param _headers: set to override the headers for a single
3280
+ request; this effectively ignores the headers
3281
+ in the spec for a single request.
3282
+ :type _headers: dict, optional
3283
+ :param _host_index: set to override the host_index for a single
3284
+ request; this effectively ignores the host_index
3285
+ in the spec for a single request.
3286
+ :type _host_index: int, optional
3287
+ :return: Returns the result object.
3288
+ """ # noqa: E501
3289
+
3290
+ _param = self._set_entity_description_serialize(
3291
+ entity_description_dto=entity_description_dto,
3292
+ organization_id=organization_id,
3293
+ _request_auth=_request_auth,
3294
+ _content_type=_content_type,
3295
+ _headers=_headers,
3296
+ _host_index=_host_index
3297
+ )
3298
+
3299
+ _response_types_map: Dict[str, Optional[str]] = {
3300
+ '200': None,
3301
+ }
3302
+ response_data = self.api_client.call_api(
3303
+ *_param,
3304
+ _request_timeout=_request_timeout
3305
+ )
3306
+ response_data.read()
3307
+ return self.api_client.response_deserialize(
3308
+ response_data=response_data,
3309
+ response_types_map=_response_types_map,
3310
+ )
3311
+
3312
+
3313
+ @validate_call
3314
+ def set_entity_description_without_preload_content(
3315
+ self,
3316
+ entity_description_dto: EntityDescriptionDto,
3317
+ organization_id: Optional[StrictInt] = None,
3318
+ _request_timeout: Union[
3319
+ None,
3320
+ Annotated[StrictFloat, Field(gt=0)],
3321
+ Tuple[
3322
+ Annotated[StrictFloat, Field(gt=0)],
3323
+ Annotated[StrictFloat, Field(gt=0)]
3324
+ ]
3325
+ ] = None,
3326
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3327
+ _content_type: Optional[StrictStr] = None,
3328
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3329
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3330
+ ) -> RESTResponseType:
3331
+ """Set the entity description accross the application
3332
+
3333
+
3334
+ :param entity_description_dto: (required)
3335
+ :type entity_description_dto: EntityDescriptionDto
3336
+ :param organization_id:
3337
+ :type organization_id: int
3338
+ :param _request_timeout: timeout setting for this request. If one
3339
+ number provided, it will be total request
3340
+ timeout. It can also be a pair (tuple) of
3341
+ (connection, read) timeouts.
3342
+ :type _request_timeout: int, tuple(int, int), optional
3343
+ :param _request_auth: set to override the auth_settings for an a single
3344
+ request; this effectively ignores the
3345
+ authentication in the spec for a single request.
3346
+ :type _request_auth: dict, optional
3347
+ :param _content_type: force content-type for the request.
3348
+ :type _content_type: str, Optional
3349
+ :param _headers: set to override the headers for a single
3350
+ request; this effectively ignores the headers
3351
+ in the spec for a single request.
3352
+ :type _headers: dict, optional
3353
+ :param _host_index: set to override the host_index for a single
3354
+ request; this effectively ignores the host_index
3355
+ in the spec for a single request.
3356
+ :type _host_index: int, optional
3357
+ :return: Returns the result object.
3358
+ """ # noqa: E501
3359
+
3360
+ _param = self._set_entity_description_serialize(
3361
+ entity_description_dto=entity_description_dto,
3362
+ organization_id=organization_id,
3363
+ _request_auth=_request_auth,
3364
+ _content_type=_content_type,
3365
+ _headers=_headers,
3366
+ _host_index=_host_index
3367
+ )
3368
+
3369
+ _response_types_map: Dict[str, Optional[str]] = {
3370
+ '200': None,
3371
+ }
3372
+ response_data = self.api_client.call_api(
3373
+ *_param,
3374
+ _request_timeout=_request_timeout
3375
+ )
3376
+ return response_data.response
3377
+
3378
+
3379
+ def _set_entity_description_serialize(
3380
+ self,
3381
+ entity_description_dto,
3382
+ organization_id,
3383
+ _request_auth,
3384
+ _content_type,
3385
+ _headers,
3386
+ _host_index,
3387
+ ) -> RequestSerialized:
3388
+
3389
+ _host = None
3390
+
3391
+ _collection_formats: Dict[str, str] = {
3392
+ }
3393
+
3394
+ _path_params: Dict[str, str] = {}
3395
+ _query_params: List[Tuple[str, str]] = []
3396
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3397
+ _form_params: List[Tuple[str, str]] = []
3398
+ _files: Dict[
3399
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3400
+ ] = {}
3401
+ _body_params: Optional[bytes] = None
3402
+
3403
+ # process the path parameters
3404
+ # process the query parameters
3405
+ if organization_id is not None:
3406
+
3407
+ _query_params.append(('organization_id', organization_id))
3408
+
3409
+ # process the header parameters
3410
+ # process the form parameters
3411
+ # process the body parameter
3412
+ if entity_description_dto is not None:
3413
+ _body_params = entity_description_dto
3414
+
3415
+
3416
+
3417
+ # set the HTTP header `Content-Type`
3418
+ if _content_type:
3419
+ _header_params['Content-Type'] = _content_type
3420
+ else:
3421
+ _default_content_type = (
3422
+ self.api_client.select_header_content_type(
3423
+ [
3424
+ 'application/json'
3425
+ ]
3426
+ )
3427
+ )
3428
+ if _default_content_type is not None:
3429
+ _header_params['Content-Type'] = _default_content_type
3430
+
3431
+ # authentication setting
3432
+ _auth_settings: List[str] = [
3433
+ 'QAnswer-Api-Key',
3434
+ 'Bearer'
3435
+ ]
3436
+
3437
+ return self.api_client.param_serialize(
3438
+ method='POST',
3439
+ resource_path='/api/branding/description',
3440
+ path_params=_path_params,
3441
+ query_params=_query_params,
3442
+ header_params=_header_params,
3443
+ body=_body_params,
3444
+ post_params=_form_params,
3445
+ files=_files,
3446
+ auth_settings=_auth_settings,
3447
+ collection_formats=_collection_formats,
3448
+ _host=_host,
3449
+ _request_auth=_request_auth
3450
+ )
3451
+
3452
+
3453
+
3454
+
3455
+ @validate_call
3456
+ def set_favicon(
3457
+ self,
3458
+ favicon: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3459
+ organization_id: Optional[StrictInt] = None,
3460
+ _request_timeout: Union[
3461
+ None,
3462
+ Annotated[StrictFloat, Field(gt=0)],
3463
+ Tuple[
3464
+ Annotated[StrictFloat, Field(gt=0)],
3465
+ Annotated[StrictFloat, Field(gt=0)]
3466
+ ]
3467
+ ] = None,
3468
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3469
+ _content_type: Optional[StrictStr] = None,
3470
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3471
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3472
+ ) -> None:
3473
+ """Set the favicon across the application
3474
+
3475
+ The favicon needs to be an image.
3476
+
3477
+ :param favicon: (required)
3478
+ :type favicon: bytearray
3479
+ :param organization_id:
3480
+ :type organization_id: int
3481
+ :param _request_timeout: timeout setting for this request. If one
3482
+ number provided, it will be total request
3483
+ timeout. It can also be a pair (tuple) of
3484
+ (connection, read) timeouts.
3485
+ :type _request_timeout: int, tuple(int, int), optional
3486
+ :param _request_auth: set to override the auth_settings for an a single
3487
+ request; this effectively ignores the
3488
+ authentication in the spec for a single request.
3489
+ :type _request_auth: dict, optional
3490
+ :param _content_type: force content-type for the request.
3491
+ :type _content_type: str, Optional
3492
+ :param _headers: set to override the headers for a single
3493
+ request; this effectively ignores the headers
3494
+ in the spec for a single request.
3495
+ :type _headers: dict, optional
3496
+ :param _host_index: set to override the host_index for a single
3497
+ request; this effectively ignores the host_index
3498
+ in the spec for a single request.
3499
+ :type _host_index: int, optional
3500
+ :return: Returns the result object.
3501
+ """ # noqa: E501
3502
+
3503
+ _param = self._set_favicon_serialize(
3504
+ favicon=favicon,
3505
+ organization_id=organization_id,
3506
+ _request_auth=_request_auth,
3507
+ _content_type=_content_type,
3508
+ _headers=_headers,
3509
+ _host_index=_host_index
3510
+ )
3511
+
3512
+ _response_types_map: Dict[str, Optional[str]] = {
3513
+ '200': None,
3514
+ }
3515
+ response_data = self.api_client.call_api(
3516
+ *_param,
3517
+ _request_timeout=_request_timeout
3518
+ )
3519
+ response_data.read()
3520
+ return self.api_client.response_deserialize(
3521
+ response_data=response_data,
3522
+ response_types_map=_response_types_map,
3523
+ ).data
3524
+
3525
+
3526
+ @validate_call
3527
+ def set_favicon_with_http_info(
3528
+ self,
3529
+ favicon: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3530
+ organization_id: Optional[StrictInt] = None,
3531
+ _request_timeout: Union[
3532
+ None,
3533
+ Annotated[StrictFloat, Field(gt=0)],
3534
+ Tuple[
3535
+ Annotated[StrictFloat, Field(gt=0)],
3536
+ Annotated[StrictFloat, Field(gt=0)]
3537
+ ]
3538
+ ] = None,
3539
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3540
+ _content_type: Optional[StrictStr] = None,
3541
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3542
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3543
+ ) -> ApiResponse[None]:
3544
+ """Set the favicon across the application
3545
+
3546
+ The favicon needs to be an image.
3547
+
3548
+ :param favicon: (required)
3549
+ :type favicon: bytearray
3550
+ :param organization_id:
3551
+ :type organization_id: int
3552
+ :param _request_timeout: timeout setting for this request. If one
3553
+ number provided, it will be total request
3554
+ timeout. It can also be a pair (tuple) of
3555
+ (connection, read) timeouts.
3556
+ :type _request_timeout: int, tuple(int, int), optional
3557
+ :param _request_auth: set to override the auth_settings for an a single
3558
+ request; this effectively ignores the
3559
+ authentication in the spec for a single request.
3560
+ :type _request_auth: dict, optional
3561
+ :param _content_type: force content-type for the request.
3562
+ :type _content_type: str, Optional
3563
+ :param _headers: set to override the headers for a single
3564
+ request; this effectively ignores the headers
3565
+ in the spec for a single request.
3566
+ :type _headers: dict, optional
3567
+ :param _host_index: set to override the host_index for a single
3568
+ request; this effectively ignores the host_index
3569
+ in the spec for a single request.
3570
+ :type _host_index: int, optional
3571
+ :return: Returns the result object.
3572
+ """ # noqa: E501
3573
+
3574
+ _param = self._set_favicon_serialize(
3575
+ favicon=favicon,
3576
+ organization_id=organization_id,
3577
+ _request_auth=_request_auth,
3578
+ _content_type=_content_type,
3579
+ _headers=_headers,
3580
+ _host_index=_host_index
3581
+ )
3582
+
3583
+ _response_types_map: Dict[str, Optional[str]] = {
3584
+ '200': None,
3585
+ }
3586
+ response_data = self.api_client.call_api(
3587
+ *_param,
3588
+ _request_timeout=_request_timeout
3589
+ )
3590
+ response_data.read()
3591
+ return self.api_client.response_deserialize(
3592
+ response_data=response_data,
3593
+ response_types_map=_response_types_map,
3594
+ )
3595
+
3596
+
3597
+ @validate_call
3598
+ def set_favicon_without_preload_content(
3599
+ self,
3600
+ favicon: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3601
+ organization_id: Optional[StrictInt] = None,
3602
+ _request_timeout: Union[
3603
+ None,
3604
+ Annotated[StrictFloat, Field(gt=0)],
3605
+ Tuple[
3606
+ Annotated[StrictFloat, Field(gt=0)],
3607
+ Annotated[StrictFloat, Field(gt=0)]
3608
+ ]
3609
+ ] = None,
3610
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3611
+ _content_type: Optional[StrictStr] = None,
3612
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3613
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3614
+ ) -> RESTResponseType:
3615
+ """Set the favicon across the application
3616
+
3617
+ The favicon needs to be an image.
3618
+
3619
+ :param favicon: (required)
3620
+ :type favicon: bytearray
3621
+ :param organization_id:
3622
+ :type organization_id: int
3623
+ :param _request_timeout: timeout setting for this request. If one
3624
+ number provided, it will be total request
3625
+ timeout. It can also be a pair (tuple) of
3626
+ (connection, read) timeouts.
3627
+ :type _request_timeout: int, tuple(int, int), optional
3628
+ :param _request_auth: set to override the auth_settings for an a single
3629
+ request; this effectively ignores the
3630
+ authentication in the spec for a single request.
3631
+ :type _request_auth: dict, optional
3632
+ :param _content_type: force content-type for the request.
3633
+ :type _content_type: str, Optional
3634
+ :param _headers: set to override the headers for a single
3635
+ request; this effectively ignores the headers
3636
+ in the spec for a single request.
3637
+ :type _headers: dict, optional
3638
+ :param _host_index: set to override the host_index for a single
3639
+ request; this effectively ignores the host_index
3640
+ in the spec for a single request.
3641
+ :type _host_index: int, optional
3642
+ :return: Returns the result object.
3643
+ """ # noqa: E501
3644
+
3645
+ _param = self._set_favicon_serialize(
3646
+ favicon=favicon,
3647
+ organization_id=organization_id,
3648
+ _request_auth=_request_auth,
3649
+ _content_type=_content_type,
3650
+ _headers=_headers,
3651
+ _host_index=_host_index
3652
+ )
3653
+
3654
+ _response_types_map: Dict[str, Optional[str]] = {
3655
+ '200': None,
3656
+ }
3657
+ response_data = self.api_client.call_api(
3658
+ *_param,
3659
+ _request_timeout=_request_timeout
3660
+ )
3661
+ return response_data.response
3662
+
3663
+
3664
+ def _set_favicon_serialize(
3665
+ self,
3666
+ favicon,
3667
+ organization_id,
3668
+ _request_auth,
3669
+ _content_type,
3670
+ _headers,
3671
+ _host_index,
3672
+ ) -> RequestSerialized:
3673
+
3674
+ _host = None
3675
+
3676
+ _collection_formats: Dict[str, str] = {
3677
+ }
3678
+
3679
+ _path_params: Dict[str, str] = {}
3680
+ _query_params: List[Tuple[str, str]] = []
3681
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3682
+ _form_params: List[Tuple[str, str]] = []
3683
+ _files: Dict[
3684
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3685
+ ] = {}
3686
+ _body_params: Optional[bytes] = None
3687
+
3688
+ # process the path parameters
3689
+ # process the query parameters
3690
+ if organization_id is not None:
3691
+
3692
+ _query_params.append(('organization_id', organization_id))
3693
+
3694
+ # process the header parameters
3695
+ # process the form parameters
3696
+ if favicon is not None:
3697
+ _files['favicon'] = favicon
3698
+ # process the body parameter
3699
+
3700
+
3701
+
3702
+ # set the HTTP header `Content-Type`
3703
+ if _content_type:
3704
+ _header_params['Content-Type'] = _content_type
3705
+ else:
3706
+ _default_content_type = (
3707
+ self.api_client.select_header_content_type(
3708
+ [
3709
+ 'multipart/form-data'
3710
+ ]
3711
+ )
3712
+ )
3713
+ if _default_content_type is not None:
3714
+ _header_params['Content-Type'] = _default_content_type
3715
+
3716
+ # authentication setting
3717
+ _auth_settings: List[str] = [
3718
+ 'QAnswer-Api-Key',
3719
+ 'Bearer'
3720
+ ]
3721
+
3722
+ return self.api_client.param_serialize(
3723
+ method='POST',
3724
+ resource_path='/api/branding/favicon',
3725
+ path_params=_path_params,
3726
+ query_params=_query_params,
3727
+ header_params=_header_params,
3728
+ body=_body_params,
3729
+ post_params=_form_params,
3730
+ files=_files,
3731
+ auth_settings=_auth_settings,
3732
+ collection_formats=_collection_formats,
3733
+ _host=_host,
3734
+ _request_auth=_request_auth
3735
+ )
3736
+
3737
+
3738
+
3739
+
3740
+ @validate_call
3741
+ def set_logo1(
3742
+ self,
3743
+ logo: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3744
+ organization_id: Optional[StrictInt] = None,
3745
+ _request_timeout: Union[
3746
+ None,
3747
+ Annotated[StrictFloat, Field(gt=0)],
3748
+ Tuple[
3749
+ Annotated[StrictFloat, Field(gt=0)],
3750
+ Annotated[StrictFloat, Field(gt=0)]
3751
+ ]
3752
+ ] = None,
3753
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3754
+ _content_type: Optional[StrictStr] = None,
3755
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3756
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3757
+ ) -> None:
3758
+ """Set the logo across the application
3759
+
3760
+ The logo needs to be an image.
3761
+
3762
+ :param logo: (required)
3763
+ :type logo: bytearray
3764
+ :param organization_id:
3765
+ :type organization_id: int
3766
+ :param _request_timeout: timeout setting for this request. If one
3767
+ number provided, it will be total request
3768
+ timeout. It can also be a pair (tuple) of
3769
+ (connection, read) timeouts.
3770
+ :type _request_timeout: int, tuple(int, int), optional
3771
+ :param _request_auth: set to override the auth_settings for an a single
3772
+ request; this effectively ignores the
3773
+ authentication in the spec for a single request.
3774
+ :type _request_auth: dict, optional
3775
+ :param _content_type: force content-type for the request.
3776
+ :type _content_type: str, Optional
3777
+ :param _headers: set to override the headers for a single
3778
+ request; this effectively ignores the headers
3779
+ in the spec for a single request.
3780
+ :type _headers: dict, optional
3781
+ :param _host_index: set to override the host_index for a single
3782
+ request; this effectively ignores the host_index
3783
+ in the spec for a single request.
3784
+ :type _host_index: int, optional
3785
+ :return: Returns the result object.
3786
+ """ # noqa: E501
3787
+
3788
+ _param = self._set_logo1_serialize(
3789
+ logo=logo,
3790
+ organization_id=organization_id,
3791
+ _request_auth=_request_auth,
3792
+ _content_type=_content_type,
3793
+ _headers=_headers,
3794
+ _host_index=_host_index
3795
+ )
3796
+
3797
+ _response_types_map: Dict[str, Optional[str]] = {
3798
+ '200': None,
3799
+ }
3800
+ response_data = self.api_client.call_api(
3801
+ *_param,
3802
+ _request_timeout=_request_timeout
3803
+ )
3804
+ response_data.read()
3805
+ return self.api_client.response_deserialize(
3806
+ response_data=response_data,
3807
+ response_types_map=_response_types_map,
3808
+ ).data
3809
+
3810
+
3811
+ @validate_call
3812
+ def set_logo1_with_http_info(
3813
+ self,
3814
+ logo: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3815
+ organization_id: Optional[StrictInt] = None,
3816
+ _request_timeout: Union[
3817
+ None,
3818
+ Annotated[StrictFloat, Field(gt=0)],
3819
+ Tuple[
3820
+ Annotated[StrictFloat, Field(gt=0)],
3821
+ Annotated[StrictFloat, Field(gt=0)]
3822
+ ]
3823
+ ] = None,
3824
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3825
+ _content_type: Optional[StrictStr] = None,
3826
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3827
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3828
+ ) -> ApiResponse[None]:
3829
+ """Set the logo across the application
3830
+
3831
+ The logo needs to be an image.
3832
+
3833
+ :param logo: (required)
3834
+ :type logo: bytearray
3835
+ :param organization_id:
3836
+ :type organization_id: int
3837
+ :param _request_timeout: timeout setting for this request. If one
3838
+ number provided, it will be total request
3839
+ timeout. It can also be a pair (tuple) of
3840
+ (connection, read) timeouts.
3841
+ :type _request_timeout: int, tuple(int, int), optional
3842
+ :param _request_auth: set to override the auth_settings for an a single
3843
+ request; this effectively ignores the
3844
+ authentication in the spec for a single request.
3845
+ :type _request_auth: dict, optional
3846
+ :param _content_type: force content-type for the request.
3847
+ :type _content_type: str, Optional
3848
+ :param _headers: set to override the headers for a single
3849
+ request; this effectively ignores the headers
3850
+ in the spec for a single request.
3851
+ :type _headers: dict, optional
3852
+ :param _host_index: set to override the host_index for a single
3853
+ request; this effectively ignores the host_index
3854
+ in the spec for a single request.
3855
+ :type _host_index: int, optional
3856
+ :return: Returns the result object.
3857
+ """ # noqa: E501
3858
+
3859
+ _param = self._set_logo1_serialize(
3860
+ logo=logo,
3861
+ organization_id=organization_id,
3862
+ _request_auth=_request_auth,
3863
+ _content_type=_content_type,
3864
+ _headers=_headers,
3865
+ _host_index=_host_index
3866
+ )
3867
+
3868
+ _response_types_map: Dict[str, Optional[str]] = {
3869
+ '200': None,
3870
+ }
3871
+ response_data = self.api_client.call_api(
3872
+ *_param,
3873
+ _request_timeout=_request_timeout
3874
+ )
3875
+ response_data.read()
3876
+ return self.api_client.response_deserialize(
3877
+ response_data=response_data,
3878
+ response_types_map=_response_types_map,
3879
+ )
3880
+
3881
+
3882
+ @validate_call
3883
+ def set_logo1_without_preload_content(
3884
+ self,
3885
+ logo: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3886
+ organization_id: Optional[StrictInt] = None,
3887
+ _request_timeout: Union[
3888
+ None,
3889
+ Annotated[StrictFloat, Field(gt=0)],
3890
+ Tuple[
3891
+ Annotated[StrictFloat, Field(gt=0)],
3892
+ Annotated[StrictFloat, Field(gt=0)]
3893
+ ]
3894
+ ] = None,
3895
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3896
+ _content_type: Optional[StrictStr] = None,
3897
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3898
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3899
+ ) -> RESTResponseType:
3900
+ """Set the logo across the application
3901
+
3902
+ The logo needs to be an image.
3903
+
3904
+ :param logo: (required)
3905
+ :type logo: bytearray
3906
+ :param organization_id:
3907
+ :type organization_id: int
3908
+ :param _request_timeout: timeout setting for this request. If one
3909
+ number provided, it will be total request
3910
+ timeout. It can also be a pair (tuple) of
3911
+ (connection, read) timeouts.
3912
+ :type _request_timeout: int, tuple(int, int), optional
3913
+ :param _request_auth: set to override the auth_settings for an a single
3914
+ request; this effectively ignores the
3915
+ authentication in the spec for a single request.
3916
+ :type _request_auth: dict, optional
3917
+ :param _content_type: force content-type for the request.
3918
+ :type _content_type: str, Optional
3919
+ :param _headers: set to override the headers for a single
3920
+ request; this effectively ignores the headers
3921
+ in the spec for a single request.
3922
+ :type _headers: dict, optional
3923
+ :param _host_index: set to override the host_index for a single
3924
+ request; this effectively ignores the host_index
3925
+ in the spec for a single request.
3926
+ :type _host_index: int, optional
3927
+ :return: Returns the result object.
3928
+ """ # noqa: E501
3929
+
3930
+ _param = self._set_logo1_serialize(
3931
+ logo=logo,
3932
+ organization_id=organization_id,
3933
+ _request_auth=_request_auth,
3934
+ _content_type=_content_type,
3935
+ _headers=_headers,
3936
+ _host_index=_host_index
3937
+ )
3938
+
3939
+ _response_types_map: Dict[str, Optional[str]] = {
3940
+ '200': None,
3941
+ }
3942
+ response_data = self.api_client.call_api(
3943
+ *_param,
3944
+ _request_timeout=_request_timeout
3945
+ )
3946
+ return response_data.response
3947
+
3948
+
3949
+ def _set_logo1_serialize(
3950
+ self,
3951
+ logo,
3952
+ organization_id,
3953
+ _request_auth,
3954
+ _content_type,
3955
+ _headers,
3956
+ _host_index,
3957
+ ) -> RequestSerialized:
3958
+
3959
+ _host = None
3960
+
3961
+ _collection_formats: Dict[str, str] = {
3962
+ }
3963
+
3964
+ _path_params: Dict[str, str] = {}
3965
+ _query_params: List[Tuple[str, str]] = []
3966
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3967
+ _form_params: List[Tuple[str, str]] = []
3968
+ _files: Dict[
3969
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3970
+ ] = {}
3971
+ _body_params: Optional[bytes] = None
3972
+
3973
+ # process the path parameters
3974
+ # process the query parameters
3975
+ if organization_id is not None:
3976
+
3977
+ _query_params.append(('organization_id', organization_id))
3978
+
3979
+ # process the header parameters
3980
+ # process the form parameters
3981
+ if logo is not None:
3982
+ _files['logo'] = logo
3983
+ # process the body parameter
3984
+
3985
+
3986
+
3987
+ # set the HTTP header `Content-Type`
3988
+ if _content_type:
3989
+ _header_params['Content-Type'] = _content_type
3990
+ else:
3991
+ _default_content_type = (
3992
+ self.api_client.select_header_content_type(
3993
+ [
3994
+ 'multipart/form-data'
3995
+ ]
3996
+ )
3997
+ )
3998
+ if _default_content_type is not None:
3999
+ _header_params['Content-Type'] = _default_content_type
4000
+
4001
+ # authentication setting
4002
+ _auth_settings: List[str] = [
4003
+ 'QAnswer-Api-Key',
4004
+ 'Bearer'
4005
+ ]
4006
+
4007
+ return self.api_client.param_serialize(
4008
+ method='POST',
4009
+ resource_path='/api/branding/logo',
4010
+ path_params=_path_params,
4011
+ query_params=_query_params,
4012
+ header_params=_header_params,
4013
+ body=_body_params,
4014
+ post_params=_form_params,
4015
+ files=_files,
4016
+ auth_settings=_auth_settings,
4017
+ collection_formats=_collection_formats,
4018
+ _host=_host,
4019
+ _request_auth=_request_auth
4020
+ )
4021
+
4022
+
4023
+
4024
+
4025
+ @validate_call
4026
+ def set_logo_with_text(
4027
+ self,
4028
+ logo_with_text: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
4029
+ organization_id: Optional[StrictInt] = None,
4030
+ _request_timeout: Union[
4031
+ None,
4032
+ Annotated[StrictFloat, Field(gt=0)],
4033
+ Tuple[
4034
+ Annotated[StrictFloat, Field(gt=0)],
4035
+ Annotated[StrictFloat, Field(gt=0)]
4036
+ ]
4037
+ ] = None,
4038
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4039
+ _content_type: Optional[StrictStr] = None,
4040
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4041
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4042
+ ) -> None:
4043
+ """Set the logo with text across the application
4044
+
4045
+ The logo with text needs to be an image.
4046
+
4047
+ :param logo_with_text: (required)
4048
+ :type logo_with_text: bytearray
4049
+ :param organization_id:
4050
+ :type organization_id: int
4051
+ :param _request_timeout: timeout setting for this request. If one
4052
+ number provided, it will be total request
4053
+ timeout. It can also be a pair (tuple) of
4054
+ (connection, read) timeouts.
4055
+ :type _request_timeout: int, tuple(int, int), optional
4056
+ :param _request_auth: set to override the auth_settings for an a single
4057
+ request; this effectively ignores the
4058
+ authentication in the spec for a single request.
4059
+ :type _request_auth: dict, optional
4060
+ :param _content_type: force content-type for the request.
4061
+ :type _content_type: str, Optional
4062
+ :param _headers: set to override the headers for a single
4063
+ request; this effectively ignores the headers
4064
+ in the spec for a single request.
4065
+ :type _headers: dict, optional
4066
+ :param _host_index: set to override the host_index for a single
4067
+ request; this effectively ignores the host_index
4068
+ in the spec for a single request.
4069
+ :type _host_index: int, optional
4070
+ :return: Returns the result object.
4071
+ """ # noqa: E501
4072
+
4073
+ _param = self._set_logo_with_text_serialize(
4074
+ logo_with_text=logo_with_text,
4075
+ organization_id=organization_id,
4076
+ _request_auth=_request_auth,
4077
+ _content_type=_content_type,
4078
+ _headers=_headers,
4079
+ _host_index=_host_index
4080
+ )
4081
+
4082
+ _response_types_map: Dict[str, Optional[str]] = {
4083
+ '200': None,
4084
+ }
4085
+ response_data = self.api_client.call_api(
4086
+ *_param,
4087
+ _request_timeout=_request_timeout
4088
+ )
4089
+ response_data.read()
4090
+ return self.api_client.response_deserialize(
4091
+ response_data=response_data,
4092
+ response_types_map=_response_types_map,
4093
+ ).data
4094
+
4095
+
4096
+ @validate_call
4097
+ def set_logo_with_text_with_http_info(
4098
+ self,
4099
+ logo_with_text: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
4100
+ organization_id: Optional[StrictInt] = None,
4101
+ _request_timeout: Union[
4102
+ None,
4103
+ Annotated[StrictFloat, Field(gt=0)],
4104
+ Tuple[
4105
+ Annotated[StrictFloat, Field(gt=0)],
4106
+ Annotated[StrictFloat, Field(gt=0)]
4107
+ ]
4108
+ ] = None,
4109
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4110
+ _content_type: Optional[StrictStr] = None,
4111
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4112
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4113
+ ) -> ApiResponse[None]:
4114
+ """Set the logo with text across the application
4115
+
4116
+ The logo with text needs to be an image.
4117
+
4118
+ :param logo_with_text: (required)
4119
+ :type logo_with_text: bytearray
4120
+ :param organization_id:
4121
+ :type organization_id: int
4122
+ :param _request_timeout: timeout setting for this request. If one
4123
+ number provided, it will be total request
4124
+ timeout. It can also be a pair (tuple) of
4125
+ (connection, read) timeouts.
4126
+ :type _request_timeout: int, tuple(int, int), optional
4127
+ :param _request_auth: set to override the auth_settings for an a single
4128
+ request; this effectively ignores the
4129
+ authentication in the spec for a single request.
4130
+ :type _request_auth: dict, optional
4131
+ :param _content_type: force content-type for the request.
4132
+ :type _content_type: str, Optional
4133
+ :param _headers: set to override the headers for a single
4134
+ request; this effectively ignores the headers
4135
+ in the spec for a single request.
4136
+ :type _headers: dict, optional
4137
+ :param _host_index: set to override the host_index for a single
4138
+ request; this effectively ignores the host_index
4139
+ in the spec for a single request.
4140
+ :type _host_index: int, optional
4141
+ :return: Returns the result object.
4142
+ """ # noqa: E501
4143
+
4144
+ _param = self._set_logo_with_text_serialize(
4145
+ logo_with_text=logo_with_text,
4146
+ organization_id=organization_id,
4147
+ _request_auth=_request_auth,
4148
+ _content_type=_content_type,
4149
+ _headers=_headers,
4150
+ _host_index=_host_index
4151
+ )
4152
+
4153
+ _response_types_map: Dict[str, Optional[str]] = {
4154
+ '200': None,
4155
+ }
4156
+ response_data = self.api_client.call_api(
4157
+ *_param,
4158
+ _request_timeout=_request_timeout
4159
+ )
4160
+ response_data.read()
4161
+ return self.api_client.response_deserialize(
4162
+ response_data=response_data,
4163
+ response_types_map=_response_types_map,
4164
+ )
4165
+
4166
+
4167
+ @validate_call
4168
+ def set_logo_with_text_without_preload_content(
4169
+ self,
4170
+ logo_with_text: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
4171
+ organization_id: Optional[StrictInt] = None,
4172
+ _request_timeout: Union[
4173
+ None,
4174
+ Annotated[StrictFloat, Field(gt=0)],
4175
+ Tuple[
4176
+ Annotated[StrictFloat, Field(gt=0)],
4177
+ Annotated[StrictFloat, Field(gt=0)]
4178
+ ]
4179
+ ] = None,
4180
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4181
+ _content_type: Optional[StrictStr] = None,
4182
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4183
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4184
+ ) -> RESTResponseType:
4185
+ """Set the logo with text across the application
4186
+
4187
+ The logo with text needs to be an image.
4188
+
4189
+ :param logo_with_text: (required)
4190
+ :type logo_with_text: bytearray
4191
+ :param organization_id:
4192
+ :type organization_id: int
4193
+ :param _request_timeout: timeout setting for this request. If one
4194
+ number provided, it will be total request
4195
+ timeout. It can also be a pair (tuple) of
4196
+ (connection, read) timeouts.
4197
+ :type _request_timeout: int, tuple(int, int), optional
4198
+ :param _request_auth: set to override the auth_settings for an a single
4199
+ request; this effectively ignores the
4200
+ authentication in the spec for a single request.
4201
+ :type _request_auth: dict, optional
4202
+ :param _content_type: force content-type for the request.
4203
+ :type _content_type: str, Optional
4204
+ :param _headers: set to override the headers for a single
4205
+ request; this effectively ignores the headers
4206
+ in the spec for a single request.
4207
+ :type _headers: dict, optional
4208
+ :param _host_index: set to override the host_index for a single
4209
+ request; this effectively ignores the host_index
4210
+ in the spec for a single request.
4211
+ :type _host_index: int, optional
4212
+ :return: Returns the result object.
4213
+ """ # noqa: E501
4214
+
4215
+ _param = self._set_logo_with_text_serialize(
4216
+ logo_with_text=logo_with_text,
4217
+ organization_id=organization_id,
4218
+ _request_auth=_request_auth,
4219
+ _content_type=_content_type,
4220
+ _headers=_headers,
4221
+ _host_index=_host_index
4222
+ )
4223
+
4224
+ _response_types_map: Dict[str, Optional[str]] = {
4225
+ '200': None,
4226
+ }
4227
+ response_data = self.api_client.call_api(
4228
+ *_param,
4229
+ _request_timeout=_request_timeout
4230
+ )
4231
+ return response_data.response
4232
+
4233
+
4234
+ def _set_logo_with_text_serialize(
4235
+ self,
4236
+ logo_with_text,
4237
+ organization_id,
4238
+ _request_auth,
4239
+ _content_type,
4240
+ _headers,
4241
+ _host_index,
4242
+ ) -> RequestSerialized:
4243
+
4244
+ _host = None
4245
+
4246
+ _collection_formats: Dict[str, str] = {
4247
+ }
4248
+
4249
+ _path_params: Dict[str, str] = {}
4250
+ _query_params: List[Tuple[str, str]] = []
4251
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4252
+ _form_params: List[Tuple[str, str]] = []
4253
+ _files: Dict[
4254
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
4255
+ ] = {}
4256
+ _body_params: Optional[bytes] = None
4257
+
4258
+ # process the path parameters
4259
+ # process the query parameters
4260
+ if organization_id is not None:
4261
+
4262
+ _query_params.append(('organization_id', organization_id))
4263
+
4264
+ # process the header parameters
4265
+ # process the form parameters
4266
+ if logo_with_text is not None:
4267
+ _files['logo_with_text'] = logo_with_text
4268
+ # process the body parameter
4269
+
4270
+
4271
+
4272
+ # set the HTTP header `Content-Type`
4273
+ if _content_type:
4274
+ _header_params['Content-Type'] = _content_type
4275
+ else:
4276
+ _default_content_type = (
4277
+ self.api_client.select_header_content_type(
4278
+ [
4279
+ 'multipart/form-data'
4280
+ ]
4281
+ )
4282
+ )
4283
+ if _default_content_type is not None:
4284
+ _header_params['Content-Type'] = _default_content_type
4285
+
4286
+ # authentication setting
4287
+ _auth_settings: List[str] = [
4288
+ 'QAnswer-Api-Key',
4289
+ 'Bearer'
4290
+ ]
4291
+
4292
+ return self.api_client.param_serialize(
4293
+ method='POST',
4294
+ resource_path='/api/branding/logo-with-text',
4295
+ path_params=_path_params,
4296
+ query_params=_query_params,
4297
+ header_params=_header_params,
4298
+ body=_body_params,
4299
+ post_params=_form_params,
4300
+ files=_files,
4301
+ auth_settings=_auth_settings,
4302
+ collection_formats=_collection_formats,
4303
+ _host=_host,
4304
+ _request_auth=_request_auth
4305
+ )
4306
+
4307
+
4308
+
4309
+
4310
+ @validate_call
4311
+ def set_system_message(
4312
+ self,
4313
+ system_message: StrictStr,
4314
+ organization_id: Optional[StrictInt] = None,
4315
+ _request_timeout: Union[
4316
+ None,
4317
+ Annotated[StrictFloat, Field(gt=0)],
4318
+ Tuple[
4319
+ Annotated[StrictFloat, Field(gt=0)],
4320
+ Annotated[StrictFloat, Field(gt=0)]
4321
+ ]
4322
+ ] = None,
4323
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4324
+ _content_type: Optional[StrictStr] = None,
4325
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4326
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4327
+ ) -> None:
4328
+ """Set the system message that is used for this organization
4329
+
4330
+
4331
+ :param system_message: (required)
4332
+ :type system_message: str
4333
+ :param organization_id:
4334
+ :type organization_id: int
4335
+ :param _request_timeout: timeout setting for this request. If one
4336
+ number provided, it will be total request
4337
+ timeout. It can also be a pair (tuple) of
4338
+ (connection, read) timeouts.
4339
+ :type _request_timeout: int, tuple(int, int), optional
4340
+ :param _request_auth: set to override the auth_settings for an a single
4341
+ request; this effectively ignores the
4342
+ authentication in the spec for a single request.
4343
+ :type _request_auth: dict, optional
4344
+ :param _content_type: force content-type for the request.
4345
+ :type _content_type: str, Optional
4346
+ :param _headers: set to override the headers for a single
4347
+ request; this effectively ignores the headers
4348
+ in the spec for a single request.
4349
+ :type _headers: dict, optional
4350
+ :param _host_index: set to override the host_index for a single
4351
+ request; this effectively ignores the host_index
4352
+ in the spec for a single request.
4353
+ :type _host_index: int, optional
4354
+ :return: Returns the result object.
4355
+ """ # noqa: E501
4356
+
4357
+ _param = self._set_system_message_serialize(
4358
+ system_message=system_message,
4359
+ organization_id=organization_id,
4360
+ _request_auth=_request_auth,
4361
+ _content_type=_content_type,
4362
+ _headers=_headers,
4363
+ _host_index=_host_index
4364
+ )
4365
+
4366
+ _response_types_map: Dict[str, Optional[str]] = {
4367
+ '200': None,
4368
+ }
4369
+ response_data = self.api_client.call_api(
4370
+ *_param,
4371
+ _request_timeout=_request_timeout
4372
+ )
4373
+ response_data.read()
4374
+ return self.api_client.response_deserialize(
4375
+ response_data=response_data,
4376
+ response_types_map=_response_types_map,
4377
+ ).data
4378
+
4379
+
4380
+ @validate_call
4381
+ def set_system_message_with_http_info(
4382
+ self,
4383
+ system_message: StrictStr,
4384
+ organization_id: Optional[StrictInt] = None,
4385
+ _request_timeout: Union[
4386
+ None,
4387
+ Annotated[StrictFloat, Field(gt=0)],
4388
+ Tuple[
4389
+ Annotated[StrictFloat, Field(gt=0)],
4390
+ Annotated[StrictFloat, Field(gt=0)]
4391
+ ]
4392
+ ] = None,
4393
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4394
+ _content_type: Optional[StrictStr] = None,
4395
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4396
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4397
+ ) -> ApiResponse[None]:
4398
+ """Set the system message that is used for this organization
4399
+
4400
+
4401
+ :param system_message: (required)
4402
+ :type system_message: str
4403
+ :param organization_id:
4404
+ :type organization_id: int
4405
+ :param _request_timeout: timeout setting for this request. If one
4406
+ number provided, it will be total request
4407
+ timeout. It can also be a pair (tuple) of
4408
+ (connection, read) timeouts.
4409
+ :type _request_timeout: int, tuple(int, int), optional
4410
+ :param _request_auth: set to override the auth_settings for an a single
4411
+ request; this effectively ignores the
4412
+ authentication in the spec for a single request.
4413
+ :type _request_auth: dict, optional
4414
+ :param _content_type: force content-type for the request.
4415
+ :type _content_type: str, Optional
4416
+ :param _headers: set to override the headers for a single
4417
+ request; this effectively ignores the headers
4418
+ in the spec for a single request.
4419
+ :type _headers: dict, optional
4420
+ :param _host_index: set to override the host_index for a single
4421
+ request; this effectively ignores the host_index
4422
+ in the spec for a single request.
4423
+ :type _host_index: int, optional
4424
+ :return: Returns the result object.
4425
+ """ # noqa: E501
4426
+
4427
+ _param = self._set_system_message_serialize(
4428
+ system_message=system_message,
4429
+ organization_id=organization_id,
4430
+ _request_auth=_request_auth,
4431
+ _content_type=_content_type,
4432
+ _headers=_headers,
4433
+ _host_index=_host_index
4434
+ )
4435
+
4436
+ _response_types_map: Dict[str, Optional[str]] = {
4437
+ '200': None,
4438
+ }
4439
+ response_data = self.api_client.call_api(
4440
+ *_param,
4441
+ _request_timeout=_request_timeout
4442
+ )
4443
+ response_data.read()
4444
+ return self.api_client.response_deserialize(
4445
+ response_data=response_data,
4446
+ response_types_map=_response_types_map,
4447
+ )
4448
+
4449
+
4450
+ @validate_call
4451
+ def set_system_message_without_preload_content(
4452
+ self,
4453
+ system_message: StrictStr,
4454
+ organization_id: Optional[StrictInt] = None,
4455
+ _request_timeout: Union[
4456
+ None,
4457
+ Annotated[StrictFloat, Field(gt=0)],
4458
+ Tuple[
4459
+ Annotated[StrictFloat, Field(gt=0)],
4460
+ Annotated[StrictFloat, Field(gt=0)]
4461
+ ]
4462
+ ] = None,
4463
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4464
+ _content_type: Optional[StrictStr] = None,
4465
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4466
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4467
+ ) -> RESTResponseType:
4468
+ """Set the system message that is used for this organization
4469
+
4470
+
4471
+ :param system_message: (required)
4472
+ :type system_message: str
4473
+ :param organization_id:
4474
+ :type organization_id: int
4475
+ :param _request_timeout: timeout setting for this request. If one
4476
+ number provided, it will be total request
4477
+ timeout. It can also be a pair (tuple) of
4478
+ (connection, read) timeouts.
4479
+ :type _request_timeout: int, tuple(int, int), optional
4480
+ :param _request_auth: set to override the auth_settings for an a single
4481
+ request; this effectively ignores the
4482
+ authentication in the spec for a single request.
4483
+ :type _request_auth: dict, optional
4484
+ :param _content_type: force content-type for the request.
4485
+ :type _content_type: str, Optional
4486
+ :param _headers: set to override the headers for a single
4487
+ request; this effectively ignores the headers
4488
+ in the spec for a single request.
4489
+ :type _headers: dict, optional
4490
+ :param _host_index: set to override the host_index for a single
4491
+ request; this effectively ignores the host_index
4492
+ in the spec for a single request.
4493
+ :type _host_index: int, optional
4494
+ :return: Returns the result object.
4495
+ """ # noqa: E501
4496
+
4497
+ _param = self._set_system_message_serialize(
4498
+ system_message=system_message,
4499
+ organization_id=organization_id,
4500
+ _request_auth=_request_auth,
4501
+ _content_type=_content_type,
4502
+ _headers=_headers,
4503
+ _host_index=_host_index
4504
+ )
4505
+
4506
+ _response_types_map: Dict[str, Optional[str]] = {
4507
+ '200': None,
4508
+ }
4509
+ response_data = self.api_client.call_api(
4510
+ *_param,
4511
+ _request_timeout=_request_timeout
4512
+ )
4513
+ return response_data.response
4514
+
4515
+
4516
+ def _set_system_message_serialize(
4517
+ self,
4518
+ system_message,
4519
+ organization_id,
4520
+ _request_auth,
4521
+ _content_type,
4522
+ _headers,
4523
+ _host_index,
4524
+ ) -> RequestSerialized:
4525
+
4526
+ _host = None
4527
+
4528
+ _collection_formats: Dict[str, str] = {
4529
+ }
4530
+
4531
+ _path_params: Dict[str, str] = {}
4532
+ _query_params: List[Tuple[str, str]] = []
4533
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4534
+ _form_params: List[Tuple[str, str]] = []
4535
+ _files: Dict[
4536
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
4537
+ ] = {}
4538
+ _body_params: Optional[bytes] = None
4539
+
4540
+ # process the path parameters
4541
+ # process the query parameters
4542
+ if organization_id is not None:
4543
+
4544
+ _query_params.append(('organization_id', organization_id))
4545
+
4546
+ if system_message is not None:
4547
+
4548
+ _query_params.append(('system_message', system_message))
4549
+
4550
+ # process the header parameters
4551
+ # process the form parameters
4552
+ # process the body parameter
4553
+
4554
+
4555
+
4556
+
4557
+ # authentication setting
4558
+ _auth_settings: List[str] = [
4559
+ 'QAnswer-Api-Key',
4560
+ 'Bearer'
4561
+ ]
4562
+
4563
+ return self.api_client.param_serialize(
4564
+ method='POST',
4565
+ resource_path='/api/branding/system-message',
4566
+ path_params=_path_params,
4567
+ query_params=_query_params,
4568
+ header_params=_header_params,
4569
+ body=_body_params,
4570
+ post_params=_form_params,
4571
+ files=_files,
4572
+ auth_settings=_auth_settings,
4573
+ collection_formats=_collection_formats,
4574
+ _host=_host,
4575
+ _request_auth=_request_auth
4576
+ )
4577
+
4578
+