criteo-api-retailmedia-sdk 0.0.240808__py3-none-any.whl → 0.0.250129__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.
Files changed (130) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +45 -198
  3. criteo_api_retailmedia_preview/api/analytics_api.py +3 -3
  4. criteo_api_retailmedia_preview/api/audience_api.py +89 -232
  5. criteo_api_retailmedia_preview/api/balance_api.py +0 -159
  6. criteo_api_retailmedia_preview/api/campaign_api.py +246 -1604
  7. criteo_api_retailmedia_preview/api/catalog_api.py +161 -0
  8. criteo_api_retailmedia_preview/api/on_site_recommendation_api.py +186 -0
  9. criteo_api_retailmedia_preview/api_client.py +4 -4
  10. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  11. criteo_api_retailmedia_preview/configuration.py +1 -1
  12. criteo_api_retailmedia_preview/model/async_accounts_report.py +40 -0
  13. criteo_api_retailmedia_preview/model/async_campaigns_report.py +40 -0
  14. criteo_api_retailmedia_preview/model/async_line_items_report.py +40 -0
  15. criteo_api_retailmedia_preview/model/balance_response_v2_response.py +1 -1
  16. criteo_api_retailmedia_preview/model/{creative_v2_response.py → bot_message.py} +17 -21
  17. criteo_api_retailmedia_preview/model/botmessage.py +329 -0
  18. criteo_api_retailmedia_preview/model/brand_id_search_request.py +271 -0
  19. criteo_api_retailmedia_preview/model/{external_retailer.py → brand_id_search_result.py} +26 -26
  20. criteo_api_retailmedia_preview/model/category.py +3 -3
  21. criteo_api_retailmedia_preview/model/change_details_v1.py +8 -18
  22. criteo_api_retailmedia_preview/model/{external_choice_variable_value.py → choice_variable_value.py} +4 -10
  23. criteo_api_retailmedia_preview/model/{external_color_variable_value.py → color_variable_value.py} +5 -11
  24. criteo_api_retailmedia_preview/model/{sku_search_request.py → cpc_min_bids_request.py} +11 -16
  25. criteo_api_retailmedia_preview/model/{page_of_insertion_order_history_change_data_capture_v2.py → cpc_min_bids_response.py} +19 -21
  26. criteo_api_retailmedia_preview/model/cpc_rate_card_preview.py +6 -6
  27. criteo_api_retailmedia_preview/model/{external_creative_v2.py → creative2.py} +23 -30
  28. criteo_api_retailmedia_preview/model/{resource_outcome_of_retail_media_account.py → creative2_list_response.py} +9 -9
  29. criteo_api_retailmedia_preview/model/{resource_collection_outcome_of_sku_search_result.py → creative2_response.py} +9 -9
  30. criteo_api_retailmedia_preview/model/{external_creative_create_model_v2.py → creative_create_model2.py} +9 -16
  31. criteo_api_retailmedia_preview/model/{external_creative_update_model_v2.py → creative_update_model2.py} +9 -16
  32. criteo_api_retailmedia_preview/model/{resource_of_retail_media_account.py → entity_resource_brand_id_search_result.py} +13 -13
  33. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_campaign_budget_overrides.py → entity_resource_collection_outcome_brand_id_search_result.py} +16 -16
  34. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_list_response.py → entity_resource_collection_outcome_of_retail_media_child_account.py} +15 -9
  35. criteo_api_retailmedia_preview/model/{resource_of_add_funds_to_balance_v2.py → entity_resource_of_retail_media_child_account.py} +14 -14
  36. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +1 -1
  37. criteo_api_retailmedia_preview/model/{external_account.py → external_retail_media_child_account.py} +39 -56
  38. criteo_api_retailmedia_preview/model/{external_files_variable_value.py → files_variable_value.py} +4 -10
  39. criteo_api_retailmedia_preview/model/http_validation_error.py +269 -0
  40. criteo_api_retailmedia_preview/model/{external_hyperlink_variable_value.py → hyperlink_variable_value.py} +5 -11
  41. criteo_api_retailmedia_preview/model/inbot_discussion.py +272 -0
  42. criteo_api_retailmedia_preview/model/{external_brand.py → inbot_discussion_body_model.py} +17 -15
  43. criteo_api_retailmedia_preview/model/inbot_discussion_data_instance_model.py +279 -0
  44. criteo_api_retailmedia_preview/model/json_api_request_of_seller_catalog_request.py +1 -1
  45. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_request.py +1 -1
  46. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py +1 -1
  47. criteo_api_retailmedia_preview/model/{external_text_variable_value.py → location_inner.py} +3 -7
  48. criteo_api_retailmedia_preview/model/message.py +273 -0
  49. criteo_api_retailmedia_preview/model/message_body_model.py +275 -0
  50. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_retailer_and_retailer.py → message_data_instance_model.py} +16 -22
  51. criteo_api_retailmedia_preview/model/message_error.py +275 -0
  52. criteo_api_retailmedia_preview/model/{rm_legacy_segment_customer_list.py → offset_page_metadata.py} +21 -17
  53. criteo_api_retailmedia_preview/model/{resource_of_sku_search_result.py → outcome.py} +15 -17
  54. criteo_api_retailmedia_preview/model/{external_page_type_environment.py → page_type_environment2.py} +4 -10
  55. criteo_api_retailmedia_preview/model/placement_preview.py +4 -0
  56. criteo_api_retailmedia_preview/model/product.py +4 -0
  57. criteo_api_retailmedia_preview/model/product_recommendation.py +305 -0
  58. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_account_and_account.py → report_detail_warning.py} +21 -21
  59. criteo_api_retailmedia_preview/model/report_detail_warnings.py +281 -0
  60. criteo_api_retailmedia_preview/model/report_ok_response.py +31 -17
  61. criteo_api_retailmedia_preview/model/{proposal_status_model_resource.py → resource_of_creative2.py} +14 -14
  62. criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.py +1 -1
  63. criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py +1 -1
  64. criteo_api_retailmedia_preview/model/retail_media_seller.py +4 -0
  65. criteo_api_retailmedia_preview/model/rm_algebra_node_v1.py +275 -0
  66. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_resource.py → rm_audience_entity_v1.py} +45 -24
  67. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_resource.py → rm_audience_entity_v1_resource.py} +8 -8
  68. criteo_api_retailmedia_preview/model/{creative_v2_list_response.py → rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response.py} +14 -8
  69. criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1.py +271 -0
  70. criteo_api_retailmedia_preview/model/{resource_of_creative_v2.py → rm_audience_search_entity_v1_resource.py} +11 -15
  71. criteo_api_retailmedia_preview/model/{add_funds_to_balance_v2_request.py → rm_audience_search_input_v1.py} +8 -8
  72. criteo_api_retailmedia_preview/model/rm_audience_search_metadata_v1.py +271 -0
  73. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +17 -9
  74. criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1.py +7 -7
  75. criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +1 -1
  76. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +5 -5
  77. criteo_api_retailmedia_preview/model/{rm_user_behavior_v1.py → rm_events_v1.py} +3 -3
  78. criteo_api_retailmedia_preview/model/{retail_media_account.py → sdk_api_rest_common_problem.py} +41 -42
  79. criteo_api_retailmedia_preview/model/seller_catalog_request.py +1 -1
  80. criteo_api_retailmedia_preview/model/{sku_search_request_body.py → seller_search.py} +18 -25
  81. criteo_api_retailmedia_preview/model/sku_data_preview.py +27 -27
  82. criteo_api_retailmedia_preview/model/sku_min_bid.py +269 -0
  83. criteo_api_retailmedia_preview/model/sku_slim_data_v2.py +9 -13
  84. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +4 -0
  85. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +1 -11
  86. criteo_api_retailmedia_preview/model/sync_line_items_report.py +1 -11
  87. criteo_api_retailmedia_preview/model/{external_template_variable_value.py → template_variable_value.py} +36 -43
  88. criteo_api_retailmedia_preview/model/text_variable_value.py +257 -0
  89. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_brand_and_brand.py → validation_error.py} +19 -17
  90. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller_account_creation.py → value_resource_brand_id_search_request.py} +10 -10
  91. criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_retail_media_seller.py +8 -8
  92. criteo_api_retailmedia_preview/model/{value_resource_of_campaign_budget_overrides.py → value_resource_cpc_min_bids_request.py} +10 -10
  93. criteo_api_retailmedia_preview/model/{value_resource_of_line_item_budget_overrides.py → value_resource_cpc_min_bids_response.py} +10 -10
  94. criteo_api_retailmedia_preview/model/{value_resource_input_of_line_item_budget_overrides.py → value_resource_input_brand_id_search_request.py} +8 -8
  95. criteo_api_retailmedia_preview/model/{value_resource_collection_input_of_retail_media_seller.py → value_resource_input_cpc_min_bids_request.py} +8 -8
  96. criteo_api_retailmedia_preview/model/{value_resource_input_of_campaign_budget_overrides.py → value_resource_input_of_seller_search.py} +8 -8
  97. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller.py +2 -2
  98. criteo_api_retailmedia_preview/model/value_resource_of_seller_search.py +266 -0
  99. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_line_item_budget_overrides.py → value_resource_outcome_cpc_min_bids_response.py} +16 -16
  100. criteo_api_retailmedia_preview/model/{external_video_variable_value.py → video_variable_value.py} +4 -10
  101. criteo_api_retailmedia_preview/models/__init__.py +60 -69
  102. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/METADATA +14 -5
  103. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/RECORD +105 -113
  104. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/WHEEL +1 -1
  105. criteo_api_retailmedia_preview/model/add_funds_to_balance_v2.py +0 -277
  106. criteo_api_retailmedia_preview/model/approval_status_model.py +0 -292
  107. criteo_api_retailmedia_preview/model/campaign_budget_overrides.py +0 -276
  108. criteo_api_retailmedia_preview/model/campaign_daily_budget_override.py +0 -283
  109. criteo_api_retailmedia_preview/model/campaign_monthly_budget_override.py +0 -283
  110. criteo_api_retailmedia_preview/model/change_details_v2.py +0 -275
  111. criteo_api_retailmedia_preview/model/daily_line_item_budget_override.py +0 -281
  112. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture_v2.py +0 -303
  113. criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py +0 -295
  114. criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py +0 -295
  115. criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py +0 -295
  116. criteo_api_retailmedia_preview/model/line_item_budget_overrides.py +0 -276
  117. criteo_api_retailmedia_preview/model/monthly_line_item_budeget_override.py +0 -283
  118. criteo_api_retailmedia_preview/model/negotiation_state_model.py +0 -293
  119. criteo_api_retailmedia_preview/model/proposal_status_model.py +0 -284
  120. criteo_api_retailmedia_preview/model/proposal_status_model_response.py +0 -274
  121. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +0 -270
  122. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v1.py +0 -291
  123. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2.py +0 -291
  124. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2_list_response.py +0 -281
  125. criteo_api_retailmedia_preview/model/rm_legacy_audience_user_behavior_details_v2.py +0 -279
  126. criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v1.py +0 -306
  127. criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v2.py +0 -311
  128. criteo_api_retailmedia_preview/model/sku_search_result.py +0 -313
  129. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +0 -262
  130. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/top_level.txt +0 -0
