api-sdk-py 1.11.66__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 (294) hide show
  1. api_sdk_py/__init__.py +312 -0
  2. api_sdk_py/api/__init__.py +18 -0
  3. api_sdk_py/api/canvases_api.py +1605 -0
  4. api_sdk_py/api/compositions_api.py +11616 -0
  5. api_sdk_py/api/credits_api.py +628 -0
  6. api_sdk_py/api/entitlements_api.py +676 -0
  7. api_sdk_py/api/invoices_api.py +357 -0
  8. api_sdk_py/api/managed_users_api.py +5087 -0
  9. api_sdk_py/api/operations_api.py +305 -0
  10. api_sdk_py/api/partner_api.py +41365 -0
  11. api_sdk_py/api/partners_api.py +11156 -0
  12. api_sdk_py/api/public_embed_api.py +1938 -0
  13. api_sdk_py/api/tokens_api.py +283 -0
  14. api_sdk_py/api/uploads_api.py +1507 -0
  15. api_sdk_py/api/users_api.py +3649 -0
  16. api_sdk_py/api/widgets_api.py +1300 -0
  17. api_sdk_py/api_client.py +797 -0
  18. api_sdk_py/api_response.py +21 -0
  19. api_sdk_py/configuration.py +526 -0
  20. api_sdk_py/exceptions.py +199 -0
  21. api_sdk_py/models/__init__.py +282 -0
  22. api_sdk_py/models/account_credit_balance.py +96 -0
  23. api_sdk_py/models/account_credit_balance_response.py +99 -0
  24. api_sdk_py/models/account_credit_transaction.py +120 -0
  25. api_sdk_py/models/adapter_connection.py +112 -0
  26. api_sdk_py/models/adapter_connection_removal.py +87 -0
  27. api_sdk_py/models/add_ai_answers_knowledge_document201_response.py +99 -0
  28. api_sdk_py/models/add_ai_answers_knowledge_document_request.py +90 -0
  29. api_sdk_py/models/add_domain_request.py +87 -0
  30. api_sdk_py/models/ai_answers_knowledge.py +101 -0
  31. api_sdk_py/models/ai_answers_knowledge_document.py +113 -0
  32. api_sdk_py/models/ai_answers_knowledge_removal.py +87 -0
  33. api_sdk_py/models/ai_answers_knowledge_totals.py +93 -0
  34. api_sdk_py/models/api_key_scope.py +44 -0
  35. api_sdk_py/models/canvas.py +112 -0
  36. api_sdk_py/models/canvas_response.py +99 -0
  37. api_sdk_py/models/check_composition_access_response.py +99 -0
  38. api_sdk_py/models/check_composition_access_response_data.py +89 -0
  39. api_sdk_py/models/composition.py +133 -0
  40. api_sdk_py/models/composition_data_source.py +90 -0
  41. api_sdk_py/models/composition_data_source_response.py +99 -0
  42. api_sdk_py/models/composition_entries_description.py +99 -0
  43. api_sdk_py/models/composition_entries_description_response.py +99 -0
  44. api_sdk_py/models/composition_entries_reading.py +126 -0
  45. api_sdk_py/models/composition_entries_reading_response.py +99 -0
  46. api_sdk_py/models/composition_entry_aggregate_tally.py +122 -0
  47. api_sdk_py/models/composition_entry_aggregates_block.py +99 -0
  48. api_sdk_py/models/composition_entry_column.py +89 -0
  49. api_sdk_py/models/composition_entry_delete_success.py +93 -0
  50. api_sdk_py/models/composition_entry_delete_success_data.py +87 -0
  51. api_sdk_py/models/composition_entry_item.py +111 -0
  52. api_sdk_py/models/composition_entry_items_meta.py +106 -0
  53. api_sdk_py/models/composition_entry_items_page_success.py +103 -0
  54. api_sdk_py/models/composition_entry_table.py +105 -0
  55. api_sdk_py/models/composition_entry_tally.py +95 -0
  56. api_sdk_py/models/composition_response.py +99 -0
  57. api_sdk_py/models/composition_version.py +96 -0
  58. api_sdk_py/models/content_check_finding.py +93 -0
  59. api_sdk_py/models/content_item_write_result.py +101 -0
  60. api_sdk_py/models/content_item_write_result_validation_result.py +91 -0
  61. api_sdk_py/models/copy_partner_preset_request.py +88 -0
  62. api_sdk_py/models/create_canvas_request.py +118 -0
  63. api_sdk_py/models/create_composition_content_item201_response.py +99 -0
  64. api_sdk_py/models/create_composition_content_item_request.py +101 -0
  65. api_sdk_py/models/create_composition_database_record201_response.py +95 -0
  66. api_sdk_py/models/create_composition_from_preset_request.py +100 -0
  67. api_sdk_py/models/create_composition_from_widget201_response.py +99 -0
  68. api_sdk_py/models/create_composition_from_widget_request.py +102 -0
  69. api_sdk_py/models/create_user_api_key_request.py +106 -0
  70. api_sdk_py/models/create_widget201_response.py +99 -0
  71. api_sdk_py/models/create_widget201_response_data.py +207 -0
  72. api_sdk_py/models/created_user_api_key.py +117 -0
  73. api_sdk_py/models/created_user_api_key_response.py +99 -0
  74. api_sdk_py/models/delete_composition_content_item_response.py +99 -0
  75. api_sdk_py/models/delete_composition_content_item_response_data.py +89 -0
  76. api_sdk_py/models/delete_composition_data_source_response.py +99 -0
  77. api_sdk_py/models/delete_composition_data_source_response_data.py +87 -0
  78. api_sdk_py/models/delete_managed_user200_response.py +99 -0
  79. api_sdk_py/models/delete_personal_workspace_domain_response.py +99 -0
  80. api_sdk_py/models/delete_personal_workspace_domain_response_data.py +87 -0
  81. api_sdk_py/models/delete_user_api_key_response.py +99 -0
  82. api_sdk_py/models/delete_user_api_key_response_data.py +87 -0
  83. api_sdk_py/models/design_defaults.py +92 -0
  84. api_sdk_py/models/duplicate_composition202_response.py +99 -0
  85. api_sdk_py/models/duplicate_composition202_response_data.py +87 -0
  86. api_sdk_py/models/duplicate_composition_request.py +89 -0
  87. api_sdk_py/models/editor_session.py +122 -0
  88. api_sdk_py/models/editor_session_response.py +99 -0
  89. api_sdk_py/models/entitlement.py +118 -0
  90. api_sdk_py/models/error_detail.py +104 -0
  91. api_sdk_py/models/error_response.py +108 -0
  92. api_sdk_py/models/export_composition_entry_items200_response.py +103 -0
  93. api_sdk_py/models/export_composition_entry_items200_response_meta.py +89 -0
  94. api_sdk_py/models/get_ai_answers_knowledge200_response.py +99 -0
  95. api_sdk_py/models/get_all_canvases_response.py +99 -0
  96. api_sdk_py/models/get_all_canvases_response_data.py +101 -0
  97. api_sdk_py/models/get_all_compositions200_response.py +103 -0
  98. api_sdk_py/models/get_all_managed_users200_response.py +103 -0
  99. api_sdk_py/models/get_composition_content_response.py +95 -0
  100. api_sdk_py/models/get_composition_content_schema_response.py +99 -0
  101. api_sdk_py/models/get_composition_content_schema_response_data.py +97 -0
  102. api_sdk_py/models/get_composition_data_source_response.py +104 -0
  103. api_sdk_py/models/get_composition_database_records200_response.py +95 -0
  104. api_sdk_py/models/get_composition_design_response.py +95 -0
  105. api_sdk_py/models/get_composition_design_schema_response.py +99 -0
  106. api_sdk_py/models/get_composition_design_schema_response_data.py +97 -0
  107. api_sdk_py/models/get_composition_embed_schema_response.py +99 -0
  108. api_sdk_py/models/get_composition_embed_schema_response_data.py +107 -0
  109. api_sdk_py/models/get_composition_embed_settings_response.py +95 -0
  110. api_sdk_py/models/get_composition_preview_response.py +99 -0
  111. api_sdk_py/models/get_composition_preview_response_data.py +93 -0
  112. api_sdk_py/models/get_composition_versions200_response.py +103 -0
  113. api_sdk_py/models/get_compositions_batch_request.py +88 -0
  114. api_sdk_py/models/get_compositions_batch_response.py +99 -0
  115. api_sdk_py/models/get_compositions_batch_response_data.py +105 -0
  116. api_sdk_py/models/get_invoices_by_partner_id200_response.py +103 -0
  117. api_sdk_py/models/get_managed_user_entitlements_response.py +99 -0
  118. api_sdk_py/models/get_managed_user_entitlements_response_data.py +97 -0
  119. api_sdk_py/models/get_managed_user_limits200_response.py +99 -0
  120. api_sdk_py/models/get_managed_user_storage_usage200_response.py +99 -0
  121. api_sdk_py/models/get_managed_user_storage_usage200_response_data.py +95 -0
  122. api_sdk_py/models/get_managed_user_storage_usage200_response_data_by_purpose.py +106 -0
  123. api_sdk_py/models/get_managed_users_by_manager_id_response.py +99 -0
  124. api_sdk_py/models/get_managed_users_by_manager_id_response_data.py +101 -0
  125. api_sdk_py/models/get_partner_billing_overview200_response.py +99 -0
  126. api_sdk_py/models/get_partner_credit_transactions200_response.py +103 -0
  127. api_sdk_py/models/get_partner_design_defaults200_response.py +99 -0
  128. api_sdk_py/models/get_partner_entitlements_response.py +99 -0
  129. api_sdk_py/models/get_partner_entitlements_response_data.py +97 -0
  130. api_sdk_py/models/get_personal_workspace_domains200_response.py +103 -0
  131. api_sdk_py/models/get_public_composition_embed200_response.py +133 -0
  132. api_sdk_py/models/get_public_composition_embed200_response_data_source.py +89 -0
  133. api_sdk_py/models/get_public_composition_embed200_response_direct.py +96 -0
  134. api_sdk_py/models/get_user_adapter_connections200_response.py +103 -0
  135. api_sdk_py/models/get_user_api_key_usage_logs_response.py +99 -0
  136. api_sdk_py/models/get_user_api_key_usage_logs_response_data.py +95 -0
  137. api_sdk_py/models/get_user_api_keys200_response.py +103 -0
  138. api_sdk_py/models/get_widgets200_response.py +103 -0
  139. api_sdk_py/models/get_widgets_batch_request.py +87 -0
  140. api_sdk_py/models/get_widgets_batch_response.py +99 -0
  141. api_sdk_py/models/get_widgets_batch_response_data.py +105 -0
  142. api_sdk_py/models/get_widgets_batch_response_data_errors_inner.py +89 -0
  143. api_sdk_py/models/list_partner_presets200_response.py +103 -0
  144. api_sdk_py/models/managed_user.py +105 -0
  145. api_sdk_py/models/managed_user_entries_meta.py +100 -0
  146. api_sdk_py/models/managed_user_entries_page_success.py +103 -0
  147. api_sdk_py/models/managed_user_entry_item.py +115 -0
  148. api_sdk_py/models/managed_user_limits.py +104 -0
  149. api_sdk_py/models/managed_user_operation_usage.py +95 -0
  150. api_sdk_py/models/managed_user_removal.py +89 -0
  151. api_sdk_py/models/managed_user_response.py +99 -0
  152. api_sdk_py/models/managed_user_usage.py +110 -0
  153. api_sdk_py/models/managed_user_usage_response.py +99 -0
  154. api_sdk_py/models/managed_user_usage_totals.py +93 -0
  155. api_sdk_py/models/my_partner.py +136 -0
  156. api_sdk_py/models/my_partners.py +112 -0
  157. api_sdk_py/models/my_partners_response.py +99 -0
  158. api_sdk_py/models/new_composition.py +108 -0
  159. api_sdk_py/models/new_editor_session.py +107 -0
  160. api_sdk_py/models/new_managed_user.py +91 -0
  161. api_sdk_py/models/new_widget.py +118 -0
  162. api_sdk_py/models/operations_id_get_response.py +99 -0
  163. api_sdk_py/models/operations_id_get_response_data.py +113 -0
  164. api_sdk_py/models/partner_analytics_by_managed_user.py +109 -0
  165. api_sdk_py/models/partner_analytics_by_managed_user_response.py +99 -0
  166. api_sdk_py/models/partner_analytics_of_day.py +94 -0
  167. api_sdk_py/models/partner_analytics_of_managed_user.py +126 -0
  168. api_sdk_py/models/partner_analytics_of_widget.py +102 -0
  169. api_sdk_py/models/partner_analytics_summary.py +110 -0
  170. api_sdk_py/models/partner_analytics_summary_response.py +99 -0
  171. api_sdk_py/models/partner_analytics_timeline.py +110 -0
  172. api_sdk_py/models/partner_analytics_timeline_response.py +99 -0
  173. api_sdk_py/models/partner_analytics_top_widgets.py +110 -0
  174. api_sdk_py/models/partner_analytics_top_widgets_response.py +99 -0
  175. api_sdk_py/models/partner_billing_overview.py +114 -0
  176. api_sdk_py/models/partner_billing_overview_billing_integration.py +100 -0
  177. api_sdk_py/models/partner_billing_overview_operational_credits.py +101 -0
  178. api_sdk_py/models/partner_billing_overview_partner.py +100 -0
  179. api_sdk_py/models/partner_contract.py +158 -0
  180. api_sdk_py/models/partner_contract_response.py +99 -0
  181. api_sdk_py/models/partner_customization.py +140 -0
  182. api_sdk_py/models/partner_data_database.py +112 -0
  183. api_sdk_py/models/partner_data_database_removal.py +87 -0
  184. api_sdk_py/models/partner_data_database_removal_response.py +99 -0
  185. api_sdk_py/models/partner_data_database_response.py +99 -0
  186. api_sdk_py/models/partner_entry_context_secret.py +93 -0
  187. api_sdk_py/models/partner_entry_context_secret_response.py +99 -0
  188. api_sdk_py/models/partner_entry_context_signing.py +108 -0
  189. api_sdk_py/models/partner_entry_context_signing_response.py +99 -0
  190. api_sdk_py/models/partner_extra_credits_invoice.py +130 -0
  191. api_sdk_py/models/partner_extra_credits_invoice_response.py +99 -0
  192. api_sdk_py/models/partner_invoice.py +234 -0
  193. api_sdk_py/models/partner_notification.py +108 -0
  194. api_sdk_py/models/partner_notification_default_recipients.py +89 -0
  195. api_sdk_py/models/partner_notification_delivery.py +170 -0
  196. api_sdk_py/models/partner_notification_delivery_log.py +95 -0
  197. api_sdk_py/models/partner_notification_delivery_log_response.py +99 -0
  198. api_sdk_py/models/partner_notification_delivery_response.py +99 -0
  199. api_sdk_py/models/partner_notification_event.py +112 -0
  200. api_sdk_py/models/partner_notification_event_type.py +51 -0
  201. api_sdk_py/models/partner_notification_page.py +103 -0
  202. api_sdk_py/models/partner_notification_page_response.py +99 -0
  203. api_sdk_py/models/partner_notification_settings.py +139 -0
  204. api_sdk_py/models/partner_notification_settings_change.py +98 -0
  205. api_sdk_py/models/partner_notification_settings_change_response.py +99 -0
  206. api_sdk_py/models/partner_notification_settings_response.py +99 -0
  207. api_sdk_py/models/partner_notification_test_event_request.py +88 -0
  208. api_sdk_py/models/partner_notification_test_event_result.py +98 -0
  209. api_sdk_py/models/partner_notification_test_event_result_response.py +99 -0
  210. api_sdk_py/models/partner_preset.py +119 -0
  211. api_sdk_py/models/partner_preset_copy.py +97 -0
  212. api_sdk_py/models/partner_preset_copy_response.py +99 -0
  213. api_sdk_py/models/partner_preset_removal.py +87 -0
  214. api_sdk_py/models/partner_preset_removal_response.py +99 -0
  215. api_sdk_py/models/partner_preset_response.py +99 -0
  216. api_sdk_py/models/partner_report_page.py +91 -0
  217. api_sdk_py/models/partner_report_period.py +90 -0
  218. api_sdk_py/models/partner_storage_destination.py +120 -0
  219. api_sdk_py/models/partner_storage_destination_response.py +99 -0
  220. api_sdk_py/models/partner_storage_removal.py +87 -0
  221. api_sdk_py/models/partner_storage_removal_response.py +99 -0
  222. api_sdk_py/models/partner_storage_usage.py +109 -0
  223. api_sdk_py/models/partner_storage_usage_of_managed_user.py +129 -0
  224. api_sdk_py/models/partner_storage_usage_response.py +99 -0
  225. api_sdk_py/models/partner_storage_usage_totals.py +93 -0
  226. api_sdk_py/models/personal_workspace_domain.py +96 -0
  227. api_sdk_py/models/personal_workspace_domain_result.py +93 -0
  228. api_sdk_py/models/personal_workspace_domain_result_response.py +99 -0
  229. api_sdk_py/models/post_public_composition_embed_status200_response.py +99 -0
  230. api_sdk_py/models/post_public_composition_embed_status200_response_data.py +97 -0
  231. api_sdk_py/models/post_public_composition_embed_status_request.py +88 -0
  232. api_sdk_py/models/public_adapter_call_error.py +93 -0
  233. api_sdk_py/models/public_adapter_call_request.py +113 -0
  234. api_sdk_py/models/public_adapter_call_result.py +93 -0
  235. api_sdk_py/models/public_adapter_call_result_data.py +87 -0
  236. api_sdk_py/models/public_adapter_file_result.py +93 -0
  237. api_sdk_py/models/public_adapter_file_result_data.py +91 -0
  238. api_sdk_py/models/public_adapter_file_result_data_file.py +108 -0
  239. api_sdk_py/models/public_composition_entry_created.py +93 -0
  240. api_sdk_py/models/public_composition_entry_created_data.py +92 -0
  241. api_sdk_py/models/public_composition_entry_request.py +101 -0
  242. api_sdk_py/models/public_embed_failure.py +105 -0
  243. api_sdk_py/models/public_embed_failure_details.py +112 -0
  244. api_sdk_py/models/public_embed_failure_error.py +98 -0
  245. api_sdk_py/models/purpose_storage_bucket.py +89 -0
  246. api_sdk_py/models/remove_ai_answers_knowledge_document200_response.py +99 -0
  247. api_sdk_py/models/remove_user_adapter_connection200_response.py +99 -0
  248. api_sdk_py/models/request_extra_credits.py +88 -0
  249. api_sdk_py/models/response_meta.py +121 -0
  250. api_sdk_py/models/revoke_managed_user_editor_sessions_response.py +99 -0
  251. api_sdk_py/models/revoke_managed_user_editor_sessions_response_data.py +87 -0
  252. api_sdk_py/models/set_adapter_connection_request.py +88 -0
  253. api_sdk_py/models/set_composition_data_source_request.py +90 -0
  254. api_sdk_py/models/set_dynamic_content_request.py +95 -0
  255. api_sdk_py/models/set_dynamic_content_response.py +99 -0
  256. api_sdk_py/models/set_dynamic_content_response_data.py +99 -0
  257. api_sdk_py/models/set_dynamic_content_response_data_validation_result.py +91 -0
  258. api_sdk_py/models/set_managed_user_limits_request.py +93 -0
  259. api_sdk_py/models/set_partner_data_database_request.py +87 -0
  260. api_sdk_py/models/set_partner_design_defaults_request.py +92 -0
  261. api_sdk_py/models/set_partner_preset_request.py +104 -0
  262. api_sdk_py/models/set_partner_storage_destination_request.py +101 -0
  263. api_sdk_py/models/set_user_adapter_connection200_response.py +99 -0
  264. api_sdk_py/models/success_response.py +95 -0
  265. api_sdk_py/models/update_canvas_request.py +96 -0
  266. api_sdk_py/models/update_composition.py +101 -0
  267. api_sdk_py/models/update_composition_status_request.py +94 -0
  268. api_sdk_py/models/update_domain_request.py +87 -0
  269. api_sdk_py/models/update_managed_user.py +91 -0
  270. api_sdk_py/models/update_partner_entry_context_signing_request.py +87 -0
  271. api_sdk_py/models/update_partner_notification_settings_request.py +110 -0
  272. api_sdk_py/models/update_user_api_key_request.py +90 -0
  273. api_sdk_py/models/upload.py +167 -0
  274. api_sdk_py/models/upload_limits.py +97 -0
  275. api_sdk_py/models/upload_limits_response.py +99 -0
  276. api_sdk_py/models/upload_response.py +99 -0
  277. api_sdk_py/models/uploads_get200_response.py +103 -0
  278. api_sdk_py/models/uploads_id_delete200_response.py +99 -0
  279. api_sdk_py/models/uploads_id_delete200_response_data.py +87 -0
  280. api_sdk_py/models/user_api_key.py +122 -0
  281. api_sdk_py/models/user_api_key_response.py +99 -0
  282. api_sdk_py/models/user_api_key_usage_log.py +107 -0
  283. api_sdk_py/models/validate_composition_content_response.py +99 -0
  284. api_sdk_py/models/validate_composition_content_response_data.py +108 -0
  285. api_sdk_py/models/validate_token200_response.py +99 -0
  286. api_sdk_py/models/validate_token200_response_data.py +106 -0
  287. api_sdk_py/models/widget.py +205 -0
  288. api_sdk_py/py.typed +0 -0
  289. api_sdk_py/rest.py +257 -0
  290. api_sdk_py-1.11.66.dist-info/METADATA +28 -0
  291. api_sdk_py-1.11.66.dist-info/RECORD +294 -0
  292. api_sdk_py-1.11.66.dist-info/WHEEL +5 -0
  293. api_sdk_py-1.11.66.dist-info/licenses/LICENSE +122 -0
  294. api_sdk_py-1.11.66.dist-info/top_level.txt +1 -0
