criteo-api-retailmedia-sdk 0.0.240626__py3-none-any.whl → 0.0.240731__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 criteo-api-retailmedia-sdk might be problematic. Click here for more details.

Files changed (79) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +42 -629
  3. criteo_api_retailmedia_preview/api/audience_api.py +835 -58
  4. criteo_api_retailmedia_preview/api/balance_api.py +1146 -0
  5. criteo_api_retailmedia_preview/api/campaign_api.py +165 -158
  6. criteo_api_retailmedia_preview/api_client.py +4 -4
  7. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  8. criteo_api_retailmedia_preview/configuration.py +1 -1
  9. criteo_api_retailmedia_preview/model/add_funds_to_balance_v2.py +277 -0
  10. criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_seller_account_creation.py → add_funds_to_balance_v2_request.py} +16 -9
  11. criteo_api_retailmedia_preview/model/application_summary_model_response.py +0 -4
  12. criteo_api_retailmedia_preview/model/async_accounts_report.py +2 -0
  13. criteo_api_retailmedia_preview/model/async_campaigns_report.py +2 -0
  14. criteo_api_retailmedia_preview/model/async_line_items_report.py +2 -0
  15. criteo_api_retailmedia_preview/model/{insertion_order_history_change_data_capture.py → balance_history_change_data_capture_v1.py} +11 -11
  16. criteo_api_retailmedia_preview/model/balance_response_v2.py +351 -0
  17. criteo_api_retailmedia_preview/model/balance_response_v2_response.py +281 -0
  18. criteo_api_retailmedia_preview/model/change_dates_of_balance_v2.py +271 -0
  19. criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_brand_account_creation.py → change_dates_of_balance_v2_request.py} +16 -9
  20. criteo_api_retailmedia_preview/model/{change_details.py → change_details_v1.py} +3 -3
  21. criteo_api_retailmedia_preview/model/change_details_v2.py +275 -0
  22. criteo_api_retailmedia_preview/model/common_problem.py +2 -2
  23. criteo_api_retailmedia_preview/model/create_balance_v2.py +302 -0
  24. criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_brands.py → create_balance_v2_request.py} +16 -9
  25. criteo_api_retailmedia_preview/model/external_catalog_status.py +312 -0
  26. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture_v2.py +303 -0
  27. criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py +285 -0
  28. criteo_api_retailmedia_preview/model/json_api_body_without_id_of_seller_catalog_request_and_seller_catalog_request.py +279 -0
  29. criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py +8 -6
  30. criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py +8 -6
  31. criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py +8 -6
  32. criteo_api_retailmedia_preview/model/json_api_request_of_seller_catalog_request.py +269 -0
  33. criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py +287 -0
  34. criteo_api_retailmedia_preview/model/{retail_media_seller.py → nillable_string.py} +14 -12
  35. criteo_api_retailmedia_preview/model/page_of_balance_history_change_data_capture_v1.py +276 -0
  36. criteo_api_retailmedia_preview/model/{page_of_insertion_order_history_change_data_capture.py → page_of_insertion_order_history_change_data_capture_v2.py} +8 -8
  37. criteo_api_retailmedia_preview/model/paged_resource_collection_outcome_of_balance_response_v2.py +287 -0
  38. criteo_api_retailmedia_preview/model/resource_of_add_funds_to_balance_v2.py +277 -0
  39. criteo_api_retailmedia_preview/model/resource_of_balance_response_v2.py +277 -0
  40. criteo_api_retailmedia_preview/model/resource_of_change_dates_of_balance_v2.py +277 -0
  41. criteo_api_retailmedia_preview/model/resource_of_create_balance_v2.py +277 -0
  42. criteo_api_retailmedia_preview/model/resource_of_update_balance_model_v2.py +277 -0
  43. criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_attributes.py +6 -6
  44. criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_create_input_v1.py +269 -0
  45. criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_delete_input_v1.py +269 -0
  46. criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_update_input_v1.py +269 -0
  47. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +281 -0
  48. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_brand_account_creation.py → rm_audience_segment_create_entity_v1_resource.py} +16 -9
  49. criteo_api_retailmedia_preview/model/{resource_of_retail_media_account.py → rm_audience_segment_delete_entity_v1_resource.py} +15 -14
  50. criteo_api_retailmedia_preview/model/{retail_media_account.py → rm_audience_segment_entity_v1.py} +52 -37
  51. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_retail_media_seller.py → rm_audience_segment_entity_v1_list_response.py} +16 -9
  52. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller_account_creation.py → rm_audience_segment_entity_v1_resource.py} +21 -10
  53. criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1_rm_audience_segment_search_metadata_v1_list_response.py +287 -0
  54. criteo_api_retailmedia_preview/model/rm_audience_segment_id_entity_v1_list_response.py +281 -0
  55. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller.py → rm_audience_segment_id_entity_v1_resource.py} +18 -13
  56. criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +267 -0
  57. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_brands.py → rm_audience_segment_search_entity_v1_resource.py} +16 -9
  58. criteo_api_retailmedia_preview/model/rm_audience_segment_search_input_v1.py +269 -0
  59. criteo_api_retailmedia_preview/model/{retail_media_brand_account_creation.py → rm_audience_segment_search_metadata_v1.py} +22 -16
  60. criteo_api_retailmedia_preview/model/{retail_media_seller_account_creation.py → rm_audience_segment_update_entity_v1.py} +23 -16
  61. criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1_resource.py +277 -0
  62. criteo_api_retailmedia_preview/model/{retail_media_brands.py → rm_contact_list_create_v1.py} +21 -8
  63. criteo_api_retailmedia_preview/model/rm_contact_list_statistics_entity_v1.py +271 -0
  64. criteo_api_retailmedia_preview/model/rm_contact_list_statistics_entity_v1_resource.py +277 -0
  65. criteo_api_retailmedia_preview/model/{resource_outcome_of_retail_media_account.py → rm_contact_list_statistics_entity_v1_response.py} +16 -9
  66. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +275 -0
  67. criteo_api_retailmedia_preview/model/seller_catalog_request.py +269 -0
  68. criteo_api_retailmedia_preview/model/seller_identifier.py +275 -0
  69. criteo_api_retailmedia_preview/model/sku_data_preview.py +8 -6
  70. criteo_api_retailmedia_preview/model/sku_slim_data_preview.py +8 -6
  71. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +2 -0
  72. criteo_api_retailmedia_preview/model/sync_line_items_report.py +2 -0
  73. criteo_api_retailmedia_preview/model/update_balance_model_v2.py +279 -0
  74. criteo_api_retailmedia_preview/model/{value_resource_collection_input_of_retail_media_seller.py → update_balance_model_v2_request.py} +16 -9
  75. criteo_api_retailmedia_preview/models/__init__.py +53 -19
  76. {criteo_api_retailmedia_sdk-0.0.240626.dist-info → criteo_api_retailmedia_sdk-0.0.240731.dist-info}/METADATA +3 -3
  77. {criteo_api_retailmedia_sdk-0.0.240626.dist-info → criteo_api_retailmedia_sdk-0.0.240731.dist-info}/RECORD +79 -44
  78. {criteo_api_retailmedia_sdk-0.0.240626.dist-info → criteo_api_retailmedia_sdk-0.0.240731.dist-info}/WHEEL +1 -1
  79. {criteo_api_retailmedia_sdk-0.0.240626.dist-info → criteo_api_retailmedia_sdk-0.0.240731.dist-info}/top_level.txt +0 -0
