criteo-api-retailmedia-sdk 0.0.240207__py3-none-any.whl → 0.0.240515__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 (131) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +181 -35
  3. criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
  4. criteo_api_retailmedia_preview/api/audience_api.py +284 -0
  5. criteo_api_retailmedia_preview/api/campaign_api.py +1678 -902
  6. criteo_api_retailmedia_preview/api/catalog_api.py +312 -0
  7. criteo_api_retailmedia_preview/api_client.py +4 -4
  8. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  9. criteo_api_retailmedia_preview/configuration.py +1 -1
  10. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keyword_model.py → add_remove_keyword_model.py} +12 -19
  11. criteo_api_retailmedia_preview/model/add_remove_keywords_model.py +262 -0
  12. criteo_api_retailmedia_preview/model/add_remove_keywords_model_request.py +262 -0
  13. criteo_api_retailmedia_preview/model/add_remove_keywords_model_resource.py +270 -0
  14. criteo_api_retailmedia_preview/model/approval_status_model.py +292 -0
  15. criteo_api_retailmedia_preview/model/async_accounts_report.py +421 -0
  16. criteo_api_retailmedia_preview/model/{external_catalog_request_preview.py → async_accounts_report_request.py} +13 -10
  17. criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +273 -0
  18. criteo_api_retailmedia_preview/model/async_campaigns_report.py +74 -59
  19. criteo_api_retailmedia_preview/model/async_line_items_report.py +74 -60
  20. criteo_api_retailmedia_preview/model/audience_error.py +310 -0
  21. criteo_api_retailmedia_preview/model/{template_variable.py → audience_warning.py} +48 -46
  22. criteo_api_retailmedia_preview/model/{hyperlink_variable_value.py → batch_accepted_response.py} +11 -11
  23. criteo_api_retailmedia_preview/model/change_details.py +275 -0
  24. criteo_api_retailmedia_preview/model/{creative202210_list_response.py → creative_v2_list_response.py} +16 -16
  25. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_int64.py → creative_v2_response.py} +16 -9
  26. criteo_api_retailmedia_preview/model/custom_attribute.py +275 -0
  27. criteo_api_retailmedia_preview/model/error_code_response.py +281 -0
  28. criteo_api_retailmedia_preview/model/export_report_column.py +2 -2
  29. criteo_api_retailmedia_preview/model/{choice_variable_value.py → external_choice_variable_value.py} +3 -3
  30. criteo_api_retailmedia_preview/model/{color_variable_value.py → external_color_variable_value.py} +8 -14
  31. criteo_api_retailmedia_preview/model/{creative_update_model202207.py → external_creative_create_model_v2.py} +11 -11
  32. criteo_api_retailmedia_preview/model/{creative_create_model202207.py → external_creative_update_model_v2.py} +11 -11
  33. criteo_api_retailmedia_preview/model/{creative202210.py → external_creative_v2.py} +34 -28
  34. criteo_api_retailmedia_preview/model/{files_variable_value.py → external_files_variable_value.py} +4 -3
  35. criteo_api_retailmedia_preview/model/{text_variable_specification.py → external_hyperlink_variable_value.py} +7 -7
  36. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers.py → external_line_item_bid_multipliers_v2.py} +41 -29
  37. criteo_api_retailmedia_preview/model/external_line_item_capping_v2.py +280 -0
  38. criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py +273 -0
  39. criteo_api_retailmedia_preview/model/{choice_variable_specification.py → external_line_item_page_v2.py} +36 -21
  40. criteo_api_retailmedia_preview/model/{page_type_environment.py → external_page_type_environment.py} +15 -9
  41. criteo_api_retailmedia_preview/model/external_preferred_line_item_create_model_v2.py +345 -0
  42. criteo_api_retailmedia_preview/model/{external_catalog_status.py → external_preferred_line_item_update_model_v2.py} +70 -47
  43. criteo_api_retailmedia_preview/model/{template.py → external_preferred_line_item_v2.py} +93 -70
  44. criteo_api_retailmedia_preview/model/{template_variable_value.py → external_template_variable_value.py} +36 -30
  45. criteo_api_retailmedia_preview/model/{text_variable_value.py → external_text_variable_value.py} +8 -14
  46. criteo_api_retailmedia_preview/model/external_video_variable_value.py +293 -0
  47. criteo_api_retailmedia_preview/model/{choice_option.py → fail_response.py} +21 -19
  48. criteo_api_retailmedia_preview/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} +4 -16
  49. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model.py → input_resource_of_preferred_line_item_create_model_v2.py} +13 -11
  50. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture.py +303 -0
  51. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model.py → installment.py} +13 -11
  52. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py → json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py} +8 -8
  53. criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers.py → json_api_single_response_of_line_item_bid_multipliers_v2.py} +14 -14
  54. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} +19 -37
  55. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model.py → keywords_model.py} +9 -18
  56. criteo_api_retailmedia_preview/model/keywords_model_resource.py +270 -0
  57. criteo_api_retailmedia_preview/model/keywords_model_response.py +274 -0
  58. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_request.py → line_item_bid_multipliers_v2_request.py} +8 -8
  59. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_response.py → line_item_bid_multipliers_v2_response.py} +16 -16
  60. criteo_api_retailmedia_preview/model/line_item_product_status.py +291 -0
  61. criteo_api_retailmedia_preview/model/loyalty_points.py +271 -0
  62. criteo_api_retailmedia_preview/model/match_type_model.py +291 -0
  63. criteo_api_retailmedia_preview/model/metadata.py +273 -0
  64. criteo_api_retailmedia_preview/model/negotiation_state_model.py +293 -0
  65. criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py +276 -0
  66. criteo_api_retailmedia_preview/model/{json_api_request_of_catalog_request_preview.py → preferred_line_item_create_model_v2_request.py} +8 -8
  67. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model_request.py → preferred_line_item_update_model_v2_request.py} +8 -8
  68. criteo_api_retailmedia_preview/model/{creative202210_response.py → preferred_line_item_v2_paged_list_response.py} +22 -16
  69. criteo_api_retailmedia_preview/model/{template_response.py → preferred_line_item_v2_response.py} +16 -16
  70. criteo_api_retailmedia_preview/model/price.py +267 -0
  71. criteo_api_retailmedia_preview/model/product.py +626 -0
  72. criteo_api_retailmedia_preview/model/product_importer_error.py +299 -0
  73. criteo_api_retailmedia_preview/model/product_importer_warning.py +299 -0
  74. criteo_api_retailmedia_preview/model/product_metadata.py +269 -0
  75. criteo_api_retailmedia_preview/model/product_resource_outcome.py +266 -0
  76. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model_response.py → product_shipping.py} +33 -25
  77. criteo_api_retailmedia_preview/model/product_shipping_dimension.py +267 -0
  78. criteo_api_retailmedia_preview/model/product_shipping_weight.py +267 -0
  79. criteo_api_retailmedia_preview/model/product_tax.py +283 -0
  80. criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py +267 -0
  81. criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py +267 -0
  82. criteo_api_retailmedia_preview/model/{section.py → products_custom_batch_request.py} +13 -19
  83. criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py +305 -0
  84. criteo_api_retailmedia_preview/model/promoted_product.py +270 -0
  85. criteo_api_retailmedia_preview/model/promoted_product_resource.py +270 -0
  86. criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.py +262 -0
  87. criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py +278 -0
  88. criteo_api_retailmedia_preview/model/{retail_media_externalv1_proposal_status_model.py → proposal_status_model.py} +22 -50
  89. criteo_api_retailmedia_preview/model/proposal_status_model_resource.py +270 -0
  90. criteo_api_retailmedia_preview/model/{template_list_response.py → proposal_status_model_response.py} +20 -27
  91. criteo_api_retailmedia_preview/model/report_detail_error.py +299 -0
  92. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model_request.py → report_detail_errors.py} +23 -11
  93. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model_resource.py → report_ok_response.py} +56 -21
  94. criteo_api_retailmedia_preview/model/{resource_of_creative202210.py → resource_of_creative_v2.py} +8 -8
  95. criteo_api_retailmedia_preview/model/{resource_of_template.py → resource_of_line_item_bid_multipliers_v2.py} +8 -8
  96. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model_resource.py → resource_of_preferred_line_item_update_model_v2.py} +16 -22
  97. criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers.py → resource_of_preferred_line_item_v2.py} +9 -9
  98. criteo_api_retailmedia_preview/model/resource_outcome.py +268 -0
  99. criteo_api_retailmedia_preview/model/retail_media_account.py +6 -6
  100. criteo_api_retailmedia_preview/model/retail_media_brands.py +257 -0
  101. criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py → retail_media_contactlist_amendment.py} +16 -16
  102. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model_resource.py → retail_media_contactlist_amendment_attributes.py} +34 -25
  103. criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_request.py +275 -0
  104. criteo_api_retailmedia_preview/model/{json_api_single_response_of_catalog_status.py → retail_media_contactlist_operation.py} +24 -20
  105. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py → retail_media_contactlist_operation_response_attributes.py} +14 -18
  106. criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes_attributes.py +297 -0
  107. criteo_api_retailmedia_preview/model/review_state_model.py +294 -0
  108. criteo_api_retailmedia_preview/model/{retail_media_externalv1_problem_details.py → rmca_common_problem.py} +41 -30
  109. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bid_model.py → set_bid_model.py} +4 -10
  110. criteo_api_retailmedia_preview/model/set_bids_model.py +262 -0
  111. criteo_api_retailmedia_preview/model/set_bids_model_request.py +262 -0
  112. criteo_api_retailmedia_preview/model/set_bids_model_resource.py +270 -0
  113. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +47 -45
  114. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +68 -53
  115. criteo_api_retailmedia_preview/model/sync_line_items_report.py +70 -56
  116. criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py +262 -0
  117. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py +262 -0
  118. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py +262 -0
  119. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +262 -0
  120. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py +266 -0
  121. criteo_api_retailmedia_preview/model/{value_resource_of_int64.py → value_resource_of_retail_media_brands.py} +11 -6
  122. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py +266 -0
  123. criteo_api_retailmedia_preview/models/__init__.py +106 -55
  124. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/METADATA +3 -3
  125. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/RECORD +127 -75
  126. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/WHEEL +1 -1
  127. criteo_api_retailmedia_preview/model/files_variables_specification.py +0 -290
  128. criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_resource.py +0 -283
  129. criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_response.py +0 -285
  130. criteo_api_retailmedia_preview/model/retail_media_externalv1_resource_outcome.py +0 -279
  131. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/top_level.txt +0 -0
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class ColorVariableValue(ModelNormal):
33
+ class ExternalColorVariableValue(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -86,7 +86,7 @@ class ColorVariableValue(ModelNormal):
86
86
  and the value is attribute type.
87
87
  """
88
88
  return {
89
- 'color': (str,), # noqa: E501
89
+ 'color': (str, none_type,), # noqa: E501
90
90
  }
91
91
 
92
92
  @cached_property
@@ -105,11 +105,8 @@ class ColorVariableValue(ModelNormal):
105
105
 
106
106
  @classmethod
107
107
  @convert_js_args_to_python_args
108
- def _from_openapi_data(cls, color, *args, **kwargs): # noqa: E501
109
- """ColorVariableValue - a model defined in OpenAPI
110
-
111
- Args:
112
- color (str): The displayed color (HEX format)
108
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
109
+ """ExternalColorVariableValue - a model defined in OpenAPI
113
110
 
114
111
  Keyword Args:
115
112
  _check_type (bool): if True, values for parameters in openapi_types
@@ -142,6 +139,7 @@ class ColorVariableValue(ModelNormal):
142
139
  Animal class but this time we won't travel
143
140
  through its discriminator because we passed in
144
141
  _visited_composed_classes = (Animal,)
142
+ color (str, none_type): The displayed color (HEX format). [optional] # noqa: E501
145
143
  """
146
144
 
147
145
  _check_type = kwargs.pop('_check_type', True)
@@ -173,7 +171,6 @@ class ColorVariableValue(ModelNormal):
173
171
  self._configuration = _configuration
174
172
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
175
173
 
176
- self.color = color
177
174
  for var_name, var_value in kwargs.items():
178
175
  if var_name not in self.attribute_map and \
179
176
  self._configuration is not None and \
@@ -194,11 +191,8 @@ class ColorVariableValue(ModelNormal):
194
191
  ])
