criteo-api-retailmedia-sdk 0.0.241029__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 (91) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +23 -324
  3. criteo_api_retailmedia_preview/api/balance_api.py +0 -159
  4. criteo_api_retailmedia_preview/api/campaign_api.py +127 -921
  5. criteo_api_retailmedia_preview/api/catalog_api.py +161 -0
  6. criteo_api_retailmedia_preview/api_client.py +4 -4
  7. criteo_api_retailmedia_preview/configuration.py +1 -1
  8. criteo_api_retailmedia_preview/model/async_accounts_report.py +40 -0
  9. criteo_api_retailmedia_preview/model/async_campaigns_report.py +40 -0
  10. criteo_api_retailmedia_preview/model/async_line_items_report.py +40 -0
  11. criteo_api_retailmedia_preview/model/balance_response_v2_response.py +1 -1
  12. criteo_api_retailmedia_preview/model/brand_id_search_request.py +271 -0
  13. criteo_api_retailmedia_preview/model/{external_retailer.py → brand_id_search_result.py} +26 -26
  14. criteo_api_retailmedia_preview/model/category.py +3 -3
  15. criteo_api_retailmedia_preview/model/change_details_v1.py +8 -18
  16. criteo_api_retailmedia_preview/model/{external_choice_variable_value.py → choice_variable_value.py} +4 -10
  17. criteo_api_retailmedia_preview/model/{external_color_variable_value.py → color_variable_value.py} +5 -11
  18. criteo_api_retailmedia_preview/model/{sku_search_request.py → cpc_min_bids_request.py} +11 -16
  19. criteo_api_retailmedia_preview/model/{page_of_insertion_order_history_change_data_capture_v2.py → cpc_min_bids_response.py} +19 -21
  20. criteo_api_retailmedia_preview/model/cpc_rate_card_preview.py +6 -6
  21. criteo_api_retailmedia_preview/model/{external_creative_v2.py → creative2.py} +23 -30
  22. criteo_api_retailmedia_preview/model/{resource_outcome_of_retail_media_account.py → creative2_list_response.py} +9 -9
  23. criteo_api_retailmedia_preview/model/{resource_collection_outcome_of_sku_search_result.py → creative2_response.py} +9 -9
  24. criteo_api_retailmedia_preview/model/{external_creative_create_model_v2.py → creative_create_model2.py} +9 -16
  25. criteo_api_retailmedia_preview/model/{external_creative_update_model_v2.py → creative_update_model2.py} +9 -16
  26. criteo_api_retailmedia_preview/model/{resource_of_retail_media_account.py → entity_resource_brand_id_search_result.py} +13 -13
  27. criteo_api_retailmedia_preview/model/{creative_v2_list_response.py → entity_resource_collection_outcome_brand_id_search_result.py} +17 -24
  28. criteo_api_retailmedia_preview/model/{entity_resource_collection_outcome_of_retail_media_account.py → entity_resource_collection_outcome_of_retail_media_child_account.py} +15 -9
  29. criteo_api_retailmedia_preview/model/{entity_resource_of_retail_media_account.py → entity_resource_of_retail_media_child_account.py} +9 -9
  30. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +1 -1
  31. criteo_api_retailmedia_preview/model/{external_retail_media_account.py → external_retail_media_child_account.py} +4 -8
  32. criteo_api_retailmedia_preview/model/{external_files_variable_value.py → files_variable_value.py} +4 -10
  33. criteo_api_retailmedia_preview/model/{external_hyperlink_variable_value.py → hyperlink_variable_value.py} +5 -11
  34. criteo_api_retailmedia_preview/model/json_api_request_of_seller_catalog_request.py +1 -1
  35. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_request.py +1 -1
  36. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py +1 -1
  37. criteo_api_retailmedia_preview/model/{add_funds_to_balance_v2_request.py → offset_page_metadata.py} +25 -15
  38. criteo_api_retailmedia_preview/model/{resource_of_sku_search_result.py → outcome.py} +15 -17
  39. criteo_api_retailmedia_preview/model/{external_page_type_environment.py → page_type_environment2.py} +4 -10
  40. criteo_api_retailmedia_preview/model/placement_preview.py +4 -0
  41. criteo_api_retailmedia_preview/model/report_ok_response.py +18 -18
  42. criteo_api_retailmedia_preview/model/{proposal_status_model_resource.py → resource_of_creative2.py} +14 -14
  43. criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.py +1 -1
  44. criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py +1 -1
  45. criteo_api_retailmedia_preview/model/retail_media_seller.py +4 -0
  46. criteo_api_retailmedia_preview/model/sdk_api_rest_common_problem.py +296 -0
  47. criteo_api_retailmedia_preview/model/seller_catalog_request.py +1 -1
  48. criteo_api_retailmedia_preview/model/{sku_search_request_body.py → seller_search.py} +18 -25
  49. criteo_api_retailmedia_preview/model/sku_data_preview.py +27 -27
  50. criteo_api_retailmedia_preview/model/{external_brand.py → sku_min_bid.py} +18 -22
  51. criteo_api_retailmedia_preview/model/sku_slim_data_v2.py +9 -13
  52. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +4 -0
  53. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +1 -11
  54. criteo_api_retailmedia_preview/model/sync_line_items_report.py +1 -11
  55. criteo_api_retailmedia_preview/model/{external_template_variable_value.py → template_variable_value.py} +36 -43
  56. criteo_api_retailmedia_preview/model/{external_text_variable_value.py → text_variable_value.py} +5 -11
  57. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller_account_creation.py → value_resource_brand_id_search_request.py} +10 -10
  58. criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_retail_media_seller.py +8 -8
  59. criteo_api_retailmedia_preview/model/value_resource_cpc_min_bids_request.py +266 -0
  60. criteo_api_retailmedia_preview/model/value_resource_cpc_min_bids_response.py +266 -0
  61. criteo_api_retailmedia_preview/model/value_resource_input_brand_id_search_request.py +262 -0
  62. criteo_api_retailmedia_preview/model/value_resource_input_cpc_min_bids_request.py +262 -0
  63. criteo_api_retailmedia_preview/model/{value_resource_collection_input_of_retail_media_seller.py → value_resource_input_of_seller_search.py} +8 -8
  64. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller.py +2 -2
  65. criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_seller_account_creation.py → value_resource_of_seller_search.py} +13 -9
  66. criteo_api_retailmedia_preview/model/{proposal_status_model_response.py → value_resource_outcome_cpc_min_bids_response.py} +19 -19
  67. criteo_api_retailmedia_preview/model/{external_video_variable_value.py → video_variable_value.py} +4 -10
  68. criteo_api_retailmedia_preview/models/__init__.py +36 -49
  69. {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/METADATA +14 -5
  70. {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/RECORD +72 -85
  71. {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/WHEEL +1 -1
  72. criteo_api_retailmedia_preview/model/add_funds_to_balance_v2.py +0 -277
  73. criteo_api_retailmedia_preview/model/approval_status_model.py +0 -292
  74. criteo_api_retailmedia_preview/model/change_details_v2.py +0 -275
  75. criteo_api_retailmedia_preview/model/creative_v2_response.py +0 -281
  76. criteo_api_retailmedia_preview/model/external_account.py +0 -330
  77. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture_v2.py +0 -303
  78. criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_account_and_account.py +0 -285
  79. criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_brand_and_brand.py +0 -285
  80. criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py +0 -285
  81. criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py +0 -295
  82. criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py +0 -295
  83. criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py +0 -295
  84. criteo_api_retailmedia_preview/model/negotiation_state_model.py +0 -293
  85. criteo_api_retailmedia_preview/model/proposal_status_model.py +0 -284
  86. criteo_api_retailmedia_preview/model/resource_of_add_funds_to_balance_v2.py +0 -277
  87. criteo_api_retailmedia_preview/model/resource_of_creative_v2.py +0 -277
  88. criteo_api_retailmedia_preview/model/retail_media_account.py +0 -301
  89. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +0 -274
  90. criteo_api_retailmedia_preview/model/sku_search_result.py +0 -313
  91. {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/top_level.txt +0 -0
@@ -1,313 +0,0 @@
1
- """
2
- Criteo API
3
-
4
- Criteo API - RetailMedia # noqa: E501
5
-
6
- The version of the OpenAPI document: Preview
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_preview.model_utils import ( # noqa: F401
15
- ApiTypeError,
16
- ModelComposed,
17
- ModelNormal,
18
- ModelSimple,
19
- cached_property,
20
- change_keys_js_to_python,
21
- convert_js_args_to_python_args,
22
- date,
23
- datetime,
24
- file_type,
25
- none_type,
26
- validate_get_composed_info,
27
- OpenApiModel
28
- )
29
- from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
-
31
-
32
-
33
- class SkuSearchResult(ModelNormal):
34
- """NOTE: This class is auto generated by OpenAPI Generator.
35
- Ref: https://openapi-generator.tech
36
-
37
- Do not edit the class manually.
38
-
39
- Attributes:
40
- allowed_values (dict): The key is the tuple path to the attribute
41
- and the for var_name this is (var_name,). The value is a dict
42
- with a capitalized key describing the allowed value and an allowed
43
- value. These dicts store the allowed enum values.
44
- attribute_map (dict): The key is attribute name
45
- and the value is json key in definition.
46
- discriminator_value_class_map (dict): A dict to go from the discriminator
47
- variable value to the discriminator class name.
48
- validations (dict): The key is the tuple path to the attribute
49
- and the for var_name this is (var_name,). The value is a dict
50
- that stores validations for max_length, min_length, max_items,
51
- min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
52
- inclusive_minimum, and regex.
53
- additional_properties_type (tuple): A tuple of classes accepted
54
- as additional properties values.
55
- """
56
-
57
- allowed_values = {
58
- }
59
-
60
- validations = {
61
- }
62
-
63
- additional_properties_type = None
64
-
65
- _nullable = False
66
-
67
- @cached_property
68
- def openapi_types():
69
- """
70
- This must be a method because a model may have properties that are
71
- of type self, this must run after the class is loaded
72
-
73
- Returns
74
- openapi_types (dict): The key is attribute name
75
- and the value is attribute type.
76
- """
77
- return {
78
- 'name': (str, none_type,), # noqa: E501
79
- 'category_id': (str, none_type,), # noqa: E501
80
- 'category': (str, none_type,), # noqa: E501
81
- 'global_brand_id': (str, none_type,), # noqa: E501
82
- 'global_brand_name': (str, none_type,), # noqa: E501
83
- 'retailer_brand_id': (str, none_type,), # noqa: E501
84
- 'retailer_brand_name': (str, none_type,), # noqa: E501
85
- 'global_category_id': (str, none_type,), # noqa: E501
86
- 'price': (float, none_type,), # noqa: E501
87
- 'model_number': (str, none_type,), # noqa: E501
88
- 'is_in_stock': (bool, none_type,), # noqa: E501
89
- 'gtin': (str, none_type,), # noqa: E501
90
- 'mpn': (str, none_type,), # noqa: E501
91
- 'image_url': (str, none_type,), # noqa: E501
92
- 'updated_at': (datetime, none_type,), # noqa: E501
93
- }
94
-
95
- @cached_property
96
- def discriminator():
97
- return None
98
-
99
-
100
- attribute_map = {
101
- 'name': 'name', # noqa: E501
102
- 'category_id': 'categoryId', # noqa: E501
103
- 'category': 'category', # noqa: E501
104
- 'global_brand_id': 'globalBrandId', # noqa: E501
105
- 'global_brand_name': 'globalBrandName', # noqa: E501
106
- 'retailer_brand_id': 'retailerBrandId', # noqa: E501
107
- 'retailer_brand_name': 'retailerBrandName', # noqa: E501
108
- 'global_category_id': 'globalCategoryId', # noqa: E501
109
- 'price': 'price', # noqa: E501
110
- 'model_number': 'modelNumber', # noqa: E501
111
- 'is_in_stock': 'isInStock', # noqa: E501
112
- 'gtin': 'gtin', # noqa: E501
113
- 'mpn': 'mpn', # noqa: E501
114
- 'image_url': 'imageUrl', # noqa: E501
115
- 'updated_at': 'updatedAt', # noqa: E501
116
- }
117
-
118
- read_only_vars = {
119
- }
120
-
121
- _composed_schemas = {}
122
-
123
- @classmethod
124
- @convert_js_args_to_python_args
125
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
126
- """SkuSearchResult - a model defined in OpenAPI
127
-
128
- Keyword Args:
129
- _check_type (bool): if True, values for parameters in openapi_types
130
- will be type checked and a TypeError will be
131
- raised if the wrong type is input.
132
- Defaults to True
133
- _path_to_item (tuple/list): This is a list of keys or values to
134
- drill down to the model in received_data
135
- when deserializing a response
136
- _spec_property_naming (bool): True if the variable names in the input data
137
- are serialized names, as specified in the OpenAPI document.
138
- False if the variable names in the input data
139
- are pythonic names, e.g. snake case (default)
140
- _configuration (Configuration): the instance to use when
141
- deserializing a file_type parameter.
142
- If passed, type conversion is attempted
143
- If omitted no type conversion is done.
144
- _visited_composed_classes (tuple): This stores a tuple of
145
- classes that we have traveled through so that
146
- if we see that class again we will not use its
147
- discriminator again.
148
- When traveling through a discriminator, the
149
- composed schema that is
150
- is traveled through is added to this set.
151
- For example if Animal has a discriminator
152
- petType and we pass in "Dog", and the class Dog
153
- allOf includes Animal, we move through Animal
154
- once using the discriminator, and pick Dog.
155
- Then in Dog, we will make an instance of the
156
- Animal class but this time we won't travel
157
- through its discriminator because we passed in
158
- _visited_composed_classes = (Animal,)
159
- name (str, none_type): The product name. [optional] # noqa: E501
160
- category_id (str, none_type): The cateogry Id. [optional] # noqa: E501
161
- category (str, none_type): The full retailer category taken from the retailers catalog. [optional] # noqa: E501
162
- global_brand_id (str, none_type): The global brand id associated to the product. [optional] # noqa: E501
163
- global_brand_name (str, none_type): The name of the global brand. [optional] # noqa: E501
164
- retailer_brand_id (str, none_type): The retailer brand id associated to the product. [optional] # noqa: E501
165
- retailer_brand_name (str, none_type): The name of the retailer brand. [optional] # noqa: E501
166
- global_category_id (str, none_type): the Global Category Id. [optional] # noqa: E501
167
- price (float, none_type): The product price pulled from the retailer's catalog. [optional] # noqa: E501
168
- model_number (str, none_type): The model number for the product. [optional] # noqa: E501
169
- is_in_stock (bool, none_type): Indicates if the retailer product is in stock. [optional] # noqa: E501
170
- gtin (str, none_type): A GTIN identifier for the product if available. TIt covers variations such as EANs and UPCs. [optional] # noqa: E501
171
- mpn (str, none_type): The MPN identifier for the product if available. [optional] # noqa: E501
172
- image_url (str, none_type): An http image resource provided by the retailer catalog. [optional] # noqa: E501
173
- updated_at (datetime, none_type): The last time this product was updated in the Retail Media Catalog. The date value is represented as an UTC ISO8601 string. [optional] # noqa: E501
174
- """
175
-
176
- _check_type = kwargs.pop('_check_type', True)
177
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
178
- _path_to_item = kwargs.pop('_path_to_item', ())
179
- _configuration = kwargs.pop('_configuration', None)
180
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
181
-
182
- self = super(OpenApiModel, cls).__new__(cls)
183
-
184
- if args:
185
- for arg in args:
186
- if isinstance(arg, dict):
187
- kwargs.update(arg)
188
- else:
189
- raise ApiTypeError(
190
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
191
- args,
192
- self.__class__.__name__,
193
- ),
194
- path_to_item=_path_to_item,
195
- valid_classes=(self.__class__,),
196
- )
197
-
198
- self._data_store = {}
199
- self._check_type = _check_type
200
- self._spec_property_naming = _spec_property_naming
201
- self._path_to_item = _path_to_item
202
- self._configuration = _configuration
203
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
204
-
205
- for var_name, var_value in kwargs.items():
206
- if var_name not in self.attribute_map and \
207
- self._configuration is not None and \
208
- self._configuration.discard_unknown_keys and \
209
- self.additional_properties_type is None:
210
- # discard variable.
211
- continue
212
- setattr(self, var_name, var_value)
213
- return self
214
-
215
- required_properties = set([
216
- '_data_store',
217
- '_check_type',
218
- '_spec_property_naming',
219
- '_path_to_item',
220
- '_configuration',
221
- '_visited_composed_classes',
222
- ])
223
-
224
- @convert_js_args_to_python_args
225
- def __init__(self, *args, **kwargs): # noqa: E501
226
- """SkuSearchResult - a model defined in OpenAPI
227
-
228
- Keyword Args:
229
- _check_type (bool): if True, values for parameters in openapi_types
230
- will be type checked and a TypeError will be
231
- raised if the wrong type is input.
232
- Defaults to True
233
- _path_to_item (tuple/list): This is a list of keys or values to
234
- drill down to the model in received_data
235
- when deserializing a response
236
- _spec_property_naming (bool): True if the variable names in the input data
237
- are serialized names, as specified in the OpenAPI document.
238
- False if the variable names in the input data
239
- are pythonic names, e.g. snake case (default)
240
- _configuration (Configuration): the instance to use when
241
- deserializing a file_type parameter.
242
- If passed, type conversion is attempted
243
- If omitted no type conversion is done.
244
- _visited_composed_classes (tuple): This stores a tuple of
245
- classes that we have traveled through so that
246
- if we see that class again we will not use its
247
- discriminator again.
248
- When traveling through a discriminator, the
249
- composed schema that is
250
- is traveled through is added to this set.
251
- For example if Animal has a discriminator
252
- petType and we pass in "Dog", and the class Dog
253
- allOf includes Animal, we move through Animal
254
- once using the discriminator, and pick Dog.
255
- Then in Dog, we will make an instance of the
256
- Animal class but this time we won't travel
257
- through its discriminator because we passed in
258
- _visited_composed_classes = (Animal,)
259
- name (str, none_type): The product name. [optional] # noqa: E501
260
- category_id (str, none_type): The cateogry Id. [optional] # noqa: E501
261
- category (str, none_type): The full retailer category taken from the retailers catalog. [optional] # noqa: E501
262
- global_brand_id (str, none_type): The global brand id associated to the product. [optional] # noqa: E501
263
- global_brand_name (str, none_type): The name of the global brand. [optional] # noqa: E501
264
- retailer_brand_id (str, none_type): The retailer brand id associated to the product. [optional] # noqa: E501
265
- retailer_brand_name (str, none_type): The name of the retailer brand. [optional] # noqa: E501
266
- global_category_id (str, none_type): the Global Category Id. [optional] # noqa: E501
267
- price (float, none_type): The product price pulled from the retailer's catalog. [optional] # noqa: E501
268
- model_number (str, none_type): The model number for the product. [optional] # noqa: E501
269
- is_in_stock (bool, none_type): Indicates if the retailer product is in stock. [optional] # noqa: E501
270
- gtin (str, none_type): A GTIN identifier for the product if available. TIt covers variations such as EANs and UPCs. [optional] # noqa: E501
271
- mpn (str, none_type): The MPN identifier for the product if available. [optional] # noqa: E501
272
- image_url (str, none_type): An http image resource provided by the retailer catalog. [optional] # noqa: E501
273
- updated_at (datetime, none_type): The last time this product was updated in the Retail Media Catalog. The date value is represented as an UTC ISO8601 string. [optional] # noqa: E501
274
- """
275
-
276
- _check_type = kwargs.pop('_check_type', True)
277
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
278
- _path_to_item = kwargs.pop('_path_to_item', ())
279
- _configuration = kwargs.pop('_configuration', None)
280
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
281
-
282
- if args:
283
- for arg in args:
284
- if isinstance(arg, dict):
285
- kwargs.update(arg)
286
- else:
287
- raise ApiTypeError(
288
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
289
- args,
290
- self.__class__.__name__,
291
- ),
292
- path_to_item=_path_to_item,
293
- valid_classes=(self.__class__,),
294
- )
295
-
296
- self._data_store = {}
297
- self._check_type = _check_type
298
- self._spec_property_naming = _spec_property_naming
299
- self._path_to_item = _path_to_item
300
- self._configuration = _configuration
301
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
302
-
303
- for var_name, var_value in kwargs.items():
304
- if var_name not in self.attribute_map and \
305
- self._configuration is not None and \
306
- self._configuration.discard_unknown_keys and \
307
- self.additional_properties_type is None:
308
- # discard variable.
309
- continue
310
- setattr(self, var_name, var_value)
311
- if var_name in self.read_only_vars:
312
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
313
- f"class with read only attributes.")