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.

Files changed (34) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +70 -73
  3. criteo_api_retailmedia_preview/api/analytics_api.py +137 -0
  4. criteo_api_retailmedia_preview/api/audience_api.py +12 -12
  5. criteo_api_retailmedia_preview/api/billing_api.py +18 -18
  6. criteo_api_retailmedia_preview/api/campaign_api.py +493 -325
  7. criteo_api_retailmedia_preview/api_client.py +4 -4
  8. criteo_api_retailmedia_preview/configuration.py +1 -1
  9. criteo_api_retailmedia_preview/model/async_fill_rate_report.py +5 -0
  10. criteo_api_retailmedia_preview/model/async_unfilled_placements_report.py +392 -0
  11. criteo_api_retailmedia_preview/model/async_unfilled_placements_report_request.py +269 -0
  12. criteo_api_retailmedia_preview/model/async_unfilled_placements_report_resource.py +273 -0
  13. criteo_api_retailmedia_preview/model/campaign_availability.py +289 -0
  14. criteo_api_retailmedia_preview/model/demand_managed_fee.py +1 -1
  15. 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
  16. criteo_api_retailmedia_preview/model/entity_resource_of_retailer_result.py +270 -0
  17. criteo_api_retailmedia_preview/model/files_variable_value.py +0 -3
  18. criteo_api_retailmedia_preview/model/managed_service_fee.py +1 -1
  19. criteo_api_retailmedia_preview/model/page_type_combination.py +287 -0
  20. criteo_api_retailmedia_preview/model/private_market_fees.py +6 -14
  21. criteo_api_retailmedia_preview/model/retailer_result.py +266 -0
  22. criteo_api_retailmedia_preview/model/{account_fees_update_result.py → retailer_search_request.py} +8 -12
  23. criteo_api_retailmedia_preview/model/rm_contact_list_create_v1.py +1 -0
  24. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +1 -0
  25. criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +11 -2
  26. criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +8 -0
  27. criteo_api_retailmedia_preview/model/sponsored_products_line_item_update_request_model.py +34 -28
  28. criteo_api_retailmedia_preview/model/value_resource_input_of_retailer_search_request.py +262 -0
  29. criteo_api_retailmedia_preview/model/{value_resource_account_fees_update_result.py → value_resource_of_retailer_search_request.py} +9 -9
  30. criteo_api_retailmedia_preview/models/__init__.py +11 -3
  31. {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/METADATA +3 -3
  32. {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/RECORD +34 -26
  33. {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/WHEEL +0 -0
  34. {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/top_level.txt +0 -0
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class AccountFeesUpdateResult(ModelNormal):
33
+ class RetailerSearchRequest(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -62,7 +62,7 @@ class AccountFeesUpdateResult(ModelNormal):
62
62
 
63
63
  additional_properties_type = None
64
64
 
65
- _nullable = True
65
+ _nullable = False
66
66
 
67
67
  @cached_property
68
68
  def openapi_types():
@@ -75,8 +75,7 @@ class AccountFeesUpdateResult(ModelNormal):
75
75
  and the value is attribute type.
76
76
  """
77
77
  return {
78
- 'failed_update_account_ids': ([str], none_type,), # noqa: E501
79
- 'successfully_updated_account_ids': ([str], none_type,), # noqa: E501
78
+ 'retailer_id_filter': ([str], none_type,), # noqa: E501
80
79
  }
81
80
 
82
81
  @cached_property
@@ -85,8 +84,7 @@ class AccountFeesUpdateResult(ModelNormal):
85
84
 
86
85
 
87
86
  attribute_map = {
88
- 'failed_update_account_ids': 'failedUpdateAccountIds', # noqa: E501
89
- 'successfully_updated_account_ids': 'successfullyUpdatedAccountIds', # noqa: E501
87
+ 'retailer_id_filter': 'retailerIdFilter', # noqa: E501
90
88
  }
91
89
 
92
90
  read_only_vars = {
@@ -97,7 +95,7 @@ class AccountFeesUpdateResult(ModelNormal):
97
95
  @classmethod
98
96
  @convert_js_args_to_python_args
99
97
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
100
- """AccountFeesUpdateResult - a model defined in OpenAPI
98
+ """RetailerSearchRequest - a model defined in OpenAPI
101
99
 
102
100
  Keyword Args:
103
101
  _check_type (bool): if True, values for parameters in openapi_types
@@ -130,8 +128,7 @@ class AccountFeesUpdateResult(ModelNormal):
130
128
  Animal class but this time we won't travel
131
129
  through its discriminator because we passed in
132
130
  _visited_composed_classes = (Animal,)
133
- failed_update_account_ids ([str], none_type): account Id that were not updated in the request. [optional] # noqa: E501
134
- successfully_updated_account_ids ([str], none_type): account Ids that were successfully updated in the request. [optional] # noqa: E501
131
+ retailer_id_filter ([str], none_type): Optional list of retailer IDs to filter the results. [optional] # noqa: E501
135
132
  """
136
133
 
137
134
  _check_type = kwargs.pop('_check_type', True)
@@ -184,7 +181,7 @@ class AccountFeesUpdateResult(ModelNormal):
184
181
 
185
182
  @convert_js_args_to_python_args
186
183
  def __init__(self, *args, **kwargs): # noqa: E501
187
- """AccountFeesUpdateResult - a model defined in OpenAPI
184
+ """RetailerSearchRequest - a model defined in OpenAPI
188
185
 
189
186
  Keyword Args:
190
187
  _check_type (bool): if True, values for parameters in openapi_types
@@ -217,8 +214,7 @@ class AccountFeesUpdateResult(ModelNormal):
217
214
  Animal class but this time we won't travel
218
215
  through its discriminator because we passed in
219
216
  _visited_composed_classes = (Animal,)
220
- failed_update_account_ids ([str], none_type): account Id that were not updated in the request. [optional] # noqa: E501
221
- successfully_updated_account_ids ([str], none_type): account Ids that were successfully updated in the request. [optional] # noqa: E501
217
+ retailer_id_filter ([str], none_type): Optional list of retailer IDs to filter the results. [optional] # noqa: E501
222
218
  """
223
219
 
224
220
  _check_type = kwargs.pop('_check_type', True)
@@ -60,6 +60,7 @@ class RmContactListCreateV1(ModelNormal):
60
60
  'USERIDENTIFIER': "UserIdentifier",
61
61
  'IDENTITYLINK': "IdentityLink",
62
62
  'CUSTOMERID': "CustomerId",
63
+ 'PHONENUMBER': "PhoneNumber",
63
64
  },
64
65
  }
65
66
 
@@ -62,6 +62,7 @@ class RmContactListV1(ModelNormal):
62
62
  'USERIDENTIFIER': "UserIdentifier",
63
63
  'IDENTITYLINK': "IdentityLink",
64
64
  'CUSTOMERID': "CustomerId",
65
+ 'PHONENUMBER': "PhoneNumber",
65
66
  },
66
67
  ('sharing_status',): {
67
68
  'None': None,
@@ -73,6 +73,11 @@ class SponsoredProductsLineItem(ModelNormal):
73
73
  'GENERICANDBRANDED': "genericAndBranded",
74
74
  'GENERICBRANDEDANDCONQUESTING': "genericBrandedAndConquesting",
75
75
  },
76
+ ('optimization_strategy',): {
77
+ 'None': None,
78
+ 'MANUAL': "manual",
79
+ 'AUTOMATED': "automated",
80
+ },
76
81
  ('status',): {
77
82
  'None': None,
78
83
  'UNKNOWN': "unknown",
@@ -127,6 +132,7 @@ class SponsoredProductsLineItem(ModelNormal):
127
132
  'keyword_strategy': (str, none_type,), # noqa: E501
128
133
  'max_bid': (float, none_type,), # noqa: E501
129
134
  'monthly_pacing': (float, none_type,), # noqa: E501
135
+ 'optimization_strategy': (str, none_type,), # noqa: E501
130
136
  'status': (str, none_type,), # noqa: E501
131
137
  'target_bid': (float, none_type,), # noqa: E501
132
138
  }
@@ -154,6 +160,7 @@ class SponsoredProductsLineItem(ModelNormal):
154
160
  'keyword_strategy': 'keywordStrategy', # noqa: E501
155
161
  'max_bid': 'maxBid', # noqa: E501
156
162
  'monthly_pacing': 'monthlyPacing', # noqa: E501
163
+ 'optimization_strategy': 'optimizationStrategy', # noqa: E501
157
164
  'status': 'status', # noqa: E501
158
165
  'target_bid': 'targetBid', # noqa: E501
159
166
  }
@@ -174,7 +181,7 @@ class SponsoredProductsLineItem(ModelNormal):
174
181
  created_at (datetime): The date and time when the line item was created.
175
182
  name (str): The name of the line item.
176
183
  start_date (datetime): The date and time when the line item starts running.
177
- target_retailer_id (str):
184
+ target_retailer_id (str): The ID of the retailer targeted by this line item.
178
185
  updated_at (datetime): The date and time when the line item was last updated.
179
186
 
180
187
  Keyword Args:
@@ -218,6 +225,7 @@ class SponsoredProductsLineItem(ModelNormal):
218
225
  keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
219
226
  max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
220
227
  monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
228
+ optimization_strategy (str, none_type): [optional] # noqa: E501
221
229
  status (str, none_type): The current status of the line item.. [optional] # noqa: E501
222
230
  target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
223
231
  """
@@ -287,7 +295,7 @@ class SponsoredProductsLineItem(ModelNormal):
287
295
  created_at (datetime): The date and time when the line item was created.
288
296
  name (str): The name of the line item.
289
297
  start_date (datetime): The date and time when the line item starts running.
290
- target_retailer_id (str):
298
+ target_retailer_id (str): The ID of the retailer targeted by this line item.
291
299
  updated_at (datetime): The date and time when the line item was last updated.
292
300
 
293
301
  Keyword Args:
@@ -331,6 +339,7 @@ class SponsoredProductsLineItem(ModelNormal):
331
339
  keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
332
340
  max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
333
341
  monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
342
+ optimization_strategy (str, none_type): [optional] # noqa: E501
334
343
  status (str, none_type): The current status of the line item.. [optional] # noqa: E501
335
344
  target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
336
345
  """
@@ -71,6 +71,10 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
71
71
  'GENERICANDBRANDED': "genericAndBranded",
72
72
  'GENERICBRANDEDANDCONQUESTING': "genericBrandedAndConquesting",
73
73
  },
74
+ ('optimization_strategy_enum',): {
75
+ 'MANUAL': "manual",
76
+ 'AUTOMATED': "automated",
77
+ },
74
78
  }
75
79
 
76
80
  validations = {
@@ -108,6 +112,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
108
112
  'keyword_strategy': (str, none_type,), # noqa: E501
109
113
  'max_bid': (float, none_type,), # noqa: E501
110
114
  'monthly_pacing': (float, none_type,), # noqa: E501
115
+ 'optimization_strategy_enum': (str,), # noqa: E501
111
116
  'target_bid': (float, none_type,), # noqa: E501
112
117
  }
113
118
 
@@ -129,6 +134,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
129
134
  'keyword_strategy': 'keywordStrategy', # noqa: E501
130
135
  'max_bid': 'maxBid', # noqa: E501
131
136
  'monthly_pacing': 'monthlyPacing', # noqa: E501
137
+ 'optimization_strategy_enum': 'optimizationStrategyEnum', # noqa: E501
132
138
  'target_bid': 'targetBid', # noqa: E501
133
139
  }
134
140
 
@@ -187,6 +193,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
187
193
  keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
188
194
  max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
189
195
  monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
196
+ optimization_strategy_enum (str): [optional] if omitted the server will use the default value of "manual" # noqa: E501
190
197
  target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
191
198
  """
192
199
 
@@ -290,6 +297,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
290
297
  keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
291
298
  max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
292
299
  monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
300
+ optimization_strategy_enum (str): [optional] if omitted the server will use the default value of "manual" # noqa: E501
293
301
  target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
294
302
  """
295
303
 
@@ -70,6 +70,10 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
70
70
  'CLICKS': "clicks",
71
71
  'REVENUE': "revenue",
72
72
  },
73
+ ('optimization_strategy',): {
74
+ 'MANUAL': "manual",
75
+ 'AUTOMATED': "automated",
76
+ },
73
77
  }
74
78
 
75
79
  validations = {
@@ -99,7 +103,6 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
99
103
  'name': (str,), # noqa: E501
100
104
  'start_date': (datetime,), # noqa: E501
101
105
  'status': (str,), # noqa: E501
102
- 'target_bid': (float,), # noqa: E501
103
106
  'bid_strategy': (str,), # noqa: E501
104
107
  'budget': (float, none_type,), # noqa: E501
105
108
  'daily_pacing': (float, none_type,), # noqa: E501
@@ -107,6 +110,8 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
107
110
  'flight_schedule': (FlightSchedule,), # noqa: E501
108
111
  'max_bid': (float, none_type,), # noqa: E501
109
112
  'monthly_pacing': (float, none_type,), # noqa: E501
113
+ 'optimization_strategy': (str,), # noqa: E501
114
+ 'target_bid': (float, none_type,), # noqa: E501
110
115
  }
111
116
 
112
117
  @cached_property
@@ -119,7 +124,6 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
119
124
  'name': 'name', # noqa: E501
120
125
  'start_date': 'startDate', # noqa: E501
121
126
  'status': 'status', # noqa: E501
122
- 'target_bid': 'targetBid', # noqa: E501
123
127
  'bid_strategy': 'bidStrategy', # noqa: E501
124
128
  'budget': 'budget', # noqa: E501
125
129
  'daily_pacing': 'dailyPacing', # noqa: E501
@@ -127,6 +131,8 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
127
131
  'flight_schedule': 'flightSchedule', # noqa: E501
128
132
  'max_bid': 'maxBid', # noqa: E501
129
133
  'monthly_pacing': 'monthlyPacing', # noqa: E501
134
+ 'optimization_strategy': 'optimizationStrategy', # noqa: E501
135
+ 'target_bid': 'targetBid', # noqa: E501
130
136
  }
131
137
 
132
138
  read_only_vars = {
@@ -136,15 +142,14 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
136
142
 
137
143
  @classmethod
138
144
  @convert_js_args_to_python_args
139
- def _from_openapi_data(cls, is_auto_daily_pacing, name, start_date, status, target_bid, *args, **kwargs): # noqa: E501
145
+ def _from_openapi_data(cls, is_auto_daily_pacing, name, start_date, status, *args, **kwargs): # noqa: E501
140
146
  """SponsoredProductsLineItemUpdateRequestModel - a model defined in OpenAPI
141
147
 
142
148
  Args:
143
- is_auto_daily_pacing (bool):
144
- name (str):
145
- start_date (datetime):
146
- status (str): Status of a line item.
147
- target_bid (float):
149
+ is_auto_daily_pacing (bool): True if daily pacing is automatic, false if manual.
150
+ name (str): The name of this line item.
151
+ start_date (datetime): The date and time when the line item starts running.
152
+ status (str): The current status of the line item.
148
153
 
149
154
  Keyword Args:
150
155
  _check_type (bool): if True, values for parameters in openapi_types
@@ -177,13 +182,15 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
177
182
  Animal class but this time we won't travel
178
183
  through its discriminator because we passed in
179
184
  _visited_composed_classes = (Animal,)
180
- bid_strategy (str): [optional] if omitted the server will use the default value of "conversion" # noqa: E501
181
- budget (float, none_type): [optional] # noqa: E501
182
- daily_pacing (float, none_type): [optional] # noqa: E501
183
- end_date (datetime, none_type): [optional] # noqa: E501
185
+ bid_strategy (str): The bidding strategy for the line item.. [optional] if omitted the server will use the default value of "conversion" # noqa: E501
186
+ budget (float, none_type): The total budget allocated for this line item.. [optional] # noqa: E501
187
+ daily_pacing (float, none_type): The daily pacing amount for the line item.. [optional] # noqa: E501
188
+ end_date (datetime, none_type): The date and time when the line item stops running.. [optional] # noqa: E501
184
189
  flight_schedule (FlightSchedule): [optional] # noqa: E501
185
- max_bid (float, none_type): [optional] # noqa: E501
186
- monthly_pacing (float, none_type): [optional] # noqa: E501
190
+ max_bid (float, none_type): The maximum bid amount for the line item.. [optional] # noqa: E501
191
+ monthly_pacing (float, none_type): The monthly pacing amount for the line item.. [optional] # noqa: E501
192
+ optimization_strategy (str): The optimization strategy for the line item.. [optional] if omitted the server will use the default value of "manual" # noqa: E501
193
+ target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
187
194
  """
188
195
 
189
196
  _check_type = kwargs.pop('_check_type', True)
@@ -219,7 +226,6 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
219
226
  self.name = name
220
227
  self.start_date = start_date
221
228
  self.status = status
222
- self.target_bid = target_bid
223
229
  for var_name, var_value in kwargs.items():
224
230
  if var_name not in self.attribute_map and \
225
231
  self._configuration is not None and \
@@ -240,15 +246,14 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
240
246
  ])
241
247
 
242
248
  @convert_js_args_to_python_args
243
- def __init__(self, is_auto_daily_pacing, name, start_date, status, target_bid, *args, **kwargs): # noqa: E501
249
+ def __init__(self, is_auto_daily_pacing, name, start_date, status, *args, **kwargs): # noqa: E501
244
250
  """SponsoredProductsLineItemUpdateRequestModel - a model defined in OpenAPI
245
251
 
246
252
  Args:
247
- is_auto_daily_pacing (bool):
248
- name (str):
249
- start_date (datetime):
250
- status (str): Status of a line item.
251
- target_bid (float):
253
+ is_auto_daily_pacing (bool): True if daily pacing is automatic, false if manual.
254
+ name (str): The name of this line item.
255
+ start_date (datetime): The date and time when the line item starts running.
256
+ status (str): The current status of the line item.
252
257
 
253
258
  Keyword Args:
254
259
  _check_type (bool): if True, values for parameters in openapi_types
@@ -281,13 +286,15 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
281
286
  Animal class but this time we won't travel
282
287
  through its discriminator because we passed in
283
288
  _visited_composed_classes = (Animal,)
284
- bid_strategy (str): [optional] if omitted the server will use the default value of "conversion" # noqa: E501
285
- budget (float, none_type): [optional] # noqa: E501
286
- daily_pacing (float, none_type): [optional] # noqa: E501
287
- end_date (datetime, none_type): [optional] # noqa: E501
289
+ bid_strategy (str): The bidding strategy for the line item.. [optional] if omitted the server will use the default value of "conversion" # noqa: E501
290
+ budget (float, none_type): The total budget allocated for this line item.. [optional] # noqa: E501
291
+ daily_pacing (float, none_type): The daily pacing amount for the line item.. [optional] # noqa: E501
292
+ end_date (datetime, none_type): The date and time when the line item stops running.. [optional] # noqa: E501
288
293
  flight_schedule (FlightSchedule): [optional] # noqa: E501
289
- max_bid (float, none_type): [optional] # noqa: E501
290
- monthly_pacing (float, none_type): [optional] # noqa: E501
294
+ max_bid (float, none_type): The maximum bid amount for the line item.. [optional] # noqa: E501
295
+ monthly_pacing (float, none_type): The monthly pacing amount for the line item.. [optional] # noqa: E501
296
+ optimization_strategy (str): The optimization strategy for the line item.. [optional] if omitted the server will use the default value of "manual" # noqa: E501
297
+ target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
291
298
  """
292
299
 
293
300
  _check_type = kwargs.pop('_check_type', True)
@@ -321,7 +328,6 @@ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
321
328
  self.name = name
322
329
  self.start_date = start_date
323
330
  self.status = status
324
- self.target_bid = target_bid
325
331
  for var_name, var_value in kwargs.items():
326
332
  if var_name not in self.attribute_map and \
327
333
  self._configuration is not None and \
@@ -0,0 +1,262 @@
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.value_resource_of_retailer_search_request import ValueResourceOfRetailerSearchRequest
34
+ globals()['ValueResourceOfRetailerSearchRequest'] = ValueResourceOfRetailerSearchRequest
35
+
36
+
37
+ class ValueResourceInputOfRetailerSearchRequest(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
+ 'data': (ValueResourceOfRetailerSearchRequest,), # noqa: E501
84
+ }
85
+
86
+ @cached_property
87
+ def discriminator():
88
+ return None
89
+
90
+
91
+ attribute_map = {
92
+ 'data': 'data', # noqa: E501
93
+ }
94
+
95
+ read_only_vars = {
96
+ }
97
+
98
+ _composed_schemas = {}
99
+
100
+ @classmethod
101
+ @convert_js_args_to_python_args
102
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
103
+ """ValueResourceInputOfRetailerSearchRequest - a model defined in OpenAPI
104
+
105
+ Keyword Args:
106
+ _check_type (bool): if True, values for parameters in openapi_types
107
+ will be type checked and a TypeError will be
108
+ raised if the wrong type is input.
109
+ Defaults to True
110
+ _path_to_item (tuple/list): This is a list of keys or values to
111
+ drill down to the model in received_data
112
+ when deserializing a response
113
+ _spec_property_naming (bool): True if the variable names in the input data
114
+ are serialized names, as specified in the OpenAPI document.
115
+ False if the variable names in the input data
116
+ are pythonic names, e.g. snake case (default)
117
+ _configuration (Configuration): the instance to use when
118
+ deserializing a file_type parameter.
119
+ If passed, type conversion is attempted
120
+ If omitted no type conversion is done.
121
+ _visited_composed_classes (tuple): This stores a tuple of
122
+ classes that we have traveled through so that
123
+ if we see that class again we will not use its
124
+ discriminator again.
125
+ When traveling through a discriminator, the
126
+ composed schema that is
127
+ is traveled through is added to this set.
128
+ For example if Animal has a discriminator
129
+ petType and we pass in "Dog", and the class Dog
130
+ allOf includes Animal, we move through Animal
131
+ once using the discriminator, and pick Dog.
132
+ Then in Dog, we will make an instance of the
133
+ Animal class but this time we won't travel
134
+ through its discriminator because we passed in
135
+ _visited_composed_classes = (Animal,)
136
+ data (ValueResourceOfRetailerSearchRequest): [optional] # noqa: E501
137
+ """
138
+
139
+ _check_type = kwargs.pop('_check_type', True)
140
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
141
+ _path_to_item = kwargs.pop('_path_to_item', ())
142
+ _configuration = kwargs.pop('_configuration', None)
143
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
144
+
145
+ self = super(OpenApiModel, cls).__new__(cls)
146
+
147
+ if args:
148
+ for arg in args:
149
+ if isinstance(arg, dict):
150
+ kwargs.update(arg)
151
+ else:
152
+ raise ApiTypeError(
153
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
154
+ args,
155
+ self.__class__.__name__,
156
+ ),
157
+ path_to_item=_path_to_item,
158
+ valid_classes=(self.__class__,),
159
+ )
160
+
161
+ self._data_store = {}
162
+ self._check_type = _check_type
163
+ self._spec_property_naming = _spec_property_naming
164
+ self._path_to_item = _path_to_item
165
+ self._configuration = _configuration
166
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
167
+
168
+ for var_name, var_value in kwargs.items():
169
+ if var_name not in self.attribute_map and \
170
+ self._configuration is not None and \
171
+ self._configuration.discard_unknown_keys and \
172
+ self.additional_properties_type is None:
173
+ # discard variable.
174
+ continue
175
+ setattr(self, var_name, var_value)
176
+ return self
177
+
178
+ required_properties = set([
179
+ '_data_store',
180
+ '_check_type',
181
+ '_spec_property_naming',
182
+ '_path_to_item',
183
+ '_configuration',
184
+ '_visited_composed_classes',
185
+ ])
186
+
187
+ @convert_js_args_to_python_args
188
+ def __init__(self, *args, **kwargs): # noqa: E501
189
+ """ValueResourceInputOfRetailerSearchRequest - a model defined in OpenAPI
190
+
191
+ Keyword Args:
192
+ _check_type (bool): if True, values for parameters in openapi_types
193
+ will be type checked and a TypeError will be
194
+ raised if the wrong type is input.
195
+ Defaults to True
196
+ _path_to_item (tuple/list): This is a list of keys or values to
197
+ drill down to the model in received_data
198
+ when deserializing a response
199
+ _spec_property_naming (bool): True if the variable names in the input data
200
+ are serialized names, as specified in the OpenAPI document.
201
+ False if the variable names in the input data
202
+ are pythonic names, e.g. snake case (default)
203
+ _configuration (Configuration): the instance to use when
204
+ deserializing a file_type parameter.
205
+ If passed, type conversion is attempted
206
+ If omitted no type conversion is done.
207
+ _visited_composed_classes (tuple): This stores a tuple of
208
+ classes that we have traveled through so that
209
+ if we see that class again we will not use its
210
+ discriminator again.
211
+ When traveling through a discriminator, the
212
+ composed schema that is
213
+ is traveled through is added to this set.
214
+ For example if Animal has a discriminator
215
+ petType and we pass in "Dog", and the class Dog
216
+ allOf includes Animal, we move through Animal
217
+ once using the discriminator, and pick Dog.
218
+ Then in Dog, we will make an instance of the
219
+ Animal class but this time we won't travel
220
+ through its discriminator because we passed in
221
+ _visited_composed_classes = (Animal,)
222
+ data (ValueResourceOfRetailerSearchRequest): [optional] # noqa: E501
223
+ """
224
+
225
+ _check_type = kwargs.pop('_check_type', True)
226
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
227
+ _path_to_item = kwargs.pop('_path_to_item', ())
228
+ _configuration = kwargs.pop('_configuration', None)
229
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
230
+
231
+ if args:
232
+ for arg in args:
233
+ if isinstance(arg, dict):
234
+ kwargs.update(arg)
235
+ else:
236
+ raise ApiTypeError(
237
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
238
+ args,
239
+ self.__class__.__name__,
240
+ ),
241
+ path_to_item=_path_to_item,
242
+ valid_classes=(self.__class__,),
243
+ )
244
+
245
+ self._data_store = {}
246
+ self._check_type = _check_type
247
+ self._spec_property_naming = _spec_property_naming
248
+ self._path_to_item = _path_to_item
249
+ self._configuration = _configuration
250
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
251
+
252
+ for var_name, var_value in kwargs.items():
253
+ if var_name not in self.attribute_map and \
254
+ self._configuration is not None and \
255
+ self._configuration.discard_unknown_keys and \
256
+ self.additional_properties_type is None:
257
+ # discard variable.
258
+ continue
259
+ setattr(self, var_name, var_value)
260
+ if var_name in self.read_only_vars:
261
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
262
+ f"class with read only attributes.")