criteo-api-retailmedia-sdk 2024.7.0.250129__py3-none-any.whl → 2024.10.0.241029__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of criteo-api-retailmedia-sdk might be problematic. Click here for more details.

Files changed (326) hide show
  1. {criteo_api_retailmedia_sdk-2024.7.0.250129.dist-info → criteo_api_retailmedia_sdk-2024.10.0.241029.dist-info}/METADATA +6 -15
  2. criteo_api_retailmedia_sdk-2024.10.0.241029.dist-info/RECORD +295 -0
  3. {criteo_api_retailmedia_sdk-2024.7.0.250129.dist-info → criteo_api_retailmedia_sdk-2024.10.0.241029.dist-info}/WHEEL +1 -1
  4. criteo_api_retailmedia_sdk-2024.10.0.241029.dist-info/top_level.txt +1 -0
  5. criteo_api_retailmedia_v2024_10/__init__.py +31 -0
  6. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/api/__init__.py +1 -1
  7. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/api/accounts_api.py +56 -45
  8. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/api/analytics_api.py +13 -13
  9. criteo_api_retailmedia_v2024_10/api/audience_api.py +1269 -0
  10. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/api/balance_api.py +19 -19
  11. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/api/campaign_api.py +940 -670
  12. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/api/gateway_api.py +5 -5
  13. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/api_client.py +6 -6
  14. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/api_client_builder.py +3 -3
  15. criteo_api_retailmedia_v2024_10/apis/__init__.py +22 -0
  16. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/configuration.py +5 -5
  17. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/criteo_api_client.py +2 -2
  18. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/criteo_auth.py +3 -3
  19. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/criteo_rest.py +3 -3
  20. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/exceptions.py +1 -1
  21. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/__init__.py +1 -1
  22. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_funds_to_balance_v2.py +3 -3
  23. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_funds_to_balance_v2_request.py +4 -4
  24. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_remove_keyword_model.py +4 -4
  25. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_remove_keywords_model.py +4 -4
  26. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_remove_keywords_model_request.py +4 -4
  27. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_remove_keywords_model_resource.py +4 -4
  28. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_to_basket_ids_update_model202110_request.py +4 -4
  29. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_to_basket_target202110_request.py +4 -4
  30. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/add_to_basket_target202110_response.py +5 -5
  31. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/application_summary_model.py +3 -3
  32. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/application_summary_model_resource.py +4 -4
  33. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/application_summary_model_response.py +5 -5
  34. criteo_api_retailmedia_v2024_10/model/approval_status_model.py +292 -0
  35. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/asset.py +3 -3
  36. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/asset_resource.py +4 -4
  37. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/asset_response.py +5 -5
  38. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_campaigns_report.py +3 -43
  39. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_campaigns_report_request.py +4 -4
  40. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_campaigns_report_resource.py +4 -4
  41. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_line_items_report.py +3 -43
  42. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_line_items_report_request.py +4 -4
  43. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_line_items_report_resource.py +4 -4
  44. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_report_response.py +5 -5
  45. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_revenue_report.py +5 -32
  46. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_revenue_report_request.py +4 -4
  47. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/async_revenue_report_resource.py +4 -4
  48. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/auction_line_item_create_model_request.py +4 -4
  49. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/auction_line_item_paged_list_response.py +6 -6
  50. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/auction_line_item_response.py +5 -5
  51. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/auction_line_item_update_model_request.py +4 -4
  52. criteo_api_retailmedia_v2024_10/model/audience_error.py +310 -0
  53. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/audience_ids_update_model202110_request.py +4 -4
  54. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/audience_target202110_request.py +4 -4
  55. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/audience_target202110_response.py +5 -5
  56. criteo_api_retailmedia_v2024_10/model/audience_warning.py +312 -0
  57. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/balance_campaign202110_list_request.py +4 -4
  58. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/balance_campaign202110_paged_list_response.py +6 -6
  59. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/balance_history_change_data_capture_v1.py +4 -4
  60. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/balance_response_v2.py +3 -3
  61. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/balance_response_v2_response.py +6 -6
  62. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/campaign_attributes_v202301.py +3 -3
  63. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/campaign_budget_overrides.py +5 -5
  64. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/campaign_daily_budget_override.py +3 -3
  65. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/campaign_monthly_budget_override.py +3 -3
  66. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/campaign_v202301.py +3 -3
  67. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/category202204.py +3 -3
  68. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/category202204_list_response.py +5 -5
  69. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/change_dates_of_balance_v2.py +3 -3
  70. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/change_dates_of_balance_v2_request.py +4 -4
  71. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/change_details_v1.py +21 -11
  72. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/choice_option.py +12 -5
  73. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/choice_variable_specification.py +12 -5
  74. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/choice_variable_value.py +10 -4
  75. criteo_api_retailmedia_v2024_10/model/color_variable_value.py +274 -0
  76. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/common_error.py +3 -3
  77. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/common_line_item_paged_list_response.py +6 -6
  78. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/common_line_item_response.py +5 -5
  79. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/common_problem.py +3 -3
  80. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/common_warning.py +3 -3
  81. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/create_balance_v2.py +3 -3
  82. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/create_balance_v2_request.py +4 -4
  83. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/creative202110.py +16 -10
  84. criteo_api_retailmedia_v2024_07/model/line_item_bid_multipliers_response.py → criteo_api_retailmedia_v2024_10/model/creative202110_list_response.py +12 -12
  85. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/creative202210.py +23 -16
  86. criteo_api_retailmedia_v2024_10/model/creative202210_response.py +281 -0
  87. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/creative_create_model202207.py +15 -8
  88. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/creative_update_model202207.py +15 -8
  89. criteo_api_retailmedia_v2024_10/model/creative_v2_list_response.py +281 -0
  90. criteo_api_retailmedia_v2024_10/model/creative_v2_response.py +281 -0
  91. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/daily_line_item_budget_override.py +3 -3
  92. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/editable_campaign_attributes_v202301.py +3 -3
  93. criteo_api_retailmedia_v2024_10/model/error_code_response.py +281 -0
  94. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_account.py +3 -3
  95. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_add_to_basket_ids_update_model202110.py +3 -3
  96. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_add_to_basket_target202110.py +3 -3
  97. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_auction_line_item.py +3 -3
  98. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_auction_line_item_create_model.py +3 -3
  99. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_auction_line_item_update_model.py +3 -3
  100. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_audience_ids_update_model202110.py +3 -3
  101. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_audience_target202110.py +3 -3
  102. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_brand.py +3 -3
  103. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_catalog_request.py +3 -3
  104. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_catalog_status.py +3 -3
  105. criteo_api_retailmedia_v2024_10/model/external_choice_variable_value.py +269 -0
  106. criteo_api_retailmedia_v2024_07/model/color_variable_value.py → criteo_api_retailmedia_v2024_10/model/external_color_variable_value.py +14 -8
  107. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_common_line_item.py +3 -3
  108. criteo_api_retailmedia_v2024_10/model/external_creative_v2.py +361 -0
  109. criteo_api_retailmedia_v2024_10/model/external_files_variable_value.py +272 -0
  110. criteo_api_retailmedia_v2024_07/model/hyperlink_variable_value.py → criteo_api_retailmedia_v2024_10/model/external_hyperlink_variable_value.py +14 -8
  111. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_keyword_target202110.py +3 -3
  112. criteo_api_retailmedia_v2024_07/model/line_item_bid_multipliers.py → criteo_api_retailmedia_v2024_10/model/external_line_item_bid_multipliers_v2.py +44 -32
  113. criteo_api_retailmedia_v2024_07/model/external_line_item_capping202110.py → criteo_api_retailmedia_v2024_10/model/external_line_item_capping_v2.py +8 -8
  114. criteo_api_retailmedia_v2024_07/model/external_line_item_page_category202110.py → criteo_api_retailmedia_v2024_10/model/external_line_item_page_category_v2.py +6 -6
  115. criteo_api_retailmedia_v2024_07/model/external_line_item_page202110.py → criteo_api_retailmedia_v2024_10/model/external_line_item_page_v2.py +18 -13
  116. criteo_api_retailmedia_v2024_07/model/page_type_environment202210.py → criteo_api_retailmedia_v2024_10/model/external_page_type_environment.py +17 -7
  117. criteo_api_retailmedia_v2024_07/model/external_preferred_line_item_create_model202110.py → criteo_api_retailmedia_v2024_10/model/external_preferred_line_item_create_model_v2.py +20 -20
  118. criteo_api_retailmedia_v2024_07/model/external_preferred_line_item_update_model202110.py → criteo_api_retailmedia_v2024_10/model/external_preferred_line_item_update_model_v2.py +18 -18
  119. criteo_api_retailmedia_v2024_07/model/external_preferred_line_item202110.py → criteo_api_retailmedia_v2024_10/model/external_preferred_line_item_v2.py +38 -43
  120. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_retailer.py +3 -3
  121. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_retailer_pages202110.py +3 -3
  122. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_store_ids_update_model202110.py +3 -3
  123. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/external_store_target202110.py +3 -3
  124. criteo_api_retailmedia_v2024_10/model/external_template_variable_value.py +309 -0
  125. criteo_api_retailmedia_v2024_07/model/external_retail_media_brands.py → criteo_api_retailmedia_v2024_10/model/external_text_variable_value.py +10 -10
  126. criteo_api_retailmedia_v2024_07/model/video_variable_value.py → criteo_api_retailmedia_v2024_10/model/external_video_variable_value.py +13 -7
  127. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/files_variable_value.py +10 -5
  128. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/files_variables_specification.py +18 -10
  129. criteo_api_retailmedia_v2024_10/model/hyperlink_variable_value.py +269 -0
  130. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/input_keywords_model.py +3 -3
  131. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/input_resource_of_auction_line_item_create_model.py +4 -4
  132. criteo_api_retailmedia_v2024_10/model/input_resource_of_preferred_line_item_create_model_v2.py +273 -0
  133. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py +4 -4
  134. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_body_with_id_of_int64_and_account_and_account.py +4 -4
  135. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_body_with_id_of_int64_and_brand_and_brand.py +4 -4
  136. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py +4 -4
  137. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py +4 -4
  138. criteo_api_retailmedia_v2024_10/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py +285 -0
  139. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py +4 -4
  140. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py +4 -4
  141. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py +4 -4
  142. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_page_response_of_account.py +7 -7
  143. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_page_response_of_brand.py +7 -7
  144. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_page_response_of_campaign_v202301.py +7 -7
  145. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_page_response_of_retailer.py +7 -7
  146. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_request_of_catalog_request.py +4 -4
  147. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_single_response_of_campaign_v202301.py +6 -6
  148. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/json_api_single_response_of_catalog_status.py +6 -6
  149. criteo_api_retailmedia_v2024_07/model/json_api_single_response_of_line_item_bid_multipliers.py → criteo_api_retailmedia_v2024_10/model/json_api_single_response_of_line_item_bid_multipliers_v2.py +19 -19
  150. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/keyword_data_model.py +6 -6
  151. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/keyword_target202110_request.py +4 -4
  152. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/keyword_target202110_response.py +5 -5
  153. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/keywords_model.py +4 -4
  154. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/keywords_model_resource.py +4 -4
  155. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/keywords_model_response.py +5 -5
  156. criteo_api_retailmedia_v2024_10/model/line_item_bid_multipliers_v2_request.py +269 -0
  157. criteo_api_retailmedia_v2024_07/model/entity_resource_outcome_of_retail_media_account.py → criteo_api_retailmedia_v2024_10/model/line_item_bid_multipliers_v2_response.py +13 -13
  158. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/line_item_budget_overrides.py +5 -5
  159. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/line_item_product_status.py +3 -3
  160. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/match_type_model.py +3 -3
  161. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/metadata.py +3 -3
  162. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/monthly_line_item_budeget_override.py +3 -3
  163. criteo_api_retailmedia_v2024_10/model/negotiation_state_model.py +293 -0
  164. criteo_api_retailmedia_v2024_07/model/external_retail_media_seller.py → criteo_api_retailmedia_v2024_10/model/nillable_string.py +11 -15
  165. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/page_metadata.py +3 -3
  166. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/page_of_balance_history_change_data_capture_v1.py +5 -5
  167. criteo_api_retailmedia_v2024_10/model/page_type_environment.py +287 -0
  168. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/paged_resource_collection_outcome_of_balance_response_v2.py +6 -6
  169. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/post_campaign_v202301.py +4 -4
  170. criteo_api_retailmedia_v2024_07/model/preferred_line_item_create_model202110_request.py → criteo_api_retailmedia_v2024_10/model/preferred_line_item_create_model_v2_request.py +11 -11
  171. criteo_api_retailmedia_v2024_10/model/preferred_line_item_update_model_v2_request.py +269 -0
  172. criteo_api_retailmedia_v2024_10/model/preferred_line_item_v2_paged_list_response.py +287 -0
  173. criteo_api_retailmedia_v2024_10/model/preferred_line_item_v2_response.py +281 -0
  174. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/problem_details.py +3 -3
  175. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/product_metadata.py +3 -3
  176. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/product_resource_outcome.py +4 -4
  177. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/promoted_product.py +4 -4
  178. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/promoted_product_resource.py +4 -4
  179. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/promoted_product_resource_collection_input.py +4 -4
  180. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/promoted_product_resource_collection_outcome.py +6 -6
  181. criteo_api_retailmedia_v2024_10/model/proposal_status_model.py +284 -0
  182. criteo_api_retailmedia_v2024_10/model/proposal_status_model_resource.py +270 -0
  183. criteo_api_retailmedia_v2024_10/model/proposal_status_model_response.py +274 -0
  184. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/put_campaign_v202301.py +4 -4
  185. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/report_outcome.py +4 -4
  186. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_add_funds_to_balance_v2.py +4 -4
  187. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_auction_line_item.py +4 -4
  188. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_auction_line_item_update_model.py +4 -4
  189. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_balance_campaign202110.py +3 -3
  190. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_balance_response_v2.py +4 -4
  191. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_category202204.py +4 -4
  192. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_change_dates_of_balance_v2.py +4 -4
  193. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_common_line_item.py +4 -4
  194. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_create_balance_v2.py +4 -4
  195. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_creative202110.py +17 -10
  196. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_creative202210.py +13 -6
  197. criteo_api_retailmedia_v2024_10/model/resource_of_creative_v2.py +277 -0
  198. criteo_api_retailmedia_v2024_10/model/resource_of_line_item_bid_multipliers_v2.py +277 -0
  199. criteo_api_retailmedia_v2024_10/model/resource_of_preferred_line_item_update_model_v2.py +277 -0
  200. criteo_api_retailmedia_v2024_10/model/resource_of_preferred_line_item_v2.py +277 -0
  201. criteo_api_retailmedia_v2024_10/model/resource_of_retail_media_account.py +270 -0
  202. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_template.py +13 -6
  203. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_of_update_balance_model_v2.py +4 -4
  204. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/resource_outcome.py +4 -4
  205. criteo_api_retailmedia_v2024_07/model/creative202210_response.py → criteo_api_retailmedia_v2024_10/model/resource_outcome_of_retail_media_account.py +13 -13
  206. criteo_api_retailmedia_v2024_07/model/external_retail_media_account.py → criteo_api_retailmedia_v2024_10/model/retail_media_account.py +26 -32
  207. criteo_api_retailmedia_v2024_07/model/external_retail_media_brand_account_creation.py → criteo_api_retailmedia_v2024_10/model/retail_media_brand_account_creation.py +15 -21
  208. criteo_api_retailmedia_v2024_07/model/text_variable_value.py → criteo_api_retailmedia_v2024_10/model/retail_media_brands.py +11 -11
  209. criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment.py +279 -0
  210. criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment_attributes.py +292 -0
  211. criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment_request.py +275 -0
  212. criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_operation.py +291 -0
  213. criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_operation_response_attributes.py +281 -0
  214. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v1.py → criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_operation_response_attributes_attributes.py +42 -36
  215. criteo_api_retailmedia_v2024_10/model/retail_media_seller.py +261 -0
  216. criteo_api_retailmedia_v2024_07/model/external_retail_media_seller_account_creation.py → criteo_api_retailmedia_v2024_10/model/retail_media_seller_account_creation.py +19 -26
  217. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/review_state_model.py +3 -3
  218. criteo_api_retailmedia_v2024_10/model/rm_algebra_node_v1.py +275 -0
  219. criteo_api_retailmedia_v2024_10/model/rm_audience_entity_v1.py +307 -0
  220. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v2_resource.py → criteo_api_retailmedia_v2024_10/model/rm_audience_entity_v1_resource.py +11 -11
  221. criteo_api_retailmedia_v2024_10/model/rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response.py +287 -0
  222. criteo_api_retailmedia_v2024_10/model/rm_audience_search_entity_v1.py +271 -0
  223. criteo_api_retailmedia_v2024_10/model/rm_audience_search_entity_v1_resource.py +273 -0
  224. criteo_api_retailmedia_v2024_07/model/line_item_bid_multipliers_request.py → criteo_api_retailmedia_v2024_10/model/rm_audience_search_input_v1.py +11 -11
  225. criteo_api_retailmedia_v2024_07/model/preferred_line_item_update_model202110_request.py → criteo_api_retailmedia_v2024_10/model/rm_audience_search_metadata_v1.py +18 -16
  226. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_bulk_create_input_v1.py +269 -0
  227. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_bulk_delete_input_v1.py +269 -0
  228. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_bulk_update_input_v1.py +269 -0
  229. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v2.py → criteo_api_retailmedia_v2024_10/model/rm_audience_segment_create_entity_v1.py +26 -24
  230. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_create_entity_v1_resource.py +273 -0
  231. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_delete_entity_v1_resource.py +271 -0
  232. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_entity_v1.py +323 -0
  233. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v1_response.py → criteo_api_retailmedia_v2024_10/model/rm_audience_segment_entity_v1_list_response.py +12 -12
  234. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v2_resource.py → criteo_api_retailmedia_v2024_10/model/rm_audience_segment_entity_v1_resource.py +11 -11
  235. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_entity_v1_rm_audience_segment_search_metadata_v1_list_response.py +287 -0
  236. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v1_list_response.py → criteo_api_retailmedia_v2024_10/model/rm_audience_segment_id_entity_v1_list_response.py +12 -12
  237. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_id_entity_v1_resource.py +271 -0
  238. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_search_entity_v1.py +277 -0
  239. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_search_entity_v1_resource.py +273 -0
  240. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_search_input_v1.py +269 -0
  241. criteo_api_retailmedia_v2024_10/model/rm_audience_segment_search_metadata_v1.py +271 -0
  242. criteo_api_retailmedia_v2024_07/model/preferred_line_item202110_response.py → criteo_api_retailmedia_v2024_10/model/rm_audience_segment_update_entity_v1.py +20 -24
  243. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v1_resource.py → criteo_api_retailmedia_v2024_10/model/rm_audience_segment_update_entity_v1_resource.py +11 -11
  244. criteo_api_retailmedia_v2024_10/model/rm_contact_list_create_v1.py +270 -0
  245. criteo_api_retailmedia_v2024_10/model/rm_contact_list_statistics_entity_v1.py +271 -0
  246. criteo_api_retailmedia_v2024_07/model/resource_of_preferred_line_item202110.py → criteo_api_retailmedia_v2024_10/model/rm_contact_list_statistics_entity_v1_resource.py +14 -14
  247. criteo_api_retailmedia_v2024_07/model/value_resource_outcome_of_retail_media_brands.py → criteo_api_retailmedia_v2024_10/model/rm_contact_list_statistics_entity_v1_response.py +13 -13
  248. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v1_resource.py → criteo_api_retailmedia_v2024_10/model/rm_contact_list_v1.py +31 -31
  249. criteo_api_retailmedia_v2024_07/model/rm_legacy_segment_user_behavior_v2.py → criteo_api_retailmedia_v2024_10/model/rm_events_v1.py +44 -52
  250. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/rmca_common_problem.py +3 -3
  251. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/section.py +13 -10
  252. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/set_bid_model.py +3 -3
  253. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/set_bids_model.py +4 -4
  254. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/set_bids_model_request.py +4 -4
  255. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/set_bids_model_resource.py +4 -4
  256. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/status_response.py +3 -3
  257. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/status_response_resource.py +4 -4
  258. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/store_ids_update_model202110_request.py +4 -4
  259. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/store_target202110_request.py +4 -4
  260. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/store_target202110_response.py +5 -5
  261. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/template.py +28 -17
  262. criteo_api_retailmedia_v2024_10/model/template_list_response.py +281 -0
  263. criteo_api_retailmedia_v2024_10/model/template_response.py +281 -0
  264. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/template_variable.py +14 -7
  265. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/template_variable_value.py +16 -15
  266. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/text_variable_specification.py +11 -5
  267. criteo_api_retailmedia_v2024_10/model/text_variable_value.py +269 -0
  268. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/update_balance_model_v2.py +3 -3
  269. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/update_balance_model_v2_request.py +4 -4
  270. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_collection_input_of_retail_media_seller.py +9 -16
  271. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_collection_outcome_of_retail_media_seller.py +7 -14
  272. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_input_of_campaign_budget_overrides.py +4 -4
  273. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_input_of_line_item_budget_overrides.py +4 -4
  274. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_input_of_retail_media_brand_account_creation.py +5 -12
  275. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_input_of_retail_media_brands.py +6 -13
  276. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_input_of_retail_media_seller_account_creation.py +6 -13
  277. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_of_campaign_budget_overrides.py +4 -4
  278. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_of_line_item_budget_overrides.py +4 -4
  279. criteo_api_retailmedia_v2024_10/model/value_resource_of_retail_media_brand_account_creation.py +266 -0
  280. criteo_api_retailmedia_v2024_10/model/value_resource_of_retail_media_brands.py +266 -0
  281. criteo_api_retailmedia_v2024_10/model/value_resource_of_retail_media_seller.py +266 -0
  282. criteo_api_retailmedia_v2024_10/model/value_resource_of_retail_media_seller_account_creation.py +266 -0
  283. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_outcome_of_campaign_budget_overrides.py +5 -5
  284. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_resource_outcome_of_line_item_budget_overrides.py +5 -5
  285. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_type_resource_of_add_to_basket_ids_update_model202110.py +4 -4
  286. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_type_resource_of_add_to_basket_target202110.py +4 -4
  287. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_type_resource_of_audience_ids_update_model202110.py +4 -4
  288. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_type_resource_of_audience_target202110.py +4 -4
  289. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_type_resource_of_keyword_target202110.py +4 -4
  290. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_type_resource_of_store_ids_update_model202110.py +4 -4
  291. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/value_type_resource_of_store_target202110.py +4 -4
  292. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model_utils.py +2 -2
  293. criteo_api_retailmedia_v2024_10/models/__init__.py +281 -0
  294. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/rest.py +2 -2
  295. criteo_api_retailmedia_sdk-2024.7.0.250129.dist-info/RECORD +0 -259
  296. criteo_api_retailmedia_sdk-2024.7.0.250129.dist-info/top_level.txt +0 -1
  297. criteo_api_retailmedia_v2024_07/__init__.py +0 -31
  298. criteo_api_retailmedia_v2024_07/api/audience_api.py +0 -657
  299. criteo_api_retailmedia_v2024_07/apis/__init__.py +0 -22
  300. criteo_api_retailmedia_v2024_07/model/creative202110_list_response.py +0 -274
  301. criteo_api_retailmedia_v2024_07/model/creative202210_list_response.py +0 -274
  302. criteo_api_retailmedia_v2024_07/model/entity_resource_of_retail_media_account.py +0 -277
  303. criteo_api_retailmedia_v2024_07/model/input_resource_of_preferred_line_item_create_model202110.py +0 -273
  304. criteo_api_retailmedia_v2024_07/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py +0 -285
  305. criteo_api_retailmedia_v2024_07/model/preferred_line_item202110_paged_list_response.py +0 -287
  306. criteo_api_retailmedia_v2024_07/model/resource_of_line_item_bid_multipliers.py +0 -277
  307. criteo_api_retailmedia_v2024_07/model/resource_of_preferred_line_item_update_model202110.py +0 -277
  308. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v1.py +0 -315
  309. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v2_response.py +0 -281
  310. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_input_entity_v1.py +0 -269
  311. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_input_entity_v2.py +0 -269
  312. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v2.py +0 -291
  313. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v2_list_response.py +0 -281
  314. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_user_behavior_create_v2.py +0 -279
  315. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_user_behavior_details_v2.py +0 -279
  316. criteo_api_retailmedia_v2024_07/model/rm_legacy_segment_customer_list.py +0 -275
  317. criteo_api_retailmedia_v2024_07/model/rm_legacy_segment_user_behavior_create_v2.py +0 -303
  318. criteo_api_retailmedia_v2024_07/model/rm_legacy_segment_user_behavior_v1.py +0 -306
  319. criteo_api_retailmedia_v2024_07/model/template_list_response.py +0 -274
  320. criteo_api_retailmedia_v2024_07/model/template_response.py +0 -274
  321. criteo_api_retailmedia_v2024_07/model/value_resource_of_retail_media_brand_account_creation.py +0 -273
  322. criteo_api_retailmedia_v2024_07/model/value_resource_of_retail_media_brands.py +0 -273
  323. criteo_api_retailmedia_v2024_07/model/value_resource_of_retail_media_seller.py +0 -273
  324. criteo_api_retailmedia_v2024_07/model/value_resource_of_retail_media_seller_account_creation.py +0 -273
  325. criteo_api_retailmedia_v2024_07/models/__init__.py +0 -245
  326. {criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/flow_constants.py +0 -0
@@ -0,0 +1,1269 @@
1
+ """
2
+ Criteo API
3
+
4
+ Criteo API - RetailMedia # noqa: E501
5
+
6
+ The version of the OpenAPI document: 2024-10
7
+ Generated by: https://openapi-generator.tech
8
+ """
9
+
10
+
11
+ import re # noqa: F401
12
+ import sys # noqa: F401
13
+
14
+ from criteo_api_retailmedia_v2024_10.api_client import ApiClient, Endpoint as _Endpoint
15
+ from criteo_api_retailmedia_v2024_10.model_utils import ( # noqa: F401
16
+ check_allowed_values,
17
+ check_validations,
18
+ date,
19
+ datetime,
20
+ file_type,
21
+ none_type,
22
+ validate_and_convert_types
23
+ )
24
+ from criteo_api_retailmedia_v2024_10.model.error_code_response import ErrorCodeResponse
25
+ from criteo_api_retailmedia_v2024_10.model.retail_media_contactlist_amendment_request import RetailMediaContactlistAmendmentRequest
26
+ from criteo_api_retailmedia_v2024_10.model.retail_media_contactlist_operation import RetailMediaContactlistOperation
27
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response import RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse
28
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_search_input_v1 import RmAudienceSearchInputV1
29
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_segment_bulk_create_input_v1 import RmAudienceSegmentBulkCreateInputV1
30
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_segment_bulk_delete_input_v1 import RmAudienceSegmentBulkDeleteInputV1
31
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_segment_bulk_update_input_v1 import RmAudienceSegmentBulkUpdateInputV1
32
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_segment_entity_v1_list_response import RmAudienceSegmentEntityV1ListResponse
33
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_segment_entity_v1_rm_audience_segment_search_metadata_v1_list_response import RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse
34
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_segment_id_entity_v1_list_response import RmAudienceSegmentIdEntityV1ListResponse
35
+ from criteo_api_retailmedia_v2024_10.model.rm_audience_segment_search_input_v1 import RmAudienceSegmentSearchInputV1
36
+ from criteo_api_retailmedia_v2024_10.model.rm_contact_list_statistics_entity_v1_response import RmContactListStatisticsEntityV1Response
37
+
38
+
39
+ class AudienceApi(object):
40
+ """NOTE: This class is auto generated by OpenAPI Generator
41
+ Ref: https://openapi-generator.tech
42
+
43
+ Do not edit the class manually.
44
+ """
45
+
46
+ def __init__(self, api_client=None):
47
+ if api_client is None:
48
+ api_client = ApiClient()
49
+ self.api_client = api_client
50
+ self.bulk_create_audience_segments_endpoint = _Endpoint(
51
+ settings={
52
+ 'response_type': (RmAudienceSegmentEntityV1ListResponse,),
53
+ 'auth': [
54
+ 'oauth',
55
+ 'oauth'
56
+ ],
57
+ 'endpoint_path': '/2024-10/retail-media/accounts/{account-id}/audience-segments/create',
58
+ 'operation_id': 'bulk_create_audience_segments',
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_audience_segments_endpoint = _Endpoint(
115
+ settings={
116
+ 'response_type': (RmAudienceSegmentIdEntityV1ListResponse,),
117
+ 'auth': [
118
+ 'oauth',
119
+ 'oauth'
120
+ ],
121
+ 'endpoint_path': '/2024-10/retail-media/accounts/{account-id}/audience-segments/delete',
122
+ 'operation_id': 'bulk_delete_audience_segments',
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_audience_segments_endpoint = _Endpoint(
179
+ settings={
180
+ 'response_type': (RmAudienceSegmentEntityV1ListResponse,),
181
+ 'auth': [
182
+ 'oauth',
183
+ 'oauth'
184
+ ],
185
+ 'endpoint_path': '/2024-10/retail-media/accounts/{account-id}/audience-segments',
186
+ 'operation_id': 'bulk_update_audience_segments',
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
+ )
242
+ self.delete_contact_list_identifiers_endpoint = _Endpoint(
243
+ settings={
244
+ 'response_type': None,
245
+ 'auth': [
246
+ 'oauth',
247
+ 'oauth'
248
+ ],
249
+ 'endpoint_path': '/2024-10/retail-media/audience-segments/{audience-segment-id}/contact-list/clear',
250
+ 'operation_id': 'delete_contact_list_identifiers',
251
+ 'http_method': 'POST',
252
+ 'servers': None,
253
+ },
254
+ params_map={
255
+ 'all': [
256
+ 'audience_segment_id',
257
+ ],
258
+ 'required': [
259
+ 'audience_segment_id',
260
+ ],
261
+ 'nullable': [
262
+ ],
263
+ 'enum': [
264
+ ],
265
+ 'validation': [
266
+ ]
267
+ },
268
+ root_map={
269
+ 'validations': {
270
+ },
271
+ 'allowed_values': {
272
+ },
273
+ 'openapi_types': {
274
+ 'audience_segment_id':
275
+ (int,),
276
+ },
277
+ 'attribute_map': {
278
+ 'audience_segment_id': 'audience-segment-id',
279
+ },
280
+ 'location_map': {
281
+ 'audience_segment_id': 'path',
282
+ },
283
+ 'collection_format_map': {
284
+ }
285
+ },
286
+ headers_map={
287
+ 'accept': [
288
+ 'application/json'
289
+ ],
290
+ 'content_type': [],
291
+ },
292
+ api_client=api_client
293
+ )
294
+ self.get_audience_segment_contact_list_statistics_endpoint = _Endpoint(
295
+ settings={
296
+ 'response_type': (RmContactListStatisticsEntityV1Response,),
297
+ 'auth': [
298
+ 'oauth',
299
+ 'oauth'
300
+ ],
301
+ 'endpoint_path': '/2024-10/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list',
302
+ 'operation_id': 'get_audience_segment_contact_list_statistics',
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
+ )
354
+ self.search_audience_segments_endpoint = _Endpoint(
355
+ settings={
356
+ 'response_type': (RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse,),
357
+ 'auth': [
358
+ 'oauth',
359
+ 'oauth'
360
+ ],
361
+ 'endpoint_path': '/2024-10/retail-media/accounts/{account-id}/audience-segments/search',
362
+ 'operation_id': 'search_audience_segments',
363
+ 'http_method': 'POST',
364
+ 'servers': None,
365
+ },
366
+ params_map={
367
+ 'all': [
368
+ 'account_id',
369
+ 'rm_audience_segment_search_input_v1',
370
+ 'limit',
371
+ 'offset',
372
+ ],
373
+ 'required': [
374
+ 'account_id',
375
+ 'rm_audience_segment_search_input_v1',
376
+ ],
377
+ 'nullable': [
378
+ ],
379
+ 'enum': [
380
+ ],
381
+ 'validation': [
382
+ 'limit',
383
+ ]
384
+ },
385
+ root_map={
386
+ 'validations': {
387
+ ('limit',): {
388
+
389
+ 'inclusive_maximum': 100,
390
+ 'inclusive_minimum': 0,
391
+ },
392
+ },
393
+ 'allowed_values': {
394
+ },
395
+ 'openapi_types': {
396
+ 'account_id':
397
+ (str,),
398
+ 'rm_audience_segment_search_input_v1':
399
+ (RmAudienceSegmentSearchInputV1,),
400
+ 'limit':
401
+ (int,),
402
+ 'offset':
403
+ (int,),
404
+ },
405
+ 'attribute_map': {
406
+ 'account_id': 'account-id',
407
+ 'limit': 'limit',
408
+ 'offset': 'offset',
409
+ },
410
+ 'location_map': {
411
+ 'account_id': 'path',
412
+ 'rm_audience_segment_search_input_v1': 'body',
413
+ 'limit': 'query',
414
+ 'offset': 'query',
415
+ },
416
+ 'collection_format_map': {
417
+ }
418
+ },
419
+ headers_map={
420
+ 'accept': [
421
+ 'text/plain',
422
+ 'application/json',
423
+ 'text/json'
424
+ ],
425
+ 'content_type': [
426
+ 'application/json-patch+json',
427
+ 'application/json',
428
+ 'text/json',
429
+ 'application/*+json'
430
+ ]
431
+ },
432
+ api_client=api_client
433
+ )
434
+ self.search_audiences_endpoint = _Endpoint(
435
+ settings={
436
+ 'response_type': (RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse,),
437
+ 'auth': [
438
+ 'oauth',
439
+ 'oauth'
440
+ ],
441
+ 'endpoint_path': '/2024-10/retail-media/accounts/{account-id}/audiences/search',
442
+ 'operation_id': 'search_audiences',
443
+ 'http_method': 'POST',
444
+ 'servers': None,
445
+ },
446
+ params_map={
447
+ 'all': [
448
+ 'account_id',
449
+ 'rm_audience_search_input_v1',
450
+ 'limit',
451
+ 'offset',
452
+ ],
453
+ 'required': [
454
+ 'account_id',
455
+ 'rm_audience_search_input_v1',
456
+ ],
457
+ 'nullable': [
458
+ ],
459
+ 'enum': [
460
+ ],
461
+ 'validation': [
462
+ 'limit',
463
+ ]
464
+ },
465
+ root_map={
466
+ 'validations': {
467
+ ('limit',): {
468
+
469
+ 'inclusive_maximum': 100,
470
+ 'inclusive_minimum': 0,
471
+ },
472
+ },
473
+ 'allowed_values': {
474
+ },
475
+ 'openapi_types': {
476
+ 'account_id':
477
+ (str,),
478
+ 'rm_audience_search_input_v1':
479
+ (RmAudienceSearchInputV1,),
480
+ 'limit':
481
+ (int,),
482
+ 'offset':
483
+ (int,),
484
+ },
485
+ 'attribute_map': {
486
+ 'account_id': 'account-id',
487
+ 'limit': 'limit',
488
+ 'offset': 'offset',
489
+ },
490
+ 'location_map': {
491
+ 'account_id': 'path',
492
+ 'rm_audience_search_input_v1': 'body',
493
+ 'limit': 'query',
494
+ 'offset': 'query',
495
+ },
496
+ 'collection_format_map': {
497
+ }
498
+ },
499
+ headers_map={
500
+ 'accept': [
501
+ 'text/plain',
502
+ 'application/json',
503
+ 'text/json'
504
+ ],
505
+ 'content_type': [
506
+ 'application/json-patch+json',
507
+ 'application/json',
508
+ 'text/json',
509
+ 'application/*+json'
510
+ ]
511
+ },
512
+ api_client=api_client
513
+ )
514
+ self.update_contact_list_identifiers_endpoint = _Endpoint(
515
+ settings={
516
+ 'response_type': (RetailMediaContactlistOperation,),
517
+ 'auth': [
518
+ 'oauth',
519
+ 'oauth'
520
+ ],
521
+ 'endpoint_path': '/2024-10/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove',
522
+ 'operation_id': 'update_contact_list_identifiers',
523
+ 'http_method': 'POST',
524
+ 'servers': None,
525
+ },
526
+ params_map={
527
+ 'all': [
528
+ 'audience_segment_id',
529
+ 'retail_media_contactlist_amendment_request',
530
+ ],
531
+ 'required': [
532
+ 'audience_segment_id',
533
+ 'retail_media_contactlist_amendment_request',
534
+ ],
535
+ 'nullable': [
536
+ ],
537
+ 'enum': [
538
+ ],
539
+ 'validation': [
540
+ ]
541
+ },
542
+ root_map={
543
+ 'validations': {
544
+ },
545
+ 'allowed_values': {
546
+ },
547
+ 'openapi_types': {
548
+ 'audience_segment_id':
549
+ (int,),
550
+ 'retail_media_contactlist_amendment_request':
551
+ (RetailMediaContactlistAmendmentRequest,),
552
+ },
553
+ 'attribute_map': {
554
+ 'audience_segment_id': 'audience-segment-id',
555
+ },
556
+ 'location_map': {
557
+ 'audience_segment_id': 'path',
558
+ 'retail_media_contactlist_amendment_request': 'body',
559
+ },
560
+ 'collection_format_map': {
561
+ }
562
+ },
563
+ headers_map={
564
+ 'accept': [
565
+ 'application/json'
566
+ ],
567
+ 'content_type': [
568
+ 'application/json'
569
+ ]
570
+ },
571
+ api_client=api_client
572
+ )
573
+
574
+ def bulk_create_audience_segments(
575
+ self,
576
+ account_id,
577
+ rm_audience_segment_bulk_create_input_v1,
578
+ **kwargs
579
+ ):
580
+ """bulk_create_audience_segments # noqa: E501
581
+
582
+ Creates all segments with a valid configuration, and returns the full segments. For those that cannot be created, one or multiple errors are returned. # noqa: E501
583
+ This method makes a synchronous HTTP request by default. To make an
584
+ asynchronous HTTP request, please pass async_req=True
585
+
586
+ >>> thread = api.bulk_create_audience_segments(account_id, rm_audience_segment_bulk_create_input_v1, async_req=True)
587
+ >>> result = thread.get()
588
+
589
+ Args:
590
+ account_id (str): Account Id
591
+ rm_audience_segment_bulk_create_input_v1 (RmAudienceSegmentBulkCreateInputV1): Segment creation parameter
592
+
593
+ Keyword Args:
594
+ _return_http_data_only (bool): response data without head status
595
+ code and headers. Default is True.
596
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
597
+ will be returned without reading/decoding response data.
598
+ Default is True.
599
+ _request_timeout (int/float/tuple): timeout setting for this request. If
600
+ one number provided, it will be total request timeout. It can also
601
+ be a pair (tuple) of (connection, read) timeouts.
602
+ Default is None.
603
+ _check_input_type (bool): specifies if type checking
604
+ should be done one the data sent to the server.
605
+ Default is True.
606
+ _check_return_type (bool): specifies if type checking
607
+ should be done one the data received from the server.
608
+ Default is True.
609
+ _spec_property_naming (bool): True if the variable names in the input data
610
+ are serialized names, as specified in the OpenAPI document.
611
+ False if the variable names in the input data
612
+ are pythonic names, e.g. snake case (default)
613
+ _content_type (str/None): force body content-type.
614
+ Default is None and content-type will be predicted by allowed
615
+ content-types and body.
616
+ _host_index (int/None): specifies the index of the server
617
+ that we want to use.
618
+ Default is read from the configuration.
619
+ _request_auths (list): set to override the auth_settings for an a single
620
+ request; this effectively ignores the authentication
621
+ in the spec for a single request.
622
+ Default is None
623
+ async_req (bool): execute request asynchronously
624
+
625
+ Returns:
626
+ RmAudienceSegmentEntityV1ListResponse
627
+ If the method is called asynchronously, returns the request
628
+ thread.
629
+ """
630
+ kwargs['async_req'] = kwargs.get(
631
+ 'async_req', False
632
+ )
633
+ kwargs['_return_http_data_only'] = kwargs.get(
634
+ '_return_http_data_only', True
635
+ )
636
+ kwargs['_preload_content'] = kwargs.get(
637
+ '_preload_content', True
638
+ )
639
+ kwargs['_request_timeout'] = kwargs.get(
640
+ '_request_timeout', None
641
+ )
642
+ kwargs['_check_input_type'] = kwargs.get(
643
+ '_check_input_type', True
644
+ )
645
+ kwargs['_check_return_type'] = kwargs.get(
646
+ '_check_return_type', True
647
+ )
648
+ kwargs['_spec_property_naming'] = kwargs.get(
649
+ '_spec_property_naming', False
650
+ )
651
+ kwargs['_content_type'] = kwargs.get(
652
+ '_content_type')
653
+ kwargs['_host_index'] = kwargs.get('_host_index')
654
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
655
+ kwargs['account_id'] = \
656
+ account_id
657
+ kwargs['rm_audience_segment_bulk_create_input_v1'] = \
658
+ rm_audience_segment_bulk_create_input_v1
659
+ return self.bulk_create_audience_segments_endpoint.call_with_http_info(**kwargs)
660
+
661
+ def bulk_delete_audience_segments(
662
+ self,
663
+ account_id,
664
+ rm_audience_segment_bulk_delete_input_v1,
665
+ **kwargs
666
+ ):
667
+ """bulk_delete_audience_segments # noqa: E501
668
+
669
+ Delete the segments associated to the given audience IDs. # noqa: E501
670
+ This method makes a synchronous HTTP request by default. To make an
671
+ asynchronous HTTP request, please pass async_req=True
672
+
673
+ >>> thread = api.bulk_delete_audience_segments(account_id, rm_audience_segment_bulk_delete_input_v1, async_req=True)
674
+ >>> result = thread.get()
675
+
676
+ Args:
677
+ account_id (str): Account id
678
+ rm_audience_segment_bulk_delete_input_v1 (RmAudienceSegmentBulkDeleteInputV1): Segment delete request.
679
+
680
+ Keyword Args:
681
+ _return_http_data_only (bool): response data without head status
682
+ code and headers. Default is True.
683
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
684
+ will be returned without reading/decoding response data.
685
+ Default is True.
686
+ _request_timeout (int/float/tuple): timeout setting for this request. If
687
+ one number provided, it will be total request timeout. It can also
688
+ be a pair (tuple) of (connection, read) timeouts.
689
+ Default is None.
690
+ _check_input_type (bool): specifies if type checking
691
+ should be done one the data sent to the server.
692
+ Default is True.
693
+ _check_return_type (bool): specifies if type checking
694
+ should be done one the data received from the server.
695
+ Default is True.
696
+ _spec_property_naming (bool): True if the variable names in the input data
697
+ are serialized names, as specified in the OpenAPI document.
698
+ False if the variable names in the input data
699
+ are pythonic names, e.g. snake case (default)
700
+ _content_type (str/None): force body content-type.
701
+ Default is None and content-type will be predicted by allowed
702
+ content-types and body.
703
+ _host_index (int/None): specifies the index of the server
704
+ that we want to use.
705
+ Default is read from the configuration.
706
+ _request_auths (list): set to override the auth_settings for an a single
707
+ request; this effectively ignores the authentication
708
+ in the spec for a single request.
709
+ Default is None
710
+ async_req (bool): execute request asynchronously
711
+
712
+ Returns:
713
+ RmAudienceSegmentIdEntityV1ListResponse
714
+ If the method is called asynchronously, returns the request
715
+ thread.
716
+ """
717
+ kwargs['async_req'] = kwargs.get(
718
+ 'async_req', False
719
+ )
720
+ kwargs['_return_http_data_only'] = kwargs.get(
721
+ '_return_http_data_only', True
722
+ )
723
+ kwargs['_preload_content'] = kwargs.get(
724
+ '_preload_content', True
725
+ )
726
+ kwargs['_request_timeout'] = kwargs.get(
727
+ '_request_timeout', None
728
+ )
729
+ kwargs['_check_input_type'] = kwargs.get(
730
+ '_check_input_type', True
731
+ )
732
+ kwargs['_check_return_type'] = kwargs.get(
733
+ '_check_return_type', True
734
+ )
735
+ kwargs['_spec_property_naming'] = kwargs.get(
736
+ '_spec_property_naming', False
737
+ )
738
+ kwargs['_content_type'] = kwargs.get(
739
+ '_content_type')
740
+ kwargs['_host_index'] = kwargs.get('_host_index')
741
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
742
+ kwargs['account_id'] = \
743
+ account_id
744
+ kwargs['rm_audience_segment_bulk_delete_input_v1'] = \
745
+ rm_audience_segment_bulk_delete_input_v1
746
+ return self.bulk_delete_audience_segments_endpoint.call_with_http_info(**kwargs)
747
+
748
+ def bulk_update_audience_segments(
749
+ self,
750
+ account_id,
751
+ rm_audience_segment_bulk_update_input_v1,
752
+ **kwargs
753
+ ):
754
+ """bulk_update_audience_segments # noqa: E501
755
+
756
+ Updates the properties of all segments with a valid configuration, and returns the full segments. For those that cannot be updated, one or multiple errors are returned. # noqa: E501
757
+ This method makes a synchronous HTTP request by default. To make an
758
+ asynchronous HTTP request, please pass async_req=True
759
+
760
+ >>> thread = api.bulk_update_audience_segments(account_id, rm_audience_segment_bulk_update_input_v1, async_req=True)
761
+ >>> result = thread.get()
762
+
763
+ Args:
764
+ account_id (str): Account id
765
+ rm_audience_segment_bulk_update_input_v1 (RmAudienceSegmentBulkUpdateInputV1): Segment Update request
766
+
767
+ Keyword Args:
768
+ _return_http_data_only (bool): response data without head status
769
+ code and headers. Default is True.
770
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
771
+ will be returned without reading/decoding response data.
772
+ Default is True.
773
+ _request_timeout (int/float/tuple): timeout setting for this request. If
774
+ one number provided, it will be total request timeout. It can also
775
+ be a pair (tuple) of (connection, read) timeouts.
776
+ Default is None.
777
+ _check_input_type (bool): specifies if type checking
778
+ should be done one the data sent to the server.
779
+ Default is True.
780
+ _check_return_type (bool): specifies if type checking
781
+ should be done one the data received from the server.
782
+ Default is True.
783
+ _spec_property_naming (bool): True if the variable names in the input data
784
+ are serialized names, as specified in the OpenAPI document.
785
+ False if the variable names in the input data
786
+ are pythonic names, e.g. snake case (default)
787
+ _content_type (str/None): force body content-type.
788
+ Default is None and content-type will be predicted by allowed
789
+ content-types and body.
790
+ _host_index (int/None): specifies the index of the server
791
+ that we want to use.
792
+ Default is read from the configuration.
793
+ _request_auths (list): set to override the auth_settings for an a single
794
+ request; this effectively ignores the authentication
795
+ in the spec for a single request.
796
+ Default is None
797
+ async_req (bool): execute request asynchronously
798
+
799
+ Returns:
800
+ RmAudienceSegmentEntityV1ListResponse
801
+ If the method is called asynchronously, returns the request
802
+ thread.
803
+ """
804
+ kwargs['async_req'] = kwargs.get(
805
+ 'async_req', False
806
+ )
807
+ kwargs['_return_http_data_only'] = kwargs.get(
808
+ '_return_http_data_only', True
809
+ )
810
+ kwargs['_preload_content'] = kwargs.get(
811
+ '_preload_content', True
812
+ )
813
+ kwargs['_request_timeout'] = kwargs.get(
814
+ '_request_timeout', None
815
+ )
816
+ kwargs['_check_input_type'] = kwargs.get(
817
+ '_check_input_type', True
818
+ )
819
+ kwargs['_check_return_type'] = kwargs.get(
820
+ '_check_return_type', True
821
+ )
822
+ kwargs['_spec_property_naming'] = kwargs.get(
823
+ '_spec_property_naming', False
824
+ )
825
+ kwargs['_content_type'] = kwargs.get(
826
+ '_content_type')
827
+ kwargs['_host_index'] = kwargs.get('_host_index')
828
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
829
+ kwargs['account_id'] = \
830
+ account_id
831
+ kwargs['rm_audience_segment_bulk_update_input_v1'] = \
832
+ rm_audience_segment_bulk_update_input_v1
833
+ return self.bulk_update_audience_segments_endpoint.call_with_http_info(**kwargs)
834
+
835
+ def delete_contact_list_identifiers(
836
+ self,
837
+ audience_segment_id,
838
+ **kwargs
839
+ ):
840
+ """delete_contact_list_identifiers # noqa: E501
841
+
842
+ Delete all identifiers from a retail-media contact list audience-segment, with external audience segment id. # noqa: E501
843
+ This method makes a synchronous HTTP request by default. To make an
844
+ asynchronous HTTP request, please pass async_req=True
845
+
846
+ >>> thread = api.delete_contact_list_identifiers(audience_segment_id, async_req=True)
847
+ >>> result = thread.get()
848
+
849
+ Args:
850
+ audience_segment_id (int): The id of the contact list audience-segment to amend, we only accept external Id here
851
+
852
+ Keyword Args:
853
+ _return_http_data_only (bool): response data without head status
854
+ code and headers. Default is True.
855
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
856
+ will be returned without reading/decoding response data.
857
+ Default is True.
858
+ _request_timeout (int/float/tuple): timeout setting for this request. If
859
+ one number provided, it will be total request timeout. It can also
860
+ be a pair (tuple) of (connection, read) timeouts.
861
+ Default is None.
862
+ _check_input_type (bool): specifies if type checking
863
+ should be done one the data sent to the server.
864
+ Default is True.
865
+ _check_return_type (bool): specifies if type checking
866
+ should be done one the data received from the server.
867
+ Default is True.
868
+ _spec_property_naming (bool): True if the variable names in the input data
869
+ are serialized names, as specified in the OpenAPI document.
870
+ False if the variable names in the input data
871
+ are pythonic names, e.g. snake case (default)
872
+ _content_type (str/None): force body content-type.
873
+ Default is None and content-type will be predicted by allowed
874
+ content-types and body.
875
+ _host_index (int/None): specifies the index of the server
876
+ that we want to use.
877
+ Default is read from the configuration.
878
+ _request_auths (list): set to override the auth_settings for an a single
879
+ request; this effectively ignores the authentication
880
+ in the spec for a single request.
881
+ Default is None
882
+ async_req (bool): execute request asynchronously
883
+
884
+ Returns:
885
+ None
886
+ If the method is called asynchronously, returns the request
887
+ thread.
888
+ """
889
+ kwargs['async_req'] = kwargs.get(
890
+ 'async_req', False
891
+ )
892
+ kwargs['_return_http_data_only'] = kwargs.get(
893
+ '_return_http_data_only', True
894
+ )
895
+ kwargs['_preload_content'] = kwargs.get(
896
+ '_preload_content', True
897
+ )
898
+ kwargs['_request_timeout'] = kwargs.get(
899
+ '_request_timeout', None
900
+ )
901
+ kwargs['_check_input_type'] = kwargs.get(
902
+ '_check_input_type', True
903
+ )
904
+ kwargs['_check_return_type'] = kwargs.get(
905
+ '_check_return_type', True
906
+ )
907
+ kwargs['_spec_property_naming'] = kwargs.get(
908
+ '_spec_property_naming', False
909
+ )
910
+ kwargs['_content_type'] = kwargs.get(
911
+ '_content_type')
912
+ kwargs['_host_index'] = kwargs.get('_host_index')
913
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
914
+ kwargs['audience_segment_id'] = \
915
+ audience_segment_id
916
+ return self.delete_contact_list_identifiers_endpoint.call_with_http_info(**kwargs)
917
+
918
+ def get_audience_segment_contact_list_statistics(
919
+ self,
920
+ account_id,
921
+ audience_segment_id,
922
+ **kwargs
923
+ ):
924
+ """get_audience_segment_contact_list_statistics # noqa: E501
925
+
926
+ Returns the statistics of a contact list segment. # noqa: E501
927
+ This method makes a synchronous HTTP request by default. To make an
928
+ asynchronous HTTP request, please pass async_req=True
929
+
930
+ >>> thread = api.get_audience_segment_contact_list_statistics(account_id, audience_segment_id, async_req=True)
931
+ >>> result = thread.get()
932
+
933
+ Args:
934
+ account_id (str): Account Id
935
+ audience_segment_id (str): Segment Id.
936
+
937
+ Keyword Args:
938
+ _return_http_data_only (bool): response data without head status
939
+ code and headers. Default is True.
940
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
941
+ will be returned without reading/decoding response data.
942
+ Default is True.
943
+ _request_timeout (int/float/tuple): timeout setting for this request. If
944
+ one number provided, it will be total request timeout. It can also
945
+ be a pair (tuple) of (connection, read) timeouts.
946
+ Default is None.
947
+ _check_input_type (bool): specifies if type checking
948
+ should be done one the data sent to the server.
949
+ Default is True.
950
+ _check_return_type (bool): specifies if type checking
951
+ should be done one the data received from the server.
952
+ Default is True.
953
+ _spec_property_naming (bool): True if the variable names in the input data
954
+ are serialized names, as specified in the OpenAPI document.
955
+ False if the variable names in the input data
956
+ are pythonic names, e.g. snake case (default)
957
+ _content_type (str/None): force body content-type.
958
+ Default is None and content-type will be predicted by allowed
959
+ content-types and body.
960
+ _host_index (int/None): specifies the index of the server
961
+ that we want to use.
962
+ Default is read from the configuration.
963
+ _request_auths (list): set to override the auth_settings for an a single
964
+ request; this effectively ignores the authentication
965
+ in the spec for a single request.
966
+ Default is None
967
+ async_req (bool): execute request asynchronously
968
+
969
+ Returns:
970
+ RmContactListStatisticsEntityV1Response
971
+ If the method is called asynchronously, returns the request
972
+ thread.
973
+ """
974
+ kwargs['async_req'] = kwargs.get(
975
+ 'async_req', False
976
+ )
977
+ kwargs['_return_http_data_only'] = kwargs.get(
978
+ '_return_http_data_only', True
979
+ )
980
+ kwargs['_preload_content'] = kwargs.get(
981
+ '_preload_content', True
982
+ )
983
+ kwargs['_request_timeout'] = kwargs.get(
984
+ '_request_timeout', None
985
+ )
986
+ kwargs['_check_input_type'] = kwargs.get(
987
+ '_check_input_type', True
988
+ )
989
+ kwargs['_check_return_type'] = kwargs.get(
990
+ '_check_return_type', True
991
+ )
992
+ kwargs['_spec_property_naming'] = kwargs.get(
993
+ '_spec_property_naming', False
994
+ )
995
+ kwargs['_content_type'] = kwargs.get(
996
+ '_content_type')
997
+ kwargs['_host_index'] = kwargs.get('_host_index')
998
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
999
+ kwargs['account_id'] = \
1000
+ account_id
1001
+ kwargs['audience_segment_id'] = \
1002
+ audience_segment_id
1003
+ return self.get_audience_segment_contact_list_statistics_endpoint.call_with_http_info(**kwargs)
1004
+
1005
+ def search_audience_segments(
1006
+ self,
1007
+ account_id,
1008
+ rm_audience_segment_search_input_v1,
1009
+ **kwargs
1010
+ ):
1011
+ """search_audience_segments # noqa: E501
1012
+
1013
+ Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied. # noqa: E501
1014
+ This method makes a synchronous HTTP request by default. To make an
1015
+ asynchronous HTTP request, please pass async_req=True
1016
+
1017
+ >>> thread = api.search_audience_segments(account_id, rm_audience_segment_search_input_v1, async_req=True)
1018
+ >>> result = thread.get()
1019
+
1020
+ Args:
1021
+ account_id (str): Account Id
1022
+ rm_audience_segment_search_input_v1 (RmAudienceSegmentSearchInputV1): Segment search filters.
1023
+
1024
+ Keyword Args:
1025
+ limit (int): The number of elements to be returned. The default is 50 and the maximum is 100.. [optional] if omitted the server will use the default value of 50
1026
+ offset (int): The (zero-based) offset into the collection. The default is 0.. [optional] if omitted the server will use the default value of 0
1027
+ _return_http_data_only (bool): response data without head status
1028
+ code and headers. Default is True.
1029
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1030
+ will be returned without reading/decoding response data.
1031
+ Default is True.
1032
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1033
+ one number provided, it will be total request timeout. It can also
1034
+ be a pair (tuple) of (connection, read) timeouts.
1035
+ Default is None.
1036
+ _check_input_type (bool): specifies if type checking
1037
+ should be done one the data sent to the server.
1038
+ Default is True.
1039
+ _check_return_type (bool): specifies if type checking
1040
+ should be done one the data received from the server.
1041
+ Default is True.
1042
+ _spec_property_naming (bool): True if the variable names in the input data
1043
+ are serialized names, as specified in the OpenAPI document.
1044
+ False if the variable names in the input data
1045
+ are pythonic names, e.g. snake case (default)
1046
+ _content_type (str/None): force body content-type.
1047
+ Default is None and content-type will be predicted by allowed
1048
+ content-types and body.
1049
+ _host_index (int/None): specifies the index of the server
1050
+ that we want to use.
1051
+ Default is read from the configuration.
1052
+ _request_auths (list): set to override the auth_settings for an a single
1053
+ request; this effectively ignores the authentication
1054
+ in the spec for a single request.
1055
+ Default is None
1056
+ async_req (bool): execute request asynchronously
1057
+
1058
+ Returns:
1059
+ RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse
1060
+ If the method is called asynchronously, returns the request
1061
+ thread.
1062
+ """
1063
+ kwargs['async_req'] = kwargs.get(
1064
+ 'async_req', False
1065
+ )
1066
+ kwargs['_return_http_data_only'] = kwargs.get(
1067
+ '_return_http_data_only', True
1068
+ )
1069
+ kwargs['_preload_content'] = kwargs.get(
1070
+ '_preload_content', True
1071
+ )
1072
+ kwargs['_request_timeout'] = kwargs.get(
1073
+ '_request_timeout', None
1074
+ )
1075
+ kwargs['_check_input_type'] = kwargs.get(
1076
+ '_check_input_type', True
1077
+ )
1078
+ kwargs['_check_return_type'] = kwargs.get(
1079
+ '_check_return_type', True
1080
+ )
1081
+ kwargs['_spec_property_naming'] = kwargs.get(
1082
+ '_spec_property_naming', False
1083
+ )
1084
+ kwargs['_content_type'] = kwargs.get(
1085
+ '_content_type')
1086
+ kwargs['_host_index'] = kwargs.get('_host_index')
1087
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1088
+ kwargs['account_id'] = \
1089
+ account_id
1090
+ kwargs['rm_audience_segment_search_input_v1'] = \
1091
+ rm_audience_segment_search_input_v1
1092
+ return self.search_audience_segments_endpoint.call_with_http_info(**kwargs)
1093
+
1094
+ def search_audiences(
1095
+ self,
1096
+ account_id,
1097
+ rm_audience_search_input_v1,
1098
+ **kwargs
1099
+ ):
1100
+ """search_audiences # noqa: E501
1101
+
1102
+ Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied. # noqa: E501
1103
+ This method makes a synchronous HTTP request by default. To make an
1104
+ asynchronous HTTP request, please pass async_req=True
1105
+
1106
+ >>> thread = api.search_audiences(account_id, rm_audience_search_input_v1, async_req=True)
1107
+ >>> result = thread.get()
1108
+
1109
+ Args:
1110
+ account_id (str): Account Id
1111
+ rm_audience_search_input_v1 (RmAudienceSearchInputV1): Audience search filters.
1112
+
1113
+ Keyword Args:
1114
+ limit (int): The number of elements to be returned. The default is 50 and the maximum is 100.. [optional] if omitted the server will use the default value of 50
1115
+ 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
1116
+ _return_http_data_only (bool): response data without head status
1117
+ code and headers. Default is True.
1118
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1119
+ will be returned without reading/decoding response data.
1120
+ Default is True.
1121
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1122
+ one number provided, it will be total request timeout. It can also
1123
+ be a pair (tuple) of (connection, read) timeouts.
1124
+ Default is None.
1125
+ _check_input_type (bool): specifies if type checking
1126
+ should be done one the data sent to the server.
1127
+ Default is True.
1128
+ _check_return_type (bool): specifies if type checking
1129
+ should be done one the data received from the server.
1130
+ Default is True.
1131
+ _spec_property_naming (bool): True if the variable names in the input data
1132
+ are serialized names, as specified in the OpenAPI document.
1133
+ False if the variable names in the input data
1134
+ are pythonic names, e.g. snake case (default)
1135
+ _content_type (str/None): force body content-type.
1136
+ Default is None and content-type will be predicted by allowed
1137
+ content-types and body.
1138
+ _host_index (int/None): specifies the index of the server
1139
+ that we want to use.
1140
+ Default is read from the configuration.
1141
+ _request_auths (list): set to override the auth_settings for an a single
1142
+ request; this effectively ignores the authentication
1143
+ in the spec for a single request.
1144
+ Default is None
1145
+ async_req (bool): execute request asynchronously
1146
+
1147
+ Returns:
1148
+ RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse
1149
+ If the method is called asynchronously, returns the request
1150
+ thread.
1151
+ """
1152
+ kwargs['async_req'] = kwargs.get(
1153
+ 'async_req', False
1154
+ )
1155
+ kwargs['_return_http_data_only'] = kwargs.get(
1156
+ '_return_http_data_only', True
1157
+ )
1158
+ kwargs['_preload_content'] = kwargs.get(
1159
+ '_preload_content', True
1160
+ )
1161
+ kwargs['_request_timeout'] = kwargs.get(
1162
+ '_request_timeout', None
1163
+ )
1164
+ kwargs['_check_input_type'] = kwargs.get(
1165
+ '_check_input_type', True
1166
+ )
1167
+ kwargs['_check_return_type'] = kwargs.get(
1168
+ '_check_return_type', True
1169
+ )
1170
+ kwargs['_spec_property_naming'] = kwargs.get(
1171
+ '_spec_property_naming', False
1172
+ )
1173
+ kwargs['_content_type'] = kwargs.get(
1174
+ '_content_type')
1175
+ kwargs['_host_index'] = kwargs.get('_host_index')
1176
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1177
+ kwargs['account_id'] = \
1178
+ account_id
1179
+ kwargs['rm_audience_search_input_v1'] = \
1180
+ rm_audience_search_input_v1
1181
+ return self.search_audiences_endpoint.call_with_http_info(**kwargs)
1182
+
1183
+ def update_contact_list_identifiers(
1184
+ self,
1185
+ audience_segment_id,
1186
+ retail_media_contactlist_amendment_request,
1187
+ **kwargs
1188
+ ):
1189
+ """update_contact_list_identifiers # noqa: E501
1190
+
1191
+ Add/remove identifiers to or from a retail-media contact list audience-segment, with external audience segment id. # noqa: E501
1192
+ This method makes a synchronous HTTP request by default. To make an
1193
+ asynchronous HTTP request, please pass async_req=True
1194
+
1195
+ >>> thread = api.update_contact_list_identifiers(audience_segment_id, retail_media_contactlist_amendment_request, async_req=True)
1196
+ >>> result = thread.get()
1197
+
1198
+ Args:
1199
+ audience_segment_id (int): The id of the contact list audience-segment to amend, we only accept external Id here
1200
+ retail_media_contactlist_amendment_request (RetailMediaContactlistAmendmentRequest):
1201
+
1202
+ Keyword Args:
1203
+ _return_http_data_only (bool): response data without head status
1204
+ code and headers. Default is True.
1205
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1206
+ will be returned without reading/decoding response data.
1207
+ Default is True.
1208
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1209
+ one number provided, it will be total request timeout. It can also
1210
+ be a pair (tuple) of (connection, read) timeouts.
1211
+ Default is None.
1212
+ _check_input_type (bool): specifies if type checking
1213
+ should be done one the data sent to the server.
1214
+ Default is True.
1215
+ _check_return_type (bool): specifies if type checking
1216
+ should be done one the data received from the server.
1217
+ Default is True.
1218
+ _spec_property_naming (bool): True if the variable names in the input data
1219
+ are serialized names, as specified in the OpenAPI document.
1220
+ False if the variable names in the input data
1221
+ are pythonic names, e.g. snake case (default)
1222
+ _content_type (str/None): force body content-type.
1223
+ Default is None and content-type will be predicted by allowed
1224
+ content-types and body.
1225
+ _host_index (int/None): specifies the index of the server
1226
+ that we want to use.
1227
+ Default is read from the configuration.
1228
+ _request_auths (list): set to override the auth_settings for an a single
1229
+ request; this effectively ignores the authentication
1230
+ in the spec for a single request.
1231
+ Default is None
1232
+ async_req (bool): execute request asynchronously
1233
+
1234
+ Returns:
1235
+ RetailMediaContactlistOperation
1236
+ If the method is called asynchronously, returns the request
1237
+ thread.
1238
+ """
1239
+ kwargs['async_req'] = kwargs.get(
1240
+ 'async_req', False
1241
+ )
1242
+ kwargs['_return_http_data_only'] = kwargs.get(
1243
+ '_return_http_data_only', True
1244
+ )
1245
+ kwargs['_preload_content'] = kwargs.get(
1246
+ '_preload_content', True
1247
+ )
1248
+ kwargs['_request_timeout'] = kwargs.get(
1249
+ '_request_timeout', None
1250
+ )
1251
+ kwargs['_check_input_type'] = kwargs.get(
1252
+ '_check_input_type', True
1253
+ )
1254
+ kwargs['_check_return_type'] = kwargs.get(
1255
+ '_check_return_type', True
1256
+ )
1257
+ kwargs['_spec_property_naming'] = kwargs.get(
1258
+ '_spec_property_naming', False
1259
+ )
1260
+ kwargs['_content_type'] = kwargs.get(
1261
+ '_content_type')
1262
+ kwargs['_host_index'] = kwargs.get('_host_index')
1263
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
1264
+ kwargs['audience_segment_id'] = \
1265
+ audience_segment_id
1266
+ kwargs['retail_media_contactlist_amendment_request'] = \
1267
+ retail_media_contactlist_amendment_request
1268
+ return self.update_contact_list_identifiers_endpoint.call_with_http_info(**kwargs)
1269
+