criteo-api-retailmedia-sdk 0.0.240626__py3-none-any.whl → 0.0.240731__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 (79) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +42 -629
  3. criteo_api_retailmedia_preview/api/audience_api.py +835 -58
  4. criteo_api_retailmedia_preview/api/balance_api.py +1146 -0
  5. criteo_api_retailmedia_preview/api/campaign_api.py +165 -158
  6. criteo_api_retailmedia_preview/api_client.py +4 -4
  7. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  8. criteo_api_retailmedia_preview/configuration.py +1 -1
  9. criteo_api_retailmedia_preview/model/add_funds_to_balance_v2.py +277 -0
  10. criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_seller_account_creation.py → add_funds_to_balance_v2_request.py} +16 -9
  11. criteo_api_retailmedia_preview/model/application_summary_model_response.py +0 -4
  12. criteo_api_retailmedia_preview/model/async_accounts_report.py +2 -0
  13. criteo_api_retailmedia_preview/model/async_campaigns_report.py +2 -0
  14. criteo_api_retailmedia_preview/model/async_line_items_report.py +2 -0
  15. criteo_api_retailmedia_preview/model/{insertion_order_history_change_data_capture.py → balance_history_change_data_capture_v1.py} +11 -11
  16. criteo_api_retailmedia_preview/model/balance_response_v2.py +351 -0
  17. criteo_api_retailmedia_preview/model/balance_response_v2_response.py +281 -0
  18. criteo_api_retailmedia_preview/model/change_dates_of_balance_v2.py +271 -0
  19. criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_brand_account_creation.py → change_dates_of_balance_v2_request.py} +16 -9
  20. criteo_api_retailmedia_preview/model/{change_details.py → change_details_v1.py} +3 -3
  21. criteo_api_retailmedia_preview/model/change_details_v2.py +275 -0
  22. criteo_api_retailmedia_preview/model/common_problem.py +2 -2
  23. criteo_api_retailmedia_preview/model/create_balance_v2.py +302 -0
  24. criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_brands.py → create_balance_v2_request.py} +16 -9
  25. criteo_api_retailmedia_preview/model/external_catalog_status.py +312 -0
  26. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture_v2.py +303 -0
  27. criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py +285 -0
  28. criteo_api_retailmedia_preview/model/json_api_body_without_id_of_seller_catalog_request_and_seller_catalog_request.py +279 -0
  29. criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py +8 -6
  30. criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py +8 -6
  31. criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py +8 -6
  32. criteo_api_retailmedia_preview/model/json_api_request_of_seller_catalog_request.py +269 -0
  33. criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py +287 -0
  34. criteo_api_retailmedia_preview/model/{retail_media_seller.py → nillable_string.py} +14 -12
  35. criteo_api_retailmedia_preview/model/page_of_balance_history_change_data_capture_v1.py +276 -0
  36. criteo_api_retailmedia_preview/model/{page_of_insertion_order_history_change_data_capture.py → page_of_insertion_order_history_change_data_capture_v2.py} +8 -8
  37. criteo_api_retailmedia_preview/model/paged_resource_collection_outcome_of_balance_response_v2.py +287 -0
  38. criteo_api_retailmedia_preview/model/resource_of_add_funds_to_balance_v2.py +277 -0
  39. criteo_api_retailmedia_preview/model/resource_of_balance_response_v2.py +277 -0
  40. criteo_api_retailmedia_preview/model/resource_of_change_dates_of_balance_v2.py +277 -0
  41. criteo_api_retailmedia_preview/model/resource_of_create_balance_v2.py +277 -0
  42. criteo_api_retailmedia_preview/model/resource_of_update_balance_model_v2.py +277 -0
  43. criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_attributes.py +6 -6
  44. criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_create_input_v1.py +269 -0
  45. criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_delete_input_v1.py +269 -0
  46. criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_update_input_v1.py +269 -0
  47. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +281 -0
  48. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_brand_account_creation.py → rm_audience_segment_create_entity_v1_resource.py} +16 -9
  49. criteo_api_retailmedia_preview/model/{resource_of_retail_media_account.py → rm_audience_segment_delete_entity_v1_resource.py} +15 -14
  50. criteo_api_retailmedia_preview/model/{retail_media_account.py → rm_audience_segment_entity_v1.py} +52 -37
  51. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_retail_media_seller.py → rm_audience_segment_entity_v1_list_response.py} +16 -9
  52. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller_account_creation.py → rm_audience_segment_entity_v1_resource.py} +21 -10
  53. criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1_rm_audience_segment_search_metadata_v1_list_response.py +287 -0
  54. criteo_api_retailmedia_preview/model/rm_audience_segment_id_entity_v1_list_response.py +281 -0
  55. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller.py → rm_audience_segment_id_entity_v1_resource.py} +18 -13
  56. criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +267 -0
  57. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_brands.py → rm_audience_segment_search_entity_v1_resource.py} +16 -9
  58. criteo_api_retailmedia_preview/model/rm_audience_segment_search_input_v1.py +269 -0
  59. criteo_api_retailmedia_preview/model/{retail_media_brand_account_creation.py → rm_audience_segment_search_metadata_v1.py} +22 -16
  60. criteo_api_retailmedia_preview/model/{retail_media_seller_account_creation.py → rm_audience_segment_update_entity_v1.py} +23 -16
  61. criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1_resource.py +277 -0
  62. criteo_api_retailmedia_preview/model/{retail_media_brands.py → rm_contact_list_create_v1.py} +21 -8
  63. criteo_api_retailmedia_preview/model/rm_contact_list_statistics_entity_v1.py +271 -0
  64. criteo_api_retailmedia_preview/model/rm_contact_list_statistics_entity_v1_resource.py +277 -0
  65. criteo_api_retailmedia_preview/model/{resource_outcome_of_retail_media_account.py → rm_contact_list_statistics_entity_v1_response.py} +16 -9
  66. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +275 -0
  67. criteo_api_retailmedia_preview/model/seller_catalog_request.py +269 -0
  68. criteo_api_retailmedia_preview/model/seller_identifier.py +275 -0
  69. criteo_api_retailmedia_preview/model/sku_data_preview.py +8 -6
  70. criteo_api_retailmedia_preview/model/sku_slim_data_preview.py +8 -6
  71. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +2 -0
  72. criteo_api_retailmedia_preview/model/sync_line_items_report.py +2 -0
  73. criteo_api_retailmedia_preview/model/update_balance_model_v2.py +279 -0
  74. criteo_api_retailmedia_preview/model/{value_resource_collection_input_of_retail_media_seller.py → update_balance_model_v2_request.py} +16 -9
  75. criteo_api_retailmedia_preview/models/__init__.py +53 -19
  76. {criteo_api_retailmedia_sdk-0.0.240626.dist-info → criteo_api_retailmedia_sdk-0.0.240731.dist-info}/METADATA +3 -3
  77. {criteo_api_retailmedia_sdk-0.0.240626.dist-info → criteo_api_retailmedia_sdk-0.0.240731.dist-info}/RECORD +79 -44
  78. {criteo_api_retailmedia_sdk-0.0.240626.dist-info → criteo_api_retailmedia_sdk-0.0.240731.dist-info}/WHEEL +1 -1
  79. {criteo_api_retailmedia_sdk-0.0.240626.dist-info → criteo_api_retailmedia_sdk-0.0.240731.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,277 @@
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.rm_contact_list_statistics_entity_v1 import RmContactListStatisticsEntityV1
34
+ globals()['RmContactListStatisticsEntityV1'] = RmContactListStatisticsEntityV1
35
+
36
+
37
+ class RmContactListStatisticsEntityV1Resource(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
+ @cached_property
68
+ def additional_properties_type():
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
+ lazy_import()
74
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
75
+
76
+ _nullable = False
77
+
78
+ @cached_property
79
+ def openapi_types():
80
+ """
81
+ This must be a method because a model may have properties that are
82
+ of type self, this must run after the class is loaded
83
+
84
+ Returns
85
+ openapi_types (dict): The key is attribute name
86
+ and the value is attribute type.
87
+ """
88
+ lazy_import()
89
+ return {
90
+ 'attributes': (RmContactListStatisticsEntityV1,), # noqa: E501
91
+ 'id': (str, none_type,), # noqa: E501
92
+ 'type': (str, none_type,), # noqa: E501
93
+ }
94
+
95
+ @cached_property
96
+ def discriminator():
97
+ return None
98
+
99
+
100
+ attribute_map = {
101
+ 'attributes': 'attributes', # noqa: E501
102
+ 'id': 'id', # noqa: E501
103
+ 'type': 'type', # noqa: E501
104
+ }
105
+
106
+ read_only_vars = {
107
+ }
108
+
109
+ _composed_schemas = {}
110
+
111
+ @classmethod
112
+ @convert_js_args_to_python_args
113
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
114
+ """RmContactListStatisticsEntityV1Resource - a model defined in OpenAPI
115
+
116
+ Keyword Args:
117
+ _check_type (bool): if True, values for parameters in openapi_types
118
+ will be type checked and a TypeError will be
119
+ raised if the wrong type is input.
120
+ Defaults to True
121
+ _path_to_item (tuple/list): This is a list of keys or values to
122
+ drill down to the model in received_data
123
+ when deserializing a response
124
+ _spec_property_naming (bool): True if the variable names in the input data
125
+ are serialized names, as specified in the OpenAPI document.
126
+ False if the variable names in the input data
127
+ are pythonic names, e.g. snake case (default)
128
+ _configuration (Configuration): the instance to use when
129
+ deserializing a file_type parameter.
130
+ If passed, type conversion is attempted
131
+ If omitted no type conversion is done.
132
+ _visited_composed_classes (tuple): This stores a tuple of
133
+ classes that we have traveled through so that
134
+ if we see that class again we will not use its
135
+ discriminator again.
136
+ When traveling through a discriminator, the
137
+ composed schema that is
138
+ is traveled through is added to this set.
139
+ For example if Animal has a discriminator
140
+ petType and we pass in "Dog", and the class Dog
141
+ allOf includes Animal, we move through Animal
142
+ once using the discriminator, and pick Dog.
143
+ Then in Dog, we will make an instance of the
144
+ Animal class but this time we won't travel
145
+ through its discriminator because we passed in
146
+ _visited_composed_classes = (Animal,)
147
+ attributes (RmContactListStatisticsEntityV1): [optional] # noqa: E501
148
+ id (str, none_type): Id of the entity. [optional] # noqa: E501
149
+ type (str, none_type): [optional] # noqa: E501
150
+ """
151
+
152
+ _check_type = kwargs.pop('_check_type', True)
153
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
154
+ _path_to_item = kwargs.pop('_path_to_item', ())
155
+ _configuration = kwargs.pop('_configuration', None)
156
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
157
+
158
+ self = super(OpenApiModel, cls).__new__(cls)
159
+
160
+ if args:
161
+ for arg in args:
162
+ if isinstance(arg, dict):
163
+ kwargs.update(arg)
164
+ else:
165
+ raise ApiTypeError(
166
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
167
+ args,
168
+ self.__class__.__name__,
169
+ ),
170
+ path_to_item=_path_to_item,
171
+ valid_classes=(self.__class__,),
172
+ )
173
+
174
+ self._data_store = {}
175
+ self._check_type = _check_type
176
+ self._spec_property_naming = _spec_property_naming
177
+ self._path_to_item = _path_to_item
178
+ self._configuration = _configuration
179
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
180
+
181
+ for var_name, var_value in kwargs.items():
182
+ if var_name not in self.attribute_map and \
183
+ self._configuration is not None and \
184
+ self._configuration.discard_unknown_keys and \
185
+ self.additional_properties_type is None:
186
+ # discard variable.
187
+ continue
188
+ setattr(self, var_name, var_value)
189
+ return self
190
+
191
+ required_properties = set([
192
+ '_data_store',
193
+ '_check_type',
194
+ '_spec_property_naming',
195
+ '_path_to_item',
196
+ '_configuration',
197
+ '_visited_composed_classes',
198
+ ])
199
+
200
+ @convert_js_args_to_python_args
201
+ def __init__(self, *args, **kwargs): # noqa: E501
202
+ """RmContactListStatisticsEntityV1Resource - a model defined in OpenAPI
203
+
204
+ Keyword Args:
205
+ _check_type (bool): if True, values for parameters in openapi_types
206
+ will be type checked and a TypeError will be
207
+ raised if the wrong type is input.
208
+ Defaults to True
209
+ _path_to_item (tuple/list): This is a list of keys or values to
210
+ drill down to the model in received_data
211
+ when deserializing a response
212
+ _spec_property_naming (bool): True if the variable names in the input data
213
+ are serialized names, as specified in the OpenAPI document.
214
+ False if the variable names in the input data
215
+ are pythonic names, e.g. snake case (default)
216
+ _configuration (Configuration): the instance to use when
217
+ deserializing a file_type parameter.
218
+ If passed, type conversion is attempted
219
+ If omitted no type conversion is done.
220
+ _visited_composed_classes (tuple): This stores a tuple of
221
+ classes that we have traveled through so that
222
+ if we see that class again we will not use its
223
+ discriminator again.
224
+ When traveling through a discriminator, the
225
+ composed schema that is
226
+ is traveled through is added to this set.
227
+ For example if Animal has a discriminator
228
+ petType and we pass in "Dog", and the class Dog
229
+ allOf includes Animal, we move through Animal
230
+ once using the discriminator, and pick Dog.
231
+ Then in Dog, we will make an instance of the
232
+ Animal class but this time we won't travel
233
+ through its discriminator because we passed in
234
+ _visited_composed_classes = (Animal,)
235
+ attributes (RmContactListStatisticsEntityV1): [optional] # noqa: E501
236
+ id (str, none_type): Id of the entity. [optional] # noqa: E501
237
+ type (str, none_type): [optional] # noqa: E501
238
+ """
239
+
240
+ _check_type = kwargs.pop('_check_type', True)
241
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
242
+ _path_to_item = kwargs.pop('_path_to_item', ())
243
+ _configuration = kwargs.pop('_configuration', None)
244
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
245
+
246
+ if args:
247
+ for arg in args:
248
+ if isinstance(arg, dict):
249
+ kwargs.update(arg)
250
+ else:
251
+ raise ApiTypeError(
252
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
253
+ args,
254
+ self.__class__.__name__,
255
+ ),
256
+ path_to_item=_path_to_item,
257
+ valid_classes=(self.__class__,),
258
+ )
259
+
260
+ self._data_store = {}
261
+ self._check_type = _check_type
262
+ self._spec_property_naming = _spec_property_naming
263
+ self._path_to_item = _path_to_item
264
+ self._configuration = _configuration
265
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
266
+
267
+ for var_name, var_value in kwargs.items():
268
+ if var_name not in self.attribute_map and \
269
+ self._configuration is not None and \
270
+ self._configuration.discard_unknown_keys and \
271
+ self.additional_properties_type is None:
272
+ # discard variable.
273
+ continue
274
+ setattr(self, var_name, var_value)
275
+ if var_name in self.read_only_vars:
276
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
277
+ f"class with read only attributes.")
@@ -31,12 +31,12 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
31
31
 
