criteo-api-retailmedia-sdk 0.0.250409__py3-none-any.whl → 0.0.250606__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.
Files changed (96) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +3 -147
  3. criteo_api_retailmedia_preview/api/analytics_api.py +1 -1
  4. criteo_api_retailmedia_preview/api/audience_api.py +1204 -135
  5. criteo_api_retailmedia_preview/api/campaign_api.py +741 -104
  6. criteo_api_retailmedia_preview/api_client.py +1 -1
  7. criteo_api_retailmedia_preview/configuration.py +1 -1
  8. criteo_api_retailmedia_preview/model/account_fees_update_request.py +4 -0
  9. criteo_api_retailmedia_preview/model/async_accounts_report.py +6 -6
  10. criteo_api_retailmedia_preview/model/async_campaigns_report.py +4 -4
  11. criteo_api_retailmedia_preview/model/async_line_items_report.py +4 -4
  12. criteo_api_retailmedia_preview/model/async_offsite_report.py +25 -18
  13. criteo_api_retailmedia_preview/model/brand_id_search_request.py +7 -1
  14. criteo_api_retailmedia_preview/model/brand_id_search_result.py +7 -1
  15. criteo_api_retailmedia_preview/model/categories_search_request_v1.py +270 -0
  16. criteo_api_retailmedia_preview/model/entity_resource_brand_id_search_result.py +8 -1
  17. criteo_api_retailmedia_preview/model/entity_resource_category202204.py +277 -0
  18. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_brand_id_search_result_paging_offset_limit_metadata.py +8 -1
  19. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204.py +281 -0
  20. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204_metadata.py +287 -0
  21. criteo_api_retailmedia_preview/model/entity_resource_of_sponsored_products_line_item.py +270 -0
  22. criteo_api_retailmedia_preview/model/entity_resource_outcome_of_sponsored_products_line_item.py +274 -0
  23. criteo_api_retailmedia_preview/model/{input_keywords.py → flight_leg.py} +39 -17
  24. criteo_api_retailmedia_preview/model/{recommended_keywords_result.py → flight_schedule.py} +9 -13
  25. criteo_api_retailmedia_preview/model/nillable_decimal.py +263 -0
  26. criteo_api_retailmedia_preview/model/page_of_sponsored_products_line_item.py +276 -0
  27. criteo_api_retailmedia_preview/model/paging_offset_limit_metadata.py +7 -1
  28. criteo_api_retailmedia_preview/model/{grant_consent_model.py → recommended_categories_request_v1.py} +14 -21
  29. criteo_api_retailmedia_preview/model/recommended_keywords_request_v1.py +266 -0
  30. criteo_api_retailmedia_preview/model/recommended_keywords_response_v1.py +263 -0
  31. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_request.py → rm_audience_bulk_create_input_v1.py} +9 -9
  32. criteo_api_retailmedia_preview/model/{grant_consent_input.py → rm_audience_bulk_delete_input_v1.py} +8 -8
  33. criteo_api_retailmedia_preview/model/rm_audience_bulk_update_input_v1.py +269 -0
  34. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1.py +272 -0
  35. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1_resource.py +273 -0
  36. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_input_v1.py +269 -0
  37. criteo_api_retailmedia_preview/model/rm_audience_create_entity_v1.py +291 -0
  38. criteo_api_retailmedia_preview/model/{grant_consent_model_value_resource.py → rm_audience_create_entity_v1_resource.py} +8 -8
  39. criteo_api_retailmedia_preview/model/rm_audience_delete_entity_v1_resource.py +271 -0
  40. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_recommended_keywords_result.py → rm_audience_entity_v1_list_response.py} +16 -9
  41. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1.py +282 -0
  42. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1_resource.py +273 -0
  43. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_input_v1.py +269 -0
  44. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1.py +272 -0
  45. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1_resource.py +273 -0
  46. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_sizes_input_v1.py +269 -0
  47. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +6 -0
  48. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1.py +282 -0
  49. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1_resource.py +273 -0
  50. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_input_v1.py +269 -0
  51. criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1.py +267 -0
  52. criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1_list_response.py +281 -0
  53. criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers_v2.py → rm_audience_segment_size_entity_v1_resource.py} +11 -11
  54. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1.py +267 -0
  55. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_resource.py +273 -0
  56. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_response.py +281 -0
  57. criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1.py +6 -0
  58. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1.py +267 -0
  59. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_list_response.py +281 -0
  60. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_resource.py +277 -0
  61. criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1.py +267 -0
  62. criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1_resource.py +273 -0
  63. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_response.py → rm_audience_size_estimation_v1_response.py} +9 -9
  64. criteo_api_retailmedia_preview/model/rm_audience_update_entity_v1.py +279 -0
  65. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py → rm_audience_update_entity_v1_resource.py} +17 -19
  66. criteo_api_retailmedia_preview/model/rm_events_create_v1.py +305 -0
  67. criteo_api_retailmedia_preview/model/rm_events_estimation_v1.py +305 -0
  68. criteo_api_retailmedia_preview/model/rm_events_update_v1.py +307 -0
  69. criteo_api_retailmedia_preview/model/sku_slim_data_preview.py +6 -6
  70. criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +387 -0
  71. criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers_v2.py → sponsored_products_line_item_create_request_model.py} +81 -33
  72. criteo_api_retailmedia_preview/model/{keywords.py → sponsored_products_line_item_update_request_model.py} +82 -44
  73. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +2 -2
  74. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +4 -4
  75. criteo_api_retailmedia_preview/model/sync_line_items_report.py +4 -4
  76. criteo_api_retailmedia_preview/model/value_resource_brand_id_search_request.py +8 -1
  77. criteo_api_retailmedia_preview/model/value_resource_categories_search_request_v1.py +273 -0
  78. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_private_market_account_fees.py → value_resource_collection_outcome_private_market_account_fees_and_metadata.py} +9 -3
  79. criteo_api_retailmedia_preview/model/value_resource_input_brand_id_search_request.py +8 -1
  80. criteo_api_retailmedia_preview/model/value_resource_input_categories_search_request_v1.py +269 -0
  81. criteo_api_retailmedia_preview/model/value_resource_input_of_sponsored_products_line_item_update_request_model.py +262 -0
  82. criteo_api_retailmedia_preview/model/value_resource_input_recommended_categories_request_v1.py +269 -0
  83. criteo_api_retailmedia_preview/model/value_resource_input_recommended_keywords_request_v1.py +262 -0
  84. criteo_api_retailmedia_preview/model/value_resource_of_sponsored_products_line_item_update_request_model.py +266 -0
  85. criteo_api_retailmedia_preview/model/value_resource_outcome_recommended_keywords_response_v1.py +274 -0
  86. criteo_api_retailmedia_preview/model/value_resource_recommended_categories_request_v1.py +273 -0
  87. criteo_api_retailmedia_preview/model/value_resource_recommended_keywords_request_v1.py +266 -0
  88. criteo_api_retailmedia_preview/model/{value_resource_of_recommended_keywords_result.py → value_resource_recommended_keywords_response_v1.py} +10 -10
  89. criteo_api_retailmedia_preview/models/__init__.py +63 -17
  90. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/METADATA +3 -3
  91. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/RECORD +93 -47
  92. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/WHEEL +1 -1
  93. criteo_api_retailmedia_preview/model/common_error.py +0 -301
  94. criteo_api_retailmedia_preview/model/common_warning.py +0 -301
  95. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +0 -307
  96. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/top_level.txt +0 -0
