criteo-api-retailmedia-sdk 0.0.250819__py3-none-any.whl → 0.0.250902__py3-none-any.whl

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

Potentially problematic release.


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

Files changed (37) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/balance_api.py +2 -2
  3. criteo_api_retailmedia_preview/api/campaign_api.py +9 -11
  4. criteo_api_retailmedia_preview/api/catalog_api.py +445 -0
  5. criteo_api_retailmedia_preview/api_client.py +1 -1
  6. criteo_api_retailmedia_preview/configuration.py +1 -1
  7. criteo_api_retailmedia_preview/model/async_accounts_report.py +14 -0
  8. criteo_api_retailmedia_preview/model/async_campaigns_report.py +14 -0
  9. criteo_api_retailmedia_preview/model/async_fill_rate_report.py +10 -2
  10. criteo_api_retailmedia_preview/model/async_job_response.py +257 -0
  11. criteo_api_retailmedia_preview/model/async_line_items_report.py +14 -0
  12. criteo_api_retailmedia_preview/model/async_offsite_report.py +3 -3
  13. criteo_api_retailmedia_preview/model/line_item_capping_v2.py +1 -1
  14. criteo_api_retailmedia_preview/model/load_sku_offers_request.py +272 -0
  15. criteo_api_retailmedia_preview/model/offer_load.py +289 -0
  16. criteo_api_retailmedia_preview/model/offer_update.py +287 -0
  17. criteo_api_retailmedia_preview/model/preferred_line_item_v2.py +6 -2
  18. criteo_api_retailmedia_preview/model/set_sku_buy_box_winners_request.py +272 -0
  19. criteo_api_retailmedia_preview/model/sku_buy_box_winner.py +269 -0
  20. criteo_api_retailmedia_preview/model/sku_offer_load.py +278 -0
  21. criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +43 -44
  22. criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +32 -34
  23. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +10 -0
  24. criteo_api_retailmedia_preview/model/update_offers_request.py +272 -0
  25. criteo_api_retailmedia_preview/model/value_resource_async_job_response.py +266 -0
  26. criteo_api_retailmedia_preview/model/value_resource_input_load_sku_offers_request.py +262 -0
  27. criteo_api_retailmedia_preview/model/value_resource_input_set_sku_buy_box_winners_request.py +262 -0
  28. criteo_api_retailmedia_preview/model/value_resource_input_update_offers_request.py +262 -0
  29. criteo_api_retailmedia_preview/model/value_resource_load_sku_offers_request.py +266 -0
  30. criteo_api_retailmedia_preview/model/value_resource_outcome_async_job_response.py +274 -0
  31. criteo_api_retailmedia_preview/model/value_resource_set_sku_buy_box_winners_request.py +266 -0
  32. criteo_api_retailmedia_preview/model/value_resource_update_offers_request.py +266 -0
  33. criteo_api_retailmedia_preview/models/__init__.py +16 -0
  34. {criteo_api_retailmedia_sdk-0.0.250819.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/METADATA +3 -3
  35. {criteo_api_retailmedia_sdk-0.0.250819.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/RECORD +37 -21
  36. {criteo_api_retailmedia_sdk-0.0.250819.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/WHEEL +0 -0
  37. {criteo_api_retailmedia_sdk-0.0.250819.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,269 @@
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 SkuBuyBoxWinner(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
+ 'seller_id': (str,), # noqa: E501
79
+ 'sku_id': (str,), # noqa: E501
80
+ }
81
+
82
+ @cached_property
83
+ def discriminator():
84
+ return None
85
+
86
+
87
+ attribute_map = {
88
+ 'seller_id': 'sellerId', # noqa: E501
89
+ 'sku_id': 'skuId', # noqa: E501
90
+ }
91
+
92
+ read_only_vars = {
93
+ }
94
+
95
+ _composed_schemas = {}
96
+
97
+ @classmethod
98
+ @convert_js_args_to_python_args
99
+ def _from_openapi_data(cls, seller_id, sku_id, *args, **kwargs): # noqa: E501
100
+ """SkuBuyBoxWinner - a model defined in OpenAPI
101
+
102
+ Args:
103
+ seller_id (str):
104
+ sku_id (str):
105
+
106
+ Keyword Args:
107
+ _check_type (bool): if True, values for parameters in openapi_types
108
+ will be type checked and a TypeError will be
109
+ raised if the wrong type is input.
110
+ Defaults to True
111
+ _path_to_item (tuple/list): This is a list of keys or values to
112
+ drill down to the model in received_data
113
+ when deserializing a response
114
+ _spec_property_naming (bool): True if the variable names in the input data
115
+ are serialized names, as specified in the OpenAPI document.
116
+ False if the variable names in the input data
117
+ are pythonic names, e.g. snake case (default)
118
+ _configuration (Configuration): the instance to use when
119
+ deserializing a file_type parameter.
120
+ If passed, type conversion is attempted
121
+ If omitted no type conversion is done.
122
+ _visited_composed_classes (tuple): This stores a tuple of
123
+ classes that we have traveled through so that
124
+ if we see that class again we will not use its
125
+ discriminator again.
126
+ When traveling through a discriminator, the
127
+ composed schema that is
128
+ is traveled through is added to this set.
129
+ For example if Animal has a discriminator
130
+ petType and we pass in "Dog", and the class Dog
131
+ allOf includes Animal, we move through Animal
132
+ once using the discriminator, and pick Dog.
133
+ Then in Dog, we will make an instance of the
134
+ Animal class but this time we won't travel
135
+ through its discriminator because we passed in
136
+ _visited_composed_classes = (Animal,)
137
+ """
138
+
139
+ _check_type = kwargs.pop('_check_type', True)
140
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
141
+ _path_to_item = kwargs.pop('_path_to_item', ())
142
+ _configuration = kwargs.pop('_configuration', None)
143
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
144
+
145
+ self = super(OpenApiModel, cls).__new__(cls)
146
+
147
+ if args:
148
+ for arg in args:
149
+ if isinstance(arg, dict):
150
+ kwargs.update(arg)
151
+ else:
152
+ raise ApiTypeError(
153
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
154
+ args,
155
+ self.__class__.__name__,
156
+ ),
157
+ path_to_item=_path_to_item,
158
+ valid_classes=(self.__class__,),
159
+ )
160
+
161
+ self._data_store = {}
162
+ self._check_type = _check_type
163
+ self._spec_property_naming = _spec_property_naming
164
+ self._path_to_item = _path_to_item
165
+ self._configuration = _configuration
166
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
167
+
168
+ self.seller_id = seller_id
169
+ self.sku_id = sku_id
170
+ for var_name, var_value in kwargs.items():
171
+ if var_name not in self.attribute_map and \
172
+ self._configuration is not None and \
173
+ self._configuration.discard_unknown_keys and \
174
+ self.additional_properties_type is None:
175
+ # discard variable.
176
+ continue
177
+ setattr(self, var_name, var_value)
178
+ return self
179
+
180
+ required_properties = set([
181
+ '_data_store',
182
+ '_check_type',
183
+ '_spec_property_naming',
184
+ '_path_to_item',
185
+ '_configuration',
186
+ '_visited_composed_classes',
187
+ ])
188
+
189
+ @convert_js_args_to_python_args
190
+ def __init__(self, seller_id, sku_id, *args, **kwargs): # noqa: E501
191
+ """SkuBuyBoxWinner - a model defined in OpenAPI
192
+
193
+ Args:
194
+ seller_id (str):
195
+ sku_id (str):
196
+
197
+ Keyword Args:
198
+ _check_type (bool): if True, values for parameters in openapi_types
199
+ will be type checked and a TypeError will be
200
+ raised if the wrong type is input.
201
+ Defaults to True
202
+ _path_to_item (tuple/list): This is a list of keys or values to
203
+ drill down to the model in received_data
204
+ when deserializing a response
205
+ _spec_property_naming (bool): True if the variable names in the input data
206
+ are serialized names, as specified in the OpenAPI document.
207
+ False if the variable names in the input data
208
+ are pythonic names, e.g. snake case (default)
209
+ _configuration (Configuration): the instance to use when
210
+ deserializing a file_type parameter.
211
+ If passed, type conversion is attempted
212
+ If omitted no type conversion is done.
213
+ _visited_composed_classes (tuple): This stores a tuple of
214
+ classes that we have traveled through so that
215
+ if we see that class again we will not use its
216
+ discriminator again.
217
+ When traveling through a discriminator, the
218
+ composed schema that is
219
+ is traveled through is added to this set.
220
+ For example if Animal has a discriminator
221
+ petType and we pass in "Dog", and the class Dog
222
+ allOf includes Animal, we move through Animal
223
+ once using the discriminator, and pick Dog.
224
+ Then in Dog, we will make an instance of the
225
+ Animal class but this time we won't travel
226
+ through its discriminator because we passed in
227
+ _visited_composed_classes = (Animal,)
228
+ """
229
+
230
+ _check_type = kwargs.pop('_check_type', True)
231
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
232
+ _path_to_item = kwargs.pop('_path_to_item', ())
233
+ _configuration = kwargs.pop('_configuration', None)
234
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
235
+
236
+ if args:
237
+ for arg in args:
238
+ if isinstance(arg, dict):
239
+ kwargs.update(arg)
240
+ else:
241
+ raise ApiTypeError(
242
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
243
+ args,
244
+ self.__class__.__name__,
245
+ ),
246
+ path_to_item=_path_to_item,
247
+ valid_classes=(self.__class__,),
248
+ )
249
+
250
+ self._data_store = {}
251
+ self._check_type = _check_type
252
+ self._spec_property_naming = _spec_property_naming
253
+ self._path_to_item = _path_to_item
254
+ self._configuration = _configuration
255
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
256
+
257
+ self.seller_id = seller_id
258
+ self.sku_id = sku_id
259
+ for var_name, var_value in kwargs.items():
260
+ if var_name not in self.attribute_map and \
261
+ self._configuration is not None and \
262
+ self._configuration.discard_unknown_keys and \
263
+ self.additional_properties_type is None:
264
+ # discard variable.
265
+ continue
266
+ setattr(self, var_name, var_value)
267
+ if var_name in self.read_only_vars:
268
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
269
+ f"class with read only attributes.")
@@ -0,0 +1,278 @@
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
+ def lazy_import():
33
+ from criteo_api_retailmedia_preview.model.offer_load import OfferLoad
34
+ globals()['OfferLoad'] = OfferLoad
35
+
36
+
37
+ class SkuOfferLoad(ModelNormal):
38
+ """NOTE: This class is auto generated by OpenAPI Generator.
39
+ Ref: https://openapi-generator.tech
40
+
41
+ Do not edit the class manually.
42
+
43
+ Attributes:
44
+ allowed_values (dict): The key is the tuple path to the attribute
45
+ and the for var_name this is (var_name,). The value is a dict
46
+ with a capitalized key describing the allowed value and an allowed
47
+ value. These dicts store the allowed enum values.
48
+ attribute_map (dict): The key is attribute name
49
+ and the value is json key in definition.
50
+ discriminator_value_class_map (dict): A dict to go from the discriminator
51
+ variable value to the discriminator class name.
52
+ validations (dict): The key is the tuple path to the attribute
53
+ and the for var_name this is (var_name,). The value is a dict
54
+ that stores validations for max_length, min_length, max_items,
55
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
56
+ inclusive_minimum, and regex.
57
+ additional_properties_type (tuple): A tuple of classes accepted
58
+ as additional properties values.
59
+ """
60
+
61
+ allowed_values = {
62
+ }
63
+
64
+ validations = {
65
+ }
66
+
67
+ additional_properties_type = None
68
+
69
+ _nullable = False
70
+
71
+ @cached_property
72
+ def openapi_types():
73
+ """
74
+ This must be a method because a model may have properties that are
75
+ of type self, this must run after the class is loaded
76
+
77
+ Returns
78
+ openapi_types (dict): The key is attribute name
79
+ and the value is attribute type.
80
+ """
81
+ lazy_import()
82
+ return {
83
+ 'offers': ([OfferLoad],), # noqa: E501
84
+ 'sku_id': (str,), # noqa: E501
85
+ 'buy_box_winner': (str,), # noqa: E501
86
+ }
87
+
88
+ @cached_property
89
+ def discriminator():
90
+ return None
91
+
92
+
93
+ attribute_map = {
94
+ 'offers': 'offers', # noqa: E501
95
+ 'sku_id': 'skuId', # noqa: E501
96
+ 'buy_box_winner': 'buyBoxWinner', # noqa: E501
97
+ }
98
+
99
+ read_only_vars = {
100
+ }
101
+
102
+ _composed_schemas = {}
103
+
104
+ @classmethod
105
+ @convert_js_args_to_python_args
106
+ def _from_openapi_data(cls, offers, sku_id, *args, **kwargs): # noqa: E501
107
+ """SkuOfferLoad - a model defined in OpenAPI
108
+
109
+ Args:
110
+ offers ([OfferLoad]):
111
+ sku_id (str):
112
+
113
+ Keyword Args:
114
+ _check_type (bool): if True, values for parameters in openapi_types
115
+ will be type checked and a TypeError will be
116
+ raised if the wrong type is input.
117
+ Defaults to True
118
+ _path_to_item (tuple/list): This is a list of keys or values to
119
+ drill down to the model in received_data
120
+ when deserializing a response
121
+ _spec_property_naming (bool): True if the variable names in the input data
122
+ are serialized names, as specified in the OpenAPI document.
123
+ False if the variable names in the input data
124
+ are pythonic names, e.g. snake case (default)
125
+ _configuration (Configuration): the instance to use when
126
+ deserializing a file_type parameter.
127
+ If passed, type conversion is attempted
128
+ If omitted no type conversion is done.
129
+ _visited_composed_classes (tuple): This stores a tuple of
130
+ classes that we have traveled through so that
131
+ if we see that class again we will not use its
132
+ discriminator again.
133
+ When traveling through a discriminator, the
134
+ composed schema that is
135
+ is traveled through is added to this set.
136
+ For example if Animal has a discriminator
137
+ petType and we pass in "Dog", and the class Dog
138
+ allOf includes Animal, we move through Animal
139
+ once using the discriminator, and pick Dog.
140
+ Then in Dog, we will make an instance of the
141
+ Animal class but this time we won't travel
142
+ through its discriminator because we passed in
143
+ _visited_composed_classes = (Animal,)
144
+ buy_box_winner (str): [optional] # noqa: E501
145
+ """
146
+
147
+ _check_type = kwargs.pop('_check_type', True)
148
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
149
+ _path_to_item = kwargs.pop('_path_to_item', ())
150
+ _configuration = kwargs.pop('_configuration', None)
151
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
152
+
153
+ self = super(OpenApiModel, cls).__new__(cls)
154
+
155
+ if args:
156
+ for arg in args:
157
+ if isinstance(arg, dict):
158
+ kwargs.update(arg)
159
+ else:
160
+ raise ApiTypeError(
161
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
162
+ args,
163
+ self.__class__.__name__,
164
+ ),
165
+ path_to_item=_path_to_item,
166
+ valid_classes=(self.__class__,),
167
+ )
168
+
169
+ self._data_store = {}
170
+ self._check_type = _check_type
171
+ self._spec_property_naming = _spec_property_naming
172
+ self._path_to_item = _path_to_item
173
+ self._configuration = _configuration
174
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
175
+
176
+ self.offers = offers
177
+ self.sku_id = sku_id
178
+ for var_name, var_value in kwargs.items():
179
+ if var_name not in self.attribute_map and \
180
+ self._configuration is not None and \
181
+ self._configuration.discard_unknown_keys and \
182
+ self.additional_properties_type is None:
183
+ # discard variable.
184
+ continue
185
+ setattr(self, var_name, var_value)
186
+ return self
187
+
188
+ required_properties = set([
189
+ '_data_store',
190
+ '_check_type',
191
+ '_spec_property_naming',
192
+ '_path_to_item',
193
+ '_configuration',
194
+ '_visited_composed_classes',
195
+ ])
196
+
197
+ @convert_js_args_to_python_args
198
+ def __init__(self, offers, sku_id, *args, **kwargs): # noqa: E501
199
+ """SkuOfferLoad - a model defined in OpenAPI
200
+
201
+ Args:
202
+ offers ([OfferLoad]):
203
+ sku_id (str):
204
+
205
+ Keyword Args:
206
+ _check_type (bool): if True, values for parameters in openapi_types
207
+ will be type checked and a TypeError will be
208
+ raised if the wrong type is input.
209
+ Defaults to True
210
+ _path_to_item (tuple/list): This is a list of keys or values to
211
+ drill down to the model in received_data
212
+ when deserializing a response
213
+ _spec_property_naming (bool): True if the variable names in the input data
214
+ are serialized names, as specified in the OpenAPI document.
215
+ False if the variable names in the input data
216
+ are pythonic names, e.g. snake case (default)
217
+ _configuration (Configuration): the instance to use when
218
+ deserializing a file_type parameter.
219
+ If passed, type conversion is attempted
220
+ If omitted no type conversion is done.
221
+ _visited_composed_classes (tuple): This stores a tuple of
222
+ classes that we have traveled through so that
223
+ if we see that class again we will not use its
224
+ discriminator again.
225
+ When traveling through a discriminator, the
226
+ composed schema that is
227
+ is traveled through is added to this set.
228
+ For example if Animal has a discriminator
229
+ petType and we pass in "Dog", and the class Dog
230
+ allOf includes Animal, we move through Animal
231
+ once using the discriminator, and pick Dog.
232
+ Then in Dog, we will make an instance of the
233
+ Animal class but this time we won't travel
234
+ through its discriminator because we passed in
235
+ _visited_composed_classes = (Animal,)
236
+ buy_box_winner (str): [optional] # noqa: E501
237
+ """
238
+
239
+ _check_type = kwargs.pop('_check_type', True)
240
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
241
+ _path_to_item = kwargs.pop('_path_to_item', ())
242
+ _configuration = kwargs.pop('_configuration', None)
243
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
244
+
245
+ if args:
246
+ for arg in args:
247
+ if isinstance(arg, dict):
248
+ kwargs.update(arg)
249
+ else:
250
+ raise ApiTypeError(
251
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
252
+ args,
253
+ self.__class__.__name__,
254
+ ),
255
+ path_to_item=_path_to_item,
256
+ valid_classes=(self.__class__,),
257
+ )
258
+
259
+ self._data_store = {}
260
+ self._check_type = _check_type
261
+ self._spec_property_naming = _spec_property_naming
262
+ self._path_to_item = _path_to_item
263
+ self._configuration = _configuration
264
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
265
+
266
+ self.offers = offers
267
+ self.sku_id = sku_id
268
+ for var_name, var_value in kwargs.items():
269
+ if var_name not in self.attribute_map and \
270
+ self._configuration is not None and \
271
+ self._configuration.discard_unknown_keys and \
272
+ self.additional_properties_type is None:
273
+ # discard variable.
274
+ continue
275
+ setattr(self, var_name, var_value)
276
+ if var_name in self.read_only_vars:
277
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
278
+ f"class with read only attributes.")