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
@@ -87,9 +87,9 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
87
87
  """
88
88
  lazy_import()
89
89
  return {
90
- 'name': (str, none_type,), # noqa: E501
90
+ 'name': (str,), # noqa: E501
91
+ 'retailer_id': (str,), # noqa: E501
91
92
  'description': (str, none_type,), # noqa: E501
92
- 'retailer_id': (str, none_type,), # noqa: E501
93
93
  'contact_list': (RmContactListCreateV1,), # noqa: E501
94
94
  }
95
95
 
@@ -100,8 +100,8 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
100
100
 
101
101
  attribute_map = {
102
102
  'name': 'name', # noqa: E501
103
- 'description': 'description', # noqa: E501
104
103
  'retailer_id': 'retailerId', # noqa: E501
104
+ 'description': 'description', # noqa: E501
105
105
  'contact_list': 'contactList', # noqa: E501
106
106
  }
107
107
 
@@ -112,9 +112,13 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
112
112
 
113
113
  @classmethod
114
114
  @convert_js_args_to_python_args
115
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
115
+ def _from_openapi_data(cls, name, retailer_id, *args, **kwargs): # noqa: E501
116
116
  """RmAudienceSegmentCreateEntityV1 - a model defined in OpenAPI
117
117
 
118
+ Args:
119
+ name (str): Name of the segment
120
+ retailer_id (str): Retailer associated to the segment
121
+
118
122
  Keyword Args:
119
123
  _check_type (bool): if True, values for parameters in openapi_types
120
124
  will be type checked and a TypeError will be
@@ -146,9 +150,7 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
146
150
  Animal class but this time we won't travel
147
151
  through its discriminator because we passed in
148
152
  _visited_composed_classes = (Animal,)
149
- name (str, none_type): Name of the segment. [optional] # noqa: E501
150
153
  description (str, none_type): Description of the segment. [optional] # noqa: E501
151
- retailer_id (str, none_type): Retailer associated to the segment. [optional] # noqa: E501
152
154
  contact_list (RmContactListCreateV1): [optional] # noqa: E501
153
155
  """
154
156
 
@@ -181,6 +183,8 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
181
183
  self._configuration = _configuration
182
184
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
183
185
 
186
+ self.name = name
187
+ self.retailer_id = retailer_id
184
188
  for var_name, var_value in kwargs.items():
185
189
  if var_name not in self.attribute_map and \
186
190
  self._configuration is not None and \
@@ -201,9 +205,13 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
201
205
  ])
202
206
 
203
207
  @convert_js_args_to_python_args
204
- def __init__(self, *args, **kwargs): # noqa: E501
208
+ def __init__(self, name, retailer_id, *args, **kwargs): # noqa: E501
205
209
  """RmAudienceSegmentCreateEntityV1 - a model defined in OpenAPI
206
210
 
211
+ Args:
212
+ name (str): Name of the segment
213
+ retailer_id (str): Retailer associated to the segment
214
+
207
215
  Keyword Args:
208
216
  _check_type (bool): if True, values for parameters in openapi_types
209
217
  will be type checked and a TypeError will be
@@ -235,9 +243,7 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
235
243
  Animal class but this time we won't travel
236
244
  through its discriminator because we passed in
237
245
  _visited_composed_classes = (Animal,)
238
- name (str, none_type): Name of the segment. [optional] # noqa: E501
239
246
  description (str, none_type): Description of the segment. [optional] # noqa: E501
240
- retailer_id (str, none_type): Retailer associated to the segment. [optional] # noqa: E501
241
247
  contact_list (RmContactListCreateV1): [optional] # noqa: E501