@@ -24,6 +24,14 @@ 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_segment_bulk_create_input_v1 import RmAudienceSegmentBulkCreateInputV1
28
+ from criteo_api_retailmedia_preview.model.rm_audience_segment_bulk_delete_input_v1 import RmAudienceSegmentBulkDeleteInputV1
29
+ from criteo_api_retailmedia_preview.model.rm_audience_segment_bulk_update_input_v1 import RmAudienceSegmentBulkUpdateInputV1
30
+ from criteo_api_retailmedia_preview.model.rm_audience_segment_entity_v1_list_response import RmAudienceSegmentEntityV1ListResponse
31
+ from criteo_api_retailmedia_preview.model.rm_audience_segment_entity_v1_rm_audience_segment_search_metadata_v1_list_response import RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse
32
+ from criteo_api_retailmedia_preview.model.rm_audience_segment_id_entity_v1_list_response import RmAudienceSegmentIdEntityV1ListResponse
33
+ from criteo_api_retailmedia_preview.model.rm_audience_segment_search_input_v1 import RmAudienceSegmentSearchInputV1
34
+ from criteo_api_retailmedia_preview.model.rm_contact_list_statistics_entity_v1_response import RmContactListStatisticsEntityV1Response
27
35
  from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse
28
36
  from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse
29
37
 
@@ -39,6 +47,198 @@ class AudienceApi(object):
39
47
  if api_client is None:
40
48
  api_client = ApiClient()
41
49
  self.api_client = api_client
