rapidata 0.1.3__py3-none-any.whl → 0.1.5__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 (225) hide show
  1. openapi/openapi-client/openapi_client/__init__.py +215 -0
  2. openapi/openapi-client/openapi_client/api/__init__.py +11 -0
  3. openapi/openapi-client/openapi_client/api/coco_api.py +619 -0
  4. openapi/openapi-client/openapi_client/api/datapoint_api.py +817 -0
  5. openapi/openapi-client/openapi_client/api/dataset_api.py +2290 -0
  6. openapi/openapi-client/openapi_client/api/identity_api.py +3181 -0
  7. openapi/openapi-client/openapi_client/api/newsletter_api.py +571 -0
  8. openapi/openapi-client/openapi_client/api/order_api.py +5390 -0
  9. openapi/openapi-client/openapi_client/api/validation_api.py +1670 -0
  10. openapi/openapi-client/openapi_client/api_client.py +797 -0
  11. openapi/openapi-client/openapi_client/api_response.py +21 -0
  12. openapi/openapi-client/openapi_client/configuration.py +479 -0
  13. openapi/openapi-client/openapi_client/exceptions.py +199 -0
  14. openapi/openapi-client/openapi_client/models/__init__.py +192 -0
  15. openapi/openapi-client/openapi_client/models/add_validation_rapid_model.py +116 -0
  16. openapi/openapi-client/openapi_client/models/add_validation_rapid_model_payload.py +238 -0
  17. openapi/openapi-client/openapi_client/models/add_validation_rapid_model_truth.py +238 -0
  18. openapi/openapi-client/openapi_client/models/admin_order_model.py +103 -0
  19. openapi/openapi-client/openapi_client/models/admin_order_model_paged_result.py +105 -0
  20. openapi/openapi-client/openapi_client/models/age_group.py +40 -0
  21. openapi/openapi-client/openapi_client/models/age_user_filter_model.py +97 -0
  22. openapi/openapi-client/openapi_client/models/aggregator_type.py +46 -0
  23. openapi/openapi-client/openapi_client/models/attach_category_rapid_blueprint.py +98 -0
  24. openapi/openapi-client/openapi_client/models/attach_category_truth.py +96 -0
  25. openapi/openapi-client/openapi_client/models/base_error.py +90 -0
  26. openapi/openapi-client/openapi_client/models/bounding_box_payload.py +96 -0
  27. openapi/openapi-client/openapi_client/models/bounding_box_rapid_blueprint.py +96 -0
  28. openapi/openapi-client/openapi_client/models/bounding_box_truth.py +102 -0
  29. openapi/openapi-client/openapi_client/models/box_shape.py +122 -0
  30. openapi/openapi-client/openapi_client/models/classification_metadata.py +110 -0
  31. openapi/openapi-client/openapi_client/models/classification_metadata_filter_config.py +96 -0
  32. openapi/openapi-client/openapi_client/models/classify_payload.py +98 -0
  33. openapi/openapi-client/openapi_client/models/clone_dataset_model.py +98 -0
  34. openapi/openapi-client/openapi_client/models/clone_order_model.py +89 -0
  35. openapi/openapi-client/openapi_client/models/clone_order_result.py +89 -0
  36. openapi/openapi-client/openapi_client/models/compare_payload.py +96 -0
  37. openapi/openapi-client/openapi_client/models/compare_rapid_blueprint.py +96 -0
  38. openapi/openapi-client/openapi_client/models/compare_truth.py +96 -0
  39. openapi/openapi-client/openapi_client/models/compare_workflow_config.py +143 -0
  40. openapi/openapi-client/openapi_client/models/compare_workflow_config_rapid_selection_configs_inner.py +210 -0
  41. openapi/openapi-client/openapi_client/models/compare_workflow_config_referee.py +154 -0
  42. openapi/openapi-client/openapi_client/models/compare_workflow_model.py +106 -0
  43. openapi/openapi-client/openapi_client/models/conditional_validation_rapid_selection_config.py +113 -0
  44. openapi/openapi-client/openapi_client/models/correlated_rapid_selection_config.py +98 -0
  45. openapi/openapi-client/openapi_client/models/count_classification_metadata_filter_config.py +94 -0
  46. openapi/openapi-client/openapi_client/models/count_metadata.py +110 -0
  47. openapi/openapi-client/openapi_client/models/country_user_filter_model.py +96 -0
  48. openapi/openapi-client/openapi_client/models/create_client_model.py +89 -0
  49. openapi/openapi-client/openapi_client/models/create_complex_order_model.py +95 -0
  50. openapi/openapi-client/openapi_client/models/create_complex_order_model_pipeline.py +126 -0
  51. openapi/openapi-client/openapi_client/models/create_complex_order_result.py +96 -0
  52. openapi/openapi-client/openapi_client/models/create_dataset_artifact_model.py +102 -0
  53. openapi/openapi-client/openapi_client/models/create_dataset_artifact_model_dataset.py +126 -0
  54. openapi/openapi-client/openapi_client/models/create_default_order_model.py +109 -0
  55. openapi/openapi-client/openapi_client/models/create_default_order_model_workflow_config.py +140 -0
  56. openapi/openapi-client/openapi_client/models/create_empty_validation_set_result.py +87 -0
  57. openapi/openapi-client/openapi_client/models/create_legacy_order_result.py +89 -0
  58. openapi/openapi-client/openapi_client/models/create_order_model.py +163 -0
  59. openapi/openapi-client/openapi_client/models/create_order_model_referee.py +126 -0
  60. openapi/openapi-client/openapi_client/models/create_order_model_selections_inner.py +154 -0
  61. openapi/openapi-client/openapi_client/models/create_order_model_user_filters_inner.py +154 -0
  62. openapi/openapi-client/openapi_client/models/create_order_model_workflow.py +140 -0
  63. openapi/openapi-client/openapi_client/models/create_order_result.py +96 -0
  64. openapi/openapi-client/openapi_client/models/create_simple_pipeline_model.py +116 -0
  65. openapi/openapi-client/openapi_client/models/create_simple_pipeline_model_artifacts_inner.py +126 -0
  66. openapi/openapi-client/openapi_client/models/create_simple_pipeline_model_pipeline_steps_inner.py +182 -0
  67. openapi/openapi-client/openapi_client/models/create_unsupported_order_model.py +91 -0
  68. openapi/openapi-client/openapi_client/models/customer_order_model.py +101 -0
  69. openapi/openapi-client/openapi_client/models/customer_order_model_paged_result.py +105 -0
  70. openapi/openapi-client/openapi_client/models/datapoint.py +121 -0
  71. openapi/openapi-client/openapi_client/models/datapoint_asset.py +170 -0
  72. openapi/openapi-client/openapi_client/models/datapoint_get_by_id_get200_response.py +126 -0
  73. openapi/openapi-client/openapi_client/models/datapoint_metadata_model.py +97 -0
  74. openapi/openapi-client/openapi_client/models/datapoint_metadata_model_metadata_inner.py +168 -0
  75. openapi/openapi-client/openapi_client/models/datapoint_model.py +95 -0
  76. openapi/openapi-client/openapi_client/models/datapoint_model_asset.py +170 -0
  77. openapi/openapi-client/openapi_client/models/dataset_evaluation_step_model.py +102 -0
  78. openapi/openapi-client/openapi_client/models/demographic_rapid_selection_config.py +96 -0
  79. openapi/openapi-client/openapi_client/models/demographic_selection.py +96 -0
  80. openapi/openapi-client/openapi_client/models/empty_validation_truth.py +94 -0
  81. openapi/openapi-client/openapi_client/models/error_type.py +40 -0
  82. openapi/openapi-client/openapi_client/models/feature_flag.py +89 -0
  83. openapi/openapi-client/openapi_client/models/feature_flag_model.py +89 -0
  84. openapi/openapi-client/openapi_client/models/feedback_model.py +94 -0
  85. openapi/openapi-client/openapi_client/models/file_asset.py +108 -0
  86. openapi/openapi-client/openapi_client/models/file_asset_metadata_inner.py +224 -0
  87. openapi/openapi-client/openapi_client/models/file_asset_model.py +108 -0
  88. openapi/openapi-client/openapi_client/models/filter.py +134 -0
  89. openapi/openapi-client/openapi_client/models/filter_operator.py +44 -0
  90. openapi/openapi-client/openapi_client/models/free_text_payload.py +96 -0
  91. openapi/openapi-client/openapi_client/models/free_text_rapid_blueprint.py +96 -0
  92. openapi/openapi-client/openapi_client/models/gender.py +38 -0
  93. openapi/openapi-client/openapi_client/models/gender_user_filter_model.py +97 -0
  94. openapi/openapi-client/openapi_client/models/get_available_validation_sets_result.py +95 -0
  95. openapi/openapi-client/openapi_client/models/get_datapoints_by_dataset_id_result.py +95 -0
  96. openapi/openapi-client/openapi_client/models/get_dataset_by_id_result.py +87 -0
  97. openapi/openapi-client/openapi_client/models/get_order_by_id_result.py +98 -0
  98. openapi/openapi-client/openapi_client/models/get_order_results_result.py +91 -0
  99. openapi/openapi-client/openapi_client/models/get_public_orders_result.py +95 -0
  100. openapi/openapi-client/openapi_client/models/get_workflow_config_result.py +91 -0
  101. openapi/openapi-client/openapi_client/models/get_workflow_config_result_workflow_config.py +140 -0
  102. openapi/openapi-client/openapi_client/models/image_dimension_metadata.py +112 -0
  103. openapi/openapi-client/openapi_client/models/import_from_file_result.py +87 -0
  104. openapi/openapi-client/openapi_client/models/import_validation_set_from_file_result.py +87 -0
  105. openapi/openapi-client/openapi_client/models/issue_auth_token_result.py +87 -0
  106. openapi/openapi-client/openapi_client/models/issue_client_auth_token_result.py +87 -0
  107. openapi/openapi-client/openapi_client/models/labeling_selection.py +96 -0
  108. openapi/openapi-client/openapi_client/models/line_payload.py +96 -0
  109. openapi/openapi-client/openapi_client/models/line_rapid_blueprint.py +96 -0
  110. openapi/openapi-client/openapi_client/models/line_truth.py +94 -0
  111. openapi/openapi-client/openapi_client/models/locate_box_truth.py +104 -0
  112. openapi/openapi-client/openapi_client/models/locate_payload.py +96 -0
  113. openapi/openapi-client/openapi_client/models/locate_rapid_blueprint.py +96 -0
  114. openapi/openapi-client/openapi_client/models/location_metadata.py +112 -0
  115. openapi/openapi-client/openapi_client/models/location_metadata_exists_filter_config.py +94 -0
  116. openapi/openapi-client/openapi_client/models/logic_operator.py +37 -0
  117. openapi/openapi-client/openapi_client/models/login_model.py +89 -0
  118. openapi/openapi-client/openapi_client/models/metadata_visibilities.py +40 -0
  119. openapi/openapi-client/openapi_client/models/multi_asset.py +116 -0
  120. openapi/openapi-client/openapi_client/models/multi_asset_model.py +118 -0
  121. openapi/openapi-client/openapi_client/models/naive_referee_config.py +96 -0
  122. openapi/openapi-client/openapi_client/models/naive_referee_model.py +96 -0
  123. openapi/openapi-client/openapi_client/models/named_classification.py +100 -0
  124. openapi/openapi-client/openapi_client/models/named_entity_payload.py +98 -0
  125. openapi/openapi-client/openapi_client/models/named_entity_rapid_blueprint.py +98 -0
  126. openapi/openapi-client/openapi_client/models/named_entity_truth.py +104 -0
  127. openapi/openapi-client/openapi_client/models/never_ending_referee_config.py +94 -0
  128. openapi/openapi-client/openapi_client/models/newsletter_model.py +89 -0
  129. openapi/openapi-client/openapi_client/models/no_validation_workflow_rapid_selection_config.py +101 -0
  130. openapi/openapi-client/openapi_client/models/null_asset.py +104 -0
  131. openapi/openapi-client/openapi_client/models/null_asset_model.py +106 -0
  132. openapi/openapi-client/openapi_client/models/only_validation_workflow_rapid_selection_config.py +96 -0
  133. openapi/openapi-client/openapi_client/models/order_model.py +91 -0
  134. openapi/openapi-client/openapi_client/models/order_query_get200_response.py +137 -0
  135. openapi/openapi-client/openapi_client/models/original_filename_metadata.py +110 -0
  136. openapi/openapi-client/openapi_client/models/page_info.py +94 -0
  137. openapi/openapi-client/openapi_client/models/polygon_payload.py +96 -0
  138. openapi/openapi-client/openapi_client/models/polygon_rapid_blueprint.py +96 -0
  139. openapi/openapi-client/openapi_client/models/polygon_truth.py +94 -0
  140. openapi/openapi-client/openapi_client/models/private_text_metadata_input.py +98 -0
  141. openapi/openapi-client/openapi_client/models/probabilistic_attach_category_referee_config.py +98 -0
  142. openapi/openapi-client/openapi_client/models/prompt_metadata.py +110 -0
  143. openapi/openapi-client/openapi_client/models/prompt_metadata_input.py +98 -0
  144. openapi/openapi-client/openapi_client/models/public_text_metadata_input.py +98 -0
  145. openapi/openapi-client/openapi_client/models/query_orders_model.py +112 -0
  146. openapi/openapi-client/openapi_client/models/query_validation_set_model.py +112 -0
  147. openapi/openapi-client/openapi_client/models/request_password_reset_command.py +98 -0
  148. openapi/openapi-client/openapi_client/models/root_filter.py +107 -0
  149. openapi/openapi-client/openapi_client/models/send_completion_mail_step_model.py +98 -0
  150. openapi/openapi-client/openapi_client/models/signup_customer_model.py +93 -0
  151. openapi/openapi-client/openapi_client/models/signup_shadow_customer_model.py +87 -0
  152. openapi/openapi-client/openapi_client/models/simple_workflow_config.py +137 -0
  153. openapi/openapi-client/openapi_client/models/simple_workflow_config_blueprint.py +238 -0
  154. openapi/openapi-client/openapi_client/models/simple_workflow_model.py +100 -0
  155. openapi/openapi-client/openapi_client/models/simple_workflow_model_blueprint.py +238 -0
  156. openapi/openapi-client/openapi_client/models/sort_criterion.py +96 -0
  157. openapi/openapi-client/openapi_client/models/sort_direction.py +37 -0
  158. openapi/openapi-client/openapi_client/models/static_rapid_selection_config.py +96 -0
  159. openapi/openapi-client/openapi_client/models/submit_coco_model.py +91 -0
  160. openapi/openapi-client/openapi_client/models/submit_coco_result.py +87 -0
  161. openapi/openapi-client/openapi_client/models/submit_password_reset_command.py +102 -0
  162. openapi/openapi-client/openapi_client/models/text_asset.py +106 -0
  163. openapi/openapi-client/openapi_client/models/text_asset_model.py +108 -0
  164. openapi/openapi-client/openapi_client/models/text_metadata.py +107 -0
  165. openapi/openapi-client/openapi_client/models/transcription_metadata.py +107 -0
  166. openapi/openapi-client/openapi_client/models/transcription_metadata_input.py +98 -0
  167. openapi/openapi-client/openapi_client/models/transcription_payload.py +106 -0
  168. openapi/openapi-client/openapi_client/models/transcription_rapid_blueprint.py +96 -0
  169. openapi/openapi-client/openapi_client/models/transcription_truth.py +106 -0
  170. openapi/openapi-client/openapi_client/models/transcription_word.py +89 -0
  171. openapi/openapi-client/openapi_client/models/unlock_order_result.py +87 -0
  172. openapi/openapi-client/openapi_client/models/update_access_model.py +87 -0
  173. openapi/openapi-client/openapi_client/models/update_order_model.py +87 -0
  174. openapi/openapi-client/openapi_client/models/update_workflow_config_model.py +100 -0
  175. openapi/openapi-client/openapi_client/models/update_workflow_config_model_workflow_config.py +140 -0
  176. openapi/openapi-client/openapi_client/models/upload_coco_result.py +91 -0
  177. openapi/openapi-client/openapi_client/models/upload_datapoints_result.py +97 -0
  178. openapi/openapi-client/openapi_client/models/upload_files_from_s3_bucket_model.py +116 -0
  179. openapi/openapi-client/openapi_client/models/upload_text_sources_to_dataset_model.py +89 -0
  180. openapi/openapi-client/openapi_client/models/validation_chance.py +91 -0
  181. openapi/openapi-client/openapi_client/models/validation_import_post_request_blueprint.py +238 -0
  182. openapi/openapi-client/openapi_client/models/validation_rapid_selection_config.py +98 -0
  183. openapi/openapi-client/openapi_client/models/validation_selection.py +98 -0
  184. openapi/openapi-client/openapi_client/models/validation_set.py +105 -0
  185. openapi/openapi-client/openapi_client/models/validation_set_overview_model.py +91 -0
  186. openapi/openapi-client/openapi_client/models/validation_set_paged_result.py +105 -0
  187. openapi/openapi-client/openapi_client/models/workflow_aggregation_step_model.py +112 -0
  188. openapi/openapi-client/openapi_client/models/workflow_labeling_step_model.py +96 -0
  189. openapi/openapi-client/openapi_client/models/workflow_split_model.py +110 -0
  190. openapi/openapi-client/openapi_client/models/workflow_split_model_filter_configs_inner.py +154 -0
  191. openapi/openapi-client/openapi_client/rest.py +257 -0
  192. rapidata/rapidata_client/{workflow/feature_flags → feature_flags}/feature_flags.py +5 -3
  193. rapidata/rapidata_client/metadata/__init__.py +0 -0
  194. rapidata/rapidata_client/metadata/base_metadata.py +12 -0
  195. rapidata/rapidata_client/metadata/transcription_metadata.py +19 -0
  196. rapidata/rapidata_client/order/dataset/rapidata_dataset.py +42 -16
  197. rapidata/rapidata_client/order/dataset/validation_set_builder.py +187 -0
  198. rapidata/rapidata_client/order/rapidata_order.py +49 -23
  199. rapidata/rapidata_client/order/rapidata_order_builder.py +126 -8
  200. rapidata/rapidata_client/rapidata_client.py +17 -5
  201. rapidata/rapidata_client/{workflow/referee → referee}/base_referee.py +8 -2
  202. rapidata/rapidata_client/{workflow/referee → referee}/classify_early_stopping_referee.py +1 -1
  203. rapidata/rapidata_client/{workflow/referee → referee}/naive_referee.py +5 -1
  204. rapidata/rapidata_client/workflow/__init__.py +0 -2
  205. rapidata/rapidata_client/workflow/base_workflow.py +9 -5
  206. rapidata/rapidata_client/workflow/classify_workflow.py +18 -3
  207. rapidata/rapidata_client/workflow/compare_workflow.py +13 -14
  208. rapidata/rapidata_client/workflow/free_text_workflow.py +14 -0
  209. rapidata/rapidata_client/workflow/transcription_workflow.py +22 -0
  210. rapidata/service/__init__.py +0 -1
  211. rapidata/service/openapi_service.py +43 -0
  212. {rapidata-0.1.3.dist-info → rapidata-0.1.5.dist-info}/METADATA +1 -1
  213. rapidata-0.1.5.dist-info/RECORD +227 -0
  214. rapidata/service/rapidata_api_services/base_service.py +0 -76
  215. rapidata/service/rapidata_api_services/dataset_service.py +0 -82
  216. rapidata/service/rapidata_api_services/order_service.py +0 -49
  217. rapidata/service/rapidata_api_services/rapidata_service.py +0 -18
  218. rapidata-0.1.3.dist-info/RECORD +0 -34
  219. /rapidata/service/rapidata_api_services/__init__.py → /openapi/openapi-client/openapi_client/py.typed +0 -0
  220. /rapidata/rapidata_client/{workflow/country_codes → country_codes}/__init__.py +0 -0
  221. /rapidata/rapidata_client/{workflow/country_codes → country_codes}/country_codes.py +0 -0
  222. /rapidata/rapidata_client/{workflow/feature_flags → feature_flags}/__init__.py +0 -0
  223. /rapidata/rapidata_client/{workflow/referee → referee}/__init__.py +0 -0
  224. {rapidata-0.1.3.dist-info → rapidata-0.1.5.dist-info}/LICENSE +0 -0
  225. {rapidata-0.1.3.dist-info → rapidata-0.1.5.dist-info}/WHEEL +0 -0