242
248
  """
243
249
 
@@ -268,6 +274,8 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
268
274
  self._configuration = _configuration
269
275
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
270
276
 
277
+ self.name = name
278
+ self.retailer_id = retailer_id
271
279
  for var_name, var_value in kwargs.items():
272
280
  if var_name not in self.attribute_map and \
273
281
  self._configuration is not None and \
@@ -31,9 +31,9 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
31
31
 
32
32
  def lazy_import():
33
33
  from criteo_api_retailmedia_preview.model.rm_contact_list_v1 import RmContactListV1
34
- from criteo_api_retailmedia_preview.model.rm_user_behavior_v1 import RmUserBehaviorV1
34
+ from criteo_api_retailmedia_preview.model.rm_events_v1 import RmEventsV1
35
35
  globals()['RmContactListV1'] = RmContactListV1
36
- globals()['RmUserBehaviorV1'] = RmUserBehaviorV1
36
+ globals()['RmEventsV1'] = RmEventsV1
37
37
 
38
38
 
39
39
  class RmAudienceSegmentEntityV1(ModelNormal):
@@ -65,7 +65,7 @@ class RmAudienceSegmentEntityV1(ModelNormal):
65
65
  'None': None,
66
66
  'UNKNOWN': "Unknown",
67
67
  'CONTACTLIST': "ContactList",
68
- 'USERBEHAVIOR': "UserBehavior",
68
+ 'EVENTS': "Events",
69
69
  },
70
70
  ('channels',): {
71
71
  'None': None,
@@ -110,7 +110,7 @@ class RmAudienceSegmentEntityV1(ModelNormal):
110
110
  'updated_at': (datetime, none_type,), # noqa: E501
111
111
  'created_by_id': (str, none_type,), # noqa: E501
112
112
  'contact_list': (RmContactListV1,), # noqa: E501
113
- 'user_behavior': (RmUserBehaviorV1,), # noqa: E501
113
+ 'events': (RmEventsV1,), # noqa: E501
114
114
  'channels': ([str], none_type,), # noqa: E501
115
115
  }
116
116
 
@@ -129,7 +129,7 @@ class RmAudienceSegmentEntityV1(ModelNormal):
129
129
  'updated_at': 'updatedAt', # noqa: E501
130
130
  'created_by_id': 'createdById', # noqa: E501
131
131
  'contact_list': 'contactList', # noqa: E501
132
- 'user_behavior': 'userBehavior', # noqa: E501
132
+ 'events': 'events', # noqa: E501
133
133
  'channels': 'channels', # noqa: E501
134
134
  }
135
135
 
@@ -183,7 +183,7 @@ class RmAudienceSegmentEntityV1(ModelNormal):
183
183
  updated_at (datetime, none_type): ISO-8601 timestamp in UTC of segment update (read-only). [optional] # noqa: E501
184
184
  created_by_id (str, none_type): User that created the segment. [optional] # noqa: E501
185
185
  contact_list (RmContactListV1): [optional] # noqa: E501
186
- user_behavior (RmUserBehaviorV1): [optional] # noqa: E501
186
+ events (RmEventsV1): [optional] # noqa: E501
187
187
  channels ([str], none_type): Channels associated to the segment (read-only). [optional] # noqa: E501
188
188
  """
189
189
 
@@ -279,7 +279,7 @@ class RmAudienceSegmentEntityV1(ModelNormal):
279
279
  updated_at (datetime, none_type): ISO-8601 timestamp in UTC of segment update (read-only). [optional] # noqa: E501
280
280
  created_by_id (str, none_type): User that created the segment. [optional] # noqa: E501
281
281
  contact_list (RmContactListV1): [optional] # noqa: E501
282
- user_behavior (RmUserBehaviorV1): [optional] # noqa: E501
282
+ events (RmEventsV1): [optional] # noqa: E501
283
283
  channels ([str], none_type): Channels associated to the segment (read-only). [optional] # noqa: E501
284
284
  """
285
285
 
@@ -59,7 +59,7 @@ class RmAudienceSegmentSearchEntityV1(ModelNormal):
59
59
  'None': None,
60
60
  'UNKNOWN': "Unknown",
61
61
  'CONTACTLIST': "ContactList",
62
- 'USERBEHAVIOR': "UserBehavior",
62
+ 'EVENTS': "Events",
63
63
  },
64
64
  }
65
65
 
@@ -55,7 +55,7 @@ class RmContactListV1(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
- ('type',): {
58
+ ('identifier_type',): {
59
59
  'None': None,
60
60
  'UNKNOWN': "Unknown",
61
61
  'EMAIL': "Email",
@@ -97,7 +97,7 @@ class RmContactListV1(ModelNormal):
97
97
  """
98
98
  return {
99
99
  'is_read_only': (bool, none_type,), # noqa: E501
100
- 'type': (str, none_type,), # noqa: E501
100
+ 'identifier_type': (str, none_type,), # noqa: E501
101
101
  'sharing_status': (str, none_type,), # noqa: E501
102
102
  }