@@ -21,7 +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.add_funds_to_balance_v2_request import AddFundsToBalanceV2Request
25
24
  from criteo_api_retailmedia_preview.model.balance_response_v2_response import BalanceResponseV2Response
26
25
  from criteo_api_retailmedia_preview.model.change_dates_of_balance_v2_request import ChangeDatesOfBalanceV2Request
27
26
  from criteo_api_retailmedia_preview.model.create_balance_v2_request import CreateBalanceV2Request
@@ -317,73 +316,6 @@ class BalanceApi(object):
317
316
  },
318
317
  api_client=api_client
319
318
  )
320
- self.post_api_v2_external_account_add_funds_by_account_id_balancesbalance_id_endpoint = _Endpoint(
321
- settings={
322
- 'response_type': (BalanceResponseV2Response,),
323
- 'auth': [
324
- 'oauth',
325
- 'oauth'
326
- ],
327
- 'endpoint_path': '/preview/retail-media/accounts/{account-id}/balances/{balance-id}/add-funds',
328
- 'operation_id': 'post_api_v2_external_account_add_funds_by_account_id_balancesbalance_id',
329
- 'http_method': 'POST',
330
- 'servers': None,
331
- },
332
- params_map={
333
- 'all': [
334
- 'account_id',
335
- 'balance_id',
336
- 'add_funds_to_balance_v2_request',
337
- ],
338
- 'required': [
339
- 'account_id',
340
- 'balance_id',
341
- 'add_funds_to_balance_v2_request',
342
- ],
343
- 'nullable': [
344
- ],
345
- 'enum': [
346
- ],
347
- 'validation': [
348
- ]
349
- },
350
- root_map={
351
- 'validations': {
352
- },
353
- 'allowed_values': {
354
- },
355
- 'openapi_types': {
356
- 'account_id':
357
- (str,),
358
- 'balance_id':
359
- (str,),
360
- 'add_funds_to_balance_v2_request':
361
- (AddFundsToBalanceV2Request,),
362
- },
363
- 'attribute_map': {
364
- 'account_id': 'account-id',
365
- 'balance_id': 'balance-id',
366
- },
367
- 'location_map': {
368
- 'account_id': 'path',
369
- 'balance_id': 'path',
370
- 'add_funds_to_balance_v2_request': 'body',
371
- },
372
- 'collection_format_map': {
373
- }
374
- },
375
- headers_map={
376
- 'accept': [
377
- 'text/plain',
378
- 'application/json',
379
- 'text/json'
380
- ],
381
- 'content_type': [
382
- 'application/json'
383
- ]
384
- },
385
- api_client=api_client
386
- )
387
319
  self.post_api_v2_external_account_balances_by_account_id_endpoint = _Endpoint(
388
320
  settings={
389
321
  'response_type': (BalanceResponseV2Response,),
@@ -863,97 +795,6 @@ class BalanceApi(object):
863
795
  update_balance_model_v2_request
864
796
  return self.patch_api_v2_external_account_by_account_id_balancesbalance_id_endpoint.call_with_http_info(**kwargs)
865
797
 
866
- def post_api_v2_external_account_add_funds_by_account_id_balancesbalance_id(
867
- self,
868
- account_id,
869
- balance_id,
870
- add_funds_to_balance_v2_request,
871
- **kwargs
872
- ):
873
- """post_api_v2_external_account_add_funds_by_account_id_balancesbalance_id # noqa: E501
874
-
875
- Add funds to a balance for the given account id # noqa: E501
876
- This method makes a synchronous HTTP request by default. To make an
877
- asynchronous HTTP request, please pass async_req=True
878
-
879
- >>> thread = api.post_api_v2_external_account_add_funds_by_account_id_balancesbalance_id(account_id, balance_id, add_funds_to_balance_v2_request, async_req=True)
880
- >>> result = thread.get()
881
-
882
- Args:
883
- account_id (str): The account of the balance
884
- balance_id (str): The balance to add funds to
885
- add_funds_to_balance_v2_request (AddFundsToBalanceV2Request): An object that represents the available options of adding funds to a balance.
886
-
887
- Keyword Args:
888
- _return_http_data_only (bool): response data without head status
889
- code and headers. Default is True.
890
- _preload_content (bool): if False, the urllib3.HTTPResponse object
891
- will be returned without reading/decoding response data.
892
- Default is True.
893
- _request_timeout (int/float/tuple): timeout setting for this request. If
894
- one number provided, it will be total request timeout. It can also
895
- be a pair (tuple) of (connection, read) timeouts.
896
- Default is None.
897
- _check_input_type (bool): specifies if type checking
898
- should be done one the data sent to the server.
899
- Default is True.
900
- _check_return_type (bool): specifies if type checking
901
- should be done one the data received from the server.
902
- Default is True.
903
- _spec_property_naming (bool): True if the variable names in the input data
904
- are serialized names, as specified in the OpenAPI document.
905
- False if the variable names in the input data
906
- are pythonic names, e.g. snake case (default)
907
- _content_type (str/None): force body content-type.
908
- Default is None and content-type will be predicted by allowed
909
- content-types and body.
910
- _host_index (int/None): specifies the index of the server
911
- that we want to use.
912
- Default is read from the configuration.
913
- _request_auths (list): set to override the auth_settings for an a single
914
- request; this effectively ignores the authentication
915
- in the spec for a single request.
916
- Default is None
917
- async_req (bool): execute request asynchronously
918
-
919
- Returns:
920
- BalanceResponseV2Response
921
- If the method is called asynchronously, returns the request
922
- thread.
923
- """
924
- kwargs['async_req'] = kwargs.get(
925
- 'async_req', False
926
- )
927
- kwargs['_return_http_data_only'] = kwargs.get(
928
- '_return_http_data_only', True
929
- )
930
- kwargs['_preload_content'] = kwargs.get(
931
- '_preload_content', True
932
- )
933
- kwargs['_request_timeout'] = kwargs.get(
934
- '_request_timeout', None
935
- )
936
- kwargs['_check_input_type'] = kwargs.get(
937
- '_check_input_type', True
938
- )
939
- kwargs['_check_return_type'] = kwargs.get(
940
- '_check_return_type', True
941
- )
942
- kwargs['_spec_property_naming'] = kwargs.get(
943
- '_spec_property_naming', False
944
- )
945
- kwargs['_content_type'] = kwargs.get(
946
- '_content_type')
947
- kwargs['_host_index'] = kwargs.get('_host_index')
948
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
949
- kwargs['account_id'] = \
950
- account_id
951
- kwargs['balance_id'] = \
952
- balance_id
953
- kwargs['add_funds_to_balance_v2_request'] = \
954
- add_funds_to_balance_v2_request
955
- return self.post_api_v2_external_account_add_funds_by_account_id_balancesbalance_id_endpoint.call_with_http_info(**kwargs)
956
-
957
798
  def post_api_v2_external_account_balances_by_account_id(
958
799
  self,
959
800
  account_id,