criteo-api-retailmedia-sdk 0.0.250409__py3-none-any.whl → 0.0.250606__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 (96) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +3 -147
  3. criteo_api_retailmedia_preview/api/analytics_api.py +1 -1
  4. criteo_api_retailmedia_preview/api/audience_api.py +1204 -135
  5. criteo_api_retailmedia_preview/api/campaign_api.py +741 -104
  6. criteo_api_retailmedia_preview/api_client.py +1 -1
  7. criteo_api_retailmedia_preview/configuration.py +1 -1
  8. criteo_api_retailmedia_preview/model/account_fees_update_request.py +4 -0
  9. criteo_api_retailmedia_preview/model/async_accounts_report.py +6 -6
  10. criteo_api_retailmedia_preview/model/async_campaigns_report.py +4 -4
  11. criteo_api_retailmedia_preview/model/async_line_items_report.py +4 -4
  12. criteo_api_retailmedia_preview/model/async_offsite_report.py +25 -18
  13. criteo_api_retailmedia_preview/model/brand_id_search_request.py +7 -1
  14. criteo_api_retailmedia_preview/model/brand_id_search_result.py +7 -1
  15. criteo_api_retailmedia_preview/model/categories_search_request_v1.py +270 -0
  16. criteo_api_retailmedia_preview/model/entity_resource_brand_id_search_result.py +8 -1
  17. criteo_api_retailmedia_preview/model/entity_resource_category202204.py +277 -0
  18. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_brand_id_search_result_paging_offset_limit_metadata.py +8 -1
  19. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204.py +281 -0
  20. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204_metadata.py +287 -0
  21. criteo_api_retailmedia_preview/model/entity_resource_of_sponsored_products_line_item.py +270 -0
  22. criteo_api_retailmedia_preview/model/entity_resource_outcome_of_sponsored_products_line_item.py +274 -0
  23. criteo_api_retailmedia_preview/model/{input_keywords.py → flight_leg.py} +39 -17
  24. criteo_api_retailmedia_preview/model/{recommended_keywords_result.py → flight_schedule.py} +9 -13
  25. criteo_api_retailmedia_preview/model/nillable_decimal.py +263 -0
  26. criteo_api_retailmedia_preview/model/page_of_sponsored_products_line_item.py +276 -0
  27. criteo_api_retailmedia_preview/model/paging_offset_limit_metadata.py +7 -1
  28. criteo_api_retailmedia_preview/model/{grant_consent_model.py → recommended_categories_request_v1.py} +14 -21
  29. criteo_api_retailmedia_preview/model/recommended_keywords_request_v1.py +266 -0
  30. criteo_api_retailmedia_preview/model/recommended_keywords_response_v1.py +263 -0
  31. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_request.py → rm_audience_bulk_create_input_v1.py} +9 -9
  32. criteo_api_retailmedia_preview/model/{grant_consent_input.py → rm_audience_bulk_delete_input_v1.py} +8 -8
  33. criteo_api_retailmedia_preview/model/rm_audience_bulk_update_input_v1.py +269 -0
  34. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1.py +272 -0
  35. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1_resource.py +273 -0
  36. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_input_v1.py +269 -0
  37. criteo_api_retailmedia_preview/model/rm_audience_create_entity_v1.py +291 -0
  38. criteo_api_retailmedia_preview/model/{grant_consent_model_value_resource.py → rm_audience_create_entity_v1_resource.py} +8 -8
  39. criteo_api_retailmedia_preview/model/rm_audience_delete_entity_v1_resource.py +271 -0
  40. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_recommended_keywords_result.py → rm_audience_entity_v1_list_response.py} +16 -9
  41. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1.py +282 -0
  42. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1_resource.py +273 -0
  43. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_input_v1.py +269 -0
  44. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1.py +272 -0
  45. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1_resource.py +273 -0
  46. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_sizes_input_v1.py +269 -0
  47. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +6 -0
  48. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1.py +282 -0
  49. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1_resource.py +273 -0
  50. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_input_v1.py +269 -0
  51. criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1.py +267 -0
  52. criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1_list_response.py +281 -0
  53. criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers_v2.py → rm_audience_segment_size_entity_v1_resource.py} +11 -11
  54. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1.py +267 -0
  55. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_resource.py +273 -0
  56. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_response.py +281 -0
  57. criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1.py +6 -0
  58. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1.py +267 -0
  59. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_list_response.py +281 -0
  60. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_resource.py +277 -0
  61. criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1.py +267 -0
  62. criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1_resource.py +273 -0
  63. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_response.py → rm_audience_size_estimation_v1_response.py} +9 -9
  64. criteo_api_retailmedia_preview/model/rm_audience_update_entity_v1.py +279 -0
  65. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py → rm_audience_update_entity_v1_resource.py} +17 -19
  66. criteo_api_retailmedia_preview/model/rm_events_create_v1.py +305 -0
  67. criteo_api_retailmedia_preview/model/rm_events_estimation_v1.py +305 -0
  68. criteo_api_retailmedia_preview/model/rm_events_update_v1.py +307 -0
  69. criteo_api_retailmedia_preview/model/sku_slim_data_preview.py +6 -6
  70. criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +387 -0
  71. criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers_v2.py → sponsored_products_line_item_create_request_model.py} +81 -33
  72. criteo_api_retailmedia_preview/model/{keywords.py → sponsored_products_line_item_update_request_model.py} +82 -44
  73. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +2 -2
  74. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +4 -4
  75. criteo_api_retailmedia_preview/model/sync_line_items_report.py +4 -4
  76. criteo_api_retailmedia_preview/model/value_resource_brand_id_search_request.py +8 -1
  77. criteo_api_retailmedia_preview/model/value_resource_categories_search_request_v1.py +273 -0
  78. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_private_market_account_fees.py → value_resource_collection_outcome_private_market_account_fees_and_metadata.py} +9 -3
  79. criteo_api_retailmedia_preview/model/value_resource_input_brand_id_search_request.py +8 -1
  80. criteo_api_retailmedia_preview/model/value_resource_input_categories_search_request_v1.py +269 -0
  81. criteo_api_retailmedia_preview/model/value_resource_input_of_sponsored_products_line_item_update_request_model.py +262 -0
  82. criteo_api_retailmedia_preview/model/value_resource_input_recommended_categories_request_v1.py +269 -0
  83. criteo_api_retailmedia_preview/model/value_resource_input_recommended_keywords_request_v1.py +262 -0
  84. criteo_api_retailmedia_preview/model/value_resource_of_sponsored_products_line_item_update_request_model.py +266 -0
  85. criteo_api_retailmedia_preview/model/value_resource_outcome_recommended_keywords_response_v1.py +274 -0
  86. criteo_api_retailmedia_preview/model/value_resource_recommended_categories_request_v1.py +273 -0
  87. criteo_api_retailmedia_preview/model/value_resource_recommended_keywords_request_v1.py +266 -0
  88. criteo_api_retailmedia_preview/model/{value_resource_of_recommended_keywords_result.py → value_resource_recommended_keywords_response_v1.py} +10 -10
  89. criteo_api_retailmedia_preview/models/__init__.py +63 -17
  90. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/METADATA +3 -3
  91. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/RECORD +93 -47
  92. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/WHEEL +1 -1
  93. criteo_api_retailmedia_preview/model/common_error.py +0 -301
  94. criteo_api_retailmedia_preview/model/common_warning.py +0 -301
  95. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +0 -307
  96. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/top_level.txt +0 -0