32
32
  def lazy_import():
33
33
  from criteo_api_retailmedia_preview.model.common_problem import CommonProblem
34
- from criteo_api_retailmedia_preview.model.resource_of_retail_media_account import ResourceOfRetailMediaAccount
34
+ from criteo_api_retailmedia_preview.model.rm_contact_list_statistics_entity_v1_resource import RmContactListStatisticsEntityV1Resource
35
35
  globals()['CommonProblem'] = CommonProblem
36
- globals()['ResourceOfRetailMediaAccount'] = ResourceOfRetailMediaAccount
36
+ globals()['RmContactListStatisticsEntityV1Resource'] = RmContactListStatisticsEntityV1Resource
37
37
 
38
38
 
39
- class ResourceOutcomeOfRetailMediaAccount(ModelNormal):
39
+ class RmContactListStatisticsEntityV1Response(ModelNormal):
40
40
  """NOTE: This class is auto generated by OpenAPI Generator.
41
41
  Ref: https://openapi-generator.tech
42
42
 
@@ -66,7 +66,14 @@ class ResourceOutcomeOfRetailMediaAccount(ModelNormal):
66
66
  validations = {
67
67
  }
68
68
 
69
- additional_properties_type = None
69
+ @cached_property
70
+ def additional_properties_type():
71
+ """
72
+ This must be a method because a model may have properties that are
73
+ of type self, this must run after the class is loaded
74
+ """
75
+ lazy_import()
76
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
70
77
 
71
78
  _nullable = False
72
79
 
@@ -82,7 +89,7 @@ class ResourceOutcomeOfRetailMediaAccount(ModelNormal):
82
89
  """
