criteo-api-retailmedia-sdk 0.0.240118__py3-none-any.whl → 0.0.240207__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 (25) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/audience_api.py +2 -313
  3. criteo_api_retailmedia_preview/api_client.py +1 -1
  4. criteo_api_retailmedia_preview/configuration.py +1 -1
  5. criteo_api_retailmedia_preview/model/external_account.py +4 -0
  6. criteo_api_retailmedia_preview/model/retail_media_account.py +4 -0
  7. criteo_api_retailmedia_preview/model/retail_media_brand_account_creation.py +4 -0
  8. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +4 -0
  9. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2.py +3 -3
  10. criteo_api_retailmedia_preview/models/__init__.py +0 -11
  11. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240207.dist-info}/METADATA +3 -3
  12. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240207.dist-info}/RECORD +14 -25
  13. criteo_api_retailmedia_preview/model/common_status_code_response.py +0 -275
  14. criteo_api_retailmedia_preview/model/create_user_behavior_segment_v2.py +0 -309
  15. criteo_api_retailmedia_preview/model/customer_list_details.py +0 -269
  16. criteo_api_retailmedia_preview/model/get_page_of_audiences_by_account_id_response.py +0 -295
  17. criteo_api_retailmedia_preview/model/retail_media_audience.py +0 -297
  18. criteo_api_retailmedia_preview/model/retail_media_audience_attributes.py +0 -291
  19. criteo_api_retailmedia_preview/model/retail_media_audience_v2.py +0 -291
  20. criteo_api_retailmedia_preview/model/retail_media_audience_v2_attributes.py +0 -291
  21. criteo_api_retailmedia_preview/model/retail_media_audience_v2_list_response.py +0 -293
  22. criteo_api_retailmedia_preview/model/user_behavior_details.py +0 -306
  23. criteo_api_retailmedia_preview/model/user_behavior_details_v2.py +0 -279
  24. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240207.dist-info}/WHEEL +0 -0
  25. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240207.dist-info}/top_level.txt +0 -0