@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
- from criteo_api_retailmedia_preview.model.input_keywords import InputKeywords
34
- globals()['InputKeywords'] = InputKeywords
33
+ from criteo_api_retailmedia_preview.model.flight_schedule import FlightSchedule
34
+ globals()['FlightSchedule'] = FlightSchedule
35
35
 
36
36
 
37
- class Keywords(ModelNormal):
37
+ class SponsoredProductsLineItemUpdateRequestModel(ModelNormal):
38
38
  """NOTE: This class is auto generated by OpenAPI Generator.
39
39
  Ref: https://openapi-generator.tech
40
40
 
@@ -59,24 +59,24 @@ class Keywords(ModelNormal):
59
59
  """
60
60
 
61
61
  allowed_values = {
62
- ('match_type',): {
63
- 'POSITIVEEXACTMATCH': "PositiveExactMatch",
64
- 'NEGATIVEEXACTMATCH': "NegativeExactMatch",
65
- 'NEGATIVEBROADMATCH': "NegativeBroadMatch",
66
- 'UNKNOWN': "Unknown",
62
+ ('status',): {
63
+ 'ACTIVE': "Active",
64
+ 'PAUSED': "Paused",
65
+ 'DRAFT': "Draft",
67
66
  },
68
- ('review_state',): {
69
- 'INREVIEW': "InReview",
70
- 'RECOMMENDED': "Recommended",
71
- 'APPROVED': "Approved",
72
- 'AUTOAPPROVED': "AutoApproved",
73
- 'REJECTED': "Rejected",
74
- 'AUTOREJECTED': "AutoRejected",
75
- 'UNKOWN': "Unkown",
67
+ ('bid_strategy',): {
68
+ 'UNKNOWN': "Unknown",
69
+ 'CONVERSION': "Conversion",
70
+ 'CLICKS': "Clicks",
71
+ 'REVENUE': "Revenue",
76
72
  },
77
73
  }
78
74
 
79
75
  validations = {
76
+ ('name',): {
77
+ 'max_length': 255,
78
+ 'min_length': 0,
79
+ },
80
80
  }
81
81
 
82
82
  additional_properties_type = None
@@ -95,12 +95,18 @@ class Keywords(ModelNormal):
95
95
  """
96
96
  lazy_import()
97
97
  return {
98
- 'bid': (float, none_type,), # noqa: E501
99
- 'created_at': (datetime,), # noqa: E501
100
- 'input_keywords': (InputKeywords,), # noqa: E501
101
- 'match_type': (str,), # noqa: E501
102
- 'review_state': (str,), # noqa: E501
103
- 'updated_at': (datetime,), # noqa: E501
98
+ 'is_auto_daily_pacing': (bool,), # noqa: E501
99
+ 'name': (str,), # noqa: E501
100
+ 'start_date': (datetime,), # noqa: E501
101
+ 'status': (str,), # noqa: E501
102
+ 'target_bid': (float,), # noqa: E501
103
+ 'bid_strategy': (str,), # noqa: E501
104
+ 'budget': (float, none_type,), # noqa: E501
105
+ 'daily_pacing': (float, none_type,), # noqa: E501
106
+ 'end_date': (datetime, none_type,), # noqa: E501
107
+ 'flight_schedule': (FlightSchedule,), # noqa: E501
108
+ 'max_bid': (float, none_type,), # noqa: E501
109
+ 'monthly_pacing': (float, none_type,), # noqa: E501
104
110
  }
105
111
 
106
112
  @cached_property
@@ -109,12 +115,18 @@ class Keywords(ModelNormal):
109
115
 
110
116
 
111
117
  attribute_map = {
112
- 'bid': 'bid', # noqa: E501
113
- 'created_at': 'createdAt', # noqa: E501
114
- 'input_keywords': 'inputKeywords', # noqa: E501
115
- 'match_type': 'matchType', # noqa: E501
116
- 'review_state': 'reviewState', # noqa: E501
117
- 'updated_at': 'updatedAt', # noqa: E501
118
+ 'is_auto_daily_pacing': 'isAutoDailyPacing', # noqa: E501
119
+ 'name': 'name', # noqa: E501
120
+ 'start_date': 'startDate', # noqa: E501
121
+ 'status': 'status', # noqa: E501
122
+ 'target_bid': 'targetBid', # noqa: E501
123
+ 'bid_strategy': 'bidStrategy', # noqa: E501
124
+ 'budget': 'budget', # noqa: E501
125
+ 'daily_pacing': 'dailyPacing', # noqa: E501
126
+ 'end_date': 'endDate', # noqa: E501
127
+ 'flight_schedule': 'flightSchedule', # noqa: E501
128
+ 'max_bid': 'maxBid', # noqa: E501
129
+ 'monthly_pacing': 'monthlyPacing', # noqa: E501
118
130
  }
119
131
 
120
132
  read_only_vars = {
@@ -124,8 +136,15 @@ class Keywords(ModelNormal):
124
136
 
125
137
  @classmethod
126
138
  @convert_js_args_to_python_args
127
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
128
- """Keywords - a model defined in OpenAPI
139
+ def _from_openapi_data(cls, is_auto_daily_pacing, name, start_date, status, target_bid, *args, **kwargs): # noqa: E501
140
+ """SponsoredProductsLineItemUpdateRequestModel - a model defined in OpenAPI
141
+
142
+ 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):
129
148
 
130
149
  Keyword Args:
131
150
  _check_type (bool): if True, values for parameters in openapi_types
@@ -158,12 +177,13 @@ class Keywords(ModelNormal):
158
177
  Animal class but this time we won't travel
159
178
  through its discriminator because we passed in
160
179
  _visited_composed_classes = (Animal,)
161
- bid (float, none_type): The bid to use when a positive keyword matches the shopper search phrase. [optional] # noqa: E501
162
- created_at (datetime): The time at which this keyword was created in UTC. [optional] # noqa: E501
163
- input_keywords (InputKeywords): [optional] # noqa: E501
164
- match_type (str): The matching algorthim to be use when comparing this keyword with the shopper search phrase. [optional] # noqa: E501
165
- review_state (str): Review status of the keyword. [optional] # noqa: E501
166
- updated_at (datetime): The time at which the keyword was last modified in UTC. [optional] # noqa: E501
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
184
+ flight_schedule (FlightSchedule): [optional] # noqa: E501
185
+ max_bid (float, none_type): [optional] # noqa: E501
186
+ monthly_pacing (float, none_type): [optional] # noqa: E501
167
187
  """
168
188
 
169
189
  _check_type = kwargs.pop('_check_type', True)
@@ -195,6 +215,11 @@ class Keywords(ModelNormal):
195
215
  self._configuration = _configuration
196
216
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
197
217
 
218
+ self.is_auto_daily_pacing = is_auto_daily_pacing
219
+ self.name = name
220
+ self.start_date = start_date
221
+ self.status = status
222
+ self.target_bid = target_bid
198
223
  for var_name, var_value in kwargs.items():
199
224
  if var_name not in self.attribute_map and \
200
225
  self._configuration is not None and \
@@ -215,8 +240,15 @@ class Keywords(ModelNormal):
215
240
  ])
