rapidata 2.15.0__py3-none-any.whl → 2.16.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of rapidata might be problematic. Click here for more details.

Files changed (60) hide show
  1. rapidata/api_client/__init__.py +17 -7
  2. rapidata/api_client/api/__init__.py +2 -1
  3. rapidata/api_client/api/campaign_api.py +554 -30
  4. rapidata/api_client/api/client_api.py +292 -20
  5. rapidata/api_client/api/coco_api.py +594 -8
  6. rapidata/api_client/api/compare_workflow_api.py +23 -23
  7. rapidata/api_client/api/datapoint_api.py +548 -26
  8. rapidata/api_client/api/dataset_api.py +2198 -186
  9. rapidata/api_client/api/feedback_api.py +306 -0
  10. rapidata/api_client/api/identity_api.py +1143 -78
  11. rapidata/api_client/api/newsletter_api.py +299 -11
  12. rapidata/api_client/api/order_api.py +5358 -556
  13. rapidata/api_client/api/pipeline_api.py +263 -524
  14. rapidata/api_client/api/rapid_api.py +1930 -254
  15. rapidata/api_client/api/simple_workflow_api.py +23 -23
  16. rapidata/api_client/api/validation_set_api.py +5259 -0
  17. rapidata/api_client/api/workflow_api.py +929 -134
  18. rapidata/api_client/models/__init__.py +15 -6
  19. rapidata/api_client/models/ab_test_selection_a_inner.py +24 -10
  20. rapidata/api_client/models/add_user_response_result.py +106 -0
  21. rapidata/api_client/models/add_user_response_result_validation_truth.py +258 -0
  22. rapidata/api_client/models/add_validation_rapid_model.py +3 -3
  23. rapidata/api_client/models/add_validation_text_rapid_model.py +3 -3
  24. rapidata/api_client/models/are_rapids_active_result.py +87 -0
  25. rapidata/api_client/models/compare_workflow_model.py +3 -3
  26. rapidata/api_client/models/create_datapoint_from_files_model.py +102 -0
  27. rapidata/api_client/models/create_datapoint_from_files_model_metadata_inner.py +168 -0
  28. rapidata/api_client/models/create_datapoint_from_text_sources_model.py +109 -0
  29. rapidata/api_client/models/create_datapoint_from_urls_model.py +4 -4
  30. rapidata/api_client/models/create_datapoints_from_s3_bucket_model.py +124 -0
  31. rapidata/api_client/models/create_rapid_result.py +87 -0
  32. rapidata/api_client/models/create_validation_set_model.py +87 -0
  33. rapidata/api_client/models/datapoint_metadata_model.py +3 -3
  34. rapidata/api_client/models/get_validation_rapids_query.py +123 -0
  35. rapidata/api_client/models/get_validation_rapids_query_paged_result.py +105 -0
  36. rapidata/api_client/models/pipeline_id_workflow_artifact_id_put_request.py +140 -0
  37. rapidata/api_client/models/query_validation_rapids_result.py +3 -3
  38. rapidata/api_client/models/rapid_issue.py +4 -0
  39. rapidata/api_client/models/report_model.py +4 -4
  40. rapidata/api_client/models/shuffling_selection.py +106 -0
  41. rapidata/api_client/models/update_dataset_name_model.py +87 -0
  42. rapidata/api_client/models/update_order_name_model.py +87 -0
  43. rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
  44. rapidata/api_client/models/user_score_user_filter_model.py +9 -2
  45. rapidata/api_client_README.md +153 -88
  46. rapidata/rapidata_client/demographic/demographic_manager.py +1 -1
  47. rapidata/rapidata_client/filter/user_score_filter.py +4 -1
  48. rapidata/rapidata_client/order/_rapidata_dataset.py +10 -11
  49. rapidata/rapidata_client/order/_rapidata_order_builder.py +1 -1
  50. rapidata/rapidata_client/order/rapidata_order.py +5 -5
  51. rapidata/rapidata_client/order/rapidata_order_manager.py +1 -1
  52. rapidata/rapidata_client/order/rapidata_results.py +1 -1
  53. rapidata/rapidata_client/validation/rapidata_validation_set.py +11 -0
  54. rapidata/rapidata_client/validation/rapids/rapids.py +3 -5
  55. rapidata/rapidata_client/validation/validation_set_manager.py +36 -21
  56. rapidata/rapidata_client/workflow/_ranking_workflow.py +2 -2
  57. {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/METADATA +1 -1
  58. {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/RECORD +60 -43
  59. {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/LICENSE +0 -0
  60. {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/WHEEL +0 -0
@@ -43,9 +43,9 @@ class IdentityApi:
43
43
 
44
44
 
45
45
  @validate_call
46
- def identity_create_bridge_token_post(
46
+ def identity_bridge_token_get(
47
47
  self,
48
- client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
48
+ read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
49
49
  _request_timeout: Union[
50
50
  None,
51
51
  Annotated[StrictFloat, Field(gt=0)],
@@ -58,12 +58,12 @@ class IdentityApi:
58
58
  _content_type: Optional[StrictStr] = None,
59
59
  _headers: Optional[Dict[StrictStr, Any]] = None,
60
60
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
61
- ) -> CreateBridgeTokenResult:
62
- """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
61
+ ) -> ReadBridgeTokenKeysResult:
62
+ """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
63
63
 
64
64
 
65
- :param client_id: The client ID to create the keys for.
66
- :type client_id: str
65
+ :param read_key: The read key to read the bridge token keys for.
66
+ :type read_key: str
67
67
  :param _request_timeout: timeout setting for this request. If one
68
68
  number provided, it will be total request
69
69
  timeout. It can also be a pair (tuple) of
@@ -86,8 +86,8 @@ class IdentityApi:
86
86
  :return: Returns the result object.
87
87
  """ # noqa: E501
88
88
 
89
- _param = self._identity_create_bridge_token_post_serialize(
90
- client_id=client_id,
89
+ _param = self._identity_bridge_token_get_serialize(
90
+ read_key=read_key,
91
91
  _request_auth=_request_auth,
92
92
  _content_type=_content_type,
93
93
  _headers=_headers,
@@ -95,7 +95,8 @@ class IdentityApi:
95
95
  )
96
96
 
97
97
  _response_types_map: Dict[str, Optional[str]] = {
98
- '200': "CreateBridgeTokenResult",
98
+ '200': "ReadBridgeTokenKeysResult",
99
+ '202': "NotAvailableYetResult",
99
100
  }
100
101
  response_data = self.api_client.call_api(
101
102
  *_param,
@@ -109,9 +110,9 @@ class IdentityApi:
109
110
 
110
111
 
111
112
  @validate_call
112
- def identity_create_bridge_token_post_with_http_info(
113
+ def identity_bridge_token_get_with_http_info(
113
114
  self,
114
- client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
115
+ read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
115
116
  _request_timeout: Union[
116
117
  None,
117
118
  Annotated[StrictFloat, Field(gt=0)],
@@ -124,12 +125,12 @@ class IdentityApi:
124
125
  _content_type: Optional[StrictStr] = None,
125
126
  _headers: Optional[Dict[StrictStr, Any]] = None,
126
127
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
127
- ) -> ApiResponse[CreateBridgeTokenResult]:
128
- """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
128
+ ) -> ApiResponse[ReadBridgeTokenKeysResult]:
129
+ """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
129
130
 
130
131
 
131
- :param client_id: The client ID to create the keys for.
132
- :type client_id: str
132
+ :param read_key: The read key to read the bridge token keys for.
133
+ :type read_key: str
133
134
  :param _request_timeout: timeout setting for this request. If one
134
135
  number provided, it will be total request
135
136
  timeout. It can also be a pair (tuple) of
@@ -152,8 +153,8 @@ class IdentityApi:
152
153
  :return: Returns the result object.
153
154
  """ # noqa: E501
154
155
 
155
- _param = self._identity_create_bridge_token_post_serialize(
156
- client_id=client_id,
156
+ _param = self._identity_bridge_token_get_serialize(
157
+ read_key=read_key,
157
158
  _request_auth=_request_auth,
158
159
  _content_type=_content_type,
159
160
  _headers=_headers,
@@ -161,7 +162,8 @@ class IdentityApi:
161
162
  )
162
163
 
163
164
  _response_types_map: Dict[str, Optional[str]] = {
164
- '200': "CreateBridgeTokenResult",
165
+ '200': "ReadBridgeTokenKeysResult",
166
+ '202': "NotAvailableYetResult",
165
167
  }
166
168
  response_data = self.api_client.call_api(
167
169
  *_param,
@@ -175,9 +177,9 @@ class IdentityApi:
175
177
 
176
178
 
177
179
  @validate_call
178
- def identity_create_bridge_token_post_without_preload_content(
180
+ def identity_bridge_token_get_without_preload_content(
179
181
  self,
180
- client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
182
+ read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
181
183
  _request_timeout: Union[
182
184
  None,
183
185
  Annotated[StrictFloat, Field(gt=0)],
@@ -191,11 +193,11 @@ class IdentityApi:
191
193
  _headers: Optional[Dict[StrictStr, Any]] = None,
192
194
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
193
195
  ) -> RESTResponseType:
194
- """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
196
+ """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
195
197
 
196
198
 
197
- :param client_id: The client ID to create the keys for.
198
- :type client_id: str
199
+ :param read_key: The read key to read the bridge token keys for.
200
+ :type read_key: str
199
201
  :param _request_timeout: timeout setting for this request. If one
200
202
  number provided, it will be total request
201
203
  timeout. It can also be a pair (tuple) of
@@ -218,8 +220,8 @@ class IdentityApi:
218
220
  :return: Returns the result object.
219
221
  """ # noqa: E501
220
222
 
221
- _param = self._identity_create_bridge_token_post_serialize(
222
- client_id=client_id,
223
+ _param = self._identity_bridge_token_get_serialize(
224
+ read_key=read_key,
223
225
  _request_auth=_request_auth,
224
226
  _content_type=_content_type,
225
227
  _headers=_headers,
@@ -227,7 +229,8 @@ class IdentityApi:
227
229
  )
228
230
 
229
231
  _response_types_map: Dict[str, Optional[str]] = {
230
- '200': "CreateBridgeTokenResult",
232
+ '200': "ReadBridgeTokenKeysResult",
233
+ '202': "NotAvailableYetResult",
231
234
  }
232
235
  response_data = self.api_client.call_api(
233
236
  *_param,
@@ -236,9 +239,9 @@ class IdentityApi:
236
239
  return response_data.response
237
240
 
238
241
 
239
- def _identity_create_bridge_token_post_serialize(
242
+ def _identity_bridge_token_get_serialize(
240
243
  self,
241
- client_id,
244
+ read_key,
242
245
  _request_auth,
243
246
  _content_type,
244
247
  _headers,
@@ -261,9 +264,9 @@ class IdentityApi:
261
264
 
262
265
  # process the path parameters
263
266
  # process the query parameters
264
- if client_id is not None:
267
+ if read_key is not None:
265
268
 
266
- _query_params.append(('clientId', client_id))
269
+ _query_params.append(('readKey', read_key))
267
270
 
268
271
  # process the header parameters
269
272
  # process the form parameters
@@ -288,8 +291,8 @@ class IdentityApi:
288
291
  ]
289
292
 
290
293
  return self.api_client.param_serialize(
291
- method='POST',
292
- resource_path='/Identity/CreateBridgeToken',
294
+ method='GET',
295
+ resource_path='/identity/bridge-token',
293
296
  path_params=_path_params,
294
297
  query_params=_query_params,
295
298
  header_params=_header_params,
@@ -306,9 +309,9 @@ class IdentityApi:
306
309
 
307
310
 
308
311
  @validate_call
309
- def identity_read_bridge_token_get(
312
+ def identity_bridge_token_post(
310
313
  self,
311
- read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
314
+ client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
312
315
  _request_timeout: Union[
313
316
  None,
314
317
  Annotated[StrictFloat, Field(gt=0)],
@@ -321,12 +324,12 @@ class IdentityApi:
321
324
  _content_type: Optional[StrictStr] = None,
322
325
  _headers: Optional[Dict[StrictStr, Any]] = None,
323
326
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
324
- ) -> ReadBridgeTokenKeysResult:
325
- """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
327
+ ) -> CreateBridgeTokenResult:
328
+ """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
326
329
 
327
330
 
328
- :param read_key: The read key to read the bridge token keys for.
329
- :type read_key: str
331
+ :param client_id: The client ID to create the keys for.
332
+ :type client_id: str
330
333
  :param _request_timeout: timeout setting for this request. If one
331
334
  number provided, it will be total request
332
335
  timeout. It can also be a pair (tuple) of
@@ -349,8 +352,8 @@ class IdentityApi:
349
352
  :return: Returns the result object.
350
353
  """ # noqa: E501
351
354
 
352
- _param = self._identity_read_bridge_token_get_serialize(
353
- read_key=read_key,
355
+ _param = self._identity_bridge_token_post_serialize(
356
+ client_id=client_id,
354
357
  _request_auth=_request_auth,
355
358
  _content_type=_content_type,
356
359
  _headers=_headers,
@@ -358,9 +361,7 @@ class IdentityApi:
358
361
  )
359
362
 
360
363
  _response_types_map: Dict[str, Optional[str]] = {
361
- '200': "ReadBridgeTokenKeysResult",
362
- '202': "IdentityReadBridgeTokenGet202Response",
363
- '404': "ProblemDetails",
364
+ '200': "CreateBridgeTokenResult",
364
365
  }
365
366
  response_data = self.api_client.call_api(
366
367
  *_param,
@@ -374,9 +375,9 @@ class IdentityApi:
374
375
 
375
376
 
376
377
  @validate_call
377
- def identity_read_bridge_token_get_with_http_info(
378
+ def identity_bridge_token_post_with_http_info(
378
379
  self,
379
- read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
380
+ client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
380
381
  _request_timeout: Union[
381
382
  None,
382
383
  Annotated[StrictFloat, Field(gt=0)],
@@ -389,12 +390,12 @@ class IdentityApi:
389
390
  _content_type: Optional[StrictStr] = None,
390
391
  _headers: Optional[Dict[StrictStr, Any]] = None,
391
392
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
392
- ) -> ApiResponse[ReadBridgeTokenKeysResult]:
393
- """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
393
+ ) -> ApiResponse[CreateBridgeTokenResult]:
394
+ """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
394
395
 
395
396
 
396
- :param read_key: The read key to read the bridge token keys for.
397
- :type read_key: str
397
+ :param client_id: The client ID to create the keys for.
398
+ :type client_id: str
398
399
  :param _request_timeout: timeout setting for this request. If one
399
400
  number provided, it will be total request
400
401
  timeout. It can also be a pair (tuple) of
@@ -417,8 +418,8 @@ class IdentityApi:
417
418
  :return: Returns the result object.
418
419
  """ # noqa: E501
419
420
 
420
- _param = self._identity_read_bridge_token_get_serialize(
421
- read_key=read_key,
421
+ _param = self._identity_bridge_token_post_serialize(
422
+ client_id=client_id,
422
423
  _request_auth=_request_auth,
423
424
  _content_type=_content_type,
424
425
  _headers=_headers,
@@ -426,9 +427,7 @@ class IdentityApi:
426
427
  )
427
428
 
428
429
  _response_types_map: Dict[str, Optional[str]] = {
429
- '200': "ReadBridgeTokenKeysResult",
430
- '202': "IdentityReadBridgeTokenGet202Response",
431
- '404': "ProblemDetails",
430
+ '200': "CreateBridgeTokenResult",
432
431
  }
433
432
  response_data = self.api_client.call_api(
434
433
  *_param,
@@ -442,9 +441,9 @@ class IdentityApi:
442
441
 
443
442
 
444
443
  @validate_call
445
- def identity_read_bridge_token_get_without_preload_content(
444
+ def identity_bridge_token_post_without_preload_content(
446
445
  self,
447
- read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
446
+ client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
448
447
  _request_timeout: Union[
449
448
  None,
450
449
  Annotated[StrictFloat, Field(gt=0)],
@@ -458,11 +457,11 @@ class IdentityApi:
458
457
  _headers: Optional[Dict[StrictStr, Any]] = None,
459
458
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
460
459
  ) -> RESTResponseType:
461
- """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
460
+ """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
462
461
 
463
462
 
464
- :param read_key: The read key to read the bridge token keys for.
465
- :type read_key: str
463
+ :param client_id: The client ID to create the keys for.
464
+ :type client_id: str
466
465
  :param _request_timeout: timeout setting for this request. If one
467
466
  number provided, it will be total request
468
467
  timeout. It can also be a pair (tuple) of
@@ -485,8 +484,8 @@ class IdentityApi:
485
484
  :return: Returns the result object.
486
485
  """ # noqa: E501
487
486
 
488
- _param = self._identity_read_bridge_token_get_serialize(
489
- read_key=read_key,
487
+ _param = self._identity_bridge_token_post_serialize(
488
+ client_id=client_id,
490
489
  _request_auth=_request_auth,
491
490
  _content_type=_content_type,
492
491
  _headers=_headers,
@@ -494,9 +493,7 @@ class IdentityApi:
494
493
  )
495
494
 
496
495
  _response_types_map: Dict[str, Optional[str]] = {
497
- '200': "ReadBridgeTokenKeysResult",
498
- '202': "IdentityReadBridgeTokenGet202Response",
499
- '404': "ProblemDetails",
496
+ '200': "CreateBridgeTokenResult",
500
497
  }
501
498
  response_data = self.api_client.call_api(
502
499
  *_param,
@@ -505,9 +502,9 @@ class IdentityApi:
505
502
  return response_data.response
506
503
 
507
504
 
508
- def _identity_read_bridge_token_get_serialize(
505
+ def _identity_bridge_token_post_serialize(
509
506
  self,
510
- read_key,
507
+ client_id,
511
508
  _request_auth,
512
509
  _content_type,
513
510
  _headers,
@@ -530,9 +527,9 @@ class IdentityApi:
530
527
 
531
528
  # process the path parameters
532
529
  # process the query parameters
533
- if read_key is not None:
530
+ if client_id is not None:
534
531
 
535
- _query_params.append(('readKey', read_key))
532
+ _query_params.append(('clientId', client_id))
536
533
 
537
534
  # process the header parameters
538
535
  # process the form parameters
@@ -557,8 +554,1076 @@ class IdentityApi:
557
554
  ]
558
555
 
559
556
  return self.api_client.param_serialize(
560
- method='GET',
561
- resource_path='/Identity/ReadBridgeToken',
557
+ method='POST',
558
+ resource_path='/identity/bridge-token',
559
+ path_params=_path_params,
560
+ query_params=_query_params,
561
+ header_params=_header_params,
562
+ body=_body_params,
563
+ post_params=_form_params,
564
+ files=_files,
565
+ auth_settings=_auth_settings,
566
+ collection_formats=_collection_formats,
567
+ _host=_host,
568
+ _request_auth=_request_auth
569
+ )
570
+
571
+
572
+
573
+
574
+ @validate_call
575
+ def identity_createbridgetoken_post(
576
+ self,
577
+ client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
578
+ _request_timeout: Union[
579
+ None,
580
+ Annotated[StrictFloat, Field(gt=0)],
581
+ Tuple[
582
+ Annotated[StrictFloat, Field(gt=0)],
583
+ Annotated[StrictFloat, Field(gt=0)]
584
+ ]
585
+ ] = None,
586
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
587
+ _content_type: Optional[StrictStr] = None,
588
+ _headers: Optional[Dict[StrictStr, Any]] = None,
589
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
590
+ ) -> CreateBridgeTokenResult:
591
+ """(Deprecated) Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
592
+
593
+
594
+ :param client_id: The client ID to create the keys for.
595
+ :type client_id: str
596
+ :param _request_timeout: timeout setting for this request. If one
597
+ number provided, it will be total request
598
+ timeout. It can also be a pair (tuple) of
599
+ (connection, read) timeouts.
600
+ :type _request_timeout: int, tuple(int, int), optional
601
+ :param _request_auth: set to override the auth_settings for an a single
602
+ request; this effectively ignores the
603
+ authentication in the spec for a single request.
604
+ :type _request_auth: dict, optional
605
+ :param _content_type: force content-type for the request.
606
+ :type _content_type: str, Optional
607
+ :param _headers: set to override the headers for a single
608
+ request; this effectively ignores the headers
609
+ in the spec for a single request.
610
+ :type _headers: dict, optional
611
+ :param _host_index: set to override the host_index for a single
612
+ request; this effectively ignores the host_index
613
+ in the spec for a single request.
614
+ :type _host_index: int, optional
615
+ :return: Returns the result object.
616
+ """ # noqa: E501
617
+ warnings.warn("POST /identity/createbridgetoken is deprecated.", DeprecationWarning)
618
+
619
+ _param = self._identity_createbridgetoken_post_serialize(
620
+ client_id=client_id,
621
+ _request_auth=_request_auth,
622
+ _content_type=_content_type,
623
+ _headers=_headers,
624
+ _host_index=_host_index
625
+ )
626
+
627
+ _response_types_map: Dict[str, Optional[str]] = {
628
+ '200': "CreateBridgeTokenResult",
629
+ }
630
+ response_data = self.api_client.call_api(
631
+ *_param,
632
+ _request_timeout=_request_timeout
633
+ )
634
+ response_data.read()
635
+ return self.api_client.response_deserialize(
636
+ response_data=response_data,
637
+ response_types_map=_response_types_map,
638
+ ).data
639
+
640
+
641
+ @validate_call
642
+ def identity_createbridgetoken_post_with_http_info(
643
+ self,
644
+ client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
645
+ _request_timeout: Union[
646
+ None,
647
+ Annotated[StrictFloat, Field(gt=0)],
648
+ Tuple[
649
+ Annotated[StrictFloat, Field(gt=0)],
650
+ Annotated[StrictFloat, Field(gt=0)]
651
+ ]
652
+ ] = None,
653
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
654
+ _content_type: Optional[StrictStr] = None,
655
+ _headers: Optional[Dict[StrictStr, Any]] = None,
656
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
657
+ ) -> ApiResponse[CreateBridgeTokenResult]:
658
+ """(Deprecated) Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
659
+
660
+
661
+ :param client_id: The client ID to create the keys for.
662
+ :type client_id: str
663
+ :param _request_timeout: timeout setting for this request. If one
664
+ number provided, it will be total request
665
+ timeout. It can also be a pair (tuple) of
666
+ (connection, read) timeouts.
667
+ :type _request_timeout: int, tuple(int, int), optional
668
+ :param _request_auth: set to override the auth_settings for an a single
669
+ request; this effectively ignores the
670
+ authentication in the spec for a single request.
671
+ :type _request_auth: dict, optional
672
+ :param _content_type: force content-type for the request.
673
+ :type _content_type: str, Optional
674
+ :param _headers: set to override the headers for a single
675
+ request; this effectively ignores the headers
676
+ in the spec for a single request.
677
+ :type _headers: dict, optional
678
+ :param _host_index: set to override the host_index for a single
679
+ request; this effectively ignores the host_index
680
+ in the spec for a single request.
681
+ :type _host_index: int, optional
682
+ :return: Returns the result object.
683
+ """ # noqa: E501
684
+ warnings.warn("POST /identity/createbridgetoken is deprecated.", DeprecationWarning)
685
+
686
+ _param = self._identity_createbridgetoken_post_serialize(
687
+ client_id=client_id,
688
+ _request_auth=_request_auth,
689
+ _content_type=_content_type,
690
+ _headers=_headers,
691
+ _host_index=_host_index
692
+ )
693
+
694
+ _response_types_map: Dict[str, Optional[str]] = {
695
+ '200': "CreateBridgeTokenResult",
696
+ }
697
+ response_data = self.api_client.call_api(
698
+ *_param,
699
+ _request_timeout=_request_timeout
700
+ )
701
+ response_data.read()
702
+ return self.api_client.response_deserialize(
703
+ response_data=response_data,
704
+ response_types_map=_response_types_map,
705
+ )
706
+
707
+
708
+ @validate_call
709
+ def identity_createbridgetoken_post_without_preload_content(
710
+ self,
711
+ client_id: Annotated[Optional[StrictStr], Field(description="The client ID to create the keys for.")] = None,
712
+ _request_timeout: Union[
713
+ None,
714
+ Annotated[StrictFloat, Field(gt=0)],
715
+ Tuple[
716
+ Annotated[StrictFloat, Field(gt=0)],
717
+ Annotated[StrictFloat, Field(gt=0)]
718
+ ]
719
+ ] = None,
720
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
721
+ _content_type: Optional[StrictStr] = None,
722
+ _headers: Optional[Dict[StrictStr, Any]] = None,
723
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
724
+ ) -> RESTResponseType:
725
+ """(Deprecated) Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
726
+
727
+
728
+ :param client_id: The client ID to create the keys for.
729
+ :type client_id: str
730
+ :param _request_timeout: timeout setting for this request. If one
731
+ number provided, it will be total request
732
+ timeout. It can also be a pair (tuple) of
733
+ (connection, read) timeouts.
734
+ :type _request_timeout: int, tuple(int, int), optional
735
+ :param _request_auth: set to override the auth_settings for an a single
736
+ request; this effectively ignores the
737
+ authentication in the spec for a single request.
738
+ :type _request_auth: dict, optional
739
+ :param _content_type: force content-type for the request.
740
+ :type _content_type: str, Optional
741
+ :param _headers: set to override the headers for a single
742
+ request; this effectively ignores the headers
743
+ in the spec for a single request.
744
+ :type _headers: dict, optional
745
+ :param _host_index: set to override the host_index for a single
746
+ request; this effectively ignores the host_index
747
+ in the spec for a single request.
748
+ :type _host_index: int, optional
749
+ :return: Returns the result object.
750
+ """ # noqa: E501
751
+ warnings.warn("POST /identity/createbridgetoken is deprecated.", DeprecationWarning)
752
+
753
+ _param = self._identity_createbridgetoken_post_serialize(
754
+ client_id=client_id,
755
+ _request_auth=_request_auth,
756
+ _content_type=_content_type,
757
+ _headers=_headers,
758
+ _host_index=_host_index
759
+ )
760
+
761
+ _response_types_map: Dict[str, Optional[str]] = {
762
+ '200': "CreateBridgeTokenResult",
763
+ }
764
+ response_data = self.api_client.call_api(
765
+ *_param,
766
+ _request_timeout=_request_timeout
767
+ )
768
+ return response_data.response
769
+
770
+
771
+ def _identity_createbridgetoken_post_serialize(
772
+ self,
773
+ client_id,
774
+ _request_auth,
775
+ _content_type,
776
+ _headers,
777
+ _host_index,
778
+ ) -> RequestSerialized:
779
+
780
+ _host = None
781
+
782
+ _collection_formats: Dict[str, str] = {
783
+ }
784
+
785
+ _path_params: Dict[str, str] = {}
786
+ _query_params: List[Tuple[str, str]] = []
787
+ _header_params: Dict[str, Optional[str]] = _headers or {}
788
+ _form_params: List[Tuple[str, str]] = []
789
+ _files: Dict[
790
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
791
+ ] = {}
792
+ _body_params: Optional[bytes] = None
793
+
794
+ # process the path parameters
795
+ # process the query parameters
796
+ if client_id is not None:
797
+
798
+ _query_params.append(('clientId', client_id))
799
+
800
+ # process the header parameters
801
+ # process the form parameters
802
+ # process the body parameter
803
+
804
+
805
+ # set the HTTP header `Accept`
806
+ if 'Accept' not in _header_params:
807
+ _header_params['Accept'] = self.api_client.select_header_accept(
808
+ [
809
+ 'text/plain',
810
+ 'application/json',
811
+ 'text/json'
812
+ ]
813
+ )
814
+
815
+
816
+ # authentication setting
817
+ _auth_settings: List[str] = [
818
+ 'bearer',
819
+ 'oauth2'
820
+ ]
821
+
822
+ return self.api_client.param_serialize(
823
+ method='POST',
824
+ resource_path='/identity/createbridgetoken',
825
+ path_params=_path_params,
826
+ query_params=_query_params,
827
+ header_params=_header_params,
828
+ body=_body_params,
829
+ post_params=_form_params,
830
+ files=_files,
831
+ auth_settings=_auth_settings,
832
+ collection_formats=_collection_formats,
833
+ _host=_host,
834
+ _request_auth=_request_auth
835
+ )
836
+
837
+
838
+
839
+
840
+ @validate_call
841
+ def identity_readbridgetoken_get(
842
+ self,
843
+ read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
844
+ _request_timeout: Union[
845
+ None,
846
+ Annotated[StrictFloat, Field(gt=0)],
847
+ Tuple[
848
+ Annotated[StrictFloat, Field(gt=0)],
849
+ Annotated[StrictFloat, Field(gt=0)]
850
+ ]
851
+ ] = None,
852
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
853
+ _content_type: Optional[StrictStr] = None,
854
+ _headers: Optional[Dict[StrictStr, Any]] = None,
855
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
856
+ ) -> ReadBridgeTokenKeysResult:
857
+ """(Deprecated) Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
858
+
859
+
860
+ :param read_key: The read key to read the bridge token keys for.
861
+ :type read_key: str
862
+ :param _request_timeout: timeout setting for this request. If one
863
+ number provided, it will be total request
864
+ timeout. It can also be a pair (tuple) of
865
+ (connection, read) timeouts.
866
+ :type _request_timeout: int, tuple(int, int), optional
867
+ :param _request_auth: set to override the auth_settings for an a single
868
+ request; this effectively ignores the
869
+ authentication in the spec for a single request.
870
+ :type _request_auth: dict, optional
871
+ :param _content_type: force content-type for the request.
872
+ :type _content_type: str, Optional
873
+ :param _headers: set to override the headers for a single
874
+ request; this effectively ignores the headers
875
+ in the spec for a single request.
876
+ :type _headers: dict, optional
877
+ :param _host_index: set to override the host_index for a single
878
+ request; this effectively ignores the host_index
879
+ in the spec for a single request.
880
+ :type _host_index: int, optional
881
+ :return: Returns the result object.
882
+ """ # noqa: E501
883
+ warnings.warn("GET /identity/readbridgetoken is deprecated.", DeprecationWarning)
884
+
885
+ _param = self._identity_readbridgetoken_get_serialize(
886
+ read_key=read_key,
887
+ _request_auth=_request_auth,
888
+ _content_type=_content_type,
889
+ _headers=_headers,
890
+ _host_index=_host_index
891
+ )
892
+
893
+ _response_types_map: Dict[str, Optional[str]] = {
894
+ '200': "ReadBridgeTokenKeysResult",
895
+ '202': "NotAvailableYetResult",
896
+ }
897
+ response_data = self.api_client.call_api(
898
+ *_param,
899
+ _request_timeout=_request_timeout
900
+ )
901
+ response_data.read()
902
+ return self.api_client.response_deserialize(
903
+ response_data=response_data,
904
+ response_types_map=_response_types_map,
905
+ ).data
906
+
907
+
908
+ @validate_call
909
+ def identity_readbridgetoken_get_with_http_info(
910
+ self,
911
+ read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
912
+ _request_timeout: Union[
913
+ None,
914
+ Annotated[StrictFloat, Field(gt=0)],
915
+ Tuple[
916
+ Annotated[StrictFloat, Field(gt=0)],
917
+ Annotated[StrictFloat, Field(gt=0)]
918
+ ]
919
+ ] = None,
920
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
921
+ _content_type: Optional[StrictStr] = None,
922
+ _headers: Optional[Dict[StrictStr, Any]] = None,
923
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
924
+ ) -> ApiResponse[ReadBridgeTokenKeysResult]:
925
+ """(Deprecated) Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
926
+
927
+
928
+ :param read_key: The read key to read the bridge token keys for.
929
+ :type read_key: str
930
+ :param _request_timeout: timeout setting for this request. If one
931
+ number provided, it will be total request
932
+ timeout. It can also be a pair (tuple) of
933
+ (connection, read) timeouts.
934
+ :type _request_timeout: int, tuple(int, int), optional
935
+ :param _request_auth: set to override the auth_settings for an a single
936
+ request; this effectively ignores the
937
+ authentication in the spec for a single request.
938
+ :type _request_auth: dict, optional
939
+ :param _content_type: force content-type for the request.
940
+ :type _content_type: str, Optional
941
+ :param _headers: set to override the headers for a single
942
+ request; this effectively ignores the headers
943
+ in the spec for a single request.
944
+ :type _headers: dict, optional
945
+ :param _host_index: set to override the host_index for a single
946
+ request; this effectively ignores the host_index
947
+ in the spec for a single request.
948
+ :type _host_index: int, optional
949
+ :return: Returns the result object.
950
+ """ # noqa: E501
951
+ warnings.warn("GET /identity/readbridgetoken is deprecated.", DeprecationWarning)
952
+
953
+ _param = self._identity_readbridgetoken_get_serialize(
954
+ read_key=read_key,
955
+ _request_auth=_request_auth,
956
+ _content_type=_content_type,
957
+ _headers=_headers,
958
+ _host_index=_host_index
959
+ )
960
+
961
+ _response_types_map: Dict[str, Optional[str]] = {
962
+ '200': "ReadBridgeTokenKeysResult",
963
+ '202': "NotAvailableYetResult",
964
+ }
965
+ response_data = self.api_client.call_api(
966
+ *_param,
967
+ _request_timeout=_request_timeout
968
+ )
969
+ response_data.read()
970
+ return self.api_client.response_deserialize(
971
+ response_data=response_data,
972
+ response_types_map=_response_types_map,
973
+ )
974
+
975
+
976
+ @validate_call
977
+ def identity_readbridgetoken_get_without_preload_content(
978
+ self,
979
+ read_key: Annotated[Optional[StrictStr], Field(description="The read key to read the bridge token keys for.")] = None,
980
+ _request_timeout: Union[
981
+ None,
982
+ Annotated[StrictFloat, Field(gt=0)],
983
+ Tuple[
984
+ Annotated[StrictFloat, Field(gt=0)],
985
+ Annotated[StrictFloat, Field(gt=0)]
986
+ ]
987
+ ] = None,
988
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
989
+ _content_type: Optional[StrictStr] = None,
990
+ _headers: Optional[Dict[StrictStr, Any]] = None,
991
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
992
+ ) -> RESTResponseType:
993
+ """(Deprecated) Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
994
+
995
+
996
+ :param read_key: The read key to read the bridge token keys for.
997
+ :type read_key: str
998
+ :param _request_timeout: timeout setting for this request. If one
999
+ number provided, it will be total request
1000
+ timeout. It can also be a pair (tuple) of
1001
+ (connection, read) timeouts.
1002
+ :type _request_timeout: int, tuple(int, int), optional
1003
+ :param _request_auth: set to override the auth_settings for an a single
1004
+ request; this effectively ignores the
1005
+ authentication in the spec for a single request.
1006
+ :type _request_auth: dict, optional
1007
+ :param _content_type: force content-type for the request.
1008
+ :type _content_type: str, Optional
1009
+ :param _headers: set to override the headers for a single
1010
+ request; this effectively ignores the headers
1011
+ in the spec for a single request.
1012
+ :type _headers: dict, optional
1013
+ :param _host_index: set to override the host_index for a single
1014
+ request; this effectively ignores the host_index
1015
+ in the spec for a single request.
1016
+ :type _host_index: int, optional
1017
+ :return: Returns the result object.
1018
+ """ # noqa: E501
1019
+ warnings.warn("GET /identity/readbridgetoken is deprecated.", DeprecationWarning)
1020
+
1021
+ _param = self._identity_readbridgetoken_get_serialize(
1022
+ read_key=read_key,
1023
+ _request_auth=_request_auth,
1024
+ _content_type=_content_type,
1025
+ _headers=_headers,
1026
+ _host_index=_host_index
1027
+ )
1028
+
1029
+ _response_types_map: Dict[str, Optional[str]] = {
1030
+ '200': "ReadBridgeTokenKeysResult",
1031
+ '202': "NotAvailableYetResult",
1032
+ }
1033
+ response_data = self.api_client.call_api(
1034
+ *_param,
1035
+ _request_timeout=_request_timeout
1036
+ )
1037
+ return response_data.response
1038
+
1039
+
1040
+ def _identity_readbridgetoken_get_serialize(
1041
+ self,
1042
+ read_key,
1043
+ _request_auth,
1044
+ _content_type,
1045
+ _headers,
1046
+ _host_index,
1047
+ ) -> RequestSerialized:
1048
+
1049
+ _host = None
1050
+
1051
+ _collection_formats: Dict[str, str] = {
1052
+ }
1053
+
1054
+ _path_params: Dict[str, str] = {}
1055
+ _query_params: List[Tuple[str, str]] = []
1056
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1057
+ _form_params: List[Tuple[str, str]] = []
1058
+ _files: Dict[
1059
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1060
+ ] = {}
1061
+ _body_params: Optional[bytes] = None
1062
+
1063
+ # process the path parameters
1064
+ # process the query parameters
1065
+ if read_key is not None:
1066
+
1067
+ _query_params.append(('readKey', read_key))
1068
+
1069
+ # process the header parameters
1070
+ # process the form parameters
1071
+ # process the body parameter
1072
+
1073
+
1074
+ # set the HTTP header `Accept`
1075
+ if 'Accept' not in _header_params:
1076
+ _header_params['Accept'] = self.api_client.select_header_accept(
1077
+ [
1078
+ 'text/plain',
1079
+ 'application/json',
1080
+ 'text/json'
1081
+ ]
1082
+ )
1083
+
1084
+
1085
+ # authentication setting
1086
+ _auth_settings: List[str] = [
1087
+ 'bearer',
1088
+ 'oauth2'
1089
+ ]
1090
+
1091
+ return self.api_client.param_serialize(
1092
+ method='GET',
1093
+ resource_path='/identity/readbridgetoken',
1094
+ path_params=_path_params,
1095
+ query_params=_query_params,
1096
+ header_params=_header_params,
1097
+ body=_body_params,
1098
+ post_params=_form_params,
1099
+ files=_files,
1100
+ auth_settings=_auth_settings,
1101
+ collection_formats=_collection_formats,
1102
+ _host=_host,
1103
+ _request_auth=_request_auth
1104
+ )
1105
+
1106
+
1107
+
1108
+
1109
+ @validate_call
1110
+ def identity_referrer_post(
1111
+ self,
1112
+ referrer: Optional[StrictStr] = None,
1113
+ _request_timeout: Union[
1114
+ None,
1115
+ Annotated[StrictFloat, Field(gt=0)],
1116
+ Tuple[
1117
+ Annotated[StrictFloat, Field(gt=0)],
1118
+ Annotated[StrictFloat, Field(gt=0)]
1119
+ ]
1120
+ ] = None,
1121
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1122
+ _content_type: Optional[StrictStr] = None,
1123
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1124
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1125
+ ) -> None:
1126
+ """Sets the referrer for the current customer.
1127
+
1128
+
1129
+ :param referrer:
1130
+ :type referrer: str
1131
+ :param _request_timeout: timeout setting for this request. If one
1132
+ number provided, it will be total request
1133
+ timeout. It can also be a pair (tuple) of
1134
+ (connection, read) timeouts.
1135
+ :type _request_timeout: int, tuple(int, int), optional
1136
+ :param _request_auth: set to override the auth_settings for an a single
1137
+ request; this effectively ignores the
1138
+ authentication in the spec for a single request.
1139
+ :type _request_auth: dict, optional
1140
+ :param _content_type: force content-type for the request.
1141
+ :type _content_type: str, Optional
1142
+ :param _headers: set to override the headers for a single
1143
+ request; this effectively ignores the headers
1144
+ in the spec for a single request.
1145
+ :type _headers: dict, optional
1146
+ :param _host_index: set to override the host_index for a single
1147
+ request; this effectively ignores the host_index
1148
+ in the spec for a single request.
1149
+ :type _host_index: int, optional
1150
+ :return: Returns the result object.
1151
+ """ # noqa: E501
1152
+
1153
+ _param = self._identity_referrer_post_serialize(
1154
+ referrer=referrer,
1155
+ _request_auth=_request_auth,
1156
+ _content_type=_content_type,
1157
+ _headers=_headers,
1158
+ _host_index=_host_index
1159
+ )
1160
+
1161
+ _response_types_map: Dict[str, Optional[str]] = {
1162
+ '204': None,
1163
+ }
1164
+ response_data = self.api_client.call_api(
1165
+ *_param,
1166
+ _request_timeout=_request_timeout
1167
+ )
1168
+ response_data.read()
1169
+ return self.api_client.response_deserialize(
1170
+ response_data=response_data,
1171
+ response_types_map=_response_types_map,
1172
+ ).data
1173
+
1174
+
1175
+ @validate_call
1176
+ def identity_referrer_post_with_http_info(
1177
+ self,
1178
+ referrer: Optional[StrictStr] = None,
1179
+ _request_timeout: Union[
1180
+ None,
1181
+ Annotated[StrictFloat, Field(gt=0)],
1182
+ Tuple[
1183
+ Annotated[StrictFloat, Field(gt=0)],
1184
+ Annotated[StrictFloat, Field(gt=0)]
1185
+ ]
1186
+ ] = None,
1187
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1188
+ _content_type: Optional[StrictStr] = None,
1189
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1190
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1191
+ ) -> ApiResponse[None]:
1192
+ """Sets the referrer for the current customer.
1193
+
1194
+
1195
+ :param referrer:
1196
+ :type referrer: str
1197
+ :param _request_timeout: timeout setting for this request. If one
1198
+ number provided, it will be total request
1199
+ timeout. It can also be a pair (tuple) of
1200
+ (connection, read) timeouts.
1201
+ :type _request_timeout: int, tuple(int, int), optional
1202
+ :param _request_auth: set to override the auth_settings for an a single
1203
+ request; this effectively ignores the
1204
+ authentication in the spec for a single request.
1205
+ :type _request_auth: dict, optional
1206
+ :param _content_type: force content-type for the request.
1207
+ :type _content_type: str, Optional
1208
+ :param _headers: set to override the headers for a single
1209
+ request; this effectively ignores the headers
1210
+ in the spec for a single request.
1211
+ :type _headers: dict, optional
1212
+ :param _host_index: set to override the host_index for a single
1213
+ request; this effectively ignores the host_index
1214
+ in the spec for a single request.
1215
+ :type _host_index: int, optional
1216
+ :return: Returns the result object.
1217
+ """ # noqa: E501
1218
+
1219
+ _param = self._identity_referrer_post_serialize(
1220
+ referrer=referrer,
1221
+ _request_auth=_request_auth,
1222
+ _content_type=_content_type,
1223
+ _headers=_headers,
1224
+ _host_index=_host_index
1225
+ )
1226
+
1227
+ _response_types_map: Dict[str, Optional[str]] = {
1228
+ '204': None,
1229
+ }
1230
+ response_data = self.api_client.call_api(
1231
+ *_param,
1232
+ _request_timeout=_request_timeout
1233
+ )
1234
+ response_data.read()
1235
+ return self.api_client.response_deserialize(
1236
+ response_data=response_data,
1237
+ response_types_map=_response_types_map,
1238
+ )
1239
+
1240
+
1241
+ @validate_call
1242
+ def identity_referrer_post_without_preload_content(
1243
+ self,
1244
+ referrer: Optional[StrictStr] = None,
1245
+ _request_timeout: Union[
1246
+ None,
1247
+ Annotated[StrictFloat, Field(gt=0)],
1248
+ Tuple[
1249
+ Annotated[StrictFloat, Field(gt=0)],
1250
+ Annotated[StrictFloat, Field(gt=0)]
1251
+ ]
1252
+ ] = None,
1253
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1254
+ _content_type: Optional[StrictStr] = None,
1255
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1256
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1257
+ ) -> RESTResponseType:
1258
+ """Sets the referrer for the current customer.
1259
+
1260
+
1261
+ :param referrer:
1262
+ :type referrer: str
1263
+ :param _request_timeout: timeout setting for this request. If one
1264
+ number provided, it will be total request
1265
+ timeout. It can also be a pair (tuple) of
1266
+ (connection, read) timeouts.
1267
+ :type _request_timeout: int, tuple(int, int), optional
1268
+ :param _request_auth: set to override the auth_settings for an a single
1269
+ request; this effectively ignores the
1270
+ authentication in the spec for a single request.
1271
+ :type _request_auth: dict, optional
1272
+ :param _content_type: force content-type for the request.
1273
+ :type _content_type: str, Optional
1274
+ :param _headers: set to override the headers for a single
1275
+ request; this effectively ignores the headers
1276
+ in the spec for a single request.
1277
+ :type _headers: dict, optional
1278
+ :param _host_index: set to override the host_index for a single
1279
+ request; this effectively ignores the host_index
1280
+ in the spec for a single request.
1281
+ :type _host_index: int, optional
1282
+ :return: Returns the result object.
1283
+ """ # noqa: E501
1284
+
1285
+ _param = self._identity_referrer_post_serialize(
1286
+ referrer=referrer,
1287
+ _request_auth=_request_auth,
1288
+ _content_type=_content_type,
1289
+ _headers=_headers,
1290
+ _host_index=_host_index
1291
+ )
1292
+
1293
+ _response_types_map: Dict[str, Optional[str]] = {
1294
+ '204': None,
1295
+ }
1296
+ response_data = self.api_client.call_api(
1297
+ *_param,
1298
+ _request_timeout=_request_timeout
1299
+ )
1300
+ return response_data.response
1301
+
1302
+
1303
+ def _identity_referrer_post_serialize(
1304
+ self,
1305
+ referrer,
1306
+ _request_auth,
1307
+ _content_type,
1308
+ _headers,
1309
+ _host_index,
1310
+ ) -> RequestSerialized:
1311
+
1312
+ _host = None
1313
+
1314
+ _collection_formats: Dict[str, str] = {
1315
+ }
1316
+
1317
+ _path_params: Dict[str, str] = {}
1318
+ _query_params: List[Tuple[str, str]] = []
1319
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1320
+ _form_params: List[Tuple[str, str]] = []
1321
+ _files: Dict[
1322
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1323
+ ] = {}
1324
+ _body_params: Optional[bytes] = None
1325
+
1326
+ # process the path parameters
1327
+ # process the query parameters
1328
+ if referrer is not None:
1329
+
1330
+ _query_params.append(('referrer', referrer))
1331
+
1332
+ # process the header parameters
1333
+ # process the form parameters
1334
+ # process the body parameter
1335
+
1336
+
1337
+
1338
+
1339
+ # authentication setting
1340
+ _auth_settings: List[str] = [
1341
+ 'bearer',
1342
+ 'oauth2'
1343
+ ]
1344
+
1345
+ return self.api_client.param_serialize(
1346
+ method='POST',
1347
+ resource_path='/identity/referrer',
1348
+ path_params=_path_params,
1349
+ query_params=_query_params,
1350
+ header_params=_header_params,
1351
+ body=_body_params,
1352
+ post_params=_form_params,
1353
+ files=_files,
1354
+ auth_settings=_auth_settings,
1355
+ collection_formats=_collection_formats,
1356
+ _host=_host,
1357
+ _request_auth=_request_auth
1358
+ )
1359
+
1360
+
1361
+
1362
+
1363
+ @validate_call
1364
+ def identity_registertemporary_post(
1365
+ self,
1366
+ register_temporary_customer_model: Annotated[Optional[RegisterTemporaryCustomerModel], Field(description="The model to register the temporary customer with.")] = None,
1367
+ _request_timeout: Union[
1368
+ None,
1369
+ Annotated[StrictFloat, Field(gt=0)],
1370
+ Tuple[
1371
+ Annotated[StrictFloat, Field(gt=0)],
1372
+ Annotated[StrictFloat, Field(gt=0)]
1373
+ ]
1374
+ ] = None,
1375
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1376
+ _content_type: Optional[StrictStr] = None,
1377
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1378
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1379
+ ) -> RegisterTemporaryCustomerResult:
1380
+ """(Deprecated) Registers and logs in a temporary customer.
1381
+
1382
+
1383
+ :param register_temporary_customer_model: The model to register the temporary customer with.
1384
+ :type register_temporary_customer_model: RegisterTemporaryCustomerModel
1385
+ :param _request_timeout: timeout setting for this request. If one
1386
+ number provided, it will be total request
1387
+ timeout. It can also be a pair (tuple) of
1388
+ (connection, read) timeouts.
1389
+ :type _request_timeout: int, tuple(int, int), optional
1390
+ :param _request_auth: set to override the auth_settings for an a single
1391
+ request; this effectively ignores the
1392
+ authentication in the spec for a single request.
1393
+ :type _request_auth: dict, optional
1394
+ :param _content_type: force content-type for the request.
1395
+ :type _content_type: str, Optional
1396
+ :param _headers: set to override the headers for a single
1397
+ request; this effectively ignores the headers
1398
+ in the spec for a single request.
1399
+ :type _headers: dict, optional
1400
+ :param _host_index: set to override the host_index for a single
1401
+ request; this effectively ignores the host_index
1402
+ in the spec for a single request.
1403
+ :type _host_index: int, optional
1404
+ :return: Returns the result object.
1405
+ """ # noqa: E501
1406
+ warnings.warn("POST /identity/registertemporary is deprecated.", DeprecationWarning)
1407
+
1408
+ _param = self._identity_registertemporary_post_serialize(
1409
+ register_temporary_customer_model=register_temporary_customer_model,
1410
+ _request_auth=_request_auth,
1411
+ _content_type=_content_type,
1412
+ _headers=_headers,
1413
+ _host_index=_host_index
1414
+ )
1415
+
1416
+ _response_types_map: Dict[str, Optional[str]] = {
1417
+ '200': "RegisterTemporaryCustomerResult",
1418
+ }
1419
+ response_data = self.api_client.call_api(
1420
+ *_param,
1421
+ _request_timeout=_request_timeout
1422
+ )
1423
+ response_data.read()
1424
+ return self.api_client.response_deserialize(
1425
+ response_data=response_data,
1426
+ response_types_map=_response_types_map,
1427
+ ).data
1428
+
1429
+
1430
+ @validate_call
1431
+ def identity_registertemporary_post_with_http_info(
1432
+ self,
1433
+ register_temporary_customer_model: Annotated[Optional[RegisterTemporaryCustomerModel], Field(description="The model to register the temporary customer with.")] = None,
1434
+ _request_timeout: Union[
1435
+ None,
1436
+ Annotated[StrictFloat, Field(gt=0)],
1437
+ Tuple[
1438
+ Annotated[StrictFloat, Field(gt=0)],
1439
+ Annotated[StrictFloat, Field(gt=0)]
1440
+ ]
1441
+ ] = None,
1442
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1443
+ _content_type: Optional[StrictStr] = None,
1444
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1445
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1446
+ ) -> ApiResponse[RegisterTemporaryCustomerResult]:
1447
+ """(Deprecated) Registers and logs in a temporary customer.
1448
+
1449
+
1450
+ :param register_temporary_customer_model: The model to register the temporary customer with.
1451
+ :type register_temporary_customer_model: RegisterTemporaryCustomerModel
1452
+ :param _request_timeout: timeout setting for this request. If one
1453
+ number provided, it will be total request
1454
+ timeout. It can also be a pair (tuple) of
1455
+ (connection, read) timeouts.
1456
+ :type _request_timeout: int, tuple(int, int), optional
1457
+ :param _request_auth: set to override the auth_settings for an a single
1458
+ request; this effectively ignores the
1459
+ authentication in the spec for a single request.
1460
+ :type _request_auth: dict, optional
1461
+ :param _content_type: force content-type for the request.
1462
+ :type _content_type: str, Optional
1463
+ :param _headers: set to override the headers for a single
1464
+ request; this effectively ignores the headers
1465
+ in the spec for a single request.
1466
+ :type _headers: dict, optional
1467
+ :param _host_index: set to override the host_index for a single
1468
+ request; this effectively ignores the host_index
1469
+ in the spec for a single request.
1470
+ :type _host_index: int, optional
1471
+ :return: Returns the result object.
1472
+ """ # noqa: E501
1473
+ warnings.warn("POST /identity/registertemporary is deprecated.", DeprecationWarning)
1474
+
1475
+ _param = self._identity_registertemporary_post_serialize(
1476
+ register_temporary_customer_model=register_temporary_customer_model,
1477
+ _request_auth=_request_auth,
1478
+ _content_type=_content_type,
1479
+ _headers=_headers,
1480
+ _host_index=_host_index
1481
+ )
1482
+
1483
+ _response_types_map: Dict[str, Optional[str]] = {
1484
+ '200': "RegisterTemporaryCustomerResult",
1485
+ }
1486
+ response_data = self.api_client.call_api(
1487
+ *_param,
1488
+ _request_timeout=_request_timeout
1489
+ )
1490
+ response_data.read()
1491
+ return self.api_client.response_deserialize(
1492
+ response_data=response_data,
1493
+ response_types_map=_response_types_map,
1494
+ )
1495
+
1496
+
1497
+ @validate_call
1498
+ def identity_registertemporary_post_without_preload_content(
1499
+ self,
1500
+ register_temporary_customer_model: Annotated[Optional[RegisterTemporaryCustomerModel], Field(description="The model to register the temporary customer with.")] = None,
1501
+ _request_timeout: Union[
1502
+ None,
1503
+ Annotated[StrictFloat, Field(gt=0)],
1504
+ Tuple[
1505
+ Annotated[StrictFloat, Field(gt=0)],
1506
+ Annotated[StrictFloat, Field(gt=0)]
1507
+ ]
1508
+ ] = None,
1509
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1510
+ _content_type: Optional[StrictStr] = None,
1511
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1512
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1513
+ ) -> RESTResponseType:
1514
+ """(Deprecated) Registers and logs in a temporary customer.
1515
+
1516
+
1517
+ :param register_temporary_customer_model: The model to register the temporary customer with.
1518
+ :type register_temporary_customer_model: RegisterTemporaryCustomerModel
1519
+ :param _request_timeout: timeout setting for this request. If one
1520
+ number provided, it will be total request
1521
+ timeout. It can also be a pair (tuple) of
1522
+ (connection, read) timeouts.
1523
+ :type _request_timeout: int, tuple(int, int), optional
1524
+ :param _request_auth: set to override the auth_settings for an a single
1525
+ request; this effectively ignores the
1526
+ authentication in the spec for a single request.
1527
+ :type _request_auth: dict, optional
1528
+ :param _content_type: force content-type for the request.
1529
+ :type _content_type: str, Optional
1530
+ :param _headers: set to override the headers for a single
1531
+ request; this effectively ignores the headers
1532
+ in the spec for a single request.
1533
+ :type _headers: dict, optional
1534
+ :param _host_index: set to override the host_index for a single
1535
+ request; this effectively ignores the host_index
1536
+ in the spec for a single request.
1537
+ :type _host_index: int, optional
1538
+ :return: Returns the result object.
1539
+ """ # noqa: E501
1540
+ warnings.warn("POST /identity/registertemporary is deprecated.", DeprecationWarning)
1541
+
1542
+ _param = self._identity_registertemporary_post_serialize(
1543
+ register_temporary_customer_model=register_temporary_customer_model,
1544
+ _request_auth=_request_auth,
1545
+ _content_type=_content_type,
1546
+ _headers=_headers,
1547
+ _host_index=_host_index
1548
+ )
1549
+
1550
+ _response_types_map: Dict[str, Optional[str]] = {
1551
+ '200': "RegisterTemporaryCustomerResult",
1552
+ }
1553
+ response_data = self.api_client.call_api(
1554
+ *_param,
1555
+ _request_timeout=_request_timeout
1556
+ )
1557
+ return response_data.response
1558
+
1559
+
1560
+ def _identity_registertemporary_post_serialize(
1561
+ self,
1562
+ register_temporary_customer_model,
1563
+ _request_auth,
1564
+ _content_type,
1565
+ _headers,
1566
+ _host_index,
1567
+ ) -> RequestSerialized:
1568
+
1569
+ _host = None
1570
+
1571
+ _collection_formats: Dict[str, str] = {
1572
+ }
1573
+
1574
+ _path_params: Dict[str, str] = {}
1575
+ _query_params: List[Tuple[str, str]] = []
1576
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1577
+ _form_params: List[Tuple[str, str]] = []
1578
+ _files: Dict[
1579
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1580
+ ] = {}
1581
+ _body_params: Optional[bytes] = None
1582
+
1583
+ # process the path parameters
1584
+ # process the query parameters
1585
+ # process the header parameters
1586
+ # process the form parameters
1587
+ # process the body parameter
1588
+ if register_temporary_customer_model is not None:
1589
+ _body_params = register_temporary_customer_model
1590
+
1591
+
1592
+ # set the HTTP header `Accept`
1593
+ if 'Accept' not in _header_params:
1594
+ _header_params['Accept'] = self.api_client.select_header_accept(
1595
+ [
1596
+ 'text/plain',
1597
+ 'application/json',
1598
+ 'text/json'
1599
+ ]
1600
+ )
1601
+
1602
+ # set the HTTP header `Content-Type`
1603
+ if _content_type:
1604
+ _header_params['Content-Type'] = _content_type
1605
+ else:
1606
+ _default_content_type = (
1607
+ self.api_client.select_header_content_type(
1608
+ [
1609
+ 'application/json',
1610
+ 'text/json',
1611
+ 'application/*+json'
1612
+ ]
1613
+ )
1614
+ )
1615
+ if _default_content_type is not None:
1616
+ _header_params['Content-Type'] = _default_content_type
1617
+
1618
+ # authentication setting
1619
+ _auth_settings: List[str] = [
1620
+ 'bearer',
1621
+ 'oauth2'
1622
+ ]
1623
+
1624
+ return self.api_client.param_serialize(
1625
+ method='POST',
1626
+ resource_path='/identity/registertemporary',
562
1627
  path_params=_path_params,
563
1628
  query_params=_query_params,
564
1629
  header_params=_header_params,
@@ -575,7 +1640,7 @@ class IdentityApi:
575
1640
 
576
1641
 
577
1642
  @validate_call
578
- def identity_register_temporary_post(
1643
+ def identity_temporary_post(
579
1644
  self,
580
1645
  register_temporary_customer_model: Annotated[Optional[RegisterTemporaryCustomerModel], Field(description="The model to register the temporary customer with.")] = None,
581
1646
  _request_timeout: Union[
@@ -618,7 +1683,7 @@ class IdentityApi:
618
1683
  :return: Returns the result object.
619
1684
  """ # noqa: E501
620
1685
 
621
- _param = self._identity_register_temporary_post_serialize(
1686
+ _param = self._identity_temporary_post_serialize(
622
1687
  register_temporary_customer_model=register_temporary_customer_model,
623
1688
  _request_auth=_request_auth,
624
1689
  _content_type=_content_type,
@@ -641,7 +1706,7 @@ class IdentityApi:
641
1706
 
642
1707
 
643
1708
  @validate_call
644
- def identity_register_temporary_post_with_http_info(
1709
+ def identity_temporary_post_with_http_info(
645
1710
  self,
646
1711
  register_temporary_customer_model: Annotated[Optional[RegisterTemporaryCustomerModel], Field(description="The model to register the temporary customer with.")] = None,
647
1712
  _request_timeout: Union[
@@ -684,7 +1749,7 @@ class IdentityApi:
684
1749
  :return: Returns the result object.
685
1750
  """ # noqa: E501
686
1751
 
687
- _param = self._identity_register_temporary_post_serialize(
1752
+ _param = self._identity_temporary_post_serialize(
688
1753
  register_temporary_customer_model=register_temporary_customer_model,
689
1754
  _request_auth=_request_auth,
690
1755
  _content_type=_content_type,
@@ -707,7 +1772,7 @@ class IdentityApi:
707
1772
 
708
1773
 
709
1774
  @validate_call
710
- def identity_register_temporary_post_without_preload_content(
1775
+ def identity_temporary_post_without_preload_content(
711
1776
  self,
712
1777
  register_temporary_customer_model: Annotated[Optional[RegisterTemporaryCustomerModel], Field(description="The model to register the temporary customer with.")] = None,
713
1778
  _request_timeout: Union[
@@ -750,7 +1815,7 @@ class IdentityApi:
750
1815
  :return: Returns the result object.
751
1816
  """ # noqa: E501
752
1817
 
753
- _param = self._identity_register_temporary_post_serialize(
1818
+ _param = self._identity_temporary_post_serialize(
754
1819
  register_temporary_customer_model=register_temporary_customer_model,
755
1820
  _request_auth=_request_auth,
756
1821
  _content_type=_content_type,
@@ -768,7 +1833,7 @@ class IdentityApi:
768
1833
  return response_data.response
769
1834
 
770
1835
 
771
- def _identity_register_temporary_post_serialize(
1836
+ def _identity_temporary_post_serialize(
772
1837
  self,
773
1838
  register_temporary_customer_model,
774
1839
  _request_auth,
@@ -834,7 +1899,7 @@ class IdentityApi:
834
1899
 
835
1900
  return self.api_client.param_serialize(
836
1901
  method='POST',
837
- resource_path='/Identity/RegisterTemporary',
1902
+ resource_path='/identity/temporary',
838
1903
  path_params=_path_params,
839
1904
  query_params=_query_params,
840
1905
  header_params=_header_params,