criteo-api-retailmedia-sdk 0.0.240118__py3-none-any.whl → 0.0.240404__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 (86) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +181 -35
  3. criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
  4. criteo_api_retailmedia_preview/api/audience_api.py +2 -313
  5. criteo_api_retailmedia_preview/api/campaign_api.py +443 -974
  6. criteo_api_retailmedia_preview/api/catalog_api.py +312 -0
  7. criteo_api_retailmedia_preview/api_client.py +4 -4
  8. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  9. criteo_api_retailmedia_preview/configuration.py +1 -1
  10. criteo_api_retailmedia_preview/model/{creative202210.py → async_accounts_report.py} +149 -95
  11. criteo_api_retailmedia_preview/model/{external_catalog_request_preview.py → async_accounts_report_request.py} +13 -10
  12. criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +273 -0
  13. criteo_api_retailmedia_preview/model/async_campaigns_report.py +57 -53
  14. criteo_api_retailmedia_preview/model/async_line_items_report.py +57 -54
  15. criteo_api_retailmedia_preview/model/{customer_list_details.py → batch_accepted_response.py} +11 -11
  16. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_int64.py → change_details.py} +27 -26
  17. criteo_api_retailmedia_preview/model/{color_variable_value.py → custom_attribute.py} +17 -16
  18. criteo_api_retailmedia_preview/model/export_report_column.py +2 -2
  19. criteo_api_retailmedia_preview/model/external_account.py +4 -0
  20. criteo_api_retailmedia_preview/model/{files_variable_value.py → external_line_item_capping_v2.py} +22 -13
  21. criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py +273 -0
  22. criteo_api_retailmedia_preview/model/{page_type_environment.py → external_line_item_page_v2.py} +40 -29
  23. criteo_api_retailmedia_preview/model/{retail_media_audience_attributes.py → external_preferred_line_item_create_model_v2.py} +79 -25
  24. criteo_api_retailmedia_preview/model/{external_catalog_status.py → external_preferred_line_item_update_model_v2.py} +70 -47
  25. criteo_api_retailmedia_preview/model/{template.py → external_preferred_line_item_v2.py} +93 -70
  26. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py → fail_response.py} +21 -23
  27. criteo_api_retailmedia_preview/model/input_resource_of_preferred_line_item_create_model_v2.py +273 -0
  28. criteo_api_retailmedia_preview/model/{retail_media_audience.py → insertion_order_history_change_data_capture.py} +48 -42
  29. criteo_api_retailmedia_preview/model/installment.py +273 -0
  30. criteo_api_retailmedia_preview/model/{creative202210_response.py → loyalty_points.py} +15 -25
  31. criteo_api_retailmedia_preview/model/metadata.py +273 -0
  32. criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py +276 -0
  33. criteo_api_retailmedia_preview/model/{json_api_request_of_catalog_request_preview.py → preferred_line_item_create_model_v2_request.py} +8 -8
  34. criteo_api_retailmedia_preview/model/{common_status_code_response.py → preferred_line_item_update_model_v2_request.py} +9 -15
  35. criteo_api_retailmedia_preview/model/{retail_media_audience_v2_list_response.py → preferred_line_item_v2_paged_list_response.py} +21 -27
  36. criteo_api_retailmedia_preview/model/{creative202210_list_response.py → preferred_line_item_v2_response.py} +16 -16
  37. criteo_api_retailmedia_preview/model/price.py +267 -0
  38. criteo_api_retailmedia_preview/model/product.py +626 -0
  39. criteo_api_retailmedia_preview/model/{retail_media_audience_v2.py → product_importer_error.py} +37 -29
  40. criteo_api_retailmedia_preview/model/product_importer_warning.py +299 -0
  41. criteo_api_retailmedia_preview/model/product_shipping.py +293 -0
  42. criteo_api_retailmedia_preview/model/product_shipping_dimension.py +267 -0
  43. criteo_api_retailmedia_preview/model/product_shipping_weight.py +267 -0
  44. criteo_api_retailmedia_preview/model/product_tax.py +283 -0
  45. criteo_api_retailmedia_preview/model/{choice_variable_value.py → product_unit_pricing_base_measure.py} +13 -15
  46. criteo_api_retailmedia_preview/model/{text_variable_specification.py → product_unit_pricing_measure.py} +11 -7
  47. criteo_api_retailmedia_preview/model/{section.py → products_custom_batch_request.py} +13 -19
  48. criteo_api_retailmedia_preview/model/{retail_media_audience_v2_attributes.py → products_custom_batch_request_entry.py} +43 -29
  49. criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py → report_detail_error.py} +35 -15
  50. criteo_api_retailmedia_preview/model/report_detail_errors.py +281 -0
  51. criteo_api_retailmedia_preview/model/{template_variable_value.py → report_ok_response.py} +58 -43
  52. criteo_api_retailmedia_preview/model/{resource_of_creative202210.py → resource_of_preferred_line_item_update_model_v2.py} +9 -9
  53. criteo_api_retailmedia_preview/model/{resource_of_template.py → resource_of_preferred_line_item_v2.py} +9 -9
  54. criteo_api_retailmedia_preview/model/retail_media_account.py +4 -0
  55. criteo_api_retailmedia_preview/model/retail_media_brand_account_creation.py +4 -0
  56. criteo_api_retailmedia_preview/model/{text_variable_value.py → retail_media_brands.py} +10 -22
  57. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +4 -0
  58. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2.py +3 -3
  59. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +37 -37
  60. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +51 -47
  61. criteo_api_retailmedia_preview/model/sync_line_items_report.py +53 -50
  62. criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py +262 -0
  63. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py +262 -0
  64. criteo_api_retailmedia_preview/model/{hyperlink_variable_value.py → value_resource_input_of_retail_media_brands.py} +15 -22
  65. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +262 -0
  66. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py +266 -0
  67. criteo_api_retailmedia_preview/model/{value_resource_of_int64.py → value_resource_of_retail_media_brands.py} +11 -6
  68. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py +266 -0
  69. criteo_api_retailmedia_preview/models/__init__.py +48 -42
  70. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/METADATA +3 -3
  71. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/RECORD +73 -66
  72. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/WHEEL +1 -1
  73. criteo_api_retailmedia_preview/model/choice_option.py +0 -281
  74. criteo_api_retailmedia_preview/model/choice_variable_specification.py +0 -283
  75. criteo_api_retailmedia_preview/model/create_user_behavior_segment_v2.py +0 -309
  76. criteo_api_retailmedia_preview/model/creative_create_model202207.py +0 -297
  77. criteo_api_retailmedia_preview/model/creative_update_model202207.py +0 -297
  78. criteo_api_retailmedia_preview/model/files_variables_specification.py +0 -290
  79. criteo_api_retailmedia_preview/model/get_page_of_audiences_by_account_id_response.py +0 -295
  80. criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py +0 -287
  81. criteo_api_retailmedia_preview/model/template_list_response.py +0 -281
  82. criteo_api_retailmedia_preview/model/template_response.py +0 -281
  83. criteo_api_retailmedia_preview/model/template_variable.py +0 -310
  84. criteo_api_retailmedia_preview/model/user_behavior_details.py +0 -306
  85. criteo_api_retailmedia_preview/model/user_behavior_details_v2.py +0 -279
  86. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/top_level.txt +0 -0
