criteo-api-retailmedia-sdk 2025.1.0.250129__py3-none-any.whl → 2025.1.0.250211__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 (24) hide show
  1. {criteo_api_retailmedia_sdk-2025.1.0.250129.dist-info → criteo_api_retailmedia_sdk-2025.1.0.250211.dist-info}/METADATA +3 -3
  2. {criteo_api_retailmedia_sdk-2025.1.0.250129.dist-info → criteo_api_retailmedia_sdk-2025.1.0.250211.dist-info}/RECORD +20 -24
  3. criteo_api_retailmedia_v2025_01/__init__.py +1 -1
  4. criteo_api_retailmedia_v2025_01/api/campaign_api.py +6 -167
  5. criteo_api_retailmedia_v2025_01/api_client.py +1 -1
  6. criteo_api_retailmedia_v2025_01/configuration.py +1 -1
  7. criteo_api_retailmedia_v2025_01/model/async_campaigns_report.py +4 -0
  8. criteo_api_retailmedia_v2025_01/model/async_line_items_report.py +4 -0
  9. criteo_api_retailmedia_v2025_01/model/balance_response_v2.py +4 -4
  10. criteo_api_retailmedia_v2025_01/model/campaign_attributes_v202301.py +8 -8
  11. criteo_api_retailmedia_v2025_01/model/campaign_v202301.py +8 -8
  12. criteo_api_retailmedia_v2025_01/model/editable_campaign_attributes_v202301.py +6 -6
  13. criteo_api_retailmedia_v2025_01/model/external_catalog_status.py +3 -3
  14. criteo_api_retailmedia_v2025_01/model/external_retailer.py +2 -0
  15. criteo_api_retailmedia_v2025_01/model/line_item_product_status.py +7 -7
  16. criteo_api_retailmedia_v2025_01/model/retail_media_contactlist_operation.py +4 -0
  17. criteo_api_retailmedia_v2025_01/model/retail_media_contactlist_operation_response_attributes.py +36 -20
  18. criteo_api_retailmedia_v2025_01/models/__init__.py +0 -4
  19. criteo_api_retailmedia_v2025_01/model/brand_preview.py +0 -269
  20. criteo_api_retailmedia_v2025_01/model/brand_preview_list_response.py +0 -281
  21. criteo_api_retailmedia_v2025_01/model/resource_of_brand_preview.py +0 -277
  22. criteo_api_retailmedia_v2025_01/model/retail_media_contactlist_operation_response_attributes_attributes.py +0 -297
  23. {criteo_api_retailmedia_sdk-2025.1.0.250129.dist-info → criteo_api_retailmedia_sdk-2025.1.0.250211.dist-info}/WHEEL +0 -0
  24. {criteo_api_retailmedia_sdk-2025.1.0.250129.dist-info → criteo_api_retailmedia_sdk-2025.1.0.250211.dist-info}/top_level.txt +0 -0
@@ -94,6 +94,7 @@ class RetailMediaContactlistOperation(ModelNormal):
94
94
  'data': (RetailMediaContactlistOperationResponseAttributes,), # noqa: E501
95
95
  'errors': ([AudienceError],), # noqa: E501
96
96
  'warnings': ([AudienceWarning],), # noqa: E501
97
+ 'type': (str, none_type,), # noqa: E501
97
98
  }
98
99
 
99
100
  @cached_property
@@ -105,6 +106,7 @@ class RetailMediaContactlistOperation(ModelNormal):
105
106
  'data': 'data', # noqa: E501
106
107
  'errors': 'errors', # noqa: E501
107
108
  'warnings': 'warnings', # noqa: E501
109
+ 'type': 'type', # noqa: E501
108
110
  }
109
111
 