83
90
  lazy_import()
84
91
  return {
85
- 'data': (ResourceOfRetailMediaAccount,), # noqa: E501
92
+ 'data': (RmContactListStatisticsEntityV1Resource,), # noqa: E501
86
93
  'warnings': ([CommonProblem], none_type,), # noqa: E501
87
94
  'errors': ([CommonProblem], none_type,), # noqa: E501
88
95
  }
@@ -108,7 +115,7 @@ class ResourceOutcomeOfRetailMediaAccount(ModelNormal):
108
115
  @classmethod
109
116
  @convert_js_args_to_python_args
110
117
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
111
- """ResourceOutcomeOfRetailMediaAccount - a model defined in OpenAPI
118
+ """RmContactListStatisticsEntityV1Response - a model defined in OpenAPI
112
119
 
113
120
  Keyword Args:
114
121
  _check_type (bool): if True, values for parameters in openapi_types
@@ -141,7 +148,7 @@ class ResourceOutcomeOfRetailMediaAccount(ModelNormal):
141
148
  Animal class but this time we won't travel
142
149
  through its discriminator because we passed in
143
150
  _visited_composed_classes = (Animal,)
144
- data (ResourceOfRetailMediaAccount): [optional] # noqa: E501
151
+ data (RmContactListStatisticsEntityV1Resource): [optional] # noqa: E501
145
152
  warnings ([CommonProblem], none_type): [optional] # noqa: E501