@@ -21,9 +21,6 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
21
21
  none_type,
22
22
  validate_and_convert_types
23
23
  )
24
- from criteo_api_retailmedia_preview.model.common_status_code_response import CommonStatusCodeResponse
25
- from criteo_api_retailmedia_preview.model.get_page_of_audiences_by_account_id_response import GetPageOfAudiencesByAccountIdResponse
26
- from criteo_api_retailmedia_preview.model.retail_media_audience_v2_list_response import RetailMediaAudienceV2ListResponse
27
24
  from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse
28
25
  from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse
29
26
 
@@ -39,142 +36,6 @@ class AudienceApi(object):
39
36
  if api_client is None:
40
37
  api_client = ApiClient()
41
38
  self.api_client = api_client
42
- self.get_audiences_by_account_id_endpoint = _Endpoint(
43
- settings={
44
- 'response_type': (GetPageOfAudiencesByAccountIdResponse,),
45
- 'auth': [
46
- 'oauth',
47
- 'oauth'
48
- ],
49
- 'endpoint_path': '/preview/retail-media/accounts/{accountId}/audiences',
50
- 'operation_id': 'get_audiences_by_account_id',
51
- 'http_method': 'GET',
52
- 'servers': None,
53
- },
54
- params_map={
55
- 'all': [
56
- 'account_id',
57
- 'limit_to_id',
58
- 'page_size',
59
- 'page_index',
60
- ],
61
- 'required': [
62
- 'account_id',
63
- ],
64
- 'nullable': [
65
- ],
66
- 'enum': [
67
- ],
68
- 'validation': [
69
- ]
70
- },
71
- root_map={
72
- 'validations': {
73
- },
74
- 'allowed_values': {
75
- },
76
- 'openapi_types': {
77
- 'account_id':
78
- (str,),
79
- 'limit_to_id':
80
- ([str],),
81
- 'page_size':
82
- (int,),
83
- 'page_index':
84
- (int,),
85
- },
86
- 'attribute_map': {
87
- 'account_id': 'accountId',
88
- 'limit_to_id': 'limitToId',
89
- 'page_size': 'pageSize',
90
- 'page_index': 'pageIndex',
91
- },
92
- 'location_map': {
93
- 'account_id': 'path',
94
- 'limit_to_id': 'query',
95
- 'page_size': 'query',
96
- 'page_index': 'query',
97
- },
98
- 'collection_format_map': {
99
- 'limit_to_id': 'multi',
100
- }
101
- },
102
- headers_map={
103
- 'accept': [
104
- 'application/json'
105
- ],
106
- 'content_type': [],
107
- },
108
- api_client=api_client
109
- )
110
- self.get_retail_media_audience_v2_list_by_account_id_endpoint = _Endpoint(
111
- settings={
112
- 'response_type': (RetailMediaAudienceV2ListResponse,),
113
- 'auth': [
114
- 'oauth',
115
- 'oauth'
116
- ],
117
- 'endpoint_path': '/preview/retail-media/v2/accounts/{accountId}/audiences',
118
- 'operation_id': 'get_retail_media_audience_v2_list_by_account_id',
119
- 'http_method': 'GET',
120
- 'servers': None,
121
- },
122
- params_map={
123
- 'all': [
124
- 'account_id',
125
- 'limit_to_id',
126
- 'page_size',
127
- 'page_index',
128
- ],
129
- 'required': [
130
- 'account_id',
131
- ],
132
- 'nullable': [
133
- ],
134
- 'enum': [
135
- ],
136
- 'validation': [
137
- ]
138
- },
139
- root_map={
140
- 'validations': {
141
- },
142
- 'allowed_values': {
143
- },
144
- 'openapi_types': {
145
- 'account_id':
146
- (int,),
147
- 'limit_to_id':
148
- ([int],),
149
- 'page_size':
150
- (int,),
151
- 'page_index':
152
- (int,),
153
- },
154
- 'attribute_map': {
155
- 'account_id': 'accountId',
156
- 'limit_to_id': 'limitToId',
157
- 'page_size': 'pageSize',
158
- 'page_index': 'pageIndex',
159
- },
160
- 'location_map': {
161
- 'account_id': 'path',
162
- 'limit_to_id': 'query',
163
- 'page_size': 'query',
164
- 'page_index': 'query',
165
- },
166
- 'collection_format_map': {
167
- 'limit_to_id': 'multi',
168
- }
169
- },
170
- headers_map={
171
- 'accept': [
172
- 'application/json'
173
- ],
174
- 'content_type': [],
175
- },
176
- api_client=api_client
177
- )
178
39
  self.legacy_get_audience_v1_endpoint = _Endpoint(
179
40
  settings={
180
41
  'response_type': (RmLegacyAudienceGetEntityV1ListResponse,),
@@ -182,7 +43,7 @@ class AudienceApi(object):
182
43
  'oauth',
183
44
  'oauth'
184
45
  ],
185
- 'endpoint_path': '/preview/retail-media/test/accounts/{accountId}/audiences',
46
+ 'endpoint_path': '/preview/retail-media/accounts/{accountId}/audiences',
186
47
  'operation_id': 'legacy_get_audience_v1',
187
48
  'http_method': 'GET',
188
49
  'servers': None,
@@ -252,7 +113,7 @@ class AudienceApi(object):
252
113
  'oauth',
253
114
  'oauth'
254
115
  ],
