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