195
192
 
196
193
  @convert_js_args_to_python_args
197
- def __init__(self, color, *args, **kwargs): # noqa: E501
198
- """ColorVariableValue - a model defined in OpenAPI
199
-
200
- Args:
201
- color (str): The displayed color (HEX format)
194
+ def __init__(self, *args, **kwargs): # noqa: E501
195
+ """ExternalColorVariableValue - a model defined in OpenAPI
202
196
 
203
197
  Keyword Args:
204
198
  _check_type (bool): if True, values for parameters in openapi_types
@@ -231,6 +225,7 @@ class ColorVariableValue(ModelNormal):
231
225
  Animal class but this time we won't travel
232
226
  through its discriminator because we passed in
233
227
  _visited_composed_classes = (Animal,)
228
+ color (str, none_type): The displayed color (HEX format). [optional] # noqa: E501
234
229
  """
235
230
 
236
231
  _check_type = kwargs.pop('_check_type', True)
@@ -260,7 +255,6 @@ class ColorVariableValue(ModelNormal):
260
255
  self._configuration = _configuration
261
256
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
262
257
 
263
- self.color = color
264
258
  for var_name, var_value in kwargs.items():
265
259
  if var_name not in self.attribute_map and \
266
260
  self._configuration is not None and \
@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
- from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue
34
- globals()['TemplateVariableValue'] = TemplateVariableValue
33
+ from criteo_api_retailmedia_preview.model.external_template_variable_value import ExternalTemplateVariableValue
34
+ globals()['ExternalTemplateVariableValue'] = ExternalTemplateVariableValue
35
35
 
36
36
 
37
- class CreativeUpdateModel202207(ModelNormal):
37
+ class ExternalCreativeCreateModelV2(ModelNormal):
38
38
  """NOTE: This class is auto generated by OpenAPI Generator.