50
+ self.bulk_create_v1_endpoint = _Endpoint(
51
+ settings={
52
+ 'response_type': (RmAudienceSegmentEntityV1ListResponse,),
53
+ 'auth': [
54
+ 'oauth',
55
+ 'oauth'
56
+ ],
57
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/create',
58
+ 'operation_id': 'bulk_create_v1',
59
+ 'http_method': 'POST',
60
+ 'servers': None,
61
+ },
62
+ params_map={
63
+ 'all': [
64
+ 'account_id',
65
+ 'rm_audience_segment_bulk_create_input_v1',
66
+ ],
67
+ 'required': [
68
+ 'account_id',
69
+ 'rm_audience_segment_bulk_create_input_v1',
70
+ ],
71
+ 'nullable': [
72
+ ],
73
+ 'enum': [
74
+ ],
75
+ 'validation': [
76
+ ]
77
+ },
78
+ root_map={
79
+ 'validations': {
80
+ },
81
+ 'allowed_values': {
82
+ },
83
+ 'openapi_types': {
84
+ 'account_id':
85
+ (str,),
86
+ 'rm_audience_segment_bulk_create_input_v1':
87
+ (RmAudienceSegmentBulkCreateInputV1,),
88
+ },
89
+ 'attribute_map': {
90
+ 'account_id': 'account-id',
91
+ },
92
+ 'location_map': {
93
+ 'account_id': 'path',
94
+ 'rm_audience_segment_bulk_create_input_v1': 'body',
95
+ },
96
+ 'collection_format_map': {
97
+ }
98
+ },
99
+ headers_map={
100
+ 'accept': [
101
+ 'text/plain',
102
+ 'application/json',
103
+ 'text/json'
104
+ ],
105
+ 'content_type': [
106
+ 'application/json-patch+json',
107
+ 'application/json',
108
+ 'text/json',
109
+ 'application/*+json'
110
+ ]
111
+ },
112
+ api_client=api_client
113
+ )
114
+ self.bulk_delete_v1_endpoint = _Endpoint(
115
+ settings={
116
+ 'response_type': (RmAudienceSegmentIdEntityV1ListResponse,),
117
+ 'auth': [
118
+ 'oauth',
119
+ 'oauth'
120
+ ],
121
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/delete',
122
+ 'operation_id': 'bulk_delete_v1',
123
+ 'http_method': 'POST',
124
+ 'servers': None,
125
+ },
126
+ params_map={
127
+ 'all': [
128
+ 'account_id',
129
+ 'rm_audience_segment_bulk_delete_input_v1',
130
+ ],
131
+ 'required': [
132
+ 'account_id',
133
+ 'rm_audience_segment_bulk_delete_input_v1',
134
+ ],
135
+ 'nullable': [
136
+ ],
137
+ 'enum': [
138
+ ],
139
+ 'validation': [
140
+ ]
141
+ },
142
+ root_map={
143
+ 'validations': {
144
+ },
145
+ 'allowed_values': {
146
+ },
147
+ 'openapi_types': {
148
+ 'account_id':
149
+ (str,),
150
+ 'rm_audience_segment_bulk_delete_input_v1':
151
+ (RmAudienceSegmentBulkDeleteInputV1,),
152
+ },
153
+ 'attribute_map': {
154
+ 'account_id': 'account-id',
155
+ },
156
+ 'location_map': {
157
+ 'account_id': 'path',
158
+ 'rm_audience_segment_bulk_delete_input_v1': 'body',
159
+ },
160
+ 'collection_format_map': {
161
+ }
162
+ },
163
+ headers_map={
164
+ 'accept': [
165
+ 'text/plain',
166
+ 'application/json',
167
+ 'text/json'
168
+ ],
169
+ 'content_type': [
170
+ 'application/json-patch+json',
171
+ 'application/json',
172
+ 'text/json',
173
+ 'application/*+json'
174
+ ]
175
+ },
176
+ api_client=api_client
177
+ )
178
+ self.bulk_update_v1_endpoint = _Endpoint(
179
+ settings={
180
+ 'response_type': (RmAudienceSegmentEntityV1ListResponse,),
181
+ 'auth': [
182
+ 'oauth',
183
+ 'oauth'
184
+ ],
185
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments',
186
+ 'operation_id': 'bulk_update_v1',
187
+ 'http_method': 'PATCH',
188
+ 'servers': None,
189
+ },
190
+ params_map={
191
+ 'all': [
192
+ 'account_id',
193
+ 'rm_audience_segment_bulk_update_input_v1',
194
+ ],
195
+ 'required': [
196
+ 'account_id',
197
+ 'rm_audience_segment_bulk_update_input_v1',
198
+ ],
199
+ 'nullable': [
200
+ ],
201
+ 'enum': [
202
+ ],
203
+ 'validation': [
204
+ ]
205
+ },
206
+ root_map={
207
+ 'validations': {
208
+ },
209
+ 'allowed_values': {
210
+ },
211
+ 'openapi_types': {
212
+ 'account_id':
213
+ (str,),
214
+ 'rm_audience_segment_bulk_update_input_v1':
215
+ (RmAudienceSegmentBulkUpdateInputV1,),
216
+ },
217
+ 'attribute_map': {
218
+ 'account_id': 'account-id',
219
+ },
220
+ 'location_map': {
221
+ 'account_id': 'path',
222
+ 'rm_audience_segment_bulk_update_input_v1': 'body',
223
+ },
224
+ 'collection_format_map': {
225
+ }
226
+ },
227
+ headers_map={
228
+ 'accept': [
229
+ 'text/plain',
230
+ 'application/json',
231
+ 'text/json'
232
+ ],
233
+ 'content_type': [
234
+ 'application/json-patch+json',
235
+ 'application/json',
236
+ 'text/json',
237
+ 'application/*+json'
238
+ ]
239
+ },
240
+ api_client=api_client
241
+ )
42
242
  self.delete_contact_list_identifiers_endpoint = _Endpoint(
43
243
  settings={
44
244
  'response_type': None,
@@ -91,6 +291,66 @@ class AudienceApi(object):
91
291
  },
92
292
  api_client=api_client
93
293
  )