110
112
  read_only_vars = {
@@ -153,6 +155,7 @@ class RetailMediaContactlistOperation(ModelNormal):
153
155
  Animal class but this time we won't travel
154
156
  through its discriminator because we passed in
155
157
  _visited_composed_classes = (Animal,)
158
+ type (str, none_type): the name of the entity type. [optional] # noqa: E501
156
159
  """
157
160
 
158
161
  _check_type = kwargs.pop('_check_type', True)
@@ -246,6 +249,7 @@ class RetailMediaContactlistOperation(ModelNormal):
246
249
  Animal class but this time we won't travel
247
250
  through its discriminator because we passed in
248
251
  _visited_composed_classes = (Animal,)
252
+ type (str, none_type): the name of the entity type. [optional] # noqa: E501
249
253
  """
250
254
 
251
255
  _check_type = kwargs.pop('_check_type', True)
@@ -29,10 +29,6 @@ from criteo_api_retailmedia_v2025_01.model_utils import ( # noqa: F401
29
29
  from criteo_api_retailmedia_v2025_01.exceptions import ApiAttributeError
30
30
 
31
31
 
32
- def lazy_import():
33
- from criteo_api_retailmedia_v2025_01.model.retail_media_contactlist_operation_response_attributes_attributes import RetailMediaContactlistOperationResponseAttributesAttributes
34
- globals()['RetailMediaContactlistOperationResponseAttributesAttributes'] = RetailMediaContactlistOperationResponseAttributesAttributes
35
-
36
32
 
37
33
  class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
38
34
  """NOTE: This class is auto generated by OpenAPI Generator.
@@ -70,7 +66,6 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
70
66
  This must be a method because a model may have properties that are
71
67
  of type self, this must run after the class is loaded
72
68
  """
73
- lazy_import()
74
69
  return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
75
70
 
76
71
  _nullable = False
@@ -85,10 +80,14 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
85
80
  openapi_types (dict): The key is attribute name
86
81
  and the value is attribute type.
87
82
  """
88
- lazy_import()
89
83
  return {
90
- 'type': (str,), # noqa: E501
91
- 'attributes': (RetailMediaContactlistOperationResponseAttributesAttributes,), # noqa: E501
84
+ 'contact_list_id': (int,), # noqa: E501
85
+ 'operation': (str,), # noqa: E501
86
+ 'request_date': (datetime,), # noqa: E501
87
+ 'identifier_type': (str, none_type,), # noqa: E501
88
+ 'nb_invalid_identifiers': (int, none_type,), # noqa: E501
89
+ 'nb_valid_identifiers': (int, none_type,), # noqa: E501
90
+ 'sample_invalid_identifiers': ([str], none_type,), # noqa: E501
92
91
  }
93
92
 
94
93
  @cached_property
@@ -97,8 +96,13 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
97
96
 
98
97
 
99
98
  attribute_map = {
100
- 'type': 'type', # noqa: E501
101
- 'attributes': 'attributes', # noqa: E501
99
+ 'contact_list_id': 'contactListId', # noqa: E501
100
+ 'operation': 'operation', # noqa: E501
101
+ 'request_date': 'requestDate', # noqa: E501
102
+ 'identifier_type': 'identifierType', # noqa: E501
103
+ 'nb_invalid_identifiers': 'nbInvalidIdentifiers', # noqa: E501
104
+ 'nb_valid_identifiers': 'nbValidIdentifiers', # noqa: E501
105
+ 'sample_invalid_identifiers': 'sampleInvalidIdentifiers', # noqa: E501
102
106
  }
103
107
 
104
108
  read_only_vars = {
@@ -108,12 +112,13 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
108
112
 
109
113
  @classmethod
110
114
  @convert_js_args_to_python_args
111
- def _from_openapi_data(cls, type, attributes, *args, **kwargs): # noqa: E501
115
+ def _from_openapi_data(cls, contact_list_id, operation, request_date, *args, **kwargs): # noqa: E501
112
116
  """RetailMediaContactlistOperationResponseAttributes - a model defined in OpenAPI
113
117
 
114
118
  Args:
115
- type (str): the name of the entity type
116
- attributes (RetailMediaContactlistOperationResponseAttributesAttributes):
119
+ contact_list_id (int): The affected user list id
120
+ operation (str): The action recorded
121
+ request_date (datetime): When the action was recorded
117
122
 
118
123
  Keyword Args:
119
124
  _check_type (bool): if True, values for parameters in openapi_types
@@ -146,6 +151,10 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
146
151
  Animal class but this time we won't travel
147
152
  through its discriminator because we passed in
148
153
  _visited_composed_classes = (Animal,)
154
+ identifier_type (str, none_type): The schema specified for of the identifiers. [optional] # noqa: E501
155
+ nb_invalid_identifiers (int, none_type): How many identifiers were invalid for the specified schema. [optional] # noqa: E501
156
+ nb_valid_identifiers (int, none_type): How many identifiers were valid for the specified schema. [optional] # noqa: E501
157
+ sample_invalid_identifiers ([str], none_type): A sample of invalid identifiers if there is some. [optional] # noqa: E501
149
158
  """
150
159
 
151
160
  _check_type = kwargs.pop('_check_type', True)
@@ -177,8 +186,9 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
177
186
  self._configuration = _configuration
178
187
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
179
188
 
180
- self.type = type
181
- self.attributes = attributes
189
+ self.contact_list_id = contact_list_id
190
+ self.operation = operation
191
+ self.request_date = request_date
182
192
  for var_name, var_value in kwargs.items():
183
193
  if var_name not in self.attribute_map and \
184
194
  self._configuration is not None and \
@@ -199,12 +209,13 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
199
209
  ])
200
210
 
201
211
  @convert_js_args_to_python_args
202
- def __init__(self, type, attributes, *args, **kwargs): # noqa: E501
212
+ def __init__(self, contact_list_id, operation, request_date, *args, **kwargs): # noqa: E501
203
213
  """RetailMediaContactlistOperationResponseAttributes - a model defined in OpenAPI
204
214
 
205
215
  Args:
206
- type (str): the name of the entity type
207
- attributes (RetailMediaContactlistOperationResponseAttributesAttributes):
216
+ contact_list_id (int): The affected user list id
217
+ operation (str): The action recorded
218
+ request_date (datetime): When the action was recorded
208
219
 
209
220
  Keyword Args:
210
221
  _check_type (bool): if True, values for parameters in openapi_types
@@ -237,6 +248,10 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
237
248
  Animal class but this time we won't travel
238
249
  through its discriminator because we passed in
239
250
  _visited_composed_classes = (Animal,)
251
+ identifier_type (str, none_type): The schema specified for of the identifiers. [optional] # noqa: E501
252
+ nb_invalid_identifiers (int, none_type): How many identifiers were invalid for the specified schema. [optional] # noqa: E501
253
+ nb_valid_identifiers (int, none_type): How many identifiers were valid for the specified schema. [optional] # noqa: E501
254
+ sample_invalid_identifiers ([str], none_type): A sample of invalid identifiers if there is some. [optional] # noqa: E501
240
255
  """
241
256
 
242
257
  _check_type = kwargs.pop('_check_type', True)
@@ -266,8 +281,9 @@ class RetailMediaContactlistOperationResponseAttributes(ModelNormal):
266
281
  self._configuration = _configuration
267
282
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
268
283
 
269
- self.type = type
270
- self.attributes = attributes
284
+ self.contact_list_id = contact_list_id
285
+ self.operation = operation
286
+ self.request_date = request_date
271
287
  for var_name, var_value in kwargs.items():
272
288
  if var_name not in self.attribute_map and \
273
289
  self._configuration is not None and \
@@ -48,8 +48,6 @@ from criteo_api_retailmedia_v2025_01.model.balance_campaign202110_paged_list_res
48
48
  from criteo_api_retailmedia_v2025_01.model.balance_history_change_data_capture_v1 import BalanceHistoryChangeDataCaptureV1
49
49
  from criteo_api_retailmedia_v2025_01.model.balance_response_v2 import BalanceResponseV2
50
50
  from criteo_api_retailmedia_v2025_01.model.balance_response_v2_response import BalanceResponseV2Response
51
- from criteo_api_retailmedia_v2025_01.model.brand_preview import BrandPreview
52
- from criteo_api_retailmedia_v2025_01.model.brand_preview_list_response import BrandPreviewListResponse
53
51
  from criteo_api_retailmedia_v2025_01.model.campaign_attributes_v202301 import CampaignAttributesV202301
54
52
  from criteo_api_retailmedia_v2025_01.model.campaign_budget_overrides import CampaignBudgetOverrides
55
53
  from criteo_api_retailmedia_v2025_01.model.campaign_daily_budget_override import CampaignDailyBudgetOverride
@@ -183,7 +181,6 @@ from criteo_api_retailmedia_v2025_01.model.resource_of_auction_line_item import
183
181
  from criteo_api_retailmedia_v2025_01.model.resource_of_auction_line_item_update_model import ResourceOfAuctionLineItemUpdateModel
184
182
  from criteo_api_retailmedia_v2025_01.model.resource_of_balance_campaign202110 import ResourceOfBalanceCampaign202110
185
183
  from criteo_api_retailmedia_v2025_01.model.resource_of_balance_response_v2 import ResourceOfBalanceResponseV2
186
- from criteo_api_retailmedia_v2025_01.model.resource_of_brand_preview import ResourceOfBrandPreview
187
184
  from criteo_api_retailmedia_v2025_01.model.resource_of_category202204 import ResourceOfCategory202204
188
185
  from criteo_api_retailmedia_v2025_01.model.resource_of_change_dates_of_balance_v2 import ResourceOfChangeDatesOfBalanceV2
189
186
  from criteo_api_retailmedia_v2025_01.model.resource_of_common_line_item import ResourceOfCommonLineItem
@@ -202,7 +199,6 @@ from criteo_api_retailmedia_v2025_01.model.retail_media_contactlist_amendment_at
202
199
  from criteo_api_retailmedia_v2025_01.model.retail_media_contactlist_amendment_request import RetailMediaContactlistAmendmentRequest
203
200
  from criteo_api_retailmedia_v2025_01.model.retail_media_contactlist_operation import RetailMediaContactlistOperation
204
201
  from criteo_api_retailmedia_v2025_01.model.retail_media_contactlist_operation_response_attributes import RetailMediaContactlistOperationResponseAttributes
205
- from criteo_api_retailmedia_v2025_01.model.retail_media_contactlist_operation_response_attributes_attributes import RetailMediaContactlistOperationResponseAttributesAttributes
206
202
  from criteo_api_retailmedia_v2025_01.model.review_state_model import ReviewStateModel
207
203
  from criteo_api_retailmedia_v2025_01.model.rm_algebra_node_v1 import RmAlgebraNodeV1
208
204
  from criteo_api_retailmedia_v2025_01.model.rm_audience_entity_v1 import RmAudienceEntityV1
@@ -1,269 +0,0 @@
1
- """
2
- Criteo API
3
-
4
- Criteo API - RetailMedia # noqa: E501
5
-
6
- The version of the OpenAPI document: 2025-01
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_v2025_01.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_v2025_01.exceptions import ApiAttributeError
30
-
31
-
32
-
33
- class BrandPreview(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 = False
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
- 'name': (str,), # noqa: E501
85
- }
86
-
87
- @cached_property
88
- def discriminator():
89
- return None
90
-
91
-
92
- attribute_map = {
93
- 'name': 'name', # noqa: E501
94
- }
95
-
96
- read_only_vars = {
97
- }
98
-
99
- _composed_schemas = {}
100
-
101
- @classmethod
102
- @convert_js_args_to_python_args
103
- def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501
104
- """BrandPreview - a model defined in OpenAPI
105
-
106
- Args:
107
- name (str): Brand Name
108
-
109
- Keyword Args:
110
- _check_type (bool): if True, values for parameters in openapi_types
111
- will be type checked and a TypeError will be
112
- raised if the wrong type is input.
113
- Defaults to True
114
- _path_to_item (tuple/list): This is a list of keys or values to
115
- drill down to the model in received_data
116
- when deserializing a response
117
- _spec_property_naming (bool): True if the variable names in the input data
118
- are serialized names, as specified in the OpenAPI document.
119
- False if the variable names in the input data
120
- are pythonic names, e.g. snake case (default)
121
- _configuration (Configuration): the instance to use when
122
- deserializing a file_type parameter.
123
- If passed, type conversion is attempted
124
- If omitted no type conversion is done.
125
- _visited_composed_classes (tuple): This stores a tuple of
126
- classes that we have traveled through so that
127
- if we see that class again we will not use its
128
- discriminator again.
129
- When traveling through a discriminator, the
130
- composed schema that is
131
- is traveled through is added to this set.
132
- For example if Animal has a discriminator
133
- petType and we pass in "Dog", and the class Dog
134
- allOf includes Animal, we move through Animal
135
- once using the discriminator, and pick Dog.
136
- Then in Dog, we will make an instance of the
137
- Animal class but this time we won't travel
138
- through its discriminator because we passed in
139
- _visited_composed_classes = (Animal,)
140
- """
141
-
142
- _check_type = kwargs.pop('_check_type', True)
143
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
144
- _path_to_item = kwargs.pop('_path_to_item', ())
145
- _configuration = kwargs.pop('_configuration', None)
146
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
147
-
148
- self = super(OpenApiModel, cls).__new__(cls)
149
-
150
- if args:
151
- for arg in args:
152
- if isinstance(arg, dict):
153
- kwargs.update(arg)
154
- else:
155
- raise ApiTypeError(
156
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
157
- args,
158
- self.__class__.__name__,
159
- ),
160
- path_to_item=_path_to_item,
161
- valid_classes=(self.__class__,),
162
- )
163
-
164
- self._data_store = {}
165
- self._check_type = _check_type
166
- self._spec_property_naming = _spec_property_naming
167
- self._path_to_item = _path_to_item
168
- self._configuration = _configuration
169
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
170
-
171
- self.name = name
172
- for var_name, var_value in kwargs.items():
173
- if var_name not in self.attribute_map and \
174
- self._configuration is not None and \
175
- self._configuration.discard_unknown_keys and \
176
- self.additional_properties_type is None:
177
- # discard variable.
178
- continue
179
- setattr(self, var_name, var_value)
180
- return self
181
-
182
- required_properties = set([
183
- '_data_store',
184
- '_check_type',
185
- '_spec_property_naming',
186
- '_path_to_item',
187
- '_configuration',
188
- '_visited_composed_classes',
189
- ])
190
-
191
- @convert_js_args_to_python_args
192
- def __init__(self, name, *args, **kwargs): # noqa: E501
193
- """BrandPreview - a model defined in OpenAPI
194
-
195
- Args:
196
- name (str): Brand Name
197
-
198
- Keyword Args:
199
- _check_type (bool): if True, values for parameters in openapi_types
200
- will be type checked and a TypeError will be
201
- raised if the wrong type is input.
202
- Defaults to True
203
- _path_to_item (tuple/list): This is a list of keys or values to
204
- drill down to the model in received_data
205
- when deserializing a response
206
- _spec_property_naming (bool): True if the variable names in the input data
207
- are serialized names, as specified in the OpenAPI document.
208
- False if the variable names in the input data
209
- are pythonic names, e.g. snake case (default)
210
- _configuration (Configuration): the instance to use when
211
- deserializing a file_type parameter.
212
- If passed, type conversion is attempted
213
- If omitted no type conversion is done.
214
- _visited_composed_classes (tuple): This stores a tuple of
215
- classes that we have traveled through so that
216
- if we see that class again we will not use its
217
- discriminator again.
218
- When traveling through a discriminator, the
219
- composed schema that is
220
- is traveled through is added to this set.
221
- For example if Animal has a discriminator
222
- petType and we pass in "Dog", and the class Dog
223
- allOf includes Animal, we move through Animal
224
- once using the discriminator, and pick Dog.
225
- Then in Dog, we will make an instance of the
226
- Animal class but this time we won't travel
227
- through its discriminator because we passed in
228
- _visited_composed_classes = (Animal,)
229
- """
230
-
231
- _check_type = kwargs.pop('_check_type', True)
232
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
233
- _path_to_item = kwargs.pop('_path_to_item', ())
234
- _configuration = kwargs.pop('_configuration', None)
235
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
236
-
237
- if args:
238
- for arg in args:
239
- if isinstance(arg, dict):
240
- kwargs.update(arg)
241
- else:
242
- raise ApiTypeError(
243
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
244
- args,
245
- self.__class__.__name__,
246
- ),
247
- path_to_item=_path_to_item,
248
- valid_classes=(self.__class__,),
249
- )
250
-
251
- self._data_store = {}
252
- self._check_type = _check_type
253
- self._spec_property_naming = _spec_property_naming
254
- self._path_to_item = _path_to_item
255
- self._configuration = _configuration
256
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
257
-
258
- self.name = name
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.")