146
153
  errors ([CommonProblem], none_type): [optional] # noqa: E501
147
154
  """
@@ -196,7 +203,7 @@ class ResourceOutcomeOfRetailMediaAccount(ModelNormal):
196
203
 
197
204
  @convert_js_args_to_python_args
198
205
  def __init__(self, *args, **kwargs): # noqa: E501
199
- """ResourceOutcomeOfRetailMediaAccount - a model defined in OpenAPI
206
+ """RmContactListStatisticsEntityV1Response - a model defined in OpenAPI
200
207
 
201
208
  Keyword Args:
202
209
  _check_type (bool): if True, values for parameters in openapi_types
@@ -229,7 +236,7 @@ class ResourceOutcomeOfRetailMediaAccount(ModelNormal):
229
236
  Animal class but this time we won't travel
230
237
  through its discriminator because we passed in
231
238
  _visited_composed_classes = (Animal,)
232
- data (ResourceOfRetailMediaAccount): [optional] # noqa: E501
239
+ data (RmContactListStatisticsEntityV1Resource): [optional] # noqa: E501
233
240
  warnings ([CommonProblem], none_type): [optional] # noqa: E501
234
241
  errors ([CommonProblem], none_type): [optional] # noqa: E501
235
242
  """
@@ -0,0 +1,275 @@
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 RmContactListV1(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
+ ('type',): {
59
+ 'None': None,
60
+ 'UNKNOWN': "Unknown",
61
+ 'EMAIL': "Email",
62
+ 'USERIDENTIFIER': "UserIdentifier",
63
+ 'IDENTITYLINK': "IdentityLink",
64
+ 'CUSTOMERID': "CustomerId",
65
+ },
66
+ }
67
+
68
+ validations = {
69
+ }
70
+
71
+ @cached_property
72
+ def additional_properties_type():
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
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
78
+
79
+ _nullable = False
80
+
81
+ @cached_property
82
+ def openapi_types():
83
+ """
84
+ This must be a method because a model may have properties that are
85
+ of type self, this must run after the class is loaded
86
+
87
+ Returns
88
+ openapi_types (dict): The key is attribute name
89
+ and the value is attribute type.
90
+ """
91
+ return {
92
+ 'is_read_only': (bool, none_type,), # noqa: E501
93
+ 'type': (str, none_type,), # noqa: E501
94
+ }
95
+
96
+ @cached_property
97
+ def discriminator():
98
+ return None
99
+
100
+
101
+ attribute_map = {
102
+ 'is_read_only': 'isReadOnly', # noqa: E501
103
+ 'type': 'type', # noqa: E501
104
+ }
105
+
106
+ read_only_vars = {
107
+ }
108
+
109
+ _composed_schemas = {}
110
+
111
+ @classmethod
112
+ @convert_js_args_to_python_args
113
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
114
+ """RmContactListV1 - a model defined in OpenAPI
115
+
116
+ Keyword Args:
117
+ _check_type (bool): if True, values for parameters in openapi_types
118
+ will be type checked and a TypeError will be
119
+ raised if the wrong type is input.
120
+ Defaults to True
121
+ _path_to_item (tuple/list): This is a list of keys or values to
122
+ drill down to the model in received_data
123
+ when deserializing a response
124
+ _spec_property_naming (bool): True if the variable names in the input data
125
+ are serialized names, as specified in the OpenAPI document.
126
+ False if the variable names in the input data
127
+ are pythonic names, e.g. snake case (default)
128
+ _configuration (Configuration): the instance to use when
129
+ deserializing a file_type parameter.
130
+ If passed, type conversion is attempted
131
+ If omitted no type conversion is done.
132
+ _visited_composed_classes (tuple): This stores a tuple of
133
+ classes that we have traveled through so that
134
+ if we see that class again we will not use its
135
+ discriminator again.
136
+ When traveling through a discriminator, the
137
+ composed schema that is
138
+ is traveled through is added to this set.
139
+ For example if Animal has a discriminator
140
+ petType and we pass in "Dog", and the class Dog
141
+ allOf includes Animal, we move through Animal
142
+ once using the discriminator, and pick Dog.
143
+ Then in Dog, we will make an instance of the
144
+ Animal class but this time we won't travel
145
+ through its discriminator because we passed in
146
+ _visited_composed_classes = (Animal,)
147
+ is_read_only (bool, none_type): Is the segment read-only. [optional] # noqa: E501
148
+ type (str, none_type): Indicates contact list type. [optional] # noqa: E501
149
+ """
150
+
151
+ _check_type = kwargs.pop('_check_type', True)
152
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
153
+ _path_to_item = kwargs.pop('_path_to_item', ())
154
+ _configuration = kwargs.pop('_configuration', None)
155
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
156
+
157
+ self = super(OpenApiModel, cls).__new__(cls)
158
+
159
+ if args:
160
+ for arg in args:
161
+ if isinstance(arg, dict):
162
+ kwargs.update(arg)
163
+ else:
164
+ raise ApiTypeError(
165
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
166
+ args,
167
+ self.__class__.__name__,
168
+ ),
169
+ path_to_item=_path_to_item,
170
+ valid_classes=(self.__class__,),
171
+ )
172
+
173
+ self._data_store = {}
174
+ self._check_type = _check_type
175
+ self._spec_property_naming = _spec_property_naming
176
+ self._path_to_item = _path_to_item
177
+ self._configuration = _configuration
178
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
179
+
180
+ for var_name, var_value in kwargs.items():
181
+ if var_name not in self.attribute_map and \
182
+ self._configuration is not None and \
183
+ self._configuration.discard_unknown_keys and \
184
+ self.additional_properties_type is None:
185
+ # discard variable.
186
+ continue
187
+ setattr(self, var_name, var_value)
188
+ return self
189
+
190
+ required_properties = set([
191
+ '_data_store',
192
+ '_check_type',
193
+ '_spec_property_naming',
194
+ '_path_to_item',
195
+ '_configuration',
196
+ '_visited_composed_classes',
197
+ ])
198
+
199
+ @convert_js_args_to_python_args
200
+ def __init__(self, *args, **kwargs): # noqa: E501
201
+ """RmContactListV1 - a model defined in OpenAPI
202
+
203
+ Keyword Args:
204
+ _check_type (bool): if True, values for parameters in openapi_types
205
+ will be type checked and a TypeError will be
206
+ raised if the wrong type is input.
207
+ Defaults to True
208
+ _path_to_item (tuple/list): This is a list of keys or values to
209
+ drill down to the model in received_data
210
+ when deserializing a response
211
+ _spec_property_naming (bool): True if the variable names in the input data
212
+ are serialized names, as specified in the OpenAPI document.
213
+ False if the variable names in the input data
214
+ are pythonic names, e.g. snake case (default)
215
+ _configuration (Configuration): the instance to use when
216
+ deserializing a file_type parameter.
217
+ If passed, type conversion is attempted
218
+ If omitted no type conversion is done.
219
+ _visited_composed_classes (tuple): This stores a tuple of
220
+ classes that we have traveled through so that
221
+ if we see that class again we will not use its
222
+ discriminator again.
223
+ When traveling through a discriminator, the
224
+ composed schema that is
225
+ is traveled through is added to this set.
226
+ For example if Animal has a discriminator
227
+ petType and we pass in "Dog", and the class Dog
228
+ allOf includes Animal, we move through Animal
229
+ once using the discriminator, and pick Dog.
230
+ Then in Dog, we will make an instance of the
231
+ Animal class but this time we won't travel
232
+ through its discriminator because we passed in
233
+ _visited_composed_classes = (Animal,)
234
+ is_read_only (bool, none_type): Is the segment read-only. [optional] # noqa: E501
235
+ type (str, none_type): Indicates contact list type. [optional] # noqa: E501
236
+ """
237
+
238
+ _check_type = kwargs.pop('_check_type', True)
239
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
240
+ _path_to_item = kwargs.pop('_path_to_item', ())
241
+ _configuration = kwargs.pop('_configuration', None)
242
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
243
+
244
+ if args:
245
+ for arg in args:
246
+ if isinstance(arg, dict):
247
+ kwargs.update(arg)
248
+ else:
249
+ raise ApiTypeError(
250
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
251
+ args,
252
+ self.__class__.__name__,
253
+ ),
254
+ path_to_item=_path_to_item,
255
+ valid_classes=(self.__class__,),
256
+ )
257
+
258
+ self._data_store = {}
259
+ self._check_type = _check_type
260
+ self._spec_property_naming = _spec_property_naming
261
+ self._path_to_item = _path_to_item
262
+ self._configuration = _configuration
263
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
264
+
265
+ for var_name, var_value in kwargs.items():
266
+ if var_name not in self.attribute_map and \
267
+ self._configuration is not None and \
268
+ self._configuration.discard_unknown_keys and \
269
+ self.additional_properties_type is None:
270
+ # discard variable.
271
+ continue
272
+ setattr(self, var_name, var_value)
273
+ if var_name in self.read_only_vars:
274
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
275
+ f"class with read only attributes.")