103
103
 
@@ -108,7 +108,7 @@ class RmContactListV1(ModelNormal):
108
108
 
109
109
  attribute_map = {
110
110
  'is_read_only': 'isReadOnly', # noqa: E501
111
- 'type': 'type', # noqa: E501
111
+ 'identifier_type': 'identifierType', # noqa: E501
112
112
  'sharing_status': 'sharingStatus', # noqa: E501
113
113
  }
114
114
 
@@ -154,7 +154,7 @@ class RmContactListV1(ModelNormal):
154
154
  through its discriminator because we passed in
155
155
  _visited_composed_classes = (Animal,)
156
156
  is_read_only (bool, none_type): Is the segment read-only. [optional] # noqa: E501
157
- type (str, none_type): Indicates contact list type. [optional] # noqa: E501
157
+ identifier_type (str, none_type): Indicates contact list identifier's type. [optional] # noqa: E501
158
158
  sharing_status (str, none_type): Indicates if the contact list is shared with other accounts. [optional] # noqa: E501
159
159
  """
160
160
 
@@ -242,7 +242,7 @@ class RmContactListV1(ModelNormal):
242
242
  through its discriminator because we passed in
243
243
  _visited_composed_classes = (Animal,)
244
244
  is_read_only (bool, none_type): Is the segment read-only. [optional] # noqa: E501
245
- type (str, none_type): Indicates contact list type. [optional] # noqa: E501
245
+ identifier_type (str, none_type): Indicates contact list identifier's type. [optional] # noqa: E501
246
246
  sharing_status (str, none_type): Indicates if the contact list is shared with other accounts. [optional] # noqa: E501
247
247
  """
