criteo-api-retailmedia-sdk 0.0.240731__py3-none-any.whl → 0.0.241029__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.
- criteo_api_retailmedia_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/accounts_api.py +442 -0
- criteo_api_retailmedia_preview/api/analytics_api.py +3 -3
- criteo_api_retailmedia_preview/api/audience_api.py +89 -232
- criteo_api_retailmedia_preview/api/balance_api.py +4 -16
- criteo_api_retailmedia_preview/api/campaign_api.py +10 -574
- criteo_api_retailmedia_preview/api/on_site_recommendation_api.py +186 -0
- criteo_api_retailmedia_preview/api_client.py +4 -4
- criteo_api_retailmedia_preview/apis/__init__.py +1 -0
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/balance_response_v2.py +10 -10
- criteo_api_retailmedia_preview/model/bot_message.py +277 -0
- criteo_api_retailmedia_preview/model/botmessage.py +329 -0
- criteo_api_retailmedia_preview/model/create_balance_v2.py +6 -6
- criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_list_response.py → entity_resource_collection_outcome_of_retail_media_account.py} +8 -8
- criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_resource.py → entity_resource_of_retail_media_account.py} +9 -18
- criteo_api_retailmedia_preview/model/external_account.py +4 -0
- criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2.py → external_retail_media_account.py} +54 -32
- criteo_api_retailmedia_preview/model/http_validation_error.py +269 -0
- criteo_api_retailmedia_preview/model/inbot_discussion.py +272 -0
- criteo_api_retailmedia_preview/model/{rm_legacy_segment_customer_list.py → inbot_discussion_body_model.py} +17 -17
- criteo_api_retailmedia_preview/model/{rm_legacy_audience_user_behavior_details_v2.py → inbot_discussion_data_instance_model.py} +17 -17
- criteo_api_retailmedia_preview/model/location_inner.py +259 -0
- criteo_api_retailmedia_preview/model/message.py +273 -0
- criteo_api_retailmedia_preview/model/message_body_model.py +275 -0
- criteo_api_retailmedia_preview/model/message_data_instance_model.py +279 -0
- criteo_api_retailmedia_preview/model/message_error.py +275 -0
- criteo_api_retailmedia_preview/model/product.py +4 -0
- criteo_api_retailmedia_preview/model/{rm_legacy_segment_user_behavior_v1.py → product_recommendation.py} +46 -47
- criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py +6 -4
- criteo_api_retailmedia_preview/model/report_detail_warning.py +285 -0
- criteo_api_retailmedia_preview/model/report_detail_warnings.py +281 -0
- criteo_api_retailmedia_preview/model/report_ok_response.py +16 -2
- criteo_api_retailmedia_preview/model/resource_of_retail_media_account.py +270 -0
- criteo_api_retailmedia_preview/model/{value_resource_outcome_of_line_item_budget_overrides.py → resource_outcome_of_retail_media_account.py} +8 -8
- criteo_api_retailmedia_preview/model/retail_media_account.py +301 -0
- criteo_api_retailmedia_preview/model/retail_media_seller.py +261 -0
- criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +274 -0
- criteo_api_retailmedia_preview/model/rm_algebra_node_v1.py +275 -0
- criteo_api_retailmedia_preview/model/rm_audience_entity_v1.py +307 -0
- criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_resource.py → rm_audience_entity_v1_resource.py} +8 -8
- criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_list_response.py → rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response.py} +14 -8
- criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1.py +271 -0
- criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1_resource.py +273 -0
- criteo_api_retailmedia_preview/model/rm_audience_search_input_v1.py +269 -0
- criteo_api_retailmedia_preview/model/rm_audience_search_metadata_v1.py +271 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +17 -9
- criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1.py +11 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +10 -0
- criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +16 -5
- criteo_api_retailmedia_preview/model/{rm_legacy_segment_user_behavior_v2.py → rm_events_v1.py} +41 -49
- criteo_api_retailmedia_preview/model/validation_error.py +287 -0
- criteo_api_retailmedia_preview/model/{value_resource_input_of_campaign_budget_overrides.py → value_resource_collection_input_of_retail_media_seller.py} +8 -8
- criteo_api_retailmedia_preview/model/{value_resource_outcome_of_campaign_budget_overrides.py → value_resource_collection_outcome_of_retail_media_seller.py} +8 -8
- criteo_api_retailmedia_preview/model/{value_resource_input_of_line_item_budget_overrides.py → value_resource_input_of_retail_media_seller_account_creation.py} +8 -8
- criteo_api_retailmedia_preview/model/{value_resource_of_campaign_budget_overrides.py → value_resource_of_retail_media_seller.py} +8 -8
- criteo_api_retailmedia_preview/model/{value_resource_of_line_item_budget_overrides.py → value_resource_of_retail_media_seller_account_creation.py} +8 -8
- criteo_api_retailmedia_preview/models/__init__.py +37 -22
- {criteo_api_retailmedia_sdk-0.0.240731.dist-info → criteo_api_retailmedia_sdk-0.0.241029.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.240731.dist-info → criteo_api_retailmedia_sdk-0.0.241029.dist-info}/RECORD +62 -46
- {criteo_api_retailmedia_sdk-0.0.240731.dist-info → criteo_api_retailmedia_sdk-0.0.241029.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_preview/model/campaign_budget_overrides.py +0 -276
- criteo_api_retailmedia_preview/model/campaign_daily_budget_override.py +0 -283
- criteo_api_retailmedia_preview/model/campaign_monthly_budget_override.py +0 -283
- criteo_api_retailmedia_preview/model/daily_line_item_budget_override.py +0 -281
- criteo_api_retailmedia_preview/model/line_item_budget_overrides.py +0 -276
- criteo_api_retailmedia_preview/model/monthly_line_item_budeget_override.py +0 -283
- criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v1.py +0 -291
- {criteo_api_retailmedia_sdk-0.0.240731.dist-info → criteo_api_retailmedia_sdk-0.0.241029.dist-info}/top_level.txt +0 -0
|
@@ -24,6 +24,8 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
|
|
|
24
24
|
from criteo_api_retailmedia_preview.model.error_code_response import ErrorCodeResponse
|
|
25
25
|
from criteo_api_retailmedia_preview.model.retail_media_contactlist_amendment_request import RetailMediaContactlistAmendmentRequest
|
|
26
26
|
from criteo_api_retailmedia_preview.model.retail_media_contactlist_operation import RetailMediaContactlistOperation
|
|
27
|
+
from criteo_api_retailmedia_preview.model.rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response import RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse
|
|
28
|
+
from criteo_api_retailmedia_preview.model.rm_audience_search_input_v1 import RmAudienceSearchInputV1
|
|
27
29
|
from criteo_api_retailmedia_preview.model.rm_audience_segment_bulk_create_input_v1 import RmAudienceSegmentBulkCreateInputV1
|
|
28
30
|
from criteo_api_retailmedia_preview.model.rm_audience_segment_bulk_delete_input_v1 import RmAudienceSegmentBulkDeleteInputV1
|
|
29
31
|
from criteo_api_retailmedia_preview.model.rm_audience_segment_bulk_update_input_v1 import RmAudienceSegmentBulkUpdateInputV1
|
|
@@ -32,8 +34,6 @@ from criteo_api_retailmedia_preview.model.rm_audience_segment_entity_v1_rm_audie
|
|
|
32
34
|
from criteo_api_retailmedia_preview.model.rm_audience_segment_id_entity_v1_list_response import RmAudienceSegmentIdEntityV1ListResponse
|
|
33
35
|
from criteo_api_retailmedia_preview.model.rm_audience_segment_search_input_v1 import RmAudienceSegmentSearchInputV1
|
|
34
36
|
from criteo_api_retailmedia_preview.model.rm_contact_list_statistics_entity_v1_response import RmContactListStatisticsEntityV1Response
|
|
35
|
-
from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse
|
|
36
|
-
from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
class AudienceApi(object):
|
|
@@ -47,7 +47,7 @@ class AudienceApi(object):
|
|
|
47
47
|
if api_client is None:
|
|
48
48
|
api_client = ApiClient()
|
|
49
49
|
self.api_client = api_client
|
|
50
|
-
self.
|
|
50
|
+
self.bulk_create_audience_segments_endpoint = _Endpoint(
|
|
51
51
|
settings={
|
|
52
52
|
'response_type': (RmAudienceSegmentEntityV1ListResponse,),
|
|
53
53
|
'auth': [
|
|
@@ -55,7 +55,7 @@ class AudienceApi(object):
|
|
|
55
55
|
'oauth'
|
|
56
56
|
],
|
|
57
57
|
'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/create',
|
|
58
|
-
'operation_id': '
|
|
58
|
+
'operation_id': 'bulk_create_audience_segments',
|
|
59
59
|
'http_method': 'POST',
|
|
60
60
|
'servers': None,
|
|
61
61
|
},
|
|
@@ -111,7 +111,7 @@ class AudienceApi(object):
|
|
|
111
111
|
},
|
|
112
112
|
api_client=api_client
|
|
113
113
|
)
|
|
114
|
-
self.
|
|
114
|
+
self.bulk_delete_audience_segments_endpoint = _Endpoint(
|
|
115
115
|
settings={
|
|
116
116
|
'response_type': (RmAudienceSegmentIdEntityV1ListResponse,),
|
|
117
117
|
'auth': [
|
|
@@ -119,7 +119,7 @@ class AudienceApi(object):
|
|
|
119
119
|
'oauth'
|
|
120
120
|
],
|
|
121
121
|
'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/delete',
|
|
122
|
-
'operation_id': '
|
|
122
|
+
'operation_id': 'bulk_delete_audience_segments',
|
|
123
123
|
'http_method': 'POST',
|
|
124
124
|
'servers': None,
|
|
125
125
|
},
|
|
@@ -175,7 +175,7 @@ class AudienceApi(object):
|
|
|
175
175
|
},
|
|
176
176
|
api_client=api_client
|
|
177
177
|
)
|
|
178
|
-
self.
|
|
178
|
+
self.bulk_update_audience_segments_endpoint = _Endpoint(
|
|
179
179
|
settings={
|
|
180
180
|
'response_type': (RmAudienceSegmentEntityV1ListResponse,),
|
|
181
181
|
'auth': [
|
|
@@ -183,7 +183,7 @@ class AudienceApi(object):
|
|
|
183
183
|
'oauth'
|
|
184
184
|
],
|
|
185
185
|
'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments',
|
|
186
|
-
'operation_id': '
|
|
186
|
+
'operation_id': 'bulk_update_audience_segments',
|
|
187
187
|
'http_method': 'PATCH',
|
|
188
188
|
'servers': None,
|
|
189
189
|
},
|
|
@@ -291,7 +291,7 @@ class AudienceApi(object):
|
|
|
291
291
|
},
|
|
292
292
|
api_client=api_client
|
|
293
293
|
)
|
|
294
|
-
self.
|
|
294
|
+
self.get_audience_segment_contact_list_statistics_endpoint = _Endpoint(
|
|
295
295
|
settings={
|
|
296
296
|
'response_type': (RmContactListStatisticsEntityV1Response,),
|
|
297
297
|
'auth': [
|
|
@@ -299,7 +299,7 @@ class AudienceApi(object):
|
|
|
299
299
|
'oauth'
|
|
300
300
|
],
|
|
301
301
|
'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list',
|
|
302
|
-
'operation_id': '
|
|
302
|
+
'operation_id': 'get_audience_segment_contact_list_statistics',
|
|
303
303
|
'http_method': 'GET',
|
|
304
304
|
'servers': None,
|
|
305
305
|
},
|
|
@@ -351,64 +351,69 @@ class AudienceApi(object):
|
|
|
351
351
|
},
|
|
352
352
|
api_client=api_client
|
|
353
353
|
)
|
|
354
|
-
self.
|
|
354
|
+
self.search_audience_segments_endpoint = _Endpoint(
|
|
355
355
|
settings={
|
|
356
|
-
'response_type': (
|
|
356
|
+
'response_type': (RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse,),
|
|
357
357
|
'auth': [
|
|
358
358
|
'oauth',
|
|
359
359
|
'oauth'
|
|
360
360
|
],
|
|
361
|
-
'endpoint_path': '/preview/retail-media/accounts/{
|
|
362
|
-
'operation_id': '
|
|
363
|
-
'http_method': '
|
|
361
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/search',
|
|
362
|
+
'operation_id': 'search_audience_segments',
|
|
363
|
+
'http_method': 'POST',
|
|
364
364
|
'servers': None,
|
|
365
365
|
},
|
|
366
366
|
params_map={
|
|
367
367
|
'all': [
|
|
368
368
|
'account_id',
|
|
369
|
-
'
|
|
370
|
-
'
|
|
371
|
-
'
|
|
369
|
+
'rm_audience_segment_search_input_v1',
|
|
370
|
+
'limit',
|
|
371
|
+
'offset',
|
|
372
372
|
],
|
|
373
373
|
'required': [
|
|
374
374
|
'account_id',
|
|
375
|
+
'rm_audience_segment_search_input_v1',
|
|
375
376
|
],
|
|
376
377
|
'nullable': [
|
|
377
378
|
],
|
|
378
379
|
'enum': [
|
|
379
380
|
],
|
|
380
381
|
'validation': [
|
|
382
|
+
'limit',
|
|
381
383
|
]
|
|
382
384
|
},
|
|
383
385
|
root_map={
|
|
384
386
|
'validations': {
|
|
387
|
+
('limit',): {
|
|
388
|
+
|
|
389
|
+
'inclusive_maximum': 100,
|
|
390
|
+
'inclusive_minimum': 0,
|
|
391
|
+
},
|
|
385
392
|
},
|
|
386
393
|
'allowed_values': {
|
|
387
394
|
},
|
|
388
395
|
'openapi_types': {
|
|
389
396
|
'account_id':
|
|
397
|
+
(str,),
|
|
398
|
+
'rm_audience_segment_search_input_v1':
|
|
399
|
+
(RmAudienceSegmentSearchInputV1,),
|
|
400
|
+
'limit':
|
|
390
401
|
(int,),
|
|
391
|
-
'
|
|
392
|
-
([int],),
|
|
393
|
-
'page_size':
|
|
394
|
-
(int,),
|
|
395
|
-
'page_index':
|
|
402
|
+
'offset':
|
|
396
403
|
(int,),
|
|
397
404
|
},
|
|
398
405
|
'attribute_map': {
|
|
399
|
-
'account_id': '
|
|
400
|
-
'
|
|
401
|
-
'
|
|
402
|
-
'page_index': 'pageIndex',
|
|
406
|
+
'account_id': 'account-id',
|
|
407
|
+
'limit': 'limit',
|
|
408
|
+
'offset': 'offset',
|
|
403
409
|
},
|
|
404
410
|
'location_map': {
|
|
405
411
|
'account_id': 'path',
|
|
406
|
-
'
|
|
407
|
-
'
|
|
408
|
-
'
|
|
412
|
+
'rm_audience_segment_search_input_v1': 'body',
|
|
413
|
+
'limit': 'query',
|
|
414
|
+
'offset': 'query',
|
|
409
415
|
},
|
|
410
416
|
'collection_format_map': {
|
|
411
|
-
'limit_to_id': 'multi',
|
|
412
417
|
}
|
|
413
418
|
},
|
|
414
419
|
headers_map={
|
|
@@ -417,102 +422,37 @@ class AudienceApi(object):
|
|
|
417
422
|
'application/json',
|
|
418
423
|
'text/json'
|
|
419
424
|
],
|
|
420
|
-
'content_type': [
|
|
421
|
-
|
|
422
|
-
api_client=api_client
|
|
423
|
-
)
|
|
424
|
-
self.legacy_get_audience_v2_endpoint = _Endpoint(
|
|
425
|
-
settings={
|
|
426
|
-
'response_type': (RmLegacyAudienceGetEntityV2ListResponse,),
|
|
427
|
-
'auth': [
|
|
428
|
-
'oauth',
|
|
429
|
-
'oauth'
|
|
430
|
-
],
|
|
431
|
-
'endpoint_path': '/preview/retail-media/v2/accounts/{accountId}/audiences',
|
|
432
|
-
'operation_id': 'legacy_get_audience_v2',
|
|
433
|
-
'http_method': 'GET',
|
|
434
|
-
'servers': None,
|
|
435
|
-
},
|
|
436
|
-
params_map={
|
|
437
|
-
'all': [
|
|
438
|
-
'account_id',
|
|
439
|
-
'limit_to_id',
|
|
440
|
-
'page_size',
|
|
441
|
-
'page_index',
|
|
442
|
-
],
|
|
443
|
-
'required': [
|
|
444
|
-
'account_id',
|
|
445
|
-
],
|
|
446
|
-
'nullable': [
|
|
447
|
-
],
|
|
448
|
-
'enum': [
|
|
449
|
-
],
|
|
450
|
-
'validation': [
|
|
451
|
-
]
|
|
452
|
-
},
|
|
453
|
-
root_map={
|
|
454
|
-
'validations': {
|
|
455
|
-
},
|
|
456
|
-
'allowed_values': {
|
|
457
|
-
},
|
|
458
|
-
'openapi_types': {
|
|
459
|
-
'account_id':
|
|
460
|
-
(int,),
|
|
461
|
-
'limit_to_id':
|
|
462
|
-
([int],),
|
|
463
|
-
'page_size':
|
|
464
|
-
(int,),
|
|
465
|
-
'page_index':
|
|
466
|
-
(int,),
|
|
467
|
-
},
|
|
468
|
-
'attribute_map': {
|
|
469
|
-
'account_id': 'accountId',
|
|
470
|
-
'limit_to_id': 'limitToId',
|
|
471
|
-
'page_size': 'pageSize',
|
|
472
|
-
'page_index': 'pageIndex',
|
|
473
|
-
},
|
|
474
|
-
'location_map': {
|
|
475
|
-
'account_id': 'path',
|
|
476
|
-
'limit_to_id': 'query',
|
|
477
|
-
'page_size': 'query',
|
|
478
|
-
'page_index': 'query',
|
|
479
|
-
},
|
|
480
|
-
'collection_format_map': {
|
|
481
|
-
'limit_to_id': 'multi',
|
|
482
|
-
}
|
|
483
|
-
},
|
|
484
|
-
headers_map={
|
|
485
|
-
'accept': [
|
|
486
|
-
'text/plain',
|
|
425
|
+
'content_type': [
|
|
426
|
+
'application/json-patch+json',
|
|
487
427
|
'application/json',
|
|
488
|
-
'text/json'
|
|
489
|
-
|
|
490
|
-
|
|
428
|
+
'text/json',
|
|
429
|
+
'application/*+json'
|
|
430
|
+
]
|
|
491
431
|
},
|
|
492
432
|
api_client=api_client
|
|
493
433
|
)
|
|
494
|
-
self.
|
|
434
|
+
self.search_audiences_endpoint = _Endpoint(
|
|
495
435
|
settings={
|
|
496
|
-
'response_type': (
|
|
436
|
+
'response_type': (RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse,),
|
|
497
437
|
'auth': [
|
|
498
438
|
'oauth',
|
|
499
439
|
'oauth'
|
|
500
440
|
],
|
|
501
|
-
'endpoint_path': '/preview/retail-media/accounts/{account-id}/
|
|
502
|
-
'operation_id': '
|
|
441
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/audiences/search',
|
|
442
|
+
'operation_id': 'search_audiences',
|
|
503
443
|
'http_method': 'POST',
|
|
504
444
|
'servers': None,
|
|
505
445
|
},
|
|
506
446
|
params_map={
|
|
507
447
|
'all': [
|
|
508
448
|
'account_id',
|
|
509
|
-
'
|
|
449
|
+
'rm_audience_search_input_v1',
|
|
510
450
|
'limit',
|
|
511
451
|
'offset',
|
|
512
452
|
],
|
|
513
453
|
'required': [
|
|
514
454
|
'account_id',
|
|
515
|
-
'
|
|
455
|
+
'rm_audience_search_input_v1',
|
|
516
456
|
],
|
|
517
457
|
'nullable': [
|
|
518
458
|
],
|
|
@@ -535,8 +475,8 @@ class AudienceApi(object):
|
|
|
535
475
|
'openapi_types': {
|
|
536
476
|
'account_id':
|
|
537
477
|
(str,),
|
|
538
|
-
'
|
|
539
|
-
(
|
|
478
|
+
'rm_audience_search_input_v1':
|
|
479
|
+
(RmAudienceSearchInputV1,),
|
|
540
480
|
'limit':
|
|
541
481
|
(int,),
|
|
542
482
|
'offset':
|
|
@@ -549,7 +489,7 @@ class AudienceApi(object):
|
|
|
549
489
|
},
|
|
550
490
|
'location_map': {
|
|
551
491
|
'account_id': 'path',
|
|
552
|
-
'
|
|
492
|
+
'rm_audience_search_input_v1': 'body',
|
|
553
493
|
'limit': 'query',
|
|
554
494
|
'offset': 'query',
|
|
555
495
|
},
|
|
@@ -631,19 +571,19 @@ class AudienceApi(object):
|
|
|
631
571
|
api_client=api_client
|
|
632
572
|
)
|
|
633
573
|
|
|
634
|
-
def
|
|
574
|
+
def bulk_create_audience_segments(
|
|
635
575
|
self,
|
|
636
576
|
account_id,
|
|
637
577
|
rm_audience_segment_bulk_create_input_v1,
|
|
638
578
|
**kwargs
|
|
639
579
|
):
|
|
640
|
-
"""
|
|
580
|
+
"""bulk_create_audience_segments # noqa: E501
|
|
641
581
|
|
|
642
582
|
Creates all segments with a valid configuration, and returns the full segments. For those that cannot be created, one or multiple errors are returned. # noqa: E501
|
|
643
583
|
This method makes a synchronous HTTP request by default. To make an
|
|
644
584
|
asynchronous HTTP request, please pass async_req=True
|
|
645
585
|
|
|
646
|
-
>>> thread = api.
|
|
586
|
+
>>> thread = api.bulk_create_audience_segments(account_id, rm_audience_segment_bulk_create_input_v1, async_req=True)
|
|
647
587
|
>>> result = thread.get()
|
|
648
588
|
|
|
649
589
|
Args:
|
|
@@ -716,21 +656,21 @@ class AudienceApi(object):
|
|
|
716
656
|
account_id
|
|
717
657
|
kwargs['rm_audience_segment_bulk_create_input_v1'] = \
|
|
718
658
|
rm_audience_segment_bulk_create_input_v1
|
|
719
|
-
return self.
|
|
659
|
+
return self.bulk_create_audience_segments_endpoint.call_with_http_info(**kwargs)
|
|
720
660
|
|
|
721
|
-
def
|
|
661
|
+
def bulk_delete_audience_segments(
|
|
722
662
|
self,
|
|
723
663
|
account_id,
|
|
724
664
|
rm_audience_segment_bulk_delete_input_v1,
|
|
725
665
|
**kwargs
|
|
726
666
|
):
|
|
727
|
-
"""
|
|
667
|
+
"""bulk_delete_audience_segments # noqa: E501
|
|
728
668
|
|
|
729
669
|
Delete the segments associated to the given audience IDs. # noqa: E501
|
|
730
670
|
This method makes a synchronous HTTP request by default. To make an
|
|
731
671
|
asynchronous HTTP request, please pass async_req=True
|
|
732
672
|
|
|
733
|
-
>>> thread = api.
|
|
673
|
+
>>> thread = api.bulk_delete_audience_segments(account_id, rm_audience_segment_bulk_delete_input_v1, async_req=True)
|
|
734
674
|
>>> result = thread.get()
|
|
735
675
|
|
|
736
676
|
Args:
|
|
@@ -803,21 +743,21 @@ class AudienceApi(object):
|
|
|
803
743
|
account_id
|
|
804
744
|
kwargs['rm_audience_segment_bulk_delete_input_v1'] = \
|
|
805
745
|
rm_audience_segment_bulk_delete_input_v1
|
|
806
|
-
return self.
|
|
746
|
+
return self.bulk_delete_audience_segments_endpoint.call_with_http_info(**kwargs)
|
|
807
747
|
|
|
808
|
-
def
|
|
748
|
+
def bulk_update_audience_segments(
|
|
809
749
|
self,
|
|
810
750
|
account_id,
|
|
811
751
|
rm_audience_segment_bulk_update_input_v1,
|
|
812
752
|
**kwargs
|
|
813
753
|
):
|
|
814
|
-
"""
|
|
754
|
+
"""bulk_update_audience_segments # noqa: E501
|
|
815
755
|
|
|
816
756
|
Updates the properties of all segments with a valid configuration, and returns the full segments. For those that cannot be updated, one or multiple errors are returned. # noqa: E501
|
|
817
757
|
This method makes a synchronous HTTP request by default. To make an
|
|
818
758
|
asynchronous HTTP request, please pass async_req=True
|
|
819
759
|
|
|
820
|
-
>>> thread = api.
|
|
760
|
+
>>> thread = api.bulk_update_audience_segments(account_id, rm_audience_segment_bulk_update_input_v1, async_req=True)
|
|
821
761
|
>>> result = thread.get()
|
|
822
762
|
|
|
823
763
|
Args:
|
|
@@ -890,7 +830,7 @@ class AudienceApi(object):
|
|
|
890
830
|
account_id
|
|
891
831
|
kwargs['rm_audience_segment_bulk_update_input_v1'] = \
|
|
892
832
|
rm_audience_segment_bulk_update_input_v1
|
|
893
|
-
return self.
|
|
833
|
+
return self.bulk_update_audience_segments_endpoint.call_with_http_info(**kwargs)
|
|
894
834
|
|
|
895
835
|
def delete_contact_list_identifiers(
|
|
896
836
|
self,
|
|
@@ -975,19 +915,19 @@ class AudienceApi(object):
|
|
|
975
915
|
audience_segment_id
|
|
976
916
|
return self.delete_contact_list_identifiers_endpoint.call_with_http_info(**kwargs)
|
|
977
917
|
|
|
978
|
-
def
|
|
918
|
+
def get_audience_segment_contact_list_statistics(
|
|
979
919
|
self,
|
|
980
920
|
account_id,
|
|
981
921
|
audience_segment_id,
|
|
982
922
|
**kwargs
|
|
983
923
|
):
|
|
984
|
-
"""
|
|
924
|
+
"""get_audience_segment_contact_list_statistics # noqa: E501
|
|
985
925
|
|
|
986
926
|
Returns the statistics of a contact list segment. # noqa: E501
|
|
987
927
|
This method makes a synchronous HTTP request by default. To make an
|
|
988
928
|
asynchronous HTTP request, please pass async_req=True
|
|
989
929
|
|
|
990
|
-
>>> thread = api.
|
|
930
|
+
>>> thread = api.get_audience_segment_contact_list_statistics(account_id, audience_segment_id, async_req=True)
|
|
991
931
|
>>> result = thread.get()
|
|
992
932
|
|
|
993
933
|
Args:
|
|
@@ -1060,115 +1000,30 @@ class AudienceApi(object):
|
|
|
1060
1000
|
account_id
|
|
1061
1001
|
kwargs['audience_segment_id'] = \
|
|
1062
1002
|
audience_segment_id
|
|
1063
|
-
return self.
|
|
1064
|
-
|
|
1065
|
-
def legacy_get_audience_v1(
|
|
1066
|
-
self,
|
|
1067
|
-
account_id,
|
|
1068
|
-
**kwargs
|
|
1069
|
-
):
|
|
1070
|
-
"""legacy_get_audience_v1 # noqa: E501
|
|
1071
|
-
|
|
1072
|
-
Get a page of Audiences. (deprecated Public API) # noqa: E501
|
|
1073
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
1074
|
-
asynchronous HTTP request, please pass async_req=True
|
|
1075
|
-
|
|
1076
|
-
>>> thread = api.legacy_get_audience_v1(account_id, async_req=True)
|
|
1077
|
-
>>> result = thread.get()
|
|
1078
|
-
|
|
1079
|
-
Args:
|
|
1080
|
-
account_id (int): ID of the account to which this audience belongs.
|
|
1081
|
-
|
|
1082
|
-
Keyword Args:
|
|
1083
|
-
limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
|
|
1084
|
-
page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional]
|
|
1085
|
-
page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [optional]
|
|
1086
|
-
_return_http_data_only (bool): response data without head status
|
|
1087
|
-
code and headers. Default is True.
|
|
1088
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
1089
|
-
will be returned without reading/decoding response data.
|
|
1090
|
-
Default is True.
|
|
1091
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
1092
|
-
one number provided, it will be total request timeout. It can also
|
|
1093
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
1094
|
-
Default is None.
|
|
1095
|
-
_check_input_type (bool): specifies if type checking
|
|
1096
|
-
should be done one the data sent to the server.
|
|
1097
|
-
Default is True.
|
|
1098
|
-
_check_return_type (bool): specifies if type checking
|
|
1099
|
-
should be done one the data received from the server.
|
|
1100
|
-
Default is True.
|
|
1101
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
1102
|
-
are serialized names, as specified in the OpenAPI document.
|
|
1103
|
-
False if the variable names in the input data
|
|
1104
|
-
are pythonic names, e.g. snake case (default)
|
|
1105
|
-
_content_type (str/None): force body content-type.
|
|
1106
|
-
Default is None and content-type will be predicted by allowed
|
|
1107
|
-
content-types and body.
|
|
1108
|
-
_host_index (int/None): specifies the index of the server
|
|
1109
|
-
that we want to use.
|
|
1110
|
-
Default is read from the configuration.
|
|
1111
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
1112
|
-
request; this effectively ignores the authentication
|
|
1113
|
-
in the spec for a single request.
|
|
1114
|
-
Default is None
|
|
1115
|
-
async_req (bool): execute request asynchronously
|
|
1116
|
-
|
|
1117
|
-
Returns:
|
|
1118
|
-
RmLegacyAudienceGetEntityV1ListResponse
|
|
1119
|
-
If the method is called asynchronously, returns the request
|
|
1120
|
-
thread.
|
|
1121
|
-
"""
|
|
1122
|
-
kwargs['async_req'] = kwargs.get(
|
|
1123
|
-
'async_req', False
|
|
1124
|
-
)
|
|
1125
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
1126
|
-
'_return_http_data_only', True
|
|
1127
|
-
)
|
|
1128
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
1129
|
-
'_preload_content', True
|
|
1130
|
-
)
|
|
1131
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
1132
|
-
'_request_timeout', None
|
|
1133
|
-
)
|
|
1134
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
1135
|
-
'_check_input_type', True
|
|
1136
|
-
)
|
|
1137
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
1138
|
-
'_check_return_type', True
|
|
1139
|
-
)
|
|
1140
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
1141
|
-
'_spec_property_naming', False
|
|
1142
|
-
)
|
|
1143
|
-
kwargs['_content_type'] = kwargs.get(
|
|
1144
|
-
'_content_type')
|
|
1145
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
1146
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
1147
|
-
kwargs['account_id'] = \
|
|
1148
|
-
account_id
|
|
1149
|
-
return self.legacy_get_audience_v1_endpoint.call_with_http_info(**kwargs)
|
|
1003
|
+
return self.get_audience_segment_contact_list_statistics_endpoint.call_with_http_info(**kwargs)
|
|
1150
1004
|
|
|
1151
|
-
def
|
|
1005
|
+
def search_audience_segments(
|
|
1152
1006
|
self,
|
|
1153
1007
|
account_id,
|
|
1008
|
+
rm_audience_segment_search_input_v1,
|
|
1154
1009
|
**kwargs
|
|
1155
1010
|
):
|
|
1156
|
-
"""
|
|
1011
|
+
"""search_audience_segments # noqa: E501
|
|
1157
1012
|
|
|
1158
|
-
|
|
1013
|
+
Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied. # noqa: E501
|
|
1159
1014
|
This method makes a synchronous HTTP request by default. To make an
|
|
1160
1015
|
asynchronous HTTP request, please pass async_req=True
|
|
1161
1016
|
|
|
1162
|
-
>>> thread = api.
|
|
1017
|
+
>>> thread = api.search_audience_segments(account_id, rm_audience_segment_search_input_v1, async_req=True)
|
|
1163
1018
|
>>> result = thread.get()
|
|
1164
1019
|
|
|
1165
1020
|
Args:
|
|
1166
|
-
account_id (
|
|
1021
|
+
account_id (str): Account Id
|
|
1022
|
+
rm_audience_segment_search_input_v1 (RmAudienceSegmentSearchInputV1): Segment search filters.
|
|
1167
1023
|
|
|
1168
1024
|
Keyword Args:
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [optional]
|
|
1025
|
+
limit (int): The number of elements to be returned. The default is 50 and the maximum is 100.. [optional] if omitted the server will use the default value of 50
|
|
1026
|
+
offset (int): The (zero-based) offset into the collection. The default is 0.. [optional] if omitted the server will use the default value of 0
|
|
1172
1027
|
_return_http_data_only (bool): response data without head status
|
|
1173
1028
|
code and headers. Default is True.
|
|
1174
1029
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -1201,7 +1056,7 @@ class AudienceApi(object):
|
|
|
1201
1056
|
async_req (bool): execute request asynchronously
|
|
1202
1057
|
|
|
1203
1058
|
Returns:
|
|
1204
|
-
|
|
1059
|
+
RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse
|
|
1205
1060
|
If the method is called asynchronously, returns the request
|
|
1206
1061
|
thread.
|
|
1207
1062
|
"""
|
|
@@ -1232,26 +1087,28 @@ class AudienceApi(object):
|
|
|
1232
1087
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
1233
1088
|
kwargs['account_id'] = \
|
|
1234
1089
|
account_id
|
|
1235
|
-
|
|
1090
|
+
kwargs['rm_audience_segment_search_input_v1'] = \
|
|
1091
|
+
rm_audience_segment_search_input_v1
|
|
1092
|
+
return self.search_audience_segments_endpoint.call_with_http_info(**kwargs)
|
|
1236
1093
|
|
|
1237
|
-
def
|
|
1094
|
+
def search_audiences(
|
|
1238
1095
|
self,
|
|
1239
1096
|
account_id,
|
|
1240
|
-
|
|
1097
|
+
rm_audience_search_input_v1,
|
|
1241
1098
|
**kwargs
|
|
1242
1099
|
):
|
|
1243
|
-
"""
|
|
1100
|
+
"""search_audiences # noqa: E501
|
|
1244
1101
|
|
|
1245
|
-
|
|
1102
|
+
Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied. # noqa: E501
|
|
1246
1103
|
This method makes a synchronous HTTP request by default. To make an
|
|
1247
1104
|
asynchronous HTTP request, please pass async_req=True
|
|
1248
1105
|
|
|
1249
|
-
>>> thread = api.
|
|
1106
|
+
>>> thread = api.search_audiences(account_id, rm_audience_search_input_v1, async_req=True)
|
|
1250
1107
|
>>> result = thread.get()
|
|
1251
1108
|
|
|
1252
1109
|
Args:
|
|
1253
1110
|
account_id (str): Account Id
|
|
1254
|
-
|
|
1111
|
+
rm_audience_search_input_v1 (RmAudienceSearchInputV1): Audience search filters.
|
|
1255
1112
|
|
|
1256
1113
|
Keyword Args:
|
|
1257
1114
|
limit (int): The number of elements to be returned. The default is 50 and the maximum is 100.. [optional] if omitted the server will use the default value of 50
|
|
@@ -1288,7 +1145,7 @@ class AudienceApi(object):
|
|
|
1288
1145
|
async_req (bool): execute request asynchronously
|
|
1289
1146
|
|
|
1290
1147
|
Returns:
|
|
1291
|
-
|
|
1148
|
+
RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse
|
|
1292
1149
|
If the method is called asynchronously, returns the request
|
|
1293
1150
|
thread.
|
|
1294
1151
|
"""
|
|
@@ -1319,9 +1176,9 @@ class AudienceApi(object):
|
|
|
1319
1176
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
1320
1177
|
kwargs['account_id'] = \
|
|
1321
1178
|
account_id
|
|
1322
|
-
kwargs['
|
|
1323
|
-
|
|
1324
|
-
return self.
|
|
1179
|
+
kwargs['rm_audience_search_input_v1'] = \
|
|
1180
|
+
rm_audience_search_input_v1
|
|
1181
|
+
return self.search_audiences_endpoint.call_with_http_info(**kwargs)
|
|
1325
1182
|
|
|
1326
1183
|
def update_contact_list_identifiers(
|
|
1327
1184
|
self,
|
|
@@ -62,9 +62,6 @@ class BalanceApi(object):
|
|
|
62
62
|
],
|
|
63
63
|
'required': [
|
|
64
64
|
'account_id',
|
|
65
|
-
'limit_to_id',
|
|
66
|
-
'page_index',
|
|
67
|
-
'page_size',
|
|
68
65
|
],
|
|
69
66
|
'nullable': [
|
|
70
67
|
],
|
|
@@ -519,9 +516,6 @@ class BalanceApi(object):
|
|
|
519
516
|
def get_api_v2_external_account_balances_by_account_id(
|
|
520
517
|
self,
|
|
521
518
|
account_id,
|
|
522
|
-
limit_to_id,
|
|
523
|
-
page_index=0,
|
|
524
|
-
page_size=25,
|
|
525
519
|
**kwargs
|
|
526
520
|
):
|
|
527
521
|
"""get_api_v2_external_account_balances_by_account_id # noqa: E501
|
|
@@ -530,16 +524,16 @@ class BalanceApi(object):
|
|
|
530
524
|
This method makes a synchronous HTTP request by default. To make an
|
|
531
525
|
asynchronous HTTP request, please pass async_req=True
|
|
532
526
|
|
|
533
|
-
>>> thread = api.get_api_v2_external_account_balances_by_account_id(account_id,
|
|
527
|
+
>>> thread = api.get_api_v2_external_account_balances_by_account_id(account_id, async_req=True)
|
|
534
528
|
>>> result = thread.get()
|
|
535
529
|
|
|
536
530
|
Args:
|
|
537
531
|
account_id (str): The account to get balances for
|
|
538
|
-
limit_to_id ([str]): The ids that you would like to limit your result set to
|
|
539
|
-
page_index (int): The 0 indexed page index you would like to receive given the page size. defaults to 0, must be one of [0]
|
|
540
|
-
page_size (int): The maximum number of items you would like to receive in this request. defaults to 25, must be one of [25]
|
|
541
532
|
|
|
542
533
|
Keyword Args:
|
|
534
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
535
|
+
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
|
|
536
|
+
page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
|
|
543
537
|
_return_http_data_only (bool): response data without head status
|
|
544
538
|
code and headers. Default is True.
|
|
545
539
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -603,12 +597,6 @@ class BalanceApi(object):
|
|
|
603
597
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
604
598
|
kwargs['account_id'] = \
|
|
605
599
|
account_id
|
|
606
|
-
kwargs['limit_to_id'] = \
|
|
607
|
-
limit_to_id
|
|
608
|
-
kwargs['page_index'] = \
|
|
609
|
-
page_index
|
|
610
|
-
kwargs['page_size'] = \
|
|
611
|
-
page_size
|
|
612
600
|
return self.get_api_v2_external_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
613
601
|
|
|
614
602
|
def get_api_v2_external_account_by_account_id_balancesbalance_id(
|