39
39
  Ref: https://openapi-generator.tech
40
40
 
@@ -90,8 +90,8 @@ class CreativeUpdateModel202207(ModelNormal):
90
90
  'name': (str,), # noqa: E501
91
91
  'retailer_id': (int,), # noqa: E501
92
92
  'template_id': (int,), # noqa: E501
93
- 'template_variable_values': ([TemplateVariableValue],), # noqa: E501
94
- 'brand_id': (int,), # noqa: E501
93
+ 'template_variable_values': ([ExternalTemplateVariableValue],), # noqa: E501
94
+ 'brand_id': (int, none_type,), # noqa: E501
95
95
  }
96
96
 
97
97
  @cached_property
@@ -115,13 +115,13 @@ class CreativeUpdateModel202207(ModelNormal):
115
115
  @classmethod
116
116
  @convert_js_args_to_python_args
117
117
  def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501
118
- """CreativeUpdateModel202207 - a model defined in OpenAPI
118
+ """ExternalCreativeCreateModelV2 - a model defined in OpenAPI
119
119
 
120
120
  Args:
121
121
  name (str): The name of the creative
122
122
  retailer_id (int): The retailer associated to the creative
123
123
  template_id (int): The creative template used for this creative
124
- template_variable_values ([TemplateVariableValue]): The template chosen values
124
+ template_variable_values ([ExternalTemplateVariableValue]): The template chosen values
125
125
 
126
126
  Keyword Args:
127
127
  _check_type (bool): if True, values for parameters in openapi_types
@@ -154,7 +154,7 @@ class CreativeUpdateModel202207(ModelNormal):
154
154
  Animal class but this time we won't travel