@@ -0,0 +1,21 @@
1
+ """API response object."""
2
+
3
+ from __future__ import annotations
4
+ from typing import Optional, Generic, Mapping, TypeVar
5
+ from pydantic import Field, StrictInt, StrictBytes, BaseModel
6
+
7
+ T = TypeVar("T")
8
+
9
+ class ApiResponse(BaseModel, Generic[T]):
10
+ """
11
+ API response object
12
+ """
13
+
14
+ status_code: StrictInt = Field(description="HTTP status code")
15
+ headers: Optional[Mapping[str, str]] = Field(None, description="HTTP headers")
16
+ data: T = Field(description="Deserialized data given the data type")
17
+ raw_data: StrictBytes = Field(description="Raw data (HTTP response body)")
18
+
19
+ model_config = {
20
+ "arbitrary_types_allowed": True
21
+ }
@@ -0,0 +1,526 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Widgetic API Gateway
5
+
6
+ API documentation for the Widgetic API Gateway
7
+
8
+ The version of the OpenAPI document: 1.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ import copy
16
+ import logging
17
+ from logging import FileHandler
18
+ import multiprocessing
19
+ import sys
20
+ from typing import Optional
21
+ import urllib3
22
+
23
+ import http.client as httplib
24
+
25
+ JSON_SCHEMA_VALIDATION_KEYWORDS = {
26
+ 'multipleOf', 'maximum', 'exclusiveMaximum',
27
+ 'minimum', 'exclusiveMinimum', 'maxLength',
28
+ 'minLength', 'pattern', 'maxItems', 'minItems'
29
+ }
30
+
31
+ class Configuration:
32
+ """This class contains various settings of the API client.
33
+
34
+ :param host: Base url.
35
+ :param ignore_operation_servers
36
+ Boolean to ignore operation servers for the API client.
37
+ Config will use `host` as the base url regardless of the operation servers.
38
+ :param api_key: Dict to store API key(s).
39
+ Each entry in the dict specifies an API key.
40
+ The dict key is the name of the security scheme in the OAS specification.
41
+ The dict value is the API key secret.
42
+ :param api_key_prefix: Dict to store API prefix (e.g. Bearer).
43
+ The dict key is the name of the security scheme in the OAS specification.
44
+ The dict value is an API key prefix when generating the auth data.
45
+ :param username: Username for HTTP basic authentication.
46
+ :param password: Password for HTTP basic authentication.
47
+ :param access_token: Access token.
48
+ :param server_index: Index to servers configuration.
49
+ :param server_variables: Mapping with string values to replace variables in
50
+ templated server configuration. The validation of enums is performed for
51
+ variables with defined enum values before.
52
+ :param server_operation_index: Mapping from operation ID to an index to server
53
+ configuration.
54
+ :param server_operation_variables: Mapping from operation ID to a mapping with
55
+ string values to replace variables in templated server configuration.
56
+ The validation of enums is performed for variables with defined enum
57
+ values before.
58
+ :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
59
+ in PEM format.
60
+ :param retries: Number of retries for API requests.
61
+
62
+ :Example:
63
+
64
+ API Key Authentication Example.
65
+ Given the following security scheme in the OpenAPI specification:
66
+ components:
67
+ securitySchemes:
68
+ cookieAuth: # name for the security scheme
69
+ type: apiKey
70
+ in: cookie
71
+ name: JSESSIONID # cookie name
72
+
73
+ You can programmatically set the cookie:
74
+
75
+ conf = api_sdk_py.Configuration(
76
+ api_key={'cookieAuth': 'abc123'}
77
+ api_key_prefix={'cookieAuth': 'JSESSIONID'}
78
+ )
79
+
80
+ The following cookie will be added to the HTTP request:
81
+ Cookie: JSESSIONID abc123
82
+ """
83
+
84
+ _default = None
85
+
86
+ def __init__(self, host=None,
87
+ api_key=None, api_key_prefix=None,
88
+ username=None, password=None,
89
+ access_token=None,
90
+ server_index=None, server_variables=None,
91
+ server_operation_index=None, server_operation_variables=None,
92
+ ignore_operation_servers=False,
93
+ ssl_ca_cert=None,
94
+ retries=None,
95
+ *,
96
+ debug: Optional[bool] = None
97
+ ) -> None:
98
+ """Constructor
99
+ """
100
+ self._base_path = "https://api.widgetic.com/v1" if host is None else host
101
+ """Default Base url
102
+ """
103
+ self.server_index = 0 if server_index is None and host is None else server_index
104
+ self.server_operation_index = server_operation_index or {}
105
+ """Default server index
106
+ """
107
+ self.server_variables = server_variables or {}
108
+ self.server_operation_variables = server_operation_variables or {}
109
+ """Default server variables
110
+ """
111
+ self.ignore_operation_servers = ignore_operation_servers
112
+ """Ignore operation servers
113
+ """
114
+ self.temp_folder_path = None
115
+ """Temp file folder for downloading files
116
+ """
117
+ # Authentication Settings
118
+ self.api_key = {}
119
+ if api_key:
120
+ self.api_key = api_key
121
+ """dict to store API key(s)
122
+ """
123
+ self.api_key_prefix = {}
124
+ if api_key_prefix:
125
+ self.api_key_prefix = api_key_prefix
126
+ """dict to store API prefix (e.g. Bearer)
127
+ """
128
+ self.refresh_api_key_hook = None
129
+ """function hook to refresh API key if expired
130
+ """
131
+ self.username = username
132
+ """Username for HTTP basic authentication
133
+ """
134
+ self.password = password
135
+ """Password for HTTP basic authentication
136
+ """
137
+ self.access_token = access_token
138
+ """Access token
139
+ """
140
+ self.logger = {}
141
+ """Logging Settings
142
+ """
143
+ self.logger["package_logger"] = logging.getLogger("api_sdk_py")
144
+ self.logger["urllib3_logger"] = logging.getLogger("urllib3")
145
+ self.logger_format = '%(asctime)s %(levelname)s %(message)s'
146
+ """Log format
147
+ """
148
+ self.logger_stream_handler = None
149
+ """Log stream handler
150
+ """
151
+ self.logger_file_handler: Optional[FileHandler] = None
152
+ """Log file handler
153
+ """
154
+ self.logger_file = None
155
+ """Debug file location
156
+ """
157
+ if debug is not None:
158
+ self.debug = debug
159
+ else:
160
+ self.__debug = False
161
+ """Debug switch
162
+ """
163
+
164
+ self.verify_ssl = True
165
+ """SSL/TLS verification
166
+ Set this to false to skip verifying SSL certificate when calling API
167
+ from https server.
168
+ """
169
+ self.ssl_ca_cert = ssl_ca_cert
170
+ """Set this to customize the certificate file to verify the peer.
171
+ """
172
+ self.cert_file = None
173
+ """client certificate file
174
+ """
175
+ self.key_file = None
176
+ """client key file
177
+ """
178
+ self.assert_hostname = None
179
+ """Set this to True/False to enable/disable SSL hostname verification.
180
+ """
181
+ self.tls_server_name = None
182
+ """SSL/TLS Server Name Indication (SNI)
183
+ Set this to the SNI value expected by the server.
184
+ """
185
+
186
+ self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
187
+ """urllib3 connection pool's maximum number of connections saved
188
+ per pool. urllib3 uses 1 connection as default value, but this is
189
+ not the best value when you are making a lot of possibly parallel
190
+ requests to the same host, which is often the case here.
191
+ cpu_count * 5 is used as default value to increase performance.
192
+ """
193
+
194
+ self.proxy: Optional[str] = None
195
+ """Proxy URL
196
+ """
197
+ self.proxy_headers = None
198
+ """Proxy headers
199
+ """
200
+ self.safe_chars_for_path_param = ''
201
+ """Safe chars for path_param
202
+ """
203
+ self.retries = retries
204
+ """Adding retries to override urllib3 default value 3
205
+ """
206
+ # Enable client side validation
207
+ self.client_side_validation = True
208
+
209
+ self.socket_options = None
210
+ """Options to pass down to the underlying urllib3 socket
211
+ """
212
+
213
+ self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z"
214
+ """datetime format
215
+ """
216
+
217
+ self.date_format = "%Y-%m-%d"
218
+ """date format
219
+ """
220
+
221
+ def __deepcopy__(self, memo):
222
+ cls = self.__class__
223
+ result = cls.__new__(cls)
224
+ memo[id(self)] = result
225
+ for k, v in self.__dict__.items():
226
+ if k not in ('logger', 'logger_file_handler'):
227
+ setattr(result, k, copy.deepcopy(v, memo))
228
+ # shallow copy of loggers
229
+ result.logger = copy.copy(self.logger)
230
+ # use setters to configure loggers
231
+ result.logger_file = self.logger_file
232
+ result.debug = self.debug
233
+ return result
234
+
235
+ def __setattr__(self, name, value):
236
+ object.__setattr__(self, name, value)
237
+
238
+ @classmethod
239
+ def set_default(cls, default):
240
+ """Set default instance of configuration.
241
+
242
+ It stores default configuration, which can be
243
+ returned by get_default_copy method.
244
+
245
+ :param default: object of Configuration
246
+ """
247
+ cls._default = default
248
+
249
+ @classmethod
250
+ def get_default_copy(cls):
251
+ """Deprecated. Please use `get_default` instead.
252
+
253
+ Deprecated. Please use `get_default` instead.
254
+
255
+ :return: The configuration object.
256
+ """
257
+ return cls.get_default()
258
+
259
+ @classmethod
260
+ def get_default(cls):
261
+ """Return the default configuration.
262
+
263
+ This method returns newly created, based on default constructor,
264
+ object of Configuration class or returns a copy of default
265
+ configuration.
266
+
267
+ :return: The configuration object.
268
+ """
269
+ if cls._default is None:
270
+ cls._default = Configuration()
271
+ return cls._default
272
+
273
+ @property
274
+ def logger_file(self):
275
+ """The logger file.
276
+
277
+ If the logger_file is None, then add stream handler and remove file
278
+ handler. Otherwise, add file handler and remove stream handler.
279
+
280
+ :param value: The logger_file path.
281
+ :type: str
282
+ """
283
+ return self.__logger_file
284
+
285
+ @logger_file.setter
286
+ def logger_file(self, value):
287
+ """The logger file.
288
+
289
+ If the logger_file is None, then add stream handler and remove file
290
+ handler. Otherwise, add file handler and remove stream handler.
291
+
292
+ :param value: The logger_file path.
293
+ :type: str
294
+ """
295
+ self.__logger_file = value
296
+ if self.__logger_file:
297
+ # If set logging file,
298
+ # then add file handler and remove stream handler.
299
+ self.logger_file_handler = logging.FileHandler(self.__logger_file)
300
+ self.logger_file_handler.setFormatter(self.logger_formatter)
301
+ for _, logger in self.logger.items():
302
+ logger.addHandler(self.logger_file_handler)
303
+
304
+ @property
305
+ def debug(self):
306
+ """Debug status
307
+
308
+ :param value: The debug status, True or False.
309
+ :type: bool
310
+ """
311
+ return self.__debug
312
+
313
+ @debug.setter
314
+ def debug(self, value):
315
+ """Debug status
316
+
317
+ :param value: The debug status, True or False.
318
+ :type: bool
319
+ """
320
+ self.__debug = value
321
+ if self.__debug:
322
+ # if debug status is True, turn on debug logging
323
+ for _, logger in self.logger.items():
324
+ logger.setLevel(logging.DEBUG)
325
+ # turn on httplib debug
326
+ httplib.HTTPConnection.debuglevel = 1
327
+ else:
328
+ # if debug status is False, turn off debug logging,
329
+ # setting log level to default `logging.WARNING`
330
+ for _, logger in self.logger.items():
331
+ logger.setLevel(logging.WARNING)
332
+ # turn off httplib debug
333
+ httplib.HTTPConnection.debuglevel = 0
334
+
335
+ @property
336
+ def logger_format(self):
337
+ """The logger format.
338
+
339
+ The logger_formatter will be updated when sets logger_format.
340
+
341
+ :param value: The format string.
342
+ :type: str
343
+ """
344
+ return self.__logger_format
345
+
346
+ @logger_format.setter
347
+ def logger_format(self, value):
348
+ """The logger format.
349
+
350
+ The logger_formatter will be updated when sets logger_format.
351
+
352
+ :param value: The format string.
353
+ :type: str
354
+ """
355
+ self.__logger_format = value
356
+ self.logger_formatter = logging.Formatter(self.__logger_format)
357
+
358
+ def get_api_key_with_prefix(self, identifier, alias=None):
359
+ """Gets API key (with prefix if set).
360
+
361
+ :param identifier: The identifier of apiKey.
362
+ :param alias: The alternative identifier of apiKey.
363
+ :return: The token for api key authentication.
364
+ """
365
+ if self.refresh_api_key_hook is not None:
366
+ self.refresh_api_key_hook(self)
367
+ key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None)
368
+ if key:
369
+ prefix = self.api_key_prefix.get(identifier)
370
+ if prefix:
371
+ return "%s %s" % (prefix, key)
372
+ else:
373
+ return key
374
+
375
+ def get_basic_auth_token(self):
376
+ """Gets HTTP basic authentication header (string).
377
+
378
+ :return: The token for basic HTTP authentication.
379
+ """
380
+ username = ""
381
+ if self.username is not None:
382
+ username = self.username
383
+ password = ""
384
+ if self.password is not None:
385
+ password = self.password
386
+ return urllib3.util.make_headers(
387
+ basic_auth=username + ':' + password
388
+ ).get('authorization')
389
+
390
+ def auth_settings(self):
391
+ """Gets Auth Settings dict for api client.
392
+
393
+ :return: The Auth Settings information dict.
394
+ """
395
+ auth = {}
396
+ if self.access_token is not None:
397
+ auth['apiKeyAuth'] = {
398
+ 'type': 'bearer',
399
+ 'in': 'header',
400
+ 'format': 'JWT',
401
+ 'key': 'Authorization',
402
+ 'value': 'Bearer ' + self.access_token
403
+ }
404
+ if self.access_token is not None:
405
+ auth['bearerAuth'] = {
406
+ 'type': 'bearer',
407
+ 'in': 'header',
408
+ 'format': 'JWT',
409
+ 'key': 'Authorization',
410
+ 'value': 'Bearer ' + self.access_token
411
+ }
412
+ if self.access_token is not None:
413
+ auth['BearerAuth'] = {
414
+ 'type': 'bearer',
415
+ 'in': 'header',
416
+ 'format': 'JWT',
417
+ 'key': 'Authorization',
418
+ 'value': 'Bearer ' + self.access_token
419
+ }
420
+ if 'ApiKeyAuth' in self.api_key:
421
+ auth['ApiKeyAuth'] = {
422
+ 'type': 'api_key',
423
+ 'in': 'header',
424
+ 'key': 'Authorization',
425
+ 'value': self.get_api_key_with_prefix(
426
+ 'ApiKeyAuth',
427
+ ),
428
+ }
429
+ if 'webhookSignature' in self.api_key:
430
+ auth['webhookSignature'] = {
431
+ 'type': 'api_key',
432
+ 'in': 'header',
433
+ 'key': 'X-Webhook-Signature',
434
+ 'value': self.get_api_key_with_prefix(
435
+ 'webhookSignature',
436
+ ),
437
+ }
438
+ return auth
439
+
440
+ def to_debug_report(self):
441
+ """Gets the essential information for debugging.
442
+
443
+ :return: The report for debugging.
444
+ """
445
+ return "Python SDK Debug Report:\n"\
446
+ "OS: {env}\n"\
447
+ "Python Version: {pyversion}\n"\
448
+ "Version of the API: 1.0.0\n"\
449
+ "SDK Package Version: 1.11.66".\
450
+ format(env=sys.platform, pyversion=sys.version)
451
+
452
+ def get_host_settings(self):
453
+ """Gets an array of host settings
454
+
455
+ :return: An array of host settings
456
+ """
457
+ return [
458
+ {
459
+ 'url': "https://api.widgetic.com/v1",
460
+ 'description': "Development server",
461
+ 'variables': {
462
+ 'env': {
463
+ 'description': "Environment",
464
+ 'default_value': "development",
465
+ },
466
+ 'apiUrl': {
467
+ 'description': "API URL",
468
+ 'default_value': "https://api.widgetic.com",
469
+ },
470
+ 'apiVersion': {
471
+ 'description': "API Version path prefix",
472
+ 'default_value': "/v1",
473
+ }
474
+ }
475
+ }
476
+ ]
477
+
478
+ def get_host_from_settings(self, index, variables=None, servers=None):
479
+ """Gets host URL based on the index and variables
480
+ :param index: array index of the host settings
481
+ :param variables: hash of variable and the corresponding value
482
+ :param servers: an array of host settings or None
483
+ :return: URL based on host settings
484
+ """
485
+ if index is None:
486
+ return self._base_path
487
+
488
+ variables = {} if variables is None else variables
489
+ servers = self.get_host_settings() if servers is None else servers
490
+
491
+ try:
492
+ server = servers[index]
493
+ except IndexError:
494
+ raise ValueError(
495
+ "Invalid index {0} when selecting the host settings. "
496
+ "Must be less than {1}".format(index, len(servers)))
497
+
498
+ url = server['url']
499
+
500
+ # go through variables and replace placeholders
501
+ for variable_name, variable in server.get('variables', {}).items():
502
+ used_value = variables.get(
503
+ variable_name, variable['default_value'])
504
+
505
+ if 'enum_values' in variable \
506
+ and used_value not in variable['enum_values']:
507
+ raise ValueError(
508
+ "The variable `{0}` in the host URL has invalid value "
509
+ "{1}. Must be {2}.".format(
510
+ variable_name, variables[variable_name],
511
+ variable['enum_values']))
512
+
513
+ url = url.replace("{" + variable_name + "}", used_value)
514
+
515
+ return url
516
+
517
+ @property
518
+ def host(self):
519
+ """Return generated host."""
520
+ return self.get_host_from_settings(self.server_index, variables=self.server_variables)
521
+
522
+ @host.setter
523
+ def host(self, value):
524
+ """Fix base path."""
525
+ self._base_path = value
526
+ self.server_index = None