criteo-api-retailmedia-sdk 0.0.250911__py3-none-any.whl → 0.0.251009__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 (38) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +71 -83
  3. criteo_api_retailmedia_preview/api/analytics_api.py +155 -63
  4. criteo_api_retailmedia_preview/api/audience_api.py +25 -88
  5. criteo_api_retailmedia_preview/api/balance_api.py +176 -186
  6. criteo_api_retailmedia_preview/api/billing_api.py +20 -25
  7. criteo_api_retailmedia_preview/api/campaign_api.py +1103 -996
  8. criteo_api_retailmedia_preview/api/catalog_api.py +6 -22
  9. criteo_api_retailmedia_preview/api_client.py +4 -4
  10. criteo_api_retailmedia_preview/configuration.py +1 -1
  11. criteo_api_retailmedia_preview/model/async_fill_rate_report.py +5 -0
  12. criteo_api_retailmedia_preview/model/{product_importer_error.py → async_unfilled_placements_report.py} +134 -41
  13. criteo_api_retailmedia_preview/model/{report_outcome.py → async_unfilled_placements_report_request.py} +9 -15
  14. criteo_api_retailmedia_preview/model/{error_code_response.py → async_unfilled_placements_report_resource.py} +15 -23
  15. criteo_api_retailmedia_preview/model/campaign_availability.py +289 -0
  16. criteo_api_retailmedia_preview/model/demand_managed_fee.py +1 -1
  17. criteo_api_retailmedia_preview/model/{value_resource_outcome_account_fees_update_result.py → entity_resource_collection_outcome_of_retailer_result_and_metadata.py} +14 -8
  18. criteo_api_retailmedia_preview/model/{outcome.py → entity_resource_of_retailer_result.py} +17 -15
  19. criteo_api_retailmedia_preview/model/files_variable_value.py +0 -3
  20. criteo_api_retailmedia_preview/model/managed_service_fee.py +1 -1
  21. criteo_api_retailmedia_preview/model/page_type_combination.py +287 -0
  22. criteo_api_retailmedia_preview/model/private_market_fees.py +6 -14
  23. criteo_api_retailmedia_preview/model/retailer_result.py +266 -0
  24. criteo_api_retailmedia_preview/model/{account_fees_update_result.py → retailer_search_request.py} +8 -12
  25. criteo_api_retailmedia_preview/model/rm_contact_list_create_v1.py +1 -0
  26. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +1 -0
  27. criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +11 -2
  28. criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +8 -0
  29. criteo_api_retailmedia_preview/model/sponsored_products_line_item_update_request_model.py +34 -28
  30. criteo_api_retailmedia_preview/model/value_resource_input_of_retailer_search_request.py +262 -0
  31. criteo_api_retailmedia_preview/model/{value_resource_account_fees_update_result.py → value_resource_of_retailer_search_request.py} +9 -9
  32. criteo_api_retailmedia_preview/models/__init__.py +11 -9
  33. {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.251009.dist-info}/METADATA +3 -3
  34. {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.251009.dist-info}/RECORD +36 -34
  35. criteo_api_retailmedia_preview/model/fail_response.py +0 -283
  36. criteo_api_retailmedia_preview/model/product_importer_warning.py +0 -299
  37. {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.251009.dist-info}/WHEEL +0 -0
  38. {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.251009.dist-info}/top_level.txt +0 -0