216
241
 
217
242
  @convert_js_args_to_python_args
218
- def __init__(self, *args, **kwargs): # noqa: E501
219
- """Keywords - a model defined in OpenAPI
243
+ def __init__(self, is_auto_daily_pacing, name, start_date, status, target_bid, *args, **kwargs): # noqa: E501
244
+ """SponsoredProductsLineItemUpdateRequestModel - a model defined in OpenAPI
245
+
246
+ 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):
220
252
 
221
253
  Keyword Args:
222
254
  _check_type (bool): if True, values for parameters in openapi_types
@@ -249,12 +281,13 @@ class Keywords(ModelNormal):
249
281
  Animal class but this time we won't travel
250
282
  through its discriminator because we passed in
251
283
  _visited_composed_classes = (Animal,)
252
- bid (float, none_type): The bid to use when a positive keyword matches the shopper search phrase. [optional] # noqa: E501
253
- created_at (datetime): The time at which this keyword was created in UTC. [optional] # noqa: E501
254
- input_keywords (InputKeywords): [optional] # noqa: E501
255
- match_type (str): The matching algorthim to be use when comparing this keyword with the shopper search phrase. [optional] # noqa: E501
256
- review_state (str): Review status of the keyword. [optional] # noqa: E501
257
- updated_at (datetime): The time at which the keyword was last modified in UTC. [optional] # noqa: E501
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
288
+ flight_schedule (FlightSchedule): [optional] # noqa: E501
289
+ max_bid (float, none_type): [optional] # noqa: E501
290
+ monthly_pacing (float, none_type): [optional] # noqa: E501
258
291
  """
259
292
 
260
293
  _check_type = kwargs.pop('_check_type', True)
@@ -284,6 +317,11 @@ class Keywords(ModelNormal):
284
317
  self._configuration = _configuration
285
318
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
286
319
 
320
+ self.is_auto_daily_pacing = is_auto_daily_pacing
321
+ self.name = name
322
+ self.start_date = start_date
323
+ self.status = status
324
+ self.target_bid = target_bid
287
325
  for var_name, var_value in kwargs.items():
288
326
  if var_name not in self.attribute_map and \
289
327
  self._configuration is not None and \
@@ -103,9 +103,9 @@ class SyncAttributedTransactionsReport(ModelNormal):
103
103
  'ATTRIBUTEDSALES': "attributedSales",
104
104
  },
105
105
  ('sales_channel',): {
106
- 'ALL': "all",
107
- 'OFFLINE': "offline",
108
106
  'ONLINE': "online",
107
+ 'OFFLINE': "offline",
108
+ 'ALL': "all",
109
109
  },
110
110
  ('view_attribution_window',): {
111
111
  'NONE': "none",
@@ -116,9 +116,9 @@ class SyncCampaignsReport(ModelNormal):
116
116
  'SERVEDCATEGORY': "servedCategory",
117
117
  },
118
118
  ('sales_channel',): {
119
- 'ALL': "all",
120
- 'OFFLINE': "offline",
121
119
  'ONLINE': "online",
120
+ 'OFFLINE': "offline",
121
+ 'ALL': "all",
122
122
  },
123
123
  ('view_attribution_window',): {
124
124
  'NONE': "none",
@@ -238,7 +238,7 @@ class SyncCampaignsReport(ModelNormal):
238
238
  click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
239
239
  dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
240
240
  metrics ([str]): List of metrics to report on. [optional] # noqa: E501
241
- report_type (str): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
241
+ report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
242
242
  sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
243
243
  timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
244
244
  view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
@@ -340,7 +340,7 @@ class SyncCampaignsReport(ModelNormal):
340
340
  click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
341
341
  dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
342
342
  metrics ([str]): List of metrics to report on. [optional] # noqa: E501
343
- report_type (str): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
343
+ report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
344
344
  sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
345
345
  timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
346
346
  view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
@@ -116,9 +116,9 @@ class SyncLineItemsReport(ModelNormal):
116
116
  'SERVEDCATEGORY': "servedCategory",
117
117
  },
118
118
  ('sales_channel',): {
119
- 'ALL': "all",
120
- 'OFFLINE': "offline",
121
119
  'ONLINE': "online",
120
+ 'OFFLINE': "offline",
121
+ 'ALL': "all",
122
122
  },
123
123
  ('view_attribution_window',): {
124
124
  'NONE': "none",
@@ -241,7 +241,7 @@ class SyncLineItemsReport(ModelNormal):
241
241
  dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
242
242
  line_item_ids ([str]): Line Item ids to filter. [optional] # noqa: E501
243
243
  metrics ([str]): List of metrics to report on. [optional] # noqa: E501
244
- report_type (str): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
244
+ report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
245
245
  sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
246
246
  timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
247
247
  view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
@@ -344,7 +344,7 @@ class SyncLineItemsReport(ModelNormal):
344
344
  dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
345
345
  line_item_ids ([str]): Line Item ids to filter. [optional] # noqa: E501
346
346
  metrics ([str]): List of metrics to report on. [optional] # noqa: E501
347
- report_type (str): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
347
+ report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
348
348
  sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
349
349
  timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
350
350
  view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
@@ -64,7 +64,14 @@ class ValueResourceBrandIdSearchRequest(ModelNormal):
64
64
  validations = {
65
65
  }
66
66
 
67
- additional_properties_type = None
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
68
75
 
69
76
  _nullable = False
70
77
 
@@ -0,0 +1,273 @@
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.categories_search_request_v1 import CategoriesSearchRequestV1
34
+ globals()['CategoriesSearchRequestV1'] = CategoriesSearchRequestV1
35
+
36
+
37
+ class ValueResourceCategoriesSearchRequestV1(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': (CategoriesSearchRequestV1,), # noqa: E501
91
+ 'type': (str, none_type,), # noqa: E501
92
+ }
93
+
94
+ @cached_property
95
+ def discriminator():
96
+ return None
97
+
98
+
99
+ attribute_map = {
100
+ 'attributes': 'attributes', # noqa: E501
101
+ 'type': 'type', # noqa: E501
102
+ }
103
+
104
+ read_only_vars = {
105
+ }
106
+
107
+ _composed_schemas = {}
108
+
109
+ @classmethod
110
+ @convert_js_args_to_python_args
111
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
112
+ """ValueResourceCategoriesSearchRequestV1 - a model defined in OpenAPI
113
+
114
+ Keyword Args:
115
+ _check_type (bool): if True, values for parameters in openapi_types
116
+ will be type checked and a TypeError will be
117
+ raised if the wrong type is input.
118
+ Defaults to True
119
+ _path_to_item (tuple/list): This is a list of keys or values to
120
+ drill down to the model in received_data
121
+ when deserializing a response
122
+ _spec_property_naming (bool): True if the variable names in the input data
123
+ are serialized names, as specified in the OpenAPI document.
124
+ False if the variable names in the input data
125
+ are pythonic names, e.g. snake case (default)
126
+ _configuration (Configuration): the instance to use when
127
+ deserializing a file_type parameter.
128
+ If passed, type conversion is attempted
129
+ If omitted no type conversion is done.
130
+ _visited_composed_classes (tuple): This stores a tuple of
131
+ classes that we have traveled through so that
132
+ if we see that class again we will not use its
133
+ discriminator again.
134
+ When traveling through a discriminator, the
135
+ composed schema that is
136
+ is traveled through is added to this set.
137
+ For example if Animal has a discriminator
138
+ petType and we pass in "Dog", and the class Dog
139
+ allOf includes Animal, we move through Animal
140
+ once using the discriminator, and pick Dog.
141
+ Then in Dog, we will make an instance of the
142
+ Animal class but this time we won't travel
143
+ through its discriminator because we passed in
144
+ _visited_composed_classes = (Animal,)
145
+ attributes (CategoriesSearchRequestV1): [optional] # noqa: E501
146
+ type (str, none_type): Type of the resource.. [optional] # noqa: E501
147
+ """
148
+
149
+ _check_type = kwargs.pop('_check_type', True)
150
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
151
+ _path_to_item = kwargs.pop('_path_to_item', ())
152
+ _configuration = kwargs.pop('_configuration', None)
153
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
154
+
155
+ self = super(OpenApiModel, cls).__new__(cls)
156
+
157
+ if args:
158
+ for arg in args:
159
+ if isinstance(arg, dict):
160
+ kwargs.update(arg)
161
+ else:
162
+ raise ApiTypeError(
163
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
164
+ args,
165
+ self.__class__.__name__,
166
+ ),
167
+ path_to_item=_path_to_item,
168
+ valid_classes=(self.__class__,),
169
+ )
170
+
171
+ self._data_store = {}
172
+ self._check_type = _check_type
173
+ self._spec_property_naming = _spec_property_naming
174
+ self._path_to_item = _path_to_item
175
+ self._configuration = _configuration
176
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
177
+
178
+ for var_name, var_value in kwargs.items():
179
+ if var_name not in self.attribute_map and \
180
+ self._configuration is not None and \
181
+ self._configuration.discard_unknown_keys and \
182
+ self.additional_properties_type is None:
183
+ # discard variable.
184
+ continue
185
+ setattr(self, var_name, var_value)
186
+ return self
187
+
188
+ required_properties = set([
189
+ '_data_store',
190
+ '_check_type',
191
+ '_spec_property_naming',
192
+ '_path_to_item',
193
+ '_configuration',
194
+ '_visited_composed_classes',
195
+ ])
196
+
197
+ @convert_js_args_to_python_args
198
+ def __init__(self, *args, **kwargs): # noqa: E501
199
+ """ValueResourceCategoriesSearchRequestV1 - a model defined in OpenAPI
200
+
201
+ Keyword Args:
202
+ _check_type (bool): if True, values for parameters in openapi_types
203
+ will be type checked and a TypeError will be
204
+ raised if the wrong type is input.
205
+ Defaults to True
206
+ _path_to_item (tuple/list): This is a list of keys or values to
207
+ drill down to the model in received_data
208
+ when deserializing a response
209
+ _spec_property_naming (bool): True if the variable names in the input data
210
+ are serialized names, as specified in the OpenAPI document.
211
+ False if the variable names in the input data
212
+ are pythonic names, e.g. snake case (default)
213
+ _configuration (Configuration): the instance to use when
214
+ deserializing a file_type parameter.
215
+ If passed, type conversion is attempted
216
+ If omitted no type conversion is done.
217
+ _visited_composed_classes (tuple): This stores a tuple of
218
+ classes that we have traveled through so that
219
+ if we see that class again we will not use its
220
+ discriminator again.
221
+ When traveling through a discriminator, the
222
+ composed schema that is
223
+ is traveled through is added to this set.
224
+ For example if Animal has a discriminator
225
+ petType and we pass in "Dog", and the class Dog
226
+ allOf includes Animal, we move through Animal
227
+ once using the discriminator, and pick Dog.
228
+ Then in Dog, we will make an instance of the
229
+ Animal class but this time we won't travel
230
+ through its discriminator because we passed in
231
+ _visited_composed_classes = (Animal,)
232
+ attributes (CategoriesSearchRequestV1): [optional] # noqa: E501
233
+ type (str, none_type): Type of the resource.. [optional] # noqa: E501
234
+ """
235
+
236
+ _check_type = kwargs.pop('_check_type', True)
237
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
238
+ _path_to_item = kwargs.pop('_path_to_item', ())
239
+ _configuration = kwargs.pop('_configuration', None)
240
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
241
+
242
+ if args:
243
+ for arg in args:
244
+ if isinstance(arg, dict):
245
+ kwargs.update(arg)
246
+ else:
247
+ raise ApiTypeError(
248
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
249
+ args,
250
+ self.__class__.__name__,
251
+ ),
252
+ path_to_item=_path_to_item,
253
+ valid_classes=(self.__class__,),
254
+ )
255
+
256
+ self._data_store = {}
257
+ self._check_type = _check_type
258
+ self._spec_property_naming = _spec_property_naming
259
+ self._path_to_item = _path_to_item
260
+ self._configuration = _configuration
261
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
262
+
263
+ for var_name, var_value in kwargs.items():
264
+ if var_name not in self.attribute_map and \
265
+ self._configuration is not None and \
266
+ self._configuration.discard_unknown_keys and \
267
+ self.additional_properties_type is None:
268
+ # discard variable.
269
+ continue
270
+ setattr(self, var_name, var_value)
271
+ if var_name in self.read_only_vars:
272
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
273
+ 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.metadata import Metadata
33
34
  from criteo_api_retailmedia_preview.model.sdk_api_rest_common_problem import SdkApiRestCommonProblem
34
35
  from criteo_api_retailmedia_preview.model.value_resource_private_market_account_fees import ValueResourcePrivateMarketAccountFees
36
+ globals()['Metadata'] = Metadata
35
37
  globals()['SdkApiRestCommonProblem'] = SdkApiRestCommonProblem
36
38
  globals()['ValueResourcePrivateMarketAccountFees'] = ValueResourcePrivateMarketAccountFees
37
39
 
38
40
 
39
- class ValueResourceCollectionOutcomePrivateMarketAccountFees(ModelNormal):
41
+ class ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata(ModelNormal):
40
42
  """NOTE: This class is auto generated by OpenAPI Generator.