155
155
  through its discriminator because we passed in
156
156
  _visited_composed_classes = (Animal,)
157
- brand_id (int): The brand associated to the creative. [optional] # noqa: E501
157
+ brand_id (int, none_type): The brand associated to the creative. [optional] # noqa: E501
158
158
  """
159
159
 
160
160
  _check_type = kwargs.pop('_check_type', True)
@@ -211,13 +211,13 @@ class CreativeUpdateModel202207(ModelNormal):
211
211
 
212
212
  @convert_js_args_to_python_args
213
213
  def __init__(self, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501
214
- """CreativeUpdateModel202207 - a model defined in OpenAPI
214
+ """ExternalCreativeCreateModelV2 - a model defined in OpenAPI
215
215
 
216
216
  Args:
217
217
  name (str): The name of the creative
218
218
  retailer_id (int): The retailer associated to the creative
219
219
  template_id (int): The creative template used for this creative
220
- template_variable_values ([TemplateVariableValue]): The template chosen values
220
+ template_variable_values ([ExternalTemplateVariableValue]): The template chosen values
221
221
 
222
222
  Keyword Args:
223
223
  _check_type (bool): if True, values for parameters in openapi_types
@@ -250,7 +250,7 @@ class CreativeUpdateModel202207(ModelNormal):
250
250
  Animal class but this time we won't travel
251
251
  through its discriminator because we passed in
252
252
  _visited_composed_classes = (Animal,)
253
- brand_id (int): The brand associated to the creative. [optional] # noqa: E501
253
+ brand_id (int, none_type): The brand associated to the creative. [optional] # noqa: E501
254
254
  """
255
255
 
256
256
  _check_type = kwargs.pop('_check_type', True)
@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
- from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue
34
- globals()['TemplateVariableValue'] = TemplateVariableValue
33
+ from criteo_api_retailmedia_preview.model.external_template_variable_value import ExternalTemplateVariableValue
34
+ globals()['ExternalTemplateVariableValue'] = ExternalTemplateVariableValue
35
35
 
36
36
 
37
- class CreativeCreateModel202207(ModelNormal):
37
+ class ExternalCreativeUpdateModelV2(ModelNormal):
38
38
  """NOTE: This class is auto generated by OpenAPI Generator.
39
39
  Ref: https://openapi-generator.tech
40
40
 
@@ -90,8 +90,8 @@ class CreativeCreateModel202207(ModelNormal):
90
90
  'name': (str,), # noqa: E501
91
91
  'retailer_id': (int,), # noqa: E501
92
92
  'template_id': (int,), # noqa: E501
93
- 'template_variable_values': ([TemplateVariableValue],), # noqa: E501
94
- 'brand_id': (int,), # noqa: E501
93
+ 'template_variable_values': ([ExternalTemplateVariableValue],), # noqa: E501
94
+ 'brand_id': (int, none_type,), # noqa: E501
95
95
  }
96
96
 
97
97
  @cached_property
@@ -115,13 +115,13 @@ class CreativeCreateModel202207(ModelNormal):
115
115
  @classmethod
116
116
  @convert_js_args_to_python_args
117
117
  def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501
118
- """CreativeCreateModel202207 - a model defined in OpenAPI
118
+ """ExternalCreativeUpdateModelV2 - a model defined in OpenAPI
119
119
 
120
120
  Args:
121
121
  name (str): The name of the creative
122
122
  retailer_id (int): The retailer associated to the creative
123
123
  template_id (int): The creative template used for this creative
124
- template_variable_values ([TemplateVariableValue]): The template chosen values
124
+ template_variable_values ([ExternalTemplateVariableValue]): The template chosen values
125
125
 
126
126
  Keyword Args:
127
127
  _check_type (bool): if True, values for parameters in openapi_types
@@ -154,7 +154,7 @@ class CreativeCreateModel202207(ModelNormal):
154
154
  Animal class but this time we won't travel
155
155
  through its discriminator because we passed in
156
156
  _visited_composed_classes = (Animal,)
157
- brand_id (int): The brand associated to the creative. [optional] # noqa: E501
157
+ brand_id (int, none_type): The brand associated to the creative. [optional] # noqa: E501
158
158
  """
159
159
 
160
160
  _check_type = kwargs.pop('_check_type', True)
@@ -211,13 +211,13 @@ class CreativeCreateModel202207(ModelNormal):
211
211
 
212
212
  @convert_js_args_to_python_args