@@ -8,7 +8,7 @@
8
8
  """
9
9
 
10
10
 
11
- __version__ = "0.0.250911"
11
+ __version__ = "0.0.251009"
12
12
 
13
13
  # import ApiClient
14
14
  from criteo_api_retailmedia_preview.api_client import ApiClient
@@ -22,11 +22,9 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
22
22
  validate_and_convert_types
23
23
  )
24
24
  from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_retail_media_child_account_and_metadata import EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata
25
- from criteo_api_retailmedia_preview.model.outcome import Outcome
26
25
  from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_private_market_account_fees_and_metadata import ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata
27
26
  from criteo_api_retailmedia_preview.model.value_resource_input_account_fees_search_request import ValueResourceInputAccountFeesSearchRequest
28
27
  from criteo_api_retailmedia_preview.model.value_resource_input_account_fees_update_request import ValueResourceInputAccountFeesUpdateRequest
29
- from criteo_api_retailmedia_preview.model.value_resource_outcome_account_fees_update_result import ValueResourceOutcomeAccountFeesUpdateResult
30
28
 
31
29
 
32
30
  class AccountsApi(object):
@@ -40,56 +38,65 @@ class AccountsApi(object):
40
38
  if api_client is None:
41
39
  api_client = ApiClient()
42
40
  self.api_client = api_client
43
- self.get_api_external_v1_account_private_market_child_accounts_by_account_id_endpoint = _Endpoint(
41
+ self.account_fees_search_endpoint = _Endpoint(
44
42
  settings={
45
- 'response_type': (EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata,),
43
+ 'response_type': (ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata,),
46
44
  'auth': [
47
45
  'oauth',
48
46
  'oauth'
49
47
  ],
50
- 'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/private-market-child-accounts',
51
- 'operation_id': 'get_api_external_v1_account_private_market_child_accounts_by_account_id',
52
- 'http_method': 'GET',
48
+ 'endpoint_path': '/preview/retail-media/accounts/fees/search',
49
+ 'operation_id': 'account_fees_search',
50
+ 'http_method': 'POST',
53
51
  'servers': None,
54
52
  },
55
53
  params_map={
56
54
  'all': [
57
- 'account_id',
58
55
  'limit',
59
56
  'offset',
57
+ 'value_resource_input_account_fees_search_request',
60
58
  ],
61
- 'required': [
62
- 'account_id',
63
- ],
59
+ 'required': [],
64
60
  'nullable': [
65
61
  ],
66
62
  'enum': [
67
63
  ],
68
64
  'validation': [
65
+ 'limit',
66
+ 'offset',
69
67
  ]
70
68
  },
71
69
  root_map={
72
70
  'validations': {
71
+ ('limit',): {
72
+
73
+ 'inclusive_maximum': 500,
74
+ 'inclusive_minimum': 1,
75
+ },
76
+ ('offset',): {
77
+
78
+ 'inclusive_maximum': 2147483647,
79
+ 'inclusive_minimum': 0,
80
+ },
73
81
  },
74
82
  'allowed_values': {
75
83
  },
76
84
  'openapi_types': {
77
- 'account_id':
78
- (str,),
79
85
  'limit':
80
86
  (int,),
81
87
  'offset':
82
88
  (int,),
89
+ 'value_resource_input_account_fees_search_request':
90
+ (ValueResourceInputAccountFeesSearchRequest,),
83
91
  },
84
92
  'attribute_map': {
85
- 'account_id': 'accountId',
86
93
  'limit': 'limit',
87
94
  'offset': 'offset',
88
95
  },
89
96
  'location_map': {
90
- 'account_id': 'path',
91
97
  'limit': 'query',
92
98
  'offset': 'query',
99
+ 'value_resource_input_account_fees_search_request': 'body',
93
100
  },
94
101
  'collection_format_map': {
95
102
  }
@@ -98,69 +105,62 @@ class AccountsApi(object):
98
105
  'accept': [
99
106
  'application/json'
100
107
  ],
101
- 'content_type': [],
108
+ 'content_type': [
109
+ 'application/json'
110
+ ]
102
111
  },
103
112
  api_client=api_client
104
113
  )
105
- self.preview_retail_media_accounts_fees_search_post_endpoint = _Endpoint(
114
+ self.get_private_market_child_accounts_by_account_id_endpoint = _Endpoint(
106
115
  settings={
107
- 'response_type': (ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata,),
116
+ 'response_type': (EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata,),
108
117
  'auth': [
109
118
  'oauth',
110
119
  'oauth'
111
120
  ],
112
- 'endpoint_path': '/preview/retail-media/accounts/fees/search',
113
- 'operation_id': 'preview_retail_media_accounts_fees_search_post',
114
- 'http_method': 'POST',
121
+ 'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/private-market-child-accounts',
122
+ 'operation_id': 'get_private_market_child_accounts_by_account_id',
123
+ 'http_method': 'GET',
115
124
  'servers': None,
116
125
  },
117
126
  params_map={
118
127
  'all': [
128
+ 'account_id',
119
129
  'limit',
120
130
  'offset',
121
- 'value_resource_input_account_fees_search_request',
122
131
  ],
123
- 'required': [],
132
+ 'required': [
133
+ 'account_id',
134
+ ],
124
135
  'nullable': [
125
136
  ],
126
137
  'enum': [
127
138
  ],
128
139
  'validation': [
129
- 'limit',
130
- 'offset',
131
140
  ]
132
141
  },
133
142
  root_map={
134
143
  'validations': {
135
- ('limit',): {
136
-
137
- 'inclusive_maximum': 500,
138
- 'inclusive_minimum': 1,
139
- },
140
- ('offset',): {
141
-
142
- 'inclusive_maximum': 2147483647,
143
- 'inclusive_minimum': 0,
144
- },
145
144
  },
146
145
  'allowed_values': {
147
146
  },
148
147
  'openapi_types': {
148
+ 'account_id':
149
+ (str,),
149
150
  'limit':
150
151
  (int,),
151
152
  'offset':
152
153
  (int,),
153
- 'value_resource_input_account_fees_search_request':
154
- (ValueResourceInputAccountFeesSearchRequest,),
155
154
  },
156
155
  'attribute_map': {
156
+ 'account_id': 'accountId',
157
157
  'limit': 'limit',
158
158
  'offset': 'offset',
159
159
  },
160
160
  'location_map': {
161
+ 'account_id': 'path',
161
162
  'limit': 'query',
162
163
  'offset': 'query',
163
- 'value_resource_input_account_fees_search_request': 'body',
164
164
  },
165
165
  'collection_format_map': {
166
166
  }
@@ -169,24 +169,19 @@ class AccountsApi(object):
169
169
  'accept': [
170
170
  'application/json'
171
171
  ],
172
- 'content_type': [
173
- 'application/json-patch+json',
174
- 'application/json',
175
- 'text/json',
176
- 'application/*+json'
177
- ]
172
+ 'content_type': [],
178
173
  },
179
174
  api_client=api_client
180
175
  )
181
- self.preview_retail_media_accounts_fees_update_post_endpoint = _Endpoint(
176
+ self.update_account_fees_endpoint = _Endpoint(
182
177
  settings={
183
- 'response_type': (ValueResourceOutcomeAccountFeesUpdateResult,),
178
+ 'response_type': None,
184
179
  'auth': [
185
180
  'oauth',
186
181
  'oauth'
187
182
  ],
188
183
  'endpoint_path': '/preview/retail-media/accounts/fees/update',
189
- 'operation_id': 'preview_retail_media_accounts_fees_update_post',
184
+ 'operation_id': 'update_account_fees',
190
185
  'http_method': 'POST',
191
186
  'servers': None,
192
187
  },
@@ -220,41 +215,32 @@ class AccountsApi(object):
220
215
  }
221
216
  },
222
217
  headers_map={
223
- 'accept': [
224
- 'text/plain',
225
- 'application/json',
226
- 'text/json'
227
- ],
218
+ 'accept': [],
228
219
  'content_type': [
229
- 'application/json-patch+json',
230
- 'application/json',
231
- 'text/json',
232
- 'application/*+json'
220
+ 'application/json'
233
221
  ]
234
222
  },
235
223
  api_client=api_client
236
224
  )
237
225
 
238
- def get_api_external_v1_account_private_market_child_accounts_by_account_id(
226
+ def account_fees_search(
239
227
  self,
240
- account_id,
241
228
  **kwargs
242
229
  ):
243
- """get_api_external_v1_account_private_market_child_accounts_by_account_id # noqa: E501
230
+ """account_fees_search # noqa: E501
244
231
 
245
- Gets page of private market child accounts that are associated with the given account # noqa: E501
232
+ Get fees for provided accounts # noqa: E501
246
233
  This method makes a synchronous HTTP request by default. To make an
247
234
  asynchronous HTTP request, please pass async_req=True
248
235
 
249
- >>> thread = api.get_api_external_v1_account_private_market_child_accounts_by_account_id(account_id, async_req=True)
236
+ >>> thread = api.account_fees_search(async_req=True)
250
237
  >>> result = thread.get()
251
238
 
252
- Args:
253
- account_id (str): Account Id
254
239
 
255
240
  Keyword Args:
256
- limit (int): The number of accounts to be returned. The default is 25.. [optional] if omitted the server will use the default value of 25
257
- offset (int): The (zero-based) offset into the collection of accounts. The default is 0.. [optional] if omitted the server will use the default value of 0
241
+ limit (int): used for paging, number of results returned per request, Maximum of 500. [optional] if omitted the server will use the default value of 50
242
+ offset (int): used for paging, number of records to skip. [optional] if omitted the server will use the default value of 0
243
+ value_resource_input_account_fees_search_request (ValueResourceInputAccountFeesSearchRequest): [optional]
258
244
  _return_http_data_only (bool): response data without head status
259
245
  code and headers. Default is True.
260
246
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -287,7 +273,7 @@ class AccountsApi(object):
287
273
  async_req (bool): execute request asynchronously
288
274
 
289
275
  Returns:
290
- EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata
276
+ ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata
291
277
  If the method is called asynchronously, returns the request
292
278
  thread.
293
279
  """