@@ -0,0 +1,3181 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Rapidata.Dataset
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: v1
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictStr
20
+ from typing import Optional
21
+ from typing_extensions import Annotated
22
+ from openapi_client.models.create_client_model import CreateClientModel
23
+ from openapi_client.models.issue_auth_token_result import IssueAuthTokenResult
24
+ from openapi_client.models.issue_client_auth_token_result import IssueClientAuthTokenResult
25
+ from openapi_client.models.login_model import LoginModel
26
+ from openapi_client.models.request_password_reset_command import RequestPasswordResetCommand
27
+ from openapi_client.models.signup_customer_model import SignupCustomerModel
28
+ from openapi_client.models.signup_shadow_customer_model import SignupShadowCustomerModel
29
+ from openapi_client.models.submit_password_reset_command import SubmitPasswordResetCommand
30
+
31
+ from openapi_client.api_client import ApiClient, RequestSerialized
32
+ from openapi_client.api_response import ApiResponse
33
+ from openapi_client.rest import RESTResponseType
34
+
35
+
36
+ class IdentityApi:
37
+ """NOTE: This class is auto generated by OpenAPI Generator
38
+ Ref: https://openapi-generator.tech
39
+
40
+ Do not edit the class manually.
41
+ """
42
+
43
+ def __init__(self, api_client=None) -> None:
44
+ if api_client is None:
45
+ api_client = ApiClient.get_default()
46
+ self.api_client = api_client
47
+
48
+
49
+ @validate_call
50
+ def identity_confirm_get(
51
+ self,
52
+ user_id: Annotated[Optional[StrictStr], Field(description="The id of the user to confirm the signup for.")] = None,
53
+ token: Annotated[Optional[StrictStr], Field(description="The confirmation token received by mail.")] = None,
54
+ _request_timeout: Union[
55
+ None,
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Tuple[
58
+ Annotated[StrictFloat, Field(gt=0)],
59
+ Annotated[StrictFloat, Field(gt=0)]
60
+ ]
61
+ ] = None,
62
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
63
+ _content_type: Optional[StrictStr] = None,
64
+ _headers: Optional[Dict[StrictStr, Any]] = None,
65
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
66
+ ) -> None:
67
+ """Confirms a user's signup by a token.
68
+
69
+
70
+ :param user_id: The id of the user to confirm the signup for.
71
+ :type user_id: str
72
+ :param token: The confirmation token received by mail.
73
+ :type token: str
74
+ :param _request_timeout: timeout setting for this request. If one
75
+ number provided, it will be total request
76
+ timeout. It can also be a pair (tuple) of
77
+ (connection, read) timeouts.
78
+ :type _request_timeout: int, tuple(int, int), optional
79
+ :param _request_auth: set to override the auth_settings for an a single
80
+ request; this effectively ignores the
81
+ authentication in the spec for a single request.
82
+ :type _request_auth: dict, optional
83
+ :param _content_type: force content-type for the request.
84
+ :type _content_type: str, Optional
85
+ :param _headers: set to override the headers for a single
86
+ request; this effectively ignores the headers
87
+ in the spec for a single request.
88
+ :type _headers: dict, optional
89
+ :param _host_index: set to override the host_index for a single
90
+ request; this effectively ignores the host_index
91
+ in the spec for a single request.
92
+ :type _host_index: int, optional
93
+ :return: Returns the result object.
94
+ """ # noqa: E501
95
+
96
+ _param = self._identity_confirm_get_serialize(
97
+ user_id=user_id,
98
+ token=token,
99
+ _request_auth=_request_auth,
100
+ _content_type=_content_type,
101
+ _headers=_headers,
102
+ _host_index=_host_index
103
+ )
104
+
105
+ _response_types_map: Dict[str, Optional[str]] = {
106
+ '200': None,
107
+ }
108
+ response_data = self.api_client.call_api(
109
+ *_param,
110
+ _request_timeout=_request_timeout
111
+ )
112
+ response_data.read()
113
+ return self.api_client.response_deserialize(
114
+ response_data=response_data,
115
+ response_types_map=_response_types_map,
116
+ ).data
117
+
118
+
119
+ @validate_call
120
+ def identity_confirm_get_with_http_info(
121
+ self,
122
+ user_id: Annotated[Optional[StrictStr], Field(description="The id of the user to confirm the signup for.")] = None,
123
+ token: Annotated[Optional[StrictStr], Field(description="The confirmation token received by mail.")] = None,
124
+ _request_timeout: Union[
125
+ None,
126
+ Annotated[StrictFloat, Field(gt=0)],
127
+ Tuple[
128
+ Annotated[StrictFloat, Field(gt=0)],
129
+ Annotated[StrictFloat, Field(gt=0)]
130
+ ]
131
+ ] = None,
132
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
133
+ _content_type: Optional[StrictStr] = None,
134
+ _headers: Optional[Dict[StrictStr, Any]] = None,
135
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
136
+ ) -> ApiResponse[None]:
137
+ """Confirms a user's signup by a token.
138
+
139
+
140
+ :param user_id: The id of the user to confirm the signup for.
141
+ :type user_id: str
142
+ :param token: The confirmation token received by mail.
143
+ :type token: str
144
+ :param _request_timeout: timeout setting for this request. If one
145
+ number provided, it will be total request
146
+ timeout. It can also be a pair (tuple) of
147
+ (connection, read) timeouts.
148
+ :type _request_timeout: int, tuple(int, int), optional
149
+ :param _request_auth: set to override the auth_settings for an a single
150
+ request; this effectively ignores the
151
+ authentication in the spec for a single request.
152
+ :type _request_auth: dict, optional
153
+ :param _content_type: force content-type for the request.
154
+ :type _content_type: str, Optional
155
+ :param _headers: set to override the headers for a single
156
+ request; this effectively ignores the headers
157
+ in the spec for a single request.
158
+ :type _headers: dict, optional
159
+ :param _host_index: set to override the host_index for a single
160
+ request; this effectively ignores the host_index
161
+ in the spec for a single request.
162
+ :type _host_index: int, optional
163
+ :return: Returns the result object.
164
+ """ # noqa: E501
165
+
166
+ _param = self._identity_confirm_get_serialize(
167
+ user_id=user_id,
168
+ token=token,
169
+ _request_auth=_request_auth,
170
+ _content_type=_content_type,
171
+ _headers=_headers,
172
+ _host_index=_host_index
173
+ )
174
+
175
+ _response_types_map: Dict[str, Optional[str]] = {
176
+ '200': None,
177
+ }
178
+ response_data = self.api_client.call_api(
179
+ *_param,
180
+ _request_timeout=_request_timeout
181
+ )
182
+ response_data.read()
183
+ return self.api_client.response_deserialize(
184
+ response_data=response_data,
185
+ response_types_map=_response_types_map,
186
+ )
187
+
188
+
189
+ @validate_call
190
+ def identity_confirm_get_without_preload_content(
191
+ self,
192
+ user_id: Annotated[Optional[StrictStr], Field(description="The id of the user to confirm the signup for.")] = None,
193
+ token: Annotated[Optional[StrictStr], Field(description="The confirmation token received by mail.")] = None,
194
+ _request_timeout: Union[
195
+ None,
196
+ Annotated[StrictFloat, Field(gt=0)],
197
+ Tuple[
198
+ Annotated[StrictFloat, Field(gt=0)],
199
+ Annotated[StrictFloat, Field(gt=0)]
200
+ ]
201
+ ] = None,
202
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
203
+ _content_type: Optional[StrictStr] = None,
204
+ _headers: Optional[Dict[StrictStr, Any]] = None,
205
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
206
+ ) -> RESTResponseType:
207
+ """Confirms a user's signup by a token.
208
+
209
+
210
+ :param user_id: The id of the user to confirm the signup for.
211
+ :type user_id: str
212
+ :param token: The confirmation token received by mail.
213
+ :type token: str
214
+ :param _request_timeout: timeout setting for this request. If one
215
+ number provided, it will be total request
216
+ timeout. It can also be a pair (tuple) of
217
+ (connection, read) timeouts.
218
+ :type _request_timeout: int, tuple(int, int), optional
219
+ :param _request_auth: set to override the auth_settings for an a single
220
+ request; this effectively ignores the
221
+ authentication in the spec for a single request.
222
+ :type _request_auth: dict, optional
223
+ :param _content_type: force content-type for the request.
224
+ :type _content_type: str, Optional
225
+ :param _headers: set to override the headers for a single
226
+ request; this effectively ignores the headers
227
+ in the spec for a single request.
228
+ :type _headers: dict, optional
229
+ :param _host_index: set to override the host_index for a single
230
+ request; this effectively ignores the host_index
231
+ in the spec for a single request.
232
+ :type _host_index: int, optional
233
+ :return: Returns the result object.
234
+ """ # noqa: E501
235
+
236
+ _param = self._identity_confirm_get_serialize(
237
+ user_id=user_id,
238
+ token=token,
239
+ _request_auth=_request_auth,
240
+ _content_type=_content_type,
241
+ _headers=_headers,
242
+ _host_index=_host_index
243
+ )
244
+
245
+ _response_types_map: Dict[str, Optional[str]] = {
246
+ '200': None,
247
+ }
248
+ response_data = self.api_client.call_api(
249
+ *_param,
250
+ _request_timeout=_request_timeout
251
+ )
252
+ return response_data.response
253
+
254
+
255
+ def _identity_confirm_get_serialize(
256
+ self,
257
+ user_id,
258
+ token,
259
+ _request_auth,
260
+ _content_type,
261
+ _headers,
262
+ _host_index,
263
+ ) -> RequestSerialized:
264
+
265
+ _host = None
266
+
267
+ _collection_formats: Dict[str, str] = {
268
+ }
269
+
270
+ _path_params: Dict[str, str] = {}
271
+ _query_params: List[Tuple[str, str]] = []
272
+ _header_params: Dict[str, Optional[str]] = _headers or {}
273
+ _form_params: List[Tuple[str, str]] = []
274
+ _files: Dict[
275
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
276
+ ] = {}
277
+ _body_params: Optional[bytes] = None
278
+
279
+ # process the path parameters
280
+ # process the query parameters
281
+ if user_id is not None:
282
+
283
+ _query_params.append(('userId', user_id))
284
+
285
+ if token is not None:
286
+
287
+ _query_params.append(('token', token))
288
+
289
+ # process the header parameters
290
+ # process the form parameters
291
+ # process the body parameter
292
+
293
+
294
+
295
+
296
+ # authentication setting
297
+ _auth_settings: List[str] = [
298
+ 'bearer'
299
+ ]
300
+
301
+ return self.api_client.param_serialize(
302
+ method='GET',
303
+ resource_path='/Identity/Confirm',
304
+ path_params=_path_params,
305
+ query_params=_query_params,
306
+ header_params=_header_params,
307
+ body=_body_params,
308
+ post_params=_form_params,
309
+ files=_files,
310
+ auth_settings=_auth_settings,
311
+ collection_formats=_collection_formats,
312
+ _host=_host,
313
+ _request_auth=_request_auth
314
+ )
315
+
316
+
317
+
318
+
319
+ @validate_call
320
+ def identity_create_client_post(
321
+ self,
322
+ create_client_model: Annotated[Optional[CreateClientModel], Field(description="The model for creating a new client.")] = None,
323
+ _request_timeout: Union[
324
+ None,
325
+ Annotated[StrictFloat, Field(gt=0)],
326
+ Tuple[
327
+ Annotated[StrictFloat, Field(gt=0)],
328
+ Annotated[StrictFloat, Field(gt=0)]
329
+ ]
330
+ ] = None,
331
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
332
+ _content_type: Optional[StrictStr] = None,
333
+ _headers: Optional[Dict[StrictStr, Any]] = None,
334
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
335
+ ) -> None:
336
+ """Creates a new client for a customer.
337
+
338
+ A client represents an application or project that a customer might use to access the API. The clients are used for machine-to-machine communication.
339
+
340
+ :param create_client_model: The model for creating a new client.
341
+ :type create_client_model: CreateClientModel
342
+ :param _request_timeout: timeout setting for this request. If one
343
+ number provided, it will be total request
344
+ timeout. It can also be a pair (tuple) of
345
+ (connection, read) timeouts.
346
+ :type _request_timeout: int, tuple(int, int), optional
347
+ :param _request_auth: set to override the auth_settings for an a single
348
+ request; this effectively ignores the
349
+ authentication in the spec for a single request.
350
+ :type _request_auth: dict, optional
351
+ :param _content_type: force content-type for the request.
352
+ :type _content_type: str, Optional
353
+ :param _headers: set to override the headers for a single
354
+ request; this effectively ignores the headers
355
+ in the spec for a single request.
356
+ :type _headers: dict, optional
357
+ :param _host_index: set to override the host_index for a single
358
+ request; this effectively ignores the host_index
359
+ in the spec for a single request.
360
+ :type _host_index: int, optional
361
+ :return: Returns the result object.
362
+ """ # noqa: E501
363
+
364
+ _param = self._identity_create_client_post_serialize(
365
+ create_client_model=create_client_model,
366
+ _request_auth=_request_auth,
367
+ _content_type=_content_type,
368
+ _headers=_headers,
369
+ _host_index=_host_index
370
+ )
371
+
372
+ _response_types_map: Dict[str, Optional[str]] = {
373
+ '200': None,
374
+ }
375
+ response_data = self.api_client.call_api(
376
+ *_param,
377
+ _request_timeout=_request_timeout
378
+ )
379
+ response_data.read()
380
+ return self.api_client.response_deserialize(
381
+ response_data=response_data,
382
+ response_types_map=_response_types_map,
383
+ ).data
384
+
385
+
386
+ @validate_call
387
+ def identity_create_client_post_with_http_info(
388
+ self,
389
+ create_client_model: Annotated[Optional[CreateClientModel], Field(description="The model for creating a new client.")] = None,
390
+ _request_timeout: Union[
391
+ None,
392
+ Annotated[StrictFloat, Field(gt=0)],
393
+ Tuple[
394
+ Annotated[StrictFloat, Field(gt=0)],
395
+ Annotated[StrictFloat, Field(gt=0)]
396
+ ]
397
+ ] = None,
398
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
399
+ _content_type: Optional[StrictStr] = None,
400
+ _headers: Optional[Dict[StrictStr, Any]] = None,
401
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
402
+ ) -> ApiResponse[None]:
403
+ """Creates a new client for a customer.
404
+
405
+ A client represents an application or project that a customer might use to access the API. The clients are used for machine-to-machine communication.
406
+
407
+ :param create_client_model: The model for creating a new client.
408
+ :type create_client_model: CreateClientModel
409
+ :param _request_timeout: timeout setting for this request. If one
410
+ number provided, it will be total request
411
+ timeout. It can also be a pair (tuple) of
412
+ (connection, read) timeouts.
413
+ :type _request_timeout: int, tuple(int, int), optional
414
+ :param _request_auth: set to override the auth_settings for an a single
415
+ request; this effectively ignores the
416
+ authentication in the spec for a single request.
417
+ :type _request_auth: dict, optional
418
+ :param _content_type: force content-type for the request.
419
+ :type _content_type: str, Optional
420
+ :param _headers: set to override the headers for a single
421
+ request; this effectively ignores the headers
422
+ in the spec for a single request.
423
+ :type _headers: dict, optional
424
+ :param _host_index: set to override the host_index for a single
425
+ request; this effectively ignores the host_index
426
+ in the spec for a single request.
427
+ :type _host_index: int, optional
428
+ :return: Returns the result object.
429
+ """ # noqa: E501
430
+
431
+ _param = self._identity_create_client_post_serialize(
432
+ create_client_model=create_client_model,
433
+ _request_auth=_request_auth,
434
+ _content_type=_content_type,
435
+ _headers=_headers,
436
+ _host_index=_host_index
437
+ )
438
+
439
+ _response_types_map: Dict[str, Optional[str]] = {
440
+ '200': None,
441
+ }
442
+ response_data = self.api_client.call_api(
443
+ *_param,
444
+ _request_timeout=_request_timeout
445
+ )
446
+ response_data.read()
447
+ return self.api_client.response_deserialize(
448
+ response_data=response_data,
449
+ response_types_map=_response_types_map,
450
+ )
451
+
452
+
453
+ @validate_call
454
+ def identity_create_client_post_without_preload_content(
455
+ self,
456
+ create_client_model: Annotated[Optional[CreateClientModel], Field(description="The model for creating a new client.")] = None,
457
+ _request_timeout: Union[
458
+ None,
459
+ Annotated[StrictFloat, Field(gt=0)],
460
+ Tuple[
461
+ Annotated[StrictFloat, Field(gt=0)],
462
+ Annotated[StrictFloat, Field(gt=0)]
463
+ ]
464
+ ] = None,
465
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
466
+ _content_type: Optional[StrictStr] = None,
467
+ _headers: Optional[Dict[StrictStr, Any]] = None,
468
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
469
+ ) -> RESTResponseType:
470
+ """Creates a new client for a customer.
471
+
472
+ A client represents an application or project that a customer might use to access the API. The clients are used for machine-to-machine communication.
473
+
474
+ :param create_client_model: The model for creating a new client.
475
+ :type create_client_model: CreateClientModel
476
+ :param _request_timeout: timeout setting for this request. If one
477
+ number provided, it will be total request
478
+ timeout. It can also be a pair (tuple) of
479
+ (connection, read) timeouts.
480
+ :type _request_timeout: int, tuple(int, int), optional
481
+ :param _request_auth: set to override the auth_settings for an a single
482
+ request; this effectively ignores the
483
+ authentication in the spec for a single request.
484
+ :type _request_auth: dict, optional
485
+ :param _content_type: force content-type for the request.
486
+ :type _content_type: str, Optional
487
+ :param _headers: set to override the headers for a single
488
+ request; this effectively ignores the headers
489
+ in the spec for a single request.
490
+ :type _headers: dict, optional
491
+ :param _host_index: set to override the host_index for a single
492
+ request; this effectively ignores the host_index
493
+ in the spec for a single request.
494
+ :type _host_index: int, optional
495
+ :return: Returns the result object.
496
+ """ # noqa: E501
497
+
498
+ _param = self._identity_create_client_post_serialize(
499
+ create_client_model=create_client_model,
500
+ _request_auth=_request_auth,
501
+ _content_type=_content_type,
502
+ _headers=_headers,
503
+ _host_index=_host_index
504
+ )
505
+
506
+ _response_types_map: Dict[str, Optional[str]] = {
507
+ '200': None,
508
+ }
509
+ response_data = self.api_client.call_api(
510
+ *_param,
511
+ _request_timeout=_request_timeout
512
+ )
513
+ return response_data.response
514
+
515
+
516
+ def _identity_create_client_post_serialize(
517
+ self,
518
+ create_client_model,
519
+ _request_auth,
520
+ _content_type,
521
+ _headers,
522
+ _host_index,
523
+ ) -> RequestSerialized:
524
+
525
+ _host = None
526
+
527
+ _collection_formats: Dict[str, str] = {
528
+ }
529
+
530
+ _path_params: Dict[str, str] = {}
531
+ _query_params: List[Tuple[str, str]] = []
532
+ _header_params: Dict[str, Optional[str]] = _headers or {}
533
+ _form_params: List[Tuple[str, str]] = []
534
+ _files: Dict[
535
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
536
+ ] = {}
537
+ _body_params: Optional[bytes] = None
538
+
539
+ # process the path parameters
540
+ # process the query parameters
541
+ # process the header parameters
542
+ # process the form parameters
543
+ # process the body parameter
544
+ if create_client_model is not None:
545
+ _body_params = create_client_model
546
+
547
+
548
+
549
+ # set the HTTP header `Content-Type`
550
+ if _content_type:
551
+ _header_params['Content-Type'] = _content_type
552
+ else:
553
+ _default_content_type = (
554
+ self.api_client.select_header_content_type(
555
+ [
556
+ 'application/json',
557
+ 'text/json',
558
+ 'application/*+json'
559
+ ]
560
+ )
561
+ )
562
+ if _default_content_type is not None:
563
+ _header_params['Content-Type'] = _default_content_type
564
+
565
+ # authentication setting
566
+ _auth_settings: List[str] = [
567
+ 'bearer'
568
+ ]
569
+
570
+ return self.api_client.param_serialize(
571
+ method='POST',
572
+ resource_path='/Identity/CreateClient',
573
+ path_params=_path_params,
574
+ query_params=_query_params,
575
+ header_params=_header_params,
576
+ body=_body_params,
577
+ post_params=_form_params,
578
+ files=_files,
579
+ auth_settings=_auth_settings,
580
+ collection_formats=_collection_formats,
581
+ _host=_host,
582
+ _request_auth=_request_auth
583
+ )
584
+
585
+
586
+
587
+
588
+ @validate_call
589
+ def identity_external_login_callback_get(
590
+ self,
591
+ return_url: Annotated[Optional[StrictStr], Field(description="The URL to redirect to after logging in.")] = None,
592
+ _request_timeout: Union[
593
+ None,
594
+ Annotated[StrictFloat, Field(gt=0)],
595
+ Tuple[
596
+ Annotated[StrictFloat, Field(gt=0)],
597
+ Annotated[StrictFloat, Field(gt=0)]
598
+ ]
599
+ ] = None,
600
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
601
+ _content_type: Optional[StrictStr] = None,
602
+ _headers: Optional[Dict[StrictStr, Any]] = None,
603
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
604
+ ) -> None:
605
+ """Logs in a user using after receiving a grant from an external provider.
606
+
607
+
608
+ :param return_url: The URL to redirect to after logging in.
609
+ :type return_url: str
610
+ :param _request_timeout: timeout setting for this request. If one
611
+ number provided, it will be total request
612
+ timeout. It can also be a pair (tuple) of
613
+ (connection, read) timeouts.
614
+ :type _request_timeout: int, tuple(int, int), optional
615
+ :param _request_auth: set to override the auth_settings for an a single
616
+ request; this effectively ignores the
617
+ authentication in the spec for a single request.
618
+ :type _request_auth: dict, optional
619
+ :param _content_type: force content-type for the request.
620
+ :type _content_type: str, Optional
621
+ :param _headers: set to override the headers for a single
622
+ request; this effectively ignores the headers
623
+ in the spec for a single request.
624
+ :type _headers: dict, optional
625
+ :param _host_index: set to override the host_index for a single
626
+ request; this effectively ignores the host_index
627
+ in the spec for a single request.
628
+ :type _host_index: int, optional
629
+ :return: Returns the result object.
630
+ """ # noqa: E501
631
+
632
+ _param = self._identity_external_login_callback_get_serialize(
633
+ return_url=return_url,
634
+ _request_auth=_request_auth,
635
+ _content_type=_content_type,
636
+ _headers=_headers,
637
+ _host_index=_host_index
638
+ )
639
+
640
+ _response_types_map: Dict[str, Optional[str]] = {
641
+ '302': None,
642
+ }
643
+ response_data = self.api_client.call_api(
644
+ *_param,
645
+ _request_timeout=_request_timeout
646
+ )
647
+ response_data.read()
648
+ return self.api_client.response_deserialize(
649
+ response_data=response_data,
650
+ response_types_map=_response_types_map,
651
+ ).data
652
+
653
+
654
+ @validate_call
655
+ def identity_external_login_callback_get_with_http_info(
656
+ self,
657
+ return_url: Annotated[Optional[StrictStr], Field(description="The URL to redirect to after logging in.")] = None,
658
+ _request_timeout: Union[
659
+ None,
660
+ Annotated[StrictFloat, Field(gt=0)],
661
+ Tuple[
662
+ Annotated[StrictFloat, Field(gt=0)],
663
+ Annotated[StrictFloat, Field(gt=0)]
664
+ ]
665
+ ] = None,
666
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
667
+ _content_type: Optional[StrictStr] = None,
668
+ _headers: Optional[Dict[StrictStr, Any]] = None,
669
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
670
+ ) -> ApiResponse[None]:
671
+ """Logs in a user using after receiving a grant from an external provider.
672
+
673
+
674
+ :param return_url: The URL to redirect to after logging in.
675
+ :type return_url: str
676
+ :param _request_timeout: timeout setting for this request. If one
677
+ number provided, it will be total request
678
+ timeout. It can also be a pair (tuple) of
679
+ (connection, read) timeouts.
680
+ :type _request_timeout: int, tuple(int, int), optional
681
+ :param _request_auth: set to override the auth_settings for an a single
682
+ request; this effectively ignores the
683
+ authentication in the spec for a single request.
684
+ :type _request_auth: dict, optional
685
+ :param _content_type: force content-type for the request.
686
+ :type _content_type: str, Optional
687
+ :param _headers: set to override the headers for a single
688
+ request; this effectively ignores the headers
689
+ in the spec for a single request.
690
+ :type _headers: dict, optional
691
+ :param _host_index: set to override the host_index for a single
692
+ request; this effectively ignores the host_index
693
+ in the spec for a single request.
694
+ :type _host_index: int, optional
695
+ :return: Returns the result object.
696
+ """ # noqa: E501
697
+
698
+ _param = self._identity_external_login_callback_get_serialize(
699
+ return_url=return_url,
700
+ _request_auth=_request_auth,
701
+ _content_type=_content_type,
702
+ _headers=_headers,
703
+ _host_index=_host_index
704
+ )
705
+
706
+ _response_types_map: Dict[str, Optional[str]] = {
707
+ '302': None,
708
+ }
709
+ response_data = self.api_client.call_api(
710
+ *_param,
711
+ _request_timeout=_request_timeout
712
+ )
713
+ response_data.read()
714
+ return self.api_client.response_deserialize(
715
+ response_data=response_data,
716
+ response_types_map=_response_types_map,
717
+ )
718
+
719
+
720
+ @validate_call
721
+ def identity_external_login_callback_get_without_preload_content(
722
+ self,
723
+ return_url: Annotated[Optional[StrictStr], Field(description="The URL to redirect to after logging in.")] = None,
724
+ _request_timeout: Union[
725
+ None,
726
+ Annotated[StrictFloat, Field(gt=0)],
727
+ Tuple[
728
+ Annotated[StrictFloat, Field(gt=0)],
729
+ Annotated[StrictFloat, Field(gt=0)]
730
+ ]
731
+ ] = None,
732
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
733
+ _content_type: Optional[StrictStr] = None,
734
+ _headers: Optional[Dict[StrictStr, Any]] = None,
735
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
736
+ ) -> RESTResponseType:
737
+ """Logs in a user using after receiving a grant from an external provider.
738
+
739
+
740
+ :param return_url: The URL to redirect to after logging in.
741
+ :type return_url: str
742
+ :param _request_timeout: timeout setting for this request. If one
743
+ number provided, it will be total request
744
+ timeout. It can also be a pair (tuple) of
745
+ (connection, read) timeouts.
746
+ :type _request_timeout: int, tuple(int, int), optional
747
+ :param _request_auth: set to override the auth_settings for an a single
748
+ request; this effectively ignores the
749
+ authentication in the spec for a single request.
750
+ :type _request_auth: dict, optional
751
+ :param _content_type: force content-type for the request.
752
+ :type _content_type: str, Optional
753
+ :param _headers: set to override the headers for a single
754
+ request; this effectively ignores the headers
755
+ in the spec for a single request.
756
+ :type _headers: dict, optional
757
+ :param _host_index: set to override the host_index for a single
758
+ request; this effectively ignores the host_index
759
+ in the spec for a single request.
760
+ :type _host_index: int, optional
761
+ :return: Returns the result object.
762
+ """ # noqa: E501
763
+
764
+ _param = self._identity_external_login_callback_get_serialize(
765
+ return_url=return_url,
766
+ _request_auth=_request_auth,
767
+ _content_type=_content_type,
768
+ _headers=_headers,
769
+ _host_index=_host_index
770
+ )
771
+
772
+ _response_types_map: Dict[str, Optional[str]] = {
773
+ '302': None,
774
+ }
775
+ response_data = self.api_client.call_api(
776
+ *_param,
777
+ _request_timeout=_request_timeout
778
+ )
779
+ return response_data.response
780
+
781
+
782
+ def _identity_external_login_callback_get_serialize(
783
+ self,
784
+ return_url,
785
+ _request_auth,
786
+ _content_type,
787
+ _headers,
788
+ _host_index,
789
+ ) -> RequestSerialized:
790
+
791
+ _host = None
792
+
793
+ _collection_formats: Dict[str, str] = {
794
+ }
795
+
796
+ _path_params: Dict[str, str] = {}
797
+ _query_params: List[Tuple[str, str]] = []
798
+ _header_params: Dict[str, Optional[str]] = _headers or {}
799
+ _form_params: List[Tuple[str, str]] = []
800
+ _files: Dict[
801
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
802
+ ] = {}
803
+ _body_params: Optional[bytes] = None
804
+
805
+ # process the path parameters
806
+ # process the query parameters
807
+ if return_url is not None:
808
+
809
+ _query_params.append(('returnUrl', return_url))
810
+
811
+ # process the header parameters
812
+ # process the form parameters
813
+ # process the body parameter
814
+
815
+
816
+
817
+
818
+ # authentication setting
819
+ _auth_settings: List[str] = [
820
+ 'bearer'
821
+ ]
822
+
823
+ return self.api_client.param_serialize(
824
+ method='GET',
825
+ resource_path='/Identity/ExternalLoginCallback',
826
+ path_params=_path_params,
827
+ query_params=_query_params,
828
+ header_params=_header_params,
829
+ body=_body_params,
830
+ post_params=_form_params,
831
+ files=_files,
832
+ auth_settings=_auth_settings,
833
+ collection_formats=_collection_formats,
834
+ _host=_host,
835
+ _request_auth=_request_auth
836
+ )
837
+
838
+
839
+
840
+
841
+ @validate_call
842
+ def identity_external_login_post(
843
+ self,
844
+ provider: Annotated[Optional[StrictStr], Field(description="The name of the external provider.")] = None,
845
+ return_url: Annotated[Optional[StrictStr], Field(description="The URL to redirect to after logging in.")] = None,
846
+ _request_timeout: Union[
847
+ None,
848
+ Annotated[StrictFloat, Field(gt=0)],
849
+ Tuple[
850
+ Annotated[StrictFloat, Field(gt=0)],
851
+ Annotated[StrictFloat, Field(gt=0)]
852
+ ]
853
+ ] = None,
854
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
855
+ _content_type: Optional[StrictStr] = None,
856
+ _headers: Optional[Dict[StrictStr, Any]] = None,
857
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
858
+ ) -> None:
859
+ """Logs in a user using an external provider.
860
+
861
+
862
+ :param provider: The name of the external provider.
863
+ :type provider: str
864
+ :param return_url: The URL to redirect to after logging in.
865
+ :type return_url: str
866
+ :param _request_timeout: timeout setting for this request. If one
867
+ number provided, it will be total request
868
+ timeout. It can also be a pair (tuple) of
869
+ (connection, read) timeouts.
870
+ :type _request_timeout: int, tuple(int, int), optional
871
+ :param _request_auth: set to override the auth_settings for an a single
872
+ request; this effectively ignores the
873
+ authentication in the spec for a single request.
874
+ :type _request_auth: dict, optional
875
+ :param _content_type: force content-type for the request.
876
+ :type _content_type: str, Optional
877
+ :param _headers: set to override the headers for a single
878
+ request; this effectively ignores the headers
879
+ in the spec for a single request.
880
+ :type _headers: dict, optional
881
+ :param _host_index: set to override the host_index for a single
882
+ request; this effectively ignores the host_index
883
+ in the spec for a single request.
884
+ :type _host_index: int, optional
885
+ :return: Returns the result object.
886
+ """ # noqa: E501
887
+
888
+ _param = self._identity_external_login_post_serialize(
889
+ provider=provider,
890
+ return_url=return_url,
891
+ _request_auth=_request_auth,
892
+ _content_type=_content_type,
893
+ _headers=_headers,
894
+ _host_index=_host_index
895
+ )
896
+
897
+ _response_types_map: Dict[str, Optional[str]] = {
898
+ '302': None,
899
+ }
900
+ response_data = self.api_client.call_api(
901
+ *_param,
902
+ _request_timeout=_request_timeout
903
+ )
904
+ response_data.read()
905
+ return self.api_client.response_deserialize(
906
+ response_data=response_data,
907
+ response_types_map=_response_types_map,
908
+ ).data
909
+
910
+
911
+ @validate_call
912
+ def identity_external_login_post_with_http_info(
913
+ self,
914
+ provider: Annotated[Optional[StrictStr], Field(description="The name of the external provider.")] = None,
915
+ return_url: Annotated[Optional[StrictStr], Field(description="The URL to redirect to after logging in.")] = None,
916
+ _request_timeout: Union[
917
+ None,
918
+ Annotated[StrictFloat, Field(gt=0)],
919
+ Tuple[
920
+ Annotated[StrictFloat, Field(gt=0)],
921
+ Annotated[StrictFloat, Field(gt=0)]
922
+ ]
923
+ ] = None,
924
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
925
+ _content_type: Optional[StrictStr] = None,
926
+ _headers: Optional[Dict[StrictStr, Any]] = None,
927
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
928
+ ) -> ApiResponse[None]:
929
+ """Logs in a user using an external provider.
930
+
931
+
932
+ :param provider: The name of the external provider.
933
+ :type provider: str
934
+ :param return_url: The URL to redirect to after logging in.
935
+ :type return_url: str
936
+ :param _request_timeout: timeout setting for this request. If one
937
+ number provided, it will be total request
938
+ timeout. It can also be a pair (tuple) of
939
+ (connection, read) timeouts.
940
+ :type _request_timeout: int, tuple(int, int), optional
941
+ :param _request_auth: set to override the auth_settings for an a single
942
+ request; this effectively ignores the
943
+ authentication in the spec for a single request.
944
+ :type _request_auth: dict, optional
945
+ :param _content_type: force content-type for the request.
946
+ :type _content_type: str, Optional
947
+ :param _headers: set to override the headers for a single
948
+ request; this effectively ignores the headers
949
+ in the spec for a single request.
950
+ :type _headers: dict, optional
951
+ :param _host_index: set to override the host_index for a single
952
+ request; this effectively ignores the host_index
953
+ in the spec for a single request.
954
+ :type _host_index: int, optional
955
+ :return: Returns the result object.
956
+ """ # noqa: E501
957
+
958
+ _param = self._identity_external_login_post_serialize(
959
+ provider=provider,
960
+ return_url=return_url,
961
+ _request_auth=_request_auth,
962
+ _content_type=_content_type,
963
+ _headers=_headers,
964
+ _host_index=_host_index
965
+ )
966
+
967
+ _response_types_map: Dict[str, Optional[str]] = {
968
+ '302': None,
969
+ }
970
+ response_data = self.api_client.call_api(
971
+ *_param,
972
+ _request_timeout=_request_timeout
973
+ )
974
+ response_data.read()
975
+ return self.api_client.response_deserialize(
976
+ response_data=response_data,
977
+ response_types_map=_response_types_map,
978
+ )
979
+
980
+
981
+ @validate_call
982
+ def identity_external_login_post_without_preload_content(
983
+ self,
984
+ provider: Annotated[Optional[StrictStr], Field(description="The name of the external provider.")] = None,
985
+ return_url: Annotated[Optional[StrictStr], Field(description="The URL to redirect to after logging in.")] = None,
986
+ _request_timeout: Union[
987
+ None,
988
+ Annotated[StrictFloat, Field(gt=0)],
989
+ Tuple[
990
+ Annotated[StrictFloat, Field(gt=0)],
991
+ Annotated[StrictFloat, Field(gt=0)]
992
+ ]
993
+ ] = None,
994
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
995
+ _content_type: Optional[StrictStr] = None,
996
+ _headers: Optional[Dict[StrictStr, Any]] = None,
997
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
998
+ ) -> RESTResponseType:
999
+ """Logs in a user using an external provider.
1000
+
1001
+
1002
+ :param provider: The name of the external provider.
1003
+ :type provider: str
1004
+ :param return_url: The URL to redirect to after logging in.
1005
+ :type return_url: str
1006
+ :param _request_timeout: timeout setting for this request. If one
1007
+ number provided, it will be total request
1008
+ timeout. It can also be a pair (tuple) of
1009
+ (connection, read) timeouts.
1010
+ :type _request_timeout: int, tuple(int, int), optional
1011
+ :param _request_auth: set to override the auth_settings for an a single
1012
+ request; this effectively ignores the
1013
+ authentication in the spec for a single request.
1014
+ :type _request_auth: dict, optional
1015
+ :param _content_type: force content-type for the request.
1016
+ :type _content_type: str, Optional
1017
+ :param _headers: set to override the headers for a single
1018
+ request; this effectively ignores the headers
1019
+ in the spec for a single request.
1020
+ :type _headers: dict, optional
1021
+ :param _host_index: set to override the host_index for a single
1022
+ request; this effectively ignores the host_index
1023
+ in the spec for a single request.
1024
+ :type _host_index: int, optional
1025
+ :return: Returns the result object.
1026
+ """ # noqa: E501
1027
+
1028
+ _param = self._identity_external_login_post_serialize(
1029
+ provider=provider,
1030
+ return_url=return_url,
1031
+ _request_auth=_request_auth,
1032
+ _content_type=_content_type,
1033
+ _headers=_headers,
1034
+ _host_index=_host_index
1035
+ )
1036
+
1037
+ _response_types_map: Dict[str, Optional[str]] = {
1038
+ '302': None,
1039
+ }
1040
+ response_data = self.api_client.call_api(
1041
+ *_param,
1042
+ _request_timeout=_request_timeout
1043
+ )
1044
+ return response_data.response
1045
+
1046
+
1047
+ def _identity_external_login_post_serialize(
1048
+ self,
1049
+ provider,
1050
+ return_url,
1051
+ _request_auth,
1052
+ _content_type,
1053
+ _headers,
1054
+ _host_index,
1055
+ ) -> RequestSerialized:
1056
+
1057
+ _host = None
1058
+
1059
+ _collection_formats: Dict[str, str] = {
1060
+ }
1061
+
1062
+ _path_params: Dict[str, str] = {}
1063
+ _query_params: List[Tuple[str, str]] = []
1064
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1065
+ _form_params: List[Tuple[str, str]] = []
1066
+ _files: Dict[
1067
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1068
+ ] = {}
1069
+ _body_params: Optional[bytes] = None
1070
+
1071
+ # process the path parameters
1072
+ # process the query parameters
1073
+ if provider is not None:
1074
+
1075
+ _query_params.append(('provider', provider))
1076
+
1077
+ if return_url is not None:
1078
+
1079
+ _query_params.append(('returnUrl', return_url))
1080
+
1081
+ # process the header parameters
1082
+ # process the form parameters
1083
+ # process the body parameter
1084
+
1085
+
1086
+
1087
+
1088
+ # authentication setting
1089
+ _auth_settings: List[str] = [
1090
+ 'bearer'
1091
+ ]
1092
+
1093
+ return self.api_client.param_serialize(
1094
+ method='POST',
1095
+ resource_path='/Identity/ExternalLogin',
1096
+ path_params=_path_params,
1097
+ query_params=_query_params,
1098
+ header_params=_header_params,
1099
+ body=_body_params,
1100
+ post_params=_form_params,
1101
+ files=_files,
1102
+ auth_settings=_auth_settings,
1103
+ collection_formats=_collection_formats,
1104
+ _host=_host,
1105
+ _request_auth=_request_auth
1106
+ )
1107
+
1108
+
1109
+
1110
+
1111
+ @validate_call
1112
+ def identity_get_auth_token_get(
1113
+ self,
1114
+ _request_timeout: Union[
1115
+ None,
1116
+ Annotated[StrictFloat, Field(gt=0)],
1117
+ Tuple[
1118
+ Annotated[StrictFloat, Field(gt=0)],
1119
+ Annotated[StrictFloat, Field(gt=0)]
1120
+ ]
1121
+ ] = None,
1122
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1123
+ _content_type: Optional[StrictStr] = None,
1124
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1125
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1126
+ ) -> IssueAuthTokenResult:
1127
+ """Issues a new auth token using the refresh token.
1128
+
1129
+
1130
+ :param _request_timeout: timeout setting for this request. If one
1131
+ number provided, it will be total request
1132
+ timeout. It can also be a pair (tuple) of
1133
+ (connection, read) timeouts.
1134
+ :type _request_timeout: int, tuple(int, int), optional
1135
+ :param _request_auth: set to override the auth_settings for an a single
1136
+ request; this effectively ignores the
1137
+ authentication in the spec for a single request.
1138
+ :type _request_auth: dict, optional
1139
+ :param _content_type: force content-type for the request.
1140
+ :type _content_type: str, Optional
1141
+ :param _headers: set to override the headers for a single
1142
+ request; this effectively ignores the headers
1143
+ in the spec for a single request.
1144
+ :type _headers: dict, optional
1145
+ :param _host_index: set to override the host_index for a single
1146
+ request; this effectively ignores the host_index
1147
+ in the spec for a single request.
1148
+ :type _host_index: int, optional
1149
+ :return: Returns the result object.
1150
+ """ # noqa: E501
1151
+
1152
+ _param = self._identity_get_auth_token_get_serialize(
1153
+ _request_auth=_request_auth,
1154
+ _content_type=_content_type,
1155
+ _headers=_headers,
1156
+ _host_index=_host_index
1157
+ )
1158
+
1159
+ _response_types_map: Dict[str, Optional[str]] = {
1160
+ '200': "IssueAuthTokenResult",
1161
+ }
1162
+ response_data = self.api_client.call_api(
1163
+ *_param,
1164
+ _request_timeout=_request_timeout
1165
+ )
1166
+ response_data.read()
1167
+ return self.api_client.response_deserialize(
1168
+ response_data=response_data,
1169
+ response_types_map=_response_types_map,
1170
+ ).data
1171
+
1172
+
1173
+ @validate_call
1174
+ def identity_get_auth_token_get_with_http_info(
1175
+ self,
1176
+ _request_timeout: Union[
1177
+ None,
1178
+ Annotated[StrictFloat, Field(gt=0)],
1179
+ Tuple[
1180
+ Annotated[StrictFloat, Field(gt=0)],
1181
+ Annotated[StrictFloat, Field(gt=0)]
1182
+ ]
1183
+ ] = None,
1184
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1185
+ _content_type: Optional[StrictStr] = None,
1186
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1187
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1188
+ ) -> ApiResponse[IssueAuthTokenResult]:
1189
+ """Issues a new auth token using the refresh token.
1190
+
1191
+
1192
+ :param _request_timeout: timeout setting for this request. If one
1193
+ number provided, it will be total request
1194
+ timeout. It can also be a pair (tuple) of
1195
+ (connection, read) timeouts.
1196
+ :type _request_timeout: int, tuple(int, int), optional
1197
+ :param _request_auth: set to override the auth_settings for an a single
1198
+ request; this effectively ignores the
1199
+ authentication in the spec for a single request.
1200
+ :type _request_auth: dict, optional
1201
+ :param _content_type: force content-type for the request.
1202
+ :type _content_type: str, Optional
1203
+ :param _headers: set to override the headers for a single
1204
+ request; this effectively ignores the headers
1205
+ in the spec for a single request.
1206
+ :type _headers: dict, optional
1207
+ :param _host_index: set to override the host_index for a single
1208
+ request; this effectively ignores the host_index
1209
+ in the spec for a single request.
1210
+ :type _host_index: int, optional
1211
+ :return: Returns the result object.
1212
+ """ # noqa: E501
1213
+
1214
+ _param = self._identity_get_auth_token_get_serialize(
1215
+ _request_auth=_request_auth,
1216
+ _content_type=_content_type,
1217
+ _headers=_headers,
1218
+ _host_index=_host_index
1219
+ )
1220
+
1221
+ _response_types_map: Dict[str, Optional[str]] = {
1222
+ '200': "IssueAuthTokenResult",
1223
+ }
1224
+ response_data = self.api_client.call_api(
1225
+ *_param,
1226
+ _request_timeout=_request_timeout
1227
+ )
1228
+ response_data.read()
1229
+ return self.api_client.response_deserialize(
1230
+ response_data=response_data,
1231
+ response_types_map=_response_types_map,
1232
+ )
1233
+
1234
+
1235
+ @validate_call
1236
+ def identity_get_auth_token_get_without_preload_content(
1237
+ self,
1238
+ _request_timeout: Union[
1239
+ None,
1240
+ Annotated[StrictFloat, Field(gt=0)],
1241
+ Tuple[
1242
+ Annotated[StrictFloat, Field(gt=0)],
1243
+ Annotated[StrictFloat, Field(gt=0)]
1244
+ ]
1245
+ ] = None,
1246
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1247
+ _content_type: Optional[StrictStr] = None,
1248
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1249
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1250
+ ) -> RESTResponseType:
1251
+ """Issues a new auth token using the refresh token.
1252
+
1253
+
1254
+ :param _request_timeout: timeout setting for this request. If one
1255
+ number provided, it will be total request
1256
+ timeout. It can also be a pair (tuple) of
1257
+ (connection, read) timeouts.
1258
+ :type _request_timeout: int, tuple(int, int), optional
1259
+ :param _request_auth: set to override the auth_settings for an a single
1260
+ request; this effectively ignores the
1261
+ authentication in the spec for a single request.
1262
+ :type _request_auth: dict, optional
1263
+ :param _content_type: force content-type for the request.
1264
+ :type _content_type: str, Optional
1265
+ :param _headers: set to override the headers for a single
1266
+ request; this effectively ignores the headers
1267
+ in the spec for a single request.
1268
+ :type _headers: dict, optional
1269
+ :param _host_index: set to override the host_index for a single
1270
+ request; this effectively ignores the host_index
1271
+ in the spec for a single request.
1272
+ :type _host_index: int, optional
1273
+ :return: Returns the result object.
1274
+ """ # noqa: E501
1275
+
1276
+ _param = self._identity_get_auth_token_get_serialize(
1277
+ _request_auth=_request_auth,
1278
+ _content_type=_content_type,
1279
+ _headers=_headers,
1280
+ _host_index=_host_index
1281
+ )
1282
+
1283
+ _response_types_map: Dict[str, Optional[str]] = {
1284
+ '200': "IssueAuthTokenResult",
1285
+ }
1286
+ response_data = self.api_client.call_api(
1287
+ *_param,
1288
+ _request_timeout=_request_timeout
1289
+ )
1290
+ return response_data.response
1291
+
1292
+
1293
+ def _identity_get_auth_token_get_serialize(
1294
+ self,
1295
+ _request_auth,
1296
+ _content_type,
1297
+ _headers,
1298
+ _host_index,
1299
+ ) -> RequestSerialized:
1300
+
1301
+ _host = None
1302
+
1303
+ _collection_formats: Dict[str, str] = {
1304
+ }
1305
+
1306
+ _path_params: Dict[str, str] = {}
1307
+ _query_params: List[Tuple[str, str]] = []
1308
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1309
+ _form_params: List[Tuple[str, str]] = []
1310
+ _files: Dict[
1311
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1312
+ ] = {}
1313
+ _body_params: Optional[bytes] = None
1314
+
1315
+ # process the path parameters
1316
+ # process the query parameters
1317
+ # process the header parameters
1318
+ # process the form parameters
1319
+ # process the body parameter
1320
+
1321
+
1322
+ # set the HTTP header `Accept`
1323
+ if 'Accept' not in _header_params:
1324
+ _header_params['Accept'] = self.api_client.select_header_accept(
1325
+ [
1326
+ 'text/plain',
1327
+ 'application/json',
1328
+ 'text/json'
1329
+ ]
1330
+ )
1331
+
1332
+
1333
+ # authentication setting
1334
+ _auth_settings: List[str] = [
1335
+ 'bearer'
1336
+ ]
1337
+
1338
+ return self.api_client.param_serialize(
1339
+ method='GET',
1340
+ resource_path='/Identity/GetAuthToken',
1341
+ path_params=_path_params,
1342
+ query_params=_query_params,
1343
+ header_params=_header_params,
1344
+ body=_body_params,
1345
+ post_params=_form_params,
1346
+ files=_files,
1347
+ auth_settings=_auth_settings,
1348
+ collection_formats=_collection_formats,
1349
+ _host=_host,
1350
+ _request_auth=_request_auth
1351
+ )
1352
+
1353
+
1354
+
1355
+
1356
+ @validate_call
1357
+ def identity_get_client_auth_token_post(
1358
+ self,
1359
+ client_id: Annotated[Optional[StrictStr], Field(description="The id of the client to issue the token for.")] = None,
1360
+ _request_timeout: Union[
1361
+ None,
1362
+ Annotated[StrictFloat, Field(gt=0)],
1363
+ Tuple[
1364
+ Annotated[StrictFloat, Field(gt=0)],
1365
+ Annotated[StrictFloat, Field(gt=0)]
1366
+ ]
1367
+ ] = None,
1368
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1369
+ _content_type: Optional[StrictStr] = None,
1370
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1371
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1372
+ ) -> IssueClientAuthTokenResult:
1373
+ """Issues a new auth token using the client credentials.
1374
+
1375
+
1376
+ :param client_id: The id of the client to issue the token for.
1377
+ :type client_id: str
1378
+ :param _request_timeout: timeout setting for this request. If one
1379
+ number provided, it will be total request
1380
+ timeout. It can also be a pair (tuple) of
1381
+ (connection, read) timeouts.
1382
+ :type _request_timeout: int, tuple(int, int), optional
1383
+ :param _request_auth: set to override the auth_settings for an a single
1384
+ request; this effectively ignores the
1385
+ authentication in the spec for a single request.
1386
+ :type _request_auth: dict, optional
1387
+ :param _content_type: force content-type for the request.
1388
+ :type _content_type: str, Optional
1389
+ :param _headers: set to override the headers for a single
1390
+ request; this effectively ignores the headers
1391
+ in the spec for a single request.
1392
+ :type _headers: dict, optional
1393
+ :param _host_index: set to override the host_index for a single
1394
+ request; this effectively ignores the host_index
1395
+ in the spec for a single request.
1396
+ :type _host_index: int, optional
1397
+ :return: Returns the result object.
1398
+ """ # noqa: E501
1399
+
1400
+ _param = self._identity_get_client_auth_token_post_serialize(
1401
+ client_id=client_id,
1402
+ _request_auth=_request_auth,
1403
+ _content_type=_content_type,
1404
+ _headers=_headers,
1405
+ _host_index=_host_index
1406
+ )
1407
+
1408
+ _response_types_map: Dict[str, Optional[str]] = {
1409
+ '200': "IssueClientAuthTokenResult",
1410
+ }
1411
+ response_data = self.api_client.call_api(
1412
+ *_param,
1413
+ _request_timeout=_request_timeout
1414
+ )
1415
+ response_data.read()
1416
+ return self.api_client.response_deserialize(
1417
+ response_data=response_data,
1418
+ response_types_map=_response_types_map,
1419
+ ).data
1420
+
1421
+
1422
+ @validate_call
1423
+ def identity_get_client_auth_token_post_with_http_info(
1424
+ self,
1425
+ client_id: Annotated[Optional[StrictStr], Field(description="The id of the client to issue the token for.")] = None,
1426
+ _request_timeout: Union[
1427
+ None,
1428
+ Annotated[StrictFloat, Field(gt=0)],
1429
+ Tuple[
1430
+ Annotated[StrictFloat, Field(gt=0)],
1431
+ Annotated[StrictFloat, Field(gt=0)]
1432
+ ]
1433
+ ] = None,
1434
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1435
+ _content_type: Optional[StrictStr] = None,
1436
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1437
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1438
+ ) -> ApiResponse[IssueClientAuthTokenResult]:
1439
+ """Issues a new auth token using the client credentials.
1440
+
1441
+
1442
+ :param client_id: The id of the client to issue the token for.
1443
+ :type client_id: str
1444
+ :param _request_timeout: timeout setting for this request. If one
1445
+ number provided, it will be total request
1446
+ timeout. It can also be a pair (tuple) of
1447
+ (connection, read) timeouts.
1448
+ :type _request_timeout: int, tuple(int, int), optional
1449
+ :param _request_auth: set to override the auth_settings for an a single
1450
+ request; this effectively ignores the
1451
+ authentication in the spec for a single request.
1452
+ :type _request_auth: dict, optional
1453
+ :param _content_type: force content-type for the request.
1454
+ :type _content_type: str, Optional
1455
+ :param _headers: set to override the headers for a single
1456
+ request; this effectively ignores the headers
1457
+ in the spec for a single request.
1458
+ :type _headers: dict, optional
1459
+ :param _host_index: set to override the host_index for a single
1460
+ request; this effectively ignores the host_index
1461
+ in the spec for a single request.
1462
+ :type _host_index: int, optional
1463
+ :return: Returns the result object.
1464
+ """ # noqa: E501
1465
+
1466
+ _param = self._identity_get_client_auth_token_post_serialize(
1467
+ client_id=client_id,
1468
+ _request_auth=_request_auth,
1469
+ _content_type=_content_type,
1470
+ _headers=_headers,
1471
+ _host_index=_host_index
1472
+ )
1473
+
1474
+ _response_types_map: Dict[str, Optional[str]] = {
1475
+ '200': "IssueClientAuthTokenResult",
1476
+ }
1477
+ response_data = self.api_client.call_api(
1478
+ *_param,
1479
+ _request_timeout=_request_timeout
1480
+ )
1481
+ response_data.read()
1482
+ return self.api_client.response_deserialize(
1483
+ response_data=response_data,
1484
+ response_types_map=_response_types_map,
1485
+ )
1486
+
1487
+
1488
+ @validate_call
1489
+ def identity_get_client_auth_token_post_without_preload_content(
1490
+ self,
1491
+ client_id: Annotated[Optional[StrictStr], Field(description="The id of the client to issue the token for.")] = None,
1492
+ _request_timeout: Union[
1493
+ None,
1494
+ Annotated[StrictFloat, Field(gt=0)],
1495
+ Tuple[
1496
+ Annotated[StrictFloat, Field(gt=0)],
1497
+ Annotated[StrictFloat, Field(gt=0)]
1498
+ ]
1499
+ ] = None,
1500
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1501
+ _content_type: Optional[StrictStr] = None,
1502
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1503
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1504
+ ) -> RESTResponseType:
1505
+ """Issues a new auth token using the client credentials.
1506
+
1507
+
1508
+ :param client_id: The id of the client to issue the token for.
1509
+ :type client_id: str
1510
+ :param _request_timeout: timeout setting for this request. If one
1511
+ number provided, it will be total request
1512
+ timeout. It can also be a pair (tuple) of
1513
+ (connection, read) timeouts.
1514
+ :type _request_timeout: int, tuple(int, int), optional
1515
+ :param _request_auth: set to override the auth_settings for an a single
1516
+ request; this effectively ignores the
1517
+ authentication in the spec for a single request.
1518
+ :type _request_auth: dict, optional
1519
+ :param _content_type: force content-type for the request.
1520
+ :type _content_type: str, Optional
1521
+ :param _headers: set to override the headers for a single
1522
+ request; this effectively ignores the headers
1523
+ in the spec for a single request.
1524
+ :type _headers: dict, optional
1525
+ :param _host_index: set to override the host_index for a single
1526
+ request; this effectively ignores the host_index
1527
+ in the spec for a single request.
1528
+ :type _host_index: int, optional
1529
+ :return: Returns the result object.
1530
+ """ # noqa: E501
1531
+
1532
+ _param = self._identity_get_client_auth_token_post_serialize(
1533
+ client_id=client_id,
1534
+ _request_auth=_request_auth,
1535
+ _content_type=_content_type,
1536
+ _headers=_headers,
1537
+ _host_index=_host_index
1538
+ )
1539
+
1540
+ _response_types_map: Dict[str, Optional[str]] = {
1541
+ '200': "IssueClientAuthTokenResult",
1542
+ }
1543
+ response_data = self.api_client.call_api(
1544
+ *_param,
1545
+ _request_timeout=_request_timeout
1546
+ )
1547
+ return response_data.response
1548
+
1549
+
1550
+ def _identity_get_client_auth_token_post_serialize(
1551
+ self,
1552
+ client_id,
1553
+ _request_auth,
1554
+ _content_type,
1555
+ _headers,
1556
+ _host_index,
1557
+ ) -> RequestSerialized:
1558
+
1559
+ _host = None
1560
+
1561
+ _collection_formats: Dict[str, str] = {
1562
+ }
1563
+
1564
+ _path_params: Dict[str, str] = {}
1565
+ _query_params: List[Tuple[str, str]] = []
1566
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1567
+ _form_params: List[Tuple[str, str]] = []
1568
+ _files: Dict[
1569
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1570
+ ] = {}
1571
+ _body_params: Optional[bytes] = None
1572
+
1573
+ # process the path parameters
1574
+ # process the query parameters
1575
+ if client_id is not None:
1576
+
1577
+ _query_params.append(('clientId', client_id))
1578
+
1579
+ # process the header parameters
1580
+ # process the form parameters
1581
+ # process the body parameter
1582
+
1583
+
1584
+ # set the HTTP header `Accept`
1585
+ if 'Accept' not in _header_params:
1586
+ _header_params['Accept'] = self.api_client.select_header_accept(
1587
+ [
1588
+ 'text/plain',
1589
+ 'application/json',
1590
+ 'text/json'
1591
+ ]
1592
+ )
1593
+
1594
+
1595
+ # authentication setting
1596
+ _auth_settings: List[str] = [
1597
+ 'bearer'
1598
+ ]
1599
+
1600
+ return self.api_client.param_serialize(
1601
+ method='POST',
1602
+ resource_path='/Identity/GetClientAuthToken',
1603
+ path_params=_path_params,
1604
+ query_params=_query_params,
1605
+ header_params=_header_params,
1606
+ body=_body_params,
1607
+ post_params=_form_params,
1608
+ files=_files,
1609
+ auth_settings=_auth_settings,
1610
+ collection_formats=_collection_formats,
1611
+ _host=_host,
1612
+ _request_auth=_request_auth
1613
+ )
1614
+
1615
+
1616
+
1617
+
1618
+ @validate_call
1619
+ def identity_index_post(
1620
+ self,
1621
+ login_model: Annotated[Optional[LoginModel], Field(description="The model containing the username or email and password.")] = None,
1622
+ _request_timeout: Union[
1623
+ None,
1624
+ Annotated[StrictFloat, Field(gt=0)],
1625
+ Tuple[
1626
+ Annotated[StrictFloat, Field(gt=0)],
1627
+ Annotated[StrictFloat, Field(gt=0)]
1628
+ ]
1629
+ ] = None,
1630
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1631
+ _content_type: Optional[StrictStr] = None,
1632
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1633
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1634
+ ) -> None:
1635
+ """Logs in a user by username or email and password.
1636
+
1637
+
1638
+ :param login_model: The model containing the username or email and password.
1639
+ :type login_model: LoginModel
1640
+ :param _request_timeout: timeout setting for this request. If one
1641
+ number provided, it will be total request
1642
+ timeout. It can also be a pair (tuple) of
1643
+ (connection, read) timeouts.
1644
+ :type _request_timeout: int, tuple(int, int), optional
1645
+ :param _request_auth: set to override the auth_settings for an a single
1646
+ request; this effectively ignores the
1647
+ authentication in the spec for a single request.
1648
+ :type _request_auth: dict, optional
1649
+ :param _content_type: force content-type for the request.
1650
+ :type _content_type: str, Optional
1651
+ :param _headers: set to override the headers for a single
1652
+ request; this effectively ignores the headers
1653
+ in the spec for a single request.
1654
+ :type _headers: dict, optional
1655
+ :param _host_index: set to override the host_index for a single
1656
+ request; this effectively ignores the host_index
1657
+ in the spec for a single request.
1658
+ :type _host_index: int, optional
1659
+ :return: Returns the result object.
1660
+ """ # noqa: E501
1661
+
1662
+ _param = self._identity_index_post_serialize(
1663
+ login_model=login_model,
1664
+ _request_auth=_request_auth,
1665
+ _content_type=_content_type,
1666
+ _headers=_headers,
1667
+ _host_index=_host_index
1668
+ )
1669
+
1670
+ _response_types_map: Dict[str, Optional[str]] = {
1671
+ '200': None,
1672
+ }
1673
+ response_data = self.api_client.call_api(
1674
+ *_param,
1675
+ _request_timeout=_request_timeout
1676
+ )
1677
+ response_data.read()
1678
+ return self.api_client.response_deserialize(
1679
+ response_data=response_data,
1680
+ response_types_map=_response_types_map,
1681
+ ).data
1682
+
1683
+
1684
+ @validate_call
1685
+ def identity_index_post_with_http_info(
1686
+ self,
1687
+ login_model: Annotated[Optional[LoginModel], Field(description="The model containing the username or email and password.")] = None,
1688
+ _request_timeout: Union[
1689
+ None,
1690
+ Annotated[StrictFloat, Field(gt=0)],
1691
+ Tuple[
1692
+ Annotated[StrictFloat, Field(gt=0)],
1693
+ Annotated[StrictFloat, Field(gt=0)]
1694
+ ]
1695
+ ] = None,
1696
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1697
+ _content_type: Optional[StrictStr] = None,
1698
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1699
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1700
+ ) -> ApiResponse[None]:
1701
+ """Logs in a user by username or email and password.
1702
+
1703
+
1704
+ :param login_model: The model containing the username or email and password.
1705
+ :type login_model: LoginModel
1706
+ :param _request_timeout: timeout setting for this request. If one
1707
+ number provided, it will be total request
1708
+ timeout. It can also be a pair (tuple) of
1709
+ (connection, read) timeouts.
1710
+ :type _request_timeout: int, tuple(int, int), optional
1711
+ :param _request_auth: set to override the auth_settings for an a single
1712
+ request; this effectively ignores the
1713
+ authentication in the spec for a single request.
1714
+ :type _request_auth: dict, optional
1715
+ :param _content_type: force content-type for the request.
1716
+ :type _content_type: str, Optional
1717
+ :param _headers: set to override the headers for a single
1718
+ request; this effectively ignores the headers
1719
+ in the spec for a single request.
1720
+ :type _headers: dict, optional
1721
+ :param _host_index: set to override the host_index for a single
1722
+ request; this effectively ignores the host_index
1723
+ in the spec for a single request.
1724
+ :type _host_index: int, optional
1725
+ :return: Returns the result object.
1726
+ """ # noqa: E501
1727
+
1728
+ _param = self._identity_index_post_serialize(
1729
+ login_model=login_model,
1730
+ _request_auth=_request_auth,
1731
+ _content_type=_content_type,
1732
+ _headers=_headers,
1733
+ _host_index=_host_index
1734
+ )
1735
+
1736
+ _response_types_map: Dict[str, Optional[str]] = {
1737
+ '200': None,
1738
+ }
1739
+ response_data = self.api_client.call_api(
1740
+ *_param,
1741
+ _request_timeout=_request_timeout
1742
+ )
1743
+ response_data.read()
1744
+ return self.api_client.response_deserialize(
1745
+ response_data=response_data,
1746
+ response_types_map=_response_types_map,
1747
+ )
1748
+
1749
+
1750
+ @validate_call
1751
+ def identity_index_post_without_preload_content(
1752
+ self,
1753
+ login_model: Annotated[Optional[LoginModel], Field(description="The model containing the username or email and password.")] = None,
1754
+ _request_timeout: Union[
1755
+ None,
1756
+ Annotated[StrictFloat, Field(gt=0)],
1757
+ Tuple[
1758
+ Annotated[StrictFloat, Field(gt=0)],
1759
+ Annotated[StrictFloat, Field(gt=0)]
1760
+ ]
1761
+ ] = None,
1762
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1763
+ _content_type: Optional[StrictStr] = None,
1764
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1765
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1766
+ ) -> RESTResponseType:
1767
+ """Logs in a user by username or email and password.
1768
+
1769
+
1770
+ :param login_model: The model containing the username or email and password.
1771
+ :type login_model: LoginModel
1772
+ :param _request_timeout: timeout setting for this request. If one
1773
+ number provided, it will be total request
1774
+ timeout. It can also be a pair (tuple) of
1775
+ (connection, read) timeouts.
1776
+ :type _request_timeout: int, tuple(int, int), optional
1777
+ :param _request_auth: set to override the auth_settings for an a single
1778
+ request; this effectively ignores the
1779
+ authentication in the spec for a single request.
1780
+ :type _request_auth: dict, optional
1781
+ :param _content_type: force content-type for the request.
1782
+ :type _content_type: str, Optional
1783
+ :param _headers: set to override the headers for a single
1784
+ request; this effectively ignores the headers
1785
+ in the spec for a single request.
1786
+ :type _headers: dict, optional
1787
+ :param _host_index: set to override the host_index for a single
1788
+ request; this effectively ignores the host_index
1789
+ in the spec for a single request.
1790
+ :type _host_index: int, optional
1791
+ :return: Returns the result object.
1792
+ """ # noqa: E501
1793
+
1794
+ _param = self._identity_index_post_serialize(
1795
+ login_model=login_model,
1796
+ _request_auth=_request_auth,
1797
+ _content_type=_content_type,
1798
+ _headers=_headers,
1799
+ _host_index=_host_index
1800
+ )
1801
+
1802
+ _response_types_map: Dict[str, Optional[str]] = {
1803
+ '200': None,
1804
+ }
1805
+ response_data = self.api_client.call_api(
1806
+ *_param,
1807
+ _request_timeout=_request_timeout
1808
+ )
1809
+ return response_data.response
1810
+
1811
+
1812
+ def _identity_index_post_serialize(
1813
+ self,
1814
+ login_model,
1815
+ _request_auth,
1816
+ _content_type,
1817
+ _headers,
1818
+ _host_index,
1819
+ ) -> RequestSerialized:
1820
+
1821
+ _host = None
1822
+
1823
+ _collection_formats: Dict[str, str] = {
1824
+ }
1825
+
1826
+ _path_params: Dict[str, str] = {}
1827
+ _query_params: List[Tuple[str, str]] = []
1828
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1829
+ _form_params: List[Tuple[str, str]] = []
1830
+ _files: Dict[
1831
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1832
+ ] = {}
1833
+ _body_params: Optional[bytes] = None
1834
+
1835
+ # process the path parameters
1836
+ # process the query parameters
1837
+ # process the header parameters
1838
+ # process the form parameters
1839
+ # process the body parameter
1840
+ if login_model is not None:
1841
+ _body_params = login_model
1842
+
1843
+
1844
+
1845
+ # set the HTTP header `Content-Type`
1846
+ if _content_type:
1847
+ _header_params['Content-Type'] = _content_type
1848
+ else:
1849
+ _default_content_type = (
1850
+ self.api_client.select_header_content_type(
1851
+ [
1852
+ 'application/json',
1853
+ 'text/json',
1854
+ 'application/*+json'
1855
+ ]
1856
+ )
1857
+ )
1858
+ if _default_content_type is not None:
1859
+ _header_params['Content-Type'] = _default_content_type
1860
+
1861
+ # authentication setting
1862
+ _auth_settings: List[str] = [
1863
+ 'bearer'
1864
+ ]
1865
+
1866
+ return self.api_client.param_serialize(
1867
+ method='POST',
1868
+ resource_path='/Identity/Index',
1869
+ path_params=_path_params,
1870
+ query_params=_query_params,
1871
+ header_params=_header_params,
1872
+ body=_body_params,
1873
+ post_params=_form_params,
1874
+ files=_files,
1875
+ auth_settings=_auth_settings,
1876
+ collection_formats=_collection_formats,
1877
+ _host=_host,
1878
+ _request_auth=_request_auth
1879
+ )
1880
+
1881
+
1882
+
1883
+
1884
+ @validate_call
1885
+ def identity_logout_post(
1886
+ self,
1887
+ _request_timeout: Union[
1888
+ None,
1889
+ Annotated[StrictFloat, Field(gt=0)],
1890
+ Tuple[
1891
+ Annotated[StrictFloat, Field(gt=0)],
1892
+ Annotated[StrictFloat, Field(gt=0)]
1893
+ ]
1894
+ ] = None,
1895
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1896
+ _content_type: Optional[StrictStr] = None,
1897
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1898
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1899
+ ) -> None:
1900
+ """Logs out the current user by deleting the refresh token cookie.
1901
+
1902
+
1903
+ :param _request_timeout: timeout setting for this request. If one
1904
+ number provided, it will be total request
1905
+ timeout. It can also be a pair (tuple) of
1906
+ (connection, read) timeouts.
1907
+ :type _request_timeout: int, tuple(int, int), optional
1908
+ :param _request_auth: set to override the auth_settings for an a single
1909
+ request; this effectively ignores the
1910
+ authentication in the spec for a single request.
1911
+ :type _request_auth: dict, optional
1912
+ :param _content_type: force content-type for the request.
1913
+ :type _content_type: str, Optional
1914
+ :param _headers: set to override the headers for a single
1915
+ request; this effectively ignores the headers
1916
+ in the spec for a single request.
1917
+ :type _headers: dict, optional
1918
+ :param _host_index: set to override the host_index for a single
1919
+ request; this effectively ignores the host_index
1920
+ in the spec for a single request.
1921
+ :type _host_index: int, optional
1922
+ :return: Returns the result object.
1923
+ """ # noqa: E501
1924
+
1925
+ _param = self._identity_logout_post_serialize(
1926
+ _request_auth=_request_auth,
1927
+ _content_type=_content_type,
1928
+ _headers=_headers,
1929
+ _host_index=_host_index
1930
+ )
1931
+
1932
+ _response_types_map: Dict[str, Optional[str]] = {
1933
+ '200': None,
1934
+ }
1935
+ response_data = self.api_client.call_api(
1936
+ *_param,
1937
+ _request_timeout=_request_timeout
1938
+ )
1939
+ response_data.read()
1940
+ return self.api_client.response_deserialize(
1941
+ response_data=response_data,
1942
+ response_types_map=_response_types_map,
1943
+ ).data
1944
+
1945
+
1946
+ @validate_call
1947
+ def identity_logout_post_with_http_info(
1948
+ self,
1949
+ _request_timeout: Union[
1950
+ None,
1951
+ Annotated[StrictFloat, Field(gt=0)],
1952
+ Tuple[
1953
+ Annotated[StrictFloat, Field(gt=0)],
1954
+ Annotated[StrictFloat, Field(gt=0)]
1955
+ ]
1956
+ ] = None,
1957
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1958
+ _content_type: Optional[StrictStr] = None,
1959
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1960
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1961
+ ) -> ApiResponse[None]:
1962
+ """Logs out the current user by deleting the refresh token cookie.
1963
+
1964
+
1965
+ :param _request_timeout: timeout setting for this request. If one
1966
+ number provided, it will be total request
1967
+ timeout. It can also be a pair (tuple) of
1968
+ (connection, read) timeouts.
1969
+ :type _request_timeout: int, tuple(int, int), optional
1970
+ :param _request_auth: set to override the auth_settings for an a single
1971
+ request; this effectively ignores the
1972
+ authentication in the spec for a single request.
1973
+ :type _request_auth: dict, optional
1974
+ :param _content_type: force content-type for the request.
1975
+ :type _content_type: str, Optional
1976
+ :param _headers: set to override the headers for a single
1977
+ request; this effectively ignores the headers
1978
+ in the spec for a single request.
1979
+ :type _headers: dict, optional
1980
+ :param _host_index: set to override the host_index for a single
1981
+ request; this effectively ignores the host_index
1982
+ in the spec for a single request.
1983
+ :type _host_index: int, optional
1984
+ :return: Returns the result object.
1985
+ """ # noqa: E501
1986
+
1987
+ _param = self._identity_logout_post_serialize(
1988
+ _request_auth=_request_auth,
1989
+ _content_type=_content_type,
1990
+ _headers=_headers,
1991
+ _host_index=_host_index
1992
+ )
1993
+
1994
+ _response_types_map: Dict[str, Optional[str]] = {
1995
+ '200': None,
1996
+ }
1997
+ response_data = self.api_client.call_api(
1998
+ *_param,
1999
+ _request_timeout=_request_timeout
2000
+ )
2001
+ response_data.read()
2002
+ return self.api_client.response_deserialize(
2003
+ response_data=response_data,
2004
+ response_types_map=_response_types_map,
2005
+ )
2006
+
2007
+
2008
+ @validate_call
2009
+ def identity_logout_post_without_preload_content(
2010
+ self,
2011
+ _request_timeout: Union[
2012
+ None,
2013
+ Annotated[StrictFloat, Field(gt=0)],
2014
+ Tuple[
2015
+ Annotated[StrictFloat, Field(gt=0)],
2016
+ Annotated[StrictFloat, Field(gt=0)]
2017
+ ]
2018
+ ] = None,
2019
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2020
+ _content_type: Optional[StrictStr] = None,
2021
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2022
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2023
+ ) -> RESTResponseType:
2024
+ """Logs out the current user by deleting the refresh token cookie.
2025
+
2026
+
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._identity_logout_post_serialize(
2050
+ _request_auth=_request_auth,
2051
+ _content_type=_content_type,
2052
+ _headers=_headers,
2053
+ _host_index=_host_index
2054
+ )
2055
+
2056
+ _response_types_map: Dict[str, Optional[str]] = {
2057
+ '200': None,
2058
+ }
2059
+ response_data = self.api_client.call_api(
2060
+ *_param,
2061
+ _request_timeout=_request_timeout
2062
+ )
2063
+ return response_data.response
2064
+
2065
+
2066
+ def _identity_logout_post_serialize(
2067
+ self,
2068
+ _request_auth,
2069
+ _content_type,
2070
+ _headers,
2071
+ _host_index,
2072
+ ) -> RequestSerialized:
2073
+
2074
+ _host = None
2075
+
2076
+ _collection_formats: Dict[str, str] = {
2077
+ }
2078
+
2079
+ _path_params: Dict[str, str] = {}
2080
+ _query_params: List[Tuple[str, str]] = []
2081
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2082
+ _form_params: List[Tuple[str, str]] = []
2083
+ _files: Dict[
2084
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2085
+ ] = {}
2086
+ _body_params: Optional[bytes] = None
2087
+
2088
+ # process the path parameters
2089
+ # process the query parameters
2090
+ # process the header parameters
2091
+ # process the form parameters
2092
+ # process the body parameter
2093
+
2094
+
2095
+
2096
+
2097
+ # authentication setting
2098
+ _auth_settings: List[str] = [
2099
+ 'bearer'
2100
+ ]
2101
+
2102
+ return self.api_client.param_serialize(
2103
+ method='POST',
2104
+ resource_path='/Identity/Logout',
2105
+ path_params=_path_params,
2106
+ query_params=_query_params,
2107
+ header_params=_header_params,
2108
+ body=_body_params,
2109
+ post_params=_form_params,
2110
+ files=_files,
2111
+ auth_settings=_auth_settings,
2112
+ collection_formats=_collection_formats,
2113
+ _host=_host,
2114
+ _request_auth=_request_auth
2115
+ )
2116
+
2117
+
2118
+
2119
+
2120
+ @validate_call
2121
+ def identity_request_reset_post(
2122
+ self,
2123
+ request_password_reset_command: Annotated[Optional[RequestPasswordResetCommand], Field(description="The command containing the user's email.")] = None,
2124
+ _request_timeout: Union[
2125
+ None,
2126
+ Annotated[StrictFloat, Field(gt=0)],
2127
+ Tuple[
2128
+ Annotated[StrictFloat, Field(gt=0)],
2129
+ Annotated[StrictFloat, Field(gt=0)]
2130
+ ]
2131
+ ] = None,
2132
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2133
+ _content_type: Optional[StrictStr] = None,
2134
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2135
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2136
+ ) -> None:
2137
+ """Request a password reset for a user.
2138
+
2139
+
2140
+ :param request_password_reset_command: The command containing the user's email.
2141
+ :type request_password_reset_command: RequestPasswordResetCommand
2142
+ :param _request_timeout: timeout setting for this request. If one
2143
+ number provided, it will be total request
2144
+ timeout. It can also be a pair (tuple) of
2145
+ (connection, read) timeouts.
2146
+ :type _request_timeout: int, tuple(int, int), optional
2147
+ :param _request_auth: set to override the auth_settings for an a single
2148
+ request; this effectively ignores the
2149
+ authentication in the spec for a single request.
2150
+ :type _request_auth: dict, optional
2151
+ :param _content_type: force content-type for the request.
2152
+ :type _content_type: str, Optional
2153
+ :param _headers: set to override the headers for a single
2154
+ request; this effectively ignores the headers
2155
+ in the spec for a single request.
2156
+ :type _headers: dict, optional
2157
+ :param _host_index: set to override the host_index for a single
2158
+ request; this effectively ignores the host_index
2159
+ in the spec for a single request.
2160
+ :type _host_index: int, optional
2161
+ :return: Returns the result object.
2162
+ """ # noqa: E501
2163
+
2164
+ _param = self._identity_request_reset_post_serialize(
2165
+ request_password_reset_command=request_password_reset_command,
2166
+ _request_auth=_request_auth,
2167
+ _content_type=_content_type,
2168
+ _headers=_headers,
2169
+ _host_index=_host_index
2170
+ )
2171
+
2172
+ _response_types_map: Dict[str, Optional[str]] = {
2173
+ '200': None,
2174
+ }
2175
+ response_data = self.api_client.call_api(
2176
+ *_param,
2177
+ _request_timeout=_request_timeout
2178
+ )
2179
+ response_data.read()
2180
+ return self.api_client.response_deserialize(
2181
+ response_data=response_data,
2182
+ response_types_map=_response_types_map,
2183
+ ).data
2184
+
2185
+
2186
+ @validate_call
2187
+ def identity_request_reset_post_with_http_info(
2188
+ self,
2189
+ request_password_reset_command: Annotated[Optional[RequestPasswordResetCommand], Field(description="The command containing the user's email.")] = None,
2190
+ _request_timeout: Union[
2191
+ None,
2192
+ Annotated[StrictFloat, Field(gt=0)],
2193
+ Tuple[
2194
+ Annotated[StrictFloat, Field(gt=0)],
2195
+ Annotated[StrictFloat, Field(gt=0)]
2196
+ ]
2197
+ ] = None,
2198
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2199
+ _content_type: Optional[StrictStr] = None,
2200
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2201
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2202
+ ) -> ApiResponse[None]:
2203
+ """Request a password reset for a user.
2204
+
2205
+
2206
+ :param request_password_reset_command: The command containing the user's email.
2207
+ :type request_password_reset_command: RequestPasswordResetCommand
2208
+ :param _request_timeout: timeout setting for this request. If one
2209
+ number provided, it will be total request
2210
+ timeout. It can also be a pair (tuple) of
2211
+ (connection, read) timeouts.
2212
+ :type _request_timeout: int, tuple(int, int), optional
2213
+ :param _request_auth: set to override the auth_settings for an a single
2214
+ request; this effectively ignores the
2215
+ authentication in the spec for a single request.
2216
+ :type _request_auth: dict, optional
2217
+ :param _content_type: force content-type for the request.
2218
+ :type _content_type: str, Optional
2219
+ :param _headers: set to override the headers for a single
2220
+ request; this effectively ignores the headers
2221
+ in the spec for a single request.
2222
+ :type _headers: dict, optional
2223
+ :param _host_index: set to override the host_index for a single
2224
+ request; this effectively ignores the host_index
2225
+ in the spec for a single request.
2226
+ :type _host_index: int, optional
2227
+ :return: Returns the result object.
2228
+ """ # noqa: E501
2229
+
2230
+ _param = self._identity_request_reset_post_serialize(
2231
+ request_password_reset_command=request_password_reset_command,
2232
+ _request_auth=_request_auth,
2233
+ _content_type=_content_type,
2234
+ _headers=_headers,
2235
+ _host_index=_host_index
2236
+ )
2237
+
2238
+ _response_types_map: Dict[str, Optional[str]] = {
2239
+ '200': None,
2240
+ }
2241
+ response_data = self.api_client.call_api(
2242
+ *_param,
2243
+ _request_timeout=_request_timeout
2244
+ )
2245
+ response_data.read()
2246
+ return self.api_client.response_deserialize(
2247
+ response_data=response_data,
2248
+ response_types_map=_response_types_map,
2249
+ )
2250
+
2251
+
2252
+ @validate_call
2253
+ def identity_request_reset_post_without_preload_content(
2254
+ self,
2255
+ request_password_reset_command: Annotated[Optional[RequestPasswordResetCommand], Field(description="The command containing the user's email.")] = None,
2256
+ _request_timeout: Union[
2257
+ None,
2258
+ Annotated[StrictFloat, Field(gt=0)],
2259
+ Tuple[
2260
+ Annotated[StrictFloat, Field(gt=0)],
2261
+ Annotated[StrictFloat, Field(gt=0)]
2262
+ ]
2263
+ ] = None,
2264
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2265
+ _content_type: Optional[StrictStr] = None,
2266
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2267
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2268
+ ) -> RESTResponseType:
2269
+ """Request a password reset for a user.
2270
+
2271
+
2272
+ :param request_password_reset_command: The command containing the user's email.
2273
+ :type request_password_reset_command: RequestPasswordResetCommand
2274
+ :param _request_timeout: timeout setting for this request. If one
2275
+ number provided, it will be total request
2276
+ timeout. It can also be a pair (tuple) of
2277
+ (connection, read) timeouts.
2278
+ :type _request_timeout: int, tuple(int, int), optional
2279
+ :param _request_auth: set to override the auth_settings for an a single
2280
+ request; this effectively ignores the
2281
+ authentication in the spec for a single request.
2282
+ :type _request_auth: dict, optional
2283
+ :param _content_type: force content-type for the request.
2284
+ :type _content_type: str, Optional
2285
+ :param _headers: set to override the headers for a single
2286
+ request; this effectively ignores the headers
2287
+ in the spec for a single request.
2288
+ :type _headers: dict, optional
2289
+ :param _host_index: set to override the host_index for a single
2290
+ request; this effectively ignores the host_index
2291
+ in the spec for a single request.
2292
+ :type _host_index: int, optional
2293
+ :return: Returns the result object.
2294
+ """ # noqa: E501
2295
+
2296
+ _param = self._identity_request_reset_post_serialize(
2297
+ request_password_reset_command=request_password_reset_command,
2298
+ _request_auth=_request_auth,
2299
+ _content_type=_content_type,
2300
+ _headers=_headers,
2301
+ _host_index=_host_index
2302
+ )
2303
+
2304
+ _response_types_map: Dict[str, Optional[str]] = {
2305
+ '200': None,
2306
+ }
2307
+ response_data = self.api_client.call_api(
2308
+ *_param,
2309
+ _request_timeout=_request_timeout
2310
+ )
2311
+ return response_data.response
2312
+
2313
+
2314
+ def _identity_request_reset_post_serialize(
2315
+ self,
2316
+ request_password_reset_command,
2317
+ _request_auth,
2318
+ _content_type,
2319
+ _headers,
2320
+ _host_index,
2321
+ ) -> RequestSerialized:
2322
+
2323
+ _host = None
2324
+
2325
+ _collection_formats: Dict[str, str] = {
2326
+ }
2327
+
2328
+ _path_params: Dict[str, str] = {}
2329
+ _query_params: List[Tuple[str, str]] = []
2330
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2331
+ _form_params: List[Tuple[str, str]] = []
2332
+ _files: Dict[
2333
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2334
+ ] = {}
2335
+ _body_params: Optional[bytes] = None
2336
+
2337
+ # process the path parameters
2338
+ # process the query parameters
2339
+ # process the header parameters
2340
+ # process the form parameters
2341
+ # process the body parameter
2342
+ if request_password_reset_command is not None:
2343
+ _body_params = request_password_reset_command
2344
+
2345
+
2346
+
2347
+ # set the HTTP header `Content-Type`
2348
+ if _content_type:
2349
+ _header_params['Content-Type'] = _content_type
2350
+ else:
2351
+ _default_content_type = (
2352
+ self.api_client.select_header_content_type(
2353
+ [
2354
+ 'application/json',
2355
+ 'text/json',
2356
+ 'application/*+json'
2357
+ ]
2358
+ )
2359
+ )
2360
+ if _default_content_type is not None:
2361
+ _header_params['Content-Type'] = _default_content_type
2362
+
2363
+ # authentication setting
2364
+ _auth_settings: List[str] = [
2365
+ 'bearer'
2366
+ ]
2367
+
2368
+ return self.api_client.param_serialize(
2369
+ method='POST',
2370
+ resource_path='/Identity/RequestReset',
2371
+ path_params=_path_params,
2372
+ query_params=_query_params,
2373
+ header_params=_header_params,
2374
+ body=_body_params,
2375
+ post_params=_form_params,
2376
+ files=_files,
2377
+ auth_settings=_auth_settings,
2378
+ collection_formats=_collection_formats,
2379
+ _host=_host,
2380
+ _request_auth=_request_auth
2381
+ )
2382
+
2383
+
2384
+
2385
+
2386
+ @validate_call
2387
+ def identity_signup_post(
2388
+ self,
2389
+ signup_customer_model: Annotated[Optional[SignupCustomerModel], Field(description="The body to sign up the user with.")] = None,
2390
+ _request_timeout: Union[
2391
+ None,
2392
+ Annotated[StrictFloat, Field(gt=0)],
2393
+ Tuple[
2394
+ Annotated[StrictFloat, Field(gt=0)],
2395
+ Annotated[StrictFloat, Field(gt=0)]
2396
+ ]
2397
+ ] = None,
2398
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2399
+ _content_type: Optional[StrictStr] = None,
2400
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2401
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2402
+ ) -> None:
2403
+ """Signs up a new user.
2404
+
2405
+
2406
+ :param signup_customer_model: The body to sign up the user with.
2407
+ :type signup_customer_model: SignupCustomerModel
2408
+ :param _request_timeout: timeout setting for this request. If one
2409
+ number provided, it will be total request
2410
+ timeout. It can also be a pair (tuple) of
2411
+ (connection, read) timeouts.
2412
+ :type _request_timeout: int, tuple(int, int), optional
2413
+ :param _request_auth: set to override the auth_settings for an a single
2414
+ request; this effectively ignores the
2415
+ authentication in the spec for a single request.
2416
+ :type _request_auth: dict, optional
2417
+ :param _content_type: force content-type for the request.
2418
+ :type _content_type: str, Optional
2419
+ :param _headers: set to override the headers for a single
2420
+ request; this effectively ignores the headers
2421
+ in the spec for a single request.
2422
+ :type _headers: dict, optional
2423
+ :param _host_index: set to override the host_index for a single
2424
+ request; this effectively ignores the host_index
2425
+ in the spec for a single request.
2426
+ :type _host_index: int, optional
2427
+ :return: Returns the result object.
2428
+ """ # noqa: E501
2429
+
2430
+ _param = self._identity_signup_post_serialize(
2431
+ signup_customer_model=signup_customer_model,
2432
+ _request_auth=_request_auth,
2433
+ _content_type=_content_type,
2434
+ _headers=_headers,
2435
+ _host_index=_host_index
2436
+ )
2437
+
2438
+ _response_types_map: Dict[str, Optional[str]] = {
2439
+ '200': None,
2440
+ }
2441
+ response_data = self.api_client.call_api(
2442
+ *_param,
2443
+ _request_timeout=_request_timeout
2444
+ )
2445
+ response_data.read()
2446
+ return self.api_client.response_deserialize(
2447
+ response_data=response_data,
2448
+ response_types_map=_response_types_map,
2449
+ ).data
2450
+
2451
+
2452
+ @validate_call
2453
+ def identity_signup_post_with_http_info(
2454
+ self,
2455
+ signup_customer_model: Annotated[Optional[SignupCustomerModel], Field(description="The body to sign up the user with.")] = None,
2456
+ _request_timeout: Union[
2457
+ None,
2458
+ Annotated[StrictFloat, Field(gt=0)],
2459
+ Tuple[
2460
+ Annotated[StrictFloat, Field(gt=0)],
2461
+ Annotated[StrictFloat, Field(gt=0)]
2462
+ ]
2463
+ ] = None,
2464
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2465
+ _content_type: Optional[StrictStr] = None,
2466
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2467
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2468
+ ) -> ApiResponse[None]:
2469
+ """Signs up a new user.
2470
+
2471
+
2472
+ :param signup_customer_model: The body to sign up the user with.
2473
+ :type signup_customer_model: SignupCustomerModel
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._identity_signup_post_serialize(
2497
+ signup_customer_model=signup_customer_model,
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 identity_signup_post_without_preload_content(
2520
+ self,
2521
+ signup_customer_model: Annotated[Optional[SignupCustomerModel], Field(description="The body to sign up the user with.")] = 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
+ """Signs up a new user.
2536
+
2537
+
2538
+ :param signup_customer_model: The body to sign up the user with.
2539
+ :type signup_customer_model: SignupCustomerModel
2540
+ :param _request_timeout: timeout setting for this request. If one
2541
+ number provided, it will be total request
2542
+ timeout. It can also be a pair (tuple) of
2543
+ (connection, read) timeouts.
2544
+ :type _request_timeout: int, tuple(int, int), optional
2545
+ :param _request_auth: set to override the auth_settings for an a single
2546
+ request; this effectively ignores the
2547
+ authentication in the spec for a single request.
2548
+ :type _request_auth: dict, optional
2549
+ :param _content_type: force content-type for the request.
2550
+ :type _content_type: str, Optional
2551
+ :param _headers: set to override the headers for a single
2552
+ request; this effectively ignores the headers
2553
+ in the spec for a single request.
2554
+ :type _headers: dict, optional
2555
+ :param _host_index: set to override the host_index for a single
2556
+ request; this effectively ignores the host_index
2557
+ in the spec for a single request.
2558
+ :type _host_index: int, optional
2559
+ :return: Returns the result object.
2560
+ """ # noqa: E501
2561
+
2562
+ _param = self._identity_signup_post_serialize(
2563
+ signup_customer_model=signup_customer_model,
2564
+ _request_auth=_request_auth,
2565
+ _content_type=_content_type,
2566
+ _headers=_headers,
2567
+ _host_index=_host_index
2568
+ )
2569
+
2570
+ _response_types_map: Dict[str, Optional[str]] = {
2571
+ '200': None,
2572
+ }
2573
+ response_data = self.api_client.call_api(
2574
+ *_param,
2575
+ _request_timeout=_request_timeout
2576
+ )
2577
+ return response_data.response
2578
+
2579
+
2580
+ def _identity_signup_post_serialize(
2581
+ self,
2582
+ signup_customer_model,
2583
+ _request_auth,
2584
+ _content_type,
2585
+ _headers,
2586
+ _host_index,
2587
+ ) -> RequestSerialized:
2588
+
2589
+ _host = None
2590
+
2591
+ _collection_formats: Dict[str, str] = {
2592
+ }
2593
+
2594
+ _path_params: Dict[str, str] = {}
2595
+ _query_params: List[Tuple[str, str]] = []
2596
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2597
+ _form_params: List[Tuple[str, str]] = []
2598
+ _files: Dict[
2599
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2600
+ ] = {}
2601
+ _body_params: Optional[bytes] = None
2602
+
2603
+ # process the path parameters
2604
+ # process the query parameters
2605
+ # process the header parameters
2606
+ # process the form parameters
2607
+ # process the body parameter
2608
+ if signup_customer_model is not None:
2609
+ _body_params = signup_customer_model
2610
+
2611
+
2612
+
2613
+ # set the HTTP header `Content-Type`
2614
+ if _content_type:
2615
+ _header_params['Content-Type'] = _content_type
2616
+ else:
2617
+ _default_content_type = (
2618
+ self.api_client.select_header_content_type(
2619
+ [
2620
+ 'application/json',
2621
+ 'text/json',
2622
+ 'application/*+json'
2623
+ ]
2624
+ )
2625
+ )
2626
+ if _default_content_type is not None:
2627
+ _header_params['Content-Type'] = _default_content_type
2628
+
2629
+ # authentication setting
2630
+ _auth_settings: List[str] = [
2631
+ 'bearer'
2632
+ ]
2633
+
2634
+ return self.api_client.param_serialize(
2635
+ method='POST',
2636
+ resource_path='/Identity/Signup',
2637
+ path_params=_path_params,
2638
+ query_params=_query_params,
2639
+ header_params=_header_params,
2640
+ body=_body_params,
2641
+ post_params=_form_params,
2642
+ files=_files,
2643
+ auth_settings=_auth_settings,
2644
+ collection_formats=_collection_formats,
2645
+ _host=_host,
2646
+ _request_auth=_request_auth
2647
+ )
2648
+
2649
+
2650
+
2651
+
2652
+ @validate_call
2653
+ def identity_submit_reset_post(
2654
+ self,
2655
+ submit_password_reset_command: Annotated[Optional[SubmitPasswordResetCommand], Field(description="The command containing the user's email, the reset token and the new password.")] = None,
2656
+ _request_timeout: Union[
2657
+ None,
2658
+ Annotated[StrictFloat, Field(gt=0)],
2659
+ Tuple[
2660
+ Annotated[StrictFloat, Field(gt=0)],
2661
+ Annotated[StrictFloat, Field(gt=0)]
2662
+ ]
2663
+ ] = None,
2664
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2665
+ _content_type: Optional[StrictStr] = None,
2666
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2667
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2668
+ ) -> None:
2669
+ """Updates the password of a user after a password reset request.
2670
+
2671
+
2672
+ :param submit_password_reset_command: The command containing the user's email, the reset token and the new password.
2673
+ :type submit_password_reset_command: SubmitPasswordResetCommand
2674
+ :param _request_timeout: timeout setting for this request. If one
2675
+ number provided, it will be total request
2676
+ timeout. It can also be a pair (tuple) of
2677
+ (connection, read) timeouts.
2678
+ :type _request_timeout: int, tuple(int, int), optional
2679
+ :param _request_auth: set to override the auth_settings for an a single
2680
+ request; this effectively ignores the
2681
+ authentication in the spec for a single request.
2682
+ :type _request_auth: dict, optional
2683
+ :param _content_type: force content-type for the request.
2684
+ :type _content_type: str, Optional
2685
+ :param _headers: set to override the headers for a single
2686
+ request; this effectively ignores the headers
2687
+ in the spec for a single request.
2688
+ :type _headers: dict, optional
2689
+ :param _host_index: set to override the host_index for a single
2690
+ request; this effectively ignores the host_index
2691
+ in the spec for a single request.
2692
+ :type _host_index: int, optional
2693
+ :return: Returns the result object.
2694
+ """ # noqa: E501
2695
+
2696
+ _param = self._identity_submit_reset_post_serialize(
2697
+ submit_password_reset_command=submit_password_reset_command,
2698
+ _request_auth=_request_auth,
2699
+ _content_type=_content_type,
2700
+ _headers=_headers,
2701
+ _host_index=_host_index
2702
+ )
2703
+
2704
+ _response_types_map: Dict[str, Optional[str]] = {
2705
+ '200': None,
2706
+ }
2707
+ response_data = self.api_client.call_api(
2708
+ *_param,
2709
+ _request_timeout=_request_timeout
2710
+ )
2711
+ response_data.read()
2712
+ return self.api_client.response_deserialize(
2713
+ response_data=response_data,
2714
+ response_types_map=_response_types_map,
2715
+ ).data
2716
+
2717
+
2718
+ @validate_call
2719
+ def identity_submit_reset_post_with_http_info(
2720
+ self,
2721
+ submit_password_reset_command: Annotated[Optional[SubmitPasswordResetCommand], Field(description="The command containing the user's email, the reset token and the new password.")] = None,
2722
+ _request_timeout: Union[
2723
+ None,
2724
+ Annotated[StrictFloat, Field(gt=0)],
2725
+ Tuple[
2726
+ Annotated[StrictFloat, Field(gt=0)],
2727
+ Annotated[StrictFloat, Field(gt=0)]
2728
+ ]
2729
+ ] = None,
2730
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2731
+ _content_type: Optional[StrictStr] = None,
2732
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2733
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2734
+ ) -> ApiResponse[None]:
2735
+ """Updates the password of a user after a password reset request.
2736
+
2737
+
2738
+ :param submit_password_reset_command: The command containing the user's email, the reset token and the new password.
2739
+ :type submit_password_reset_command: SubmitPasswordResetCommand
2740
+ :param _request_timeout: timeout setting for this request. If one
2741
+ number provided, it will be total request
2742
+ timeout. It can also be a pair (tuple) of
2743
+ (connection, read) timeouts.
2744
+ :type _request_timeout: int, tuple(int, int), optional
2745
+ :param _request_auth: set to override the auth_settings for an a single
2746
+ request; this effectively ignores the
2747
+ authentication in the spec for a single request.
2748
+ :type _request_auth: dict, optional
2749
+ :param _content_type: force content-type for the request.
2750
+ :type _content_type: str, Optional
2751
+ :param _headers: set to override the headers for a single
2752
+ request; this effectively ignores the headers
2753
+ in the spec for a single request.
2754
+ :type _headers: dict, optional
2755
+ :param _host_index: set to override the host_index for a single
2756
+ request; this effectively ignores the host_index
2757
+ in the spec for a single request.
2758
+ :type _host_index: int, optional
2759
+ :return: Returns the result object.
2760
+ """ # noqa: E501
2761
+
2762
+ _param = self._identity_submit_reset_post_serialize(
2763
+ submit_password_reset_command=submit_password_reset_command,
2764
+ _request_auth=_request_auth,
2765
+ _content_type=_content_type,
2766
+ _headers=_headers,
2767
+ _host_index=_host_index
2768
+ )
2769
+
2770
+ _response_types_map: Dict[str, Optional[str]] = {
2771
+ '200': None,
2772
+ }
2773
+ response_data = self.api_client.call_api(
2774
+ *_param,
2775
+ _request_timeout=_request_timeout
2776
+ )
2777
+ response_data.read()
2778
+ return self.api_client.response_deserialize(
2779
+ response_data=response_data,
2780
+ response_types_map=_response_types_map,
2781
+ )
2782
+
2783
+
2784
+ @validate_call
2785
+ def identity_submit_reset_post_without_preload_content(
2786
+ self,
2787
+ submit_password_reset_command: Annotated[Optional[SubmitPasswordResetCommand], Field(description="The command containing the user's email, the reset token and the new password.")] = None,
2788
+ _request_timeout: Union[
2789
+ None,
2790
+ Annotated[StrictFloat, Field(gt=0)],
2791
+ Tuple[
2792
+ Annotated[StrictFloat, Field(gt=0)],
2793
+ Annotated[StrictFloat, Field(gt=0)]
2794
+ ]
2795
+ ] = None,
2796
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2797
+ _content_type: Optional[StrictStr] = None,
2798
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2799
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2800
+ ) -> RESTResponseType:
2801
+ """Updates the password of a user after a password reset request.
2802
+
2803
+
2804
+ :param submit_password_reset_command: The command containing the user's email, the reset token and the new password.
2805
+ :type submit_password_reset_command: SubmitPasswordResetCommand
2806
+ :param _request_timeout: timeout setting for this request. If one
2807
+ number provided, it will be total request
2808
+ timeout. It can also be a pair (tuple) of
2809
+ (connection, read) timeouts.
2810
+ :type _request_timeout: int, tuple(int, int), optional
2811
+ :param _request_auth: set to override the auth_settings for an a single
2812
+ request; this effectively ignores the
2813
+ authentication in the spec for a single request.
2814
+ :type _request_auth: dict, optional
2815
+ :param _content_type: force content-type for the request.
2816
+ :type _content_type: str, Optional
2817
+ :param _headers: set to override the headers for a single
2818
+ request; this effectively ignores the headers
2819
+ in the spec for a single request.
2820
+ :type _headers: dict, optional
2821
+ :param _host_index: set to override the host_index for a single
2822
+ request; this effectively ignores the host_index
2823
+ in the spec for a single request.
2824
+ :type _host_index: int, optional
2825
+ :return: Returns the result object.
2826
+ """ # noqa: E501
2827
+
2828
+ _param = self._identity_submit_reset_post_serialize(
2829
+ submit_password_reset_command=submit_password_reset_command,
2830
+ _request_auth=_request_auth,
2831
+ _content_type=_content_type,
2832
+ _headers=_headers,
2833
+ _host_index=_host_index
2834
+ )
2835
+
2836
+ _response_types_map: Dict[str, Optional[str]] = {
2837
+ '200': None,
2838
+ }
2839
+ response_data = self.api_client.call_api(
2840
+ *_param,
2841
+ _request_timeout=_request_timeout
2842
+ )
2843
+ return response_data.response
2844
+
2845
+
2846
+ def _identity_submit_reset_post_serialize(
2847
+ self,
2848
+ submit_password_reset_command,
2849
+ _request_auth,
2850
+ _content_type,
2851
+ _headers,
2852
+ _host_index,
2853
+ ) -> RequestSerialized:
2854
+
2855
+ _host = None
2856
+
2857
+ _collection_formats: Dict[str, str] = {
2858
+ }
2859
+
2860
+ _path_params: Dict[str, str] = {}
2861
+ _query_params: List[Tuple[str, str]] = []
2862
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2863
+ _form_params: List[Tuple[str, str]] = []
2864
+ _files: Dict[
2865
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2866
+ ] = {}
2867
+ _body_params: Optional[bytes] = None
2868
+
2869
+ # process the path parameters
2870
+ # process the query parameters
2871
+ # process the header parameters
2872
+ # process the form parameters
2873
+ # process the body parameter
2874
+ if submit_password_reset_command is not None:
2875
+ _body_params = submit_password_reset_command
2876
+
2877
+
2878
+
2879
+ # set the HTTP header `Content-Type`
2880
+ if _content_type:
2881
+ _header_params['Content-Type'] = _content_type
2882
+ else:
2883
+ _default_content_type = (
2884
+ self.api_client.select_header_content_type(
2885
+ [
2886
+ 'application/json',
2887
+ 'text/json',
2888
+ 'application/*+json'
2889
+ ]
2890
+ )
2891
+ )
2892
+ if _default_content_type is not None:
2893
+ _header_params['Content-Type'] = _default_content_type
2894
+
2895
+ # authentication setting
2896
+ _auth_settings: List[str] = [
2897
+ 'bearer'
2898
+ ]
2899
+
2900
+ return self.api_client.param_serialize(
2901
+ method='POST',
2902
+ resource_path='/Identity/SubmitReset',
2903
+ path_params=_path_params,
2904
+ query_params=_query_params,
2905
+ header_params=_header_params,
2906
+ body=_body_params,
2907
+ post_params=_form_params,
2908
+ files=_files,
2909
+ auth_settings=_auth_settings,
2910
+ collection_formats=_collection_formats,
2911
+ _host=_host,
2912
+ _request_auth=_request_auth
2913
+ )
2914
+
2915
+
2916
+
2917
+
2918
+ @validate_call
2919
+ def identity_temporary_post(
2920
+ self,
2921
+ signup_shadow_customer_model: Annotated[Optional[SignupShadowCustomerModel], Field(description="The model to create the temporary user with.")] = None,
2922
+ _request_timeout: Union[
2923
+ None,
2924
+ Annotated[StrictFloat, Field(gt=0)],
2925
+ Tuple[
2926
+ Annotated[StrictFloat, Field(gt=0)],
2927
+ Annotated[StrictFloat, Field(gt=0)]
2928
+ ]
2929
+ ] = None,
2930
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2931
+ _content_type: Optional[StrictStr] = None,
2932
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2933
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2934
+ ) -> None:
2935
+ """Creates a new temporary user.
2936
+
2937
+
2938
+ :param signup_shadow_customer_model: The model to create the temporary user with.
2939
+ :type signup_shadow_customer_model: SignupShadowCustomerModel
2940
+ :param _request_timeout: timeout setting for this request. If one
2941
+ number provided, it will be total request
2942
+ timeout. It can also be a pair (tuple) of
2943
+ (connection, read) timeouts.
2944
+ :type _request_timeout: int, tuple(int, int), optional
2945
+ :param _request_auth: set to override the auth_settings for an a single
2946
+ request; this effectively ignores the
2947
+ authentication in the spec for a single request.
2948
+ :type _request_auth: dict, optional
2949
+ :param _content_type: force content-type for the request.
2950
+ :type _content_type: str, Optional
2951
+ :param _headers: set to override the headers for a single
2952
+ request; this effectively ignores the headers
2953
+ in the spec for a single request.
2954
+ :type _headers: dict, optional
2955
+ :param _host_index: set to override the host_index for a single
2956
+ request; this effectively ignores the host_index
2957
+ in the spec for a single request.
2958
+ :type _host_index: int, optional
2959
+ :return: Returns the result object.
2960
+ """ # noqa: E501
2961
+
2962
+ _param = self._identity_temporary_post_serialize(
2963
+ signup_shadow_customer_model=signup_shadow_customer_model,
2964
+ _request_auth=_request_auth,
2965
+ _content_type=_content_type,
2966
+ _headers=_headers,
2967
+ _host_index=_host_index
2968
+ )
2969
+
2970
+ _response_types_map: Dict[str, Optional[str]] = {
2971
+ '200': None,
2972
+ }
2973
+ response_data = self.api_client.call_api(
2974
+ *_param,
2975
+ _request_timeout=_request_timeout
2976
+ )
2977
+ response_data.read()
2978
+ return self.api_client.response_deserialize(
2979
+ response_data=response_data,
2980
+ response_types_map=_response_types_map,
2981
+ ).data
2982
+
2983
+
2984
+ @validate_call
2985
+ def identity_temporary_post_with_http_info(
2986
+ self,
2987
+ signup_shadow_customer_model: Annotated[Optional[SignupShadowCustomerModel], Field(description="The model to create the temporary user with.")] = None,
2988
+ _request_timeout: Union[
2989
+ None,
2990
+ Annotated[StrictFloat, Field(gt=0)],
2991
+ Tuple[
2992
+ Annotated[StrictFloat, Field(gt=0)],
2993
+ Annotated[StrictFloat, Field(gt=0)]
2994
+ ]
2995
+ ] = None,
2996
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2997
+ _content_type: Optional[StrictStr] = None,
2998
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2999
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3000
+ ) -> ApiResponse[None]:
3001
+ """Creates a new temporary user.
3002
+
3003
+
3004
+ :param signup_shadow_customer_model: The model to create the temporary user with.
3005
+ :type signup_shadow_customer_model: SignupShadowCustomerModel
3006
+ :param _request_timeout: timeout setting for this request. If one
3007
+ number provided, it will be total request
3008
+ timeout. It can also be a pair (tuple) of
3009
+ (connection, read) timeouts.
3010
+ :type _request_timeout: int, tuple(int, int), optional
3011
+ :param _request_auth: set to override the auth_settings for an a single
3012
+ request; this effectively ignores the
3013
+ authentication in the spec for a single request.
3014
+ :type _request_auth: dict, optional
3015
+ :param _content_type: force content-type for the request.
3016
+ :type _content_type: str, Optional
3017
+ :param _headers: set to override the headers for a single
3018
+ request; this effectively ignores the headers
3019
+ in the spec for a single request.
3020
+ :type _headers: dict, optional
3021
+ :param _host_index: set to override the host_index for a single
3022
+ request; this effectively ignores the host_index
3023
+ in the spec for a single request.
3024
+ :type _host_index: int, optional
3025
+ :return: Returns the result object.
3026
+ """ # noqa: E501
3027
+
3028
+ _param = self._identity_temporary_post_serialize(
3029
+ signup_shadow_customer_model=signup_shadow_customer_model,
3030
+ _request_auth=_request_auth,
3031
+ _content_type=_content_type,
3032
+ _headers=_headers,
3033
+ _host_index=_host_index
3034
+ )
3035
+
3036
+ _response_types_map: Dict[str, Optional[str]] = {
3037
+ '200': None,
3038
+ }
3039
+ response_data = self.api_client.call_api(
3040
+ *_param,
3041
+ _request_timeout=_request_timeout
3042
+ )
3043
+ response_data.read()
3044
+ return self.api_client.response_deserialize(
3045
+ response_data=response_data,
3046
+ response_types_map=_response_types_map,
3047
+ )
3048
+
3049
+
3050
+ @validate_call
3051
+ def identity_temporary_post_without_preload_content(
3052
+ self,
3053
+ signup_shadow_customer_model: Annotated[Optional[SignupShadowCustomerModel], Field(description="The model to create the temporary user with.")] = None,
3054
+ _request_timeout: Union[
3055
+ None,
3056
+ Annotated[StrictFloat, Field(gt=0)],
3057
+ Tuple[
3058
+ Annotated[StrictFloat, Field(gt=0)],
3059
+ Annotated[StrictFloat, Field(gt=0)]
3060
+ ]
3061
+ ] = None,
3062
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3063
+ _content_type: Optional[StrictStr] = None,
3064
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3065
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3066
+ ) -> RESTResponseType:
3067
+ """Creates a new temporary user.
3068
+
3069
+
3070
+ :param signup_shadow_customer_model: The model to create the temporary user with.
3071
+ :type signup_shadow_customer_model: SignupShadowCustomerModel
3072
+ :param _request_timeout: timeout setting for this request. If one
3073
+ number provided, it will be total request
3074
+ timeout. It can also be a pair (tuple) of
3075
+ (connection, read) timeouts.
3076
+ :type _request_timeout: int, tuple(int, int), optional
3077
+ :param _request_auth: set to override the auth_settings for an a single
3078
+ request; this effectively ignores the
3079
+ authentication in the spec for a single request.
3080
+ :type _request_auth: dict, optional
3081
+ :param _content_type: force content-type for the request.
3082
+ :type _content_type: str, Optional
3083
+ :param _headers: set to override the headers for a single
3084
+ request; this effectively ignores the headers
3085
+ in the spec for a single request.
3086
+ :type _headers: dict, optional
3087
+ :param _host_index: set to override the host_index for a single
3088
+ request; this effectively ignores the host_index
3089
+ in the spec for a single request.
3090
+ :type _host_index: int, optional
3091
+ :return: Returns the result object.
3092
+ """ # noqa: E501
3093
+
3094
+ _param = self._identity_temporary_post_serialize(
3095
+ signup_shadow_customer_model=signup_shadow_customer_model,
3096
+ _request_auth=_request_auth,
3097
+ _content_type=_content_type,
3098
+ _headers=_headers,
3099
+ _host_index=_host_index
3100
+ )
3101
+
3102
+ _response_types_map: Dict[str, Optional[str]] = {
3103
+ '200': None,
3104
+ }
3105
+ response_data = self.api_client.call_api(
3106
+ *_param,
3107
+ _request_timeout=_request_timeout
3108
+ )
3109
+ return response_data.response
3110
+
3111
+
3112
+ def _identity_temporary_post_serialize(
3113
+ self,
3114
+ signup_shadow_customer_model,
3115
+ _request_auth,
3116
+ _content_type,
3117
+ _headers,
3118
+ _host_index,
3119
+ ) -> RequestSerialized:
3120
+
3121
+ _host = None
3122
+
3123
+ _collection_formats: Dict[str, str] = {
3124
+ }
3125
+
3126
+ _path_params: Dict[str, str] = {}
3127
+ _query_params: List[Tuple[str, str]] = []
3128
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3129
+ _form_params: List[Tuple[str, str]] = []
3130
+ _files: Dict[
3131
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3132
+ ] = {}
3133
+ _body_params: Optional[bytes] = None
3134
+
3135
+ # process the path parameters
3136
+ # process the query parameters
3137
+ # process the header parameters
3138
+ # process the form parameters
3139
+ # process the body parameter
3140
+ if signup_shadow_customer_model is not None:
3141
+ _body_params = signup_shadow_customer_model
3142
+
3143
+
3144
+
3145
+ # set the HTTP header `Content-Type`
3146
+ if _content_type:
3147
+ _header_params['Content-Type'] = _content_type
3148
+ else:
3149
+ _default_content_type = (
3150
+ self.api_client.select_header_content_type(
3151
+ [
3152
+ 'application/json',
3153
+ 'text/json',
3154
+ 'application/*+json'
3155
+ ]
3156
+ )
3157
+ )
3158
+ if _default_content_type is not None:
3159
+ _header_params['Content-Type'] = _default_content_type
3160
+
3161
+ # authentication setting
3162
+ _auth_settings: List[str] = [
3163
+ 'bearer'
3164
+ ]
3165
+
3166
+ return self.api_client.param_serialize(
3167
+ method='POST',
3168
+ resource_path='/Identity/Temporary',
3169
+ path_params=_path_params,
3170
+ query_params=_query_params,
3171
+ header_params=_header_params,
3172
+ body=_body_params,
3173
+ post_params=_form_params,
3174
+ files=_files,
3175
+ auth_settings=_auth_settings,
3176
+ collection_formats=_collection_formats,
3177
+ _host=_host,
3178
+ _request_auth=_request_auth
3179
+ )
3180
+
3181
+