294
+ self.get_contact_list_statistics_v1_endpoint = _Endpoint(
295
+ settings={
296
+ 'response_type': (RmContactListStatisticsEntityV1Response,),
297
+ 'auth': [
298
+ 'oauth',
299
+ 'oauth'
300
+ ],
301
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list',
302
+ 'operation_id': 'get_contact_list_statistics_v1',
303
+ 'http_method': 'GET',
304
+ 'servers': None,
305
+ },
306
+ params_map={
307
+ 'all': [
308
+ 'account_id',
309
+ 'audience_segment_id',
310
+ ],
311
+ 'required': [
312
+ 'account_id',
313
+ 'audience_segment_id',
314
+ ],
315
+ 'nullable': [
316
+ ],
317
+ 'enum': [
318
+ ],
319
+ 'validation': [
320
+ ]
321
+ },
322
+ root_map={
323
+ 'validations': {
324
+ },
325
+ 'allowed_values': {
326
+ },
327
+ 'openapi_types': {
328
+ 'account_id':
329
+ (str,),
330
+ 'audience_segment_id':
331
+ (str,),
332
+ },
333
+ 'attribute_map': {
334
+ 'account_id': 'account-id',
335
+ 'audience_segment_id': 'audience-segment-id',
336
+ },
337
+ 'location_map': {
338
+ 'account_id': 'path',
339
+ 'audience_segment_id': 'path',
340
+ },
341
+ 'collection_format_map': {
342
+ }
343
+ },
344
+ headers_map={
345
+ 'accept': [
346
+ 'text/plain',
347
+ 'application/json',
348
+ 'text/json'
349
+ ],
350
+ 'content_type': [],
351
+ },
352
+ api_client=api_client
353
+ )
94
354
  self.legacy_get_audience_v1_endpoint = _Endpoint(
95
355
  settings={
96
356
  'response_type': (RmLegacyAudienceGetEntityV1ListResponse,),
@@ -231,65 +491,406 @@ class AudienceApi(object):
231
491
  },
232
492
  api_client=api_client
233
493
  )