@@ -316,28 +302,28 @@ class AccountsApi(object):
316
302
  '_content_type')
317
303
  kwargs['_host_index'] = kwargs.get('_host_index')
318
304
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
319
- kwargs['account_id'] = \
320
- account_id
321
- return self.get_api_external_v1_account_private_market_child_accounts_by_account_id_endpoint.call_with_http_info(**kwargs)
305
+ return self.account_fees_search_endpoint.call_with_http_info(**kwargs)
322
306
 
323
- def preview_retail_media_accounts_fees_search_post(
307
+ def get_private_market_child_accounts_by_account_id(
324
308
  self,
309
+ account_id,
325
310
  **kwargs
326
311
  ):
327
- """preview_retail_media_accounts_fees_search_post # noqa: E501
312
+ """get_private_market_child_accounts_by_account_id # noqa: E501
328
313
 
329
- Get fees for provided accounts # noqa: E501
314
+ Gets page of private market child accounts that are associated with the given account # noqa: E501
330
315
  This method makes a synchronous HTTP request by default. To make an
331
316
  asynchronous HTTP request, please pass async_req=True
332
317
 
333
- >>> thread = api.preview_retail_media_accounts_fees_search_post(async_req=True)
318
+ >>> thread = api.get_private_market_child_accounts_by_account_id(account_id, async_req=True)
334
319
  >>> result = thread.get()
335
320
 
321
+ Args:
322
+ account_id (str): Account Id
336
323
 
337
324
  Keyword Args:
338
- limit (int): used for paging, number of results returned per request, Maximum of 500. [optional] if omitted the server will use the default value of 50
339
- offset (int): used for paging, number of records to skip. [optional] if omitted the server will use the default value of 0
340
- value_resource_input_account_fees_search_request (ValueResourceInputAccountFeesSearchRequest): [optional]
325
+ limit (int): The number of accounts to be returned. The default is 25.. [optional] if omitted the server will use the default value of 25
326
+ offset (int): The (zero-based) offset into the collection of accounts. The default is 0.. [optional] if omitted the server will use the default value of 0
341
327
  _return_http_data_only (bool): response data without head status
342
328
  code and headers. Default is True.
343
329
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -370,7 +356,7 @@ class AccountsApi(object):
370
356
  async_req (bool): execute request asynchronously
371
357
 
372
358
  Returns:
373
- ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata
359
+ EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata
374
360
  If the method is called asynchronously, returns the request
375
361
  thread.
376
362
  """
@@ -399,19 +385,21 @@ class AccountsApi(object):
399
385
  '_content_type')
400
386
  kwargs['_host_index'] = kwargs.get('_host_index')
401
387
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
402
- return self.preview_retail_media_accounts_fees_search_post_endpoint.call_with_http_info(**kwargs)
388
+ kwargs['account_id'] = \
389
+ account_id
390
+ return self.get_private_market_child_accounts_by_account_id_endpoint.call_with_http_info(**kwargs)
403
391
 
404
- def preview_retail_media_accounts_fees_update_post(
392
+ def update_account_fees(
405
393
  self,
406
394
  **kwargs
407
395
  ):
408
- """preview_retail_media_accounts_fees_update_post # noqa: E501
396
+ """update_account_fees # noqa: E501
409
397
 
410
398
  Set fees for provided accounts # noqa: E501
411
399
  This method makes a synchronous HTTP request by default. To make an
412
400
  asynchronous HTTP request, please pass async_req=True
413
401
 
414
- >>> thread = api.preview_retail_media_accounts_fees_update_post(async_req=True)
402
+ >>> thread = api.update_account_fees(async_req=True)
415
403
  >>> result = thread.get()
416
404
 
417
405
 
@@ -449,7 +437,7 @@ class AccountsApi(object):
449
437
  async_req (bool): execute request asynchronously
450
438
 
451
439
  Returns:
452
- ValueResourceOutcomeAccountFeesUpdateResult
440
+ None
453
441
  If the method is called asynchronously, returns the request
454
442
  thread.
455
443
  """
@@ -478,5 +466,5 @@ class AccountsApi(object):
478
466
  '_content_type')
479
467
  kwargs['_host_index'] = kwargs.get('_host_index')
480
468
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
481
- return self.preview_retail_media_accounts_fees_update_post_endpoint.call_with_http_info(**kwargs)
469
+ return self.update_account_fees_endpoint.call_with_http_info(**kwargs)
482
470