255
- 'endpoint_path': '/preview/retail-media/test/v2/accounts/{accountId}/audiences',
116
+ 'endpoint_path': '/preview/retail-media/v2/accounts/{accountId}/audiences',
256
117
  'operation_id': 'legacy_get_audience_v2',
257
118
  'http_method': 'GET',
258
119
  'servers': None,
@@ -316,178 +177,6 @@ class AudienceApi(object):
316
177
  api_client=api_client
317
178
  )
318
179
 
319
- def get_audiences_by_account_id(
320
- self,
321
- account_id,
322
- **kwargs
323
- ):
324
- """get_audiences_by_account_id # noqa: E501
325
-
326
- Get a page of audiences for a given account ID # noqa: E501
327
- This method makes a synchronous HTTP request by default. To make an
328
- asynchronous HTTP request, please pass async_req=True
329
-
330
- >>> thread = api.get_audiences_by_account_id(account_id, async_req=True)
331
- >>> result = thread.get()
332
-
333
- Args:
334
- account_id (str): External account ID which owns audience.
335
-
336
- Keyword Args:
337
- limit_to_id ([str]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
338
- page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. [optional]
339
- page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed. [optional]
340
- _return_http_data_only (bool): response data without head status
341
- code and headers. Default is True.
342
- _preload_content (bool): if False, the urllib3.HTTPResponse object
343
- will be returned without reading/decoding response data.
344
- Default is True.
345
- _request_timeout (int/float/tuple): timeout setting for this request. If
346
- one number provided, it will be total request timeout. It can also
347
- be a pair (tuple) of (connection, read) timeouts.
348
- Default is None.
349
- _check_input_type (bool): specifies if type checking
350
- should be done one the data sent to the server.
351
- Default is True.
352
- _check_return_type (bool): specifies if type checking
353
- should be done one the data received from the server.
354
- Default is True.
355
- _spec_property_naming (bool): True if the variable names in the input data
356
- are serialized names, as specified in the OpenAPI document.
357
- False if the variable names in the input data
358
- are pythonic names, e.g. snake case (default)
359
- _content_type (str/None): force body content-type.
360
- Default is None and content-type will be predicted by allowed
361
- content-types and body.
362
- _host_index (int/None): specifies the index of the server
363
- that we want to use.
364
- Default is read from the configuration.
365
- _request_auths (list): set to override the auth_settings for an a single
366
- request; this effectively ignores the authentication
367
- in the spec for a single request.
368
- Default is None
369
- async_req (bool): execute request asynchronously
370
-
371
- Returns:
372
- GetPageOfAudiencesByAccountIdResponse
373
- If the method is called asynchronously, returns the request
374
- thread.
375
- """
376
- kwargs['async_req'] = kwargs.get(
377
- 'async_req', False
378
- )
379
- kwargs['_return_http_data_only'] = kwargs.get(
380
- '_return_http_data_only', True
381
- )
382
- kwargs['_preload_content'] = kwargs.get(
383
- '_preload_content', True
384
- )
385
- kwargs['_request_timeout'] = kwargs.get(
386
- '_request_timeout', None
387
- )
388
- kwargs['_check_input_type'] = kwargs.get(
389
- '_check_input_type', True
390
- )
391
- kwargs['_check_return_type'] = kwargs.get(
392
- '_check_return_type', True
393
- )
394
- kwargs['_spec_property_naming'] = kwargs.get(
395
- '_spec_property_naming', False
396
- )
397
- kwargs['_content_type'] = kwargs.get(
398
- '_content_type')
399
- kwargs['_host_index'] = kwargs.get('_host_index')
400
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
401
- kwargs['account_id'] = \
402
- account_id
403
- return self.get_audiences_by_account_id_endpoint.call_with_http_info(**kwargs)
404
-
405
- def get_retail_media_audience_v2_list_by_account_id(
406
- self,
407
- account_id,
408
- **kwargs
409
- ):
410
- """get_retail_media_audience_v2_list_by_account_id # noqa: E501
411
-
412
- Get a page of audiences for a given account ID # noqa: E501
413
- This method makes a synchronous HTTP request by default. To make an
414
- asynchronous HTTP request, please pass async_req=True
415
-
416
- >>> thread = api.get_retail_media_audience_v2_list_by_account_id(account_id, async_req=True)
417
- >>> result = thread.get()
418
-
419
- Args:
420
- account_id (int): External account ID which owns audience.
421
-
422
- Keyword Args:
423
- limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
424
- page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. [optional]
425
- page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed. [optional]
426
- _return_http_data_only (bool): response data without head status
427
- code and headers. Default is True.
428
- _preload_content (bool): if False, the urllib3.HTTPResponse object
429
- will be returned without reading/decoding response data.
430
- Default is True.
431
- _request_timeout (int/float/tuple): timeout setting for this request. If
432
- one number provided, it will be total request timeout. It can also
433
- be a pair (tuple) of (connection, read) timeouts.
434
- Default is None.
435
- _check_input_type (bool): specifies if type checking
436
- should be done one the data sent to the server.
437
- Default is True.
438
- _check_return_type (bool): specifies if type checking
439
- should be done one the data received from the server.
440
- Default is True.
441
- _spec_property_naming (bool): True if the variable names in the input data
442
- are serialized names, as specified in the OpenAPI document.
443
- False if the variable names in the input data
444
- are pythonic names, e.g. snake case (default)
445
- _content_type (str/None): force body content-type.
446
- Default is None and content-type will be predicted by allowed
447
- content-types and body.
448
- _host_index (int/None): specifies the index of the server
449
- that we want to use.
450
- Default is read from the configuration.
451
- _request_auths (list): set to override the auth_settings for an a single
452
- request; this effectively ignores the authentication
453
- in the spec for a single request.
454
- Default is None
455
- async_req (bool): execute request asynchronously
456
-
457
- Returns:
458
- RetailMediaAudienceV2ListResponse
459
- If the method is called asynchronously, returns the request
460
- thread.
461
- """
462
- kwargs['async_req'] = kwargs.get(
463
- 'async_req', False
464
- )
465
- kwargs['_return_http_data_only'] = kwargs.get(
466
- '_return_http_data_only', True
467
- )
468
- kwargs['_preload_content'] = kwargs.get(
469
- '_preload_content', True
470
- )
471
- kwargs['_request_timeout'] = kwargs.get(
472
- '_request_timeout', None
473
- )
474
- kwargs['_check_input_type'] = kwargs.get(
475
- '_check_input_type', True
476
- )
477
- kwargs['_check_return_type'] = kwargs.get(
478
- '_check_return_type', True
479
- )
480
- kwargs['_spec_property_naming'] = kwargs.get(
481
- '_spec_property_naming', False
482
- )
483
- kwargs['_content_type'] = kwargs.get(
484
- '_content_type')
485
- kwargs['_host_index'] = kwargs.get('_host_index')
486
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
487
- kwargs['account_id'] = \
488
- account_id
489
- return self.get_retail_media_audience_v2_list_by_account_id_endpoint.call_with_http_info(**kwargs)
490
-
491
180
  def legacy_get_audience_v1(
492
181
  self,
493
182
  account_id,