criteo-api-retailmedia-sdk 0.0.250915__py3-none-any.whl → 0.0.251014__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.
- criteo_api_retailmedia_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/accounts_api.py +70 -73
- criteo_api_retailmedia_preview/api/analytics_api.py +137 -0
- criteo_api_retailmedia_preview/api/audience_api.py +12 -12
- criteo_api_retailmedia_preview/api/billing_api.py +18 -18
- criteo_api_retailmedia_preview/api/campaign_api.py +493 -325
- criteo_api_retailmedia_preview/api_client.py +4 -4
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/async_fill_rate_report.py +5 -0
- criteo_api_retailmedia_preview/model/async_unfilled_placements_report.py +392 -0
- criteo_api_retailmedia_preview/model/async_unfilled_placements_report_request.py +269 -0
- criteo_api_retailmedia_preview/model/async_unfilled_placements_report_resource.py +273 -0
- criteo_api_retailmedia_preview/model/campaign_availability.py +289 -0
- criteo_api_retailmedia_preview/model/demand_managed_fee.py +1 -1
- criteo_api_retailmedia_preview/model/{value_resource_outcome_account_fees_update_result.py → entity_resource_collection_outcome_of_retailer_result_and_metadata.py} +14 -8
- criteo_api_retailmedia_preview/model/entity_resource_of_retailer_result.py +270 -0
- criteo_api_retailmedia_preview/model/files_variable_value.py +0 -3
- criteo_api_retailmedia_preview/model/managed_service_fee.py +1 -1
- criteo_api_retailmedia_preview/model/page_type_combination.py +287 -0
- criteo_api_retailmedia_preview/model/private_market_fees.py +6 -14
- criteo_api_retailmedia_preview/model/retailer_result.py +266 -0
- criteo_api_retailmedia_preview/model/{account_fees_update_result.py → retailer_search_request.py} +8 -12
- criteo_api_retailmedia_preview/model/rm_contact_list_create_v1.py +1 -0
- criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +1 -0
- criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +11 -2
- criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +8 -0
- criteo_api_retailmedia_preview/model/sponsored_products_line_item_update_request_model.py +34 -28
- criteo_api_retailmedia_preview/model/value_resource_input_of_retailer_search_request.py +262 -0
- criteo_api_retailmedia_preview/model/{value_resource_account_fees_update_result.py → value_resource_of_retailer_search_request.py} +9 -9
- criteo_api_retailmedia_preview/models/__init__.py +11 -3
- {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/RECORD +34 -26
- {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/WHEEL +0 -0
- {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,289 @@
|
|
|
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.page_type_combination import PageTypeCombination
|
|
34
|
+
globals()['PageTypeCombination'] = PageTypeCombination
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class CampaignAvailability(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
|
+
('buy_type',): {
|
|
63
|
+
'None': None,
|
|
64
|
+
'UNKNOWN': "unknown",
|
|
65
|
+
'AUCTION': "auction",
|
|
66
|
+
'PREFERREDDEALS': "preferreddeals",
|
|
67
|
+
'SPONSORSHIP': "sponsorship",
|
|
68
|
+
'OFFSITE': "offsite",
|
|
69
|
+
},
|
|
70
|
+
('campaign_type',): {
|
|
71
|
+
'None': None,
|
|
72
|
+
'UNKNOWN': "unknown",
|
|
73
|
+
'SPONSOREDPRODUCTS': "sponsoredproducts",
|
|
74
|
+
'ONSITEDISPLAY': "onsitedisplay",
|
|
75
|
+
'OFFSITE': "offsite",
|
|
76
|
+
},
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
validations = {
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
additional_properties_type = None
|
|
83
|
+
|
|
84
|
+
_nullable = False
|
|
85
|
+
|
|
86
|
+
@cached_property
|
|
87
|
+
def openapi_types():
|
|
88
|
+
"""
|
|
89
|
+
This must be a method because a model may have properties that are
|
|
90
|
+
of type self, this must run after the class is loaded
|
|
91
|
+
|
|
92
|
+
Returns
|
|
93
|
+
openapi_types (dict): The key is attribute name
|
|
94
|
+
and the value is attribute type.
|
|
95
|
+
"""
|
|
96
|
+
lazy_import()
|
|
97
|
+
return {
|
|
98
|
+
'buy_type': (str, none_type,), # noqa: E501
|
|
99
|
+
'campaign_type': (str, none_type,), # noqa: E501
|
|
100
|
+
'is_available': (bool, none_type,), # noqa: E501
|
|
101
|
+
'valid_combinations': ([PageTypeCombination], none_type,), # noqa: E501
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
@cached_property
|
|
105
|
+
def discriminator():
|
|
106
|
+
return None
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
attribute_map = {
|
|
110
|
+
'buy_type': 'buyType', # noqa: E501
|
|
111
|
+
'campaign_type': 'campaignType', # noqa: E501
|
|
112
|
+
'is_available': 'isAvailable', # noqa: E501
|
|
113
|
+
'valid_combinations': 'validCombinations', # noqa: E501
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
read_only_vars = {
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
_composed_schemas = {}
|
|
120
|
+
|
|
121
|
+
@classmethod
|
|
122
|
+
@convert_js_args_to_python_args
|
|
123
|
+
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
124
|
+
"""CampaignAvailability - a model defined in OpenAPI
|
|
125
|
+
|
|
126
|
+
Keyword Args:
|
|
127
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
128
|
+
will be type checked and a TypeError will be
|
|
129
|
+
raised if the wrong type is input.
|
|
130
|
+
Defaults to True
|
|
131
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
132
|
+
drill down to the model in received_data
|
|
133
|
+
when deserializing a response
|
|
134
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
135
|
+
are serialized names, as specified in the OpenAPI document.
|
|
136
|
+
False if the variable names in the input data
|
|
137
|
+
are pythonic names, e.g. snake case (default)
|
|
138
|
+
_configuration (Configuration): the instance to use when
|
|
139
|
+
deserializing a file_type parameter.
|
|
140
|
+
If passed, type conversion is attempted
|
|
141
|
+
If omitted no type conversion is done.
|
|
142
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
143
|
+
classes that we have traveled through so that
|
|
144
|
+
if we see that class again we will not use its
|
|
145
|
+
discriminator again.
|
|
146
|
+
When traveling through a discriminator, the
|
|
147
|
+
composed schema that is
|
|
148
|
+
is traveled through is added to this set.
|
|
149
|
+
For example if Animal has a discriminator
|
|
150
|
+
petType and we pass in "Dog", and the class Dog
|
|
151
|
+
allOf includes Animal, we move through Animal
|
|
152
|
+
once using the discriminator, and pick Dog.
|
|
153
|
+
Then in Dog, we will make an instance of the
|
|
154
|
+
Animal class but this time we won't travel
|
|
155
|
+
through its discriminator because we passed in
|
|
156
|
+
_visited_composed_classes = (Animal,)
|
|
157
|
+
buy_type (str, none_type): The buy type this object represents availability for. [optional] # noqa: E501
|
|
158
|
+
campaign_type (str, none_type): The type of campaign this object represents availability for. [optional] # noqa: E501
|
|
159
|
+
is_available (bool, none_type): Indicates whether the campaign type and buy type combination is available for the retailer. [optional] # noqa: E501
|
|
160
|
+
valid_combinations ([PageTypeCombination], none_type): PageType-PageEnvironmentType pairs which are supported for this campaign-buy type combination. [optional] # noqa: E501
|
|
161
|
+
"""
|
|
162
|
+
|
|
163
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
164
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
165
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
166
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
167
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
168
|
+
|
|
169
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
170
|
+
|
|
171
|
+
if args:
|
|
172
|
+
for arg in args:
|
|
173
|
+
if isinstance(arg, dict):
|
|
174
|
+
kwargs.update(arg)
|
|
175
|
+
else:
|
|
176
|
+
raise ApiTypeError(
|
|
177
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
178
|
+
args,
|
|
179
|
+
self.__class__.__name__,
|
|
180
|
+
),
|
|
181
|
+
path_to_item=_path_to_item,
|
|
182
|
+
valid_classes=(self.__class__,),
|
|
183
|
+
)
|
|
184
|
+
|
|
185
|
+
self._data_store = {}
|
|
186
|
+
self._check_type = _check_type
|
|
187
|
+
self._spec_property_naming = _spec_property_naming
|
|
188
|
+
self._path_to_item = _path_to_item
|
|
189
|
+
self._configuration = _configuration
|
|
190
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
191
|
+
|
|
192
|
+
for var_name, var_value in kwargs.items():
|
|
193
|
+
if var_name not in self.attribute_map and \
|
|
194
|
+
self._configuration is not None and \
|
|
195
|
+
self._configuration.discard_unknown_keys and \
|
|
196
|
+
self.additional_properties_type is None:
|
|
197
|
+
# discard variable.
|
|
198
|
+
continue
|
|
199
|
+
setattr(self, var_name, var_value)
|
|
200
|
+
return self
|
|
201
|
+
|
|
202
|
+
required_properties = set([
|
|
203
|
+
'_data_store',
|
|
204
|
+
'_check_type',
|
|
205
|
+
'_spec_property_naming',
|
|
206
|
+
'_path_to_item',
|
|
207
|
+
'_configuration',
|
|
208
|
+
'_visited_composed_classes',
|
|
209
|
+
])
|
|
210
|
+
|
|
211
|
+
@convert_js_args_to_python_args
|
|
212
|
+
def __init__(self, *args, **kwargs): # noqa: E501
|
|
213
|
+
"""CampaignAvailability - a model defined in OpenAPI
|
|
214
|
+
|
|
215
|
+
Keyword Args:
|
|
216
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
217
|
+
will be type checked and a TypeError will be
|
|
218
|
+
raised if the wrong type is input.
|
|
219
|
+
Defaults to True
|
|
220
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
221
|
+
drill down to the model in received_data
|
|
222
|
+
when deserializing a response
|
|
223
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
224
|
+
are serialized names, as specified in the OpenAPI document.
|
|
225
|
+
False if the variable names in the input data
|
|
226
|
+
are pythonic names, e.g. snake case (default)
|
|
227
|
+
_configuration (Configuration): the instance to use when
|
|
228
|
+
deserializing a file_type parameter.
|
|
229
|
+
If passed, type conversion is attempted
|
|
230
|
+
If omitted no type conversion is done.
|
|
231
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
232
|
+
classes that we have traveled through so that
|
|
233
|
+
if we see that class again we will not use its
|
|
234
|
+
discriminator again.
|
|
235
|
+
When traveling through a discriminator, the
|
|
236
|
+
composed schema that is
|
|
237
|
+
is traveled through is added to this set.
|
|
238
|
+
For example if Animal has a discriminator
|
|
239
|
+
petType and we pass in "Dog", and the class Dog
|
|
240
|
+
allOf includes Animal, we move through Animal
|
|
241
|
+
once using the discriminator, and pick Dog.
|
|
242
|
+
Then in Dog, we will make an instance of the
|
|
243
|
+
Animal class but this time we won't travel
|
|
244
|
+
through its discriminator because we passed in
|
|
245
|
+
_visited_composed_classes = (Animal,)
|
|
246
|
+
buy_type (str, none_type): The buy type this object represents availability for. [optional] # noqa: E501
|
|
247
|
+
campaign_type (str, none_type): The type of campaign this object represents availability for. [optional] # noqa: E501
|
|
248
|
+
is_available (bool, none_type): Indicates whether the campaign type and buy type combination is available for the retailer. [optional] # noqa: E501
|
|
249
|
+
valid_combinations ([PageTypeCombination], none_type): PageType-PageEnvironmentType pairs which are supported for this campaign-buy type combination. [optional] # noqa: E501
|
|
250
|
+
"""
|
|
251
|
+
|
|
252
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
253
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
254
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
255
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
256
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
257
|
+
|
|
258
|
+
if args:
|
|
259
|
+
for arg in args:
|
|
260
|
+
if isinstance(arg, dict):
|
|
261
|
+
kwargs.update(arg)
|
|
262
|
+
else:
|
|
263
|
+
raise ApiTypeError(
|
|
264
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
265
|
+
args,
|
|
266
|
+
self.__class__.__name__,
|
|
267
|
+
),
|
|
268
|
+
path_to_item=_path_to_item,
|
|
269
|
+
valid_classes=(self.__class__,),
|
|
270
|
+
)
|
|
271
|
+
|
|
272
|
+
self._data_store = {}
|
|
273
|
+
self._check_type = _check_type
|
|
274
|
+
self._spec_property_naming = _spec_property_naming
|
|
275
|
+
self._path_to_item = _path_to_item
|
|
276
|
+
self._configuration = _configuration
|
|
277
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
278
|
+
|
|
279
|
+
for var_name, var_value in kwargs.items():
|
|
280
|
+
if var_name not in self.attribute_map and \
|
|
281
|
+
self._configuration is not None and \
|
|
282
|
+
self._configuration.discard_unknown_keys and \
|
|
283
|
+
self.additional_properties_type is None:
|
|
284
|
+
# discard variable.
|
|
285
|
+
continue
|
|
286
|
+
setattr(self, var_name, var_value)
|
|
287
|
+
if var_name in self.read_only_vars:
|
|
288
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
289
|
+
f"class with read only attributes.")
|
|
@@ -30,13 +30,15 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
|
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
def lazy_import():
|
|
33
|
+
from criteo_api_retailmedia_preview.model.entity_resource_of_retailer_result import EntityResourceOfRetailerResult
|
|
34
|
+
from criteo_api_retailmedia_preview.model.metadata import Metadata
|
|
33
35
|
from criteo_api_retailmedia_preview.model.sdk_api_rest_common_problem import SdkApiRestCommonProblem
|
|
34
|
-
|
|
36
|
+
globals()['EntityResourceOfRetailerResult'] = EntityResourceOfRetailerResult
|
|
37
|
+
globals()['Metadata'] = Metadata
|
|
35
38
|
globals()['SdkApiRestCommonProblem'] = SdkApiRestCommonProblem
|
|
36
|
-
globals()['ValueResourceAccountFeesUpdateResult'] = ValueResourceAccountFeesUpdateResult
|
|
37
39
|
|
|
38
40
|
|
|
39
|
-
class
|
|
41
|
+
class EntityResourceCollectionOutcomeOfRetailerResultAndMetadata(ModelNormal):
|
|
40
42
|
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
41
43
|
Ref: https://openapi-generator.tech
|
|
42
44
|
|
|
@@ -82,8 +84,9 @@ class ValueResourceOutcomeAccountFeesUpdateResult(ModelNormal):
|
|
|
82
84
|
"""
|
|
83
85
|
lazy_import()
|
|
84
86
|
return {
|
|
85
|
-
'data': (
|
|
87
|
+
'data': ([EntityResourceOfRetailerResult], none_type,), # noqa: E501
|
|
86
88
|
'errors': ([SdkApiRestCommonProblem], none_type,), # noqa: E501
|
|
89
|
+
'metadata': (Metadata,), # noqa: E501
|
|
87
90
|
'warnings': ([SdkApiRestCommonProblem], none_type,), # noqa: E501
|
|
88
91
|
}
|
|
89
92
|
|
|
@@ -95,6 +98,7 @@ class ValueResourceOutcomeAccountFeesUpdateResult(ModelNormal):
|
|
|
95
98
|
attribute_map = {
|
|
96
99
|
'data': 'data', # noqa: E501
|
|
97
100
|
'errors': 'errors', # noqa: E501
|
|
101
|
+
'metadata': 'metadata', # noqa: E501
|
|
98
102
|
'warnings': 'warnings', # noqa: E501
|
|
99
103
|
}
|
|
100
104
|
|
|
@@ -108,7 +112,7 @@ class ValueResourceOutcomeAccountFeesUpdateResult(ModelNormal):
|
|
|
108
112
|
@classmethod
|
|
109
113
|
@convert_js_args_to_python_args
|
|
110
114
|
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
111
|
-
"""
|
|
115
|
+
"""EntityResourceCollectionOutcomeOfRetailerResultAndMetadata - a model defined in OpenAPI
|
|
112
116
|
|
|
113
117
|
Keyword Args:
|
|
114
118
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -141,8 +145,9 @@ class ValueResourceOutcomeAccountFeesUpdateResult(ModelNormal):
|
|
|
141
145
|
Animal class but this time we won't travel
|
|
142
146
|
through its discriminator because we passed in
|
|
143
147
|
_visited_composed_classes = (Animal,)
|
|
144
|
-
data (
|
|
148
|
+
data ([EntityResourceOfRetailerResult], none_type): [optional] # noqa: E501
|
|
145
149
|
errors ([SdkApiRestCommonProblem], none_type): Errors that occured during this call.. [optional] # noqa: E501
|
|
150
|
+
metadata (Metadata): [optional] # noqa: E501
|
|
146
151
|
warnings ([SdkApiRestCommonProblem], none_type): Warnings that occured during this call.. [optional] # noqa: E501
|
|
147
152
|
"""
|
|
148
153
|
|
|
@@ -196,7 +201,7 @@ class ValueResourceOutcomeAccountFeesUpdateResult(ModelNormal):
|
|
|
196
201
|
|
|
197
202
|
@convert_js_args_to_python_args
|
|
198
203
|
def __init__(self, *args, **kwargs): # noqa: E501
|
|
199
|
-
"""
|
|
204
|
+
"""EntityResourceCollectionOutcomeOfRetailerResultAndMetadata - a model defined in OpenAPI
|
|
200
205
|
|
|
201
206
|
Keyword Args:
|
|
202
207
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -229,8 +234,9 @@ class ValueResourceOutcomeAccountFeesUpdateResult(ModelNormal):
|
|
|
229
234
|
Animal class but this time we won't travel
|
|
230
235
|
through its discriminator because we passed in
|
|
231
236
|
_visited_composed_classes = (Animal,)
|
|
232
|
-
data (
|
|
237
|
+
data ([EntityResourceOfRetailerResult], none_type): [optional] # noqa: E501
|
|
233
238
|
errors ([SdkApiRestCommonProblem], none_type): Errors that occured during this call.. [optional] # noqa: E501
|
|
239
|
+
metadata (Metadata): [optional] # noqa: E501
|
|
234
240
|
warnings ([SdkApiRestCommonProblem], none_type): Warnings that occured during this call.. [optional] # noqa: E501
|
|
235
241
|
"""
|
|
236
242
|
|
|
@@ -0,0 +1,270 @@
|
|
|
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.retailer_result import RetailerResult
|
|
34
|
+
globals()['RetailerResult'] = RetailerResult
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class EntityResourceOfRetailerResult(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
|
+
'attributes': (RetailerResult,), # noqa: E501
|
|
84
|
+
'id': (str, none_type,), # noqa: E501
|
|
85
|
+
'type': (str, none_type,), # noqa: E501
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
@cached_property
|
|
89
|
+
def discriminator():
|
|
90
|
+
return None
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
attribute_map = {
|
|
94
|
+
'attributes': 'attributes', # noqa: E501
|
|
95
|
+
'id': 'id', # noqa: E501
|
|
96
|
+
'type': 'type', # 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, *args, **kwargs): # noqa: E501
|
|
107
|
+
"""EntityResourceOfRetailerResult - a model defined in OpenAPI
|
|
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
|
+
attributes (RetailerResult): [optional] # noqa: E501
|
|
141
|
+
id (str, none_type): Unique id of the entity.. [optional] # noqa: E501
|
|
142
|
+
type (str, none_type): Type of the resource.. [optional] # noqa: E501
|
|
143
|
+
"""
|
|
144
|
+
|
|
145
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
146
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
147
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
148
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
149
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
150
|
+
|
|
151
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
152
|
+
|
|
153
|
+
if args:
|
|
154
|
+
for arg in args:
|
|
155
|
+
if isinstance(arg, dict):
|
|
156
|
+
kwargs.update(arg)
|
|
157
|
+
else:
|
|
158
|
+
raise ApiTypeError(
|
|
159
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
160
|
+
args,
|
|
161
|
+
self.__class__.__name__,
|
|
162
|
+
),
|
|
163
|
+
path_to_item=_path_to_item,
|
|
164
|
+
valid_classes=(self.__class__,),
|
|
165
|
+
)
|
|
166
|
+
|
|
167
|
+
self._data_store = {}
|
|
168
|
+
self._check_type = _check_type
|
|
169
|
+
self._spec_property_naming = _spec_property_naming
|
|
170
|
+
self._path_to_item = _path_to_item
|
|
171
|
+
self._configuration = _configuration
|
|
172
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
173
|
+
|
|
174
|
+
for var_name, var_value in kwargs.items():
|
|
175
|
+
if var_name not in self.attribute_map and \
|
|
176
|
+
self._configuration is not None and \
|
|
177
|
+
self._configuration.discard_unknown_keys and \
|
|
178
|
+
self.additional_properties_type is None:
|
|
179
|
+
# discard variable.
|
|
180
|
+
continue
|
|
181
|
+
setattr(self, var_name, var_value)
|
|
182
|
+
return self
|
|
183
|
+
|
|
184
|
+
required_properties = set([
|
|
185
|
+
'_data_store',
|
|
186
|
+
'_check_type',
|
|
187
|
+
'_spec_property_naming',
|
|
188
|
+
'_path_to_item',
|
|
189
|
+
'_configuration',
|
|
190
|
+
'_visited_composed_classes',
|
|
191
|
+
])
|
|
192
|
+
|
|
193
|
+
@convert_js_args_to_python_args
|
|
194
|
+
def __init__(self, *args, **kwargs): # noqa: E501
|
|
195
|
+
"""EntityResourceOfRetailerResult - a model defined in OpenAPI
|
|
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
|
+
attributes (RetailerResult): [optional] # noqa: E501
|
|
229
|
+
id (str, none_type): Unique id of the entity.. [optional] # noqa: E501
|
|
230
|
+
type (str, none_type): Type of the resource.. [optional] # noqa: E501
|
|
231
|
+
"""
|
|
232
|
+
|
|
233
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
234
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
235
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
236
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
237
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
238
|
+
|
|
239
|
+
if args:
|
|
240
|
+
for arg in args:
|
|
241
|
+
if isinstance(arg, dict):
|
|
242
|
+
kwargs.update(arg)
|
|
243
|
+
else:
|
|
244
|
+
raise ApiTypeError(
|
|
245
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
246
|
+
args,
|
|
247
|
+
self.__class__.__name__,
|
|
248
|
+
),
|
|
249
|
+
path_to_item=_path_to_item,
|
|
250
|
+
valid_classes=(self.__class__,),
|
|
251
|
+
)
|
|
252
|
+
|
|
253
|
+
self._data_store = {}
|
|
254
|
+
self._check_type = _check_type
|
|
255
|
+
self._spec_property_naming = _spec_property_naming
|
|
256
|
+
self._path_to_item = _path_to_item
|
|
257
|
+
self._configuration = _configuration
|
|
258
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
259
|
+
|
|
260
|
+
for var_name, var_value in kwargs.items():
|
|
261
|
+
if var_name not in self.attribute_map and \
|
|
262
|
+
self._configuration is not None and \
|
|
263
|
+
self._configuration.discard_unknown_keys and \
|
|
264
|
+
self.additional_properties_type is None:
|
|
265
|
+
# discard variable.
|
|
266
|
+
continue
|
|
267
|
+
setattr(self, var_name, var_value)
|
|
268
|
+
if var_name in self.read_only_vars:
|
|
269
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
270
|
+
f"class with read only attributes.")
|