@@ -1,307 +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 ExternalLineItemBidMultipliersV2(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
- @cached_property
64
- def additional_properties_type():
65
- """
66
- This must be a method because a model may have properties that are
67
- of type self, this must run after the class is loaded
68
- """
69
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
70
-
71
- _nullable = True
72
-
73
- @cached_property
74
- def openapi_types():
75
- """
76
- This must be a method because a model may have properties that are
77
- of type self, this must run after the class is loaded
78
-
79
- Returns
80
- openapi_types (dict): The key is attribute name
81
- and the value is attribute type.
82
- """
83
- return {
84
- 'category': (float, none_type,), # noqa: E501
85
- 'category_menu': (float, none_type,), # noqa: E501
86
- 'checkout': (float, none_type,), # noqa: E501
87
- 'confirmation': (float, none_type,), # noqa: E501
88
- 'deals': (float, none_type,), # noqa: E501
89
- 'favorites': (float, none_type,), # noqa: E501
90
- 'home': (float, none_type,), # noqa: E501
91
- 'id': (str, none_type,), # noqa: E501
92
- 'merchandising': (float, none_type,), # noqa: E501
93
- 'product_detail': (float, none_type,), # noqa: E501
94
- 'search': (float, none_type,), # noqa: E501
95
- 'search_bar': (float, none_type,), # noqa: E501
96
- }
97
-
98
- @cached_property
99
- def discriminator():
100
- return None
101
-
102
-
103
- attribute_map = {
104
- 'category': 'category', # noqa: E501
105
- 'category_menu': 'categoryMenu', # noqa: E501
106
- 'checkout': 'checkout', # noqa: E501
107
- 'confirmation': 'confirmation', # noqa: E501
108
- 'deals': 'deals', # noqa: E501
109
- 'favorites': 'favorites', # noqa: E501
110
- 'home': 'home', # noqa: E501
111
- 'id': 'id', # noqa: E501
112
- 'merchandising': 'merchandising', # noqa: E501
113
- 'product_detail': 'productDetail', # noqa: E501
114
- 'search': 'search', # noqa: E501
115
- 'search_bar': 'searchBar', # 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
- """ExternalLineItemBidMultipliersV2 - 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
- category (float, none_type): Categories Page Type Bid Multiplier. [optional] # noqa: E501
160
- category_menu (float, none_type): CategoryMenu Page Type Bid Multiplier. [optional] # noqa: E501
161
- checkout (float, none_type): Checkout Page Type Bid Multiplier. [optional] # noqa: E501
162
- confirmation (float, none_type): Confirmation Page Type Bid Multiplier. [optional] # noqa: E501
163
- deals (float, none_type): Deals Page Type Bid Multiplier. [optional] # noqa: E501
164
- favorites (float, none_type): Favorites Page Type Bid Multiplier. [optional] # noqa: E501
165
- home (float, none_type): Home Page Type Bid Multiplier. [optional] # noqa: E501
166
- id (str, none_type): Id of the entity. [optional] # noqa: E501
167
- merchandising (float, none_type): Merchandising Page Type Bid Multiplier. [optional] # noqa: E501
168
- product_detail (float, none_type): ProductDetail Page Type Bid Multiplier. [optional] # noqa: E501
169
- search (float, none_type): Search Page Type Bid Multiplier. [optional] # noqa: E501
170
- search_bar (float, none_type): SearchBar Page Type Bid Multiplier. [optional] # noqa: E501
171
- """
172
-
173
- _check_type = kwargs.pop('_check_type', True)
174
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
175
- _path_to_item = kwargs.pop('_path_to_item', ())
176
- _configuration = kwargs.pop('_configuration', None)
177
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
178
-
179
- self = super(OpenApiModel, cls).__new__(cls)
180
-
181
- if args:
182
- for arg in args:
183
- if isinstance(arg, dict):
184
- kwargs.update(arg)
185
- else:
186
- raise ApiTypeError(
187
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
188
- args,
189
- self.__class__.__name__,
190
- ),
191
- path_to_item=_path_to_item,
192
- valid_classes=(self.__class__,),
193
- )
194
-
195
- self._data_store = {}
196
- self._check_type = _check_type
197
- self._spec_property_naming = _spec_property_naming
198
- self._path_to_item = _path_to_item
199
- self._configuration = _configuration
200
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
201
-
202
- for var_name, var_value in kwargs.items():
203
- if var_name not in self.attribute_map and \
204
- self._configuration is not None and \
205
- self._configuration.discard_unknown_keys and \
206
- self.additional_properties_type is None:
207
- # discard variable.
208
- continue
209
- setattr(self, var_name, var_value)
210
- return self
211
-
212
- required_properties = set([
213
- '_data_store',
214
- '_check_type',
215
- '_spec_property_naming',
216
- '_path_to_item',
217
- '_configuration',
218
- '_visited_composed_classes',
219
- ])
220
-
221
- @convert_js_args_to_python_args
222
- def __init__(self, *args, **kwargs): # noqa: E501
223
- """ExternalLineItemBidMultipliersV2 - a model defined in OpenAPI
224
-
225
- Keyword Args:
226
- _check_type (bool): if True, values for parameters in openapi_types
227
- will be type checked and a TypeError will be
228
- raised if the wrong type is input.
229
- Defaults to True
230
- _path_to_item (tuple/list): This is a list of keys or values to
231
- drill down to the model in received_data
232
- when deserializing a response
233
- _spec_property_naming (bool): True if the variable names in the input data
234
- are serialized names, as specified in the OpenAPI document.
235
- False if the variable names in the input data
236
- are pythonic names, e.g. snake case (default)
237
- _configuration (Configuration): the instance to use when
238
- deserializing a file_type parameter.
239
- If passed, type conversion is attempted
240
- If omitted no type conversion is done.
241
- _visited_composed_classes (tuple): This stores a tuple of
242
- classes that we have traveled through so that
243
- if we see that class again we will not use its
244
- discriminator again.
245
- When traveling through a discriminator, the
246
- composed schema that is
247
- is traveled through is added to this set.
248
- For example if Animal has a discriminator
249
- petType and we pass in "Dog", and the class Dog
250
- allOf includes Animal, we move through Animal
251
- once using the discriminator, and pick Dog.
252
- Then in Dog, we will make an instance of the
253
- Animal class but this time we won't travel
254
- through its discriminator because we passed in
255
- _visited_composed_classes = (Animal,)
256
- category (float, none_type): Categories Page Type Bid Multiplier. [optional] # noqa: E501
257
- category_menu (float, none_type): CategoryMenu Page Type Bid Multiplier. [optional] # noqa: E501
258
- checkout (float, none_type): Checkout Page Type Bid Multiplier. [optional] # noqa: E501
259
- confirmation (float, none_type): Confirmation Page Type Bid Multiplier. [optional] # noqa: E501
260
- deals (float, none_type): Deals Page Type Bid Multiplier. [optional] # noqa: E501
261
- favorites (float, none_type): Favorites Page Type Bid Multiplier. [optional] # noqa: E501
262
- home (float, none_type): Home Page Type Bid Multiplier. [optional] # noqa: E501
263
- id (str, none_type): Id of the entity. [optional] # noqa: E501
264
- merchandising (float, none_type): Merchandising Page Type Bid Multiplier. [optional] # noqa: E501
265
- product_detail (float, none_type): ProductDetail Page Type Bid Multiplier. [optional] # noqa: E501
266
- search (float, none_type): Search Page Type Bid Multiplier. [optional] # noqa: E501
267
- search_bar (float, none_type): SearchBar Page Type Bid Multiplier. [optional] # noqa: E501
268
- """
269
-
270
- _check_type = kwargs.pop('_check_type', True)
271
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
272
- _path_to_item = kwargs.pop('_path_to_item', ())
273
- _configuration = kwargs.pop('_configuration', None)
274
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
275
-
276
- if args:
277
- for arg in args:
278
- if isinstance(arg, dict):
279
- kwargs.update(arg)
280
- else:
281
- raise ApiTypeError(
282
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
283
- args,
284
- self.__class__.__name__,
285
- ),
286
- path_to_item=_path_to_item,
287
- valid_classes=(self.__class__,),
288
- )
289
-
290
- self._data_store = {}
291
- self._check_type = _check_type
292
- self._spec_property_naming = _spec_property_naming
293
- self._path_to_item = _path_to_item
294
- self._configuration = _configuration
295
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
296
-
297
- for var_name, var_value in kwargs.items():
298
- if var_name not in self.attribute_map and \
299
- self._configuration is not None and \
300
- self._configuration.discard_unknown_keys and \
301
- self.additional_properties_type is None:
302
- # discard variable.
303
- continue
304
- setattr(self, var_name, var_value)
305
- if var_name in self.read_only_vars:
306
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
307
- f"class with read only attributes.")