@@ -1,309 +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 CreateUserBehaviorSegmentV2(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
- ('user_action',): {
59
- 'BUY': "buy",
60
- 'VIEW': "view",
61
- 'ADDTOCART': "addToCart",
62
- },
63
- ('lookback_window',): {
64
- 'P7D': "P7D",
65
- 'P14D': "P14D",
66
- 'P30D': "P30D",
67
- 'P45D': "P45D",
68
- 'P60D': "P60D",
69
- 'P90D': "P90D",
70
- 'P120D': "P120D",
71
- 'P150D': "P150D",
72
- 'P180D': "P180D",
73
- },
74
- }
75
-
76
- validations = {
77
- }
78
-
79
- @cached_property
80
- def additional_properties_type():
81
- """
82
- This must be a method because a model may have properties that are
83
- of type self, this must run after the class is loaded
84
- """
85
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
86
-
87
- _nullable = False
88
-
89
- @cached_property
90
- def openapi_types():
91
- """
92
- This must be a method because a model may have properties that are
93
- of type self, this must run after the class is loaded
94
-
95
- Returns
96
- openapi_types (dict): The key is attribute name
97
- and the value is attribute type.
98
- """
99
- return {
100
- 'user_action': (str,), # noqa: E501
101
- 'lookback_window': (str,), # noqa: E501
102
- 'category_ids': ([int], none_type,), # noqa: E501
103
- 'brand_ids': ([int], none_type,), # noqa: E501
104
- 'min_price': (float, none_type,), # noqa: E501
105
- 'max_price': (float, none_type,), # noqa: E501
106
- }
107
-
108
- @cached_property
109
- def discriminator():
110
- return None
111
-
112
-
113
- attribute_map = {
114
- 'user_action': 'userAction', # noqa: E501
115
- 'lookback_window': 'lookbackWindow', # noqa: E501
116
- 'category_ids': 'categoryIds', # noqa: E501
117
- 'brand_ids': 'brandIds', # noqa: E501
118
- 'min_price': 'minPrice', # noqa: E501
119
- 'max_price': 'maxPrice', # noqa: E501
120
- }
121
-
122
- read_only_vars = {
123
- 'min_price', # noqa: E501
124
- 'max_price', # noqa: E501
125
- }
126
-
127
- _composed_schemas = {}
128
-
129
- @classmethod
130
- @convert_js_args_to_python_args
131
- def _from_openapi_data(cls, user_action, lookback_window, *args, **kwargs): # noqa: E501
132
- """CreateUserBehaviorSegmentV2 - a model defined in OpenAPI
133
-
134
- Args:
135
- user_action (str): Type of shopper activity used to generate the audience.
136
- lookback_window (str): Length of lookback window
137
-
138
- Keyword Args:
139
- _check_type (bool): if True, values for parameters in openapi_types
140
- will be type checked and a TypeError will be
141
- raised if the wrong type is input.
142
- Defaults to True
143
- _path_to_item (tuple/list): This is a list of keys or values to
144
- drill down to the model in received_data
145
- when deserializing a response
146
- _spec_property_naming (bool): True if the variable names in the input data
147
- are serialized names, as specified in the OpenAPI document.
148
- False if the variable names in the input data
149
- are pythonic names, e.g. snake case (default)
150
- _configuration (Configuration): the instance to use when
151
- deserializing a file_type parameter.
152
- If passed, type conversion is attempted
153
- If omitted no type conversion is done.
154
- _visited_composed_classes (tuple): This stores a tuple of
155
- classes that we have traveled through so that
156
- if we see that class again we will not use its
157
- discriminator again.
158
- When traveling through a discriminator, the
159
- composed schema that is
160
- is traveled through is added to this set.
161
- For example if Animal has a discriminator
162
- petType and we pass in "Dog", and the class Dog
163
- allOf includes Animal, we move through Animal
164
- once using the discriminator, and pick Dog.
165
- Then in Dog, we will make an instance of the
166
- Animal class but this time we won't travel
167
- through its discriminator because we passed in
168
- _visited_composed_classes = (Animal,)
169
- category_ids ([int], none_type): The categories to target. [optional] # noqa: E501
170
- brand_ids ([int], none_type): The brands to target. [optional] # noqa: E501
171
- min_price (float, none_type): The min price of targeted skus.. [optional] # noqa: E501
172
- max_price (float, none_type): The max price of targeted skus.. [optional] # noqa: E501
173
- """
174
-
175
- _check_type = kwargs.pop('_check_type', True)
176
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
177
- _path_to_item = kwargs.pop('_path_to_item', ())
178
- _configuration = kwargs.pop('_configuration', None)
179
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
180
-
181
- self = super(OpenApiModel, cls).__new__(cls)
182
-
183
- if args:
184
- for arg in args:
185
- if isinstance(arg, dict):
186
- kwargs.update(arg)
187
- else:
188
- raise ApiTypeError(
189
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
190
- args,
191
- self.__class__.__name__,
192
- ),
193
- path_to_item=_path_to_item,
194
- valid_classes=(self.__class__,),
195
- )
196
-
197
- self._data_store = {}
198
- self._check_type = _check_type
199
- self._spec_property_naming = _spec_property_naming
200
- self._path_to_item = _path_to_item
201
- self._configuration = _configuration
202
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
203
-
204
- self.user_action = user_action
205
- self.lookback_window = lookback_window
206
- for var_name, var_value in kwargs.items():
207
- if var_name not in self.attribute_map and \
208
- self._configuration is not None and \
209
- self._configuration.discard_unknown_keys and \
210
- self.additional_properties_type is None:
211
- # discard variable.
212
- continue
213
- setattr(self, var_name, var_value)
214
- return self
215
-
216
- required_properties = set([
217
- '_data_store',
218
- '_check_type',
219
- '_spec_property_naming',
220
- '_path_to_item',
221
- '_configuration',
222
- '_visited_composed_classes',
223
- ])
224
-
225
- @convert_js_args_to_python_args
226
- def __init__(self, user_action, lookback_window, *args, **kwargs): # noqa: E501
227
- """CreateUserBehaviorSegmentV2 - a model defined in OpenAPI
228
-
229
- Args:
230
- user_action (str): Type of shopper activity used to generate the audience.
231
- lookback_window (str): Length of lookback window
232
-
233
- Keyword Args:
234
- _check_type (bool): if True, values for parameters in openapi_types
235
- will be type checked and a TypeError will be
236
- raised if the wrong type is input.
237
- Defaults to True
238
- _path_to_item (tuple/list): This is a list of keys or values to
239
- drill down to the model in received_data
240
- when deserializing a response
241
- _spec_property_naming (bool): True if the variable names in the input data
242
- are serialized names, as specified in the OpenAPI document.
243
- False if the variable names in the input data
244
- are pythonic names, e.g. snake case (default)
245
- _configuration (Configuration): the instance to use when
246
- deserializing a file_type parameter.
247
- If passed, type conversion is attempted
248
- If omitted no type conversion is done.
249
- _visited_composed_classes (tuple): This stores a tuple of
250
- classes that we have traveled through so that
251
- if we see that class again we will not use its
252
- discriminator again.
253
- When traveling through a discriminator, the
254
- composed schema that is
255
- is traveled through is added to this set.
256
- For example if Animal has a discriminator
257
- petType and we pass in "Dog", and the class Dog
258
- allOf includes Animal, we move through Animal
259
- once using the discriminator, and pick Dog.
260
- Then in Dog, we will make an instance of the
261
- Animal class but this time we won't travel
262
- through its discriminator because we passed in
263
- _visited_composed_classes = (Animal,)
264
- category_ids ([int], none_type): The categories to target. [optional] # noqa: E501
265
- brand_ids ([int], none_type): The brands to target. [optional] # noqa: E501
266
- min_price (float, none_type): The min price of targeted skus.. [optional] # noqa: E501
267
- max_price (float, none_type): The max price of targeted skus.. [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
- self.user_action = user_action
298
- self.lookback_window = lookback_window
299
- for var_name, var_value in kwargs.items():
300
- if var_name not in self.attribute_map and \
301
- self._configuration is not None and \
302
- self._configuration.discard_unknown_keys and \
303
- self.additional_properties_type is None:
304
- # discard variable.
305
- continue
306
- setattr(self, var_name, var_value)
307
- if var_name in self.read_only_vars:
308
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
309
- f"class with read only attributes.")
@@ -1,269 +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 CustomerListDetails(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
- 'size': (str,), # noqa: E501
85
- }
86
-
87
- @cached_property
88
- def discriminator():
89
- return None
90
-
91
-
92
- attribute_map = {
93
- 'size': 'size', # 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, size, *args, **kwargs): # noqa: E501
104
- """CustomerListDetails - a model defined in OpenAPI
105
-
106
- Args:
107
- size (str): Number of users in the customer list audience.
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.size = size
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, size, *args, **kwargs): # noqa: E501
193
- """CustomerListDetails - a model defined in OpenAPI
194
-
195
- Args:
196
- size (str): Number of users in the customer list audience.
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.size = size
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.")