234
- self.update_contact_list_identifiers_endpoint = _Endpoint(
235
- settings={
236
- 'response_type': (RetailMediaContactlistOperation,),
237
- 'auth': [
238
- 'oauth',
239
- 'oauth'
240
- ],
241
- 'endpoint_path': '/preview/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove',
242
- 'operation_id': 'update_contact_list_identifiers',
243
- 'http_method': 'POST',
244
- 'servers': None,
245
- },
246
- params_map={
247
- 'all': [
248
- 'audience_segment_id',
249
- 'retail_media_contactlist_amendment_request',
250
- ],
251
- 'required': [
252
- 'audience_segment_id',
253
- 'retail_media_contactlist_amendment_request',
254
- ],
255
- 'nullable': [
256
- ],
257
- 'enum': [
258
- ],
259
- 'validation': [
260
- ]
261
- },
262
- root_map={
263
- 'validations': {
264
- },
265
- 'allowed_values': {
266
- },
267
- 'openapi_types': {
268
- 'audience_segment_id':
269
- (int,),
270
- 'retail_media_contactlist_amendment_request':
271
- (RetailMediaContactlistAmendmentRequest,),
272
- },
273
- 'attribute_map': {
274
- 'audience_segment_id': 'audience-segment-id',
275
- },
276
- 'location_map': {
277
- 'audience_segment_id': 'path',
278
- 'retail_media_contactlist_amendment_request': 'body',
279
- },
280
- 'collection_format_map': {
281
- }
282
- },
283
- headers_map={
284
- 'accept': [
285
- 'application/json'
286
- ],
287
- 'content_type': [
288
- 'application/json'
289
- ]
290
- },
291
- api_client=api_client
494
+ self.search_v1_endpoint = _Endpoint(
495
+ settings={
496
+ 'response_type': (RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse,),
497
+ 'auth': [
498
+ 'oauth',
499
+ 'oauth'
500
+ ],
501
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/search',
502
+ 'operation_id': 'search_v1',
503
+ 'http_method': 'POST',
504
+ 'servers': None,
505
+ },
506
+ params_map={
507
+ 'all': [
508
+ 'account_id',
509
+ 'rm_audience_segment_search_input_v1',
510
+ 'limit',
511
+ 'offset',
512
+ ],
513
+ 'required': [
514
+ 'account_id',
515
+ 'rm_audience_segment_search_input_v1',
516
+ ],
517
+ 'nullable': [
518
+ ],
519
+ 'enum': [
520
+ ],
521
+ 'validation': [
522
+ 'limit',
523
+ ]
524
+ },
525
+ root_map={
526
+ 'validations': {
527
+ ('limit',): {
528
+
529
+ 'inclusive_maximum': 100,
530
+ 'inclusive_minimum': 0,
531
+ },
532
+ },
533
+ 'allowed_values': {
534
+ },
535
+ 'openapi_types': {
536
+ 'account_id':
537
+ (str,),
538
+ 'rm_audience_segment_search_input_v1':
539
+ (RmAudienceSegmentSearchInputV1,),
540
+ 'limit':
541
+ (int,),
542
+ 'offset':
543
+ (int,),
544
+ },
545
+ 'attribute_map': {
546
+ 'account_id': 'account-id',
547
+ 'limit': 'limit',
548
+ 'offset': 'offset',
549
+ },
550
+ 'location_map': {
551
+ 'account_id': 'path',
552
+ 'rm_audience_segment_search_input_v1': 'body',
553
+ 'limit': 'query',
554
+ 'offset': 'query',
555
+ },
556
+ 'collection_format_map': {
557
+ }
558
+ },
559
+ headers_map={
560
+ 'accept': [
561
+ 'text/plain',
562
+ 'application/json',
563
+ 'text/json'
564
+ ],
565
+ 'content_type': [
566
+ 'application/json-patch+json',
567
+ 'application/json',
568
+ 'text/json',
569
+ 'application/*+json'
570
+ ]
571
+ },
572
+ api_client=api_client
573
+ )
574
+ self.update_contact_list_identifiers_endpoint = _Endpoint(
575
+ settings={
576
+ 'response_type': (RetailMediaContactlistOperation,),
577
+ 'auth': [
578
+ 'oauth',
579
+ 'oauth'
580
+ ],
581
+ 'endpoint_path': '/preview/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove',
582
+ 'operation_id': 'update_contact_list_identifiers',
583
+ 'http_method': 'POST',
584
+ 'servers': None,
585
+ },
586
+ params_map={
587
+ 'all': [
588
+ 'audience_segment_id',
589
+ 'retail_media_contactlist_amendment_request',
590
+ ],
591
+ 'required': [
592
+ 'audience_segment_id',
593
+ 'retail_media_contactlist_amendment_request',
594
+ ],
595
+ 'nullable': [
596
+ ],
597
+ 'enum': [
598
+ ],
599
+ 'validation': [
600
+ ]
601
+ },
602
+ root_map={
603
+ 'validations': {
604
+ },
605
+ 'allowed_values': {
606
+ },
607
+ 'openapi_types': {
608
+ 'audience_segment_id':
609
+ (int,),
610
+ 'retail_media_contactlist_amendment_request':
611
+ (RetailMediaContactlistAmendmentRequest,),
612
+ },
613
+ 'attribute_map': {
614
+ 'audience_segment_id': 'audience-segment-id',
615
+ },
616
+ 'location_map': {
617
+ 'audience_segment_id': 'path',
618
+ 'retail_media_contactlist_amendment_request': 'body',
619
+ },
620
+ 'collection_format_map': {
621
+ }
622
+ },
623
+ headers_map={
624
+ 'accept': [
625
+ 'application/json'
626
+ ],
627
+ 'content_type': [
628
+ 'application/json'
629
+ ]
630
+ },
631
+ api_client=api_client
632
+ )
633
+
634
+ def bulk_create_v1(
635
+ self,
636
+ account_id,
637
+ rm_audience_segment_bulk_create_input_v1,
638
+ **kwargs
639
+ ):
640
+ """bulk_create_v1 # noqa: E501
641
+
642
+ 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
+ This method makes a synchronous HTTP request by default. To make an
644
+ asynchronous HTTP request, please pass async_req=True
645
+
646
+ >>> thread = api.bulk_create_v1(account_id, rm_audience_segment_bulk_create_input_v1, async_req=True)
647
+ >>> result = thread.get()
648
+
649
+ Args:
650
+ account_id (str): Account Id
651
+ rm_audience_segment_bulk_create_input_v1 (RmAudienceSegmentBulkCreateInputV1): Segment creation parameter
652
+
653
+ Keyword Args:
654
+ _return_http_data_only (bool): response data without head status
655
+ code and headers. Default is True.
656
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
657
+ will be returned without reading/decoding response data.
658
+ Default is True.
659
+ _request_timeout (int/float/tuple): timeout setting for this request. If
660
+ one number provided, it will be total request timeout. It can also
661
+ be a pair (tuple) of (connection, read) timeouts.
662
+ Default is None.
663
+ _check_input_type (bool): specifies if type checking
664
+ should be done one the data sent to the server.
665
+ Default is True.
666
+ _check_return_type (bool): specifies if type checking
667
+ should be done one the data received from the server.
668
+ Default is True.
669
+ _spec_property_naming (bool): True if the variable names in the input data
670
+ are serialized names, as specified in the OpenAPI document.
671
+ False if the variable names in the input data
672
+ are pythonic names, e.g. snake case (default)
673
+ _content_type (str/None): force body content-type.
674
+ Default is None and content-type will be predicted by allowed
675
+ content-types and body.
676
+ _host_index (int/None): specifies the index of the server
677
+ that we want to use.
678
+ Default is read from the configuration.
679
+ _request_auths (list): set to override the auth_settings for an a single
680
+ request; this effectively ignores the authentication
681
+ in the spec for a single request.
682
+ Default is None
683
+ async_req (bool): execute request asynchronously
684
+
685
+ Returns:
686
+ RmAudienceSegmentEntityV1ListResponse
687
+ If the method is called asynchronously, returns the request
688
+ thread.
689
+ """
690
+ kwargs['async_req'] = kwargs.get(
691
+ 'async_req', False
692
+ )
693
+ kwargs['_return_http_data_only'] = kwargs.get(
694
+ '_return_http_data_only', True
695
+ )
696
+ kwargs['_preload_content'] = kwargs.get(
697
+ '_preload_content', True
698
+ )
699
+ kwargs['_request_timeout'] = kwargs.get(
700
+ '_request_timeout', None
701
+ )
702
+ kwargs['_check_input_type'] = kwargs.get(
703
+ '_check_input_type', True
704
+ )
705
+ kwargs['_check_return_type'] = kwargs.get(
706
+ '_check_return_type', True
707
+ )
708
+ kwargs['_spec_property_naming'] = kwargs.get(
709
+ '_spec_property_naming', False
710
+ )
711
+ kwargs['_content_type'] = kwargs.get(
712
+ '_content_type')
713
+ kwargs['_host_index'] = kwargs.get('_host_index')
714
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
715
+ kwargs['account_id'] = \
716
+ account_id
717
+ kwargs['rm_audience_segment_bulk_create_input_v1'] = \
718
+ rm_audience_segment_bulk_create_input_v1
719
+ return self.bulk_create_v1_endpoint.call_with_http_info(**kwargs)
720
+
721
+ def bulk_delete_v1(
722
+ self,
723
+ account_id,
724
+ rm_audience_segment_bulk_delete_input_v1,
725
+ **kwargs
726
+ ):
727
+ """bulk_delete_v1 # noqa: E501
728
+
729
+ Delete the segments associated to the given audience IDs. # noqa: E501
730
+ This method makes a synchronous HTTP request by default. To make an
731
+ asynchronous HTTP request, please pass async_req=True
732
+
733
+ >>> thread = api.bulk_delete_v1(account_id, rm_audience_segment_bulk_delete_input_v1, async_req=True)
734
+ >>> result = thread.get()
735
+
736
+ Args:
737
+ account_id (str): Account id
738
+ rm_audience_segment_bulk_delete_input_v1 (RmAudienceSegmentBulkDeleteInputV1): Segment delete request.
739
+
740
+ Keyword Args:
741
+ _return_http_data_only (bool): response data without head status
742
+ code and headers. Default is True.
743
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
744
+ will be returned without reading/decoding response data.
745
+ Default is True.
746
+ _request_timeout (int/float/tuple): timeout setting for this request. If
747
+ one number provided, it will be total request timeout. It can also
748
+ be a pair (tuple) of (connection, read) timeouts.
749
+ Default is None.
750
+ _check_input_type (bool): specifies if type checking
751
+ should be done one the data sent to the server.
752
+ Default is True.
753
+ _check_return_type (bool): specifies if type checking
754
+ should be done one the data received from the server.
755
+ Default is True.
756
+ _spec_property_naming (bool): True if the variable names in the input data
757
+ are serialized names, as specified in the OpenAPI document.
758
+ False if the variable names in the input data
759
+ are pythonic names, e.g. snake case (default)
760
+ _content_type (str/None): force body content-type.
761
+ Default is None and content-type will be predicted by allowed
762
+ content-types and body.
763
+ _host_index (int/None): specifies the index of the server
764
+ that we want to use.
765
+ Default is read from the configuration.
766
+ _request_auths (list): set to override the auth_settings for an a single
767
+ request; this effectively ignores the authentication
768
+ in the spec for a single request.
769
+ Default is None
770
+ async_req (bool): execute request asynchronously
771
+
772
+ Returns:
773
+ RmAudienceSegmentIdEntityV1ListResponse
774
+ If the method is called asynchronously, returns the request
775
+ thread.
776
+ """
777
+ kwargs['async_req'] = kwargs.get(
778
+ 'async_req', False
779
+ )
780
+ kwargs['_return_http_data_only'] = kwargs.get(
781
+ '_return_http_data_only', True
782
+ )
783
+ kwargs['_preload_content'] = kwargs.get(
784
+ '_preload_content', True
785
+ )
786
+ kwargs['_request_timeout'] = kwargs.get(
787
+ '_request_timeout', None
788
+ )
789
+ kwargs['_check_input_type'] = kwargs.get(
790
+ '_check_input_type', True
791
+ )
792
+ kwargs['_check_return_type'] = kwargs.get(
793
+ '_check_return_type', True
794
+ )
795
+ kwargs['_spec_property_naming'] = kwargs.get(
796
+ '_spec_property_naming', False
797
+ )
798
+ kwargs['_content_type'] = kwargs.get(
799
+ '_content_type')
800
+ kwargs['_host_index'] = kwargs.get('_host_index')
801
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
802
+ kwargs['account_id'] = \
803
+ account_id
804
+ kwargs['rm_audience_segment_bulk_delete_input_v1'] = \
805
+ rm_audience_segment_bulk_delete_input_v1
806
+ return self.bulk_delete_v1_endpoint.call_with_http_info(**kwargs)
807
+
808
+ def bulk_update_v1(
809
+ self,
810
+ account_id,
811
+ rm_audience_segment_bulk_update_input_v1,
812
+ **kwargs
813
+ ):
814
+ """bulk_update_v1 # noqa: E501
815
+
816
+ 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
+ This method makes a synchronous HTTP request by default. To make an
818
+ asynchronous HTTP request, please pass async_req=True
819
+
820
+ >>> thread = api.bulk_update_v1(account_id, rm_audience_segment_bulk_update_input_v1, async_req=True)
821
+ >>> result = thread.get()
822
+
823
+ Args:
824
+ account_id (str): Account id
825
+ rm_audience_segment_bulk_update_input_v1 (RmAudienceSegmentBulkUpdateInputV1): Segment Update request
826
+
827
+ Keyword Args:
828
+ _return_http_data_only (bool): response data without head status
829
+ code and headers. Default is True.
830
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
831
+ will be returned without reading/decoding response data.
832
+ Default is True.
833
+ _request_timeout (int/float/tuple): timeout setting for this request. If
834
+ one number provided, it will be total request timeout. It can also
835
+ be a pair (tuple) of (connection, read) timeouts.
836
+ Default is None.
837
+ _check_input_type (bool): specifies if type checking
838
+ should be done one the data sent to the server.
839
+ Default is True.
840
+ _check_return_type (bool): specifies if type checking
841
+ should be done one the data received from the server.
842
+ Default is True.
843
+ _spec_property_naming (bool): True if the variable names in the input data
844
+ are serialized names, as specified in the OpenAPI document.
845
+ False if the variable names in the input data
846
+ are pythonic names, e.g. snake case (default)
847
+ _content_type (str/None): force body content-type.
848
+ Default is None and content-type will be predicted by allowed
849
+ content-types and body.
850
+ _host_index (int/None): specifies the index of the server
851
+ that we want to use.
852
+ Default is read from the configuration.
853
+ _request_auths (list): set to override the auth_settings for an a single
854
+ request; this effectively ignores the authentication
855
+ in the spec for a single request.
856
+ Default is None
857
+ async_req (bool): execute request asynchronously
858
+
859
+ Returns:
860
+ RmAudienceSegmentEntityV1ListResponse
861
+ If the method is called asynchronously, returns the request
862
+ thread.
863
+ """
864
+ kwargs['async_req'] = kwargs.get(
865
+ 'async_req', False
866
+ )
867
+ kwargs['_return_http_data_only'] = kwargs.get(
868
+ '_return_http_data_only', True
292
869
  )
870
+ kwargs['_preload_content'] = kwargs.get(
871
+ '_preload_content', True
872
+ )
873
+ kwargs['_request_timeout'] = kwargs.get(
874
+ '_request_timeout', None
875
+ )
876
+ kwargs['_check_input_type'] = kwargs.get(
877
+ '_check_input_type', True
878
+ )
879
+ kwargs['_check_return_type'] = kwargs.get(
880
+ '_check_return_type', True
881
+ )
882
+ kwargs['_spec_property_naming'] = kwargs.get(
883
+ '_spec_property_naming', False
884
+ )
885
+ kwargs['_content_type'] = kwargs.get(
886
+ '_content_type')
887
+ kwargs['_host_index'] = kwargs.get('_host_index')
888
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
889
+ kwargs['account_id'] = \
890
+ account_id
891
+ kwargs['rm_audience_segment_bulk_update_input_v1'] = \
892
+ rm_audience_segment_bulk_update_input_v1
893
+ return self.bulk_update_v1_endpoint.call_with_http_info(**kwargs)
293
894
 
294
895
  def delete_contact_list_identifiers(
295
896
  self,
@@ -374,6 +975,93 @@ class AudienceApi(object):
374
975
  audience_segment_id
375
976
  return self.delete_contact_list_identifiers_endpoint.call_with_http_info(**kwargs)
376
977
 
978
+ def get_contact_list_statistics_v1(
979
+ self,
980
+ account_id,
981
+ audience_segment_id,
982
+ **kwargs
983
+ ):
984
+ """get_contact_list_statistics_v1 # noqa: E501
985
+
986
+ Returns the statistics of a contact list segment. # noqa: E501
987
+ This method makes a synchronous HTTP request by default. To make an
988
+ asynchronous HTTP request, please pass async_req=True
989
+
990
+ >>> thread = api.get_contact_list_statistics_v1(account_id, audience_segment_id, async_req=True)
991
+ >>> result = thread.get()
992
+
993
+ Args:
994
+ account_id (str): Account Id
995
+ audience_segment_id (str): Segment Id.
996
+
997
+ Keyword Args:
998
+ _return_http_data_only (bool): response data without head status
999
+ code and headers. Default is True.
1000
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1001
+ will be returned without reading/decoding response data.
1002
+ Default is True.
1003
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1004
+ one number provided, it will be total request timeout. It can also
1005
+ be a pair (tuple) of (connection, read) timeouts.
1006
+ Default is None.
1007
+ _check_input_type (bool): specifies if type checking
1008
+ should be done one the data sent to the server.
1009
+ Default is True.
1010
+ _check_return_type (bool): specifies if type checking
1011
+ should be done one the data received from the server.
1012
+ Default is True.
1013
+ _spec_property_naming (bool): True if the variable names in the input data
1014
+ are serialized names, as specified in the OpenAPI document.
1015
+ False if the variable names in the input data
1016
+ are pythonic names, e.g. snake case (default)
1017
+ _content_type (str/None): force body content-type.
1018
+ Default is None and content-type will be predicted by allowed
1019
+ content-types and body.
1020
+ _host_index (int/None): specifies the index of the server
1021
+ that we want to use.
1022
+ Default is read from the configuration.
1023
+ _request_auths (list): set to override the auth_settings for an a single
1024
+ request; this effectively ignores the authentication
1025
+ in the spec for a single request.
1026
+ Default is None
1027
+ async_req (bool): execute request asynchronously
1028
+
1029
+ Returns:
1030
+ RmContactListStatisticsEntityV1Response
1031
+ If the method is called asynchronously, returns the request
1032
+ thread.
1033
+ """
1034
+ kwargs['async_req'] = kwargs.get(
1035
+ 'async_req', False
1036
+ )
1037
+ kwargs['_return_http_data_only'] = kwargs.get(
1038
+ '_return_http_data_only', True
1039
+ )
1040
+ kwargs['_preload_content'] = kwargs.get(
1041
+ '_preload_content', True
1042
+ )
1043
+ kwargs['_request_timeout'] = kwargs.get(
1044
+ '_request_timeout', None
1045
+ )
1046
+ kwargs['_check_input_type'] = kwargs.get(
1047
+ '_check_input_type', True
1048
+ )
1049
+ kwargs['_check_return_type'] = kwargs.get(
1050
+ '_check_return_type', True
1051
+ )
1052
+ kwargs['_spec_property_naming'] = kwargs.get(
1053
+ '_spec_property_naming', False
1054
+ )
1055
+ kwargs['_content_type'] = kwargs.get(
1056
+ '_content_type')
1057
+ kwargs['_host_index'] = kwargs.get('_host_index')
1058
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1059
+ kwargs['account_id'] = \
1060
+ account_id
1061
+ kwargs['audience_segment_id'] = \
1062
+ audience_segment_id
1063
+ return self.get_contact_list_statistics_v1_endpoint.call_with_http_info(**kwargs)
1064
+
377
1065
  def legacy_get_audience_v1(
378
1066
  self,
379
1067
  account_id,
@@ -546,6 +1234,95 @@ class AudienceApi(object):
546
1234
  account_id
547
1235
  return self.legacy_get_audience_v2_endpoint.call_with_http_info(**kwargs)
548
1236
 
1237
+ def search_v1(
1238
+ self,
1239
+ account_id,
1240
+ rm_audience_segment_search_input_v1,
1241
+ **kwargs
1242
+ ):
1243
+ """search_v1 # noqa: E501
1244
+
1245
+ Search segments based on the provided filters.( by ids or retailer ids) # noqa: E501
1246
+ This method makes a synchronous HTTP request by default. To make an
1247
+ asynchronous HTTP request, please pass async_req=True
1248
+
1249
+ >>> thread = api.search_v1(account_id, rm_audience_segment_search_input_v1, async_req=True)
1250
+ >>> result = thread.get()
1251
+
1252
+ Args:
1253
+ account_id (str): Account Id
1254
+ rm_audience_segment_search_input_v1 (RmAudienceSegmentSearchInputV1): Segment creation parameter
1255
+
1256
+ Keyword Args:
1257
+ 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
1258
+ 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
1259
+ _return_http_data_only (bool): response data without head status
1260
+ code and headers. Default is True.
1261
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1262
+ will be returned without reading/decoding response data.
1263
+ Default is True.
1264
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1265
+ one number provided, it will be total request timeout. It can also
1266
+ be a pair (tuple) of (connection, read) timeouts.
1267
+ Default is None.
1268
+ _check_input_type (bool): specifies if type checking
1269
+ should be done one the data sent to the server.
1270
+ Default is True.
1271
+ _check_return_type (bool): specifies if type checking
1272
+ should be done one the data received from the server.
1273
+ Default is True.
1274
+ _spec_property_naming (bool): True if the variable names in the input data
1275
+ are serialized names, as specified in the OpenAPI document.
1276
+ False if the variable names in the input data
1277
+ are pythonic names, e.g. snake case (default)
1278
+ _content_type (str/None): force body content-type.
1279
+ Default is None and content-type will be predicted by allowed
1280
+ content-types and body.
1281
+ _host_index (int/None): specifies the index of the server
1282
+ that we want to use.
1283
+ Default is read from the configuration.
1284
+ _request_auths (list): set to override the auth_settings for an a single
1285
+ request; this effectively ignores the authentication
1286
+ in the spec for a single request.
1287
+ Default is None
1288
+ async_req (bool): execute request asynchronously
1289
+
1290
+ Returns:
1291
+ RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse
1292
+ If the method is called asynchronously, returns the request
1293
+ thread.
1294
+ """
1295
+ kwargs['async_req'] = kwargs.get(
1296
+ 'async_req', False
1297
+ )
1298
+ kwargs['_return_http_data_only'] = kwargs.get(
1299
+ '_return_http_data_only', True
1300
+ )
1301
+ kwargs['_preload_content'] = kwargs.get(
1302
+ '_preload_content', True
1303
+ )
1304
+ kwargs['_request_timeout'] = kwargs.get(
1305
+ '_request_timeout', None
1306
+ )
1307
+ kwargs['_check_input_type'] = kwargs.get(
1308
+ '_check_input_type', True
1309
+ )
1310
+ kwargs['_check_return_type'] = kwargs.get(
1311
+ '_check_return_type', True
1312
+ )
1313
+ kwargs['_spec_property_naming'] = kwargs.get(
1314
+ '_spec_property_naming', False
1315
+ )
1316
+ kwargs['_content_type'] = kwargs.get(
1317
+ '_content_type')
1318
+ kwargs['_host_index'] = kwargs.get('_host_index')
1319
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1320
+ kwargs['account_id'] = \
1321
+ account_id
1322
+ kwargs['rm_audience_segment_search_input_v1'] = \
1323
+ rm_audience_segment_search_input_v1
1324
+ return self.search_v1_endpoint.call_with_http_info(**kwargs)
1325
+
549
1326
  def update_contact_list_identifiers(
550
1327
  self,
551
1328
  audience_segment_id,