criteo-api-retailmedia-sdk 0.0.250218__py3-none-any.whl → 0.0.250320__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of criteo-api-retailmedia-sdk might be problematic. Click here for more details.
- criteo_api_retailmedia_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/accounts_api.py +3 -3
- criteo_api_retailmedia_preview/api/billing_api.py +445 -0
- criteo_api_retailmedia_preview/api/campaign_api.py +300 -17
- criteo_api_retailmedia_preview/api_client.py +1 -1
- criteo_api_retailmedia_preview/apis/__init__.py +1 -0
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/add_remove_keyword_model.py +3 -3
- criteo_api_retailmedia_preview/model/application_summary_model.py +1 -1
- criteo_api_retailmedia_preview/model/application_summary_model_resource.py +1 -1
- criteo_api_retailmedia_preview/model/async_accounts_report.py +36 -47
- criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +39 -49
- criteo_api_retailmedia_preview/model/async_campaigns_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/async_fill_rate_report.py +21 -14
- criteo_api_retailmedia_preview/model/async_fill_rate_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/async_line_items_report.py +39 -49
- criteo_api_retailmedia_preview/model/async_line_items_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/balance_response_v2.py +1 -1
- criteo_api_retailmedia_preview/model/bot_message.py +1 -1
- criteo_api_retailmedia_preview/model/brand_catalog_request_v2.py +284 -0
- criteo_api_retailmedia_preview/model/brand_id_search_request.py +3 -4
- criteo_api_retailmedia_preview/model/brand_id_search_result.py +1 -1
- criteo_api_retailmedia_preview/model/{external_catalog_status.py → catalog_status_v2.py} +15 -29
- criteo_api_retailmedia_preview/model/{entity_resource_collection_outcome_of_retail_media_child_account.py → catalog_status_v2_response.py} +8 -14
- criteo_api_retailmedia_preview/model/choice_variable_value.py +1 -1
- criteo_api_retailmedia_preview/model/cpc_min_bids_response.py +1 -1
- criteo_api_retailmedia_preview/model/create_balance_v2.py +3 -3
- criteo_api_retailmedia_preview/model/creative2.py +5 -1
- criteo_api_retailmedia_preview/model/creative_update_model2.py +3 -3
- criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_of_retail_media_child_account_and_metadata.py +280 -0
- criteo_api_retailmedia_preview/model/entity_resource_of_retail_media_child_account.py +6 -13
- criteo_api_retailmedia_preview/model/{json_api_single_response_of_catalog_status.py → entity_resource_outcome_partner_billing_report_status_v1.py} +22 -35
- criteo_api_retailmedia_preview/model/entity_resource_partner_billing_report_status_v1.py +270 -0
- criteo_api_retailmedia_preview/model/export_report_meta_data.py +1 -1
- criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +4 -0
- criteo_api_retailmedia_preview/model/external_line_item_page_v2.py +3 -3
- criteo_api_retailmedia_preview/model/external_preferred_line_item_v2.py +4 -0
- criteo_api_retailmedia_preview/model/external_retail_media_child_account.py +25 -37
- criteo_api_retailmedia_preview/model/files_variable_value.py +1 -1
- criteo_api_retailmedia_preview/model/grant_consent_model.py +3 -3
- criteo_api_retailmedia_preview/model/grant_consent_model_value_resource.py +3 -3
- criteo_api_retailmedia_preview/model/inbot_discussion.py +3 -3
- criteo_api_retailmedia_preview/model/inbot_discussion_data_instance_model.py +3 -3
- criteo_api_retailmedia_preview/model/installment.py +3 -3
- 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 +2 -8
- criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py → json_api_body_without_id_of_brand_catalog_request_v2_and_brand_catalog_request_v2.py} +10 -16
- criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_seller_catalog_request_and_seller_catalog_request.py → json_api_body_without_id_of_seller_catalog_request_v2_and_seller_catalog_request_v2.py} +8 -8
- criteo_api_retailmedia_preview/model/{json_api_request_of_seller_catalog_request.py → json_api_request_of_brand_catalog_request_v2.py} +8 -8
- criteo_api_retailmedia_preview/model/{seller_catalog_request.py → json_api_request_of_seller_catalog_request_v2.py} +9 -9
- criteo_api_retailmedia_preview/model/keyword_data_model.py +6 -6
- criteo_api_retailmedia_preview/model/keywords.py +12 -14
- criteo_api_retailmedia_preview/model/keywords_model.py +1 -1
- criteo_api_retailmedia_preview/model/keywords_model_resource.py +1 -1
- criteo_api_retailmedia_preview/model/line_item_product_status.py +2 -1
- criteo_api_retailmedia_preview/model/loyalty_points.py +9 -9
- criteo_api_retailmedia_preview/model/message_data_instance_model.py +1 -1
- criteo_api_retailmedia_preview/model/metadata.py +1 -1
- criteo_api_retailmedia_preview/model/nillable_string.py +1 -1
- criteo_api_retailmedia_preview/model/page_metadata.py +6 -6
- criteo_api_retailmedia_preview/model/paging_offset_limit_metadata.py +1 -1
- criteo_api_retailmedia_preview/model/partner_billing_report_request_v1.py +293 -0
- criteo_api_retailmedia_preview/model/partner_billing_report_status_v1.py +279 -0
- criteo_api_retailmedia_preview/model/price.py +6 -6
- criteo_api_retailmedia_preview/model/product.py +198 -198
- criteo_api_retailmedia_preview/model/product_metadata.py +1 -1
- criteo_api_retailmedia_preview/model/product_shipping.py +18 -18
- criteo_api_retailmedia_preview/model/product_shipping_dimension.py +6 -6
- criteo_api_retailmedia_preview/model/product_shipping_weight.py +6 -6
- criteo_api_retailmedia_preview/model/product_tax.py +18 -18
- criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py +6 -6
- criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py +6 -6
- criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py +12 -12
- criteo_api_retailmedia_preview/model/promoted_product.py +1 -1
- criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.py +3 -3
- criteo_api_retailmedia_preview/model/recommended_keywords_result.py +1 -1
- criteo_api_retailmedia_preview/model/report_data_response_resource.py +1 -1
- criteo_api_retailmedia_preview/model/resource_of_balance_response_v2.py +1 -1
- criteo_api_retailmedia_preview/model/resource_of_catalog_status_v2.py +277 -0
- criteo_api_retailmedia_preview/model/resource_of_change_dates_of_balance_v2.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_create_balance_v2.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_update_model_v2.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_product_button_request.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_sku_search_request_preview.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_sku_search_request_slim_preview.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_sku_search_request_slim_v2_preview.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_update_balance_model_v2.py +6 -6
- criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py +3 -3
- criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_attributes.py +3 -4
- criteo_api_retailmedia_preview/model/rm_algebra_node_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_entity_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1.py +9 -9
- criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_search_metadata_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_create_input_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_delete_input_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_update_input_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_delete_entity_v1_resource.py +6 -6
- criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_segment_id_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +9 -10
- criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_search_metadata_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1_resource.py +6 -6
- criteo_api_retailmedia_preview/model/rm_contact_list_create_v1.py +3 -4
- criteo_api_retailmedia_preview/model/rm_contact_list_statistics_entity_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_contact_list_statistics_entity_v1_resource.py +1 -1
- criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_events_v1.py +1 -1
- criteo_api_retailmedia_preview/model/seller_catalog_request_v2.py +286 -0
- criteo_api_retailmedia_preview/model/{seller_identifier.py → seller_identifier_v2.py} +3 -3
- criteo_api_retailmedia_preview/model/seller_search.py +3 -3
- criteo_api_retailmedia_preview/model/seller_search_result.py +1 -1
- criteo_api_retailmedia_preview/model/status_response.py +1 -1
- criteo_api_retailmedia_preview/model/status_response_resource.py +1 -1
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +27 -33
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/sync_campaigns_report.py +27 -34
- criteo_api_retailmedia_preview/model/sync_campaigns_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/sync_line_items_report.py +30 -37
- criteo_api_retailmedia_preview/model/sync_line_items_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/value_resource_cpc_min_bids_response.py +1 -1
- criteo_api_retailmedia_preview/model/{offset_page_metadata.py → value_resource_input_partner_billing_report_request_v1.py} +15 -32
- criteo_api_retailmedia_preview/model/value_resource_of_recommended_keywords_result.py +1 -1
- criteo_api_retailmedia_preview/model/value_resource_partner_billing_report_request_v1.py +266 -0
- criteo_api_retailmedia_preview/model/video_variable_value.py +1 -1
- criteo_api_retailmedia_preview/models/__init__.py +17 -9
- {criteo_api_retailmedia_sdk-0.0.250218.dist-info → criteo_api_retailmedia_sdk-0.0.250320.dist-info}/METADATA +4 -4
- {criteo_api_retailmedia_sdk-0.0.250218.dist-info → criteo_api_retailmedia_sdk-0.0.250320.dist-info}/RECORD +134 -125
- {criteo_api_retailmedia_sdk-0.0.250218.dist-info → criteo_api_retailmedia_sdk-0.0.250320.dist-info}/WHEEL +1 -1
- {criteo_api_retailmedia_sdk-0.0.250218.dist-info → criteo_api_retailmedia_sdk-0.0.250320.dist-info}/top_level.txt +0 -0
|
@@ -56,38 +56,32 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
58
|
('search_term_types',): {
|
|
59
|
-
'None': None,
|
|
60
59
|
'UNKNOWN': "unknown",
|
|
61
60
|
'SEARCHED': "searched",
|
|
62
61
|
'ENTERED': "entered",
|
|
63
62
|
},
|
|
64
63
|
('search_term_targetings',): {
|
|
65
|
-
'None': None,
|
|
66
64
|
'UNKNOWN': "unknown",
|
|
67
65
|
'AUTOMATIC': "automatic",
|
|
68
66
|
'MANUAL': "manual",
|
|
69
67
|
},
|
|
70
68
|
('campaign_type',): {
|
|
71
|
-
'None': None,
|
|
72
69
|
'ALL': "all",
|
|
73
70
|
'SPONSOREDPRODUCTS': "sponsoredProducts",
|
|
74
71
|
'ONSITEDISPLAYS': "onSiteDisplays",
|
|
75
72
|
},
|
|
76
73
|
('sales_channel',): {
|
|
77
|
-
'None': None,
|
|
78
74
|
'ALL': "all",
|
|
79
75
|
'OFFLINE': "offline",
|
|
80
76
|
'ONLINE': "online",
|
|
81
77
|
},
|
|
82
78
|
('format',): {
|
|
83
|
-
'None': None,
|
|
84
79
|
'JSON': "json",
|
|
85
80
|
'JSON-COMPACT': "json-compact",
|
|
86
81
|
'JSON-NEWLINE': "json-newline",
|
|
87
82
|
'CSV': "csv",
|
|
88
83
|
},
|
|
89
84
|
('report_type',): {
|
|
90
|
-
'None': None,
|
|
91
85
|
'SUMMARY': "summary",
|
|
92
86
|
'PAGETYPE': "pageType",
|
|
93
87
|
'KEYWORD': "keyword",
|
|
@@ -99,14 +93,12 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
99
93
|
'CAPOUT': "capout",
|
|
100
94
|
},
|
|
101
95
|
('click_attribution_window',): {
|
|
102
|
-
'None': None,
|
|
103
96
|
'NONE': "none",
|
|
104
97
|
'7D': "7D",
|
|
105
98
|
'14D': "14D",
|
|
106
99
|
'30D': "30D",
|
|
107
100
|
},
|
|
108
101
|
('view_attribution_window',): {
|
|
109
|
-
'None': None,
|
|
110
102
|
'NONE': "none",
|
|
111
103
|
'1D': "1D",
|
|
112
104
|
'7D': "7D",
|
|
@@ -114,7 +106,6 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
114
106
|
'30D': "30D",
|
|
115
107
|
},
|
|
116
108
|
('dimensions',): {
|
|
117
|
-
'None': None,
|
|
118
109
|
'DATE': "date",
|
|
119
110
|
'HOUR': "hour",
|
|
120
111
|
'ACCOUNTID': "accountId",
|
|
@@ -149,7 +140,6 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
149
140
|
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
150
141
|
},
|
|
151
142
|
('metrics',): {
|
|
152
|
-
'None': None,
|
|
153
143
|
'IMPRESSIONS': "impressions",
|
|
154
144
|
'CLICKS': "clicks",
|
|
155
145
|
'SPEND': "spend",
|
|
@@ -216,19 +206,19 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
216
206
|
return {
|
|
217
207
|
'start_date': (datetime,), # noqa: E501
|
|
218
208
|
'end_date': (datetime,), # noqa: E501
|
|
219
|
-
'ids': ([str],
|
|
220
|
-
'id': (str,
|
|
221
|
-
'search_term_types': ([str],
|
|
222
|
-
'search_term_targetings': ([str],
|
|
223
|
-
'campaign_type': (str,
|
|
224
|
-
'sales_channel': (str,
|
|
225
|
-
'format': (str,
|
|
226
|
-
'report_type': (str,
|
|
227
|
-
'click_attribution_window': (str,
|
|
228
|
-
'view_attribution_window': (str,
|
|
229
|
-
'dimensions': ([str],
|
|
230
|
-
'metrics': ([str],
|
|
231
|
-
'timezone': (str,
|
|
209
|
+
'ids': ([str],), # noqa: E501
|
|
210
|
+
'id': (str,), # noqa: E501
|
|
211
|
+
'search_term_types': ([str],), # noqa: E501
|
|
212
|
+
'search_term_targetings': ([str],), # noqa: E501
|
|
213
|
+
'campaign_type': (str,), # noqa: E501
|
|
214
|
+
'sales_channel': (str,), # noqa: E501
|
|
215
|
+
'format': (str,), # noqa: E501
|
|
216
|
+
'report_type': (str,), # noqa: E501
|
|
217
|
+
'click_attribution_window': (str,), # noqa: E501
|
|
218
|
+
'view_attribution_window': (str,), # noqa: E501
|
|
219
|
+
'dimensions': ([str],), # noqa: E501
|
|
220
|
+
'metrics': ([str],), # noqa: E501
|
|
221
|
+
'timezone': (str,), # noqa: E501
|
|
232
222
|
}
|
|
233
223
|
|
|
234
224
|
@cached_property
|
|
@@ -299,19 +289,19 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
299
289
|
Animal class but this time we won't travel
|
|
300
290
|
through its discriminator because we passed in
|
|
301
291
|
_visited_composed_classes = (Animal,)
|
|
302
|
-
ids ([str]
|
|
303
|
-
id (str
|
|
304
|
-
search_term_types ([str]
|
|
305
|
-
search_term_targetings ([str]
|
|
306
|
-
campaign_type (str
|
|
307
|
-
sales_channel (str
|
|
308
|
-
format (str
|
|
309
|
-
report_type (str
|
|
310
|
-
click_attribution_window (str
|
|
311
|
-
view_attribution_window (str
|
|
312
|
-
dimensions ([str]
|
|
313
|
-
metrics ([str]
|
|
314
|
-
timezone (str
|
|
292
|
+
ids ([str]): Line Item ids to report on. [optional] # noqa: E501
|
|
293
|
+
id (str): Line Item id to report on. [optional] # noqa: E501
|
|
294
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
295
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
296
|
+
campaign_type (str): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
297
|
+
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
|
|
298
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
299
|
+
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
|
|
300
|
+
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
301
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
302
|
+
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
303
|
+
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
304
|
+
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
|
|
315
305
|
"""
|
|
316
306
|
|
|
317
307
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -403,19 +393,19 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
403
393
|
Animal class but this time we won't travel
|
|
404
394
|
through its discriminator because we passed in
|
|
405
395
|
_visited_composed_classes = (Animal,)
|
|
406
|
-
ids ([str]
|
|
407
|
-
id (str
|
|
408
|
-
search_term_types ([str]
|
|
409
|
-
search_term_targetings ([str]
|
|
410
|
-
campaign_type (str
|
|
411
|
-
sales_channel (str
|
|
412
|
-
format (str
|
|
413
|
-
report_type (str
|
|
414
|
-
click_attribution_window (str
|
|
415
|
-
view_attribution_window (str
|
|
416
|
-
dimensions ([str]
|
|
417
|
-
metrics ([str]
|
|
418
|
-
timezone (str
|
|
396
|
+
ids ([str]): Line Item ids to report on. [optional] # noqa: E501
|
|
397
|
+
id (str): Line Item id to report on. [optional] # noqa: E501
|
|
398
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
399
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
400
|
+
campaign_type (str): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
401
|
+
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
|
|
402
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
403
|
+
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
|
|
404
|
+
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
405
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
406
|
+
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
407
|
+
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
408
|
+
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
|
|
419
409
|
"""
|
|
420
410
|
|
|
421
411
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -87,7 +87,7 @@ class AsyncLineItemsReportResource(ModelNormal):
|
|
|
87
87
|
"""
|
|
88
88
|
lazy_import()
|
|
89
89
|
return {
|
|
90
|
-
'type': (str,
|
|
90
|
+
'type': (str,), # noqa: E501
|
|
91
91
|
'attributes': (AsyncLineItemsReport,), # noqa: E501
|
|
92
92
|
}
|
|
93
93
|
|
|
@@ -142,7 +142,7 @@ class AsyncLineItemsReportResource(ModelNormal):
|
|
|
142
142
|
Animal class but this time we won't travel
|
|
143
143
|
through its discriminator because we passed in
|
|
144
144
|
_visited_composed_classes = (Animal,)
|
|
145
|
-
type (str
|
|
145
|
+
type (str): [optional] # noqa: E501
|
|
146
146
|
attributes (AsyncLineItemsReport): [optional] # noqa: E501
|
|
147
147
|
"""
|
|
148
148
|
|
|
@@ -229,7 +229,7 @@ class AsyncLineItemsReportResource(ModelNormal):
|
|
|
229
229
|
Animal class but this time we won't travel
|
|
230
230
|
through its discriminator because we passed in
|
|
231
231
|
_visited_composed_classes = (Animal,)
|
|
232
|
-
type (str
|
|
232
|
+
type (str): [optional] # noqa: E501
|
|
233
233
|
attributes (AsyncLineItemsReport): [optional] # noqa: E501
|
|
234
234
|
"""
|
|
235
235
|
|
|
@@ -0,0 +1,284 @@
|
|
|
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 BrandCatalogRequestV2(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
|
+
('include_fields',): {
|
|
59
|
+
'UNKNOWN': "Unknown",
|
|
60
|
+
'DESCRIPTION': "Description",
|
|
61
|
+
'IMAGEURL': "ImageUrl",
|
|
62
|
+
'GLOBALCATEGORYID': "GlobalCategoryId",
|
|
63
|
+
'RETAILERNAME': "RetailerName",
|
|
64
|
+
'CATEGORY': "Category",
|
|
65
|
+
'BRANDNAME': "BrandName",
|
|
66
|
+
},
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
validations = {
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
@cached_property
|
|
73
|
+
def additional_properties_type():
|
|
74
|
+
"""
|
|
75
|
+
This must be a method because a model may have properties that are
|
|
76
|
+
of type self, this must run after the class is loaded
|
|
77
|
+
"""
|
|
78
|
+
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
79
|
+
|
|
80
|
+
_nullable = True
|
|
81
|
+
|
|
82
|
+
@cached_property
|
|
83
|
+
def openapi_types():
|
|
84
|
+
"""
|
|
85
|
+
This must be a method because a model may have properties that are
|
|
86
|
+
of type self, this must run after the class is loaded
|
|
87
|
+
|
|
88
|
+
Returns
|
|
89
|
+
openapi_types (dict): The key is attribute name
|
|
90
|
+
and the value is attribute type.
|
|
91
|
+
"""
|
|
92
|
+
return {
|
|
93
|
+
'brand_id_filter': ([str],), # noqa: E501
|
|
94
|
+
'retailer_id_filter': ([int],), # noqa: E501
|
|
95
|
+
'modified_after': (datetime,), # noqa: E501
|
|
96
|
+
'include_fields': ([str],), # noqa: E501
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
@cached_property
|
|
100
|
+
def discriminator():
|
|
101
|
+
return None
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
attribute_map = {
|
|
105
|
+
'brand_id_filter': 'brandIdFilter', # noqa: E501
|
|
106
|
+
'retailer_id_filter': 'retailerIdFilter', # noqa: E501
|
|
107
|
+
'modified_after': 'modifiedAfter', # noqa: E501
|
|
108
|
+
'include_fields': 'includeFields', # noqa: E501
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
read_only_vars = {
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
_composed_schemas = {}
|
|
115
|
+
|
|
116
|
+
@classmethod
|
|
117
|
+
@convert_js_args_to_python_args
|
|
118
|
+
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
119
|
+
"""BrandCatalogRequestV2 - a model defined in OpenAPI
|
|
120
|
+
|
|
121
|
+
Keyword Args:
|
|
122
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
123
|
+
will be type checked and a TypeError will be
|
|
124
|
+
raised if the wrong type is input.
|
|
125
|
+
Defaults to True
|
|
126
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
127
|
+
drill down to the model in received_data
|
|
128
|
+
when deserializing a response
|
|
129
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
130
|
+
are serialized names, as specified in the OpenAPI document.
|
|
131
|
+
False if the variable names in the input data
|
|
132
|
+
are pythonic names, e.g. snake case (default)
|
|
133
|
+
_configuration (Configuration): the instance to use when
|
|
134
|
+
deserializing a file_type parameter.
|
|
135
|
+
If passed, type conversion is attempted
|
|
136
|
+
If omitted no type conversion is done.
|
|
137
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
138
|
+
classes that we have traveled through so that
|
|
139
|
+
if we see that class again we will not use its
|
|
140
|
+
discriminator again.
|
|
141
|
+
When traveling through a discriminator, the
|
|
142
|
+
composed schema that is
|
|
143
|
+
is traveled through is added to this set.
|
|
144
|
+
For example if Animal has a discriminator
|
|
145
|
+
petType and we pass in "Dog", and the class Dog
|
|
146
|
+
allOf includes Animal, we move through Animal
|
|
147
|
+
once using the discriminator, and pick Dog.
|
|
148
|
+
Then in Dog, we will make an instance of the
|
|
149
|
+
Animal class but this time we won't travel
|
|
150
|
+
through its discriminator because we passed in
|
|
151
|
+
_visited_composed_classes = (Animal,)
|
|
152
|
+
brand_id_filter ([str]): The brand ids to filter the catalog by.. [optional] # noqa: E501
|
|
153
|
+
retailer_id_filter ([int]): The retailer ids to filter the catalog by.. [optional] # noqa: E501
|
|
154
|
+
modified_after (datetime): Only products modified after this time will be returned.. [optional] # noqa: E501
|
|
155
|
+
include_fields ([str]): Out of the optional fields, only the ones specified will be included in the catalog generated.. [optional] # noqa: E501
|
|
156
|
+
"""
|
|
157
|
+
|
|
158
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
159
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
160
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
161
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
162
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
163
|
+
|
|
164
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
165
|
+
|
|
166
|
+
if args:
|
|
167
|
+
for arg in args:
|
|
168
|
+
if isinstance(arg, dict):
|
|
169
|
+
kwargs.update(arg)
|
|
170
|
+
else:
|
|
171
|
+
raise ApiTypeError(
|
|
172
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
173
|
+
args,
|
|
174
|
+
self.__class__.__name__,
|
|
175
|
+
),
|
|
176
|
+
path_to_item=_path_to_item,
|
|
177
|
+
valid_classes=(self.__class__,),
|
|
178
|
+
)
|
|
179
|
+
|
|
180
|
+
self._data_store = {}
|
|
181
|
+
self._check_type = _check_type
|
|
182
|
+
self._spec_property_naming = _spec_property_naming
|
|
183
|
+
self._path_to_item = _path_to_item
|
|
184
|
+
self._configuration = _configuration
|
|
185
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
186
|
+
|
|
187
|
+
for var_name, var_value in kwargs.items():
|
|
188
|
+
if var_name not in self.attribute_map and \
|
|
189
|
+
self._configuration is not None and \
|
|
190
|
+
self._configuration.discard_unknown_keys and \
|
|
191
|
+
self.additional_properties_type is None:
|
|
192
|
+
# discard variable.
|
|
193
|
+
continue
|
|
194
|
+
setattr(self, var_name, var_value)
|
|
195
|
+
return self
|
|
196
|
+
|
|
197
|
+
required_properties = set([
|
|
198
|
+
'_data_store',
|
|
199
|
+
'_check_type',
|
|
200
|
+
'_spec_property_naming',
|
|
201
|
+
'_path_to_item',
|
|
202
|
+
'_configuration',
|
|
203
|
+
'_visited_composed_classes',
|
|
204
|
+
])
|
|
205
|
+
|
|
206
|
+
@convert_js_args_to_python_args
|
|
207
|
+
def __init__(self, *args, **kwargs): # noqa: E501
|
|
208
|
+
"""BrandCatalogRequestV2 - a model defined in OpenAPI
|
|
209
|
+
|
|
210
|
+
Keyword Args:
|
|
211
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
212
|
+
will be type checked and a TypeError will be
|
|
213
|
+
raised if the wrong type is input.
|
|
214
|
+
Defaults to True
|
|
215
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
216
|
+
drill down to the model in received_data
|
|
217
|
+
when deserializing a response
|
|
218
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
219
|
+
are serialized names, as specified in the OpenAPI document.
|
|
220
|
+
False if the variable names in the input data
|
|
221
|
+
are pythonic names, e.g. snake case (default)
|
|
222
|
+
_configuration (Configuration): the instance to use when
|
|
223
|
+
deserializing a file_type parameter.
|
|
224
|
+
If passed, type conversion is attempted
|
|
225
|
+
If omitted no type conversion is done.
|
|
226
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
227
|
+
classes that we have traveled through so that
|
|
228
|
+
if we see that class again we will not use its
|
|
229
|
+
discriminator again.
|
|
230
|
+
When traveling through a discriminator, the
|
|
231
|
+
composed schema that is
|
|
232
|
+
is traveled through is added to this set.
|
|
233
|
+
For example if Animal has a discriminator
|
|
234
|
+
petType and we pass in "Dog", and the class Dog
|
|
235
|
+
allOf includes Animal, we move through Animal
|
|
236
|
+
once using the discriminator, and pick Dog.
|
|
237
|
+
Then in Dog, we will make an instance of the
|
|
238
|
+
Animal class but this time we won't travel
|
|
239
|
+
through its discriminator because we passed in
|
|
240
|
+
_visited_composed_classes = (Animal,)
|
|
241
|
+
brand_id_filter ([str]): The brand ids to filter the catalog by.. [optional] # noqa: E501
|
|
242
|
+
retailer_id_filter ([int]): The retailer ids to filter the catalog by.. [optional] # noqa: E501
|
|
243
|
+
modified_after (datetime): Only products modified after this time will be returned.. [optional] # noqa: E501
|
|
244
|
+
include_fields ([str]): Out of the optional fields, only the ones specified will be included in the catalog generated.. [optional] # noqa: E501
|
|
245
|
+
"""
|
|
246
|
+
|
|
247
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
248
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
249
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
250
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
251
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
252
|
+
|
|
253
|
+
if args:
|
|
254
|
+
for arg in args:
|
|
255
|
+
if isinstance(arg, dict):
|
|
256
|
+
kwargs.update(arg)
|
|
257
|
+
else:
|
|
258
|
+
raise ApiTypeError(
|
|
259
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
260
|
+
args,
|
|
261
|
+
self.__class__.__name__,
|
|
262
|
+
),
|
|
263
|
+
path_to_item=_path_to_item,
|
|
264
|
+
valid_classes=(self.__class__,),
|
|
265
|
+
)
|
|
266
|
+
|
|
267
|
+
self._data_store = {}
|
|
268
|
+
self._check_type = _check_type
|
|
269
|
+
self._spec_property_naming = _spec_property_naming
|
|
270
|
+
self._path_to_item = _path_to_item
|
|
271
|
+
self._configuration = _configuration
|
|
272
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
273
|
+
|
|
274
|
+
for var_name, var_value in kwargs.items():
|
|
275
|
+
if var_name not in self.attribute_map and \
|
|
276
|
+
self._configuration is not None and \
|
|
277
|
+
self._configuration.discard_unknown_keys and \
|
|
278
|
+
self.additional_properties_type is None:
|
|
279
|
+
# discard variable.
|
|
280
|
+
continue
|
|
281
|
+
setattr(self, var_name, var_value)
|
|
282
|
+
if var_name in self.read_only_vars:
|
|
283
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
284
|
+
f"class with read only attributes.")
|
|
@@ -56,7 +56,6 @@ class BrandIdSearchRequest(ModelNormal):
|
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
58
|
('brand_type',): {
|
|
59
|
-
'None': None,
|
|
60
59
|
'UC': "uc",
|
|
61
60
|
'RETAILER': "retailer",
|
|
62
61
|
'ALL': "all",
|
|
@@ -86,7 +85,7 @@ class BrandIdSearchRequest(ModelNormal):
|
|
|
86
85
|
return {
|
|
87
86
|
'retailer_ids': ([int],), # noqa: E501
|
|
88
87
|
'name': (str, none_type,), # noqa: E501
|
|
89
|
-
'brand_type': (str,
|
|
88
|
+
'brand_type': (str,), # noqa: E501
|
|
90
89
|
}
|
|
91
90
|
|
|
92
91
|
@cached_property
|
|
@@ -145,7 +144,7 @@ class BrandIdSearchRequest(ModelNormal):
|
|
|
145
144
|
through its discriminator because we passed in
|
|
146
145
|
_visited_composed_classes = (Animal,)
|
|
147
146
|
name (str, none_type): The name of the brand(s) to be searched. [optional] # noqa: E501
|
|
148
|
-
brand_type (str
|
|
147
|
+
brand_type (str): The type of brand, primarily where this brand belongs: UC, Retailer or All (both). [optional] # noqa: E501
|
|
149
148
|
"""
|
|
150
149
|
|
|
151
150
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -236,7 +235,7 @@ class BrandIdSearchRequest(ModelNormal):
|
|
|
236
235
|
through its discriminator because we passed in
|
|
237
236
|
_visited_composed_classes = (Animal,)
|
|
238
237
|
name (str, none_type): The name of the brand(s) to be searched. [optional] # noqa: E501
|
|
239
|
-
brand_type (str
|
|
238
|
+
brand_type (str): The type of brand, primarily where this brand belongs: UC, Retailer or All (both). [optional] # noqa: E501
|
|
240
239
|
"""
|
|
241
240
|
|
|
242
241
|
_check_type = kwargs.pop('_check_type', True)
|