41
43
  Ref: https://openapi-generator.tech
42
44
 
@@ -84,6 +86,7 @@ class ValueResourceCollectionOutcomePrivateMarketAccountFees(ModelNormal):
84
86
  return {
85
87
  'data': ([ValueResourcePrivateMarketAccountFees], 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 ValueResourceCollectionOutcomePrivateMarketAccountFees(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 ValueResourceCollectionOutcomePrivateMarketAccountFees(ModelNormal):
108
112
  @classmethod
109
113
  @convert_js_args_to_python_args
110
114
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
111
- """ValueResourceCollectionOutcomePrivateMarketAccountFees - a model defined in OpenAPI
115
+ """ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata - a model defined in OpenAPI
112
116
 
113
117
  Keyword Args:
114
118
  _check_type (bool): if True, values for parameters in openapi_types
@@ -143,6 +147,7 @@ class ValueResourceCollectionOutcomePrivateMarketAccountFees(ModelNormal):
143
147
  _visited_composed_classes = (Animal,)
144
148
  data ([ValueResourcePrivateMarketAccountFees], 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 ValueResourceCollectionOutcomePrivateMarketAccountFees(ModelNormal):
196
201
 
197
202
  @convert_js_args_to_python_args
198
203
  def __init__(self, *args, **kwargs): # noqa: E501
199
- """ValueResourceCollectionOutcomePrivateMarketAccountFees - a model defined in OpenAPI
204
+ """ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata - a model defined in OpenAPI
200
205
 
201
206
  Keyword Args:
202
207
  _check_type (bool): if True, values for parameters in openapi_types
@@ -231,6 +236,7 @@ class ValueResourceCollectionOutcomePrivateMarketAccountFees(ModelNormal):
231
236
  _visited_composed_classes = (Animal,)
232
237
  data ([ValueResourcePrivateMarketAccountFees], 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
 
@@ -64,7 +64,14 @@ class ValueResourceInputBrandIdSearchRequest(ModelNormal):
64
64
  validations = {
65
65
  }
66
66
 
67
- additional_properties_type = None
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
68
75
 
69
76
  _nullable = False
70
77