248
248
 
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class RmUserBehaviorV1(ModelNormal):
33
+ class RmEventsV1(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -131,7 +131,7 @@ class RmUserBehaviorV1(ModelNormal):
131
131
  @classmethod
132
132
  @convert_js_args_to_python_args
133
133
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
134
- """RmUserBehaviorV1 - a model defined in OpenAPI
134
+ """RmEventsV1 - a model defined in OpenAPI
135
135
 
136
136
  Keyword Args:
137
137
  _check_type (bool): if True, values for parameters in openapi_types
@@ -222,7 +222,7 @@ class RmUserBehaviorV1(ModelNormal):
222
222
 
223
223
  @convert_js_args_to_python_args
224
224
  def __init__(self, *args, **kwargs): # noqa: E501
225
- """RmUserBehaviorV1 - a model defined in OpenAPI
225
+ """RmEventsV1 - a model defined in OpenAPI
226
226
 
227
227
  Keyword Args:
228
228
  _check_type (bool): if True, values for parameters in openapi_types
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class RetailMediaAccount(ModelNormal):
33
+ class SdkApiRestCommonProblem(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -57,15 +57,14 @@ class RetailMediaAccount(ModelNormal):
57
57
  allowed_values = {
58
58
  ('type',): {
59
59
  'None': None,
60
- 'UNKNOWN': "Unknown",
61
- 'SUPPLY': "Supply",
62
- 'DEMAND': "Demand",
63
- },
64
- ('sub_type',): {
65
- 'None': None,
66
- 'UNKNOWN': "Unknown",
67
- 'BRAND': "Brand",
68
- 'SELLER': "Seller",
60
+ 'UNKNOWN': "unknown",
61
+ 'ACCESS-CONTROL': "access-control",
62
+ 'AUTHENTICATION': "authentication",
63
+ 'AUTHORIZATION': "authorization",
64
+ 'AVAILABILITY': "availability",
65
+ 'DEPRECATION': "deprecation",
66
+ 'QUOTA': "quota",
67
+ 'VALIDATION': "validation",
69
68
  },
70
69
  }
71
70
 
@@ -87,14 +86,14 @@ class RetailMediaAccount(ModelNormal):
87
86
  and the value is attribute type.
88
87
  """
89
88
  return {
90
- 'name': (str, none_type,), # noqa: E501
91
- 'company_name': (str, none_type,), # noqa: E501
89
+ 'trace_id': (str, none_type,), # noqa: E501
92
90
  'type': (str, none_type,), # noqa: E501
93
- 'sub_type': (str, none_type,), # noqa: E501
94
- 'country_ids': ([str], none_type,), # noqa: E501
95
- 'currency_id': (str, none_type,), # noqa: E501
96
- 'parent_account_label': (str, none_type,), # noqa: E501
97
- 'time_zone': (str, none_type,), # noqa: E501
91
+ 'code': (str, none_type,), # noqa: E501
92
+ 'instance': (str, none_type,), # noqa: E501
93
+ 'title': (str, none_type,), # noqa: E501
94
+ 'detail': (str, none_type,), # noqa: E501
95
+ 'source': ({str: (str,)}, none_type,), # noqa: E501
96
+ 'stack_trace': (str, none_type,), # noqa: E501
98
97
  }
99
98
 
100
99
  @cached_property
@@ -103,14 +102,14 @@ class RetailMediaAccount(ModelNormal):
103
102
 
104
103
 
105
104
  attribute_map = {
106
- 'name': 'name', # noqa: E501
107
- 'company_name': 'companyName', # noqa: E501
105
+ 'trace_id': 'traceId', # noqa: E501
108
106
  'type': 'type', # noqa: E501
109
- 'sub_type': 'subType', # noqa: E501
110
- 'country_ids': 'countryIds', # noqa: E501
111
- 'currency_id': 'currencyId', # noqa: E501
112
- 'parent_account_label': 'parentAccountLabel', # noqa: E501
113
- 'time_zone': 'timeZone', # noqa: E501
107
+ 'code': 'code', # noqa: E501
108
+ 'instance': 'instance', # noqa: E501
109
+ 'title': 'title', # noqa: E501
110
+ 'detail': 'detail', # noqa: E501
111
+ 'source': 'source', # noqa: E501
112
+ 'stack_trace': 'stackTrace', # noqa: E501
114
113
  }
115
114
 
116
115
  read_only_vars = {
@@ -121,7 +120,7 @@ class RetailMediaAccount(ModelNormal):
121
120
  @classmethod
122
121
  @convert_js_args_to_python_args
123
122
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
124
- """RetailMediaAccount - a model defined in OpenAPI
123
+ """SdkApiRestCommonProblem - a model defined in OpenAPI
125
124
 
126
125
  Keyword Args:
127
126
  _check_type (bool): if True, values for parameters in openapi_types
@@ -154,14 +153,14 @@ class RetailMediaAccount(ModelNormal):
154
153
  Animal class but this time we won't travel
155
154
  through its discriminator because we passed in
156
155
  _visited_composed_classes = (Animal,)
157
- name (str, none_type): account name. [optional] # noqa: E501
158
- company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501
159
- type (str, none_type): Type for the account. [optional] # noqa: E501
160
- sub_type (str, none_type): subtype for the account. [optional] # noqa: E501
161
- country_ids ([str], none_type): list of countries associated with the account. [optional] # noqa: E501
162
- currency_id (str, none_type): the currency for the account. [optional] # noqa: E501
163
- parent_account_label (str, none_type): parent account label for the account. [optional] # noqa: E501
164
- time_zone (str, none_type): the timezone for the account. [optional] # noqa: E501
156
+ trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501
157
+ type (str, none_type): The problem's category.. [optional] # noqa: E501
158
+ code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501
159
+ instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501
160
+ title (str, none_type): A short human-readable description of the problem type.. [optional] # noqa: E501
161
+ detail (str, none_type): A human-readable explanation specific to this occurrence of the problem.. [optional] # noqa: E501
162
+ source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s).. [optional] # noqa: E501
163
+ stack_trace (str, none_type): . [optional] # noqa: E501
165
164
  """
166
165
 
167
166
  _check_type = kwargs.pop('_check_type', True)
@@ -214,7 +213,7 @@ class RetailMediaAccount(ModelNormal):
214
213
 
215
214
  @convert_js_args_to_python_args
216
215
  def __init__(self, *args, **kwargs): # noqa: E501
217
- """RetailMediaAccount - a model defined in OpenAPI
216
+ """SdkApiRestCommonProblem - a model defined in OpenAPI
218
217
 
219
218
  Keyword Args:
220
219
  _check_type (bool): if True, values for parameters in openapi_types
@@ -247,14 +246,14 @@ class RetailMediaAccount(ModelNormal):
247
246
  Animal class but this time we won't travel
248
247
  through its discriminator because we passed in
249
248
  _visited_composed_classes = (Animal,)
250
- name (str, none_type): account name. [optional] # noqa: E501
251
- company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501
252
- type (str, none_type): Type for the account. [optional] # noqa: E501
253
- sub_type (str, none_type): subtype for the account. [optional] # noqa: E501
254
- country_ids ([str], none_type): list of countries associated with the account. [optional] # noqa: E501
255
- currency_id (str, none_type): the currency for the account. [optional] # noqa: E501
256
- parent_account_label (str, none_type): parent account label for the account. [optional] # noqa: E501
257
- time_zone (str, none_type): the timezone for the account. [optional] # noqa: E501
249
+ trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501
250
+ type (str, none_type): The problem's category.. [optional] # noqa: E501
251
+ code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501
252
+ instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501
253
+ title (str, none_type): A short human-readable description of the problem type.. [optional] # noqa: E501
254
+ detail (str, none_type): A human-readable explanation specific to this occurrence of the problem.. [optional] # noqa: E501
255
+ source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s).. [optional] # noqa: E501
256
+ stack_trace (str, none_type): . [optional] # noqa: E501
258
257
  """
259
258
 
260
259
  _check_type = kwargs.pop('_check_type', True)
@@ -73,7 +73,7 @@ class SellerCatalogRequest(ModelNormal):
73
73
  lazy_import()
74
74
  return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
75
75
 
76
- _nullable = False
76
+ _nullable = True
77
77
 
78
78
  @cached_property
79
79
  def openapi_types():
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class SkuSearchRequestBody(ModelNormal):
33
+ class SellerSearch(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -55,17 +55,12 @@ class SkuSearchRequestBody(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
- ('product_id_type',): {
59
- 'SKUKEY': "SkuKey",
60
- 'GTIN': "Gtin",
61
- 'MPN': "Mpn",
62
- 'MODEL': "Model",
63
- 'SKUID': "SkuId",
64
- 'PARENTID': "ParentId",
65
- },
66
58
  }
67
59
 
68
60
  validations = {
61
+ ('account_ids',): {
62
+ 'max_items': 25,
63
+ },
69
64
  }
70
65
 
71
66
  additional_properties_type = None
@@ -83,8 +78,8 @@ class SkuSearchRequestBody(ModelNormal):
83
78
  and the value is attribute type.
84
79
  """
85
80
  return {
86
- 'product_id_type': (str,), # noqa: E501
87
- 'query_ids': ([str],), # noqa: E501
81
+ 'account_ids': ([str],), # noqa: E501
82
+ 'include_details': (bool, none_type,), # noqa: E501
88
83
  }
89
84
 
90
85
  @cached_property
@@ -93,8 +88,8 @@ class SkuSearchRequestBody(ModelNormal):
93
88
 
94
89
 
95
90
  attribute_map = {
96
- 'product_id_type': 'productIdType', # noqa: E501
97
- 'query_ids': 'queryIds', # noqa: E501
91
+ 'account_ids': 'accountIds', # noqa: E501
92
+ 'include_details': 'includeDetails', # noqa: E501
98
93
  }
99
94
 
100
95
  read_only_vars = {
@@ -104,12 +99,11 @@ class SkuSearchRequestBody(ModelNormal):
104
99
 
105
100
  @classmethod
106
101
  @convert_js_args_to_python_args
107
- def _from_openapi_data(cls, product_id_type, query_ids, *args, **kwargs): # noqa: E501
108
- """SkuSearchRequestBody - a model defined in OpenAPI
102
+ def _from_openapi_data(cls, account_ids, *args, **kwargs): # noqa: E501
103
+ """SellerSearch - a model defined in OpenAPI
109
104
 
110
105
  Args:
111
- product_id_type (str): sets which product id the QueryIds will be compared to
112
- query_ids ([str]): list of product ids to search for
106
+ account_ids ([str]): list of accounts to return seller information for. max length of 25
113
107
 
114
108
  Keyword Args:
115
109
  _check_type (bool): if True, values for parameters in openapi_types
@@ -142,6 +136,7 @@ class SkuSearchRequestBody(ModelNormal):
142
136
  Animal class but this time we won't travel
143
137
  through its discriminator because we passed in
144
138
  _visited_composed_classes = (Animal,)
139
+ include_details (bool, none_type): whether to include additional fields beyond the sellerId and retailerId in the response. May improve performance when set to false.. [optional] if omitted the server will use the default value of False # noqa: E501
145
140
  """
146
141
 
147
142
  _check_type = kwargs.pop('_check_type', True)
@@ -173,8 +168,7 @@ class SkuSearchRequestBody(ModelNormal):
173
168
  self._configuration = _configuration
174
169
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
175
170
 
176
- self.product_id_type = product_id_type
177
- self.query_ids = query_ids
171
+ self.account_ids = account_ids
178
172
  for var_name, var_value in kwargs.items():
179
173
  if var_name not in self.attribute_map and \
180
174
  self._configuration is not None and \
@@ -195,12 +189,11 @@ class SkuSearchRequestBody(ModelNormal):
195
189
  ])
196
190
 
197
191
  @convert_js_args_to_python_args
198
- def __init__(self, product_id_type, query_ids, *args, **kwargs): # noqa: E501
199
- """SkuSearchRequestBody - a model defined in OpenAPI
192
+ def __init__(self, account_ids, *args, **kwargs): # noqa: E501
193
+ """SellerSearch - a model defined in OpenAPI
200
194
 
201
195
  Args:
202
- product_id_type (str): sets which product id the QueryIds will be compared to
203
- query_ids ([str]): list of product ids to search for
196
+ account_ids ([str]): list of accounts to return seller information for. max length of 25
204
197
 
205
198
  Keyword Args:
206
199
  _check_type (bool): if True, values for parameters in openapi_types
@@ -233,6 +226,7 @@ class SkuSearchRequestBody(ModelNormal):
233
226
  Animal class but this time we won't travel
234
227
  through its discriminator because we passed in
235
228
  _visited_composed_classes = (Animal,)
229
+ include_details (bool, none_type): whether to include additional fields beyond the sellerId and retailerId in the response. May improve performance when set to false.. [optional] if omitted the server will use the default value of False # noqa: E501
236
230
  """
237
231
 
238
232
  _check_type = kwargs.pop('_check_type', True)
@@ -262,8 +256,7 @@ class SkuSearchRequestBody(ModelNormal):
262
256
  self._configuration = _configuration
263
257
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
264
258
 
265
- self.product_id_type = product_id_type
266
- self.query_ids = query_ids
259
+ self.account_ids = account_ids
267
260
  for var_name, var_value in kwargs.items():
268
261
  if var_name not in self.attribute_map and \
269
262
  self._configuration is not None and \
@@ -107,18 +107,18 @@ class SkuDataPreview(ModelNormal):
107
107
  'is_in_stock': (bool,), # noqa: E501
108
108
  'updated_at': (datetime,), # noqa: E501
109
109
  'name': (str,), # noqa: E501
110
- 'description': (str,), # noqa: E501
111
- 'category': (str,), # noqa: E501
110
+ 'description': (str, none_type,), # noqa: E501
111
+ 'category': (str, none_type,), # noqa: E501
112
112
  'is_seller_sku': (bool,), # noqa: E501
113
113
  'is_buybox': (bool,), # noqa: E501
114
- 'seller_id': (str,), # noqa: E501
115
- 'seller_name': (str,), # noqa: E501
116
- 'gtin': (str,), # noqa: E501
117
- 'mpn': (str,), # noqa: E501
118
- 'model_number': (str,), # noqa: E501
119
- 'parent_id': (str,), # noqa: E501
114
+ 'seller_id': (str, none_type,), # noqa: E501
115
+ 'seller_name': (str, none_type,), # noqa: E501
116
+ 'gtin': (str, none_type,), # noqa: E501
117
+ 'mpn': (str, none_type,), # noqa: E501
118
+ 'model_number': (str, none_type,), # noqa: E501
119
+ 'parent_id': (str, none_type,), # noqa: E501
120
120
  'image_url': (str,), # noqa: E501
121
- 'product_page': (str,), # noqa: E501
121
+ 'product_page': (str, none_type,), # noqa: E501
122
122
  }
123
123
 
124
124
  @cached_property
@@ -204,18 +204,18 @@ class SkuDataPreview(ModelNormal):
204
204
  through its discriminator because we passed in
205
205
  _visited_composed_classes = (Animal,)
206
206
  name (str): A short product name.. [optional] # noqa: E501
207
- description (str): A product description.. [optional] # noqa: E501
208
- category (str): The full category breadcrumb in the retailers catalog.. [optional] # noqa: E501
207
+ description (str, none_type): A product description.. [optional] # noqa: E501
208
+ category (str, none_type): The full category breadcrumb in the retailers catalog.. [optional] # noqa: E501
209
209
  is_seller_sku (bool): An indication of if the sku is seller sku.. [optional] # noqa: E501
210
210
  is_buybox (bool): Whether the Sku is a Buybox Winner.. [optional] # noqa: E501
211
- seller_id (str): The id of the seller.. [optional] # noqa: E501
212
- seller_name (str): The name of the seller.. [optional] # noqa: E501
213
- gtin (str): A GTIN identifier for the product if available. Covers variations such as EANs and UPCs.. [optional] # noqa: E501
214
- mpn (str): The MPN for the product if available.. [optional] # noqa: E501
215
- model_number (str): The Model Number for the product if available.. [optional] # noqa: E501
216
- parent_id (str): The ParentId for the product if available.. [optional] # noqa: E501
211
+ seller_id (str, none_type): The id of the seller.. [optional] # noqa: E501
212
+ seller_name (str, none_type): The name of the seller.. [optional] # noqa: E501
213
+ gtin (str, none_type): A GTIN identifier for the product if available. Covers variations such as EANs and UPCs.. [optional] # noqa: E501
214
+ mpn (str, none_type): The MPN for the product if available.. [optional] # noqa: E501
215
+ model_number (str, none_type): The Model Number for the product if available.. [optional] # noqa: E501
216
+ parent_id (str, none_type): The ParentId for the product if available.. [optional] # noqa: E501
217
217
  image_url (str): An http image resource provided by the retailer.. [optional] # noqa: E501
218
- product_page (str): An The product page URL. [optional] # noqa: E501
218
+ product_page (str, none_type): The product page URL. [optional] # noqa: E501
219
219
  """
220
220
 
221
221
  _check_type = kwargs.pop('_check_type', True)
@@ -322,18 +322,18 @@ class SkuDataPreview(ModelNormal):
322
322
  through its discriminator because we passed in
323
323
  _visited_composed_classes = (Animal,)
324
324
  name (str): A short product name.. [optional] # noqa: E501
325
- description (str): A product description.. [optional] # noqa: E501
326
- category (str): The full category breadcrumb in the retailers catalog.. [optional] # noqa: E501
325
+ description (str, none_type): A product description.. [optional] # noqa: E501
326
+ category (str, none_type): The full category breadcrumb in the retailers catalog.. [optional] # noqa: E501
327
327
  is_seller_sku (bool): An indication of if the sku is seller sku.. [optional] # noqa: E501
328
328
  is_buybox (bool): Whether the Sku is a Buybox Winner.. [optional] # noqa: E501
329
- seller_id (str): The id of the seller.. [optional] # noqa: E501
330
- seller_name (str): The name of the seller.. [optional] # noqa: E501
331
- gtin (str): A GTIN identifier for the product if available. Covers variations such as EANs and UPCs.. [optional] # noqa: E501
332
- mpn (str): The MPN for the product if available.. [optional] # noqa: E501
333
- model_number (str): The Model Number for the product if available.. [optional] # noqa: E501
334
- parent_id (str): The ParentId for the product if available.. [optional] # noqa: E501
329
+ seller_id (str, none_type): The id of the seller.. [optional] # noqa: E501
330
+ seller_name (str, none_type): The name of the seller.. [optional] # noqa: E501
331
+ gtin (str, none_type): A GTIN identifier for the product if available. Covers variations such as EANs and UPCs.. [optional] # noqa: E501
332
+ mpn (str, none_type): The MPN for the product if available.. [optional] # noqa: E501
333
+ model_number (str, none_type): The Model Number for the product if available.. [optional] # noqa: E501
334
+ parent_id (str, none_type): The ParentId for the product if available.. [optional] # noqa: E501
335
335
  image_url (str): An http image resource provided by the retailer.. [optional] # noqa: E501
336
- product_page (str): An The product page URL. [optional] # noqa: E501
336
+ product_page (str, none_type): The product page URL. [optional] # noqa: E501
337
337
  """
338
338
 
339
339
  _check_type = kwargs.pop('_check_type', True)