213
213
  def __init__(self, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501
214
- """CreativeCreateModel202207 - a model defined in OpenAPI
214
+ """ExternalCreativeUpdateModelV2 - a model defined in OpenAPI
215
215
 
216
216
  Args:
217
217
  name (str): The name of the creative
218
218
  retailer_id (int): The retailer associated to the creative
219
219
  template_id (int): The creative template used for this creative
220
- template_variable_values ([TemplateVariableValue]): The template chosen values
220
+ template_variable_values ([ExternalTemplateVariableValue]): The template chosen values
221
221
 
222
222
  Keyword Args:
223
223
  _check_type (bool): if True, values for parameters in openapi_types
@@ -250,7 +250,7 @@ class CreativeCreateModel202207(ModelNormal):
250
250
  Animal class but this time we won't travel
251
251
  through its discriminator because we passed in
252
252
  _visited_composed_classes = (Animal,)
253
- brand_id (int): The brand associated to the creative. [optional] # noqa: E501
253
+ brand_id (int, none_type): The brand associated to the creative. [optional] # noqa: E501
254
254
  """
255
255
 
256
256
  _check_type = kwargs.pop('_check_type', True)
@@ -30,13 +30,13 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
- from criteo_api_retailmedia_preview.model.page_type_environment import PageTypeEnvironment
34
- from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue
35
- globals()['PageTypeEnvironment'] = PageTypeEnvironment
36
- globals()['TemplateVariableValue'] = TemplateVariableValue
33
+ from criteo_api_retailmedia_preview.model.external_page_type_environment import ExternalPageTypeEnvironment
34
+ from criteo_api_retailmedia_preview.model.external_template_variable_value import ExternalTemplateVariableValue
35
+ globals()['ExternalPageTypeEnvironment'] = ExternalPageTypeEnvironment
36
+ globals()['ExternalTemplateVariableValue'] = ExternalTemplateVariableValue
37
37
 
38
38
 
39
- class Creative202210(ModelNormal):
39
+ class ExternalCreativeV2(ModelNormal):
40
40
  """NOTE: This class is auto generated by OpenAPI Generator.
41
41
  Ref: https://openapi-generator.tech
42
42
 
@@ -63,7 +63,7 @@ class Creative202210(ModelNormal):
63
63
  allowed_values = {
64
64
  ('status',): {
65
65
  'READY': "Ready",
66
- 'IN_USE': "In_Use",
66
+ 'INUSE': "InUse",
67
67
  'ARCHIVED': "Archived",
68
68
  'DELETED': "Deleted",
69
69
  },
@@ -75,7 +75,7 @@ class Creative202210(ModelNormal):
75
75
  'BUTTERFLY': "Butterfly",
76
76
  'BUNDLEBOOST': "BundleBoost",
77
77
  'IAB': "IAB",
78
- 'CUSTOM': "CUSTOM",
78
+ 'CUSTOM': "Custom",
79
79
  'DISPLAYPANEL': "DisplayPanel",
80
80
  'DIGITALSHELFTALKER': "DigitalShelfTalker",
81
81
  },
@@ -109,16 +109,16 @@ class Creative202210(ModelNormal):
109
109
  return {
110
110
  'name': (str,), # noqa: E501
111
111
  'status': (str,), # noqa: E501
112
+ 'brand_id': (int,), # noqa: E501
112
113
  'retailer_id': (int,), # noqa: E501
113
114
  'template_id': (int,), # noqa: E501
114
115
  'template_name': (str,), # noqa: E501
115
116
  'format_id': (int,), # noqa: E501
116
- 'creative_format_type': (str,), # noqa: E501
117
- 'environments': ([PageTypeEnvironment],), # noqa: E501
118
- 'template_variable_values': ([TemplateVariableValue],), # noqa: E501
119
- 'brand_id': (int, none_type,), # noqa: E501
120
117
  'associated_line_item_ids': ([str],), # noqa: E501
121
118
  'updated_at': (datetime,), # noqa: E501
119
+ 'creative_format_type': (str,), # noqa: E501
120
+ 'environments': ([ExternalPageTypeEnvironment],), # noqa: E501
121
+ 'template_variable_values': ([ExternalTemplateVariableValue],), # noqa: E501
122
122
  }
123
123
 
124
124
  @cached_property
@@ -129,16 +129,16 @@ class Creative202210(ModelNormal):
129
129
  attribute_map = {
130
130
  'name': 'name', # noqa: E501
131
131
  'status': 'status', # noqa: E501
132
+ 'brand_id': 'brandId', # noqa: E501
132
133
  'retailer_id': 'retailerId', # noqa: E501
133
134
  'template_id': 'templateId', # noqa: E501
134
135
  'template_name': 'templateName', # noqa: E501
135
136
  'format_id': 'formatId', # noqa: E501
137
+ 'associated_line_item_ids': 'associatedLineItemIds', # noqa: E501
138
+ 'updated_at': 'updatedAt', # noqa: E501
136
139
  'creative_format_type': 'creativeFormatType', # noqa: E501
137
140
  'environments': 'environments', # noqa: E501
138
141
  'template_variable_values': 'templateVariableValues', # noqa: E501
139
- 'brand_id': 'brandId', # noqa: E501
140
- 'associated_line_item_ids': 'associatedLineItemIds', # noqa: E501
141
- 'updated_at': 'updatedAt', # noqa: E501
142
142
  }
143
143
 
144
144
  read_only_vars = {
@@ -148,19 +148,22 @@ class Creative202210(ModelNormal):
148
148
 
149
149
  @classmethod
150
150
  @convert_js_args_to_python_args
151
- def _from_openapi_data(cls, name, status, retailer_id, template_id, template_name, format_id, creative_format_type, environments, template_variable_values, *args, **kwargs): # noqa: E501
152
- """Creative202210 - a model defined in OpenAPI
151
+ def _from_openapi_data(cls, name, status, brand_id, retailer_id, template_id, template_name, format_id, associated_line_item_ids, updated_at, creative_format_type, environments, template_variable_values, *args, **kwargs): # noqa: E501
152
+ """ExternalCreativeV2 - a model defined in OpenAPI
153
153
 
154
154
  Args:
155
155
  name (str): Name
156
156
  status (str): Creative Status
157
+ brand_id (int): Brand Id
157
158
  retailer_id (int): Retailer Id
158
159
  template_id (int): Template Id
159
160
  template_name (str): Template Name
160
161
  format_id (int): Format Id
162
+ associated_line_item_ids ([str]): Associated Line Item Ids
163
+ updated_at (datetime): Updated at time
161
164
  creative_format_type (str): Creative format type
162
- environments ([PageTypeEnvironment]): Environment type (e.g. mobile, web, app)
163
- template_variable_values ([TemplateVariableValue]): The template chosen values
165
+ environments ([ExternalPageTypeEnvironment]): Environment type (e.g. mobile, web, app)
166
+ template_variable_values ([ExternalTemplateVariableValue]): The template chosen values
164
167
 
165
168
  Keyword Args:
166
169
  _check_type (bool): if True, values for parameters in openapi_types
@@ -193,9 +196,6 @@ class Creative202210(ModelNormal):
193
196
  Animal class but this time we won't travel
194
197
  through its discriminator because we passed in
195
198
  _visited_composed_classes = (Animal,)
196
- brand_id (int, none_type): Brand Id. [optional] # noqa: E501
197
- associated_line_item_ids ([str]): Associated Line Item Ids. [optional] # noqa: E501
198
- updated_at (datetime): Updated at time. [optional] # noqa: E501
199
199
  """
200
200
 
201
201
  _check_type = kwargs.pop('_check_type', True)
@@ -229,10 +229,13 @@ class Creative202210(ModelNormal):
229
229
 
230
230
  self.name = name
231
231
  self.status = status
232
+ self.brand_id = brand_id
232
233
  self.retailer_id = retailer_id
233
234
  self.template_id = template_id
234
235
  self.template_name = template_name
235
236
  self.format_id = format_id
237
+ self.associated_line_item_ids = associated_line_item_ids
238
+ self.updated_at = updated_at
236
239
  self.creative_format_type = creative_format_type
237
240
  self.environments = environments
238
241
  self.template_variable_values = template_variable_values
@@ -256,19 +259,22 @@ class Creative202210(ModelNormal):
256
259
  ])
257
260
 
258
261
  @convert_js_args_to_python_args
259
- def __init__(self, name, status, retailer_id, template_id, template_name, format_id, creative_format_type, environments, template_variable_values, *args, **kwargs): # noqa: E501
260
- """Creative202210 - a model defined in OpenAPI
262
+ def __init__(self, name, status, brand_id, retailer_id, template_id, template_name, format_id, associated_line_item_ids, updated_at, creative_format_type, environments, template_variable_values, *args, **kwargs): # noqa: E501
263
+ """ExternalCreativeV2 - a model defined in OpenAPI
261
264
 
262
265
  Args:
263
266
  name (str): Name
264
267
  status (str): Creative Status
268
+ brand_id (int): Brand Id
265
269
  retailer_id (int): Retailer Id
266
270
  template_id (int): Template Id
267
271
  template_name (str): Template Name
268
272
  format_id (int): Format Id
273
+ associated_line_item_ids ([str]): Associated Line Item Ids
274
+ updated_at (datetime): Updated at time
269
275
  creative_format_type (str): Creative format type
270
- environments ([PageTypeEnvironment]): Environment type (e.g. mobile, web, app)
271
- template_variable_values ([TemplateVariableValue]): The template chosen values
276
+ environments ([ExternalPageTypeEnvironment]): Environment type (e.g. mobile, web, app)
277
+ template_variable_values ([ExternalTemplateVariableValue]): The template chosen values
272
278
 
273
279
  Keyword Args:
274
280
  _check_type (bool): if True, values for parameters in openapi_types
@@ -301,9 +307,6 @@ class Creative202210(ModelNormal):
301
307
  Animal class but this time we won't travel
302
308
  through its discriminator because we passed in
303
309
  _visited_composed_classes = (Animal,)
304
- brand_id (int, none_type): Brand Id. [optional] # noqa: E501
305
- associated_line_item_ids ([str]): Associated Line Item Ids. [optional] # noqa: E501
306
- updated_at (datetime): Updated at time. [optional] # noqa: E501
307
310
  """
308
311
 
309
312
  _check_type = kwargs.pop('_check_type', True)
@@ -335,10 +338,13 @@ class Creative202210(ModelNormal):
335
338
 
336
339
  self.name = name
337
340
  self.status = status
341
+ self.brand_id = brand_id
338
342
  self.retailer_id = retailer_id
339
343
  self.template_id = template_id
340
344
  self.template_name = template_name
341
345
  self.format_id = format_id
346
+ self.associated_line_item_ids = associated_line_item_ids
347
+ self.updated_at = updated_at
342
348
  self.creative_format_type = creative_format_type
343
349
  self.environments = environments
344
350
  self.template_variable_values = template_variable_values
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class FilesVariableValue(ModelNormal):
33
+ class ExternalFilesVariableValue(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -59,6 +59,7 @@ class FilesVariableValue(ModelNormal):
59
59
 
60
60
  validations = {
61
61
  ('asset_ids',): {
62
+ 'min_items': 1,
62
63
  },
63
64
  }
64
65
 
@@ -103,7 +104,7 @@ class FilesVariableValue(ModelNormal):
103
104
  @classmethod
104
105
  @convert_js_args_to_python_args
105
106
  def _from_openapi_data(cls, asset_ids, *args, **kwargs): # noqa: E501
106
- """FilesVariableValue - a model defined in OpenAPI
107
+ """ExternalFilesVariableValue - a model defined in OpenAPI
107
108
 
108
109
  Args:
109
110
  asset_ids ([str]): The assets representing the images to be displayed
@@ -192,7 +193,7 @@ class FilesVariableValue(ModelNormal):
192
193
 
193
194
  @convert_js_args_to_python_args
194
195
  def __init__(self, asset_ids, *args, **kwargs): # noqa: E501
195
- """FilesVariableValue - a model defined in OpenAPI
196
+ """ExternalFilesVariableValue - a model defined in OpenAPI
196
197
 
197
198
  Args:
198
199
  asset_ids ([str]): The assets representing the images to be displayed
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class TextVariableSpecification(ModelNormal):
33
+ class ExternalHyperlinkVariableValue(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -81,7 +81,7 @@ class TextVariableSpecification(ModelNormal):
81
81
  and the value is attribute type.
82
82
  """
83
83
  return {
84
- 'max_chars': (int, none_type,), # noqa: E501
84
+ 'url': (str, none_type,), # noqa: E501
85
85
  }
86
86
 
87
87
  @cached_property
@@ -90,7 +90,7 @@ class TextVariableSpecification(ModelNormal):
90
90
 
91
91
 
92
92
  attribute_map = {
93
- 'max_chars': 'maxChars', # noqa: E501
93
+ 'url': 'url', # noqa: E501
94
94
  }
95
95
 
96
96
  read_only_vars = {
@@ -101,7 +101,7 @@ class TextVariableSpecification(ModelNormal):
101
101
  @classmethod
102
102
  @convert_js_args_to_python_args
103
103
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
104
- """TextVariableSpecification - a model defined in OpenAPI
104
+ """ExternalHyperlinkVariableValue - a model defined in OpenAPI
105
105
 
106
106
  Keyword Args:
107
107
  _check_type (bool): if True, values for parameters in openapi_types
@@ -134,7 +134,7 @@ class TextVariableSpecification(ModelNormal):
134
134
  Animal class but this time we won't travel
135
135
  through its discriminator because we passed in
136
136
  _visited_composed_classes = (Animal,)
137
- max_chars (int, none_type): The maximum amount of characters accepted for the text. [optional] # noqa: E501
137
+ url (str, none_type): The url to redirect to. [optional] # noqa: E501
138
138
  """
139
139
 
140
140
  _check_type = kwargs.pop('_check_type', True)
@@ -187,7 +187,7 @@ class TextVariableSpecification(ModelNormal):
187
187
 
188
188
  @convert_js_args_to_python_args
189
189
  def __init__(self, *args, **kwargs): # noqa: E501
190
- """TextVariableSpecification - a model defined in OpenAPI
190
+ """ExternalHyperlinkVariableValue - a model defined in OpenAPI
191
191
 
192
192
  Keyword Args:
193
193
  _check_type (bool): if True, values for parameters in openapi_types
@@ -220,7 +220,7 @@ class TextVariableSpecification(ModelNormal):
220
220
  Animal class but this time we won't travel
221
221
  through its discriminator because we passed in
222
222
  _visited_composed_classes = (Animal,)
223
- max_chars (int, none_type): The maximum amount of characters accepted for the text. [optional] # noqa: E501
223
+ url (str, none_type): The url to redirect to. [optional] # noqa: E501
224
224
  """
225
225
 
226
226
  _check_type = kwargs.pop('_check_type', True)
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class LineItemBidMultipliers(ModelNormal):
33
+ class ExternalLineItemBidMultipliersV2(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -81,14 +81,17 @@ class LineItemBidMultipliers(ModelNormal):
81
81
  and the value is attribute type.
82
82
  """
83
83
  return {
84
- 'search': (float,), # noqa: E501
85
- 'homepage': (float,), # noqa: E501
86
- 'categories': (float,), # noqa: E501
87
- 'product_detail': (float,), # noqa: E501
88
- 'confirmation': (float,), # noqa: E501
89
- 'merchandising': (float,), # noqa: E501
90
- 'deals': (float,), # noqa: E501
91
- 'checkout': (float,), # noqa: E501
84
+ 'search': (float, none_type,), # noqa: E501
85
+ 'home': (float, none_type,), # noqa: E501
86
+ 'category': (float, none_type,), # noqa: E501
87
+ 'product_detail': (float, none_type,), # noqa: E501
88
+ 'confirmation': (float, none_type,), # noqa: E501
89
+ 'merchandising': (float, none_type,), # noqa: E501
90
+ 'deals': (float, none_type,), # noqa: E501
91
+ 'checkout': (float, none_type,), # noqa: E501
92
+ 'favorites': (float, none_type,), # noqa: E501
93
+ 'search_bar': (float, none_type,), # noqa: E501
94
+ 'category_menu': (float, none_type,), # noqa: E501
92
95
  }
93
96
 
94
97
  @cached_property
@@ -98,13 +101,16 @@ class LineItemBidMultipliers(ModelNormal):
98
101
 
99
102
  attribute_map = {
100
103
  'search': 'search', # noqa: E501
101
- 'homepage': 'homepage', # noqa: E501
102
- 'categories': 'categories', # noqa: E501
104
+ 'home': 'home', # noqa: E501
105
+ 'category': 'category', # noqa: E501
103
106
  'product_detail': 'productDetail', # noqa: E501
104
107
  'confirmation': 'confirmation', # noqa: E501
105
108
  'merchandising': 'merchandising', # noqa: E501
106
109
  'deals': 'deals', # noqa: E501
107
110
  'checkout': 'checkout', # noqa: E501
111
+ 'favorites': 'favorites', # noqa: E501
112
+ 'search_bar': 'searchBar', # noqa: E501
113
+ 'category_menu': 'categoryMenu', # noqa: E501
108
114
  }
109
115
 
110
116
  read_only_vars = {
@@ -115,7 +121,7 @@ class LineItemBidMultipliers(ModelNormal):
115
121
  @classmethod
116
122
  @convert_js_args_to_python_args
117
123
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
118
- """LineItemBidMultipliers - a model defined in OpenAPI
124
+ """ExternalLineItemBidMultipliersV2 - a model defined in OpenAPI
119
125
 
120
126
  Keyword Args:
121
127
  _check_type (bool): if True, values for parameters in openapi_types
@@ -148,14 +154,17 @@ class LineItemBidMultipliers(ModelNormal):
148
154
  Animal class but this time we won't travel
149
155
  through its discriminator because we passed in
150
156
  _visited_composed_classes = (Animal,)
151
- search (float): [optional] # noqa: E501
152
- homepage (float): [optional] # noqa: E501
153
- categories (float): [optional] # noqa: E501
154
- product_detail (float): [optional] # noqa: E501
155
- confirmation (float): [optional] # noqa: E501
156
- merchandising (float): [optional] # noqa: E501
157
- deals (float): [optional] # noqa: E501
158
- checkout (float): [optional] # noqa: E501
157
+ search (float, none_type): Search Page Type Bid Multiplier. [optional] # noqa: E501
158
+ home (float, none_type): Home Page Type Bid Multiplier. [optional] # noqa: E501
159
+ category (float, none_type): Categories Page Type Bid Multiplier. [optional] # noqa: E501
160
+ product_detail (float, none_type): ProductDetail Page Type Bid Multiplier. [optional] # noqa: E501
161
+ confirmation (float, none_type): Confirmation Page Type Bid Multiplier. [optional] # noqa: E501
162
+ merchandising (float, none_type): Merchandising Page Type Bid Multiplier. [optional] # noqa: E501
163
+ deals (float, none_type): Deals Page Type Bid Multiplier. [optional] # noqa: E501
164
+ checkout (float, none_type): Checkout Page Type Bid Multiplier. [optional] # noqa: E501
165
+ favorites (float, none_type): Favorites Page Type Bid Multiplier. [optional] # noqa: E501
166
+ search_bar (float, none_type): SearchBar Page Type Bid Multiplier. [optional] # noqa: E501
167
+ category_menu (float, none_type): CategoryMenu Page Type Bid Multiplier. [optional] # noqa: E501
159
168
  """
160
169
 
161
170
  _check_type = kwargs.pop('_check_type', True)
@@ -208,7 +217,7 @@ class LineItemBidMultipliers(ModelNormal):
208
217
 
209
218
  @convert_js_args_to_python_args
210
219
  def __init__(self, *args, **kwargs): # noqa: E501
211
- """LineItemBidMultipliers - a model defined in OpenAPI
220
+ """ExternalLineItemBidMultipliersV2 - a model defined in OpenAPI
212
221
 
213
222
  Keyword Args:
214
223
  _check_type (bool): if True, values for parameters in openapi_types
@@ -241,14 +250,17 @@ class LineItemBidMultipliers(ModelNormal):
241
250
  Animal class but this time we won't travel
242
251
  through its discriminator because we passed in
243
252
  _visited_composed_classes = (Animal,)
244
- search (float): [optional] # noqa: E501
245
- homepage (float): [optional] # noqa: E501
246
- categories (float): [optional] # noqa: E501
247
- product_detail (float): [optional] # noqa: E501
248
- confirmation (float): [optional] # noqa: E501
249
- merchandising (float): [optional] # noqa: E501
250
- deals (float): [optional] # noqa: E501
251
- checkout (float): [optional] # noqa: E501
253
+ search (float, none_type): Search Page Type Bid Multiplier. [optional] # noqa: E501
254
+ home (float, none_type): Home Page Type Bid Multiplier. [optional] # noqa: E501
255
+ category (float, none_type): Categories Page Type Bid Multiplier. [optional] # noqa: E501
256
+ product_detail (float, none_type): ProductDetail Page Type Bid Multiplier. [optional] # noqa: E501
257
+ confirmation (float, none_type): Confirmation Page Type Bid Multiplier. [optional] # noqa: E501
258
+ merchandising (float, none_type): Merchandising Page Type Bid Multiplier. [optional] # noqa: E501
259
+ deals (float, none_type): Deals Page Type Bid Multiplier. [optional] # noqa: E501
260
+ checkout (float, none_type): Checkout Page Type Bid Multiplier. [optional] # noqa: E501
261
+ favorites (float, none_type): Favorites Page Type Bid Multiplier. [optional] # noqa: E501
262
+ search_bar (float, none_type): SearchBar Page Type Bid Multiplier. [optional] # noqa: E501
263
+ category_menu (float, none_type): CategoryMenu Page Type Bid Multiplier. [optional] # noqa: E501
252
264
  """
253
265
 
254
266
  _check_type = kwargs.pop('_check_type', True)