From 665d44905b398a8d5f5c384388c8146387959ef0 Mon Sep 17 00:00:00 2001 From: iamishan9 <{actor}@users.noreply.github.com> Date: Thu, 4 Apr 2024 10:04:51 +0000 Subject: [PATCH] [240404] Automatic update of SDK. --- sdks/marketingsolutions_2023-01/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- sdks/marketingsolutions_2023-01/setup.py | 6 +- sdks/marketingsolutions_2023-04/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- sdks/marketingsolutions_2023-04/setup.py | 6 +- sdks/marketingsolutions_2023-07/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- sdks/marketingsolutions_2023-07/setup.py | 6 +- sdks/marketingsolutions_2023-10/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- sdks/marketingsolutions_2023-10/setup.py | 6 +- sdks/marketingsolutions_2024-01/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- sdks/marketingsolutions_2024-01/setup.py | 6 +- sdks/marketingsolutions_preview/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- .../model/product.py | 28 +- .../products_custom_batch_request_entry.py | 4 +- .../model/read_ad_set_budget_v24_q1.py | 12 +- .../model/recommended_product.py | 8 +- .../docs/CatalogApi.md | 3 + .../docs/Product.md | 13 +- .../docs/ProductsCustomBatchRequestEntry.md | 2 +- .../docs/ReadAdSetBudgetV24Q1.md | 2 +- .../docs/RecommendedProduct.md | 3 +- sdks/marketingsolutions_preview/setup.py | 6 +- sdks/retailmedia_2023-01/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- .../model/async_campaigns_report.py | 110 +- .../model/async_line_items_report.py | 111 +- sdks/retailmedia_2023-01/docs/AnalyticsApi.md | 32 +- .../docs/AsyncCampaignsReport.md | 10 +- .../docs/AsyncLineItemsReport.md | 10 +- sdks/retailmedia_2023-01/setup.py | 6 +- sdks/retailmedia_2023-04/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- .../model/async_campaigns_report.py | 110 +- .../model/async_line_items_report.py | 111 +- sdks/retailmedia_2023-04/docs/AnalyticsApi.md | 32 +- .../docs/AsyncCampaignsReport.md | 10 +- .../docs/AsyncLineItemsReport.md | 10 +- sdks/retailmedia_2023-04/setup.py | 6 +- sdks/retailmedia_2023-07/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- .../model/async_campaigns_report.py | 110 +- .../model/async_line_items_report.py | 111 +- sdks/retailmedia_2023-07/docs/AnalyticsApi.md | 32 +- .../docs/AsyncCampaignsReport.md | 10 +- .../docs/AsyncLineItemsReport.md | 10 +- sdks/retailmedia_2023-07/setup.py | 6 +- sdks/retailmedia_2023-10/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- .../model/async_campaigns_report.py | 110 +- .../model/async_line_items_report.py | 111 +- .../model/async_revenue_report.py | 95 +- sdks/retailmedia_2023-10/docs/AnalyticsApi.md | 48 +- .../docs/AsyncCampaignsReport.md | 10 +- .../docs/AsyncLineItemsReport.md | 10 +- .../docs/AsyncRevenueReport.md | 8 +- sdks/retailmedia_2023-10/setup.py | 6 +- sdks/retailmedia_2024-01/README.md | 6 +- .../__init__.py | 2 +- .../api_client.py | 2 +- .../configuration.py | 2 +- .../model/async_campaigns_report.py | 110 +- .../model/async_line_items_report.py | 111 +- .../model/async_revenue_report.py | 95 +- sdks/retailmedia_2024-01/docs/AnalyticsApi.md | 48 +- .../docs/AsyncCampaignsReport.md | 10 +- .../docs/AsyncLineItemsReport.md | 10 +- .../docs/AsyncRevenueReport.md | 8 +- sdks/retailmedia_2024-01/setup.py | 6 +- .../.openapi-generator/FILES | 160 +- sdks/retailmedia_preview/README.md | 85 +- .../__init__.py | 2 +- .../api/accounts_api.py | 216 ++- .../api/analytics_api.py | 142 ++ .../api/campaign_api.py | 1417 ++++++----------- .../api/catalog_api.py | 312 ++++ .../api_client.py | 8 +- .../apis/__init__.py | 1 + .../configuration.py | 2 +- ...tive202210.py => async_accounts_report.py} | 244 +-- ...ew.py => async_accounts_report_request.py} | 23 +- .../model/async_accounts_report_resource.py | 273 ++++ .../model/async_campaigns_report.py | 110 +- .../model/async_line_items_report.py | 111 +- ...le_value.py => batch_accepted_response.py} | 22 +- ..._outcome_of_int64.py => change_details.py} | 53 +- ..._variable_value.py => custom_attribute.py} | 28 +- .../model/export_report_column.py | 4 +- ...ue.py => external_line_item_capping_v2.py} | 35 +- .../external_line_item_page_category_v2.py | 273 ++++ ...nment.py => external_line_item_page_v2.py} | 69 +- ...al_preferred_line_item_create_model_v2.py} | 110 +- ...al_preferred_line_item_update_model_v2.py} | 117 +- ....py => external_preferred_line_item_v2.py} | 163 +- ...and_catalog_status.py => fail_response.py} | 44 +- .../model/files_variables_specification.py | 290 ---- ...of_preferred_line_item_create_model_v2.py} | 30 +- ...tion_order_history_change_data_capture.py} | 78 +- .../model/installment.py | 273 ++++ ...n_api_single_response_of_catalog_status.py | 287 ---- .../model/loyalty_points.py | 271 ++++ .../model/metadata.py | 273 ++++ ...rtion_order_history_change_data_capture.py | 276 ++++ ...rred_line_item_create_model_v2_request.py} | 16 +- ...erred_line_item_update_model_v2_request.py | 269 ++++ ...erred_line_item_v2_paged_list_response.py} | 38 +- ....py => preferred_line_item_v2_response.py} | 32 +- .../model/price.py | 267 ++++ .../model/product.py | 626 ++++++++ ..._variable.py => product_importer_error.py} | 85 +- .../model/product_importer_warning.py | 299 ++++ ...e_list_response.py => product_shipping.py} | 54 +- .../model/product_shipping_dimension.py | 267 ++++ ...le_value.py => product_shipping_weight.py} | 33 +- .../model/product_tax.py | 283 ++++ ...y => product_unit_pricing_base_measure.py} | 28 +- ...ion.py => product_unit_pricing_measure.py} | 18 +- ...on.py => products_custom_batch_request.py} | 32 +- ...=> products_custom_batch_request_entry.py} | 78 +- ...hoice_option.py => report_detail_error.py} | 64 +- .../model/report_detail_errors.py | 281 ++++ ...ariable_value.py => report_ok_response.py} | 101 +- ...of_preferred_line_item_update_model_v2.py} | 18 +- ... => resource_of_preferred_line_item_v2.py} | 18 +- .../model/retail_media_brands.py | 257 +++ .../sync_attributed_transactions_report.py | 74 +- .../model/sync_campaigns_report.py | 98 +- .../model/sync_line_items_report.py | 103 +- .../model/template_response.py | 281 ---- ...collection_input_of_retail_media_seller.py | 262 +++ ..._of_retail_media_brand_account_creation.py | 262 +++ ...e_resource_input_of_retail_media_brands.py | 262 +++ ...of_retail_media_seller_account_creation.py | 262 +++ ..._of_retail_media_brand_account_creation.py | 266 ++++ ... value_resource_of_retail_media_brands.py} | 17 +- ...of_retail_media_seller_account_creation.py | 266 ++++ .../models/__init__.py | 79 +- sdks/retailmedia_preview/docs/AccountsApi.md | 218 ++- sdks/retailmedia_preview/docs/AnalyticsApi.md | 180 ++- .../docs/AsyncAccountsReport.md | 25 + .../docs/AsyncAccountsReportRequest.md | 13 + .../docs/AsyncAccountsReportResource.md | 14 + .../docs/AsyncCampaignsReport.md | 10 +- .../docs/AsyncLineItemsReport.md | 10 +- ...iableValue.md => BatchAcceptedResponse.md} | 6 +- sdks/retailmedia_preview/docs/CampaignApi.md | 966 ++++------- sdks/retailmedia_preview/docs/CatalogApi.md | 371 +++++ .../retailmedia_preview/docs/ChangeDetails.md | 14 + .../docs/ChoiceVariableSpecification.md | 15 - .../docs/Creative202210.md | 24 - .../docs/CreativeCreateModel202207.md | 17 - .../docs/CreativeUpdateModel202207.md | 17 - .../{ChoiceOption.md => CustomAttribute.md} | 8 +- .../docs/ExportReportColumn.md | 2 +- .../docs/ExternalCatalogStatus.md | 19 - ...eValue.md => ExternalLineItemCappingV2.md} | 7 +- .../docs/ExternalLineItemPageCategoryV2.md | 14 + .../docs/ExternalLineItemPageV2.md | 15 + .../ExternalPreferredLineItemCreateModelV2.md | 22 + .../ExternalPreferredLineItemUpdateModelV2.md | 21 + .../docs/ExternalPreferredLineItemV2.md | 27 + sdks/retailmedia_preview/docs/FailResponse.md | 14 + .../docs/FilesVariablesSpecification.md | 16 - ...esourceOfPreferredLineItemCreateModelV2.md | 14 + .../InsertionOrderHistoryChangeDataCapture.md | 16 + sdks/retailmedia_preview/docs/Installment.md | 14 + ...OfInt64AndCatalogStatusAndCatalogStatus.md | 15 - ...fCatalogRequestAndCatalogRequestPreview.md | 14 - .../JsonApiRequestOfCatalogRequestPreview.md | 13 - .../JsonApiSingleResponseOfCatalogStatus.md | 15 - .../retailmedia_preview/docs/LoyaltyPoints.md | 15 + sdks/retailmedia_preview/docs/Metadata.md | 14 + ...fInsertionOrderHistoryChangeDataCapture.md | 13 + .../docs/PageTypeEnvironment.md | 14 - .../PreferredLineItemCreateModelV2Request.md | 13 + ... PreferredLineItemUpdateModelV2Request.md} | 6 +- ...> PreferredLineItemV2PagedListResponse.md} | 11 +- ...onse.md => PreferredLineItemV2Response.md} | 10 +- ...ernalCatalogRequestPreview.md => Price.md} | 7 +- sdks/retailmedia_preview/docs/Product.md | 93 ++ .../docs/ProductImporterError.md | 18 + .../docs/ProductImporterWarning.md | 18 + .../docs/ProductShipping.md | 19 + .../docs/ProductShippingDimension.md | 14 + .../docs/ProductShippingWeight.md | 14 + sdks/retailmedia_preview/docs/ProductTax.md | 18 + .../docs/ProductUnitPricingBaseMeasure.md | 14 + ...eValue.md => ProductUnitPricingMeasure.md} | 7 +- .../docs/ProductsCustomBatchRequest.md | 13 + .../docs/ProductsCustomBatchRequestEntry.md | 19 + ...tVariableValue.md => ReportDetailError.md} | 8 +- .../{Section.md => ReportDetailErrors.md} | 8 +- .../docs/ReportOkResponse.md | 19 + ...sourceOfPreferredLineItemUpdateModelV2.md} | 4 +- ...10.md => ResourceOfPreferredLineItemV2.md} | 4 +- .../docs/RetailMediaBrands.md | 12 + .../docs/SyncAttributedTransactionsReport.md | 10 +- .../docs/SyncCampaignsReport.md | 8 +- .../docs/SyncLineItemsReport.md | 8 +- sdks/retailmedia_preview/docs/Template.md | 24 - .../docs/TemplateListResponse.md | 15 - .../docs/TemplateResponse.md | 15 - .../docs/TemplateVariable.md | 18 - .../docs/TemplateVariableValue.md | 18 - .../docs/TextVariableSpecification.md | 13 - ...ourceCollectionInputOfRetailMediaSeller.md | 12 + .../ValueResourceCollectionOutcomeOfInt64.md | 14 - ...eInputOfRetailMediaBrandAccountCreation.md | 12 + .../ValueResourceInputOfRetailMediaBrands.md | 12 + ...InputOfRetailMediaSellerAccountCreation.md | 12 + ...sourceOfRetailMediaBrandAccountCreation.md | 13 + ...md => ValueResourceOfRetailMediaBrands.md} | 4 +- ...ourceOfRetailMediaSellerAccountCreation.md | 13 + sdks/retailmedia_preview/setup.py | 6 +- 238 files changed, 10899 insertions(+), 4973 deletions(-) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/catalog_api.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{creative202210.py => async_accounts_report.py} (56%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{external_catalog_request_preview.py => async_accounts_report_request.py} (94%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report_resource.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{text_variable_value.py => batch_accepted_response.py} (94%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_int64.py => change_details.py} (87%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{hyperlink_variable_value.py => custom_attribute.py} (92%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{files_variable_value.py => external_line_item_capping_v2.py} (92%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{page_type_environment.py => external_line_item_page_v2.py} (86%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{creative_create_model202207.py => external_preferred_line_item_create_model_v2.py} (74%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{external_catalog_status.py => external_preferred_line_item_update_model_v2.py} (75%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{template.py => external_preferred_line_item_v2.py} (70%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py => fail_response.py} (90%) delete mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/files_variables_specification.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py => input_resource_of_preferred_line_item_create_model_v2.py} (91%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{choice_variable_specification.py => insertion_order_history_change_data_capture.py} (78%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/installment.py delete mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/loyalty_points.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/metadata.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{json_api_request_of_catalog_request_preview.py => preferred_line_item_create_model_v2_request.py} (93%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_update_model_v2_request.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{creative202210_response.py => preferred_line_item_v2_paged_list_response.py} (88%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{creative202210_list_response.py => preferred_line_item_v2_response.py} (91%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/price.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{template_variable.py => product_importer_error.py} (78%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_importer_warning.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{template_list_response.py => product_shipping.py} (78%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping_dimension.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{color_variable_value.py => product_shipping_weight.py} (92%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_tax.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{choice_variable_value.py => product_unit_pricing_base_measure.py} (92%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{text_variable_specification.py => product_unit_pricing_measure.py} (93%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{section.py => products_custom_batch_request.py} (91%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{creative_update_model202207.py => products_custom_batch_request_entry.py} (78%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{choice_option.py => report_detail_error.py} (85%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_detail_errors.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{template_variable_value.py => report_ok_response.py} (72%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{resource_of_creative202210.py => resource_of_preferred_line_item_update_model_v2.py} (94%) rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{resource_of_template.py => resource_of_preferred_line_item_v2.py} (95%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_brands.py delete mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_response.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py rename sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/{value_resource_of_int64.py => value_resource_of_retail_media_brands.py} (94%) create mode 100644 sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py create mode 100644 sdks/retailmedia_preview/docs/AsyncAccountsReport.md create mode 100644 sdks/retailmedia_preview/docs/AsyncAccountsReportRequest.md create mode 100644 sdks/retailmedia_preview/docs/AsyncAccountsReportResource.md rename sdks/retailmedia_preview/docs/{HyperlinkVariableValue.md => BatchAcceptedResponse.md} (76%) create mode 100644 sdks/retailmedia_preview/docs/CatalogApi.md create mode 100644 sdks/retailmedia_preview/docs/ChangeDetails.md delete mode 100644 sdks/retailmedia_preview/docs/ChoiceVariableSpecification.md delete mode 100644 sdks/retailmedia_preview/docs/Creative202210.md delete mode 100644 sdks/retailmedia_preview/docs/CreativeCreateModel202207.md delete mode 100644 sdks/retailmedia_preview/docs/CreativeUpdateModel202207.md rename sdks/retailmedia_preview/docs/{ChoiceOption.md => CustomAttribute.md} (67%) delete mode 100644 sdks/retailmedia_preview/docs/ExternalCatalogStatus.md rename sdks/retailmedia_preview/docs/{ChoiceVariableValue.md => ExternalLineItemCappingV2.md} (74%) create mode 100644 sdks/retailmedia_preview/docs/ExternalLineItemPageCategoryV2.md create mode 100644 sdks/retailmedia_preview/docs/ExternalLineItemPageV2.md create mode 100644 sdks/retailmedia_preview/docs/ExternalPreferredLineItemCreateModelV2.md create mode 100644 sdks/retailmedia_preview/docs/ExternalPreferredLineItemUpdateModelV2.md create mode 100644 sdks/retailmedia_preview/docs/ExternalPreferredLineItemV2.md create mode 100644 sdks/retailmedia_preview/docs/FailResponse.md delete mode 100644 sdks/retailmedia_preview/docs/FilesVariablesSpecification.md create mode 100644 sdks/retailmedia_preview/docs/InputResourceOfPreferredLineItemCreateModelV2.md create mode 100644 sdks/retailmedia_preview/docs/InsertionOrderHistoryChangeDataCapture.md create mode 100644 sdks/retailmedia_preview/docs/Installment.md delete mode 100644 sdks/retailmedia_preview/docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md delete mode 100644 sdks/retailmedia_preview/docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview.md delete mode 100644 sdks/retailmedia_preview/docs/JsonApiRequestOfCatalogRequestPreview.md delete mode 100644 sdks/retailmedia_preview/docs/JsonApiSingleResponseOfCatalogStatus.md create mode 100644 sdks/retailmedia_preview/docs/LoyaltyPoints.md create mode 100644 sdks/retailmedia_preview/docs/Metadata.md create mode 100644 sdks/retailmedia_preview/docs/PageOfInsertionOrderHistoryChangeDataCapture.md delete mode 100644 sdks/retailmedia_preview/docs/PageTypeEnvironment.md create mode 100644 sdks/retailmedia_preview/docs/PreferredLineItemCreateModelV2Request.md rename sdks/retailmedia_preview/docs/{FilesVariableValue.md => PreferredLineItemUpdateModelV2Request.md} (69%) rename sdks/retailmedia_preview/docs/{Creative202210Response.md => PreferredLineItemV2PagedListResponse.md} (53%) rename sdks/retailmedia_preview/docs/{Creative202210ListResponse.md => PreferredLineItemV2Response.md} (56%) rename sdks/retailmedia_preview/docs/{ExternalCatalogRequestPreview.md => Price.md} (65%) create mode 100644 sdks/retailmedia_preview/docs/Product.md create mode 100644 sdks/retailmedia_preview/docs/ProductImporterError.md create mode 100644 sdks/retailmedia_preview/docs/ProductImporterWarning.md create mode 100644 sdks/retailmedia_preview/docs/ProductShipping.md create mode 100644 sdks/retailmedia_preview/docs/ProductShippingDimension.md create mode 100644 sdks/retailmedia_preview/docs/ProductShippingWeight.md create mode 100644 sdks/retailmedia_preview/docs/ProductTax.md create mode 100644 sdks/retailmedia_preview/docs/ProductUnitPricingBaseMeasure.md rename sdks/retailmedia_preview/docs/{ColorVariableValue.md => ProductUnitPricingMeasure.md} (69%) create mode 100644 sdks/retailmedia_preview/docs/ProductsCustomBatchRequest.md create mode 100644 sdks/retailmedia_preview/docs/ProductsCustomBatchRequestEntry.md rename sdks/retailmedia_preview/docs/{TextVariableValue.md => ReportDetailError.md} (75%) rename sdks/retailmedia_preview/docs/{Section.md => ReportDetailErrors.md} (70%) create mode 100644 sdks/retailmedia_preview/docs/ReportOkResponse.md rename sdks/retailmedia_preview/docs/{ResourceOfTemplate.md => ResourceOfPreferredLineItemUpdateModelV2.md} (78%) rename sdks/retailmedia_preview/docs/{ResourceOfCreative202210.md => ResourceOfPreferredLineItemV2.md} (82%) create mode 100644 sdks/retailmedia_preview/docs/RetailMediaBrands.md delete mode 100644 sdks/retailmedia_preview/docs/Template.md delete mode 100644 sdks/retailmedia_preview/docs/TemplateListResponse.md delete mode 100644 sdks/retailmedia_preview/docs/TemplateResponse.md delete mode 100644 sdks/retailmedia_preview/docs/TemplateVariable.md delete mode 100644 sdks/retailmedia_preview/docs/TemplateVariableValue.md delete mode 100644 sdks/retailmedia_preview/docs/TextVariableSpecification.md create mode 100644 sdks/retailmedia_preview/docs/ValueResourceCollectionInputOfRetailMediaSeller.md delete mode 100644 sdks/retailmedia_preview/docs/ValueResourceCollectionOutcomeOfInt64.md create mode 100644 sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md create mode 100644 sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaBrands.md create mode 100644 sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaSellerAccountCreation.md create mode 100644 sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaBrandAccountCreation.md rename sdks/retailmedia_preview/docs/{ValueResourceOfInt64.md => ValueResourceOfRetailMediaBrands.md} (77%) create mode 100644 sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaSellerAccountCreation.md diff --git a/sdks/marketingsolutions_2023-01/README.md b/sdks/marketingsolutions_2023-01/README.md index e4dc97a6..159e4e82 100644 --- a/sdks/marketingsolutions_2023-01/README.md +++ b/sdks/marketingsolutions_2023-01/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2023.01.0.240207 +- Package version: 2023.01.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2023.01.0.240207 +pip install criteo-api-marketingsolutions-sdk==2023.01.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.01.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.01.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/__init__.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/__init__.py index a21e702e..07c72862 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/__init__.py +++ b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2023.01.0.240207" +__version__ = "2023.01.0.240404" # import ApiClient from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api_client.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api_client.py index 86fb00a1..04fa8607 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api_client.py +++ b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.01.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2023.01.0.240404/python' def __enter__(self): return self diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/configuration.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/configuration.py index bcc02742..3761708d 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/configuration.py +++ b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2023-01\n"\ - "SDK Package Version: 2023.01.0.240207".\ + "SDK Package Version: 2023.01.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/marketingsolutions_2023-01/setup.py b/sdks/marketingsolutions_2023-01/setup.py index d661a106..bb2d29dc 100644 --- a/sdks/marketingsolutions_2023-01/setup.py +++ b/sdks/marketingsolutions_2023-01/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-marketingsolutions-sdk" -VERSION = "2023.01.0.240207" +VERSION = "2023.01.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-marketingsolutions-sdk==2023.01.0.240207 +pip install criteo-api-marketingsolutions-sdk==2023.01.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.01.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.01.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-04/README.md b/sdks/marketingsolutions_2023-04/README.md index 50ba9b70..3b400e8a 100644 --- a/sdks/marketingsolutions_2023-04/README.md +++ b/sdks/marketingsolutions_2023-04/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2023.04.0.240207 +- Package version: 2023.04.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2023.04.0.240207 +pip install criteo-api-marketingsolutions-sdk==2023.04.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.04.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.04.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/__init__.py b/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/__init__.py index b5ac81ab..4f23e4fe 100644 --- a/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/__init__.py +++ b/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2023.04.0.240207" +__version__ = "2023.04.0.240404" # import ApiClient from criteo_api_marketingsolutions_v2023_04.api_client import ApiClient diff --git a/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/api_client.py b/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/api_client.py index 87f72bf6..5dd86d20 100644 --- a/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/api_client.py +++ b/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.04.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2023.04.0.240404/python' def __enter__(self): return self diff --git a/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/configuration.py b/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/configuration.py index 1ef3f197..e9d32be2 100644 --- a/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/configuration.py +++ b/sdks/marketingsolutions_2023-04/criteo_api_marketingsolutions_v2023_04/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2023-04\n"\ - "SDK Package Version: 2023.04.0.240207".\ + "SDK Package Version: 2023.04.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/marketingsolutions_2023-04/setup.py b/sdks/marketingsolutions_2023-04/setup.py index 94544ceb..b96e5866 100644 --- a/sdks/marketingsolutions_2023-04/setup.py +++ b/sdks/marketingsolutions_2023-04/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-marketingsolutions-sdk" -VERSION = "2023.04.0.240207" +VERSION = "2023.04.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-marketingsolutions-sdk==2023.04.0.240207 +pip install criteo-api-marketingsolutions-sdk==2023.04.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.04.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.04.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-07/README.md b/sdks/marketingsolutions_2023-07/README.md index d7a9c0f8..16714173 100644 --- a/sdks/marketingsolutions_2023-07/README.md +++ b/sdks/marketingsolutions_2023-07/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2023.07.0.240207 +- Package version: 2023.07.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2023.07.0.240207 +pip install criteo-api-marketingsolutions-sdk==2023.07.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.07.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.07.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/__init__.py b/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/__init__.py index f4392c22..9731a7cc 100644 --- a/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/__init__.py +++ b/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2023.07.0.240207" +__version__ = "2023.07.0.240404" # import ApiClient from criteo_api_marketingsolutions_v2023_07.api_client import ApiClient diff --git a/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/api_client.py b/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/api_client.py index 7a0a8e9d..726183c4 100644 --- a/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/api_client.py +++ b/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.07.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2023.07.0.240404/python' def __enter__(self): return self diff --git a/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/configuration.py b/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/configuration.py index 1864503f..7d096fab 100644 --- a/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/configuration.py +++ b/sdks/marketingsolutions_2023-07/criteo_api_marketingsolutions_v2023_07/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2023-07\n"\ - "SDK Package Version: 2023.07.0.240207".\ + "SDK Package Version: 2023.07.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/marketingsolutions_2023-07/setup.py b/sdks/marketingsolutions_2023-07/setup.py index 4ae3b55b..ce556a7a 100644 --- a/sdks/marketingsolutions_2023-07/setup.py +++ b/sdks/marketingsolutions_2023-07/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-marketingsolutions-sdk" -VERSION = "2023.07.0.240207" +VERSION = "2023.07.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-marketingsolutions-sdk==2023.07.0.240207 +pip install criteo-api-marketingsolutions-sdk==2023.07.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.07.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.07.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-10/README.md b/sdks/marketingsolutions_2023-10/README.md index 075d4bed..b28eb72b 100644 --- a/sdks/marketingsolutions_2023-10/README.md +++ b/sdks/marketingsolutions_2023-10/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2023.10.0.240207 +- Package version: 2023.10.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2023.10.0.240207 +pip install criteo-api-marketingsolutions-sdk==2023.10.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.10.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.10.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/__init__.py b/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/__init__.py index 3ea548c4..b17c0d25 100644 --- a/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/__init__.py +++ b/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2023.10.0.240207" +__version__ = "2023.10.0.240404" # import ApiClient from criteo_api_marketingsolutions_v2023_10.api_client import ApiClient diff --git a/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/api_client.py b/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/api_client.py index 1bc6166b..af5eb2b7 100644 --- a/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/api_client.py +++ b/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.10.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2023.10.0.240404/python' def __enter__(self): return self diff --git a/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/configuration.py b/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/configuration.py index 852dc565..67db4b77 100644 --- a/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/configuration.py +++ b/sdks/marketingsolutions_2023-10/criteo_api_marketingsolutions_v2023_10/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2023-10\n"\ - "SDK Package Version: 2023.10.0.240207".\ + "SDK Package Version: 2023.10.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/marketingsolutions_2023-10/setup.py b/sdks/marketingsolutions_2023-10/setup.py index ad8d49af..7eb88802 100644 --- a/sdks/marketingsolutions_2023-10/setup.py +++ b/sdks/marketingsolutions_2023-10/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-marketingsolutions-sdk" -VERSION = "2023.10.0.240207" +VERSION = "2023.10.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-marketingsolutions-sdk==2023.10.0.240207 +pip install criteo-api-marketingsolutions-sdk==2023.10.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.10.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2023.10.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2024-01/README.md b/sdks/marketingsolutions_2024-01/README.md index 6589819e..4b98afe4 100644 --- a/sdks/marketingsolutions_2024-01/README.md +++ b/sdks/marketingsolutions_2024-01/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2024.01.0.240207 +- Package version: 2024.01.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2024.01.0.240207 +pip install criteo-api-marketingsolutions-sdk==2024.01.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2024.01.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2024.01.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/__init__.py b/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/__init__.py index 7060faba..569b54ae 100644 --- a/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/__init__.py +++ b/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2024.01.0.240207" +__version__ = "2024.01.0.240404" # import ApiClient from criteo_api_marketingsolutions_v2024_01.api_client import ApiClient diff --git a/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/api_client.py b/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/api_client.py index 1e91b8ed..8fb2977d 100644 --- a/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/api_client.py +++ b/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2024.01.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2024.01.0.240404/python' def __enter__(self): return self diff --git a/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/configuration.py b/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/configuration.py index ace0da01..3a9b0d89 100644 --- a/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/configuration.py +++ b/sdks/marketingsolutions_2024-01/criteo_api_marketingsolutions_v2024_01/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2024-01\n"\ - "SDK Package Version: 2024.01.0.240207".\ + "SDK Package Version: 2024.01.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/marketingsolutions_2024-01/setup.py b/sdks/marketingsolutions_2024-01/setup.py index 7d08ed9d..bd2280b3 100644 --- a/sdks/marketingsolutions_2024-01/setup.py +++ b/sdks/marketingsolutions_2024-01/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-marketingsolutions-sdk" -VERSION = "2024.01.0.240207" +VERSION = "2024.01.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-marketingsolutions-sdk==2024.01.0.240207 +pip install criteo-api-marketingsolutions-sdk==2024.01.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2024.01.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2024.01.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_preview/README.md b/sdks/marketingsolutions_preview/README.md index b6ec947d..f0c1b3f2 100644 --- a/sdks/marketingsolutions_preview/README.md +++ b/sdks/marketingsolutions_preview/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 0.0.240207 +- Package version: 0.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==0.0.240207 +pip install criteo-api-marketingsolutions-sdk==0.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==0.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==0.0.240404`) Then import the package: ```python diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/__init__.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/__init__.py index f81ae21b..067cb293 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/__init__.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "0.0.240207" +__version__ = "0.0.240404" # import ApiClient from criteo_api_marketingsolutions_preview.api_client import ApiClient diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api_client.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api_client.py index 5dffbc35..2ccdbe8e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api_client.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/0.0.240207/python' + self.user_agent = 'OpenAPI-Generator/0.0.240404/python' def __enter__(self): return self diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/configuration.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/configuration.py index bc2387f4..0cda66de 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/configuration.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: preview\n"\ - "SDK Package Version: 0.0.240207".\ + "SDK Package Version: 0.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product.py index 6fa2a0f2..1e3a032a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product.py @@ -172,6 +172,7 @@ def openapi_types(): 'ads_labels': ([str], none_type,), # noqa: E501 'ads_redirect': (str, none_type,), # noqa: E501 'product_types': ([str], none_type,), # noqa: E501 + 'product_type_keys': ([str], none_type,), # noqa: E501 'age_group': (str, none_type,), # noqa: E501 'availability': (str, none_type,), # noqa: E501 'condition': (str, none_type,), # noqa: E501 @@ -260,6 +261,7 @@ def discriminator(): 'ads_labels': 'adsLabels', # noqa: E501 'ads_redirect': 'adsRedirect', # noqa: E501 'product_types': 'productTypes', # noqa: E501 + 'product_type_keys': 'productTypeKeys', # noqa: E501 'age_group': 'ageGroup', # noqa: E501 'availability': 'availability', # noqa: E501 'condition': 'condition', # noqa: E501 @@ -289,7 +291,7 @@ def _from_openapi_data(cls, id, title, link, image_link, *args, **kwargs): # no """Product - a model defined in OpenAPI Args: - id (str): A unique identifier for the item. Aka Product ID. + id (str): A unique identifier for the item. Aka Product ID. Don’t use casing to make IDs unique. title (str): Title of the item. (500 UTF8 characters max). link (str): URL directly linking to your item's page on your website. (1000 UTF8 characters max). image_link (str): URL of an image of the item. Supported formats: PNG, JPEG, GIF. (2000 UTF8 characters max). @@ -338,7 +340,7 @@ def _from_openapi_data(cls, id, title, link, image_link, *args, **kwargs): # no color (str, none_type): Color of the item.. [optional] # noqa: E501 google_product_category (str, none_type): Google's category of the item (see Google product taxonomy). RECOMMENDED.. [optional] # noqa: E501 gtin (str, none_type): Global Trade Item Number (GTIN) of the item. RECOMMENDED.. [optional] # noqa: E501 - item_group_id (str, none_type): Shared identifier for all variants of the same product. RECOMMENDED.. [optional] # noqa: E501 + item_group_id (str, none_type): Shared identifier for all variants of the same product. RECOMMENDED. Don’t use casing to make IDs unique. (50 characters max). [optional] # noqa: E501 material (str, none_type): The material of which the item is made.. [optional] # noqa: E501 mpn (str, none_type): Manufacturer Part Number (MPN) of the item. RECOMMENDED.. [optional] # noqa: E501 pattern (str, none_type): The item's pattern (e.g. polka dots).. [optional] # noqa: E501 @@ -385,6 +387,7 @@ def _from_openapi_data(cls, id, title, link, image_link, *args, **kwargs): # no ads_labels ([str], none_type): Similar to adsGrouping, but only works on CPC.. [optional] # noqa: E501 ads_redirect (str, none_type): Allows advertisers to override the item URL when the product is shown within the context of Product Ads.. [optional] # noqa: E501 product_types ([str], none_type): Categories of the item (formatted as in products data specification).. [optional] # noqa: E501 + product_type_keys ([str], none_type): Category keys of the item (formatted as in productTypes).. [optional] # noqa: E501 age_group (str, none_type): Target age group of the item.. [optional] # noqa: E501 availability (str, none_type): Availability status of the item. RECOMMENDED.. [optional] # noqa: E501 condition (str, none_type): Condition or state of the item.. [optional] # noqa: E501 @@ -396,11 +399,11 @@ def _from_openapi_data(cls, id, title, link, image_link, *args, **kwargs): # no max_energy_efficiency_class (str, none_type): The energy efficiency class as defined in EU directive 2010/30/EU.. [optional] # noqa: E501 tax_category (str, none_type): The tax category of the product, used to configure detailed tax nexus in account-level tax settings.. [optional] # noqa: E501 transit_time_label (str, none_type): The transit time label of the product, used to group product in account-level transit time tables.. [optional] # noqa: E501 - seller_id (str, none_type): Deprecated field. It should be replaced by externalSellerId. The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + seller_id (str, none_type): (Deprecated Field) The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 external_seller_id (str, none_type): The external id of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 - external_seller_name (str, none_type): The external name of the seller (case sensitive and 750 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 - number_of_reviews (int, none_type): The number of reviews for the product. This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 - product_rating (str, none_type): The rating of the product. This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + external_seller_name (str, none_type): The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + number_of_reviews (int, none_type): The number of customer reviews for the product. [optional] # noqa: E501 + product_rating (str, none_type): The product rating for the product. [optional] # noqa: E501 """ channel = kwargs.get('channel', "online") @@ -462,7 +465,7 @@ def __init__(self, id, title, link, image_link, *args, **kwargs): # noqa: E501 """Product - a model defined in OpenAPI Args: - id (str): A unique identifier for the item. Aka Product ID. + id (str): A unique identifier for the item. Aka Product ID. Don’t use casing to make IDs unique. title (str): Title of the item. (500 UTF8 characters max). link (str): URL directly linking to your item's page on your website. (1000 UTF8 characters max). image_link (str): URL of an image of the item. Supported formats: PNG, JPEG, GIF. (2000 UTF8 characters max). @@ -511,7 +514,7 @@ def __init__(self, id, title, link, image_link, *args, **kwargs): # noqa: E501 color (str, none_type): Color of the item.. [optional] # noqa: E501 google_product_category (str, none_type): Google's category of the item (see Google product taxonomy). RECOMMENDED.. [optional] # noqa: E501 gtin (str, none_type): Global Trade Item Number (GTIN) of the item. RECOMMENDED.. [optional] # noqa: E501 - item_group_id (str, none_type): Shared identifier for all variants of the same product. RECOMMENDED.. [optional] # noqa: E501 + item_group_id (str, none_type): Shared identifier for all variants of the same product. RECOMMENDED. Don’t use casing to make IDs unique. (50 characters max). [optional] # noqa: E501 material (str, none_type): The material of which the item is made.. [optional] # noqa: E501 mpn (str, none_type): Manufacturer Part Number (MPN) of the item. RECOMMENDED.. [optional] # noqa: E501 pattern (str, none_type): The item's pattern (e.g. polka dots).. [optional] # noqa: E501 @@ -558,6 +561,7 @@ def __init__(self, id, title, link, image_link, *args, **kwargs): # noqa: E501 ads_labels ([str], none_type): Similar to adsGrouping, but only works on CPC.. [optional] # noqa: E501 ads_redirect (str, none_type): Allows advertisers to override the item URL when the product is shown within the context of Product Ads.. [optional] # noqa: E501 product_types ([str], none_type): Categories of the item (formatted as in products data specification).. [optional] # noqa: E501 + product_type_keys ([str], none_type): Category keys of the item (formatted as in productTypes).. [optional] # noqa: E501 age_group (str, none_type): Target age group of the item.. [optional] # noqa: E501 availability (str, none_type): Availability status of the item. RECOMMENDED.. [optional] # noqa: E501 condition (str, none_type): Condition or state of the item.. [optional] # noqa: E501 @@ -569,11 +573,11 @@ def __init__(self, id, title, link, image_link, *args, **kwargs): # noqa: E501 max_energy_efficiency_class (str, none_type): The energy efficiency class as defined in EU directive 2010/30/EU.. [optional] # noqa: E501 tax_category (str, none_type): The tax category of the product, used to configure detailed tax nexus in account-level tax settings.. [optional] # noqa: E501 transit_time_label (str, none_type): The transit time label of the product, used to group product in account-level transit time tables.. [optional] # noqa: E501 - seller_id (str, none_type): Deprecated field. It should be replaced by externalSellerId. The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + seller_id (str, none_type): (Deprecated Field) The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 external_seller_id (str, none_type): The external id of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 - external_seller_name (str, none_type): The external name of the seller (case sensitive and 750 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 - number_of_reviews (int, none_type): The number of reviews for the product. This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 - product_rating (str, none_type): The rating of the product. This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + external_seller_name (str, none_type): The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + number_of_reviews (int, none_type): The number of customer reviews for the product. [optional] # noqa: E501 + product_rating (str, none_type): The product rating for the product. [optional] # noqa: E501 """ channel = kwargs.get('channel', "online") diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/products_custom_batch_request_entry.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/products_custom_batch_request_entry.py index 2a36e052..7386dd98 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/products_custom_batch_request_entry.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/products_custom_batch_request_entry.py @@ -162,7 +162,7 @@ def _from_openapi_data(cls, merchant_id, method, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) batch_id (int, none_type): An entry ID, unique within the batch request.. [optional] # noqa: E501 product_id (str, none_type): The Product ID to delete. Only defined if the method is delete.. [optional] # noqa: E501 - item_group_id (str, none_type): The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant.. [optional] # noqa: E501 + item_group_id (str, none_type): Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant.. [optional] # noqa: E501 product (Product): [optional] # noqa: E501 feed_id (str, none_type): Not used by Criteo.. [optional] # noqa: E501 """ @@ -258,7 +258,7 @@ def __init__(self, merchant_id, method, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) batch_id (int, none_type): An entry ID, unique within the batch request.. [optional] # noqa: E501 product_id (str, none_type): The Product ID to delete. Only defined if the method is delete.. [optional] # noqa: E501 - item_group_id (str, none_type): The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant.. [optional] # noqa: E501 + item_group_id (str, none_type): Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant.. [optional] # noqa: E501 product (Product): [optional] # noqa: E501 feed_id (str, none_type): Not used by Criteo.. [optional] # noqa: E501 """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_budget_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_budget_v24_q1.py index 910e13c1..54449762 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_budget_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_budget_v24_q1.py @@ -29,10 +29,6 @@ from criteo_api_marketingsolutions_preview.exceptions import ApiAttributeError -def lazy_import(): - from criteo_api_marketingsolutions_preview.model.nillable_decimal import NillableDecimal - globals()['NillableDecimal'] = NillableDecimal - class ReadAdSetBudgetV24Q1(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -99,7 +95,6 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ - lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -114,13 +109,12 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { 'budget_strategy': (str, none_type,), # noqa: E501 'budget_renewal': (str, none_type,), # noqa: E501 'budget_delivery_smoothing': (str, none_type,), # noqa: E501 'budget_delivery_week': (str, none_type,), # noqa: E501 - 'budget_amount': (NillableDecimal,), # noqa: E501 + 'budget_amount': (float, none_type,), # noqa: E501 } @cached_property @@ -181,7 +175,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 budget_renewal (str, none_type): [optional] # noqa: E501 budget_delivery_smoothing (str, none_type): [optional] # noqa: E501 budget_delivery_week (str, none_type): [optional] # noqa: E501 - budget_amount (NillableDecimal): [optional] # noqa: E501 + budget_amount (float, none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -271,7 +265,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 budget_renewal (str, none_type): [optional] # noqa: E501 budget_delivery_smoothing (str, none_type): [optional] # noqa: E501 budget_delivery_week (str, none_type): [optional] # noqa: E501 - budget_amount (NillableDecimal): [optional] # noqa: E501 + budget_amount (float, none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/recommended_product.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/recommended_product.py index 7d1e9b9d..d6d38603 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/recommended_product.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/recommended_product.py @@ -83,6 +83,7 @@ def openapi_types(): return { 'product_external_id': (str, none_type,), # noqa: E501 'click_url': (str, none_type,), # noqa: E501 + 'alternative_click_url': (str, none_type,), # noqa: E501 'image_url': (str, none_type,), # noqa: E501 'name': (str, none_type,), # noqa: E501 'description': (str, none_type,), # noqa: E501 @@ -99,6 +100,7 @@ def discriminator(): attribute_map = { 'product_external_id': 'productExternalId', # noqa: E501 'click_url': 'clickUrl', # noqa: E501 + 'alternative_click_url': 'alternativeClickUrl', # noqa: E501 'image_url': 'imageUrl', # noqa: E501 'name': 'name', # noqa: E501 'description': 'description', # noqa: E501 @@ -149,7 +151,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) product_external_id (str, none_type): Product external id. Same id than what is used in user events.. [optional] # noqa: E501 - click_url (str, none_type): Url leading to product details page and also used to track user click.. [optional] # noqa: E501 + click_url (str, none_type): Url leading to product details page and also used to track user click. It's relying on the default product URL field in the catalog.. [optional] # noqa: E501 + alternative_click_url (str, none_type): Url leading to product details page and also used to track user click. It's relying on a custom product URL field in the catalog.. [optional] # noqa: E501 image_url (str, none_type): Product image.. [optional] # noqa: E501 name (str, none_type): Product name.. [optional] # noqa: E501 description (str, none_type): Product description.. [optional] # noqa: E501 @@ -242,7 +245,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) product_external_id (str, none_type): Product external id. Same id than what is used in user events.. [optional] # noqa: E501 - click_url (str, none_type): Url leading to product details page and also used to track user click.. [optional] # noqa: E501 + click_url (str, none_type): Url leading to product details page and also used to track user click. It's relying on the default product URL field in the catalog.. [optional] # noqa: E501 + alternative_click_url (str, none_type): Url leading to product details page and also used to track user click. It's relying on a custom product URL field in the catalog.. [optional] # noqa: E501 image_url (str, none_type): Product image.. [optional] # noqa: E501 name (str, none_type): Product name.. [optional] # noqa: E501 description (str, none_type): Product description.. [optional] # noqa: E501 diff --git a/sdks/marketingsolutions_preview/docs/CatalogApi.md b/sdks/marketingsolutions_preview/docs/CatalogApi.md index f6d96ab5..5f371efc 100644 --- a/sdks/marketingsolutions_preview/docs/CatalogApi.md +++ b/sdks/marketingsolutions_preview/docs/CatalogApi.md @@ -209,6 +209,9 @@ with criteo_api_marketingsolutions_preview.ApiClient(configuration) as api_clien product_types=[ "product_types_example", ], + product_type_keys=[ + "product_type_keys_example", + ], age_group="age_group_example", availability="availability_example", condition="condition_example", diff --git a/sdks/marketingsolutions_preview/docs/Product.md b/sdks/marketingsolutions_preview/docs/Product.md index 11f080cf..9f654009 100644 --- a/sdks/marketingsolutions_preview/docs/Product.md +++ b/sdks/marketingsolutions_preview/docs/Product.md @@ -5,7 +5,7 @@ Defines a product to be inserted or updated. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | A unique identifier for the item. Aka Product ID. | +**id** | **str** | A unique identifier for the item. Aka Product ID. Don’t use casing to make IDs unique. | **title** | **str** | Title of the item. (500 UTF8 characters max). | **link** | **str** | URL directly linking to your item's page on your website. (1000 UTF8 characters max). | **image_link** | **str** | URL of an image of the item. Supported formats: PNG, JPEG, GIF. (2000 UTF8 characters max). | @@ -22,7 +22,7 @@ Name | Type | Description | Notes **color** | **str, none_type** | Color of the item. | [optional] **google_product_category** | **str, none_type** | Google's category of the item (see Google product taxonomy). RECOMMENDED. | [optional] **gtin** | **str, none_type** | Global Trade Item Number (GTIN) of the item. RECOMMENDED. | [optional] -**item_group_id** | **str, none_type** | Shared identifier for all variants of the same product. RECOMMENDED. | [optional] +**item_group_id** | **str, none_type** | Shared identifier for all variants of the same product. RECOMMENDED. Don’t use casing to make IDs unique. (50 characters max) | [optional] **material** | **str, none_type** | The material of which the item is made. | [optional] **mpn** | **str, none_type** | Manufacturer Part Number (MPN) of the item. RECOMMENDED. | [optional] **pattern** | **str, none_type** | The item's pattern (e.g. polka dots). | [optional] @@ -69,6 +69,7 @@ Name | Type | Description | Notes **ads_labels** | **[str], none_type** | Similar to adsGrouping, but only works on CPC. | [optional] **ads_redirect** | **str, none_type** | Allows advertisers to override the item URL when the product is shown within the context of Product Ads. | [optional] **product_types** | **[str], none_type** | Categories of the item (formatted as in products data specification). | [optional] +**product_type_keys** | **[str], none_type** | Category keys of the item (formatted as in productTypes). | [optional] **age_group** | **str, none_type** | Target age group of the item. | [optional] **availability** | **str, none_type** | Availability status of the item. RECOMMENDED. | [optional] **condition** | **str, none_type** | Condition or state of the item. | [optional] @@ -80,11 +81,11 @@ Name | Type | Description | Notes **max_energy_efficiency_class** | **str, none_type** | The energy efficiency class as defined in EU directive 2010/30/EU. | [optional] **tax_category** | **str, none_type** | The tax category of the product, used to configure detailed tax nexus in account-level tax settings. | [optional] **transit_time_label** | **str, none_type** | The transit time label of the product, used to group product in account-level transit time tables. | [optional] -**seller_id** | **str, none_type** | Deprecated field. It should be replaced by externalSellerId. The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. | [optional] +**seller_id** | **str, none_type** | (Deprecated Field) The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. | [optional] **external_seller_id** | **str, none_type** | The external id of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. | [optional] -**external_seller_name** | **str, none_type** | The external name of the seller (case sensitive and 750 UTF8 characters max). This information is required by the Criteo Offsite Ads. | [optional] -**number_of_reviews** | **int, none_type** | The number of reviews for the product. This information is required by the Criteo Offsite Ads. | [optional] -**product_rating** | **str, none_type** | The rating of the product. This information is required by the Criteo Offsite Ads. | [optional] +**external_seller_name** | **str, none_type** | The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. | [optional] +**number_of_reviews** | **int, none_type** | The number of customer reviews for the product | [optional] +**product_rating** | **str, none_type** | The product rating for the product | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/marketingsolutions_preview/docs/ProductsCustomBatchRequestEntry.md b/sdks/marketingsolutions_preview/docs/ProductsCustomBatchRequestEntry.md index edf2bea5..f54d23ac 100644 --- a/sdks/marketingsolutions_preview/docs/ProductsCustomBatchRequestEntry.md +++ b/sdks/marketingsolutions_preview/docs/ProductsCustomBatchRequestEntry.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **method** | **str** | The method of the batch entry. | **batch_id** | **int, none_type** | An entry ID, unique within the batch request. | [optional] **product_id** | **str, none_type** | The Product ID to delete. Only defined if the method is delete. | [optional] -**item_group_id** | **str, none_type** | The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant. | [optional] +**item_group_id** | **str, none_type** | Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant. | [optional] **product** | [**Product**](Product.md) | | [optional] **feed_id** | **str, none_type** | Not used by Criteo. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/marketingsolutions_preview/docs/ReadAdSetBudgetV24Q1.md b/sdks/marketingsolutions_preview/docs/ReadAdSetBudgetV24Q1.md index 62caaa04..56e7b983 100644 --- a/sdks/marketingsolutions_preview/docs/ReadAdSetBudgetV24Q1.md +++ b/sdks/marketingsolutions_preview/docs/ReadAdSetBudgetV24Q1.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **budget_renewal** | **str, none_type** | | [optional] **budget_delivery_smoothing** | **str, none_type** | | [optional] **budget_delivery_week** | **str, none_type** | | [optional] -**budget_amount** | [**NillableDecimal**](NillableDecimal.md) | | [optional] +**budget_amount** | **float, none_type** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/marketingsolutions_preview/docs/RecommendedProduct.md b/sdks/marketingsolutions_preview/docs/RecommendedProduct.md index d22854c4..664ea4d2 100644 --- a/sdks/marketingsolutions_preview/docs/RecommendedProduct.md +++ b/sdks/marketingsolutions_preview/docs/RecommendedProduct.md @@ -6,7 +6,8 @@ Represents a recommended product. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **product_external_id** | **str, none_type** | Product external id. Same id than what is used in user events. | [optional] -**click_url** | **str, none_type** | Url leading to product details page and also used to track user click. | [optional] +**click_url** | **str, none_type** | Url leading to product details page and also used to track user click. It's relying on the default product URL field in the catalog. | [optional] +**alternative_click_url** | **str, none_type** | Url leading to product details page and also used to track user click. It's relying on a custom product URL field in the catalog. | [optional] **image_url** | **str, none_type** | Product image. | [optional] **name** | **str, none_type** | Product name. | [optional] **description** | **str, none_type** | Product description. | [optional] diff --git a/sdks/marketingsolutions_preview/setup.py b/sdks/marketingsolutions_preview/setup.py index 39d87991..77fb54ed 100644 --- a/sdks/marketingsolutions_preview/setup.py +++ b/sdks/marketingsolutions_preview/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-marketingsolutions-sdk" -VERSION = "0.0.240207" +VERSION = "0.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-marketingsolutions-sdk==0.0.240207 +pip install criteo-api-marketingsolutions-sdk==0.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==0.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==0.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-01/README.md b/sdks/retailmedia_2023-01/README.md index 7cc110bd..8f765edf 100644 --- a/sdks/retailmedia_2023-01/README.md +++ b/sdks/retailmedia_2023-01/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2023.01.0.240207 +- Package version: 2023.01.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2023.01.0.240207 +pip install criteo-api-retailmedia-sdk==2023.01.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.01.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.01.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/__init__.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/__init__.py index be08cf34..b352a5dc 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/__init__.py +++ b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2023.01.0.240207" +__version__ = "2023.01.0.240404" # import ApiClient from criteo_api_retailmedia_v2023_01.api_client import ApiClient diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api_client.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api_client.py index 5564c99e..ebbc381e 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api_client.py +++ b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.01.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2023.01.0.240404/python' def __enter__(self): return self diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/configuration.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/configuration.py index a0b6d3ea..fcf0cc75 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/configuration.py +++ b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2023-01\n"\ - "SDK Package Version: 2023.01.0.240207".\ + "SDK Package Version: 2023.01.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report.py index 00cba04b..70079920 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report.py +++ b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report.py @@ -55,43 +55,6 @@ class AsyncCampaignsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'CPM': "cpm", - 'ROAS': "roas", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ENVIRONMENT': "environment", - 'KEYWORD': "keyword", - 'SALESCHANNEL': "salesChannel", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -135,6 +98,47 @@ class AsyncCampaignsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -163,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -184,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -242,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -344,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report.py index 3a2c1fb3..d51cdbc3 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report.py +++ b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report.py @@ -55,44 +55,6 @@ class AsyncLineItemsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'LINEITEMID': "lineItemId", - 'LINEITEMNAME': "lineItemName", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - 'KEYWORD': "keyword", - 'PAGETYPENAME': "pageTypeName", - 'SALESCHANNEL': "salesChannel", - 'ENVIRONMENT': "environment", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -136,6 +98,47 @@ class AsyncLineItemsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -164,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -185,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -243,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -345,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-01/docs/AnalyticsApi.md b/sdks/retailmedia_2023-01/docs/AnalyticsApi.md index f63fd0ff..49b2c1ac 100644 --- a/sdks/retailmedia_2023-01/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2023-01/docs/AnalyticsApi.md @@ -61,22 +61,22 @@ with criteo_api_retailmedia_v2023_01.ApiClient(configuration) as api_client: data=AsyncCampaignsReportResource( type="type_example", attributes=AsyncCampaignsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -174,22 +174,22 @@ with criteo_api_retailmedia_v2023_01.ApiClient(configuration) as api_client: data=AsyncLineItemsReportResource( type="type_example", attributes=AsyncLineItemsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", diff --git a/sdks/retailmedia_2023-01/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2023-01/docs/AsyncCampaignsReport.md index 04625e77..21dd57bd 100644 --- a/sdks/retailmedia_2023-01/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2023-01/docs/AsyncCampaignsReport.md @@ -1,22 +1,22 @@ # AsyncCampaignsReport -Campaign report body request +Async Campaigns report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Campaign ids to report on | [optional] +**id** | **str, none_type** | Campaign id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-01/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2023-01/docs/AsyncLineItemsReport.md index 223e1c26..ccb01090 100644 --- a/sdks/retailmedia_2023-01/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2023-01/docs/AsyncLineItemsReport.md @@ -1,22 +1,22 @@ # AsyncLineItemsReport -Line Items report body request +Async Line Items report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Line Item ids to report on | [optional] +**id** | **str, none_type** | Line Item id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-01/setup.py b/sdks/retailmedia_2023-01/setup.py index 22dfa0c1..06c88795 100644 --- a/sdks/retailmedia_2023-01/setup.py +++ b/sdks/retailmedia_2023-01/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-retailmedia-sdk" -VERSION = "2023.01.0.240207" +VERSION = "2023.01.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-retailmedia-sdk==2023.01.0.240207 +pip install criteo-api-retailmedia-sdk==2023.01.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.01.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.01.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-04/README.md b/sdks/retailmedia_2023-04/README.md index 5561d925..87ef1921 100644 --- a/sdks/retailmedia_2023-04/README.md +++ b/sdks/retailmedia_2023-04/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2023.04.0.240207 +- Package version: 2023.04.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2023.04.0.240207 +pip install criteo-api-retailmedia-sdk==2023.04.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.04.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.04.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/__init__.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/__init__.py index a0965605..05b7a0b1 100644 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/__init__.py +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2023.04.0.240207" +__version__ = "2023.04.0.240404" # import ApiClient from criteo_api_retailmedia_v2023_04.api_client import ApiClient diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/api_client.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/api_client.py index a82bd3cd..6113065e 100644 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/api_client.py +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.04.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2023.04.0.240404/python' def __enter__(self): return self diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/configuration.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/configuration.py index e9ad6464..be198717 100644 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/configuration.py +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2023-04\n"\ - "SDK Package Version: 2023.04.0.240207".\ + "SDK Package Version: 2023.04.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/async_campaigns_report.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/async_campaigns_report.py index 638c56f7..3d190113 100644 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/async_campaigns_report.py +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/async_campaigns_report.py @@ -55,43 +55,6 @@ class AsyncCampaignsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'CPM': "cpm", - 'ROAS': "roas", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ENVIRONMENT': "environment", - 'KEYWORD': "keyword", - 'SALESCHANNEL': "salesChannel", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -135,6 +98,47 @@ class AsyncCampaignsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -163,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -184,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -242,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -344,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/async_line_items_report.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/async_line_items_report.py index 3cb6d158..62138df9 100644 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/async_line_items_report.py +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/async_line_items_report.py @@ -55,44 +55,6 @@ class AsyncLineItemsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'LINEITEMID': "lineItemId", - 'LINEITEMNAME': "lineItemName", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - 'KEYWORD': "keyword", - 'PAGETYPENAME': "pageTypeName", - 'SALESCHANNEL': "salesChannel", - 'ENVIRONMENT': "environment", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -136,6 +98,47 @@ class AsyncLineItemsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -164,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -185,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -243,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -345,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-04/docs/AnalyticsApi.md b/sdks/retailmedia_2023-04/docs/AnalyticsApi.md index 96d9d412..939584cb 100644 --- a/sdks/retailmedia_2023-04/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2023-04/docs/AnalyticsApi.md @@ -61,22 +61,22 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: data=AsyncCampaignsReportResource( type="type_example", attributes=AsyncCampaignsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -174,22 +174,22 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: data=AsyncLineItemsReportResource( type="type_example", attributes=AsyncLineItemsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", diff --git a/sdks/retailmedia_2023-04/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2023-04/docs/AsyncCampaignsReport.md index 04625e77..21dd57bd 100644 --- a/sdks/retailmedia_2023-04/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2023-04/docs/AsyncCampaignsReport.md @@ -1,22 +1,22 @@ # AsyncCampaignsReport -Campaign report body request +Async Campaigns report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Campaign ids to report on | [optional] +**id** | **str, none_type** | Campaign id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-04/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2023-04/docs/AsyncLineItemsReport.md index 223e1c26..ccb01090 100644 --- a/sdks/retailmedia_2023-04/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2023-04/docs/AsyncLineItemsReport.md @@ -1,22 +1,22 @@ # AsyncLineItemsReport -Line Items report body request +Async Line Items report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Line Item ids to report on | [optional] +**id** | **str, none_type** | Line Item id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-04/setup.py b/sdks/retailmedia_2023-04/setup.py index 611049eb..9fe48064 100644 --- a/sdks/retailmedia_2023-04/setup.py +++ b/sdks/retailmedia_2023-04/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-retailmedia-sdk" -VERSION = "2023.04.0.240207" +VERSION = "2023.04.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-retailmedia-sdk==2023.04.0.240207 +pip install criteo-api-retailmedia-sdk==2023.04.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.04.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.04.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-07/README.md b/sdks/retailmedia_2023-07/README.md index 3a230f9d..fba8eab5 100644 --- a/sdks/retailmedia_2023-07/README.md +++ b/sdks/retailmedia_2023-07/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2023.07.0.240207 +- Package version: 2023.07.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2023.07.0.240207 +pip install criteo-api-retailmedia-sdk==2023.07.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/__init__.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/__init__.py index cd6df4e2..f3f2afe1 100644 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/__init__.py +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2023.07.0.240207" +__version__ = "2023.07.0.240404" # import ApiClient from criteo_api_retailmedia_v2023_07.api_client import ApiClient diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/api_client.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/api_client.py index 4577cc57..3430933d 100644 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/api_client.py +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.07.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2023.07.0.240404/python' def __enter__(self): return self diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/configuration.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/configuration.py index 7838ccc8..d57af5a6 100644 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/configuration.py +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2023-07\n"\ - "SDK Package Version: 2023.07.0.240207".\ + "SDK Package Version: 2023.07.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/async_campaigns_report.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/async_campaigns_report.py index 9f551cfb..90c2bf8f 100644 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/async_campaigns_report.py +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/async_campaigns_report.py @@ -55,43 +55,6 @@ class AsyncCampaignsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'CPM': "cpm", - 'ROAS': "roas", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ENVIRONMENT': "environment", - 'KEYWORD': "keyword", - 'SALESCHANNEL': "salesChannel", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -135,6 +98,47 @@ class AsyncCampaignsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -163,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -184,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -242,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -344,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/async_line_items_report.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/async_line_items_report.py index da33a5b3..a3b1bbf0 100644 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/async_line_items_report.py +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/async_line_items_report.py @@ -55,44 +55,6 @@ class AsyncLineItemsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'LINEITEMID': "lineItemId", - 'LINEITEMNAME': "lineItemName", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - 'KEYWORD': "keyword", - 'PAGETYPENAME': "pageTypeName", - 'SALESCHANNEL': "salesChannel", - 'ENVIRONMENT': "environment", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -136,6 +98,47 @@ class AsyncLineItemsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -164,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -185,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -243,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -345,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-07/docs/AnalyticsApi.md b/sdks/retailmedia_2023-07/docs/AnalyticsApi.md index 2335b714..fcbe29bd 100644 --- a/sdks/retailmedia_2023-07/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2023-07/docs/AnalyticsApi.md @@ -61,22 +61,22 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: data=AsyncCampaignsReportResource( type="type_example", attributes=AsyncCampaignsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -174,22 +174,22 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: data=AsyncLineItemsReportResource( type="type_example", attributes=AsyncLineItemsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", diff --git a/sdks/retailmedia_2023-07/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2023-07/docs/AsyncCampaignsReport.md index 04625e77..21dd57bd 100644 --- a/sdks/retailmedia_2023-07/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2023-07/docs/AsyncCampaignsReport.md @@ -1,22 +1,22 @@ # AsyncCampaignsReport -Campaign report body request +Async Campaigns report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Campaign ids to report on | [optional] +**id** | **str, none_type** | Campaign id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-07/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2023-07/docs/AsyncLineItemsReport.md index 223e1c26..ccb01090 100644 --- a/sdks/retailmedia_2023-07/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2023-07/docs/AsyncLineItemsReport.md @@ -1,22 +1,22 @@ # AsyncLineItemsReport -Line Items report body request +Async Line Items report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Line Item ids to report on | [optional] +**id** | **str, none_type** | Line Item id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-07/setup.py b/sdks/retailmedia_2023-07/setup.py index 6ad22d11..fbb7aa1d 100644 --- a/sdks/retailmedia_2023-07/setup.py +++ b/sdks/retailmedia_2023-07/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-retailmedia-sdk" -VERSION = "2023.07.0.240207" +VERSION = "2023.07.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-retailmedia-sdk==2023.07.0.240207 +pip install criteo-api-retailmedia-sdk==2023.07.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-10/README.md b/sdks/retailmedia_2023-10/README.md index 142c3720..1cbb2672 100644 --- a/sdks/retailmedia_2023-10/README.md +++ b/sdks/retailmedia_2023-10/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2023.10.0.240207 +- Package version: 2023.10.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2023.10.0.240207 +pip install criteo-api-retailmedia-sdk==2023.10.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.10.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.10.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/__init__.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/__init__.py index 6d1fc33a..7d0d9bd1 100644 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/__init__.py +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2023.10.0.240207" +__version__ = "2023.10.0.240404" # import ApiClient from criteo_api_retailmedia_v2023_10.api_client import ApiClient diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/api_client.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/api_client.py index 1353e4ba..7f7e16a6 100644 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/api_client.py +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.10.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2023.10.0.240404/python' def __enter__(self): return self diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/configuration.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/configuration.py index 8fa8a0ba..c7c639d0 100644 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/configuration.py +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2023-10\n"\ - "SDK Package Version: 2023.10.0.240207".\ + "SDK Package Version: 2023.10.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_campaigns_report.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_campaigns_report.py index b252f720..d5318b17 100644 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_campaigns_report.py +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_campaigns_report.py @@ -55,43 +55,6 @@ class AsyncCampaignsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'CPM': "cpm", - 'ROAS': "roas", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ENVIRONMENT': "environment", - 'KEYWORD': "keyword", - 'SALESCHANNEL': "salesChannel", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -135,6 +98,47 @@ class AsyncCampaignsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -163,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -184,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -242,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -344,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_line_items_report.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_line_items_report.py index 01463d58..10a07c51 100644 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_line_items_report.py +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_line_items_report.py @@ -55,44 +55,6 @@ class AsyncLineItemsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'LINEITEMID': "lineItemId", - 'LINEITEMNAME': "lineItemName", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - 'KEYWORD': "keyword", - 'PAGETYPENAME': "pageTypeName", - 'SALESCHANNEL': "salesChannel", - 'ENVIRONMENT': "environment", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -136,6 +98,47 @@ class AsyncLineItemsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -164,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -185,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -243,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -345,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_revenue_report.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_revenue_report.py index 554d0adf..ea3afac0 100644 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_revenue_report.py +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/async_revenue_report.py @@ -68,38 +68,6 @@ class AsyncRevenueReport(ModelNormal): 'AUCTION': "auction", 'PREFERRED': "preferred", }, - ('metrics',): { - 'None': None, - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'OPENAUCTIONREVENUE': "openAuctionRevenue", - 'PREFERREDDEALSREVENUE': "preferredDealsRevenue", - 'AVGCPC': "avgCpc", - 'AVGCPM': "avgCpm", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'ACCOUNTID': "accountId", - 'ACCOUNTNAME': "accountName", - 'ENVIRONMENT': "environment", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ADVPRODUCTNAME': "advProductName", - 'ADVPRODUCTGTIN': "advProductGtin", - 'ADVPRODUCTMPN': "advProductMpn", - 'ADVPRODUCTID': "advProductId", - }, ('format',): { 'None': None, 'JSON': "json", @@ -143,6 +111,37 @@ class AsyncRevenueReport(ModelNormal): 'OFFLINE': "offline", 'ONLINE': "online", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'ENVIRONMENT': "environment", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'PAGETYPENAME': "pageTypeName", + 'ADVPRODUCTNAME': "advProductName", + 'ADVPRODUCTGTIN': "advProductGtin", + 'ADVPRODUCTMPN': "advProductMpn", + 'ADVPRODUCTID': "advProductId", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'SALES': "sales", + 'UNITS': "units", + 'CPO': "cpo", + 'ROAS': "roas", + 'OPENAUCTIONREVENUE': "openAuctionRevenue", + 'PREFERREDDEALSREVENUE': "preferredDealsRevenue", + 'AVGCPC': "avgCpc", + 'AVGCPM': "avgCpm", + }, } validations = { @@ -171,12 +170,10 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'report_type': (str, none_type,), # noqa: E501 - 'revenue_type': (str, none_type,), # noqa: E501 'ids': ([str], none_type,), # noqa: E501 'id': (str, none_type,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'report_type': (str, none_type,), # noqa: E501 + 'revenue_type': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'sold_by': (str, none_type,), # noqa: E501 'campaign_sub_type': (str, none_type,), # noqa: E501 @@ -184,6 +181,8 @@ def openapi_types(): 'view_attribution_window': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -195,12 +194,10 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'report_type': 'reportType', # noqa: E501 - 'revenue_type': 'revenueType', # noqa: E501 'ids': 'ids', # noqa: E501 'id': 'id', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'report_type': 'reportType', # noqa: E501 + 'revenue_type': 'revenueType', # noqa: E501 'format': 'format', # noqa: E501 'sold_by': 'soldBy', # noqa: E501 'campaign_sub_type': 'campaignSubType', # noqa: E501 @@ -208,6 +205,8 @@ def discriminator(): 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -256,12 +255,10 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 report_type (str, none_type): Type of report. [optional] # noqa: E501 revenue_type (str, none_type): Type of revenue. [optional] # noqa: E501 - ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501 - id (str, none_type): List of campaign Id to filter. [optional] # noqa: E501 - metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] # noqa: E501 sold_by (str, none_type): Filter on the seller: indirect, direct or private market. [optional] # noqa: E501 campaign_sub_type (str, none_type): Filter on campaign subType : Auction and Preferred Deals or Lockout campaign. [optional] # noqa: E501 @@ -269,6 +266,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -361,12 +360,10 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 report_type (str, none_type): Type of report. [optional] # noqa: E501 revenue_type (str, none_type): Type of revenue. [optional] # noqa: E501 - ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501 - id (str, none_type): List of campaign Id to filter. [optional] # noqa: E501 - metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] # noqa: E501 sold_by (str, none_type): Filter on the seller: indirect, direct or private market. [optional] # noqa: E501 campaign_sub_type (str, none_type): Filter on campaign subType : Auction and Preferred Deals or Lockout campaign. [optional] # noqa: E501 @@ -374,6 +371,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2023-10/docs/AnalyticsApi.md b/sdks/retailmedia_2023-10/docs/AnalyticsApi.md index c3d5ebe8..11c16d3c 100644 --- a/sdks/retailmedia_2023-10/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2023-10/docs/AnalyticsApi.md @@ -62,22 +62,22 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: data=AsyncCampaignsReportResource( type="type_example", attributes=AsyncCampaignsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -175,22 +175,22 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: data=AsyncLineItemsReportResource( type="type_example", attributes=AsyncLineItemsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -288,18 +288,12 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: data=AsyncRevenueReportResource( type="type_example", attributes=AsyncRevenueReport( - report_type="advertiser", - revenue_type="auction", ids=[ "ids_example", ], id="id_example", - metrics=[ - "clicks", - ], - dimensions=[ - "date", - ], + report_type="advertiser", + revenue_type="auction", format="json", sold_by="directSold", campaign_sub_type="auctionAndPreferred", @@ -307,6 +301,12 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: view_attribution_window="none", campaign_type="sponsoredProducts", sales_channel="offline", + dimensions=[ + "date", + ], + metrics=[ + "impressions", + ], start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", diff --git a/sdks/retailmedia_2023-10/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2023-10/docs/AsyncCampaignsReport.md index 04625e77..21dd57bd 100644 --- a/sdks/retailmedia_2023-10/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2023-10/docs/AsyncCampaignsReport.md @@ -1,22 +1,22 @@ # AsyncCampaignsReport -Campaign report body request +Async Campaigns report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Campaign ids to report on | [optional] +**id** | **str, none_type** | Campaign id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-10/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2023-10/docs/AsyncLineItemsReport.md index 223e1c26..ccb01090 100644 --- a/sdks/retailmedia_2023-10/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2023-10/docs/AsyncLineItemsReport.md @@ -1,22 +1,22 @@ # AsyncLineItemsReport -Line Items report body request +Async Line Items report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Line Item ids to report on | [optional] +**id** | **str, none_type** | Line Item id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-10/docs/AsyncRevenueReport.md b/sdks/retailmedia_2023-10/docs/AsyncRevenueReport.md index aead6936..53b4ca21 100644 --- a/sdks/retailmedia_2023-10/docs/AsyncRevenueReport.md +++ b/sdks/retailmedia_2023-10/docs/AsyncRevenueReport.md @@ -7,12 +7,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | +**ids** | **[str], none_type** | Campaign ids to report on | [optional] +**id** | **str, none_type** | Campaign id to report on | [optional] **report_type** | **str, none_type** | Type of report | [optional] **revenue_type** | **str, none_type** | Type of revenue | [optional] -**ids** | **[str], none_type** | List of campaign Ids to filter | [optional] -**id** | **str, none_type** | List of campaign Id to filter | [optional] -**metrics** | **[str], none_type** | List of Metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] **format** | **str, none_type** | Format of the output | [optional] **sold_by** | **str, none_type** | Filter on the seller: indirect, direct or private market | [optional] **campaign_sub_type** | **str, none_type** | Filter on campaign subType : Auction and Preferred Deals or Lockout campaign | [optional] @@ -20,6 +18,8 @@ Name | Type | Description | Notes **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2023-10/setup.py b/sdks/retailmedia_2023-10/setup.py index 4b99a979..bcea29aa 100644 --- a/sdks/retailmedia_2023-10/setup.py +++ b/sdks/retailmedia_2023-10/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-retailmedia-sdk" -VERSION = "2023.10.0.240207" +VERSION = "2023.10.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-retailmedia-sdk==2023.10.0.240207 +pip install criteo-api-retailmedia-sdk==2023.10.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.10.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.10.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2024-01/README.md b/sdks/retailmedia_2024-01/README.md index d5606bb9..3ef28b4b 100644 --- a/sdks/retailmedia_2024-01/README.md +++ b/sdks/retailmedia_2024-01/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 2024.01.0.240207 +- Package version: 2024.01.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2024.01.0.240207 +pip install criteo-api-retailmedia-sdk==2024.01.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.01.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.01.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/__init__.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/__init__.py index 1fa736cd..951e84b6 100644 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/__init__.py +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "2024.01.0.240207" +__version__ = "2024.01.0.240404" # import ApiClient from criteo_api_retailmedia_v2024_01.api_client import ApiClient diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/api_client.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/api_client.py index 70f7c6c4..d817f288 100644 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/api_client.py +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2024.01.0.240207/python' + self.user_agent = 'OpenAPI-Generator/2024.01.0.240404/python' def __enter__(self): return self diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/configuration.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/configuration.py index 14f8378c..09995b8c 100644 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/configuration.py +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2024-01\n"\ - "SDK Package Version: 2024.01.0.240207".\ + "SDK Package Version: 2024.01.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_campaigns_report.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_campaigns_report.py index 876089ca..77d464e9 100644 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_campaigns_report.py +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_campaigns_report.py @@ -55,43 +55,6 @@ class AsyncCampaignsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'CPM': "cpm", - 'ROAS': "roas", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ENVIRONMENT': "environment", - 'KEYWORD': "keyword", - 'SALESCHANNEL': "salesChannel", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -135,6 +98,47 @@ class AsyncCampaignsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -163,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -184,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -242,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -344,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_line_items_report.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_line_items_report.py index 497d7d67..8d63baa8 100644 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_line_items_report.py +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_line_items_report.py @@ -55,44 +55,6 @@ class AsyncLineItemsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'LINEITEMID': "lineItemId", - 'LINEITEMNAME': "lineItemName", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - 'KEYWORD': "keyword", - 'PAGETYPENAME': "pageTypeName", - 'SALESCHANNEL': "salesChannel", - 'ENVIRONMENT': "environment", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -136,6 +98,47 @@ class AsyncLineItemsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -164,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -185,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -243,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -345,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_revenue_report.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_revenue_report.py index e4c21027..2a86ea10 100644 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_revenue_report.py +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/async_revenue_report.py @@ -68,38 +68,6 @@ class AsyncRevenueReport(ModelNormal): 'AUCTION': "auction", 'PREFERRED': "preferred", }, - ('metrics',): { - 'None': None, - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'OPENAUCTIONREVENUE': "openAuctionRevenue", - 'PREFERREDDEALSREVENUE': "preferredDealsRevenue", - 'AVGCPC': "avgCpc", - 'AVGCPM': "avgCpm", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'ACCOUNTID': "accountId", - 'ACCOUNTNAME': "accountName", - 'ENVIRONMENT': "environment", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ADVPRODUCTNAME': "advProductName", - 'ADVPRODUCTGTIN': "advProductGtin", - 'ADVPRODUCTMPN': "advProductMpn", - 'ADVPRODUCTID': "advProductId", - }, ('format',): { 'None': None, 'JSON': "json", @@ -143,6 +111,37 @@ class AsyncRevenueReport(ModelNormal): 'OFFLINE': "offline", 'ONLINE': "online", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'ENVIRONMENT': "environment", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'PAGETYPENAME': "pageTypeName", + 'ADVPRODUCTNAME': "advProductName", + 'ADVPRODUCTGTIN': "advProductGtin", + 'ADVPRODUCTMPN': "advProductMpn", + 'ADVPRODUCTID': "advProductId", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'SALES': "sales", + 'UNITS': "units", + 'CPO': "cpo", + 'ROAS': "roas", + 'OPENAUCTIONREVENUE': "openAuctionRevenue", + 'PREFERREDDEALSREVENUE': "preferredDealsRevenue", + 'AVGCPC': "avgCpc", + 'AVGCPM': "avgCpm", + }, } validations = { @@ -171,12 +170,10 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'report_type': (str, none_type,), # noqa: E501 - 'revenue_type': (str, none_type,), # noqa: E501 'ids': ([str], none_type,), # noqa: E501 'id': (str, none_type,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'report_type': (str, none_type,), # noqa: E501 + 'revenue_type': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'sold_by': (str, none_type,), # noqa: E501 'campaign_sub_type': (str, none_type,), # noqa: E501 @@ -184,6 +181,8 @@ def openapi_types(): 'view_attribution_window': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -195,12 +194,10 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'report_type': 'reportType', # noqa: E501 - 'revenue_type': 'revenueType', # noqa: E501 'ids': 'ids', # noqa: E501 'id': 'id', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'report_type': 'reportType', # noqa: E501 + 'revenue_type': 'revenueType', # noqa: E501 'format': 'format', # noqa: E501 'sold_by': 'soldBy', # noqa: E501 'campaign_sub_type': 'campaignSubType', # noqa: E501 @@ -208,6 +205,8 @@ def discriminator(): 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -256,12 +255,10 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 report_type (str, none_type): Type of report. [optional] # noqa: E501 revenue_type (str, none_type): Type of revenue. [optional] # noqa: E501 - ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501 - id (str, none_type): List of campaign Id to filter. [optional] # noqa: E501 - metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] # noqa: E501 sold_by (str, none_type): Filter on the seller: indirect, direct or private market. [optional] # noqa: E501 campaign_sub_type (str, none_type): Filter on campaign subType : Auction and Preferred Deals or Lockout campaign. [optional] # noqa: E501 @@ -269,6 +266,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -361,12 +360,10 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 report_type (str, none_type): Type of report. [optional] # noqa: E501 revenue_type (str, none_type): Type of revenue. [optional] # noqa: E501 - ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501 - id (str, none_type): List of campaign Id to filter. [optional] # noqa: E501 - metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] # noqa: E501 sold_by (str, none_type): Filter on the seller: indirect, direct or private market. [optional] # noqa: E501 campaign_sub_type (str, none_type): Filter on campaign subType : Auction and Preferred Deals or Lockout campaign. [optional] # noqa: E501 @@ -374,6 +371,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_2024-01/docs/AnalyticsApi.md b/sdks/retailmedia_2024-01/docs/AnalyticsApi.md index 01d2a43b..e0c865ef 100644 --- a/sdks/retailmedia_2024-01/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2024-01/docs/AnalyticsApi.md @@ -62,22 +62,22 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: data=AsyncCampaignsReportResource( type="type_example", attributes=AsyncCampaignsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -175,22 +175,22 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: data=AsyncLineItemsReportResource( type="type_example", attributes=AsyncLineItemsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -288,18 +288,12 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: data=AsyncRevenueReportResource( type="type_example", attributes=AsyncRevenueReport( - report_type="advertiser", - revenue_type="auction", ids=[ "ids_example", ], id="id_example", - metrics=[ - "clicks", - ], - dimensions=[ - "date", - ], + report_type="advertiser", + revenue_type="auction", format="json", sold_by="directSold", campaign_sub_type="auctionAndPreferred", @@ -307,6 +301,12 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: view_attribution_window="none", campaign_type="sponsoredProducts", sales_channel="offline", + dimensions=[ + "date", + ], + metrics=[ + "impressions", + ], start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", diff --git a/sdks/retailmedia_2024-01/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2024-01/docs/AsyncCampaignsReport.md index 04625e77..21dd57bd 100644 --- a/sdks/retailmedia_2024-01/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2024-01/docs/AsyncCampaignsReport.md @@ -1,22 +1,22 @@ # AsyncCampaignsReport -Campaign report body request +Async Campaigns report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Campaign ids to report on | [optional] +**id** | **str, none_type** | Campaign id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2024-01/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2024-01/docs/AsyncLineItemsReport.md index 223e1c26..ccb01090 100644 --- a/sdks/retailmedia_2024-01/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2024-01/docs/AsyncLineItemsReport.md @@ -1,22 +1,22 @@ # AsyncLineItemsReport -Line Items report body request +Async Line Items report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Line Item ids to report on | [optional] +**id** | **str, none_type** | Line Item id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2024-01/docs/AsyncRevenueReport.md b/sdks/retailmedia_2024-01/docs/AsyncRevenueReport.md index aead6936..53b4ca21 100644 --- a/sdks/retailmedia_2024-01/docs/AsyncRevenueReport.md +++ b/sdks/retailmedia_2024-01/docs/AsyncRevenueReport.md @@ -7,12 +7,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | +**ids** | **[str], none_type** | Campaign ids to report on | [optional] +**id** | **str, none_type** | Campaign id to report on | [optional] **report_type** | **str, none_type** | Type of report | [optional] **revenue_type** | **str, none_type** | Type of revenue | [optional] -**ids** | **[str], none_type** | List of campaign Ids to filter | [optional] -**id** | **str, none_type** | List of campaign Id to filter | [optional] -**metrics** | **[str], none_type** | List of Metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] **format** | **str, none_type** | Format of the output | [optional] **sold_by** | **str, none_type** | Filter on the seller: indirect, direct or private market | [optional] **campaign_sub_type** | **str, none_type** | Filter on campaign subType : Auction and Preferred Deals or Lockout campaign | [optional] @@ -20,6 +18,8 @@ Name | Type | Description | Notes **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_2024-01/setup.py b/sdks/retailmedia_2024-01/setup.py index 744c23f3..aad28d40 100644 --- a/sdks/retailmedia_2024-01/setup.py +++ b/sdks/retailmedia_2024-01/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-retailmedia-sdk" -VERSION = "2024.01.0.240207" +VERSION = "2024.01.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-retailmedia-sdk==2024.01.0.240207 +pip install criteo-api-retailmedia-sdk==2024.01.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.01.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.01.0.240404`) Then import the package: ```python diff --git a/sdks/retailmedia_preview/.openapi-generator/FILES b/sdks/retailmedia_preview/.openapi-generator/FILES index cac54ba5..da0c4c9c 100644 --- a/sdks/retailmedia_preview/.openapi-generator/FILES +++ b/sdks/retailmedia_preview/.openapi-generator/FILES @@ -9,6 +9,7 @@ criteo_api_retailmedia_preview/api/accounts_api.py criteo_api_retailmedia_preview/api/analytics_api.py criteo_api_retailmedia_preview/api/audience_api.py criteo_api_retailmedia_preview/api/campaign_api.py +criteo_api_retailmedia_preview/api/catalog_api.py criteo_api_retailmedia_preview/api/gateway_api.py criteo_api_retailmedia_preview/api_client.py criteo_api_retailmedia_preview/api_client_builder.py @@ -23,6 +24,9 @@ criteo_api_retailmedia_preview/model/__init__.py criteo_api_retailmedia_preview/model/application_summary_model.py criteo_api_retailmedia_preview/model/application_summary_model_resource.py criteo_api_retailmedia_preview/model/application_summary_model_response.py +criteo_api_retailmedia_preview/model/async_accounts_report.py +criteo_api_retailmedia_preview/model/async_accounts_report_request.py +criteo_api_retailmedia_preview/model/async_accounts_report_resource.py criteo_api_retailmedia_preview/model/async_campaigns_report.py criteo_api_retailmedia_preview/model/async_campaigns_report_request.py criteo_api_retailmedia_preview/model/async_campaigns_report_resource.py @@ -30,6 +34,7 @@ criteo_api_retailmedia_preview/model/async_line_items_report.py criteo_api_retailmedia_preview/model/async_line_items_report_request.py criteo_api_retailmedia_preview/model/async_line_items_report_resource.py criteo_api_retailmedia_preview/model/async_report_response.py +criteo_api_retailmedia_preview/model/batch_accepted_response.py criteo_api_retailmedia_preview/model/brand.py criteo_api_retailmedia_preview/model/brand_preview.py criteo_api_retailmedia_preview/model/brand_preview_list_response.py @@ -38,73 +43,89 @@ criteo_api_retailmedia_preview/model/campaign_daily_budget_override.py criteo_api_retailmedia_preview/model/campaign_monthly_budget_override.py criteo_api_retailmedia_preview/model/category.py criteo_api_retailmedia_preview/model/category202204.py -criteo_api_retailmedia_preview/model/choice_option.py -criteo_api_retailmedia_preview/model/choice_variable_specification.py -criteo_api_retailmedia_preview/model/choice_variable_value.py -criteo_api_retailmedia_preview/model/color_variable_value.py +criteo_api_retailmedia_preview/model/change_details.py criteo_api_retailmedia_preview/model/common_error.py criteo_api_retailmedia_preview/model/common_problem.py criteo_api_retailmedia_preview/model/common_warning.py criteo_api_retailmedia_preview/model/cpc_rate_card_preview.py criteo_api_retailmedia_preview/model/cpc_rate_card_preview_response.py -criteo_api_retailmedia_preview/model/creative202210.py -criteo_api_retailmedia_preview/model/creative202210_list_response.py -criteo_api_retailmedia_preview/model/creative202210_response.py -criteo_api_retailmedia_preview/model/creative_create_model202207.py -criteo_api_retailmedia_preview/model/creative_update_model202207.py +criteo_api_retailmedia_preview/model/custom_attribute.py criteo_api_retailmedia_preview/model/daily_line_item_budget_override.py criteo_api_retailmedia_preview/model/export_report_column.py criteo_api_retailmedia_preview/model/export_report_meta_data.py criteo_api_retailmedia_preview/model/external_account.py criteo_api_retailmedia_preview/model/external_brand.py -criteo_api_retailmedia_preview/model/external_catalog_request_preview.py -criteo_api_retailmedia_preview/model/external_catalog_status.py +criteo_api_retailmedia_preview/model/external_line_item_capping_v2.py +criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py +criteo_api_retailmedia_preview/model/external_line_item_page_v2.py +criteo_api_retailmedia_preview/model/external_preferred_line_item_create_model_v2.py +criteo_api_retailmedia_preview/model/external_preferred_line_item_update_model_v2.py +criteo_api_retailmedia_preview/model/external_preferred_line_item_v2.py criteo_api_retailmedia_preview/model/external_product_button_request.py criteo_api_retailmedia_preview/model/external_product_button_response.py criteo_api_retailmedia_preview/model/external_retailer.py -criteo_api_retailmedia_preview/model/files_variable_value.py -criteo_api_retailmedia_preview/model/files_variables_specification.py +criteo_api_retailmedia_preview/model/fail_response.py criteo_api_retailmedia_preview/model/grant_consent_input.py criteo_api_retailmedia_preview/model/grant_consent_model.py criteo_api_retailmedia_preview/model/grant_consent_model_value_resource.py -criteo_api_retailmedia_preview/model/hyperlink_variable_value.py criteo_api_retailmedia_preview/model/input_keywords.py +criteo_api_retailmedia_preview/model/input_resource_of_preferred_line_item_create_model_v2.py +criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture.py +criteo_api_retailmedia_preview/model/installment.py criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_account_and_account.py criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_brand_and_brand.py -criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py -criteo_api_retailmedia_preview/model/json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py -criteo_api_retailmedia_preview/model/json_api_request_of_catalog_request_preview.py -criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py criteo_api_retailmedia_preview/model/json_api_single_response_of_line_item_bid_multipliers.py criteo_api_retailmedia_preview/model/keywords.py criteo_api_retailmedia_preview/model/line_item_bid_multipliers.py criteo_api_retailmedia_preview/model/line_item_bid_multipliers_request.py criteo_api_retailmedia_preview/model/line_item_bid_multipliers_response.py criteo_api_retailmedia_preview/model/line_item_budget_overrides.py +criteo_api_retailmedia_preview/model/loyalty_points.py +criteo_api_retailmedia_preview/model/metadata.py criteo_api_retailmedia_preview/model/monthly_line_item_budeget_override.py criteo_api_retailmedia_preview/model/page_metadata.py -criteo_api_retailmedia_preview/model/page_type_environment.py +criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py criteo_api_retailmedia_preview/model/placement_preview.py criteo_api_retailmedia_preview/model/placement_preview_list_response.py +criteo_api_retailmedia_preview/model/preferred_line_item_create_model_v2_request.py +criteo_api_retailmedia_preview/model/preferred_line_item_update_model_v2_request.py +criteo_api_retailmedia_preview/model/preferred_line_item_v2_paged_list_response.py +criteo_api_retailmedia_preview/model/preferred_line_item_v2_response.py +criteo_api_retailmedia_preview/model/price.py criteo_api_retailmedia_preview/model/problem_details.py +criteo_api_retailmedia_preview/model/product.py criteo_api_retailmedia_preview/model/product_button_list_request.py criteo_api_retailmedia_preview/model/product_button_list_response.py criteo_api_retailmedia_preview/model/product_button_request.py +criteo_api_retailmedia_preview/model/product_importer_error.py +criteo_api_retailmedia_preview/model/product_importer_warning.py +criteo_api_retailmedia_preview/model/product_shipping.py +criteo_api_retailmedia_preview/model/product_shipping_dimension.py +criteo_api_retailmedia_preview/model/product_shipping_weight.py +criteo_api_retailmedia_preview/model/product_tax.py +criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py +criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py +criteo_api_retailmedia_preview/model/products_custom_batch_request.py +criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py criteo_api_retailmedia_preview/model/recommended_keywords_result.py criteo_api_retailmedia_preview/model/report_data_response_resource.py +criteo_api_retailmedia_preview/model/report_detail_error.py +criteo_api_retailmedia_preview/model/report_detail_errors.py +criteo_api_retailmedia_preview/model/report_ok_response.py criteo_api_retailmedia_preview/model/report_outcome.py criteo_api_retailmedia_preview/model/report_response.py criteo_api_retailmedia_preview/model/resource_collection_outcome_of_sku_search_result.py criteo_api_retailmedia_preview/model/resource_of_brand_preview.py criteo_api_retailmedia_preview/model/resource_of_cpc_rate_card_preview.py -criteo_api_retailmedia_preview/model/resource_of_creative202210.py criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers.py criteo_api_retailmedia_preview/model/resource_of_placement_preview.py +criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_update_model_v2.py +criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py criteo_api_retailmedia_preview/model/resource_of_product_button_request.py criteo_api_retailmedia_preview/model/resource_of_product_button_response.py criteo_api_retailmedia_preview/model/resource_of_retail_media_account.py @@ -116,10 +137,10 @@ criteo_api_retailmedia_preview/model/resource_of_sku_search_request_slim_v2_prev criteo_api_retailmedia_preview/model/resource_of_sku_search_result.py criteo_api_retailmedia_preview/model/resource_of_sku_slim_data_preview.py criteo_api_retailmedia_preview/model/resource_of_sku_slim_data_v2.py -criteo_api_retailmedia_preview/model/resource_of_template.py criteo_api_retailmedia_preview/model/resource_outcome_of_retail_media_account.py criteo_api_retailmedia_preview/model/retail_media_account.py criteo_api_retailmedia_preview/model/retail_media_brand_account_creation.py +criteo_api_retailmedia_preview/model/retail_media_brands.py criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keyword_model.py criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model.py criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model_request.py @@ -150,7 +171,6 @@ criteo_api_retailmedia_preview/model/rm_legacy_audience_user_behavior_details_v2 criteo_api_retailmedia_preview/model/rm_legacy_segment_customer_list.py criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v1.py criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v2.py -criteo_api_retailmedia_preview/model/section.py criteo_api_retailmedia_preview/model/seller_preview.py criteo_api_retailmedia_preview/model/seller_preview_response.py criteo_api_retailmedia_preview/model/sku_data_preview.py @@ -179,22 +199,20 @@ criteo_api_retailmedia_preview/model/sync_campaigns_report_resource.py criteo_api_retailmedia_preview/model/sync_line_items_report.py criteo_api_retailmedia_preview/model/sync_line_items_report_request.py criteo_api_retailmedia_preview/model/sync_line_items_report_resource.py -criteo_api_retailmedia_preview/model/template.py -criteo_api_retailmedia_preview/model/template_list_response.py -criteo_api_retailmedia_preview/model/template_response.py -criteo_api_retailmedia_preview/model/template_variable.py -criteo_api_retailmedia_preview/model/template_variable_value.py -criteo_api_retailmedia_preview/model/text_variable_specification.py -criteo_api_retailmedia_preview/model/text_variable_value.py -criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_int64.py +criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_retail_media_seller.py criteo_api_retailmedia_preview/model/value_resource_input_of_campaign_budget_overrides.py criteo_api_retailmedia_preview/model/value_resource_input_of_line_item_budget_overrides.py +criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py +criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py +criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py criteo_api_retailmedia_preview/model/value_resource_of_campaign_budget_overrides.py -criteo_api_retailmedia_preview/model/value_resource_of_int64.py criteo_api_retailmedia_preview/model/value_resource_of_line_item_budget_overrides.py criteo_api_retailmedia_preview/model/value_resource_of_recommended_keywords_result.py +criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py +criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brands.py criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller.py +criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py criteo_api_retailmedia_preview/model/value_resource_outcome_of_campaign_budget_overrides.py criteo_api_retailmedia_preview/model/value_resource_outcome_of_line_item_budget_overrides.py criteo_api_retailmedia_preview/model/value_resource_outcome_of_recommended_keywords_result.py @@ -206,6 +224,9 @@ docs/AnalyticsApi.md docs/ApplicationSummaryModel.md docs/ApplicationSummaryModelResource.md docs/ApplicationSummaryModelResponse.md +docs/AsyncAccountsReport.md +docs/AsyncAccountsReportRequest.md +docs/AsyncAccountsReportResource.md docs/AsyncCampaignsReport.md docs/AsyncCampaignsReportRequest.md docs/AsyncCampaignsReportResource.md @@ -214,6 +235,7 @@ docs/AsyncLineItemsReportRequest.md docs/AsyncLineItemsReportResource.md docs/AsyncReportResponse.md docs/AudienceApi.md +docs/BatchAcceptedResponse.md docs/Brand.md docs/BrandPreview.md docs/BrandPreviewListResponse.md @@ -221,76 +243,93 @@ docs/CampaignApi.md docs/CampaignBudgetOverrides.md docs/CampaignDailyBudgetOverride.md docs/CampaignMonthlyBudgetOverride.md +docs/CatalogApi.md docs/Category.md docs/Category202204.md -docs/ChoiceOption.md -docs/ChoiceVariableSpecification.md -docs/ChoiceVariableValue.md -docs/ColorVariableValue.md +docs/ChangeDetails.md docs/CommonError.md docs/CommonProblem.md docs/CommonWarning.md docs/CpcRateCardPreview.md docs/CpcRateCardPreviewResponse.md -docs/Creative202210.md -docs/Creative202210ListResponse.md -docs/Creative202210Response.md -docs/CreativeCreateModel202207.md -docs/CreativeUpdateModel202207.md +docs/CustomAttribute.md docs/DailyLineItemBudgetOverride.md docs/ExportReportColumn.md docs/ExportReportMetaData.md docs/ExternalAccount.md docs/ExternalBrand.md -docs/ExternalCatalogRequestPreview.md -docs/ExternalCatalogStatus.md +docs/ExternalLineItemCappingV2.md +docs/ExternalLineItemPageCategoryV2.md +docs/ExternalLineItemPageV2.md +docs/ExternalPreferredLineItemCreateModelV2.md +docs/ExternalPreferredLineItemUpdateModelV2.md +docs/ExternalPreferredLineItemV2.md docs/ExternalProductButtonRequest.md docs/ExternalProductButtonResponse.md docs/ExternalRetailer.md -docs/FilesVariableValue.md -docs/FilesVariablesSpecification.md +docs/FailResponse.md docs/GatewayApi.md docs/GrantConsentInput.md docs/GrantConsentModel.md docs/GrantConsentModelValueResource.md -docs/HyperlinkVariableValue.md docs/InputKeywords.md +docs/InputResourceOfPreferredLineItemCreateModelV2.md +docs/InsertionOrderHistoryChangeDataCapture.md +docs/Installment.md docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md -docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md -docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview.md docs/JsonApiPageResponseOfAccount.md docs/JsonApiPageResponseOfBrand.md docs/JsonApiPageResponseOfRetailer.md -docs/JsonApiRequestOfCatalogRequestPreview.md -docs/JsonApiSingleResponseOfCatalogStatus.md docs/JsonApiSingleResponseOfLineItemBidMultipliers.md docs/Keywords.md docs/LineItemBidMultipliers.md docs/LineItemBidMultipliersRequest.md docs/LineItemBidMultipliersResponse.md docs/LineItemBudgetOverrides.md +docs/LoyaltyPoints.md +docs/Metadata.md docs/MonthlyLineItemBudegetOverride.md docs/PageMetadata.md -docs/PageTypeEnvironment.md +docs/PageOfInsertionOrderHistoryChangeDataCapture.md docs/PlacementPreview.md docs/PlacementPreviewListResponse.md +docs/PreferredLineItemCreateModelV2Request.md +docs/PreferredLineItemUpdateModelV2Request.md +docs/PreferredLineItemV2PagedListResponse.md +docs/PreferredLineItemV2Response.md +docs/Price.md docs/ProblemDetails.md +docs/Product.md docs/ProductButtonListRequest.md docs/ProductButtonListResponse.md docs/ProductButtonRequest.md +docs/ProductImporterError.md +docs/ProductImporterWarning.md +docs/ProductShipping.md +docs/ProductShippingDimension.md +docs/ProductShippingWeight.md +docs/ProductTax.md +docs/ProductUnitPricingBaseMeasure.md +docs/ProductUnitPricingMeasure.md +docs/ProductsCustomBatchRequest.md +docs/ProductsCustomBatchRequestEntry.md docs/RecommendedKeywordsResult.md docs/ReportDataResponseResource.md +docs/ReportDetailError.md +docs/ReportDetailErrors.md +docs/ReportOkResponse.md docs/ReportOutcome.md docs/ReportResponse.md docs/ResourceCollectionOutcomeOfSkuSearchResult.md docs/ResourceOfBrandPreview.md docs/ResourceOfCpcRateCardPreview.md -docs/ResourceOfCreative202210.md docs/ResourceOfLineItemBidMultipliers.md docs/ResourceOfPlacementPreview.md +docs/ResourceOfPreferredLineItemUpdateModelV2.md +docs/ResourceOfPreferredLineItemV2.md docs/ResourceOfProductButtonRequest.md docs/ResourceOfProductButtonResponse.md docs/ResourceOfRetailMediaAccount.md @@ -302,10 +341,10 @@ docs/ResourceOfSkuSearchRequestSlimV2Preview.md docs/ResourceOfSkuSearchResult.md docs/ResourceOfSkuSlimDataPreview.md docs/ResourceOfSkuSlimDataV2.md -docs/ResourceOfTemplate.md docs/ResourceOutcomeOfRetailMediaAccount.md docs/RetailMediaAccount.md docs/RetailMediaBrandAccountCreation.md +docs/RetailMediaBrands.md docs/RetailMediaExternalv1AddRemoveKeywordModel.md docs/RetailMediaExternalv1AddRemoveKeywordsModel.md docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md @@ -336,7 +375,6 @@ docs/RmLegacyAudienceUserBehaviorDetailsV2.md docs/RmLegacySegmentCustomerList.md docs/RmLegacySegmentUserBehaviorV1.md docs/RmLegacySegmentUserBehaviorV2.md -docs/Section.md docs/SellerPreview.md docs/SellerPreviewResponse.md docs/SkuDataPreview.md @@ -365,22 +403,20 @@ docs/SyncCampaignsReportResource.md docs/SyncLineItemsReport.md docs/SyncLineItemsReportRequest.md docs/SyncLineItemsReportResource.md -docs/Template.md -docs/TemplateListResponse.md -docs/TemplateResponse.md -docs/TemplateVariable.md -docs/TemplateVariableValue.md -docs/TextVariableSpecification.md -docs/TextVariableValue.md -docs/ValueResourceCollectionOutcomeOfInt64.md +docs/ValueResourceCollectionInputOfRetailMediaSeller.md docs/ValueResourceCollectionOutcomeOfRetailMediaSeller.md docs/ValueResourceInputOfCampaignBudgetOverrides.md docs/ValueResourceInputOfLineItemBudgetOverrides.md +docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md +docs/ValueResourceInputOfRetailMediaBrands.md +docs/ValueResourceInputOfRetailMediaSellerAccountCreation.md docs/ValueResourceOfCampaignBudgetOverrides.md -docs/ValueResourceOfInt64.md docs/ValueResourceOfLineItemBudgetOverrides.md docs/ValueResourceOfRecommendedKeywordsResult.md +docs/ValueResourceOfRetailMediaBrandAccountCreation.md +docs/ValueResourceOfRetailMediaBrands.md docs/ValueResourceOfRetailMediaSeller.md +docs/ValueResourceOfRetailMediaSellerAccountCreation.md docs/ValueResourceOutcomeOfCampaignBudgetOverrides.md docs/ValueResourceOutcomeOfLineItemBudgetOverrides.md docs/ValueResourceOutcomeOfRecommendedKeywordsResult.md diff --git a/sdks/retailmedia_preview/README.md b/sdks/retailmedia_preview/README.md index d1e01455..1b526104 100644 --- a/sdks/retailmedia_preview/README.md +++ b/sdks/retailmedia_preview/README.md @@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- Package version: 0.0.240207 +- Package version: 0.0.240404 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==0.0.240207 +pip install criteo-api-retailmedia-sdk==0.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.240404`) Then import the package: ```python @@ -63,6 +63,9 @@ Class | Method | HTTP request | Description - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) + - [AsyncAccountsReport](docs/AsyncAccountsReport.md) + - [AsyncAccountsReportRequest](docs/AsyncAccountsReportRequest.md) + - [AsyncAccountsReportResource](docs/AsyncAccountsReportResource.md) - [AsyncCampaignsReport](docs/AsyncCampaignsReport.md) - [AsyncCampaignsReportRequest](docs/AsyncCampaignsReportRequest.md) - [AsyncCampaignsReportResource](docs/AsyncCampaignsReportResource.md) @@ -70,6 +73,7 @@ Class | Method | HTTP request | Description - [AsyncLineItemsReportRequest](docs/AsyncLineItemsReportRequest.md) - [AsyncLineItemsReportResource](docs/AsyncLineItemsReportResource.md) - [AsyncReportResponse](docs/AsyncReportResponse.md) + - [BatchAcceptedResponse](docs/BatchAcceptedResponse.md) - [Brand](docs/Brand.md) - [BrandPreview](docs/BrandPreview.md) - [BrandPreviewListResponse](docs/BrandPreviewListResponse.md) @@ -78,73 +82,89 @@ Class | Method | HTTP request | Description - [CampaignMonthlyBudgetOverride](docs/CampaignMonthlyBudgetOverride.md) - [Category](docs/Category.md) - [Category202204](docs/Category202204.md) - - [ChoiceOption](docs/ChoiceOption.md) - - [ChoiceVariableSpecification](docs/ChoiceVariableSpecification.md) - - [ChoiceVariableValue](docs/ChoiceVariableValue.md) - - [ColorVariableValue](docs/ColorVariableValue.md) + - [ChangeDetails](docs/ChangeDetails.md) - [CommonError](docs/CommonError.md) - [CommonProblem](docs/CommonProblem.md) - [CommonWarning](docs/CommonWarning.md) - [CpcRateCardPreview](docs/CpcRateCardPreview.md) - [CpcRateCardPreviewResponse](docs/CpcRateCardPreviewResponse.md) - - [Creative202210](docs/Creative202210.md) - - [Creative202210ListResponse](docs/Creative202210ListResponse.md) - - [Creative202210Response](docs/Creative202210Response.md) - - [CreativeCreateModel202207](docs/CreativeCreateModel202207.md) - - [CreativeUpdateModel202207](docs/CreativeUpdateModel202207.md) + - [CustomAttribute](docs/CustomAttribute.md) - [DailyLineItemBudgetOverride](docs/DailyLineItemBudgetOverride.md) - [ExportReportColumn](docs/ExportReportColumn.md) - [ExportReportMetaData](docs/ExportReportMetaData.md) - [ExternalAccount](docs/ExternalAccount.md) - [ExternalBrand](docs/ExternalBrand.md) - - [ExternalCatalogRequestPreview](docs/ExternalCatalogRequestPreview.md) - - [ExternalCatalogStatus](docs/ExternalCatalogStatus.md) + - [ExternalLineItemCappingV2](docs/ExternalLineItemCappingV2.md) + - [ExternalLineItemPageCategoryV2](docs/ExternalLineItemPageCategoryV2.md) + - [ExternalLineItemPageV2](docs/ExternalLineItemPageV2.md) + - [ExternalPreferredLineItemCreateModelV2](docs/ExternalPreferredLineItemCreateModelV2.md) + - [ExternalPreferredLineItemUpdateModelV2](docs/ExternalPreferredLineItemUpdateModelV2.md) + - [ExternalPreferredLineItemV2](docs/ExternalPreferredLineItemV2.md) - [ExternalProductButtonRequest](docs/ExternalProductButtonRequest.md) - [ExternalProductButtonResponse](docs/ExternalProductButtonResponse.md) - [ExternalRetailer](docs/ExternalRetailer.md) - - [FilesVariableValue](docs/FilesVariableValue.md) - - [FilesVariablesSpecification](docs/FilesVariablesSpecification.md) + - [FailResponse](docs/FailResponse.md) - [GrantConsentInput](docs/GrantConsentInput.md) - [GrantConsentModel](docs/GrantConsentModel.md) - [GrantConsentModelValueResource](docs/GrantConsentModelValueResource.md) - - [HyperlinkVariableValue](docs/HyperlinkVariableValue.md) - [InputKeywords](docs/InputKeywords.md) + - [InputResourceOfPreferredLineItemCreateModelV2](docs/InputResourceOfPreferredLineItemCreateModelV2.md) + - [InsertionOrderHistoryChangeDataCapture](docs/InsertionOrderHistoryChangeDataCapture.md) + - [Installment](docs/Installment.md) - [JsonApiBodyWithIdOfInt64AndAccountAndAccount](docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md) - [JsonApiBodyWithIdOfInt64AndBrandAndBrand](docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md) - - [JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus](docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md) - [JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers](docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md) - [JsonApiBodyWithIdOfInt64AndRetailerAndRetailer](docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md) - - [JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview](docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview.md) - [JsonApiPageResponseOfAccount](docs/JsonApiPageResponseOfAccount.md) - [JsonApiPageResponseOfBrand](docs/JsonApiPageResponseOfBrand.md) - [JsonApiPageResponseOfRetailer](docs/JsonApiPageResponseOfRetailer.md) - - [JsonApiRequestOfCatalogRequestPreview](docs/JsonApiRequestOfCatalogRequestPreview.md) - - [JsonApiSingleResponseOfCatalogStatus](docs/JsonApiSingleResponseOfCatalogStatus.md) - [JsonApiSingleResponseOfLineItemBidMultipliers](docs/JsonApiSingleResponseOfLineItemBidMultipliers.md) - [Keywords](docs/Keywords.md) - [LineItemBidMultipliers](docs/LineItemBidMultipliers.md) - [LineItemBidMultipliersRequest](docs/LineItemBidMultipliersRequest.md) - [LineItemBidMultipliersResponse](docs/LineItemBidMultipliersResponse.md) - [LineItemBudgetOverrides](docs/LineItemBudgetOverrides.md) + - [LoyaltyPoints](docs/LoyaltyPoints.md) + - [Metadata](docs/Metadata.md) - [MonthlyLineItemBudegetOverride](docs/MonthlyLineItemBudegetOverride.md) - [PageMetadata](docs/PageMetadata.md) - - [PageTypeEnvironment](docs/PageTypeEnvironment.md) + - [PageOfInsertionOrderHistoryChangeDataCapture](docs/PageOfInsertionOrderHistoryChangeDataCapture.md) - [PlacementPreview](docs/PlacementPreview.md) - [PlacementPreviewListResponse](docs/PlacementPreviewListResponse.md) + - [PreferredLineItemCreateModelV2Request](docs/PreferredLineItemCreateModelV2Request.md) + - [PreferredLineItemUpdateModelV2Request](docs/PreferredLineItemUpdateModelV2Request.md) + - [PreferredLineItemV2PagedListResponse](docs/PreferredLineItemV2PagedListResponse.md) + - [PreferredLineItemV2Response](docs/PreferredLineItemV2Response.md) + - [Price](docs/Price.md) - [ProblemDetails](docs/ProblemDetails.md) + - [Product](docs/Product.md) - [ProductButtonListRequest](docs/ProductButtonListRequest.md) - [ProductButtonListResponse](docs/ProductButtonListResponse.md) - [ProductButtonRequest](docs/ProductButtonRequest.md) + - [ProductImporterError](docs/ProductImporterError.md) + - [ProductImporterWarning](docs/ProductImporterWarning.md) + - [ProductShipping](docs/ProductShipping.md) + - [ProductShippingDimension](docs/ProductShippingDimension.md) + - [ProductShippingWeight](docs/ProductShippingWeight.md) + - [ProductTax](docs/ProductTax.md) + - [ProductUnitPricingBaseMeasure](docs/ProductUnitPricingBaseMeasure.md) + - [ProductUnitPricingMeasure](docs/ProductUnitPricingMeasure.md) + - [ProductsCustomBatchRequest](docs/ProductsCustomBatchRequest.md) + - [ProductsCustomBatchRequestEntry](docs/ProductsCustomBatchRequestEntry.md) - [RecommendedKeywordsResult](docs/RecommendedKeywordsResult.md) - [ReportDataResponseResource](docs/ReportDataResponseResource.md) + - [ReportDetailError](docs/ReportDetailError.md) + - [ReportDetailErrors](docs/ReportDetailErrors.md) + - [ReportOkResponse](docs/ReportOkResponse.md) - [ReportOutcome](docs/ReportOutcome.md) - [ReportResponse](docs/ReportResponse.md) - [ResourceCollectionOutcomeOfSkuSearchResult](docs/ResourceCollectionOutcomeOfSkuSearchResult.md) - [ResourceOfBrandPreview](docs/ResourceOfBrandPreview.md) - [ResourceOfCpcRateCardPreview](docs/ResourceOfCpcRateCardPreview.md) - - [ResourceOfCreative202210](docs/ResourceOfCreative202210.md) - [ResourceOfLineItemBidMultipliers](docs/ResourceOfLineItemBidMultipliers.md) - [ResourceOfPlacementPreview](docs/ResourceOfPlacementPreview.md) + - [ResourceOfPreferredLineItemUpdateModelV2](docs/ResourceOfPreferredLineItemUpdateModelV2.md) + - [ResourceOfPreferredLineItemV2](docs/ResourceOfPreferredLineItemV2.md) - [ResourceOfProductButtonRequest](docs/ResourceOfProductButtonRequest.md) - [ResourceOfProductButtonResponse](docs/ResourceOfProductButtonResponse.md) - [ResourceOfRetailMediaAccount](docs/ResourceOfRetailMediaAccount.md) @@ -156,10 +176,10 @@ Class | Method | HTTP request | Description - [ResourceOfSkuSearchResult](docs/ResourceOfSkuSearchResult.md) - [ResourceOfSkuSlimDataPreview](docs/ResourceOfSkuSlimDataPreview.md) - [ResourceOfSkuSlimDataV2](docs/ResourceOfSkuSlimDataV2.md) - - [ResourceOfTemplate](docs/ResourceOfTemplate.md) - [ResourceOutcomeOfRetailMediaAccount](docs/ResourceOutcomeOfRetailMediaAccount.md) - [RetailMediaAccount](docs/RetailMediaAccount.md) - [RetailMediaBrandAccountCreation](docs/RetailMediaBrandAccountCreation.md) + - [RetailMediaBrands](docs/RetailMediaBrands.md) - [RetailMediaExternalv1AddRemoveKeywordModel](docs/RetailMediaExternalv1AddRemoveKeywordModel.md) - [RetailMediaExternalv1AddRemoveKeywordsModel](docs/RetailMediaExternalv1AddRemoveKeywordsModel.md) - [RetailMediaExternalv1AddRemoveKeywordsModelRequest](docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md) @@ -190,7 +210,6 @@ Class | Method | HTTP request | Description - [RmLegacySegmentCustomerList](docs/RmLegacySegmentCustomerList.md) - [RmLegacySegmentUserBehaviorV1](docs/RmLegacySegmentUserBehaviorV1.md) - [RmLegacySegmentUserBehaviorV2](docs/RmLegacySegmentUserBehaviorV2.md) - - [Section](docs/Section.md) - [SellerPreview](docs/SellerPreview.md) - [SellerPreviewResponse](docs/SellerPreviewResponse.md) - [SkuDataPreview](docs/SkuDataPreview.md) @@ -219,22 +238,20 @@ Class | Method | HTTP request | Description - [SyncLineItemsReport](docs/SyncLineItemsReport.md) - [SyncLineItemsReportRequest](docs/SyncLineItemsReportRequest.md) - [SyncLineItemsReportResource](docs/SyncLineItemsReportResource.md) - - [Template](docs/Template.md) - - [TemplateListResponse](docs/TemplateListResponse.md) - - [TemplateResponse](docs/TemplateResponse.md) - - [TemplateVariable](docs/TemplateVariable.md) - - [TemplateVariableValue](docs/TemplateVariableValue.md) - - [TextVariableSpecification](docs/TextVariableSpecification.md) - - [TextVariableValue](docs/TextVariableValue.md) - - [ValueResourceCollectionOutcomeOfInt64](docs/ValueResourceCollectionOutcomeOfInt64.md) + - [ValueResourceCollectionInputOfRetailMediaSeller](docs/ValueResourceCollectionInputOfRetailMediaSeller.md) - [ValueResourceCollectionOutcomeOfRetailMediaSeller](docs/ValueResourceCollectionOutcomeOfRetailMediaSeller.md) - [ValueResourceInputOfCampaignBudgetOverrides](docs/ValueResourceInputOfCampaignBudgetOverrides.md) - [ValueResourceInputOfLineItemBudgetOverrides](docs/ValueResourceInputOfLineItemBudgetOverrides.md) + - [ValueResourceInputOfRetailMediaBrandAccountCreation](docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md) + - [ValueResourceInputOfRetailMediaBrands](docs/ValueResourceInputOfRetailMediaBrands.md) + - [ValueResourceInputOfRetailMediaSellerAccountCreation](docs/ValueResourceInputOfRetailMediaSellerAccountCreation.md) - [ValueResourceOfCampaignBudgetOverrides](docs/ValueResourceOfCampaignBudgetOverrides.md) - - [ValueResourceOfInt64](docs/ValueResourceOfInt64.md) - [ValueResourceOfLineItemBudgetOverrides](docs/ValueResourceOfLineItemBudgetOverrides.md) - [ValueResourceOfRecommendedKeywordsResult](docs/ValueResourceOfRecommendedKeywordsResult.md) + - [ValueResourceOfRetailMediaBrandAccountCreation](docs/ValueResourceOfRetailMediaBrandAccountCreation.md) + - [ValueResourceOfRetailMediaBrands](docs/ValueResourceOfRetailMediaBrands.md) - [ValueResourceOfRetailMediaSeller](docs/ValueResourceOfRetailMediaSeller.md) + - [ValueResourceOfRetailMediaSellerAccountCreation](docs/ValueResourceOfRetailMediaSellerAccountCreation.md) - [ValueResourceOutcomeOfCampaignBudgetOverrides](docs/ValueResourceOutcomeOfCampaignBudgetOverrides.md) - [ValueResourceOutcomeOfLineItemBudgetOverrides](docs/ValueResourceOutcomeOfLineItemBudgetOverrides.md) - [ValueResourceOutcomeOfRecommendedKeywordsResult](docs/ValueResourceOutcomeOfRecommendedKeywordsResult.md) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/__init__.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/__init__.py index 516ecbf7..462480cb 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/__init__.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/__init__.py @@ -8,7 +8,7 @@ """ -__version__ = "0.0.240207" +__version__ = "0.0.240404" # import ApiClient from criteo_api_retailmedia_preview.api_client import ApiClient diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/accounts_api.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/accounts_api.py index b89187b8..315496ec 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/accounts_api.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/accounts_api.py @@ -23,11 +23,12 @@ ) from criteo_api_retailmedia_preview.model.grant_consent_input import GrantConsentInput from criteo_api_retailmedia_preview.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount -from criteo_api_retailmedia_preview.model.retail_media_brand_account_creation import RetailMediaBrandAccountCreation -from criteo_api_retailmedia_preview.model.retail_media_seller import RetailMediaSeller -from criteo_api_retailmedia_preview.model.retail_media_seller_account_creation import RetailMediaSellerAccountCreation -from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_int64 import ValueResourceCollectionOutcomeOfInt64 +from criteo_api_retailmedia_preview.model.value_resource_collection_input_of_retail_media_seller import ValueResourceCollectionInputOfRetailMediaSeller from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_retail_media_seller import ValueResourceCollectionOutcomeOfRetailMediaSeller +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brand_account_creation import ValueResourceInputOfRetailMediaBrandAccountCreation +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_seller_account_creation import ValueResourceInputOfRetailMediaSellerAccountCreation +from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands class AccountsApi(object): @@ -41,6 +42,67 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client + self.add_brands_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOfRetailMediaBrands,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/brands/add', + 'operation_id': 'add_brands', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'value_resource_input_of_retail_media_brands', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'value_resource_input_of_retail_media_brands': + (ValueResourceInputOfRetailMediaBrands,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'value_resource_input_of_retail_media_brands': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json-patch+json', + 'application/json', + 'text/json', + 'application/*+json' + ] + }, + api_client=api_client + ) self.create_private_market_demand_brand_account_endpoint = _Endpoint( settings={ 'response_type': (ResourceOutcomeOfRetailMediaAccount,), @@ -56,7 +118,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'account_id', - 'retail_media_brand_account_creation', + 'value_resource_input_of_retail_media_brand_account_creation', ], 'required': [ 'account_id', @@ -76,15 +138,15 @@ def __init__(self, api_client=None): 'openapi_types': { 'account_id': (str,), - 'retail_media_brand_account_creation': - (RetailMediaBrandAccountCreation,), + 'value_resource_input_of_retail_media_brand_account_creation': + (ValueResourceInputOfRetailMediaBrandAccountCreation,), }, 'attribute_map': { 'account_id': 'accountId', }, 'location_map': { 'account_id': 'path', - 'retail_media_brand_account_creation': 'body', + 'value_resource_input_of_retail_media_brand_account_creation': 'body', }, 'collection_format_map': { } @@ -117,7 +179,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'account_id', - 'retail_media_seller_account_creation', + 'value_resource_input_of_retail_media_seller_account_creation', ], 'required': [ 'account_id', @@ -137,15 +199,15 @@ def __init__(self, api_client=None): 'openapi_types': { 'account_id': (str,), - 'retail_media_seller_account_creation': - (RetailMediaSellerAccountCreation,), + 'value_resource_input_of_retail_media_seller_account_creation': + (ValueResourceInputOfRetailMediaSellerAccountCreation,), }, 'attribute_map': { 'account_id': 'accountId', }, 'location_map': { 'account_id': 'path', - 'retail_media_seller_account_creation': 'body', + 'value_resource_input_of_retail_media_seller_account_creation': 'body', }, 'collection_format_map': { } @@ -222,22 +284,22 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_brands_endpoint = _Endpoint( + self.remove_brands_endpoint = _Endpoint( settings={ - 'response_type': (ValueResourceCollectionOutcomeOfInt64,), + 'response_type': (ValueResourceOfRetailMediaBrands,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/brands', - 'operation_id': 'update_brands', - 'http_method': 'PUT', + 'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/brands/remove', + 'operation_id': 'remove_brands', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'account_id', - 'request_body', + 'value_resource_input_of_retail_media_brands', ], 'required': [ 'account_id', @@ -257,15 +319,15 @@ def __init__(self, api_client=None): 'openapi_types': { 'account_id': (str,), - 'request_body': - ([int],), + 'value_resource_input_of_retail_media_brands': + (ValueResourceInputOfRetailMediaBrands,), }, 'attribute_map': { 'account_id': 'accountId', }, 'location_map': { 'account_id': 'path', - 'request_body': 'body', + 'value_resource_input_of_retail_media_brands': 'body', }, 'collection_format_map': { } @@ -298,7 +360,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'account_id', - 'retail_media_seller', + 'value_resource_collection_input_of_retail_media_seller', ], 'required': [ 'account_id', @@ -318,15 +380,15 @@ def __init__(self, api_client=None): 'openapi_types': { 'account_id': (str,), - 'retail_media_seller': - ([RetailMediaSeller],), + 'value_resource_collection_input_of_retail_media_seller': + (ValueResourceCollectionInputOfRetailMediaSeller,), }, 'attribute_map': { 'account_id': 'accountId', }, 'location_map': { 'account_id': 'path', - 'retail_media_seller': 'body', + 'value_resource_collection_input_of_retail_media_seller': 'body', }, 'collection_format_map': { } @@ -345,6 +407,90 @@ def __init__(self, api_client=None): api_client=api_client ) + def add_brands( + self, + account_id, + **kwargs + ): + """add_brands # noqa: E501 + + Add brands to an account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_brands(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): the account id to update + + Keyword Args: + value_resource_input_of_retail_media_brands (ValueResourceInputOfRetailMediaBrands): brands to associate to account. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ValueResourceOfRetailMediaBrands + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['account_id'] = \ + account_id + return self.add_brands_endpoint.call_with_http_info(**kwargs) + def create_private_market_demand_brand_account( self, account_id, @@ -363,7 +509,7 @@ def create_private_market_demand_brand_account( account_id (str): Account Id for the parent private market account Keyword Args: - retail_media_brand_account_creation (RetailMediaBrandAccountCreation): Initial creation and configuration options for the new account. [optional] + value_resource_input_of_retail_media_brand_account_creation (ValueResourceInputOfRetailMediaBrandAccountCreation): Initial creation and configuration options for the new account. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -447,7 +593,7 @@ def create_private_market_demand_seller_account( account_id (str): Account Id for the parent private market account Keyword Args: - retail_media_seller_account_creation (RetailMediaSellerAccountCreation): Initial creation and configuration options for the new account. [optional] + value_resource_input_of_retail_media_seller_account_creation (ValueResourceInputOfRetailMediaSellerAccountCreation): Initial creation and configuration options for the new account. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -597,25 +743,25 @@ def grant_consent( account_id return self.grant_consent_endpoint.call_with_http_info(**kwargs) - def update_brands( + def remove_brands( self, account_id, **kwargs ): - """update_brands # noqa: E501 + """remove_brands # noqa: E501 - replace the brands for an account # noqa: E501 + Remove a brand from an account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_brands(account_id, async_req=True) + >>> thread = api.remove_brands(account_id, async_req=True) >>> result = thread.get() Args: account_id (str): the account id to update Keyword Args: - request_body ([int]): brands to associate to account. [optional] + value_resource_input_of_retail_media_brands (ValueResourceInputOfRetailMediaBrands): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -648,7 +794,7 @@ def update_brands( async_req (bool): execute request asynchronously Returns: - ValueResourceCollectionOutcomeOfInt64 + ValueResourceOfRetailMediaBrands If the method is called asynchronously, returns the request thread. """ @@ -679,7 +825,7 @@ def update_brands( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['account_id'] = \ account_id - return self.update_brands_endpoint.call_with_http_info(**kwargs) + return self.remove_brands_endpoint.call_with_http_info(**kwargs) def update_sellers( self, @@ -699,7 +845,7 @@ def update_sellers( account_id (str): the account id to update Keyword Args: - retail_media_seller ([RetailMediaSeller]): sellers to associate. [optional] + value_resource_collection_input_of_retail_media_seller (ValueResourceCollectionInputOfRetailMediaSeller): sellers to associate. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/analytics_api.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/analytics_api.py index a72d9128..6531608b 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/analytics_api.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/analytics_api.py @@ -21,6 +21,7 @@ none_type, validate_and_convert_types ) +from criteo_api_retailmedia_preview.model.async_accounts_report_request import AsyncAccountsReportRequest from criteo_api_retailmedia_preview.model.async_campaigns_report_request import AsyncCampaignsReportRequest from criteo_api_retailmedia_preview.model.async_line_items_report_request import AsyncLineItemsReportRequest from criteo_api_retailmedia_preview.model.async_report_response import AsyncReportResponse @@ -42,6 +43,64 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client + self.generate_async_accounts_report_endpoint = _Endpoint( + settings={ + 'response_type': (AsyncReportResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/reports/accounts', + 'operation_id': 'generate_async_accounts_report', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'async_accounts_report_request', + ], + 'required': [ + 'async_accounts_report_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'async_accounts_report_request': + (AsyncAccountsReportRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'async_accounts_report_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [ + 'application/json-patch+json', + 'application/json', + 'text/json', + 'application/*+json' + ] + }, + api_client=api_client + ) self.generate_async_campaigns_report_endpoint = _Endpoint( settings={ 'response_type': (AsyncReportResponse,), @@ -441,6 +500,89 @@ def __init__(self, api_client=None): api_client=api_client ) + def generate_async_accounts_report( + self, + async_accounts_report_request, + **kwargs + ): + """generate_async_accounts_report # noqa: E501 + + Returns an asynchronous Accounts Report # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_async_accounts_report(async_accounts_report_request, async_req=True) + >>> result = thread.get() + + Args: + async_accounts_report_request (AsyncAccountsReportRequest): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + AsyncReportResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['async_accounts_report_request'] = \ + async_accounts_report_request + return self.generate_async_accounts_report_endpoint.call_with_http_info(**kwargs) + def generate_async_campaigns_report( self, async_campaigns_report_request, diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/campaign_api.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/campaign_api.py index 8908b759..6277222a 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/campaign_api.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/campaign_api.py @@ -23,19 +23,18 @@ ) from criteo_api_retailmedia_preview.model.brand_preview_list_response import BrandPreviewListResponse from criteo_api_retailmedia_preview.model.cpc_rate_card_preview_response import CpcRateCardPreviewResponse -from criteo_api_retailmedia_preview.model.creative202210_list_response import Creative202210ListResponse -from criteo_api_retailmedia_preview.model.creative202210_response import Creative202210Response -from criteo_api_retailmedia_preview.model.creative_create_model202207 import CreativeCreateModel202207 -from criteo_api_retailmedia_preview.model.creative_update_model202207 import CreativeUpdateModel202207 from criteo_api_retailmedia_preview.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount from criteo_api_retailmedia_preview.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand from criteo_api_retailmedia_preview.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer -from criteo_api_retailmedia_preview.model.json_api_request_of_catalog_request_preview import JsonApiRequestOfCatalogRequestPreview -from criteo_api_retailmedia_preview.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse +from criteo_api_retailmedia_preview.model.page_of_insertion_order_history_change_data_capture import PageOfInsertionOrderHistoryChangeDataCapture from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse +from criteo_api_retailmedia_preview.model.preferred_line_item_create_model_v2_request import PreferredLineItemCreateModelV2Request +from criteo_api_retailmedia_preview.model.preferred_line_item_update_model_v2_request import PreferredLineItemUpdateModelV2Request +from criteo_api_retailmedia_preview.model.preferred_line_item_v2_paged_list_response import PreferredLineItemV2PagedListResponse +from criteo_api_retailmedia_preview.model.preferred_line_item_v2_response import PreferredLineItemV2Response from criteo_api_retailmedia_preview.model.product_button_list_request import ProductButtonListRequest from criteo_api_retailmedia_preview.model.product_button_list_response import ProductButtonListResponse from criteo_api_retailmedia_preview.model.product_button_request import ProductButtonRequest @@ -53,8 +52,6 @@ from criteo_api_retailmedia_preview.model.sku_search_request_slim_v2_preview_request import SkuSearchRequestSlimV2PreviewRequest from criteo_api_retailmedia_preview.model.sku_slim_data_preview_list_response import SkuSlimDataPreviewListResponse from criteo_api_retailmedia_preview.model.sku_slim_data_v2_list_response import SkuSlimDataV2ListResponse -from criteo_api_retailmedia_preview.model.template_list_response import TemplateListResponse -from criteo_api_retailmedia_preview.model.template_response import TemplateResponse from criteo_api_retailmedia_preview.model.value_resource_input_of_campaign_budget_overrides import ValueResourceInputOfCampaignBudgetOverrides from criteo_api_retailmedia_preview.model.value_resource_input_of_line_item_budget_overrides import ValueResourceInputOfLineItemBudgetOverrides from criteo_api_retailmedia_preview.model.value_resource_outcome_of_campaign_budget_overrides import ValueResourceOutcomeOfCampaignBudgetOverrides @@ -297,174 +294,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_api202207_external_retailer_by_retailer_id_templatestemplate_id_endpoint = _Endpoint( - settings={ - 'response_type': (TemplateResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/preview/retail-media/retailers/{retailer-id}/templates/{template-id}', - 'operation_id': 'get_api202207_external_retailer_by_retailer_id_templatestemplate_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'retailer_id', - 'template_id', - ], - 'required': [ - 'retailer_id', - 'template_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'retailer_id': - (int,), - 'template_id': - (int,), - }, - 'attribute_map': { - 'retailer_id': 'retailer-id', - 'template_id': 'template-id', - }, - 'location_map': { - 'retailer_id': 'path', - 'template_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202207_external_retailer_templates_by_retailer_id_endpoint = _Endpoint( - settings={ - 'response_type': (TemplateListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/preview/retail-media/retailers/{retailer-id}/templates', - 'operation_id': 'get_api202207_external_retailer_templates_by_retailer_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'retailer_id', - ], - 'required': [ - 'retailer_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'retailer_id': - (int,), - }, - 'attribute_map': { - 'retailer_id': 'retailer-id', - }, - 'location_map': { - 'retailer_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202210_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint( - settings={ - 'response_type': (Creative202210Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}', - 'operation_id': 'get_api202210_external_account_by_account_id_creativescreative_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'creative_id', - ], - 'required': [ - 'account_id', - 'creative_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (str,), - 'creative_id': - (str,), - }, - 'attribute_map': { - 'account_id': 'account-id', - 'creative_id': 'creative-id', - }, - 'location_map': { - 'account_id': 'path', - 'creative_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint = _Endpoint( settings={ 'response_type': (ProductButtonListResponse,), @@ -629,111 +458,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_api_v0_external_catalog_output_by_catalog_id_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/preview/retail-media/catalogs/{catalogId}/output', - 'operation_id': 'get_api_v0_external_catalog_output_by_catalog_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'catalog_id', - ], - 'required': [ - 'catalog_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'catalog_id': - (str,), - }, - 'attribute_map': { - 'catalog_id': 'catalogId', - }, - 'location_map': { - 'catalog_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/x-json-stream', - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api_v0_external_catalog_status_by_catalog_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiSingleResponseOfCatalogStatus,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/preview/retail-media/catalogs/{catalogId}/status', - 'operation_id': 'get_api_v0_external_catalog_status_by_catalog_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'catalog_id', - ], - 'required': [ - 'catalog_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'catalog_id': - (str,), - }, - 'attribute_map': { - 'catalog_id': 'catalogId', - }, - 'location_map': { - 'catalog_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) self.get_api_v1_external_account_brands_by_account_id_endpoint = _Endpoint( settings={ 'response_type': (JsonApiPageResponseOfBrand,), @@ -1175,21 +899,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_campaign_budget_overrides_endpoint = _Endpoint( + self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint( settings={ - 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,), + 'response_type': (PreferredLineItemV2PagedListResponse,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides', - 'operation_id': 'get_campaign_budget_overrides', + 'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items', + 'operation_id': 'get_api_v2_external_campaign_preferred_line_items_by_campaign_id', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'campaign_id', + 'limit_to_id', + 'page_index', + 'page_size', ], 'required': [ 'campaign_id', @@ -1208,15 +935,28 @@ def __init__(self, api_client=None): }, 'openapi_types': { 'campaign_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': (int,), }, 'attribute_map': { - 'campaign_id': 'campaignId', + 'campaign_id': 'campaign-id', + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', }, 'location_map': { 'campaign_id': 'path', + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', }, 'collection_format_map': { + 'limit_to_id': 'multi', } }, headers_map={ @@ -1227,15 +967,15 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_line_item_budget_overrides_endpoint = _Endpoint( + self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( settings={ - 'response_type': (ValueResourceOutcomeOfLineItemBudgetOverrides,), + 'response_type': (PreferredLineItemV2Response,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides', - 'operation_id': 'get_line_item_budget_overrides', + 'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}', + 'operation_id': 'get_api_v2_external_preferred_line_item_by_line_item_id', 'http_method': 'GET', 'servers': None, }, @@ -1263,7 +1003,7 @@ def __init__(self, api_client=None): (str,), }, 'attribute_map': { - 'line_item_id': 'lineItemId', + 'line_item_id': 'line-item-id', }, 'location_map': { 'line_item_id': 'path', @@ -1279,24 +1019,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_recommended_keywords_endpoint = _Endpoint( + self.get_campaign_budget_overrides_endpoint = _Endpoint( settings={ - 'response_type': (ValueResourceOutcomeOfRecommendedKeywordsResult,), + 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/line-items/{externalLineItemId}/keywords/recommended', - 'operation_id': 'get_recommended_keywords', + 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides', + 'operation_id': 'get_campaign_budget_overrides', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'external_line_item_id', + 'campaign_id', ], 'required': [ - 'external_line_item_id', + 'campaign_id', ], 'nullable': [ ], @@ -1311,14 +1051,14 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'external_line_item_id': - (str,), + 'campaign_id': + (int,), }, 'attribute_map': { - 'external_line_item_id': 'externalLineItemId', + 'campaign_id': 'campaignId', }, 'location_map': { - 'external_line_item_id': 'path', + 'campaign_id': 'path', }, 'collection_format_map': { } @@ -1331,54 +1071,39 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_sku_by_product_id_endpoint = _Endpoint( + self.get_insertion_order_history_change_data_capture_endpoint = _Endpoint( settings={ - 'response_type': (ResourceCollectionOutcomeOfSkuSearchResult,), + 'response_type': (PageOfInsertionOrderHistoryChangeDataCapture,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/catalogs/sku/search/accounts/{accountId}/retailers/{retailerId}/by-id', - 'operation_id': 'get_sku_by_product_id', - 'http_method': 'POST', + 'endpoint_path': '/preview/retail-media/insertion-order-history/{insertionOrderId}/change-data-capture', + 'operation_id': 'get_insertion_order_history_change_data_capture', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'account_id', - 'retailer_id', + 'insertion_order_id', 'offset', 'limit', - 'sku_search_request', + 'limit_to_change_types', ], 'required': [ - 'account_id', - 'retailer_id', + 'insertion_order_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ - 'account_id', - 'retailer_id', 'offset', 'limit', ] }, root_map={ 'validations': { - ('account_id',): { - - 'regex': { - 'pattern': r'^\d+$', # noqa: E501 - }, - }, - ('retailer_id',): { - - 'inclusive_maximum': 2147483647, - 'inclusive_minimum': 1, - }, ('offset',): { 'inclusive_maximum': 2147483647, @@ -1386,36 +1111,33 @@ def __init__(self, api_client=None): }, ('limit',): { - 'inclusive_maximum': 2147483647, + 'inclusive_maximum': 100, 'inclusive_minimum': 1, }, }, 'allowed_values': { }, 'openapi_types': { - 'account_id': + 'insertion_order_id': (str,), - 'retailer_id': - (int,), 'offset': (int,), 'limit': (int,), - 'sku_search_request': - (SkuSearchRequest,), + 'limit_to_change_types': + (str,), }, 'attribute_map': { - 'account_id': 'accountId', - 'retailer_id': 'retailerId', + 'insertion_order_id': 'insertionOrderId', 'offset': 'offset', 'limit': 'limit', + 'limit_to_change_types': 'limitToChangeTypes', }, 'location_map': { - 'account_id': 'path', - 'retailer_id': 'path', + 'insertion_order_id': 'path', 'offset': 'query', 'limit': 'query', - 'sku_search_request': 'body', + 'limit_to_change_types': 'query', }, 'collection_format_map': { } @@ -1424,34 +1146,28 @@ def __init__(self, api_client=None): 'accept': [ 'application/json' ], - 'content_type': [ - 'application/json-patch+json', - 'application/json', - 'text/json', - 'application/*+json' - ] + 'content_type': [], }, api_client=api_client ) - self.post_api202210_external_account_creatives_by_account_id_endpoint = _Endpoint( + self.get_line_item_budget_overrides_endpoint = _Endpoint( settings={ - 'response_type': (Creative202210Response,), + 'response_type': (ValueResourceOutcomeOfLineItemBudgetOverrides,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives', - 'operation_id': 'post_api202210_external_account_creatives_by_account_id', - 'http_method': 'POST', + 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides', + 'operation_id': 'get_line_item_budget_overrides', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'account_id', - 'creative_create_model202207', + 'line_item_id', ], 'required': [ - 'account_id', + 'line_item_id', ], 'nullable': [ ], @@ -1466,17 +1182,14 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'account_id': + 'line_item_id': (str,), - 'creative_create_model202207': - (CreativeCreateModel202207,), }, 'attribute_map': { - 'account_id': 'account-id', + 'line_item_id': 'lineItemId', }, 'location_map': { - 'account_id': 'path', - 'creative_create_model202207': 'body', + 'line_item_id': 'path', }, 'collection_format_map': { } @@ -1485,89 +1198,184 @@ def __init__(self, api_client=None): 'accept': [ 'application/json' ], - 'content_type': [ - 'application/json' + 'content_type': [], + }, + api_client=api_client + ) + self.get_recommended_keywords_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOutcomeOfRecommendedKeywordsResult,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/line-items/{externalLineItemId}/keywords/recommended', + 'operation_id': 'get_recommended_keywords', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'external_line_item_id', + ], + 'required': [ + 'external_line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ ] }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'external_line_item_id': + (str,), + }, + 'attribute_map': { + 'external_line_item_id': 'externalLineItemId', + }, + 'location_map': { + 'external_line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, api_client=api_client ) - self.post_api202210_external_account_creatives_search_by_account_id_endpoint = _Endpoint( + self.get_sku_by_product_id_endpoint = _Endpoint( settings={ - 'response_type': (Creative202210ListResponse,), + 'response_type': (ResourceCollectionOutcomeOfSkuSearchResult,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/search', - 'operation_id': 'post_api202210_external_account_creatives_search_by_account_id', + 'endpoint_path': '/preview/retail-media/catalogs/sku/search/accounts/{accountId}/retailers/{retailerId}/by-id', + 'operation_id': 'get_sku_by_product_id', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'account_id', - 'creative_ids', + 'retailer_id', + 'offset', + 'limit', + 'sku_search_request', ], 'required': [ 'account_id', + 'retailer_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ + 'account_id', + 'retailer_id', + 'offset', + 'limit', ] }, root_map={ 'validations': { + ('account_id',): { + + 'regex': { + 'pattern': r'^\d+$', # noqa: E501 + }, + }, + ('retailer_id',): { + + 'inclusive_maximum': 2147483647, + 'inclusive_minimum': 1, + }, + ('offset',): { + + 'inclusive_maximum': 2147483647, + 'inclusive_minimum': 0, + }, + ('limit',): { + + 'inclusive_maximum': 2147483647, + 'inclusive_minimum': 1, + }, }, 'allowed_values': { }, 'openapi_types': { 'account_id': (str,), - 'creative_ids': - ([str],), + 'retailer_id': + (int,), + 'offset': + (int,), + 'limit': + (int,), + 'sku_search_request': + (SkuSearchRequest,), }, 'attribute_map': { - 'account_id': 'account-id', - 'creative_ids': 'creative-ids', + 'account_id': 'accountId', + 'retailer_id': 'retailerId', + 'offset': 'offset', + 'limit': 'limit', }, 'location_map': { 'account_id': 'path', - 'creative_ids': 'query', + 'retailer_id': 'path', + 'offset': 'query', + 'limit': 'query', + 'sku_search_request': 'body', }, 'collection_format_map': { - 'creative_ids': 'multi', } }, headers_map={ 'accept': [ 'application/json' ], - 'content_type': [], + 'content_type': [ + 'application/json-patch+json', + 'application/json', + 'text/json', + 'application/*+json' + ] }, api_client=api_client ) - self.post_api202210_external_line_item_product_buttons_create_by_line_item_id_endpoint = _Endpoint( + self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint( settings={ - 'response_type': (ProductButtonListResponse,), + 'response_type': (PreferredLineItemV2Response,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/create', - 'operation_id': 'post_api202210_external_line_item_product_buttons_create_by_line_item_id', + 'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items', + 'operation_id': 'post_api202110_external_campaign_preferred_line_items_by_campaign_id', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'line_item_id', - 'product_button_list_request', + 'campaign_id', + 'preferred_line_item_create_model_v2_request', ], 'required': [ - 'line_item_id', + 'campaign_id', + 'preferred_line_item_create_model_v2_request', ], 'nullable': [ ], @@ -1582,17 +1390,17 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'line_item_id': + 'campaign_id': (str,), - 'product_button_list_request': - (ProductButtonListRequest,), + 'preferred_line_item_create_model_v2_request': + (PreferredLineItemCreateModelV2Request,), }, 'attribute_map': { - 'line_item_id': 'line-item-id', + 'campaign_id': 'campaign-id', }, 'location_map': { - 'line_item_id': 'path', - 'product_button_list_request': 'body', + 'campaign_id': 'path', + 'preferred_line_item_create_model_v2_request': 'body', }, 'collection_format_map': { } @@ -1607,25 +1415,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.post_api_v0_external_account_catalogs_by_account_id_endpoint = _Endpoint( + self.post_api202210_external_line_item_product_buttons_create_by_line_item_id_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiSingleResponseOfCatalogStatus,), + 'response_type': (ProductButtonListResponse,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/accounts/{accountId}/catalogs', - 'operation_id': 'post_api_v0_external_account_catalogs_by_account_id', + 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/create', + 'operation_id': 'post_api202210_external_line_item_product_buttons_create_by_line_item_id', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'account_id', - 'json_api_request_of_catalog_request_preview', + 'line_item_id', + 'product_button_list_request', ], 'required': [ - 'account_id', + 'line_item_id', ], 'nullable': [ ], @@ -1640,17 +1448,17 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'account_id': + 'line_item_id': (str,), - 'json_api_request_of_catalog_request_preview': - (JsonApiRequestOfCatalogRequestPreview,), + 'product_button_list_request': + (ProductButtonListRequest,), }, 'attribute_map': { - 'account_id': 'accountId', + 'line_item_id': 'line-item-id', }, 'location_map': { - 'account_id': 'path', - 'json_api_request_of_catalog_request_preview': 'body', + 'line_item_id': 'path', + 'product_button_list_request': 'body', }, 'collection_format_map': { } @@ -1974,27 +1782,26 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.put_api202210_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint( + self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( settings={ - 'response_type': (Creative202210Response,), + 'response_type': (PreferredLineItemV2Response,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}', - 'operation_id': 'put_api202210_external_account_by_account_id_creativescreative_id', + 'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}', + 'operation_id': 'put_api202110_external_preferred_line_item_by_line_item_id', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'account_id', - 'creative_id', - 'creative_update_model202207', + 'line_item_id', + 'preferred_line_item_update_model_v2_request', ], 'required': [ - 'account_id', - 'creative_id', + 'line_item_id', + 'preferred_line_item_update_model_v2_request', ], 'nullable': [ ], @@ -2009,21 +1816,17 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'account_id': - (str,), - 'creative_id': + 'line_item_id': (str,), - 'creative_update_model202207': - (CreativeUpdateModel202207,), + 'preferred_line_item_update_model_v2_request': + (PreferredLineItemUpdateModelV2Request,), }, 'attribute_map': { - 'account_id': 'account-id', - 'creative_id': 'creative-id', + 'line_item_id': 'line-item-id', }, 'location_map': { - 'account_id': 'path', - 'creative_id': 'path', - 'creative_update_model202207': 'body', + 'line_item_id': 'path', + 'preferred_line_item_update_model_v2_request': 'body', }, 'collection_format_map': { } @@ -2654,446 +2457,21 @@ def fetch_keywords( return self.fetch_keywords_endpoint.call_with_http_info(**kwargs) def fetch_proposal( - self, - id, - **kwargs - ): - """fetch_proposal # noqa: E501 - - Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.fetch_proposal(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): The external id of a line item. - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - RetailMediaExternalv1ProposalStatusModelResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.fetch_proposal_endpoint.call_with_http_info(**kwargs) - - def get_api202207_external_retailer_by_retailer_id_templatestemplate_id( - self, - retailer_id, - template_id, - **kwargs - ): - """get_api202207_external_retailer_by_retailer_id_templatestemplate_id # noqa: E501 - - Gets the template for the specified retailer id and template id # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_api202207_external_retailer_by_retailer_id_templatestemplate_id(retailer_id, template_id, async_req=True) - >>> result = thread.get() - - Args: - retailer_id (int): Retailer Id - template_id (int): Template Id - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TemplateResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['retailer_id'] = \ - retailer_id - kwargs['template_id'] = \ - template_id - return self.get_api202207_external_retailer_by_retailer_id_templatestemplate_id_endpoint.call_with_http_info(**kwargs) - - def get_api202207_external_retailer_templates_by_retailer_id( - self, - retailer_id, - **kwargs - ): - """get_api202207_external_retailer_templates_by_retailer_id # noqa: E501 - - Get retailer creative templates # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_api202207_external_retailer_templates_by_retailer_id(retailer_id, async_req=True) - >>> result = thread.get() - - Args: - retailer_id (int): External retailer id to retrieve creative templates for - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - TemplateListResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['retailer_id'] = \ - retailer_id - return self.get_api202207_external_retailer_templates_by_retailer_id_endpoint.call_with_http_info(**kwargs) - - def get_api202210_external_account_by_account_id_creativescreative_id( - self, - account_id, - creative_id, - **kwargs - ): - """get_api202210_external_account_by_account_id_creativescreative_id # noqa: E501 - - Get the specified creative # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): External account id to retrieve creatives for - creative_id (str): Creative to get - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - Creative202210Response - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['account_id'] = \ - account_id - kwargs['creative_id'] = \ - creative_id - return self.get_api202210_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs) - - def get_api202210_external_line_item_product_buttons_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api202210_external_line_item_product_buttons_by_line_item_id # noqa: E501 - - Get all the product buttons associated with a line item # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): Long external id of the associated line item - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - ProductButtonListResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['line_item_id'] = \ - line_item_id - return self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id( - self, - line_item_id, - product_button_id, + self, + id, **kwargs ): - """get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id # noqa: E501 + """fetch_proposal # noqa: E501 - Get a single product button # noqa: E501 + Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id, async_req=True) + >>> thread = api.fetch_proposal(id, async_req=True) >>> result = thread.get() Args: - line_item_id (str): Long external id of the associated line item - product_button_id (str): Sequential id of the product button + id (str): The external id of a line item. Keyword Args: _return_http_data_only (bool): response data without head status @@ -3128,7 +2506,7 @@ def get_api202210_external_line_item_product_buttons_by_line_item_id_product_but async_req (bool): execute request asynchronously Returns: - ProductButtonListResponse + RetailMediaExternalv1ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ @@ -3157,24 +2535,22 @@ def get_api202210_external_line_item_product_buttons_by_line_item_id_product_but '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['line_item_id'] = \ - line_item_id - kwargs['product_button_id'] = \ - product_button_id - return self.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.fetch_proposal_endpoint.call_with_http_info(**kwargs) - def get_api202301_external_line_item_bid_multipliers_by_line_item_id( + def get_api202210_external_line_item_product_buttons_by_line_item_id( self, line_item_id, **kwargs ): - """get_api202301_external_line_item_bid_multipliers_by_line_item_id # noqa: E501 + """get_api202210_external_line_item_product_buttons_by_line_item_id # noqa: E501 - Get bid multipliers by line item # noqa: E501 + Get all the product buttons associated with a line item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True) + >>> thread = api.get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id, async_req=True) >>> result = thread.get() Args: @@ -3213,7 +2589,7 @@ def get_api202301_external_line_item_bid_multipliers_by_line_item_id( async_req (bool): execute request asynchronously Returns: - JsonApiSingleResponseOfLineItemBidMultipliers + ProductButtonListResponse If the method is called asynchronously, returns the request thread. """ @@ -3244,24 +2620,26 @@ def get_api202301_external_line_item_bid_multipliers_by_line_item_id( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['line_item_id'] = \ line_item_id - return self.get_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) + return self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint.call_with_http_info(**kwargs) - def get_api_v0_external_catalog_output_by_catalog_id( + def get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id( self, - catalog_id, + line_item_id, + product_button_id, **kwargs ): - """get_api_v0_external_catalog_output_by_catalog_id # noqa: E501 + """get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id # noqa: E501 - Output the indicated catalog. Catalogs are only available for retrieval when their associated status request is at a Success status. Produces application/x-json-stream of CatalogProduct json objects. # noqa: E501 + Get a single product button # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_api_v0_external_catalog_output_by_catalog_id(catalog_id, async_req=True) + >>> thread = api.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id, async_req=True) >>> result = thread.get() Args: - catalog_id (str): A catalog ID returned from an account catalog request. + line_item_id (str): Long external id of the associated line item + product_button_id (str): Sequential id of the product button Keyword Args: _return_http_data_only (bool): response data without head status @@ -3296,7 +2674,7 @@ def get_api_v0_external_catalog_output_by_catalog_id( async_req (bool): execute request asynchronously Returns: - None + ProductButtonListResponse If the method is called asynchronously, returns the request thread. """ @@ -3325,26 +2703,28 @@ def get_api_v0_external_catalog_output_by_catalog_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['catalog_id'] = \ - catalog_id - return self.get_api_v0_external_catalog_output_by_catalog_id_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + kwargs['product_button_id'] = \ + product_button_id + return self.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs) - def get_api_v0_external_catalog_status_by_catalog_id( + def get_api202301_external_line_item_bid_multipliers_by_line_item_id( self, - catalog_id, + line_item_id, **kwargs ): - """get_api_v0_external_catalog_status_by_catalog_id # noqa: E501 + """get_api202301_external_line_item_bid_multipliers_by_line_item_id # noqa: E501 - Check the status of a catalog request. # noqa: E501 + Get bid multipliers by line item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_api_v0_external_catalog_status_by_catalog_id(catalog_id, async_req=True) + >>> thread = api.get_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True) >>> result = thread.get() Args: - catalog_id (str): A catalog ID returned from an account catalog request. + line_item_id (str): Long external id of the associated line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -3379,7 +2759,7 @@ def get_api_v0_external_catalog_status_by_catalog_id( async_req (bool): execute request asynchronously Returns: - JsonApiSingleResponseOfCatalogStatus + JsonApiSingleResponseOfLineItemBidMultipliers If the method is called asynchronously, returns the request thread. """ @@ -3408,9 +2788,9 @@ def get_api_v0_external_catalog_status_by_catalog_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['catalog_id'] = \ - catalog_id - return self.get_api_v0_external_catalog_status_by_catalog_id_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + return self.get_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) def get_api_v1_external_account_brands_by_account_id( self, @@ -4004,24 +3384,27 @@ def get_api_v1_external_retailer_placements_by_retailer_id( retailer_id return self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint.call_with_http_info(**kwargs) - def get_campaign_budget_overrides( + def get_api_v2_external_campaign_preferred_line_items_by_campaign_id( self, campaign_id, **kwargs ): - """get_campaign_budget_overrides # noqa: E501 + """get_api_v2_external_campaign_preferred_line_items_by_campaign_id # noqa: E501 - Get current campaign budget overrides by given external campaign id. # noqa: E501 + Gets page of preferred line item objects for the given campaign id # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_campaign_budget_overrides(campaign_id, async_req=True) + >>> thread = api.get_api_v2_external_campaign_preferred_line_items_by_campaign_id(campaign_id, async_req=True) >>> result = thread.get() Args: - campaign_id (int): External campaign id. + campaign_id (str): The given campaign id Keyword Args: + limit_to_id ([str]): The ids that you would like to limit your result set to. [optional] + page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] + page_size (int): The maximum number of items you would like to receive in this request. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -4054,7 +3437,7 @@ def get_campaign_budget_overrides( async_req (bool): execute request asynchronously Returns: - ValueResourceOutcomeOfCampaignBudgetOverrides + PreferredLineItemV2PagedListResponse If the method is called asynchronously, returns the request thread. """ @@ -4085,24 +3468,24 @@ def get_campaign_budget_overrides( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['campaign_id'] = \ campaign_id - return self.get_campaign_budget_overrides_endpoint.call_with_http_info(**kwargs) + return self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) - def get_line_item_budget_overrides( + def get_api_v2_external_preferred_line_item_by_line_item_id( self, line_item_id, **kwargs ): - """get_line_item_budget_overrides # noqa: E501 + """get_api_v2_external_preferred_line_item_by_line_item_id # noqa: E501 - Gets a collection of monthly and daily budget overrides for the provided line item. # noqa: E501 + Gets the preferred line item for the given line item id # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_line_item_budget_overrides(line_item_id, async_req=True) + >>> thread = api.get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True) >>> result = thread.get() Args: - line_item_id (str): The line item id to get budget overrides for. + line_item_id (str): The given line item id Keyword Args: _return_http_data_only (bool): response data without head status @@ -4137,7 +3520,7 @@ def get_line_item_budget_overrides( async_req (bool): execute request asynchronously Returns: - ValueResourceOutcomeOfLineItemBudgetOverrides + PreferredLineItemV2Response If the method is called asynchronously, returns the request thread. """ @@ -4168,24 +3551,24 @@ def get_line_item_budget_overrides( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['line_item_id'] = \ line_item_id - return self.get_line_item_budget_overrides_endpoint.call_with_http_info(**kwargs) + return self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) - def get_recommended_keywords( + def get_campaign_budget_overrides( self, - external_line_item_id, + campaign_id, **kwargs ): - """get_recommended_keywords # noqa: E501 + """get_campaign_budget_overrides # noqa: E501 - Retrieves a collection of recommended keywords for a line item # noqa: E501 + Get current campaign budget overrides by given external campaign id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_recommended_keywords(external_line_item_id, async_req=True) + >>> thread = api.get_campaign_budget_overrides(campaign_id, async_req=True) >>> result = thread.get() Args: - external_line_item_id (str): The external line item identifier + campaign_id (int): External campaign id. Keyword Args: _return_http_data_only (bool): response data without head status @@ -4220,7 +3603,7 @@ def get_recommended_keywords( async_req (bool): execute request asynchronously Returns: - ValueResourceOutcomeOfRecommendedKeywordsResult + ValueResourceOutcomeOfCampaignBudgetOverrides If the method is called asynchronously, returns the request thread. """ @@ -4249,33 +3632,31 @@ def get_recommended_keywords( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['external_line_item_id'] = \ - external_line_item_id - return self.get_recommended_keywords_endpoint.call_with_http_info(**kwargs) + kwargs['campaign_id'] = \ + campaign_id + return self.get_campaign_budget_overrides_endpoint.call_with_http_info(**kwargs) - def get_sku_by_product_id( + def get_insertion_order_history_change_data_capture( self, - account_id, - retailer_id, + insertion_order_id, **kwargs ): - """get_sku_by_product_id # noqa: E501 + """get_insertion_order_history_change_data_capture # noqa: E501 - Gets a list of SKUs based on a privided list of Product Ids # noqa: E501 + Gets the balance's historical data change capture. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_sku_by_product_id(account_id, retailer_id, async_req=True) + >>> thread = api.get_insertion_order_history_change_data_capture(insertion_order_id, async_req=True) >>> result = thread.get() Args: - account_id (str): account id - retailer_id (int): retailer id + insertion_order_id (str): External insertion order id. Keyword Args: - offset (int): skip a number of matches before retrning results, used with limit. [optional] if omitted the server will use the default value of 0 - limit (int): max number of results to return. [optional] if omitted the server will use the default value of 100 - sku_search_request (SkuSearchRequest): . [optional] + offset (int): The (zero-based) starting offset in the collection.. [optional] if omitted the server will use the default value of 0 + limit (int): The number of elements to be returned.. [optional] if omitted the server will use the default value of 25 + limit_to_change_types (str): Comma separated change types string that will be queried.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -4308,7 +3689,7 @@ def get_sku_by_product_id( async_req (bool): execute request asynchronously Returns: - ResourceCollectionOutcomeOfSkuSearchResult + PageOfInsertionOrderHistoryChangeDataCapture If the method is called asynchronously, returns the request thread. """ @@ -4337,31 +3718,28 @@ def get_sku_by_product_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['account_id'] = \ - account_id - kwargs['retailer_id'] = \ - retailer_id - return self.get_sku_by_product_id_endpoint.call_with_http_info(**kwargs) + kwargs['insertion_order_id'] = \ + insertion_order_id + return self.get_insertion_order_history_change_data_capture_endpoint.call_with_http_info(**kwargs) - def post_api202210_external_account_creatives_by_account_id( + def get_line_item_budget_overrides( self, - account_id, + line_item_id, **kwargs ): - """post_api202210_external_account_creatives_by_account_id # noqa: E501 + """get_line_item_budget_overrides # noqa: E501 - Create a creative for an account # noqa: E501 + Gets a collection of monthly and daily budget overrides for the provided line item. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.post_api202210_external_account_creatives_by_account_id(account_id, async_req=True) + >>> thread = api.get_line_item_budget_overrides(line_item_id, async_req=True) >>> result = thread.get() Args: - account_id (str): External account id to create a creative for + line_item_id (str): The line item id to get budget overrides for. Keyword Args: - creative_create_model202207 (CreativeCreateModel202207): The creative to create. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -4394,7 +3772,7 @@ def post_api202210_external_account_creatives_by_account_id( async_req (bool): execute request asynchronously Returns: - Creative202210Response + ValueResourceOutcomeOfLineItemBudgetOverrides If the method is called asynchronously, returns the request thread. """ @@ -4423,29 +3801,116 @@ def post_api202210_external_account_creatives_by_account_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['account_id'] = \ - account_id - return self.post_api202210_external_account_creatives_by_account_id_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + return self.get_line_item_budget_overrides_endpoint.call_with_http_info(**kwargs) + + def get_recommended_keywords( + self, + external_line_item_id, + **kwargs + ): + """get_recommended_keywords # noqa: E501 + + Retrieves a collection of recommended keywords for a line item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_recommended_keywords(external_line_item_id, async_req=True) + >>> result = thread.get() + + Args: + external_line_item_id (str): The external line item identifier + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ValueResourceOutcomeOfRecommendedKeywordsResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['external_line_item_id'] = \ + external_line_item_id + return self.get_recommended_keywords_endpoint.call_with_http_info(**kwargs) - def post_api202210_external_account_creatives_search_by_account_id( + def get_sku_by_product_id( self, account_id, + retailer_id, **kwargs ): - """post_api202210_external_account_creatives_search_by_account_id # noqa: E501 + """get_sku_by_product_id # noqa: E501 - Get account creatives # noqa: E501 + Gets a list of SKUs based on a privided list of Product Ids # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.post_api202210_external_account_creatives_search_by_account_id(account_id, async_req=True) + >>> thread = api.get_sku_by_product_id(account_id, retailer_id, async_req=True) >>> result = thread.get() Args: - account_id (str): External account id to retrieve creatives for + account_id (str): account id + retailer_id (int): retailer id Keyword Args: - creative_ids ([str]): Creatives to filter by. [optional] + offset (int): skip a number of matches before retrning results, used with limit. [optional] if omitted the server will use the default value of 0 + limit (int): max number of results to return. [optional] if omitted the server will use the default value of 100 + sku_search_request (SkuSearchRequest): . [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -4478,7 +3943,7 @@ def post_api202210_external_account_creatives_search_by_account_id( async_req (bool): execute request asynchronously Returns: - Creative202210ListResponse + ResourceCollectionOutcomeOfSkuSearchResult If the method is called asynchronously, returns the request thread. """ @@ -4509,27 +3974,30 @@ def post_api202210_external_account_creatives_search_by_account_id( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['account_id'] = \ account_id - return self.post_api202210_external_account_creatives_search_by_account_id_endpoint.call_with_http_info(**kwargs) + kwargs['retailer_id'] = \ + retailer_id + return self.get_sku_by_product_id_endpoint.call_with_http_info(**kwargs) - def post_api202210_external_line_item_product_buttons_create_by_line_item_id( + def post_api202110_external_campaign_preferred_line_items_by_campaign_id( self, - line_item_id, + campaign_id, + preferred_line_item_create_model_v2_request, **kwargs ): - """post_api202210_external_line_item_product_buttons_create_by_line_item_id # noqa: E501 + """post_api202110_external_campaign_preferred_line_items_by_campaign_id # noqa: E501 - Append new product buttons to a line item # noqa: E501 + Creates a new preferred line item with the specified settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.post_api202210_external_line_item_product_buttons_create_by_line_item_id(line_item_id, async_req=True) + >>> thread = api.post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, preferred_line_item_create_model_v2_request, async_req=True) >>> result = thread.get() Args: - line_item_id (str): Long external id of the associated line item + campaign_id (str): The given campaign id + preferred_line_item_create_model_v2_request (PreferredLineItemCreateModelV2Request): The line item settings to create a line item with Keyword Args: - product_button_list_request (ProductButtonListRequest): List of product buttons to append to the specified line item. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -4562,7 +4030,7 @@ def post_api202210_external_line_item_product_buttons_create_by_line_item_id( async_req (bool): execute request asynchronously Returns: - ProductButtonListResponse + PreferredLineItemV2Response If the method is called asynchronously, returns the request thread. """ @@ -4591,29 +4059,31 @@ def post_api202210_external_line_item_product_buttons_create_by_line_item_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['line_item_id'] = \ - line_item_id - return self.post_api202210_external_line_item_product_buttons_create_by_line_item_id_endpoint.call_with_http_info(**kwargs) + kwargs['campaign_id'] = \ + campaign_id + kwargs['preferred_line_item_create_model_v2_request'] = \ + preferred_line_item_create_model_v2_request + return self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) - def post_api_v0_external_account_catalogs_by_account_id( + def post_api202210_external_line_item_product_buttons_create_by_line_item_id( self, - account_id, + line_item_id, **kwargs ): - """post_api_v0_external_account_catalogs_by_account_id # noqa: E501 + """post_api202210_external_line_item_product_buttons_create_by_line_item_id # noqa: E501 - Create a request for a Catalog available to the indicated account. # noqa: E501 + Append new product buttons to a line item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.post_api_v0_external_account_catalogs_by_account_id(account_id, async_req=True) + >>> thread = api.post_api202210_external_line_item_product_buttons_create_by_line_item_id(line_item_id, async_req=True) >>> result = thread.get() Args: - account_id (str): The account to request the catalog for. + line_item_id (str): Long external id of the associated line item Keyword Args: - json_api_request_of_catalog_request_preview (JsonApiRequestOfCatalogRequestPreview): [optional] + product_button_list_request (ProductButtonListRequest): List of product buttons to append to the specified line item. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -4646,7 +4116,7 @@ def post_api_v0_external_account_catalogs_by_account_id( async_req (bool): execute request asynchronously Returns: - JsonApiSingleResponseOfCatalogStatus + ProductButtonListResponse If the method is called asynchronously, returns the request thread. """ @@ -4675,9 +4145,9 @@ def post_api_v0_external_account_catalogs_by_account_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['account_id'] = \ - account_id - return self.post_api_v0_external_account_catalogs_by_account_id_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + return self.post_api202210_external_line_item_product_buttons_create_by_line_item_id_endpoint.call_with_http_info(**kwargs) def post_api_v1_external_catalogs_sku_retrieval( self, @@ -5018,27 +4488,26 @@ def post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id( retailer_id return self.post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id_endpoint.call_with_http_info(**kwargs) - def put_api202210_external_account_by_account_id_creativescreative_id( + def put_api202110_external_preferred_line_item_by_line_item_id( self, - account_id, - creative_id, + line_item_id, + preferred_line_item_update_model_v2_request, **kwargs ): - """put_api202210_external_account_by_account_id_creativescreative_id # noqa: E501 + """put_api202110_external_preferred_line_item_by_line_item_id # noqa: E501 - Update a creative # noqa: E501 + Updates the preferred line item for the given line item id # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.put_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True) + >>> thread = api.put_api202110_external_preferred_line_item_by_line_item_id(line_item_id, preferred_line_item_update_model_v2_request, async_req=True) >>> result = thread.get() Args: - account_id (str): External account id containing the creative - creative_id (str): Creative to update + line_item_id (str): The given line item id + preferred_line_item_update_model_v2_request (PreferredLineItemUpdateModelV2Request): The line item settings to create a line item with Keyword Args: - creative_update_model202207 (CreativeUpdateModel202207): The creative to create. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -5071,7 +4540,7 @@ def put_api202210_external_account_by_account_id_creativescreative_id( async_req (bool): execute request asynchronously Returns: - Creative202210Response + PreferredLineItemV2Response If the method is called asynchronously, returns the request thread. """ @@ -5100,11 +4569,11 @@ def put_api202210_external_account_by_account_id_creativescreative_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['account_id'] = \ - account_id - kwargs['creative_id'] = \ - creative_id - return self.put_api202210_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + kwargs['preferred_line_item_update_model_v2_request'] = \ + preferred_line_item_update_model_v2_request + return self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) def put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id( self, diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/catalog_api.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/catalog_api.py new file mode 100644 index 00000000..e356a3ff --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/catalog_api.py @@ -0,0 +1,312 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_retailmedia_preview.model.batch_accepted_response import BatchAcceptedResponse +from criteo_api_retailmedia_preview.model.fail_response import FailResponse +from criteo_api_retailmedia_preview.model.products_custom_batch_request import ProductsCustomBatchRequest +from criteo_api_retailmedia_preview.model.report_ok_response import ReportOkResponse + + +class CatalogApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.preview_retail_media_catalog_products_batch_post_endpoint = _Endpoint( + settings={ + 'response_type': (BatchAcceptedResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/catalog/products/batch', + 'operation_id': 'preview_retail_media_catalog_products_batch_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'products_custom_batch_request', + ], + 'required': [ + 'products_custom_batch_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'products_custom_batch_request': + (ProductsCustomBatchRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'products_custom_batch_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.preview_retail_media_catalog_products_batch_report_operation_token_get_endpoint = _Endpoint( + settings={ + 'response_type': (ReportOkResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/catalog/products/batch/report/{operation-token}', + 'operation_id': 'preview_retail_media_catalog_products_batch_report_operation_token_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'operation_token', + ], + 'required': [ + 'operation_token', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'operation_token': + (str,), + }, + 'attribute_map': { + 'operation_token': 'operation-token', + }, + 'location_map': { + 'operation_token': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def preview_retail_media_catalog_products_batch_post( + self, + products_custom_batch_request, + **kwargs + ): + """preview_retail_media_catalog_products_batch_post # noqa: E501 + + Used to publish a batch of operations to insert, update and deletes products. The batch is processed asynchronously.The response provides an operationToken which can be used to track the status of the report of the operation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_retail_media_catalog_products_batch_post(products_custom_batch_request, async_req=True) + >>> result = thread.get() + + Args: + products_custom_batch_request (ProductsCustomBatchRequest): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + BatchAcceptedResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['products_custom_batch_request'] = \ + products_custom_batch_request + return self.preview_retail_media_catalog_products_batch_post_endpoint.call_with_http_info(**kwargs) + + def preview_retail_media_catalog_products_batch_report_operation_token_get( + self, + operation_token, + **kwargs + ): + """preview_retail_media_catalog_products_batch_report_operation_token_get # noqa: E501 + + Get the report of an asynchronous batch operation previously requested # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.preview_retail_media_catalog_products_batch_report_operation_token_get(operation_token, async_req=True) + >>> result = thread.get() + + Args: + operation_token (str): The token returned by the batch endpoint. + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ReportOkResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['operation_token'] = \ + operation_token + return self.preview_retail_media_catalog_products_batch_report_operation_token_get_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api_client.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api_client.py index ee1a39d9..d8104c55 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api_client.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/0.0.240207/python' + self.user_agent = 'OpenAPI-Generator/0.0.240404/python' def __enter__(self): return self @@ -804,10 +804,10 @@ def __call__(self, *args, **kwargs): Example: api_instance = AccountsApi() - api_instance.create_private_market_demand_brand_account # this is an instance of the class Endpoint - api_instance.create_private_market_demand_brand_account() # this invokes api_instance.create_private_market_demand_brand_account.__call__() + api_instance.add_brands # this is an instance of the class Endpoint + api_instance.add_brands() # this invokes api_instance.add_brands.__call__() which then invokes the callable functions stored in that endpoint at - api_instance.create_private_market_demand_brand_account.callable or self.callable in this class + api_instance.add_brands.callable or self.callable in this class """ return self.callable(self, *args, **kwargs) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/apis/__init__.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/apis/__init__.py index 55738c3f..c35ffb3f 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/apis/__init__.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/apis/__init__.py @@ -18,4 +18,5 @@ from criteo_api_retailmedia_preview.api.analytics_api import AnalyticsApi from criteo_api_retailmedia_preview.api.audience_api import AudienceApi from criteo_api_retailmedia_preview.api.campaign_api import CampaignApi +from criteo_api_retailmedia_preview.api.catalog_api import CatalogApi from criteo_api_retailmedia_preview.api.gateway_api import GatewayApi diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/configuration.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/configuration.py index 0184da0e..3964e44c 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/configuration.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/configuration.py @@ -395,7 +395,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: Preview\n"\ - "SDK Package Version: 0.0.240207".\ + "SDK Package Version: 0.0.240404".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report.py similarity index 56% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report.py index 0f11abad..1dc6a35c 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report.py @@ -29,14 +29,8 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError -def lazy_import(): - from criteo_api_retailmedia_preview.model.page_type_environment import PageTypeEnvironment - from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue - globals()['PageTypeEnvironment'] = PageTypeEnvironment - globals()['TemplateVariableValue'] = TemplateVariableValue - -class Creative202210(ModelNormal): +class AsyncAccountsReport(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -61,23 +55,93 @@ class Creative202210(ModelNormal): """ allowed_values = { - ('status',): { - 'READY': "Ready", - 'IN_USE': "In_Use", - 'ARCHIVED': "Archived", - 'DELETED': "Deleted", + ('report_type',): { + 'None': None, + 'SUMMARY': "summary", + 'PAGETYPE': "pageType", + 'KEYWORD': "keyword", + 'PRODUCTCATEGORY': "productCategory", + 'PRODUCT': "product", + 'ENVIRONMENT': "environment", + 'SERVEDCATEGORY': "servedCategory", + }, + ('aggregation_level',): { + 'None': None, + 'CAMPAIGN': "campaign", + 'LINEITEM': "lineItem", + }, + ('campaign_type',): { + 'None': None, + 'SPONSOREDPRODUCTS': "sponsoredProducts", + 'ONSITEDISPLAYS': "onSiteDisplays", + }, + ('sales_channel',): { + 'None': None, + 'OFFLINE': "offline", + 'ONLINE': "online", + }, + ('format',): { + 'None': None, + 'JSON': "json", + 'JSON-COMPACT': "json-compact", + 'JSON-NEWLINE': "json-newline", + 'CSV': "csv", + }, + ('click_attribution_window',): { + 'None': None, + '7D': "7D", + '14D': "14D", + '30D': "30D", + 'NONE': "none", + }, + ('view_attribution_window',): { + 'None': None, + '1D': "1D", + '7D': "7D", + '14D': "14D", + '30D': "30D", + 'NONE': "none", + }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", }, - ('creative_format_type',): { - 'UNKNOWN': "Unknown", - 'FLAGSHIP': "FlagShip", - 'SHOWCASE': "Showcase", - 'SPONSOREDPRODUCTS': "SponsoredProducts", - 'BUTTERFLY': "Butterfly", - 'BUNDLEBOOST': "BundleBoost", - 'IAB': "IAB", - 'CUSTOM': "CUSTOM", - 'DISPLAYPANEL': "DisplayPanel", - 'DIGITALSHELFTALKER': "DigitalShelfTalker", + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", }, } @@ -90,7 +154,6 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ - lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -105,20 +168,20 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'name': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 - 'retailer_id': (int,), # noqa: E501 - 'template_id': (int,), # noqa: E501 - 'template_name': (str,), # noqa: E501 - 'format_id': (int,), # noqa: E501 - 'creative_format_type': (str,), # noqa: E501 - 'environments': ([PageTypeEnvironment],), # noqa: E501 - 'template_variable_values': ([TemplateVariableValue],), # noqa: E501 - 'brand_id': (int, none_type,), # noqa: E501 - 'associated_line_item_ids': ([str],), # noqa: E501 - 'updated_at': (datetime,), # noqa: E501 + 'account_ids': ([str],), # noqa: E501 + 'start_date': (datetime,), # noqa: E501 + 'end_date': (datetime,), # noqa: E501 + 'report_type': (str, none_type,), # noqa: E501 + 'aggregation_level': (str, none_type,), # noqa: E501 + 'campaign_type': (str, none_type,), # noqa: E501 + 'sales_channel': (str, none_type,), # noqa: E501 + 'format': (str, none_type,), # noqa: E501 + 'click_attribution_window': (str, none_type,), # noqa: E501 + 'view_attribution_window': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 + 'timezone': (str, none_type,), # noqa: E501 } @cached_property @@ -127,18 +190,19 @@ def discriminator(): attribute_map = { - 'name': 'name', # noqa: E501 - 'status': 'status', # noqa: E501 - 'retailer_id': 'retailerId', # noqa: E501 - 'template_id': 'templateId', # noqa: E501 - 'template_name': 'templateName', # noqa: E501 - 'format_id': 'formatId', # noqa: E501 - 'creative_format_type': 'creativeFormatType', # noqa: E501 - 'environments': 'environments', # noqa: E501 - 'template_variable_values': 'templateVariableValues', # noqa: E501 - 'brand_id': 'brandId', # noqa: E501 - 'associated_line_item_ids': 'associatedLineItemIds', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 + 'account_ids': 'accountIds', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'report_type': 'reportType', # noqa: E501 + 'aggregation_level': 'aggregationLevel', # noqa: E501 + 'campaign_type': 'campaignType', # noqa: E501 + 'sales_channel': 'salesChannel', # noqa: E501 + 'format': 'format', # noqa: E501 + 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 + 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 + 'timezone': 'timezone', # noqa: E501 } read_only_vars = { @@ -148,19 +212,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, name, status, retailer_id, template_id, template_name, format_id, creative_format_type, environments, template_variable_values, *args, **kwargs): # noqa: E501 - """Creative202210 - a model defined in OpenAPI + def _from_openapi_data(cls, account_ids, start_date, end_date, *args, **kwargs): # noqa: E501 + """AsyncAccountsReport - a model defined in OpenAPI Args: - name (str): Name - status (str): Creative Status - retailer_id (int): Retailer Id - template_id (int): Template Id - template_name (str): Template Name - format_id (int): Format Id - creative_format_type (str): Creative format type - environments ([PageTypeEnvironment]): Environment type (e.g. mobile, web, app) - template_variable_values ([TemplateVariableValue]): The template chosen values + account_ids ([str]): Account Ids to report on + start_date (datetime): Start date + end_date (datetime): End date Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -193,9 +251,16 @@ def _from_openapi_data(cls, name, status, retailer_id, template_id, template_nam Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - brand_id (int, none_type): Brand Id. [optional] # noqa: E501 - associated_line_item_ids ([str]): Associated Line Item Ids. [optional] # noqa: E501 - updated_at (datetime): Updated at time. [optional] # noqa: E501 + report_type (str, none_type): 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 + aggregation_level (str, none_type): Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign" # noqa: E501 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 + click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 + view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 + timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -227,15 +292,9 @@ def _from_openapi_data(cls, name, status, retailer_id, template_id, template_nam self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.name = name - self.status = status - self.retailer_id = retailer_id - self.template_id = template_id - self.template_name = template_name - self.format_id = format_id - self.creative_format_type = creative_format_type - self.environments = environments - self.template_variable_values = template_variable_values + self.account_ids = account_ids + self.start_date = start_date + self.end_date = end_date for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -256,19 +315,13 @@ def _from_openapi_data(cls, name, status, retailer_id, template_id, template_nam ]) @convert_js_args_to_python_args - def __init__(self, name, status, retailer_id, template_id, template_name, format_id, creative_format_type, environments, template_variable_values, *args, **kwargs): # noqa: E501 - """Creative202210 - a model defined in OpenAPI + def __init__(self, account_ids, start_date, end_date, *args, **kwargs): # noqa: E501 + """AsyncAccountsReport - a model defined in OpenAPI Args: - name (str): Name - status (str): Creative Status - retailer_id (int): Retailer Id - template_id (int): Template Id - template_name (str): Template Name - format_id (int): Format Id - creative_format_type (str): Creative format type - environments ([PageTypeEnvironment]): Environment type (e.g. mobile, web, app) - template_variable_values ([TemplateVariableValue]): The template chosen values + account_ids ([str]): Account Ids to report on + start_date (datetime): Start date + end_date (datetime): End date Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -301,9 +354,16 @@ def __init__(self, name, status, retailer_id, template_id, template_name, format Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - brand_id (int, none_type): Brand Id. [optional] # noqa: E501 - associated_line_item_ids ([str]): Associated Line Item Ids. [optional] # noqa: E501 - updated_at (datetime): Updated at time. [optional] # noqa: E501 + report_type (str, none_type): 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 + aggregation_level (str, none_type): Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign" # noqa: E501 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 + click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 + view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 + timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -333,15 +393,9 @@ def __init__(self, name, status, retailer_id, template_id, template_name, format self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.name = name - self.status = status - self.retailer_id = retailer_id - self.template_id = template_id - self.template_name = template_name - self.format_id = format_id - self.creative_format_type = creative_format_type - self.environments = environments - self.template_variable_values = template_variable_values + self.account_ids = account_ids + self.start_date = start_date + self.end_date = end_date for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_catalog_request_preview.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report_request.py similarity index 94% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_catalog_request_preview.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report_request.py index 25cf8f74..907ed347 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_catalog_request_preview.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report_request.py @@ -29,8 +29,12 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError +def lazy_import(): + from criteo_api_retailmedia_preview.model.async_accounts_report_resource import AsyncAccountsReportResource + globals()['AsyncAccountsReportResource'] = AsyncAccountsReportResource -class ExternalCatalogRequestPreview(ModelNormal): + +class AsyncAccountsReportRequest(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -55,9 +59,6 @@ class ExternalCatalogRequestPreview(ModelNormal): """ allowed_values = { - ('format',): { - 'JSON-NEWLINE': "json-newline", - }, } validations = { @@ -69,6 +70,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -83,8 +85,9 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { - 'format': (str,), # noqa: E501 + 'data': (AsyncAccountsReportResource,), # noqa: E501 } @cached_property @@ -93,7 +96,7 @@ def discriminator(): attribute_map = { - 'format': 'format', # noqa: E501 + 'data': 'data', # noqa: E501 } read_only_vars = { @@ -104,7 +107,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ExternalCatalogRequestPreview - a model defined in OpenAPI + """AsyncAccountsReportRequest - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -137,7 +140,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - format (str): [optional] if omitted the server will use the default value of "json-newline" # noqa: E501 + data (AsyncAccountsReportResource): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -190,7 +193,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ExternalCatalogRequestPreview - a model defined in OpenAPI + """AsyncAccountsReportRequest - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -223,7 +226,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - format (str): [optional] if omitted the server will use the default value of "json-newline" # noqa: E501 + data (AsyncAccountsReportResource): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report_resource.py new file mode 100644 index 00000000..61bc8ec2 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.async_accounts_report import AsyncAccountsReport + globals()['AsyncAccountsReport'] = AsyncAccountsReport + + +class AsyncAccountsReportResource(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'type': (str, none_type,), # noqa: E501 + 'attributes': (AsyncAccountsReport,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AsyncAccountsReportResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str, none_type): [optional] # noqa: E501 + attributes (AsyncAccountsReport): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AsyncAccountsReportResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str, none_type): [optional] # noqa: E501 + attributes (AsyncAccountsReport): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_campaigns_report.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_campaigns_report.py index 326901b0..98848333 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_campaigns_report.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_campaigns_report.py @@ -55,43 +55,6 @@ class AsyncCampaignsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'CPM': "cpm", - 'ROAS': "roas", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ENVIRONMENT': "environment", - 'KEYWORD': "keyword", - 'SALESCHANNEL': "salesChannel", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -135,6 +98,47 @@ class AsyncCampaignsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -163,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -184,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -242,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -344,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 + id (str, none_type): Campaign id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_line_items_report.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_line_items_report.py index ec72e532..3cf9c092 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_line_items_report.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_line_items_report.py @@ -55,44 +55,6 @@ class AsyncLineItemsReport(ModelNormal): """ allowed_values = { - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'LINEITEMID': "lineItemId", - 'LINEITEMNAME': "lineItemName", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - 'KEYWORD': "keyword", - 'PAGETYPENAME': "pageTypeName", - 'SALESCHANNEL': "salesChannel", - 'ENVIRONMENT': "environment", - }, ('campaign_type',): { 'None': None, 'SPONSOREDPRODUCTS': "sponsoredProducts", @@ -136,6 +98,47 @@ class AsyncLineItemsReport(ModelNormal): '30D': "30D", 'NONE': "none", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -164,16 +167,16 @@ def openapi_types(): return { 'start_date': (datetime,), # noqa: E501 'end_date': (datetime,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 'format': (str, none_type,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 - 'ids': ([str], none_type,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -185,16 +188,16 @@ def discriminator(): attribute_map = { 'start_date': 'startDate', # noqa: E501 'end_date': 'endDate', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 'format': 'format', # noqa: E501 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 - 'ids': 'ids', # noqa: E501 - 'id': 'id', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -243,16 +246,16 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -345,16 +348,16 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501 + id (str, none_type): Line Item id to report on. [optional] # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501 report_type (str, none_type): 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 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 - ids ([str], none_type): Ids to report on. [optional] # noqa: E501 - id (str, none_type): Id to report on. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/text_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/batch_accepted_response.py similarity index 94% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/text_variable_value.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/batch_accepted_response.py index e763be3b..ccdf776c 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/text_variable_value.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/batch_accepted_response.py @@ -30,7 +30,7 @@ -class TextVariableValue(ModelNormal): +class BatchAcceptedResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -81,7 +81,7 @@ def openapi_types(): and the value is attribute type. """ return { - 'text': (str,), # noqa: E501 + 'operation_token': (str,), # noqa: E501 } @cached_property @@ -90,7 +90,7 @@ def discriminator(): attribute_map = { - 'text': 'text', # noqa: E501 + 'operation_token': 'operationToken', # noqa: E501 } read_only_vars = { @@ -100,11 +100,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, text, *args, **kwargs): # noqa: E501 - """TextVariableValue - a model defined in OpenAPI + def _from_openapi_data(cls, operation_token, *args, **kwargs): # noqa: E501 + """BatchAcceptedResponse - a model defined in OpenAPI Args: - text (str): The displayed text + operation_token (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -168,7 +168,7 @@ def _from_openapi_data(cls, text, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.text = text + self.operation_token = operation_token for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -189,11 +189,11 @@ def _from_openapi_data(cls, text, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, text, *args, **kwargs): # noqa: E501 - """TextVariableValue - a model defined in OpenAPI + def __init__(self, operation_token, *args, **kwargs): # noqa: E501 + """BatchAcceptedResponse - a model defined in OpenAPI Args: - text (str): The displayed text + operation_token (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -255,7 +255,7 @@ def __init__(self, text, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.text = text + self.operation_token = operation_token for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_int64.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/change_details.py similarity index 87% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_int64.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/change_details.py index de35ed4f..a7c6af64 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_int64.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/change_details.py @@ -29,14 +29,8 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError -def lazy_import(): - from criteo_api_retailmedia_preview.model.common_problem import CommonProblem - from criteo_api_retailmedia_preview.model.value_resource_of_int64 import ValueResourceOfInt64 - globals()['CommonProblem'] = CommonProblem - globals()['ValueResourceOfInt64'] = ValueResourceOfInt64 - -class ValueResourceCollectionOutcomeOfInt64(ModelNormal): +class ChangeDetails(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -80,11 +74,10 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'data': ([ValueResourceOfInt64], none_type,), # noqa: E501 - 'warnings': ([CommonProblem], none_type,), # noqa: E501 - 'errors': ([CommonProblem], none_type,), # noqa: E501 + 'previous_value': (str, none_type,), # noqa: E501 + 'current_value': (str, none_type,), # noqa: E501 + 'change_value': (str, none_type,), # noqa: E501 } @cached_property @@ -93,22 +86,25 @@ def discriminator(): attribute_map = { - 'data': 'data', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - 'errors': 'errors', # noqa: E501 + 'previous_value': 'previousValue', # noqa: E501 + 'current_value': 'currentValue', # noqa: E501 + 'change_value': 'changeValue', # noqa: E501 } read_only_vars = { - 'warnings', # noqa: E501 - 'errors', # noqa: E501 } _composed_schemas = {} @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ValueResourceCollectionOutcomeOfInt64 - a model defined in OpenAPI + def _from_openapi_data(cls, previous_value, current_value, change_value, *args, **kwargs): # noqa: E501 + """ChangeDetails - a model defined in OpenAPI + + Args: + previous_value (str, none_type): Previous value of a property of the insertion order. + current_value (str, none_type): Current value of a property of the insertion order. + change_value (str, none_type): Change detail of a property of the insertion order. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -141,9 +137,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data ([ValueResourceOfInt64], none_type): [optional] # noqa: E501 - warnings ([CommonProblem], none_type): [optional] # noqa: E501 - errors ([CommonProblem], none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -175,6 +168,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.previous_value = previous_value + self.current_value = current_value + self.change_value = change_value for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -195,8 +191,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ValueResourceCollectionOutcomeOfInt64 - a model defined in OpenAPI + def __init__(self, previous_value, current_value, change_value, *args, **kwargs): # noqa: E501 + """ChangeDetails - a model defined in OpenAPI + + Args: + previous_value (str, none_type): Previous value of a property of the insertion order. + current_value (str, none_type): Current value of a property of the insertion order. + change_value (str, none_type): Change detail of a property of the insertion order. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -229,9 +230,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data ([ValueResourceOfInt64], none_type): [optional] # noqa: E501 - warnings ([CommonProblem], none_type): [optional] # noqa: E501 - errors ([CommonProblem], none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -261,6 +259,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.previous_value = previous_value + self.current_value = current_value + self.change_value = change_value for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/hyperlink_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/custom_attribute.py similarity index 92% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/hyperlink_variable_value.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/custom_attribute.py index d407b12a..493a9159 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/hyperlink_variable_value.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/custom_attribute.py @@ -30,7 +30,7 @@ -class HyperlinkVariableValue(ModelNormal): +class CustomAttribute(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -81,7 +81,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'url': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'value': (str,), # noqa: E501 } @cached_property @@ -90,7 +91,8 @@ def discriminator(): attribute_map = { - 'url': 'url', # noqa: E501 + 'name': 'name', # noqa: E501 + 'value': 'value', # noqa: E501 } read_only_vars = { @@ -100,11 +102,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501 - """HyperlinkVariableValue - a model defined in OpenAPI + def _from_openapi_data(cls, name, value, *args, **kwargs): # noqa: E501 + """CustomAttribute - a model defined in OpenAPI Args: - url (str): The url to redirect to + name (str): The name of the attribute. Underscores will be replaced by spaces upon insertion. + value (str): The value of the attribute. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -168,7 +171,8 @@ def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.url = url + self.name = name + self.value = value for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -189,11 +193,12 @@ def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, url, *args, **kwargs): # noqa: E501 - """HyperlinkVariableValue - a model defined in OpenAPI + def __init__(self, name, value, *args, **kwargs): # noqa: E501 + """CustomAttribute - a model defined in OpenAPI Args: - url (str): The url to redirect to + name (str): The name of the attribute. Underscores will be replaced by spaces upon insertion. + value (str): The value of the attribute. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -255,7 +260,8 @@ def __init__(self, url, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.url = url + self.name = name + self.value = value for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/export_report_column.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/export_report_column.py index 76612e53..bb0d7659 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/export_report_column.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/export_report_column.py @@ -138,7 +138,7 @@ def _from_openapi_data(cls, name, type, role, *args, **kwargs): # noqa: E501 Args: name (str): Name of the exported column type (str): Type of the column - role (str): Role of the colummn + role (str): Role of the column Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -237,7 +237,7 @@ def __init__(self, name, type, role, *args, **kwargs): # noqa: E501 Args: name (str): Name of the exported column type (str): Type of the column - role (str): Role of the colummn + role (str): Role of the column Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/files_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_capping_v2.py similarity index 92% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/files_variable_value.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_capping_v2.py index 175dc47f..456e32d6 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/files_variable_value.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_capping_v2.py @@ -30,7 +30,7 @@ -class FilesVariableValue(ModelNormal): +class ExternalLineItemCappingV2(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -55,11 +55,14 @@ class FilesVariableValue(ModelNormal): """ allowed_values = { + ('type',): { + 'UNKNOWN': "unknown", + 'DAY': "day", + 'SESSION': "session", + }, } validations = { - ('asset_ids',): { - }, } @cached_property @@ -83,7 +86,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'asset_ids': ([str],), # noqa: E501 + 'type': (str,), # noqa: E501 + 'count': (int,), # noqa: E501 } @cached_property @@ -92,7 +96,8 @@ def discriminator(): attribute_map = { - 'asset_ids': 'assetIds', # noqa: E501 + 'type': 'type', # noqa: E501 + 'count': 'count', # noqa: E501 } read_only_vars = { @@ -102,11 +107,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, asset_ids, *args, **kwargs): # noqa: E501 - """FilesVariableValue - a model defined in OpenAPI + def _from_openapi_data(cls, type, count, *args, **kwargs): # noqa: E501 + """ExternalLineItemCappingV2 - a model defined in OpenAPI Args: - asset_ids ([str]): The assets representing the images to be displayed + type (str): Line Item Capping Type Enum + count (int): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -170,7 +176,8 @@ def _from_openapi_data(cls, asset_ids, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.asset_ids = asset_ids + self.type = type + self.count = count for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -191,11 +198,12 @@ def _from_openapi_data(cls, asset_ids, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, asset_ids, *args, **kwargs): # noqa: E501 - """FilesVariableValue - a model defined in OpenAPI + def __init__(self, type, count, *args, **kwargs): # noqa: E501 + """ExternalLineItemCappingV2 - a model defined in OpenAPI Args: - asset_ids ([str]): The assets representing the images to be displayed + type (str): Line Item Capping Type Enum + count (int): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -257,7 +265,8 @@ def __init__(self, asset_ids, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.asset_ids = asset_ids + self.type = type + self.count = count for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py new file mode 100644 index 00000000..98b425dc --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + + +class ExternalLineItemPageCategoryV2(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'category_id': (str,), # noqa: E501 + 'include_children': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'category_id': 'categoryId', # noqa: E501 + 'include_children': 'includeChildren', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, category_id, *args, **kwargs): # noqa: E501 + """ExternalLineItemPageCategoryV2 - a model defined in OpenAPI + + Args: + category_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + include_children (bool): [optional] if omitted the server will use the default value of True # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.category_id = category_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, category_id, *args, **kwargs): # noqa: E501 + """ExternalLineItemPageCategoryV2 - a model defined in OpenAPI + + Args: + category_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + include_children (bool): [optional] if omitted the server will use the default value of True # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.category_id = category_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/page_type_environment.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_page_v2.py similarity index 86% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/page_type_environment.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_page_v2.py index c327c36c..8d0e7d6b 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/page_type_environment.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_page_v2.py @@ -29,8 +29,12 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError +def lazy_import(): + from criteo_api_retailmedia_preview.model.external_line_item_page_category_v2 import ExternalLineItemPageCategoryV2 + globals()['ExternalLineItemPageCategoryV2'] = ExternalLineItemPageCategoryV2 -class PageTypeEnvironment(ModelNormal): + +class ExternalLineItemPageV2(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,24 +60,19 @@ class PageTypeEnvironment(ModelNormal): allowed_values = { ('page_type',): { - 'SEARCH': "Search", - 'HOME': "Home", - 'BROWSE': "Browse", - 'CHECKOUT': "Checkout", - 'CATEGORY': "Category", - 'PRODUCTDETAIL': "ProductDetail", - 'CONFIRMATION': "Confirmation", - 'MERCHANDISING': "Merchandising", - 'DEALS': "Deals", - }, - ('environments',): { - 'WEB': "Web", - 'MOBILE': "Mobile", - 'APP': "App", - 'LOCKOUT': "Lockout", - 'MIXED': "Mixed", - 'IOS': "iOS", - 'ANDROID': "Android", + 'UNKNOWN': "unknown", + 'SEARCH': "search", + 'HOME': "home", + 'BROWSE': "browse", + 'CHECKOUT': "checkout", + 'CATEGORY': "category", + 'PRODUCTDETAIL': "productDetail", + 'CONFIRMATION': "confirmation", + 'MERCHANDISING': "merchandising", + 'DEALS': "deals", + 'FAVORITES': "favorites", + 'SEARCHBAR': "searchBar", + 'CATEGORYMENU': "categoryMenu", }, } @@ -86,6 +85,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -100,9 +100,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'page_type': (str,), # noqa: E501 - 'environments': ([str],), # noqa: E501 + 'categories': ([ExternalLineItemPageCategoryV2],), # noqa: E501 + 'search_keywords': ([str],), # noqa: E501 } @cached_property @@ -112,7 +114,8 @@ def discriminator(): attribute_map = { 'page_type': 'pageType', # noqa: E501 - 'environments': 'environments', # noqa: E501 + 'categories': 'categories', # noqa: E501 + 'search_keywords': 'searchKeywords', # noqa: E501 } read_only_vars = { @@ -122,8 +125,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PageTypeEnvironment - a model defined in OpenAPI + def _from_openapi_data(cls, page_type, *args, **kwargs): # noqa: E501 + """ExternalLineItemPageV2 - a model defined in OpenAPI + + Args: + page_type (str): Page Type Enum Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -156,8 +162,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - page_type (str): Creative PageType. [optional] # noqa: E501 - environments ([str]): List of environments per PageType. [optional] # noqa: E501 + categories ([ExternalLineItemPageCategoryV2]): [optional] # noqa: E501 + search_keywords ([str]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -189,6 +195,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.page_type = page_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -209,8 +216,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PageTypeEnvironment - a model defined in OpenAPI + def __init__(self, page_type, *args, **kwargs): # noqa: E501 + """ExternalLineItemPageV2 - a model defined in OpenAPI + + Args: + page_type (str): Page Type Enum Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -243,8 +253,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - page_type (str): Creative PageType. [optional] # noqa: E501 - environments ([str]): List of environments per PageType. [optional] # noqa: E501 + categories ([ExternalLineItemPageCategoryV2]): [optional] # noqa: E501 + search_keywords ([str]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -274,6 +284,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.page_type = page_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_create_model202207.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_create_model_v2.py similarity index 74% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_create_model202207.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_create_model_v2.py index 29e40272..68c03ddb 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_create_model202207.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_create_model_v2.py @@ -30,11 +30,13 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue - globals()['TemplateVariableValue'] = TemplateVariableValue + from criteo_api_retailmedia_preview.model.external_line_item_capping_v2 import ExternalLineItemCappingV2 + from criteo_api_retailmedia_preview.model.external_line_item_page_v2 import ExternalLineItemPageV2 + globals()['ExternalLineItemCappingV2'] = ExternalLineItemCappingV2 + globals()['ExternalLineItemPageV2'] = ExternalLineItemPageV2 -class CreativeCreateModel202207(ModelNormal): +class ExternalPreferredLineItemCreateModelV2(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -59,9 +61,29 @@ class CreativeCreateModel202207(ModelNormal): """ allowed_values = { + ('pacing',): { + 'UNKNOWN': "unknown", + 'STANDARD': "standard", + 'ACCELERATED': "accelerated", + }, + ('status',): { + 'UNKNOWN': "unknown", + 'ACTIVE': "active", + 'SCHEDULED': "scheduled", + 'DRAFT': "draft", + 'PAUSED': "paused", + 'BUDGETHIT': "budgetHit", + 'ENDED': "ended", + 'ARCHIVED': "archived", + 'NOFUNDS': "noFunds", + }, } validations = { + ('name',): { + 'max_length': 255, + 'min_length': 0, + }, } @cached_property @@ -88,10 +110,15 @@ def openapi_types(): lazy_import() return { 'name': (str,), # noqa: E501 - 'retailer_id': (int,), # noqa: E501 - 'template_id': (int,), # noqa: E501 - 'template_variable_values': ([TemplateVariableValue],), # noqa: E501 - 'brand_id': (int,), # noqa: E501 + 'start_date': (date,), # noqa: E501 + 'end_date': (date,), # noqa: E501 + 'pacing': (str,), # noqa: E501 + 'page': (ExternalLineItemPageV2,), # noqa: E501 + 'target_retailer_id': (str,), # noqa: E501 + 'budget': (float,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'capping': (ExternalLineItemCappingV2,), # noqa: E501 + 'creative_id': (str, none_type,), # noqa: E501 } @cached_property @@ -101,10 +128,15 @@ def discriminator(): attribute_map = { 'name': 'name', # noqa: E501 - 'retailer_id': 'retailerId', # noqa: E501 - 'template_id': 'templateId', # noqa: E501 - 'template_variable_values': 'templateVariableValues', # noqa: E501 - 'brand_id': 'brandId', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'pacing': 'pacing', # noqa: E501 + 'page': 'page', # noqa: E501 + 'target_retailer_id': 'targetRetailerId', # noqa: E501 + 'budget': 'budget', # noqa: E501 + 'status': 'status', # noqa: E501 + 'capping': 'capping', # noqa: E501 + 'creative_id': 'creativeId', # noqa: E501 } read_only_vars = { @@ -114,14 +146,17 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 - """CreativeCreateModel202207 - a model defined in OpenAPI + def _from_openapi_data(cls, name, start_date, end_date, pacing, page, target_retailer_id, budget, *args, **kwargs): # noqa: E501 + """ExternalPreferredLineItemCreateModelV2 - a model defined in OpenAPI Args: - name (str): The name of the creative - retailer_id (int): The retailer associated to the creative - template_id (int): The creative template used for this creative - template_variable_values ([TemplateVariableValue]): The template chosen values + name (str): + start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + pacing (str): Line Item Pacing Enum + page (ExternalLineItemPageV2): + target_retailer_id (str): + budget (float): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -154,7 +189,9 @@ def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_va Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - brand_id (int): The brand associated to the creative. [optional] # noqa: E501 + status (str): Line Item Status Enum. [optional] # noqa: E501 + capping (ExternalLineItemCappingV2): [optional] # noqa: E501 + creative_id (str, none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -187,9 +224,12 @@ def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_va self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.name = name - self.retailer_id = retailer_id - self.template_id = template_id - self.template_variable_values = template_variable_values + self.start_date = start_date + self.end_date = end_date + self.pacing = pacing + self.page = page + self.target_retailer_id = target_retailer_id + self.budget = budget for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -210,14 +250,17 @@ def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_va ]) @convert_js_args_to_python_args - def __init__(self, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 - """CreativeCreateModel202207 - a model defined in OpenAPI + def __init__(self, name, start_date, end_date, pacing, page, target_retailer_id, budget, *args, **kwargs): # noqa: E501 + """ExternalPreferredLineItemCreateModelV2 - a model defined in OpenAPI Args: - name (str): The name of the creative - retailer_id (int): The retailer associated to the creative - template_id (int): The creative template used for this creative - template_variable_values ([TemplateVariableValue]): The template chosen values + name (str): + start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + pacing (str): Line Item Pacing Enum + page (ExternalLineItemPageV2): + target_retailer_id (str): + budget (float): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -250,7 +293,9 @@ def __init__(self, name, retailer_id, template_id, template_variable_values, *ar Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - brand_id (int): The brand associated to the creative. [optional] # noqa: E501 + status (str): Line Item Status Enum. [optional] # noqa: E501 + capping (ExternalLineItemCappingV2): [optional] # noqa: E501 + creative_id (str, none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -281,9 +326,12 @@ def __init__(self, name, retailer_id, template_id, template_variable_values, *ar self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.name = name - self.retailer_id = retailer_id - self.template_id = template_id - self.template_variable_values = template_variable_values + self.start_date = start_date + self.end_date = end_date + self.pacing = pacing + self.page = page + self.target_retailer_id = target_retailer_id + self.budget = budget for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_catalog_status.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_update_model_v2.py similarity index 75% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_catalog_status.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_update_model_v2.py index 0414d2d4..a0204a2e 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_catalog_status.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_update_model_v2.py @@ -29,8 +29,14 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError +def lazy_import(): + from criteo_api_retailmedia_preview.model.external_line_item_capping_v2 import ExternalLineItemCappingV2 + from criteo_api_retailmedia_preview.model.external_line_item_page_v2 import ExternalLineItemPageV2 + globals()['ExternalLineItemCappingV2'] = ExternalLineItemCappingV2 + globals()['ExternalLineItemPageV2'] = ExternalLineItemPageV2 -class ExternalCatalogStatus(ModelNormal): + +class ExternalPreferredLineItemUpdateModelV2(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,14 +63,27 @@ class ExternalCatalogStatus(ModelNormal): allowed_values = { ('status',): { 'UNKNOWN': "unknown", - 'PENDING': "pending", - 'SUCCESS': "success", - 'FAILURE': "failure", - 'EXPIRED': "expired", + 'ACTIVE': "active", + 'SCHEDULED': "scheduled", + 'DRAFT': "draft", + 'PAUSED': "paused", + 'BUDGETHIT': "budgetHit", + 'ENDED': "ended", + 'ARCHIVED': "archived", + 'NOFUNDS': "noFunds", + }, + ('pacing',): { + 'UNKNOWN': "unknown", + 'STANDARD': "standard", + 'ACCELERATED': "accelerated", }, } validations = { + ('name',): { + 'max_length': 255, + 'min_length': 0, + }, } @cached_property @@ -73,6 +92,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -87,14 +107,17 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { + 'name': (str,), # noqa: E501 + 'start_date': (date,), # noqa: E501 + 'end_date': (date,), # noqa: E501 'status': (str,), # noqa: E501 - 'currency': (str,), # noqa: E501 - 'row_count': (int, none_type,), # noqa: E501 - 'file_size_bytes': (int, none_type,), # noqa: E501 - 'md5_checksum': (str, none_type,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'message': (str, none_type,), # noqa: E501 + 'pacing': (str,), # noqa: E501 + 'capping': (ExternalLineItemCappingV2,), # noqa: E501 + 'page': (ExternalLineItemPageV2,), # noqa: E501 + 'budget': (float,), # noqa: E501 + 'creative_id': (str, none_type,), # noqa: E501 } @cached_property @@ -103,13 +126,15 @@ def discriminator(): attribute_map = { + 'name': 'name', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 'status': 'status', # noqa: E501 - 'currency': 'currency', # noqa: E501 - 'row_count': 'rowCount', # noqa: E501 - 'file_size_bytes': 'fileSizeBytes', # noqa: E501 - 'md5_checksum': 'md5Checksum', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'message': 'message', # noqa: E501 + 'pacing': 'pacing', # noqa: E501 + 'capping': 'capping', # noqa: E501 + 'page': 'page', # noqa: E501 + 'budget': 'budget', # noqa: E501 + 'creative_id': 'creativeId', # noqa: E501 } read_only_vars = { @@ -119,17 +144,14 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, status, currency, row_count, file_size_bytes, md5_checksum, created_at, message, *args, **kwargs): # noqa: E501 - """ExternalCatalogStatus - a model defined in OpenAPI + def _from_openapi_data(cls, name, start_date, end_date, status, *args, **kwargs): # noqa: E501 + """ExternalPreferredLineItemUpdateModelV2 - a model defined in OpenAPI Args: - status (str): An enumeration of the status of the catalog. - currency (str): An ISO4217 representation of the currency products are listed under in this catalog. - row_count (int, none_type): An indication of the number of products contained in this catalog. Available when this catalog reaches a success status. - file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status. - md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval. Available when this catalog reaches a success status. - created_at (datetime): The time this catalog was created. Represented as a UTC ISO8601 string. - message (str, none_type): An optional information message intended for developer consumption. + name (str): + start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + status (str): Line Item Status Enum Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -162,6 +184,11 @@ def _from_openapi_data(cls, status, currency, row_count, file_size_bytes, md5_ch Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + pacing (str): [optional] if omitted the server will use the default value of "accelerated" # noqa: E501 + capping (ExternalLineItemCappingV2): [optional] # noqa: E501 + page (ExternalLineItemPageV2): [optional] # noqa: E501 + budget (float): [optional] # noqa: E501 + creative_id (str, none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -193,13 +220,10 @@ def _from_openapi_data(cls, status, currency, row_count, file_size_bytes, md5_ch self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.name = name + self.start_date = start_date + self.end_date = end_date self.status = status - self.currency = currency - self.row_count = row_count - self.file_size_bytes = file_size_bytes - self.md5_checksum = md5_checksum - self.created_at = created_at - self.message = message for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -220,17 +244,14 @@ def _from_openapi_data(cls, status, currency, row_count, file_size_bytes, md5_ch ]) @convert_js_args_to_python_args - def __init__(self, status, currency, row_count, file_size_bytes, md5_checksum, created_at, message, *args, **kwargs): # noqa: E501 - """ExternalCatalogStatus - a model defined in OpenAPI + def __init__(self, name, start_date, end_date, status, *args, **kwargs): # noqa: E501 + """ExternalPreferredLineItemUpdateModelV2 - a model defined in OpenAPI Args: - status (str): An enumeration of the status of the catalog. - currency (str): An ISO4217 representation of the currency products are listed under in this catalog. - row_count (int, none_type): An indication of the number of products contained in this catalog. Available when this catalog reaches a success status. - file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status. - md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval. Available when this catalog reaches a success status. - created_at (datetime): The time this catalog was created. Represented as a UTC ISO8601 string. - message (str, none_type): An optional information message intended for developer consumption. + name (str): + start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + status (str): Line Item Status Enum Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -263,6 +284,11 @@ def __init__(self, status, currency, row_count, file_size_bytes, md5_checksum, c Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + pacing (str): [optional] if omitted the server will use the default value of "accelerated" # noqa: E501 + capping (ExternalLineItemCappingV2): [optional] # noqa: E501 + page (ExternalLineItemPageV2): [optional] # noqa: E501 + budget (float): [optional] # noqa: E501 + creative_id (str, none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -292,13 +318,10 @@ def __init__(self, status, currency, row_count, file_size_bytes, md5_checksum, c self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.name = name + self.start_date = start_date + self.end_date = end_date self.status = status - self.currency = currency - self.row_count = row_count - self.file_size_bytes = file_size_bytes - self.md5_checksum = md5_checksum - self.created_at = created_at - self.message = message for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_v2.py similarity index 70% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_v2.py index 55daa20d..57a547ce 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_preferred_line_item_v2.py @@ -30,11 +30,13 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.section import Section - globals()['Section'] = Section + from criteo_api_retailmedia_preview.model.external_line_item_capping_v2 import ExternalLineItemCappingV2 + from criteo_api_retailmedia_preview.model.external_line_item_page_v2 import ExternalLineItemPageV2 + globals()['ExternalLineItemCappingV2'] = ExternalLineItemCappingV2 + globals()['ExternalLineItemPageV2'] = ExternalLineItemPageV2 -class Template(ModelNormal): +class ExternalPreferredLineItemV2(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -59,21 +61,30 @@ class Template(ModelNormal): """ allowed_values = { - ('creative_format',): { - 'UNKNOWN': "Unknown", - 'FLAGSHIP': "FlagShip", - 'SHOWCASE': "Showcase", - 'SPONSOREDPRODUCTS': "SponsoredProducts", - 'BUTTERFLY': "Butterfly", - 'BUNDLEBOOST': "BundleBoost", - 'IAB': "IAB", - 'CUSTOM': "CUSTOM", - 'DISPLAYPANEL': "DisplayPanel", - 'DIGITALSHELFTALKER': "DigitalShelfTalker", + ('status',): { + 'UNKNOWN': "unknown", + 'ACTIVE': "active", + 'SCHEDULED': "scheduled", + 'DRAFT': "draft", + 'PAUSED': "paused", + 'BUDGETHIT': "budgetHit", + 'ENDED': "ended", + 'ARCHIVED': "archived", + 'NOFUNDS': "noFunds", + }, + ('pacing',): { + 'None': None, + 'UNKNOWN': "unknown", + 'STANDARD': "standard", + 'ACCELERATED': "accelerated", }, } validations = { + ('name',): { + 'max_length': 255, + 'min_length': 0, + }, } @cached_property @@ -99,18 +110,21 @@ def openapi_types(): """ lazy_import() return { - 'creative_format': (str,), # noqa: E501 'name': (str,), # noqa: E501 - 'sku_collection_min': (int,), # noqa: E501 - 'sku_per_collection_min': (int,), # noqa: E501 - 'all_collections_mandatory': (bool,), # noqa: E501 + 'start_date': (date,), # noqa: E501 + 'end_date': (date,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'target_retailer_id': (str,), # noqa: E501 + 'campaign_id': (str,), # noqa: E501 'created_at': (datetime,), # noqa: E501 'updated_at': (datetime,), # noqa: E501 - 'sections': ([Section],), # noqa: E501 - 'retailer_id': (int,), # noqa: E501 - 'sku_collection_max': (int, none_type,), # noqa: E501 - 'sku_per_collection_max': (int, none_type,), # noqa: E501 - 'displayable_skus_max': (int, none_type,), # noqa: E501 + 'pacing': (str, none_type,), # noqa: E501 + 'capping': (ExternalLineItemCappingV2,), # noqa: E501 + 'page': (ExternalLineItemPageV2,), # noqa: E501 + 'budget': (float, none_type,), # noqa: E501 + 'budget_spent': (float, none_type,), # noqa: E501 + 'budget_remaining': (float, none_type,), # noqa: E501 + 'creative_id': (str, none_type,), # noqa: E501 } @cached_property @@ -119,18 +133,21 @@ def discriminator(): attribute_map = { - 'creative_format': 'creativeFormat', # noqa: E501 'name': 'name', # noqa: E501 - 'sku_collection_min': 'skuCollectionMin', # noqa: E501 - 'sku_per_collection_min': 'skuPerCollectionMin', # noqa: E501 - 'all_collections_mandatory': 'allCollectionsMandatory', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'status': 'status', # noqa: E501 + 'target_retailer_id': 'targetRetailerId', # noqa: E501 + 'campaign_id': 'campaignId', # noqa: E501 'created_at': 'createdAt', # noqa: E501 'updated_at': 'updatedAt', # noqa: E501 - 'sections': 'sections', # noqa: E501 - 'retailer_id': 'retailerId', # noqa: E501 - 'sku_collection_max': 'skuCollectionMax', # noqa: E501 - 'sku_per_collection_max': 'skuPerCollectionMax', # noqa: E501 - 'displayable_skus_max': 'displayableSkusMax', # noqa: E501 + 'pacing': 'pacing', # noqa: E501 + 'capping': 'capping', # noqa: E501 + 'page': 'page', # noqa: E501 + 'budget': 'budget', # noqa: E501 + 'budget_spent': 'budgetSpent', # noqa: E501 + 'budget_remaining': 'budgetRemaining', # noqa: E501 + 'creative_id': 'creativeId', # noqa: E501 } read_only_vars = { @@ -140,18 +157,18 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, creative_format, name, sku_collection_min, sku_per_collection_min, all_collections_mandatory, created_at, updated_at, sections, *args, **kwargs): # noqa: E501 - """Template - a model defined in OpenAPI + def _from_openapi_data(cls, name, start_date, end_date, status, target_retailer_id, campaign_id, created_at, updated_at, *args, **kwargs): # noqa: E501 + """ExternalPreferredLineItemV2 - a model defined in OpenAPI Args: - creative_format (str): The kind of creative this template can be used to build. - name (str): The name of the template - sku_collection_min (int): TODO: what is it ? - sku_per_collection_min (int): TODO: what is it ? - all_collections_mandatory (bool): TODO: what is it ? - created_at (datetime): The time at which the template was created - updated_at (datetime): The time at which the template was updated - sections ([Section]): The sections holding various template variables + name (str): + start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + status (str): Line Item Status Enum + target_retailer_id (str): + campaign_id (str): + created_at (datetime): + updated_at (datetime): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -184,10 +201,13 @@ def _from_openapi_data(cls, creative_format, name, sku_collection_min, sku_per_c Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - retailer_id (int): The retailer associated to the template. [optional] # noqa: E501 - sku_collection_max (int, none_type): TODO: what is it ?. [optional] # noqa: E501 - sku_per_collection_max (int, none_type): TODO: what is it ?. [optional] # noqa: E501 - displayable_skus_max (int, none_type): TODO: what is it ?. [optional] # noqa: E501 + pacing (str, none_type): [optional] # noqa: E501 + capping (ExternalLineItemCappingV2): [optional] # noqa: E501 + page (ExternalLineItemPageV2): [optional] # noqa: E501 + budget (float, none_type): [optional] # noqa: E501 + budget_spent (float, none_type): [optional] # noqa: E501 + budget_remaining (float, none_type): [optional] # noqa: E501 + creative_id (str, none_type): External creative Id. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -219,14 +239,14 @@ def _from_openapi_data(cls, creative_format, name, sku_collection_min, sku_per_c self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.creative_format = creative_format self.name = name - self.sku_collection_min = sku_collection_min - self.sku_per_collection_min = sku_per_collection_min - self.all_collections_mandatory = all_collections_mandatory + self.start_date = start_date + self.end_date = end_date + self.status = status + self.target_retailer_id = target_retailer_id + self.campaign_id = campaign_id self.created_at = created_at self.updated_at = updated_at - self.sections = sections for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -247,18 +267,18 @@ def _from_openapi_data(cls, creative_format, name, sku_collection_min, sku_per_c ]) @convert_js_args_to_python_args - def __init__(self, creative_format, name, sku_collection_min, sku_per_collection_min, all_collections_mandatory, created_at, updated_at, sections, *args, **kwargs): # noqa: E501 - """Template - a model defined in OpenAPI + def __init__(self, name, start_date, end_date, status, target_retailer_id, campaign_id, created_at, updated_at, *args, **kwargs): # noqa: E501 + """ExternalPreferredLineItemV2 - a model defined in OpenAPI Args: - creative_format (str): The kind of creative this template can be used to build. - name (str): The name of the template - sku_collection_min (int): TODO: what is it ? - sku_per_collection_min (int): TODO: what is it ? - all_collections_mandatory (bool): TODO: what is it ? - created_at (datetime): The time at which the template was created - updated_at (datetime): The time at which the template was updated - sections ([Section]): The sections holding various template variables + name (str): + start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD + status (str): Line Item Status Enum + target_retailer_id (str): + campaign_id (str): + created_at (datetime): + updated_at (datetime): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -291,10 +311,13 @@ def __init__(self, creative_format, name, sku_collection_min, sku_per_collection Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - retailer_id (int): The retailer associated to the template. [optional] # noqa: E501 - sku_collection_max (int, none_type): TODO: what is it ?. [optional] # noqa: E501 - sku_per_collection_max (int, none_type): TODO: what is it ?. [optional] # noqa: E501 - displayable_skus_max (int, none_type): TODO: what is it ?. [optional] # noqa: E501 + pacing (str, none_type): [optional] # noqa: E501 + capping (ExternalLineItemCappingV2): [optional] # noqa: E501 + page (ExternalLineItemPageV2): [optional] # noqa: E501 + budget (float, none_type): [optional] # noqa: E501 + budget_spent (float, none_type): [optional] # noqa: E501 + budget_remaining (float, none_type): [optional] # noqa: E501 + creative_id (str, none_type): External creative Id. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -324,14 +347,14 @@ def __init__(self, creative_format, name, sku_collection_min, sku_per_collection self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.creative_format = creative_format self.name = name - self.sku_collection_min = sku_collection_min - self.sku_per_collection_min = sku_per_collection_min - self.all_collections_mandatory = all_collections_mandatory + self.start_date = start_date + self.end_date = end_date + self.status = status + self.target_retailer_id = target_retailer_id + self.campaign_id = campaign_id self.created_at = created_at self.updated_at = updated_at - self.sections = sections for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/fail_response.py similarity index 90% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/fail_response.py index ae7c958f..bd2ee52a 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/fail_response.py @@ -30,11 +30,13 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.external_catalog_status import ExternalCatalogStatus - globals()['ExternalCatalogStatus'] = ExternalCatalogStatus + from criteo_api_retailmedia_preview.model.product_importer_error import ProductImporterError + from criteo_api_retailmedia_preview.model.product_importer_warning import ProductImporterWarning + globals()['ProductImporterError'] = ProductImporterError + globals()['ProductImporterWarning'] = ProductImporterWarning -class JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus(ModelNormal): +class FailResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -87,9 +89,8 @@ def openapi_types(): """ lazy_import() return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (ExternalCatalogStatus,), # noqa: E501 + 'errors': ([ProductImporterError],), # noqa: E501 + 'warnings': ([ProductImporterWarning],), # noqa: E501 } @cached_property @@ -98,9 +99,8 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 } read_only_vars = { @@ -110,12 +110,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus - a model defined in OpenAPI + def _from_openapi_data(cls, errors, warnings, *args, **kwargs): # noqa: E501 + """FailResponse - a model defined in OpenAPI Args: - id (str): - type (str): + errors ([ProductImporterError]): List of errors + warnings ([ProductImporterWarning]): List of warnings Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -148,7 +148,6 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (ExternalCatalogStatus): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -180,8 +179,8 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.type = type + self.errors = errors + self.warnings = warnings for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -202,12 +201,12 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus - a model defined in OpenAPI + def __init__(self, errors, warnings, *args, **kwargs): # noqa: E501 + """FailResponse - a model defined in OpenAPI Args: - id (str): - type (str): + errors ([ProductImporterError]): List of errors + warnings ([ProductImporterWarning]): List of warnings Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -240,7 +239,6 @@ def __init__(self, id, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (ExternalCatalogStatus): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -270,8 +268,8 @@ def __init__(self, id, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.type = type + self.errors = errors + self.warnings = warnings for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/files_variables_specification.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/files_variables_specification.py deleted file mode 100644 index 0b097531..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/files_variables_specification.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: Preview - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from criteo_api_retailmedia_preview.exceptions import ApiAttributeError - - - -class FilesVariablesSpecification(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('extensions',): { - 'UNKNOWN': "Unknown", - 'JPEG': "Jpeg", - 'PNG': "Png", - 'GIF': "Gif", - 'PDF': "Pdf", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'extensions': ([str],), # noqa: E501 - 'min_files': (int, none_type,), # noqa: E501 - 'max_bytes': (int, none_type,), # noqa: E501 - 'max_file': (int, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'extensions': 'extensions', # noqa: E501 - 'min_files': 'minFiles', # noqa: E501 - 'max_bytes': 'maxBytes', # noqa: E501 - 'max_file': 'maxFile', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, extensions, min_files, *args, **kwargs): # noqa: E501 - """FilesVariablesSpecification - a model defined in OpenAPI - - Args: - extensions ([str]): The accepted file extensions - min_files (int, none_type): The minimum amount of files requires - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - max_bytes (int, none_type): The maximum amount of bytes per file. [optional] # noqa: E501 - max_file (int, none_type): The maximum amount of files required. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.extensions = extensions - self.min_files = min_files - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, extensions, min_files, *args, **kwargs): # noqa: E501 - """FilesVariablesSpecification - a model defined in OpenAPI - - Args: - extensions ([str]): The accepted file extensions - min_files (int, none_type): The minimum amount of files requires - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - max_bytes (int, none_type): The maximum amount of bytes per file. [optional] # noqa: E501 - max_file (int, none_type): The maximum amount of files required. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.extensions = extensions - self.min_files = min_files - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/input_resource_of_preferred_line_item_create_model_v2.py similarity index 91% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/input_resource_of_preferred_line_item_create_model_v2.py index f8ce2c98..cc5b3b1b 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/input_resource_of_preferred_line_item_create_model_v2.py @@ -30,11 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.external_catalog_request_preview import ExternalCatalogRequestPreview - globals()['ExternalCatalogRequestPreview'] = ExternalCatalogRequestPreview + from criteo_api_retailmedia_preview.model.external_preferred_line_item_create_model_v2 import ExternalPreferredLineItemCreateModelV2 + globals()['ExternalPreferredLineItemCreateModelV2'] = ExternalPreferredLineItemCreateModelV2 -class JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview(ModelNormal): +class InputResourceOfPreferredLineItemCreateModelV2(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -88,7 +88,7 @@ def openapi_types(): lazy_import() return { 'type': (str,), # noqa: E501 - 'attributes': (ExternalCatalogRequestPreview,), # noqa: E501 + 'attributes': (ExternalPreferredLineItemCreateModelV2,), # noqa: E501 } @cached_property @@ -108,11 +108,8 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview - a model defined in OpenAPI - - Args: - type (str): + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InputResourceOfPreferredLineItemCreateModelV2 - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -145,7 +142,8 @@ def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (ExternalCatalogRequestPreview): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + attributes (ExternalPreferredLineItemCreateModelV2): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -177,7 +175,6 @@ def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -198,11 +195,8 @@ def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview - a model defined in OpenAPI - - Args: - type (str): + def __init__(self, *args, **kwargs): # noqa: E501 + """InputResourceOfPreferredLineItemCreateModelV2 - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -235,7 +229,8 @@ def __init__(self, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (ExternalCatalogRequestPreview): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + attributes (ExternalPreferredLineItemCreateModelV2): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -265,7 +260,6 @@ def __init__(self, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_variable_specification.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture.py similarity index 78% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_variable_specification.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture.py index 6e9884b6..cd1f50a1 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_variable_specification.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture.py @@ -30,11 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.choice_option import ChoiceOption - globals()['ChoiceOption'] = ChoiceOption + from criteo_api_retailmedia_preview.model.change_details import ChangeDetails + globals()['ChangeDetails'] = ChangeDetails -class ChoiceVariableSpecification(ModelNormal): +class InsertionOrderHistoryChangeDataCapture(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -59,19 +59,25 @@ class ChoiceVariableSpecification(ModelNormal): """ allowed_values = { + ('change_type',): { + 'BALANCECREATED': "BalanceCreated", + 'BALANCEADDED': "BalanceAdded", + 'BALANCEREMOVED': "BalanceRemoved", + 'BALANCEUNCAPPED': "BalanceUncapped", + 'BALANCECAPPED': "BalanceCapped", + 'ENDDATE': "EndDate", + 'STARTDATE': "StartDate", + 'BALANCENAME': "BalanceName", + 'PONUMBER': "PoNumber", + 'VALUEADD': "ValueAdd", + 'SALESFORCEID': "SalesforceId", + }, } validations = { } - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + additional_properties_type = None _nullable = False @@ -87,9 +93,11 @@ def openapi_types(): """ lazy_import() return { - 'options': ([ChoiceOption],), # noqa: E501 - 'max_selected': (int, none_type,), # noqa: E501 - 'min_selected': (int, none_type,), # noqa: E501 + 'date_of_modification': (datetime,), # noqa: E501 + 'modified_by_user': (str,), # noqa: E501 + 'change_type': (str,), # noqa: E501 + 'change_details': (ChangeDetails,), # noqa: E501 + 'memo': (str, none_type,), # noqa: E501 } @cached_property @@ -98,9 +106,11 @@ def discriminator(): attribute_map = { - 'options': 'options', # noqa: E501 - 'max_selected': 'maxSelected', # noqa: E501 - 'min_selected': 'minSelected', # noqa: E501 + 'date_of_modification': 'dateOfModification', # noqa: E501 + 'modified_by_user': 'modifiedByUser', # noqa: E501 + 'change_type': 'changeType', # noqa: E501 + 'change_details': 'changeDetails', # noqa: E501 + 'memo': 'memo', # noqa: E501 } read_only_vars = { @@ -110,11 +120,14 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, options, *args, **kwargs): # noqa: E501 - """ChoiceVariableSpecification - a model defined in OpenAPI + def _from_openapi_data(cls, date_of_modification, modified_by_user, change_type, change_details, *args, **kwargs): # noqa: E501 + """InsertionOrderHistoryChangeDataCapture - a model defined in OpenAPI Args: - options ([ChoiceOption]): The available options + date_of_modification (datetime): Date when data change has occured. + modified_by_user (str): User name who modified the insertion order. + change_type (str): Represent the type of change states of the history. + change_details (ChangeDetails): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -147,8 +160,7 @@ def _from_openapi_data(cls, options, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - max_selected (int, none_type): The maximum number of selectable options. [optional] # noqa: E501 - min_selected (int, none_type): The minimum number of selectable options. [optional] # noqa: E501 + memo (str, none_type): Memo associate with the insertion order modification.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -180,7 +192,10 @@ def _from_openapi_data(cls, options, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.options = options + self.date_of_modification = date_of_modification + self.modified_by_user = modified_by_user + self.change_type = change_type + self.change_details = change_details for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -201,11 +216,14 @@ def _from_openapi_data(cls, options, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, options, *args, **kwargs): # noqa: E501 - """ChoiceVariableSpecification - a model defined in OpenAPI + def __init__(self, date_of_modification, modified_by_user, change_type, change_details, *args, **kwargs): # noqa: E501 + """InsertionOrderHistoryChangeDataCapture - a model defined in OpenAPI Args: - options ([ChoiceOption]): The available options + date_of_modification (datetime): Date when data change has occured. + modified_by_user (str): User name who modified the insertion order. + change_type (str): Represent the type of change states of the history. + change_details (ChangeDetails): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -238,8 +256,7 @@ def __init__(self, options, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - max_selected (int, none_type): The maximum number of selectable options. [optional] # noqa: E501 - min_selected (int, none_type): The minimum number of selectable options. [optional] # noqa: E501 + memo (str, none_type): Memo associate with the insertion order modification.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -269,7 +286,10 @@ def __init__(self, options, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.options = options + self.date_of_modification = date_of_modification + self.modified_by_user = modified_by_user + self.change_type = change_type + self.change_details = change_details for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/installment.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/installment.py new file mode 100644 index 00000000..d828133c --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/installment.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.price import Price + globals()['Price'] = Price + + +class Installment(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'months': (int, none_type,), # noqa: E501 + 'amount': (Price,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'months': 'months', # noqa: E501 + 'amount': 'amount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Installment - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + months (int, none_type): The number of installments the buyer has to pay.. [optional] # noqa: E501 + amount (Price): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Installment - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + months (int, none_type): The number of installments the buyer has to pay.. [optional] # noqa: E501 + amount (Price): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py deleted file mode 100644 index 5c44007d..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: Preview - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from criteo_api_retailmedia_preview.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_preview.model.common_error import CommonError - from criteo_api_retailmedia_preview.model.common_warning import CommonWarning - from criteo_api_retailmedia_preview.model.json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status import JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus - globals()['CommonError'] = CommonError - globals()['CommonWarning'] = CommonWarning - globals()['JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus'] = JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus - - -class JsonApiSingleResponseOfCatalogStatus(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus,), # noqa: E501 - 'errors': ([CommonError],), # noqa: E501 - 'warnings': ([CommonWarning],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'errors': 'errors', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiSingleResponseOfCatalogStatus - a model defined in OpenAPI - - Args: - data (JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - errors ([CommonError]): [optional] # noqa: E501 - warnings ([CommonWarning]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiSingleResponseOfCatalogStatus - a model defined in OpenAPI - - Args: - data (JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - errors ([CommonError]): [optional] # noqa: E501 - warnings ([CommonWarning]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/loyalty_points.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/loyalty_points.py new file mode 100644 index 00000000..53dcc80a --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/loyalty_points.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + + +class LoyaltyPoints(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str, none_type,), # noqa: E501 + 'points_value': (int, none_type,), # noqa: E501 + 'ratio': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'points_value': 'pointsValue', # noqa: E501 + 'ratio': 'ratio', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LoyaltyPoints - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str, none_type): Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.. [optional] # noqa: E501 + points_value (int, none_type): The retailer's loyalty points in absolute value.. [optional] # noqa: E501 + ratio (float, none_type): The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LoyaltyPoints - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str, none_type): Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.. [optional] # noqa: E501 + points_value (int, none_type): The retailer's loyalty points in absolute value.. [optional] # noqa: E501 + ratio (float, none_type): The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/metadata.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/metadata.py new file mode 100644 index 00000000..c0b426bb --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/metadata.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + + +class Metadata(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'offset': (int,), # noqa: E501 + 'limit': (int,), # noqa: E501 + 'count': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'offset': 'offset', # noqa: E501 + 'limit': 'limit', # noqa: E501 + 'count': 'count', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, offset, limit, *args, **kwargs): # noqa: E501 + """Metadata - a model defined in OpenAPI + + Args: + offset (int): The (zero-based) starting offset in the collection. + limit (int): The number of elements to be returned. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + count (int, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.offset = offset + self.limit = limit + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, offset, limit, *args, **kwargs): # noqa: E501 + """Metadata - a model defined in OpenAPI + + Args: + offset (int): The (zero-based) starting offset in the collection. + limit (int): The number of elements to be returned. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + count (int, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.offset = offset + self.limit = limit + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py new file mode 100644 index 00000000..f831b0e0 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py @@ -0,0 +1,276 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.insertion_order_history_change_data_capture import InsertionOrderHistoryChangeDataCapture + from criteo_api_retailmedia_preview.model.metadata import Metadata + globals()['InsertionOrderHistoryChangeDataCapture'] = InsertionOrderHistoryChangeDataCapture + globals()['Metadata'] = Metadata + + +class PageOfInsertionOrderHistoryChangeDataCapture(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'meta': (Metadata,), # noqa: E501 + 'data': ([InsertionOrderHistoryChangeDataCapture],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'meta': 'meta', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, meta, data, *args, **kwargs): # noqa: E501 + """PageOfInsertionOrderHistoryChangeDataCapture - a model defined in OpenAPI + + Args: + meta (Metadata): + data ([InsertionOrderHistoryChangeDataCapture]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.meta = meta + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, meta, data, *args, **kwargs): # noqa: E501 + """PageOfInsertionOrderHistoryChangeDataCapture - a model defined in OpenAPI + + Args: + meta (Metadata): + data ([InsertionOrderHistoryChangeDataCapture]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.meta = meta + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_request_of_catalog_request_preview.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_create_model_v2_request.py similarity index 93% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_request_of_catalog_request_preview.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_create_model_v2_request.py index a7843aca..9ad3dc5f 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_request_of_catalog_request_preview.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_create_model_v2_request.py @@ -30,11 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.json_api_body_without_id_of_catalog_request_and_catalog_request_preview import JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview - globals()['JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview'] = JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview + from criteo_api_retailmedia_preview.model.input_resource_of_preferred_line_item_create_model_v2 import InputResourceOfPreferredLineItemCreateModelV2 + globals()['InputResourceOfPreferredLineItemCreateModelV2'] = InputResourceOfPreferredLineItemCreateModelV2 -class JsonApiRequestOfCatalogRequestPreview(ModelNormal): +class PreferredLineItemCreateModelV2Request(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -87,7 +87,7 @@ def openapi_types(): """ lazy_import() return { - 'data': (JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview,), # noqa: E501 + 'data': (InputResourceOfPreferredLineItemCreateModelV2,), # noqa: E501 } @cached_property @@ -107,7 +107,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiRequestOfCatalogRequestPreview - a model defined in OpenAPI + """PreferredLineItemCreateModelV2Request - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -140,7 +140,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data (JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview): [optional] # noqa: E501 + data (InputResourceOfPreferredLineItemCreateModelV2): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -193,7 +193,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiRequestOfCatalogRequestPreview - a model defined in OpenAPI + """PreferredLineItemCreateModelV2Request - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -226,7 +226,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data (JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview): [optional] # noqa: E501 + data (InputResourceOfPreferredLineItemCreateModelV2): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_update_model_v2_request.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_update_model_v2_request.py new file mode 100644 index 00000000..0d8cece9 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_update_model_v2_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.resource_of_preferred_line_item_update_model_v2 import ResourceOfPreferredLineItemUpdateModelV2 + globals()['ResourceOfPreferredLineItemUpdateModelV2'] = ResourceOfPreferredLineItemUpdateModelV2 + + +class PreferredLineItemUpdateModelV2Request(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (ResourceOfPreferredLineItemUpdateModelV2,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PreferredLineItemUpdateModelV2Request - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (ResourceOfPreferredLineItemUpdateModelV2): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PreferredLineItemUpdateModelV2Request - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (ResourceOfPreferredLineItemUpdateModelV2): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_v2_paged_list_response.py similarity index 88% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210_response.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_v2_paged_list_response.py index 5980f4ce..354dbffa 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210_response.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_v2_paged_list_response.py @@ -30,13 +30,15 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.problem_details import ProblemDetails - from criteo_api_retailmedia_preview.model.resource_of_creative202210 import ResourceOfCreative202210 - globals()['ProblemDetails'] = ProblemDetails - globals()['ResourceOfCreative202210'] = ResourceOfCreative202210 + from criteo_api_retailmedia_preview.model.common_problem import CommonProblem + from criteo_api_retailmedia_preview.model.page_metadata import PageMetadata + from criteo_api_retailmedia_preview.model.resource_of_preferred_line_item_v2 import ResourceOfPreferredLineItemV2 + globals()['CommonProblem'] = CommonProblem + globals()['PageMetadata'] = PageMetadata + globals()['ResourceOfPreferredLineItemV2'] = ResourceOfPreferredLineItemV2 -class Creative202210Response(ModelNormal): +class PreferredLineItemV2PagedListResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -89,9 +91,10 @@ def openapi_types(): """ lazy_import() return { - 'data': (ResourceOfCreative202210,), # noqa: E501 - 'warnings': ([ProblemDetails],), # noqa: E501 - 'errors': ([ProblemDetails],), # noqa: E501 + 'metadata': (PageMetadata,), # noqa: E501 + 'data': ([ResourceOfPreferredLineItemV2],), # noqa: E501 + 'warnings': ([CommonProblem],), # noqa: E501 + 'errors': ([CommonProblem],), # noqa: E501 } @cached_property @@ -100,6 +103,7 @@ def discriminator(): attribute_map = { + 'metadata': 'metadata', # noqa: E501 'data': 'data', # noqa: E501 'warnings': 'warnings', # noqa: E501 'errors': 'errors', # noqa: E501 @@ -115,7 +119,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Creative202210Response - a model defined in OpenAPI + """PreferredLineItemV2PagedListResponse - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -148,9 +152,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data (ResourceOfCreative202210): [optional] # noqa: E501 - warnings ([ProblemDetails]): [optional] # noqa: E501 - errors ([ProblemDetails]): [optional] # noqa: E501 + metadata (PageMetadata): [optional] # noqa: E501 + data ([ResourceOfPreferredLineItemV2]): [optional] # noqa: E501 + warnings ([CommonProblem]): [optional] # noqa: E501 + errors ([CommonProblem]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -203,7 +208,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """Creative202210Response - a model defined in OpenAPI + """PreferredLineItemV2PagedListResponse - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -236,9 +241,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data (ResourceOfCreative202210): [optional] # noqa: E501 - warnings ([ProblemDetails]): [optional] # noqa: E501 - errors ([ProblemDetails]): [optional] # noqa: E501 + metadata (PageMetadata): [optional] # noqa: E501 + data ([ResourceOfPreferredLineItemV2]): [optional] # noqa: E501 + warnings ([CommonProblem]): [optional] # noqa: E501 + errors ([CommonProblem]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210_list_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_v2_response.py similarity index 91% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210_list_response.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_v2_response.py index 3967aae9..a8cd2579 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative202210_list_response.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/preferred_line_item_v2_response.py @@ -30,13 +30,13 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.problem_details import ProblemDetails - from criteo_api_retailmedia_preview.model.resource_of_creative202210 import ResourceOfCreative202210 - globals()['ProblemDetails'] = ProblemDetails - globals()['ResourceOfCreative202210'] = ResourceOfCreative202210 + from criteo_api_retailmedia_preview.model.common_problem import CommonProblem + from criteo_api_retailmedia_preview.model.resource_of_preferred_line_item_v2 import ResourceOfPreferredLineItemV2 + globals()['CommonProblem'] = CommonProblem + globals()['ResourceOfPreferredLineItemV2'] = ResourceOfPreferredLineItemV2 -class Creative202210ListResponse(ModelNormal): +class PreferredLineItemV2Response(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -89,9 +89,9 @@ def openapi_types(): """ lazy_import() return { - 'data': ([ResourceOfCreative202210],), # noqa: E501 - 'warnings': ([ProblemDetails],), # noqa: E501 - 'errors': ([ProblemDetails],), # noqa: E501 + 'data': (ResourceOfPreferredLineItemV2,), # noqa: E501 + 'warnings': ([CommonProblem],), # noqa: E501 + 'errors': ([CommonProblem],), # noqa: E501 } @cached_property @@ -115,7 +115,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Creative202210ListResponse - a model defined in OpenAPI + """PreferredLineItemV2Response - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -148,9 +148,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data ([ResourceOfCreative202210]): [optional] # noqa: E501 - warnings ([ProblemDetails]): [optional] # noqa: E501 - errors ([ProblemDetails]): [optional] # noqa: E501 + data (ResourceOfPreferredLineItemV2): [optional] # noqa: E501 + warnings ([CommonProblem]): [optional] # noqa: E501 + errors ([CommonProblem]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -203,7 +203,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """Creative202210ListResponse - a model defined in OpenAPI + """PreferredLineItemV2Response - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -236,9 +236,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data ([ResourceOfCreative202210]): [optional] # noqa: E501 - warnings ([ProblemDetails]): [optional] # noqa: E501 - errors ([ProblemDetails]): [optional] # noqa: E501 + data (ResourceOfPreferredLineItemV2): [optional] # noqa: E501 + warnings ([CommonProblem]): [optional] # noqa: E501 + errors ([CommonProblem]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/price.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/price.py new file mode 100644 index 00000000..acd1dc45 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/price.py @@ -0,0 +1,267 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + + +class Price(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'currency': (str, none_type,), # noqa: E501 + 'value': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'currency': 'currency', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Price - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + currency (str, none_type): The currency of the price.. [optional] # noqa: E501 + value (str, none_type): The price represented as a number. See JSON's number specification for more details.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Price - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + currency (str, none_type): The currency of the price.. [optional] # noqa: E501 + value (str, none_type): The price represented as a number. See JSON's number specification for more details.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product.py new file mode 100644 index 00000000..9b28adea --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product.py @@ -0,0 +1,626 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.custom_attribute import CustomAttribute + from criteo_api_retailmedia_preview.model.installment import Installment + from criteo_api_retailmedia_preview.model.loyalty_points import LoyaltyPoints + from criteo_api_retailmedia_preview.model.price import Price + from criteo_api_retailmedia_preview.model.product_shipping import ProductShipping + from criteo_api_retailmedia_preview.model.product_shipping_dimension import ProductShippingDimension + from criteo_api_retailmedia_preview.model.product_shipping_weight import ProductShippingWeight + from criteo_api_retailmedia_preview.model.product_tax import ProductTax + from criteo_api_retailmedia_preview.model.product_unit_pricing_base_measure import ProductUnitPricingBaseMeasure + from criteo_api_retailmedia_preview.model.product_unit_pricing_measure import ProductUnitPricingMeasure + globals()['CustomAttribute'] = CustomAttribute + globals()['Installment'] = Installment + globals()['LoyaltyPoints'] = LoyaltyPoints + globals()['Price'] = Price + globals()['ProductShipping'] = ProductShipping + globals()['ProductShippingDimension'] = ProductShippingDimension + globals()['ProductShippingWeight'] = ProductShippingWeight + globals()['ProductTax'] = ProductTax + globals()['ProductUnitPricingBaseMeasure'] = ProductUnitPricingBaseMeasure + globals()['ProductUnitPricingMeasure'] = ProductUnitPricingMeasure + + +class Product(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('channel',): { + 'ONLINE': "online", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'link': (str,), # noqa: E501 + 'image_link': (str,), # noqa: E501 + 'channel': (str,), # noqa: E501 + 'offer_id': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'additional_image_links': ([str], none_type,), # noqa: E501 + 'content_language': (str, none_type,), # noqa: E501 + 'target_country': (str, none_type,), # noqa: E501 + 'expiration_date': (str, none_type,), # noqa: E501 + 'adult': (bool, none_type,), # noqa: E501 + 'kind': (str, none_type,), # noqa: E501 + 'brand': (str, none_type,), # noqa: E501 + 'color': (str, none_type,), # noqa: E501 + 'google_product_category': (str, none_type,), # noqa: E501 + 'gtin': (str, none_type,), # noqa: E501 + 'item_group_id': (str, none_type,), # noqa: E501 + 'material': (str, none_type,), # noqa: E501 + 'mpn': (str, none_type,), # noqa: E501 + 'pattern': (str, none_type,), # noqa: E501 + 'price': (Price,), # noqa: E501 + 'sale_price': (Price,), # noqa: E501 + 'sale_price_effective_date': (str, none_type,), # noqa: E501 + 'shipping': ([ProductShipping], none_type,), # noqa: E501 + 'shipping_weight': (ProductShippingWeight,), # noqa: E501 + 'sizes': ([str], none_type,), # noqa: E501 + 'taxes': ([ProductTax], none_type,), # noqa: E501 + 'custom_attributes': ([CustomAttribute], none_type,), # noqa: E501 + 'identifier_exists': (bool, none_type,), # noqa: E501 + 'installment': (Installment,), # noqa: E501 + 'loyalty_points': (LoyaltyPoints,), # noqa: E501 + 'multipack': (int, none_type,), # noqa: E501 + 'custom_label0': (str, none_type,), # noqa: E501 + 'custom_label1': (str, none_type,), # noqa: E501 + 'custom_label2': (str, none_type,), # noqa: E501 + 'custom_label3': (str, none_type,), # noqa: E501 + 'custom_label4': (str, none_type,), # noqa: E501 + 'is_bundle': (bool, none_type,), # noqa: E501 + 'mobile_link': (str, none_type,), # noqa: E501 + 'availability_date': (str, none_type,), # noqa: E501 + 'shipping_label': (str, none_type,), # noqa: E501 + 'unit_pricing_measure': (ProductUnitPricingMeasure,), # noqa: E501 + 'unit_pricing_base_measure': (ProductUnitPricingBaseMeasure,), # noqa: E501 + 'shipping_length': (ProductShippingDimension,), # noqa: E501 + 'shipping_width': (ProductShippingDimension,), # noqa: E501 + 'shipping_height': (ProductShippingDimension,), # noqa: E501 + 'display_ads_id': (str, none_type,), # noqa: E501 + 'display_ads_similar_ids': ([str], none_type,), # noqa: E501 + 'display_ads_title': (str, none_type,), # noqa: E501 + 'display_ads_link': (str, none_type,), # noqa: E501 + 'display_ads_value': (float, none_type,), # noqa: E501 + 'sell_on_google_quantity': (int, none_type,), # noqa: E501 + 'promotion_ids': ([str], none_type,), # noqa: E501 + 'max_handling_time': (int, none_type,), # noqa: E501 + 'min_handling_time': (int, none_type,), # noqa: E501 + 'cost_of_goods_sold': (Price,), # noqa: E501 + 'source': (str, none_type,), # noqa: E501 + 'included_destinations': ([str], none_type,), # noqa: E501 + 'excluded_destinations': ([str], none_type,), # noqa: E501 + 'ads_grouping': (str, none_type,), # noqa: E501 + 'ads_labels': ([str], none_type,), # noqa: E501 + 'ads_redirect': (str, none_type,), # noqa: E501 + 'product_types': ([str], none_type,), # noqa: E501 + 'product_type_keys': ([str], none_type,), # noqa: E501 + 'age_group': (str, none_type,), # noqa: E501 + 'availability': (str, none_type,), # noqa: E501 + 'condition': (str, none_type,), # noqa: E501 + 'gender': (str, none_type,), # noqa: E501 + 'size_system': (str, none_type,), # noqa: E501 + 'size_type': (str, none_type,), # noqa: E501 + 'energy_efficiency_class': (str, none_type,), # noqa: E501 + 'min_energy_efficiency_class': (str, none_type,), # noqa: E501 + 'max_energy_efficiency_class': (str, none_type,), # noqa: E501 + 'tax_category': (str, none_type,), # noqa: E501 + 'transit_time_label': (str, none_type,), # noqa: E501 + 'seller_id': (str, none_type,), # noqa: E501 + 'external_seller_id': (str, none_type,), # noqa: E501 + 'external_seller_name': (str, none_type,), # noqa: E501 + 'number_of_reviews': (int, none_type,), # noqa: E501 + 'product_rating': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'link': 'link', # noqa: E501 + 'image_link': 'imageLink', # noqa: E501 + 'channel': 'channel', # noqa: E501 + 'offer_id': 'offerId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'additional_image_links': 'additionalImageLinks', # noqa: E501 + 'content_language': 'contentLanguage', # noqa: E501 + 'target_country': 'targetCountry', # noqa: E501 + 'expiration_date': 'expirationDate', # noqa: E501 + 'adult': 'adult', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'brand': 'brand', # noqa: E501 + 'color': 'color', # noqa: E501 + 'google_product_category': 'googleProductCategory', # noqa: E501 + 'gtin': 'gtin', # noqa: E501 + 'item_group_id': 'itemGroupId', # noqa: E501 + 'material': 'material', # noqa: E501 + 'mpn': 'mpn', # noqa: E501 + 'pattern': 'pattern', # noqa: E501 + 'price': 'price', # noqa: E501 + 'sale_price': 'salePrice', # noqa: E501 + 'sale_price_effective_date': 'salePriceEffectiveDate', # noqa: E501 + 'shipping': 'shipping', # noqa: E501 + 'shipping_weight': 'shippingWeight', # noqa: E501 + 'sizes': 'sizes', # noqa: E501 + 'taxes': 'taxes', # noqa: E501 + 'custom_attributes': 'customAttributes', # noqa: E501 + 'identifier_exists': 'identifierExists', # noqa: E501 + 'installment': 'installment', # noqa: E501 + 'loyalty_points': 'loyaltyPoints', # noqa: E501 + 'multipack': 'multipack', # noqa: E501 + 'custom_label0': 'customLabel0', # noqa: E501 + 'custom_label1': 'customLabel1', # noqa: E501 + 'custom_label2': 'customLabel2', # noqa: E501 + 'custom_label3': 'customLabel3', # noqa: E501 + 'custom_label4': 'customLabel4', # noqa: E501 + 'is_bundle': 'isBundle', # noqa: E501 + 'mobile_link': 'mobileLink', # noqa: E501 + 'availability_date': 'availabilityDate', # noqa: E501 + 'shipping_label': 'shippingLabel', # noqa: E501 + 'unit_pricing_measure': 'unitPricingMeasure', # noqa: E501 + 'unit_pricing_base_measure': 'unitPricingBaseMeasure', # noqa: E501 + 'shipping_length': 'shippingLength', # noqa: E501 + 'shipping_width': 'shippingWidth', # noqa: E501 + 'shipping_height': 'shippingHeight', # noqa: E501 + 'display_ads_id': 'displayAdsId', # noqa: E501 + 'display_ads_similar_ids': 'displayAdsSimilarIds', # noqa: E501 + 'display_ads_title': 'displayAdsTitle', # noqa: E501 + 'display_ads_link': 'displayAdsLink', # noqa: E501 + 'display_ads_value': 'displayAdsValue', # noqa: E501 + 'sell_on_google_quantity': 'sellOnGoogleQuantity', # noqa: E501 + 'promotion_ids': 'promotionIds', # noqa: E501 + 'max_handling_time': 'maxHandlingTime', # noqa: E501 + 'min_handling_time': 'minHandlingTime', # noqa: E501 + 'cost_of_goods_sold': 'costOfGoodsSold', # noqa: E501 + 'source': 'source', # noqa: E501 + 'included_destinations': 'includedDestinations', # noqa: E501 + 'excluded_destinations': 'excludedDestinations', # noqa: E501 + 'ads_grouping': 'adsGrouping', # noqa: E501 + 'ads_labels': 'adsLabels', # noqa: E501 + 'ads_redirect': 'adsRedirect', # noqa: E501 + 'product_types': 'productTypes', # noqa: E501 + 'product_type_keys': 'productTypeKeys', # noqa: E501 + 'age_group': 'ageGroup', # noqa: E501 + 'availability': 'availability', # noqa: E501 + 'condition': 'condition', # noqa: E501 + 'gender': 'gender', # noqa: E501 + 'size_system': 'sizeSystem', # noqa: E501 + 'size_type': 'sizeType', # noqa: E501 + 'energy_efficiency_class': 'energyEfficiencyClass', # noqa: E501 + 'min_energy_efficiency_class': 'minEnergyEfficiencyClass', # noqa: E501 + 'max_energy_efficiency_class': 'maxEnergyEfficiencyClass', # noqa: E501 + 'tax_category': 'taxCategory', # noqa: E501 + 'transit_time_label': 'transitTimeLabel', # noqa: E501 + 'seller_id': 'sellerId', # noqa: E501 + 'external_seller_id': 'externalSellerId', # noqa: E501 + 'external_seller_name': 'externalSellerName', # noqa: E501 + 'number_of_reviews': 'numberOfReviews', # noqa: E501 + 'product_rating': 'productRating', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, title, link, image_link, *args, **kwargs): # noqa: E501 + """Product - a model defined in OpenAPI + + Args: + id (str): A unique identifier for the item. Aka Product ID. Don’t use casing to make IDs unique. + title (str): Title of the item. (500 UTF8 characters max). + link (str): URL directly linking to your item's page on your website. (1000 UTF8 characters max). + image_link (str): URL of an image of the item. Supported formats: PNG, JPEG, GIF. (2000 UTF8 characters max). + + Keyword Args: + channel (str): The item's channel (online only).. defaults to "online", must be one of ["online", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + offer_id (str, none_type): Not used by Criteo.. [optional] # noqa: E501 + description (str, none_type): Description of the item. RECOMMENDED. (5000 UTF8 characters max).. [optional] # noqa: E501 + additional_image_links ([str], none_type): Additional URLs of images of the item.. [optional] # noqa: E501 + content_language (str, none_type): The two-letter ISO 639-1 language code for the item.. [optional] # noqa: E501 + target_country (str, none_type): The CLDR territory code for the item.. [optional] # noqa: E501 + expiration_date (str, none_type): Date on which the item should expire, as specified upon insertion, in ISO 8601 format.. [optional] # noqa: E501 + adult (bool, none_type): Set to true if the item is targeted towards adults. RECOMMENDED.. [optional] # noqa: E501 + kind (str, none_type): Identifies what kind of resource this is.. [optional] # noqa: E501 + brand (str, none_type): Brand of the item. RECOMMENDED.. [optional] # noqa: E501 + color (str, none_type): Color of the item.. [optional] # noqa: E501 + google_product_category (str, none_type): Google's category of the item (see Google product taxonomy). RECOMMENDED.. [optional] # noqa: E501 + gtin (str, none_type): Global Trade Item Number (GTIN) of the item. RECOMMENDED.. [optional] # noqa: E501 + item_group_id (str, none_type): Shared identifier for all variants of the same product. RECOMMENDED. Don’t use casing to make IDs unique. (50 characters max). [optional] # noqa: E501 + material (str, none_type): The material of which the item is made.. [optional] # noqa: E501 + mpn (str, none_type): Manufacturer Part Number (MPN) of the item. RECOMMENDED.. [optional] # noqa: E501 + pattern (str, none_type): The item's pattern (e.g. polka dots).. [optional] # noqa: E501 + price (Price): [optional] # noqa: E501 + sale_price (Price): [optional] # noqa: E501 + sale_price_effective_date (str, none_type): Date range during which the item is on sale.. [optional] # noqa: E501 + shipping ([ProductShipping], none_type): Shipping rules.. [optional] # noqa: E501 + shipping_weight (ProductShippingWeight): [optional] # noqa: E501 + sizes ([str], none_type): Size of the item. RECOMMENDED. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value.. [optional] # noqa: E501 + taxes ([ProductTax], none_type): Tax information.. [optional] # noqa: E501 + custom_attributes ([CustomAttribute], none_type): A list of custom (merchant-provided) attributes. This is useful for submitting attributes not explicitly exposed by the API. Declaring attributes explicitly exposed by the API using is forbidden. [optional] # noqa: E501 + identifier_exists (bool, none_type): False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.. [optional] # noqa: E501 + installment (Installment): [optional] # noqa: E501 + loyalty_points (LoyaltyPoints): [optional] # noqa: E501 + multipack (int, none_type): The number of identical products in a merchant-defined multipack. To avoid any overflow issue, pass it as a string.. [optional] # noqa: E501 + custom_label0 (str, none_type): Custom label 0 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + custom_label1 (str, none_type): Custom label 1 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + custom_label2 (str, none_type): Custom label 2 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + custom_label3 (str, none_type): Custom label 3 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + custom_label4 (str, none_type): Custom label 4 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + is_bundle (bool, none_type): Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.. [optional] # noqa: E501 + mobile_link (str, none_type): accounts.link to a mobile-optimized version of the landing page.. [optional] # noqa: E501 + availability_date (str, none_type): The day a pre-ordered product becomes available for delivery, in ISO 8601 format.. [optional] # noqa: E501 + shipping_label (str, none_type): The shipping label of the product, used to group product in account-level shipping rules.. [optional] # noqa: E501 + unit_pricing_measure (ProductUnitPricingMeasure): [optional] # noqa: E501 + unit_pricing_base_measure (ProductUnitPricingBaseMeasure): [optional] # noqa: E501 + shipping_length (ProductShippingDimension): [optional] # noqa: E501 + shipping_width (ProductShippingDimension): [optional] # noqa: E501 + shipping_height (ProductShippingDimension): [optional] # noqa: E501 + display_ads_id (str, none_type): An identifier for an item for dynamic remarketing campaigns.. [optional] # noqa: E501 + display_ads_similar_ids ([str], none_type): Advertiser-specified recommendations.. [optional] # noqa: E501 + display_ads_title (str, none_type): Title of an item for dynamic remarketing campaigns.. [optional] # noqa: E501 + display_ads_link (str, none_type): URL directly to your item's landing page for dynamic remarketing campaigns.. [optional] # noqa: E501 + display_ads_value (float, none_type): Offer margin for dynamic remarketing campaigns.. [optional] # noqa: E501 + sell_on_google_quantity (int, none_type): The quantity of the product that is available for selling on Google. Supported only for online products.. [optional] # noqa: E501 + promotion_ids ([str], none_type): The unique ID of a promotion.. [optional] # noqa: E501 + max_handling_time (int, none_type): Maximal product handling time (in business days).. [optional] # noqa: E501 + min_handling_time (int, none_type): Minimal product handling time (in business days).. [optional] # noqa: E501 + cost_of_goods_sold (Price): [optional] # noqa: E501 + source (str, none_type): The source of the offer, i.e., how the offer was created.. [optional] # noqa: E501 + included_destinations ([str], none_type): The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations.. [optional] # noqa: E501 + excluded_destinations ([str], none_type): The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).. [optional] # noqa: E501 + ads_grouping (str, none_type): Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.. [optional] # noqa: E501 + ads_labels ([str], none_type): Similar to adsGrouping, but only works on CPC.. [optional] # noqa: E501 + ads_redirect (str, none_type): Allows advertisers to override the item URL when the product is shown within the context of Product Ads.. [optional] # noqa: E501 + product_types ([str], none_type): Categories of the item (formatted as in products data specification).. [optional] # noqa: E501 + product_type_keys ([str], none_type): Category keys of the item (formatted as in productTypes).. [optional] # noqa: E501 + age_group (str, none_type): Target age group of the item.. [optional] # noqa: E501 + availability (str, none_type): Availability status of the item. RECOMMENDED.. [optional] # noqa: E501 + condition (str, none_type): Condition or state of the item.. [optional] # noqa: E501 + gender (str, none_type): Target gender of the item.. [optional] # noqa: E501 + size_system (str, none_type): System in which the size is specified. Recommended for apparel items.. [optional] # noqa: E501 + size_type (str, none_type): The cut of the item. Recommended for apparel items.. [optional] # noqa: E501 + energy_efficiency_class (str, none_type): The energy efficiency class as defined in EU directive 2010/30/EU.. [optional] # noqa: E501 + min_energy_efficiency_class (str, none_type): The energy efficiency class as defined in EU directive 2010/30/EU.. [optional] # noqa: E501 + max_energy_efficiency_class (str, none_type): The energy efficiency class as defined in EU directive 2010/30/EU.. [optional] # noqa: E501 + tax_category (str, none_type): The tax category of the product, used to configure detailed tax nexus in account-level tax settings.. [optional] # noqa: E501 + transit_time_label (str, none_type): The transit time label of the product, used to group product in account-level transit time tables.. [optional] # noqa: E501 + seller_id (str, none_type): (Deprecated Field) The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + external_seller_id (str, none_type): The external id of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + external_seller_name (str, none_type): The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + number_of_reviews (int, none_type): The number of customer reviews for the product. [optional] # noqa: E501 + product_rating (str, none_type): The product rating for the product. [optional] # noqa: E501 + """ + + channel = kwargs.get('channel', "online") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.title = title + self.link = link + self.image_link = image_link + self.channel = channel + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, title, link, image_link, *args, **kwargs): # noqa: E501 + """Product - a model defined in OpenAPI + + Args: + id (str): A unique identifier for the item. Aka Product ID. Don’t use casing to make IDs unique. + title (str): Title of the item. (500 UTF8 characters max). + link (str): URL directly linking to your item's page on your website. (1000 UTF8 characters max). + image_link (str): URL of an image of the item. Supported formats: PNG, JPEG, GIF. (2000 UTF8 characters max). + + Keyword Args: + channel (str): The item's channel (online only).. defaults to "online", must be one of ["online", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + offer_id (str, none_type): Not used by Criteo.. [optional] # noqa: E501 + description (str, none_type): Description of the item. RECOMMENDED. (5000 UTF8 characters max).. [optional] # noqa: E501 + additional_image_links ([str], none_type): Additional URLs of images of the item.. [optional] # noqa: E501 + content_language (str, none_type): The two-letter ISO 639-1 language code for the item.. [optional] # noqa: E501 + target_country (str, none_type): The CLDR territory code for the item.. [optional] # noqa: E501 + expiration_date (str, none_type): Date on which the item should expire, as specified upon insertion, in ISO 8601 format.. [optional] # noqa: E501 + adult (bool, none_type): Set to true if the item is targeted towards adults. RECOMMENDED.. [optional] # noqa: E501 + kind (str, none_type): Identifies what kind of resource this is.. [optional] # noqa: E501 + brand (str, none_type): Brand of the item. RECOMMENDED.. [optional] # noqa: E501 + color (str, none_type): Color of the item.. [optional] # noqa: E501 + google_product_category (str, none_type): Google's category of the item (see Google product taxonomy). RECOMMENDED.. [optional] # noqa: E501 + gtin (str, none_type): Global Trade Item Number (GTIN) of the item. RECOMMENDED.. [optional] # noqa: E501 + item_group_id (str, none_type): Shared identifier for all variants of the same product. RECOMMENDED. Don’t use casing to make IDs unique. (50 characters max). [optional] # noqa: E501 + material (str, none_type): The material of which the item is made.. [optional] # noqa: E501 + mpn (str, none_type): Manufacturer Part Number (MPN) of the item. RECOMMENDED.. [optional] # noqa: E501 + pattern (str, none_type): The item's pattern (e.g. polka dots).. [optional] # noqa: E501 + price (Price): [optional] # noqa: E501 + sale_price (Price): [optional] # noqa: E501 + sale_price_effective_date (str, none_type): Date range during which the item is on sale.. [optional] # noqa: E501 + shipping ([ProductShipping], none_type): Shipping rules.. [optional] # noqa: E501 + shipping_weight (ProductShippingWeight): [optional] # noqa: E501 + sizes ([str], none_type): Size of the item. RECOMMENDED. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value.. [optional] # noqa: E501 + taxes ([ProductTax], none_type): Tax information.. [optional] # noqa: E501 + custom_attributes ([CustomAttribute], none_type): A list of custom (merchant-provided) attributes. This is useful for submitting attributes not explicitly exposed by the API. Declaring attributes explicitly exposed by the API using is forbidden. [optional] # noqa: E501 + identifier_exists (bool, none_type): False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.. [optional] # noqa: E501 + installment (Installment): [optional] # noqa: E501 + loyalty_points (LoyaltyPoints): [optional] # noqa: E501 + multipack (int, none_type): The number of identical products in a merchant-defined multipack. To avoid any overflow issue, pass it as a string.. [optional] # noqa: E501 + custom_label0 (str, none_type): Custom label 0 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + custom_label1 (str, none_type): Custom label 1 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + custom_label2 (str, none_type): Custom label 2 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + custom_label3 (str, none_type): Custom label 3 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + custom_label4 (str, none_type): Custom label 4 for custom grouping of items in a Shopping campaign.. [optional] # noqa: E501 + is_bundle (bool, none_type): Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.. [optional] # noqa: E501 + mobile_link (str, none_type): accounts.link to a mobile-optimized version of the landing page.. [optional] # noqa: E501 + availability_date (str, none_type): The day a pre-ordered product becomes available for delivery, in ISO 8601 format.. [optional] # noqa: E501 + shipping_label (str, none_type): The shipping label of the product, used to group product in account-level shipping rules.. [optional] # noqa: E501 + unit_pricing_measure (ProductUnitPricingMeasure): [optional] # noqa: E501 + unit_pricing_base_measure (ProductUnitPricingBaseMeasure): [optional] # noqa: E501 + shipping_length (ProductShippingDimension): [optional] # noqa: E501 + shipping_width (ProductShippingDimension): [optional] # noqa: E501 + shipping_height (ProductShippingDimension): [optional] # noqa: E501 + display_ads_id (str, none_type): An identifier for an item for dynamic remarketing campaigns.. [optional] # noqa: E501 + display_ads_similar_ids ([str], none_type): Advertiser-specified recommendations.. [optional] # noqa: E501 + display_ads_title (str, none_type): Title of an item for dynamic remarketing campaigns.. [optional] # noqa: E501 + display_ads_link (str, none_type): URL directly to your item's landing page for dynamic remarketing campaigns.. [optional] # noqa: E501 + display_ads_value (float, none_type): Offer margin for dynamic remarketing campaigns.. [optional] # noqa: E501 + sell_on_google_quantity (int, none_type): The quantity of the product that is available for selling on Google. Supported only for online products.. [optional] # noqa: E501 + promotion_ids ([str], none_type): The unique ID of a promotion.. [optional] # noqa: E501 + max_handling_time (int, none_type): Maximal product handling time (in business days).. [optional] # noqa: E501 + min_handling_time (int, none_type): Minimal product handling time (in business days).. [optional] # noqa: E501 + cost_of_goods_sold (Price): [optional] # noqa: E501 + source (str, none_type): The source of the offer, i.e., how the offer was created.. [optional] # noqa: E501 + included_destinations ([str], none_type): The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations.. [optional] # noqa: E501 + excluded_destinations ([str], none_type): The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).. [optional] # noqa: E501 + ads_grouping (str, none_type): Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.. [optional] # noqa: E501 + ads_labels ([str], none_type): Similar to adsGrouping, but only works on CPC.. [optional] # noqa: E501 + ads_redirect (str, none_type): Allows advertisers to override the item URL when the product is shown within the context of Product Ads.. [optional] # noqa: E501 + product_types ([str], none_type): Categories of the item (formatted as in products data specification).. [optional] # noqa: E501 + product_type_keys ([str], none_type): Category keys of the item (formatted as in productTypes).. [optional] # noqa: E501 + age_group (str, none_type): Target age group of the item.. [optional] # noqa: E501 + availability (str, none_type): Availability status of the item. RECOMMENDED.. [optional] # noqa: E501 + condition (str, none_type): Condition or state of the item.. [optional] # noqa: E501 + gender (str, none_type): Target gender of the item.. [optional] # noqa: E501 + size_system (str, none_type): System in which the size is specified. Recommended for apparel items.. [optional] # noqa: E501 + size_type (str, none_type): The cut of the item. Recommended for apparel items.. [optional] # noqa: E501 + energy_efficiency_class (str, none_type): The energy efficiency class as defined in EU directive 2010/30/EU.. [optional] # noqa: E501 + min_energy_efficiency_class (str, none_type): The energy efficiency class as defined in EU directive 2010/30/EU.. [optional] # noqa: E501 + max_energy_efficiency_class (str, none_type): The energy efficiency class as defined in EU directive 2010/30/EU.. [optional] # noqa: E501 + tax_category (str, none_type): The tax category of the product, used to configure detailed tax nexus in account-level tax settings.. [optional] # noqa: E501 + transit_time_label (str, none_type): The transit time label of the product, used to group product in account-level transit time tables.. [optional] # noqa: E501 + seller_id (str, none_type): (Deprecated Field) The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + external_seller_id (str, none_type): The external id of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + external_seller_name (str, none_type): The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional] # noqa: E501 + number_of_reviews (int, none_type): The number of customer reviews for the product. [optional] # noqa: E501 + product_rating (str, none_type): The product rating for the product. [optional] # noqa: E501 + """ + + channel = kwargs.get('channel', "online") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.title = title + self.link = link + self.image_link = image_link + self.channel = channel + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_variable.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_importer_error.py similarity index 78% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_variable.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_importer_error.py index 27f3280b..ccf25d86 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_variable.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_importer_error.py @@ -29,16 +29,8 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError -def lazy_import(): - from criteo_api_retailmedia_preview.model.choice_variable_specification import ChoiceVariableSpecification - from criteo_api_retailmedia_preview.model.files_variables_specification import FilesVariablesSpecification - from criteo_api_retailmedia_preview.model.text_variable_specification import TextVariableSpecification - globals()['ChoiceVariableSpecification'] = ChoiceVariableSpecification - globals()['FilesVariablesSpecification'] = FilesVariablesSpecification - globals()['TextVariableSpecification'] = TextVariableSpecification - -class TemplateVariable(ModelNormal): +class ProductImporterError(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -63,13 +55,6 @@ class TemplateVariable(ModelNormal): """ allowed_values = { - ('type',): { - 'TEXT': "Text", - 'CHOICE': "Choice", - 'COLOR': "Color", - 'FILES': "Files", - 'HYPERLINK': "Hyperlink", - }, } validations = { @@ -81,7 +66,6 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ - lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -96,14 +80,13 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'id': (str,), # noqa: E501 - 'required': (bool,), # noqa: E501 + 'trace_id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'choice_variable_specification': (ChoiceVariableSpecification,), # noqa: E501 - 'text_variable_specification': (TextVariableSpecification,), # noqa: E501 - 'files_variables_specification': (FilesVariablesSpecification,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'instance': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 } @cached_property @@ -112,12 +95,12 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'required': 'required', # noqa: E501 + 'trace_id': 'traceId', # noqa: E501 'type': 'type', # noqa: E501 - 'choice_variable_specification': 'choiceVariableSpecification', # noqa: E501 - 'text_variable_specification': 'textVariableSpecification', # noqa: E501 - 'files_variables_specification': 'filesVariablesSpecification', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 } read_only_vars = { @@ -127,13 +110,16 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, required, type, *args, **kwargs): # noqa: E501 - """TemplateVariable - a model defined in OpenAPI + def _from_openapi_data(cls, trace_id, type, code, instance, title, detail, *args, **kwargs): # noqa: E501 + """ProductImporterError - a model defined in OpenAPI Args: - id (str): The id of the variable - required (bool): Whether the variable is required - type (str): The type of the variable + trace_id (str): The MACHINE-READABLE correlation ID provided by the gateway + type (str): A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors. + code (str): A MACHINE-READABLE error code string in kebab-case. Unique across Criteo + instance (str): A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error. + title (str): A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. + detail (str): A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -166,9 +152,6 @@ def _from_openapi_data(cls, id, required, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - choice_variable_specification (ChoiceVariableSpecification): [optional] # noqa: E501 - text_variable_specification (TextVariableSpecification): [optional] # noqa: E501 - files_variables_specification (FilesVariablesSpecification): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -200,9 +183,12 @@ def _from_openapi_data(cls, id, required, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.required = required + self.trace_id = trace_id self.type = type + self.code = code + self.instance = instance + self.title = title + self.detail = detail for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -223,13 +209,16 @@ def _from_openapi_data(cls, id, required, type, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, required, type, *args, **kwargs): # noqa: E501 - """TemplateVariable - a model defined in OpenAPI + def __init__(self, trace_id, type, code, instance, title, detail, *args, **kwargs): # noqa: E501 + """ProductImporterError - a model defined in OpenAPI Args: - id (str): The id of the variable - required (bool): Whether the variable is required - type (str): The type of the variable + trace_id (str): The MACHINE-READABLE correlation ID provided by the gateway + type (str): A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors. + code (str): A MACHINE-READABLE error code string in kebab-case. Unique across Criteo + instance (str): A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error. + title (str): A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. + detail (str): A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -262,9 +251,6 @@ def __init__(self, id, required, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - choice_variable_specification (ChoiceVariableSpecification): [optional] # noqa: E501 - text_variable_specification (TextVariableSpecification): [optional] # noqa: E501 - files_variables_specification (FilesVariablesSpecification): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -294,9 +280,12 @@ def __init__(self, id, required, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.required = required + self.trace_id = trace_id self.type = type + self.code = code + self.instance = instance + self.title = title + self.detail = detail for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_importer_warning.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_importer_warning.py new file mode 100644 index 00000000..35a7d138 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_importer_warning.py @@ -0,0 +1,299 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + + +class ProductImporterWarning(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'trace_id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'instance': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'trace_id': 'traceId', # noqa: E501 + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, trace_id, type, code, instance, title, detail, *args, **kwargs): # noqa: E501 + """ProductImporterWarning - a model defined in OpenAPI + + Args: + trace_id (str): The MACHINE-READABLE correlation ID provided by the gateway + type (str): A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors. + code (str): A MACHINE-READABLE error code string in kebab-case. Unique across Criteo + instance (str): A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error. + title (str): A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. + detail (str): A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.trace_id = trace_id + self.type = type + self.code = code + self.instance = instance + self.title = title + self.detail = detail + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, trace_id, type, code, instance, title, detail, *args, **kwargs): # noqa: E501 + """ProductImporterWarning - a model defined in OpenAPI + + Args: + trace_id (str): The MACHINE-READABLE correlation ID provided by the gateway + type (str): A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors. + code (str): A MACHINE-READABLE error code string in kebab-case. Unique across Criteo + instance (str): A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error. + title (str): A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. + detail (str): A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.trace_id = trace_id + self.type = type + self.code = code + self.instance = instance + self.title = title + self.detail = detail + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_list_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping.py similarity index 78% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_list_response.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping.py index b68dae49..efdf8a5d 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_list_response.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping.py @@ -30,13 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.problem_details import ProblemDetails - from criteo_api_retailmedia_preview.model.resource_of_template import ResourceOfTemplate - globals()['ProblemDetails'] = ProblemDetails - globals()['ResourceOfTemplate'] = ResourceOfTemplate + from criteo_api_retailmedia_preview.model.price import Price + globals()['Price'] = Price -class TemplateListResponse(ModelNormal): +class ProductShipping(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -89,9 +87,13 @@ def openapi_types(): """ lazy_import() return { - 'data': ([ResourceOfTemplate],), # noqa: E501 - 'warnings': ([ProblemDetails],), # noqa: E501 - 'errors': ([ProblemDetails],), # noqa: E501 + 'price': (Price,), # noqa: E501 + 'country': (str, none_type,), # noqa: E501 + 'region': (str, none_type,), # noqa: E501 + 'service': (str, none_type,), # noqa: E501 + 'location_id': (int, none_type,), # noqa: E501 + 'location_group_name': (str, none_type,), # noqa: E501 + 'postal_code': (str, none_type,), # noqa: E501 } @cached_property @@ -100,14 +102,16 @@ def discriminator(): attribute_map = { - 'data': 'data', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - 'errors': 'errors', # noqa: E501 + 'price': 'price', # noqa: E501 + 'country': 'country', # noqa: E501 + 'region': 'region', # noqa: E501 + 'service': 'service', # noqa: E501 + 'location_id': 'locationId', # noqa: E501 + 'location_group_name': 'locationGroupName', # noqa: E501 + 'postal_code': 'postalCode', # noqa: E501 } read_only_vars = { - 'warnings', # noqa: E501 - 'errors', # noqa: E501 } _composed_schemas = {} @@ -115,7 +119,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """TemplateListResponse - a model defined in OpenAPI + """ProductShipping - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -148,9 +152,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data ([ResourceOfTemplate]): [optional] # noqa: E501 - warnings ([ProblemDetails]): [optional] # noqa: E501 - errors ([ProblemDetails]): [optional] # noqa: E501 + price (Price): [optional] # noqa: E501 + country (str, none_type): The CLDR territory code of the country to which an item will ship.. [optional] # noqa: E501 + region (str, none_type): The geographic region to which a shipping rate applies.. [optional] # noqa: E501 + service (str, none_type): A free-form description of the service class or delivery speed.. [optional] # noqa: E501 + location_id (int, none_type): The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.. [optional] # noqa: E501 + location_group_name (str, none_type): The location where the shipping is applicable, represented by a location group name.. [optional] # noqa: E501 + postal_code (str, none_type): The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -203,7 +211,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """TemplateListResponse - a model defined in OpenAPI + """ProductShipping - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -236,9 +244,13 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data ([ResourceOfTemplate]): [optional] # noqa: E501 - warnings ([ProblemDetails]): [optional] # noqa: E501 - errors ([ProblemDetails]): [optional] # noqa: E501 + price (Price): [optional] # noqa: E501 + country (str, none_type): The CLDR territory code of the country to which an item will ship.. [optional] # noqa: E501 + region (str, none_type): The geographic region to which a shipping rate applies.. [optional] # noqa: E501 + service (str, none_type): A free-form description of the service class or delivery speed.. [optional] # noqa: E501 + location_id (int, none_type): The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.. [optional] # noqa: E501 + location_group_name (str, none_type): The location where the shipping is applicable, represented by a location group name.. [optional] # noqa: E501 + postal_code (str, none_type): The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping_dimension.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping_dimension.py new file mode 100644 index 00000000..cb8c1951 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping_dimension.py @@ -0,0 +1,267 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + + +class ProductShippingDimension(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (float, none_type,), # noqa: E501 + 'unit': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'value': 'value', # noqa: E501 + 'unit': 'unit', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProductShippingDimension - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + value (float, none_type): The dimension of the product used to calculate the shipping cost of the item.. [optional] # noqa: E501 + unit (str, none_type): The unit of value.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ProductShippingDimension - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + value (float, none_type): The dimension of the product used to calculate the shipping cost of the item.. [optional] # noqa: E501 + unit (str, none_type): The unit of value.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/color_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping_weight.py similarity index 92% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/color_variable_value.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping_weight.py index 842a4969..b65e9c4f 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/color_variable_value.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_shipping_weight.py @@ -30,7 +30,7 @@ -class ColorVariableValue(ModelNormal): +class ProductShippingWeight(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -58,11 +58,6 @@ class ColorVariableValue(ModelNormal): } validations = { - ('color',): { - 'regex': { - 'pattern': r'^#(([0-9a-fA-F]{2}){3}|([0-9a-fA-F]){3})$', # noqa: E501 - }, - }, } @cached_property @@ -86,7 +81,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'color': (str,), # noqa: E501 + 'value': (float, none_type,), # noqa: E501 + 'unit': (str, none_type,), # noqa: E501 } @cached_property @@ -95,7 +91,8 @@ def discriminator(): attribute_map = { - 'color': 'color', # noqa: E501 + 'value': 'value', # noqa: E501 + 'unit': 'unit', # noqa: E501 } read_only_vars = { @@ -105,11 +102,8 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, color, *args, **kwargs): # noqa: E501 - """ColorVariableValue - a model defined in OpenAPI - - Args: - color (str): The displayed color (HEX format) + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProductShippingWeight - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -142,6 +136,8 @@ def _from_openapi_data(cls, color, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + value (float, none_type): The weight of the product used to calculate the shipping cost of the item.. [optional] # noqa: E501 + unit (str, none_type): The unit of value.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -173,7 +169,6 @@ def _from_openapi_data(cls, color, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.color = color for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -194,11 +189,8 @@ def _from_openapi_data(cls, color, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, color, *args, **kwargs): # noqa: E501 - """ColorVariableValue - a model defined in OpenAPI - - Args: - color (str): The displayed color (HEX format) + def __init__(self, *args, **kwargs): # noqa: E501 + """ProductShippingWeight - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -231,6 +223,8 @@ def __init__(self, color, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + value (float, none_type): The weight of the product used to calculate the shipping cost of the item.. [optional] # noqa: E501 + unit (str, none_type): The unit of value.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -260,7 +254,6 @@ def __init__(self, color, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.color = color for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_tax.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_tax.py new file mode 100644 index 00000000..1e136c69 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_tax.py @@ -0,0 +1,283 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + + +class ProductTax(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'rate': (float, none_type,), # noqa: E501 + 'country': (str, none_type,), # noqa: E501 + 'region': (str, none_type,), # noqa: E501 + 'tax_ship': (bool, none_type,), # noqa: E501 + 'location_id': (int, none_type,), # noqa: E501 + 'postal_code': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'rate': 'rate', # noqa: E501 + 'country': 'country', # noqa: E501 + 'region': 'region', # noqa: E501 + 'tax_ship': 'taxShip', # noqa: E501 + 'location_id': 'locationId', # noqa: E501 + 'postal_code': 'postalCode', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProductTax - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + rate (float, none_type): The percentage of tax rate that applies to the item price.. [optional] # noqa: E501 + country (str, none_type): The country within which the item is taxed, specified as a CLDR territory code.. [optional] # noqa: E501 + region (str, none_type): The geographic region to which the tax rate applies.. [optional] # noqa: E501 + tax_ship (bool, none_type): Set to true if tax is charged on shipping.. [optional] # noqa: E501 + location_id (int, none_type): The numeric ID of a location that the tax rate applies to as defined in the AdWords API.. [optional] # noqa: E501 + postal_code (str, none_type): The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ProductTax - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + rate (float, none_type): The percentage of tax rate that applies to the item price.. [optional] # noqa: E501 + country (str, none_type): The country within which the item is taxed, specified as a CLDR territory code.. [optional] # noqa: E501 + region (str, none_type): The geographic region to which the tax rate applies.. [optional] # noqa: E501 + tax_ship (bool, none_type): Set to true if tax is charged on shipping.. [optional] # noqa: E501 + location_id (int, none_type): The numeric ID of a location that the tax rate applies to as defined in the AdWords API.. [optional] # noqa: E501 + postal_code (str, none_type): The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py similarity index 92% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_variable_value.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py index e4034eb2..c0bc142b 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_variable_value.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py @@ -30,7 +30,7 @@ -class ChoiceVariableValue(ModelNormal): +class ProductUnitPricingBaseMeasure(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -81,7 +81,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'chosen_options': ([str],), # noqa: E501 + 'value': (int, none_type,), # noqa: E501 + 'unit': (str, none_type,), # noqa: E501 } @cached_property @@ -90,7 +91,8 @@ def discriminator(): attribute_map = { - 'chosen_options': 'chosenOptions', # noqa: E501 + 'value': 'value', # noqa: E501 + 'unit': 'unit', # noqa: E501 } read_only_vars = { @@ -100,11 +102,8 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, chosen_options, *args, **kwargs): # noqa: E501 - """ChoiceVariableValue - a model defined in OpenAPI - - Args: - chosen_options ([str]): The chosen options + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProductUnitPricingBaseMeasure - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -137,6 +136,8 @@ def _from_openapi_data(cls, chosen_options, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + value (int, none_type): The denominator of the unit price.. [optional] # noqa: E501 + unit (str, none_type): The unit of the denominator.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -168,7 +169,6 @@ def _from_openapi_data(cls, chosen_options, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.chosen_options = chosen_options for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -189,11 +189,8 @@ def _from_openapi_data(cls, chosen_options, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, chosen_options, *args, **kwargs): # noqa: E501 - """ChoiceVariableValue - a model defined in OpenAPI - - Args: - chosen_options ([str]): The chosen options + def __init__(self, *args, **kwargs): # noqa: E501 + """ProductUnitPricingBaseMeasure - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -226,6 +223,8 @@ def __init__(self, chosen_options, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + value (int, none_type): The denominator of the unit price.. [optional] # noqa: E501 + unit (str, none_type): The unit of the denominator.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -255,7 +254,6 @@ def __init__(self, chosen_options, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.chosen_options = chosen_options for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/text_variable_specification.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py similarity index 93% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/text_variable_specification.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py index 4f44f4cf..393863cd 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/text_variable_specification.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py @@ -30,7 +30,7 @@ -class TextVariableSpecification(ModelNormal): +class ProductUnitPricingMeasure(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -81,7 +81,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'max_chars': (int, none_type,), # noqa: E501 + 'value': (float, none_type,), # noqa: E501 + 'unit': (str, none_type,), # noqa: E501 } @cached_property @@ -90,7 +91,8 @@ def discriminator(): attribute_map = { - 'max_chars': 'maxChars', # noqa: E501 + 'value': 'value', # noqa: E501 + 'unit': 'unit', # noqa: E501 } read_only_vars = { @@ -101,7 +103,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """TextVariableSpecification - a model defined in OpenAPI + """ProductUnitPricingMeasure - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -134,7 +136,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - max_chars (int, none_type): The maximum amount of characters accepted for the text. [optional] # noqa: E501 + value (float, none_type): The measurement of an item.. [optional] # noqa: E501 + unit (str, none_type): The unit of measure.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -187,7 +190,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """TextVariableSpecification - a model defined in OpenAPI + """ProductUnitPricingMeasure - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -220,7 +223,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - max_chars (int, none_type): The maximum amount of characters accepted for the text. [optional] # noqa: E501 + value (float, none_type): The measurement of an item.. [optional] # noqa: E501 + unit (str, none_type): The unit of measure.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/section.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/products_custom_batch_request.py similarity index 91% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/section.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/products_custom_batch_request.py index 8af2a67f..673f2243 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/section.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/products_custom_batch_request.py @@ -30,11 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.template_variable import TemplateVariable - globals()['TemplateVariable'] = TemplateVariable + from criteo_api_retailmedia_preview.model.products_custom_batch_request_entry import ProductsCustomBatchRequestEntry + globals()['ProductsCustomBatchRequestEntry'] = ProductsCustomBatchRequestEntry -class Section(ModelNormal): +class ProductsCustomBatchRequest(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -87,8 +87,7 @@ def openapi_types(): """ lazy_import() return { - 'title': (str,), # noqa: E501 - 'template_variables': ([TemplateVariable],), # noqa: E501 + 'entries': ([ProductsCustomBatchRequestEntry],), # noqa: E501 } @cached_property @@ -97,8 +96,7 @@ def discriminator(): attribute_map = { - 'title': 'title', # noqa: E501 - 'template_variables': 'templateVariables', # noqa: E501 + 'entries': 'entries', # noqa: E501 } read_only_vars = { @@ -108,12 +106,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, title, template_variables, *args, **kwargs): # noqa: E501 - """Section - a model defined in OpenAPI + def _from_openapi_data(cls, entries, *args, **kwargs): # noqa: E501 + """ProductsCustomBatchRequest - a model defined in OpenAPI Args: - title (str): - template_variables ([TemplateVariable]): + entries ([ProductsCustomBatchRequestEntry]): The request entries to be processed in the batch. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -177,8 +174,7 @@ def _from_openapi_data(cls, title, template_variables, *args, **kwargs): # noqa self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.title = title - self.template_variables = template_variables + self.entries = entries for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -199,12 +195,11 @@ def _from_openapi_data(cls, title, template_variables, *args, **kwargs): # noqa ]) @convert_js_args_to_python_args - def __init__(self, title, template_variables, *args, **kwargs): # noqa: E501 - """Section - a model defined in OpenAPI + def __init__(self, entries, *args, **kwargs): # noqa: E501 + """ProductsCustomBatchRequest - a model defined in OpenAPI Args: - title (str): - template_variables ([TemplateVariable]): + entries ([ProductsCustomBatchRequestEntry]): The request entries to be processed in the batch. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -266,8 +261,7 @@ def __init__(self, title, template_variables, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.title = title - self.template_variables = template_variables + self.entries = entries for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_update_model202207.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py similarity index 78% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_update_model202207.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py index 8c48fdea..e79736f9 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_update_model202207.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py @@ -30,11 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue - globals()['TemplateVariableValue'] = TemplateVariableValue + from criteo_api_retailmedia_preview.model.product import Product + globals()['Product'] = Product -class CreativeUpdateModel202207(ModelNormal): +class ProductsCustomBatchRequestEntry(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -59,6 +59,10 @@ class CreativeUpdateModel202207(ModelNormal): """ allowed_values = { + ('method',): { + 'DELETE': "delete", + 'INSERT': "insert", + }, } validations = { @@ -87,11 +91,13 @@ def openapi_types(): """ lazy_import() return { - 'name': (str,), # noqa: E501 - 'retailer_id': (int,), # noqa: E501 - 'template_id': (int,), # noqa: E501 - 'template_variable_values': ([TemplateVariableValue],), # noqa: E501 - 'brand_id': (int,), # noqa: E501 + 'merchant_id': (int,), # noqa: E501 + 'method': (str,), # noqa: E501 + 'batch_id': (int, none_type,), # noqa: E501 + 'product_id': (str, none_type,), # noqa: E501 + 'item_group_id': (str, none_type,), # noqa: E501 + 'product': (Product,), # noqa: E501 + 'feed_id': (str, none_type,), # noqa: E501 } @cached_property @@ -100,11 +106,13 @@ def discriminator(): attribute_map = { - 'name': 'name', # noqa: E501 - 'retailer_id': 'retailerId', # noqa: E501 - 'template_id': 'templateId', # noqa: E501 - 'template_variable_values': 'templateVariableValues', # noqa: E501 - 'brand_id': 'brandId', # noqa: E501 + 'merchant_id': 'merchantId', # noqa: E501 + 'method': 'method', # noqa: E501 + 'batch_id': 'batchId', # noqa: E501 + 'product_id': 'productId', # noqa: E501 + 'item_group_id': 'itemGroupId', # noqa: E501 + 'product': 'product', # noqa: E501 + 'feed_id': 'feedId', # noqa: E501 } read_only_vars = { @@ -114,14 +122,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 - """CreativeUpdateModel202207 - a model defined in OpenAPI + def _from_openapi_data(cls, merchant_id, method, *args, **kwargs): # noqa: E501 + """ProductsCustomBatchRequestEntry - a model defined in OpenAPI Args: - name (str): The name of the creative - retailer_id (int): The retailer associated to the creative - template_id (int): The creative template used for this creative - template_variable_values ([TemplateVariableValue]): The template chosen values + merchant_id (int): The ID of the managing account. Criteo: the partnerId. + method (str): The method of the batch entry. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -154,7 +160,11 @@ def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_va Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - brand_id (int): The brand associated to the creative. [optional] # noqa: E501 + batch_id (int, none_type): An entry ID, unique within the batch request.. [optional] # noqa: E501 + product_id (str, none_type): The Product ID to delete. Only defined if the method is delete.. [optional] # noqa: E501 + item_group_id (str, none_type): Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant.. [optional] # noqa: E501 + product (Product): [optional] # noqa: E501 + feed_id (str, none_type): Not used by Criteo.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -186,10 +196,8 @@ def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_va self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.name = name - self.retailer_id = retailer_id - self.template_id = template_id - self.template_variable_values = template_variable_values + self.merchant_id = merchant_id + self.method = method for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -210,14 +218,12 @@ def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_va ]) @convert_js_args_to_python_args - def __init__(self, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 - """CreativeUpdateModel202207 - a model defined in OpenAPI + def __init__(self, merchant_id, method, *args, **kwargs): # noqa: E501 + """ProductsCustomBatchRequestEntry - a model defined in OpenAPI Args: - name (str): The name of the creative - retailer_id (int): The retailer associated to the creative - template_id (int): The creative template used for this creative - template_variable_values ([TemplateVariableValue]): The template chosen values + merchant_id (int): The ID of the managing account. Criteo: the partnerId. + method (str): The method of the batch entry. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -250,7 +256,11 @@ def __init__(self, name, retailer_id, template_id, template_variable_values, *ar Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - brand_id (int): The brand associated to the creative. [optional] # noqa: E501 + batch_id (int, none_type): An entry ID, unique within the batch request.. [optional] # noqa: E501 + product_id (str, none_type): The Product ID to delete. Only defined if the method is delete.. [optional] # noqa: E501 + item_group_id (str, none_type): Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant.. [optional] # noqa: E501 + product (Product): [optional] # noqa: E501 + feed_id (str, none_type): Not used by Criteo.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -280,10 +290,8 @@ def __init__(self, name, retailer_id, template_id, template_variable_values, *ar self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.name = name - self.retailer_id = retailer_id - self.template_id = template_id - self.template_variable_values = template_variable_values + self.merchant_id = merchant_id + self.method = method for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_option.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_detail_error.py similarity index 85% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_option.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_detail_error.py index 8ce3a9b9..b590b104 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/choice_option.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_detail_error.py @@ -29,12 +29,8 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError -def lazy_import(): - from criteo_api_retailmedia_preview.model.template_variable import TemplateVariable - globals()['TemplateVariable'] = TemplateVariable - -class ChoiceOption(ModelNormal): +class ReportDetailError(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -59,6 +55,24 @@ class ChoiceOption(ModelNormal): """ allowed_values = { + ('type',): { + 'UNKNOWNERROR': "UnknownError", + 'INVALIDBIGIMAGEURL': "InvalidBigImageUrl", + 'INVALIDPRODUCTID': "InvalidProductId", + 'INVALIDPRODUCTURL': "InvalidProductUrl", + 'INVALIDSMALLIMAGEURL': "InvalidSmallImageUrl", + 'JSONPARSINGISSUE': "JsonParsingIssue", + 'MISSINGID': "MissingID", + 'MISSINGIMAGES': "MissingImages", + 'MISSINGNAME': "MissingName", + 'MISSINGURL': "MissingURL", + 'NONASCIIID': "NonAsciiId", + 'OVERLARGEBIGIMAGE': "OverlargeBigImage", + 'OVERLARGEID': "OverlargeID", + 'OVERLARGESMALLIMAGE': "OverlargeSmallImage", + 'OVERLARGEURL': "OverlargeURL", + 'CONFIGURATIONERROR': "ConfigurationError", + }, } validations = { @@ -70,7 +84,6 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ - lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -85,10 +98,10 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'dependent_variables': ([TemplateVariable],), # noqa: E501 - 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'is_server_related': (bool,), # noqa: E501 } @cached_property @@ -97,8 +110,9 @@ def discriminator(): attribute_map = { - 'dependent_variables': 'dependentVariables', # noqa: E501 - 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'message': 'message', # noqa: E501 + 'is_server_related': 'isServerRelated', # noqa: E501 } read_only_vars = { @@ -108,12 +122,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, dependent_variables, id, *args, **kwargs): # noqa: E501 - """ChoiceOption - a model defined in OpenAPI + def _from_openapi_data(cls, type, message, is_server_related, *args, **kwargs): # noqa: E501 + """ReportDetailError - a model defined in OpenAPI Args: - dependent_variables ([TemplateVariable]): Template variables unblocked when the option is chosen - id (str): The id of the option + type (str): + message (str): + is_server_related (bool): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -177,8 +192,9 @@ def _from_openapi_data(cls, dependent_variables, id, *args, **kwargs): # noqa: self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.dependent_variables = dependent_variables - self.id = id + self.type = type + self.message = message + self.is_server_related = is_server_related for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -199,12 +215,13 @@ def _from_openapi_data(cls, dependent_variables, id, *args, **kwargs): # noqa: ]) @convert_js_args_to_python_args - def __init__(self, dependent_variables, id, *args, **kwargs): # noqa: E501 - """ChoiceOption - a model defined in OpenAPI + def __init__(self, type, message, is_server_related, *args, **kwargs): # noqa: E501 + """ReportDetailError - a model defined in OpenAPI Args: - dependent_variables ([TemplateVariable]): Template variables unblocked when the option is chosen - id (str): The id of the option + type (str): + message (str): + is_server_related (bool): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -266,8 +283,9 @@ def __init__(self, dependent_variables, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.dependent_variables = dependent_variables - self.id = id + self.type = type + self.message = message + self.is_server_related = is_server_related for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_detail_errors.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_detail_errors.py new file mode 100644 index 00000000..a3d73535 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_detail_errors.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.report_detail_error import ReportDetailError + globals()['ReportDetailError'] = ReportDetailError + + +class ReportDetailErrors(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'product_id': (str,), # noqa: E501 + 'errors': ([ReportDetailError],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'product_id': 'productId', # noqa: E501 + 'errors': 'errors', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, product_id, errors, *args, **kwargs): # noqa: E501 + """ReportDetailErrors - a model defined in OpenAPI + + Args: + product_id (str): The product ID in lowercase + errors ([ReportDetailError]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.product_id = product_id + self.errors = errors + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, product_id, errors, *args, **kwargs): # noqa: E501 + """ReportDetailErrors - a model defined in OpenAPI + + Args: + product_id (str): The product ID in lowercase + errors ([ReportDetailError]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.product_id = product_id + self.errors = errors + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_ok_response.py similarity index 72% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_variable_value.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_ok_response.py index 59e92f0c..1ed40b40 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_variable_value.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/report_ok_response.py @@ -30,19 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.choice_variable_value import ChoiceVariableValue - from criteo_api_retailmedia_preview.model.color_variable_value import ColorVariableValue - from criteo_api_retailmedia_preview.model.files_variable_value import FilesVariableValue - from criteo_api_retailmedia_preview.model.hyperlink_variable_value import HyperlinkVariableValue - from criteo_api_retailmedia_preview.model.text_variable_value import TextVariableValue - globals()['ChoiceVariableValue'] = ChoiceVariableValue - globals()['ColorVariableValue'] = ColorVariableValue - globals()['FilesVariableValue'] = FilesVariableValue - globals()['HyperlinkVariableValue'] = HyperlinkVariableValue - globals()['TextVariableValue'] = TextVariableValue - - -class TemplateVariableValue(ModelNormal): + from criteo_api_retailmedia_preview.model.report_detail_errors import ReportDetailErrors + globals()['ReportDetailErrors'] = ReportDetailErrors + + +class ReportOkResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -67,6 +59,13 @@ class TemplateVariableValue(ModelNormal): """ allowed_values = { + ('status',): { + 'ACCEPTED': "ACCEPTED", + 'IN_PROGRESS': "IN_PROGRESS", + 'VALIDATED': "VALIDATED", + 'VALIDATED_WITH_ERRORS': "VALIDATED_WITH_ERRORS", + 'FAILED': "FAILED", + }, } validations = { @@ -95,12 +94,13 @@ def openapi_types(): """ lazy_import() return { - 'id': (str,), # noqa: E501 - 'text_variable_value': (TextVariableValue,), # noqa: E501 - 'choice_variable_value': (ChoiceVariableValue,), # noqa: E501 - 'color_variable_value': (ColorVariableValue,), # noqa: E501 - 'files_variable_value': (FilesVariableValue,), # noqa: E501 - 'hyperlink_variable_value': (HyperlinkVariableValue,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'import_request_timestamp': (int,), # noqa: E501 + 'number_of_products_in_the_batch': (int,), # noqa: E501 + 'number_of_products_upserted': (int,), # noqa: E501 + 'number_of_products_deleted': (int,), # noqa: E501 + 'number_of_products_with_errors': (int,), # noqa: E501 + 'error_details': ([ReportDetailErrors],), # noqa: E501 } @cached_property @@ -109,12 +109,13 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'text_variable_value': 'textVariableValue', # noqa: E501 - 'choice_variable_value': 'choiceVariableValue', # noqa: E501 - 'color_variable_value': 'colorVariableValue', # noqa: E501 - 'files_variable_value': 'filesVariableValue', # noqa: E501 - 'hyperlink_variable_value': 'hyperlinkVariableValue', # noqa: E501 + 'status': 'status', # noqa: E501 + 'import_request_timestamp': 'importRequestTimestamp', # noqa: E501 + 'number_of_products_in_the_batch': 'numberOfProductsInTheBatch', # noqa: E501 + 'number_of_products_upserted': 'numberOfProductsUpserted', # noqa: E501 + 'number_of_products_deleted': 'numberOfProductsDeleted', # noqa: E501 + 'number_of_products_with_errors': 'numberOfProductsWithErrors', # noqa: E501 + 'error_details': 'errorDetails', # noqa: E501 } read_only_vars = { @@ -124,11 +125,17 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 - """TemplateVariableValue - a model defined in OpenAPI + def _from_openapi_data(cls, status, import_request_timestamp, number_of_products_in_the_batch, number_of_products_upserted, number_of_products_deleted, number_of_products_with_errors, error_details, *args, **kwargs): # noqa: E501 + """ReportOkResponse - a model defined in OpenAPI Args: - id (str): The id of the template variable the value is applied to + status (str): The status of the operation. The operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED) + import_request_timestamp (int): The date when the original batch request was sent. + number_of_products_in_the_batch (int): The number of products present in the batch. + number_of_products_upserted (int): The number of products upserted. + number_of_products_deleted (int): The number of products deleted. + number_of_products_with_errors (int): The number of products with errors. + error_details ([ReportDetailErrors]): The list of errors with details. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -161,11 +168,6 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - text_variable_value (TextVariableValue): [optional] # noqa: E501 - choice_variable_value (ChoiceVariableValue): [optional] # noqa: E501 - color_variable_value (ColorVariableValue): [optional] # noqa: E501 - files_variable_value (FilesVariableValue): [optional] # noqa: E501 - hyperlink_variable_value (HyperlinkVariableValue): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -197,7 +199,13 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id + self.status = status + self.import_request_timestamp = import_request_timestamp + self.number_of_products_in_the_batch = number_of_products_in_the_batch + self.number_of_products_upserted = number_of_products_upserted + self.number_of_products_deleted = number_of_products_deleted + self.number_of_products_with_errors = number_of_products_with_errors + self.error_details = error_details for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -218,11 +226,17 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """TemplateVariableValue - a model defined in OpenAPI + def __init__(self, status, import_request_timestamp, number_of_products_in_the_batch, number_of_products_upserted, number_of_products_deleted, number_of_products_with_errors, error_details, *args, **kwargs): # noqa: E501 + """ReportOkResponse - a model defined in OpenAPI Args: - id (str): The id of the template variable the value is applied to + status (str): The status of the operation. The operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED) + import_request_timestamp (int): The date when the original batch request was sent. + number_of_products_in_the_batch (int): The number of products present in the batch. + number_of_products_upserted (int): The number of products upserted. + number_of_products_deleted (int): The number of products deleted. + number_of_products_with_errors (int): The number of products with errors. + error_details ([ReportDetailErrors]): The list of errors with details. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -255,11 +269,6 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - text_variable_value (TextVariableValue): [optional] # noqa: E501 - choice_variable_value (ChoiceVariableValue): [optional] # noqa: E501 - color_variable_value (ColorVariableValue): [optional] # noqa: E501 - files_variable_value (FilesVariableValue): [optional] # noqa: E501 - hyperlink_variable_value (HyperlinkVariableValue): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -289,7 +298,13 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id + self.status = status + self.import_request_timestamp = import_request_timestamp + self.number_of_products_in_the_batch = number_of_products_in_the_batch + self.number_of_products_upserted = number_of_products_upserted + self.number_of_products_deleted = number_of_products_deleted + self.number_of_products_with_errors = number_of_products_with_errors + self.error_details = error_details for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_creative202210.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_update_model_v2.py similarity index 94% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_creative202210.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_update_model_v2.py index fed98038..3b52fa83 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_creative202210.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_update_model_v2.py @@ -30,11 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.creative202210 import Creative202210 - globals()['Creative202210'] = Creative202210 + from criteo_api_retailmedia_preview.model.external_preferred_line_item_update_model_v2 import ExternalPreferredLineItemUpdateModelV2 + globals()['ExternalPreferredLineItemUpdateModelV2'] = ExternalPreferredLineItemUpdateModelV2 -class ResourceOfCreative202210(ModelNormal): +class ResourceOfPreferredLineItemUpdateModelV2(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -87,9 +87,9 @@ def openapi_types(): """ lazy_import() return { - 'attributes': (Creative202210,), # noqa: E501 'id': (str, none_type,), # noqa: E501 'type': (str, none_type,), # noqa: E501 + 'attributes': (ExternalPreferredLineItemUpdateModelV2,), # noqa: E501 } @cached_property @@ -98,9 +98,9 @@ def discriminator(): attribute_map = { - 'attributes': 'attributes', # noqa: E501 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 } read_only_vars = { @@ -111,7 +111,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResourceOfCreative202210 - a model defined in OpenAPI + """ResourceOfPreferredLineItemUpdateModelV2 - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -144,9 +144,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (Creative202210): [optional] # noqa: E501 id (str, none_type): Id of the entity. [optional] # noqa: E501 type (str, none_type): Canonical type name of the entity. [optional] # noqa: E501 + attributes (ExternalPreferredLineItemUpdateModelV2): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -199,7 +199,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ResourceOfCreative202210 - a model defined in OpenAPI + """ResourceOfPreferredLineItemUpdateModelV2 - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -232,9 +232,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (Creative202210): [optional] # noqa: E501 id (str, none_type): Id of the entity. [optional] # noqa: E501 type (str, none_type): Canonical type name of the entity. [optional] # noqa: E501 + attributes (ExternalPreferredLineItemUpdateModelV2): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_template.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py similarity index 95% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_template.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py index 46f7d4ad..cb6d6a6c 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_template.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py @@ -30,11 +30,11 @@ def lazy_import(): - from criteo_api_retailmedia_preview.model.template import Template - globals()['Template'] = Template + from criteo_api_retailmedia_preview.model.external_preferred_line_item_v2 import ExternalPreferredLineItemV2 + globals()['ExternalPreferredLineItemV2'] = ExternalPreferredLineItemV2 -class ResourceOfTemplate(ModelNormal): +class ResourceOfPreferredLineItemV2(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -87,9 +87,9 @@ def openapi_types(): """ lazy_import() return { - 'attributes': (Template,), # noqa: E501 'id': (str, none_type,), # noqa: E501 'type': (str, none_type,), # noqa: E501 + 'attributes': (ExternalPreferredLineItemV2,), # noqa: E501 } @cached_property @@ -98,9 +98,9 @@ def discriminator(): attribute_map = { - 'attributes': 'attributes', # noqa: E501 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 } read_only_vars = { @@ -111,7 +111,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResourceOfTemplate - a model defined in OpenAPI + """ResourceOfPreferredLineItemV2 - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -144,9 +144,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (Template): [optional] # noqa: E501 id (str, none_type): Id of the entity. [optional] # noqa: E501 type (str, none_type): Canonical type name of the entity. [optional] # noqa: E501 + attributes (ExternalPreferredLineItemV2): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -199,7 +199,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ResourceOfTemplate - a model defined in OpenAPI + """ResourceOfPreferredLineItemV2 - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -232,9 +232,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (Template): [optional] # noqa: E501 id (str, none_type): Id of the entity. [optional] # noqa: E501 type (str, none_type): Canonical type name of the entity. [optional] # noqa: E501 + attributes (ExternalPreferredLineItemV2): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_brands.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_brands.py new file mode 100644 index 00000000..871b4fe2 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_brands.py @@ -0,0 +1,257 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + + +class RetailMediaBrands(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'brand_ids': ([int], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'brand_ids': 'brandIds', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RetailMediaBrands - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + brand_ids ([int], none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """RetailMediaBrands - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + brand_ids ([int], none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py index 5a23aac2..47e3deb0 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py @@ -55,6 +55,31 @@ class SyncAttributedTransactionsReport(ModelNormal): """ allowed_values = { + ('click_attribution_window',): { + 'None': None, + '7D': "7D", + '14D': "14D", + '30D': "30D", + 'NONE': "none", + }, + ('view_attribution_window',): { + 'None': None, + '1D': "1D", + '7D': "7D", + '14D': "14D", + '30D': "30D", + 'NONE': "none", + }, + ('campaign_type',): { + 'None': None, + 'SPONSOREDPRODUCTS': "sponsoredProducts", + 'ONSITEDISPLAYS': "onSiteDisplays", + }, + ('sales_channel',): { + 'None': None, + 'OFFLINE': "offline", + 'ONLINE': "online", + }, ('dimensions',): { 'None': None, 'CAMPAIGNNAME': "campaignName", @@ -89,31 +114,6 @@ class SyncAttributedTransactionsReport(ModelNormal): 'ATTRIBUTEDUNITS': "attributedUnits", 'ATTRIBUTEDSALES': "attributedSales", }, - ('click_attribution_window',): { - 'None': None, - '7D': "7D", - '14D': "14D", - '30D': "30D", - 'NONE': "none", - }, - ('view_attribution_window',): { - 'None': None, - '1D': "1D", - '7D': "7D", - '14D': "14D", - '30D': "30D", - 'NONE': "none", - }, - ('campaign_type',): { - 'None': None, - 'SPONSOREDPRODUCTS': "sponsoredProducts", - 'ONSITEDISPLAYS': "onSiteDisplays", - }, - ('sales_channel',): { - 'None': None, - 'OFFLINE': "offline", - 'ONLINE': "online", - }, } validations = { @@ -145,12 +145,12 @@ def openapi_types(): 'end_date': (datetime,), # noqa: E501 'campaign_ids': ([str], none_type,), # noqa: E501 'line_item_ids': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -165,12 +165,12 @@ def discriminator(): 'end_date': 'endDate', # noqa: E501 'campaign_ids': 'campaignIds', # noqa: E501 'line_item_ids': 'lineItemIds', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -220,14 +220,14 @@ def _from_openapi_data(cls, account_id, start_date, end_date, *args, **kwargs): Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 - line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 + campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501 + line_item_ids ([str], none_type): Line item ids to filter. [optional] # noqa: E501 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -322,14 +322,14 @@ def __init__(self, account_id, start_date, end_date, *args, **kwargs): # noqa: Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 - line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 + campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501 + line_item_ids ([str], none_type): Line item ids to filter. [optional] # noqa: E501 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_campaigns_report.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_campaigns_report.py index d787a1af..34890112 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_campaigns_report.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_campaigns_report.py @@ -65,43 +65,6 @@ class SyncCampaignsReport(ModelNormal): 'ENVIRONMENT': "environment", 'SERVEDCATEGORY': "servedCategory", }, - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'CPM': "cpm", - 'ROAS': "roas", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'PAGETYPENAME': "pageTypeName", - 'ENVIRONMENT': "environment", - 'KEYWORD': "keyword", - 'SALESCHANNEL': "salesChannel", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - }, ('click_attribution_window',): { 'None': None, '7D': "7D", @@ -127,6 +90,47 @@ class SyncCampaignsReport(ModelNormal): 'OFFLINE': "offline", 'ONLINE': "online", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -158,12 +162,12 @@ def openapi_types(): 'end_date': (datetime,), # noqa: E501 'report_type': (str, none_type,), # noqa: E501 'campaign_ids': ([str], none_type,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -178,12 +182,12 @@ def discriminator(): 'end_date': 'endDate', # noqa: E501 'report_type': 'reportType', # noqa: E501 'campaign_ids': 'campaignIds', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -234,13 +238,13 @@ def _from_openapi_data(cls, account_id, start_date, end_date, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) report_type (str, none_type): 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 - campaign_ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501 - metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -336,13 +340,13 @@ def __init__(self, account_id, start_date, end_date, *args, **kwargs): # noqa: through its discriminator because we passed in _visited_composed_classes = (Animal,) report_type (str, none_type): 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 - campaign_ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501 - metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_line_items_report.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_line_items_report.py index 707716eb..cfd5a62d 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_line_items_report.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/sync_line_items_report.py @@ -65,44 +65,6 @@ class SyncLineItemsReport(ModelNormal): 'ENVIRONMENT': "environment", 'SERVEDCATEGORY': "servedCategory", }, - ('metrics',): { - 'None': None, - 'IMPRESSIONS': "impressions", - 'CLICKS': "clicks", - 'SPEND': "spend", - 'ATTRIBUTEDSALES': "attributedSales", - 'ATTRIBUTEDUNITS': "attributedUnits", - 'ATTRIBUTEDORDERS': "attributedOrders", - 'CTR': "ctr", - 'CPC': "cpc", - 'CPO': "cpo", - 'ROAS': "roas", - 'ASSISTEDUNITS': "assistedUnits", - 'ASSISTEDSALES': "assistedSales", - 'UNIQUEVISITORS': "uniqueVisitors", - 'FREQUENCY': "frequency", - }, - ('dimensions',): { - 'None': None, - 'DATE': "date", - 'HOUR': "hour", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNTYPENAME': "campaignTypeName", - 'ADVPRODUCTCATEGORY': "advProductCategory", - 'ADVPRODUCTID': "advProductId", - 'ADVPRODUCTNAME': "advProductName", - 'BRANDID': "brandId", - 'BRANDNAME': "brandName", - 'LINEITEMID': "lineItemId", - 'LINEITEMNAME': "lineItemName", - 'RETAILERID': "retailerId", - 'RETAILERNAME': "retailerName", - 'KEYWORD': "keyword", - 'PAGETYPENAME': "pageTypeName", - 'SALESCHANNEL': "salesChannel", - 'ENVIRONMENT': "environment", - }, ('click_attribution_window',): { 'None': None, '7D': "7D", @@ -128,6 +90,47 @@ class SyncLineItemsReport(ModelNormal): 'OFFLINE': "offline", 'ONLINE': "online", }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'KEYWORD': "keyword", + 'PAGETYPENAME': "pageTypeName", + 'SALESCHANNEL': "salesChannel", + 'ENVIRONMENT': "environment", + }, + ('metrics',): { + 'None': None, + 'IMPRESSIONS': "impressions", + 'CLICKS': "clicks", + 'SPEND': "spend", + 'ATTRIBUTEDSALES': "attributedSales", + 'ATTRIBUTEDUNITS': "attributedUnits", + 'ATTRIBUTEDORDERS': "attributedOrders", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'CTR': "ctr", + 'CPC': "cpc", + 'CPO': "cpo", + 'CPM': "cpm", + 'ROAS': "roas", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, } validations = { @@ -160,12 +163,12 @@ def openapi_types(): 'report_type': (str, none_type,), # noqa: E501 'line_item_ids': ([str], none_type,), # noqa: E501 'campaign_ids': ([str], none_type,), # noqa: E501 - 'metrics': ([str], none_type,), # noqa: E501 - 'dimensions': ([str], none_type,), # noqa: E501 'click_attribution_window': (str, none_type,), # noqa: E501 'view_attribution_window': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (str, none_type,), # noqa: E501 + 'dimensions': ([str], none_type,), # noqa: E501 + 'metrics': ([str], none_type,), # noqa: E501 'timezone': (str, none_type,), # noqa: E501 } @@ -181,12 +184,12 @@ def discriminator(): 'report_type': 'reportType', # noqa: E501 'line_item_ids': 'lineItemIds', # noqa: E501 'campaign_ids': 'campaignIds', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'dimensions': 'dimensions', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # noqa: E501 + 'dimensions': 'dimensions', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'timezone': 'timezone', # noqa: E501 } @@ -237,14 +240,14 @@ def _from_openapi_data(cls, account_id, start_date, end_date, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) report_type (str, none_type): 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 - line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501 - campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + line_item_ids ([str], none_type): Line Item ids to filter. [optional] # noqa: E501 + campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ @@ -340,14 +343,14 @@ def __init__(self, account_id, start_date, end_date, *args, **kwargs): # noqa: through its discriminator because we passed in _visited_composed_classes = (Animal,) report_type (str, none_type): 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 - line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501 - campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501 - metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 - dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + line_item_ids ([str], none_type): Line Item ids to filter. [optional] # noqa: E501 + campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501 click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501 campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501 sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501 + dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 + metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501 timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501 """ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_response.py deleted file mode 100644 index 73d7d7c4..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/template_response.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: Preview - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from criteo_api_retailmedia_preview.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_preview.model.problem_details import ProblemDetails - from criteo_api_retailmedia_preview.model.resource_of_template import ResourceOfTemplate - globals()['ProblemDetails'] = ProblemDetails - globals()['ResourceOfTemplate'] = ResourceOfTemplate - - -class TemplateResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (ResourceOfTemplate,), # noqa: E501 - 'warnings': ([ProblemDetails],), # noqa: E501 - 'errors': ([ProblemDetails],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - 'errors': 'errors', # noqa: E501 - } - - read_only_vars = { - 'warnings', # noqa: E501 - 'errors', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """TemplateResponse - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data (ResourceOfTemplate): [optional] # noqa: E501 - warnings ([ProblemDetails]): [optional] # noqa: E501 - errors ([ProblemDetails]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TemplateResponse - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data (ResourceOfTemplate): [optional] # noqa: E501 - warnings ([ProblemDetails]): [optional] # noqa: E501 - errors ([ProblemDetails]): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py new file mode 100644 index 00000000..65d18055 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_seller import ValueResourceOfRetailMediaSeller + globals()['ValueResourceOfRetailMediaSeller'] = ValueResourceOfRetailMediaSeller + + +class ValueResourceCollectionInputOfRetailMediaSeller(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ([ValueResourceOfRetailMediaSeller], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ValueResourceCollectionInputOfRetailMediaSeller - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ([ValueResourceOfRetailMediaSeller], none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ValueResourceCollectionInputOfRetailMediaSeller - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ([ValueResourceOfRetailMediaSeller], none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py new file mode 100644 index 00000000..4a1b7af7 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_brand_account_creation import ValueResourceOfRetailMediaBrandAccountCreation + globals()['ValueResourceOfRetailMediaBrandAccountCreation'] = ValueResourceOfRetailMediaBrandAccountCreation + + +class ValueResourceInputOfRetailMediaBrandAccountCreation(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (ValueResourceOfRetailMediaBrandAccountCreation,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ValueResourceInputOfRetailMediaBrandAccountCreation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (ValueResourceOfRetailMediaBrandAccountCreation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ValueResourceInputOfRetailMediaBrandAccountCreation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (ValueResourceOfRetailMediaBrandAccountCreation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py new file mode 100644 index 00000000..0fe42f20 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands + globals()['ValueResourceOfRetailMediaBrands'] = ValueResourceOfRetailMediaBrands + + +class ValueResourceInputOfRetailMediaBrands(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (ValueResourceOfRetailMediaBrands,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ValueResourceInputOfRetailMediaBrands - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (ValueResourceOfRetailMediaBrands): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ValueResourceInputOfRetailMediaBrands - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (ValueResourceOfRetailMediaBrands): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py new file mode 100644 index 00000000..2c345452 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_seller_account_creation import ValueResourceOfRetailMediaSellerAccountCreation + globals()['ValueResourceOfRetailMediaSellerAccountCreation'] = ValueResourceOfRetailMediaSellerAccountCreation + + +class ValueResourceInputOfRetailMediaSellerAccountCreation(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (ValueResourceOfRetailMediaSellerAccountCreation,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ValueResourceInputOfRetailMediaSellerAccountCreation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (ValueResourceOfRetailMediaSellerAccountCreation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ValueResourceInputOfRetailMediaSellerAccountCreation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (ValueResourceOfRetailMediaSellerAccountCreation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py new file mode 100644 index 00000000..23e1849a --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.retail_media_brand_account_creation import RetailMediaBrandAccountCreation + globals()['RetailMediaBrandAccountCreation'] = RetailMediaBrandAccountCreation + + +class ValueResourceOfRetailMediaBrandAccountCreation(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'type': (str, none_type,), # noqa: E501 + 'attributes': (RetailMediaBrandAccountCreation,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ValueResourceOfRetailMediaBrandAccountCreation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str, none_type): [optional] # noqa: E501 + attributes (RetailMediaBrandAccountCreation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ValueResourceOfRetailMediaBrandAccountCreation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str, none_type): [optional] # noqa: E501 + attributes (RetailMediaBrandAccountCreation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_int64.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brands.py similarity index 94% rename from sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_int64.py rename to sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brands.py index 3d9582d1..0a3fb955 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_int64.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brands.py @@ -29,8 +29,12 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError +def lazy_import(): + from criteo_api_retailmedia_preview.model.retail_media_brands import RetailMediaBrands + globals()['RetailMediaBrands'] = RetailMediaBrands -class ValueResourceOfInt64(ModelNormal): + +class ValueResourceOfRetailMediaBrands(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -74,9 +78,10 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'type': (str, none_type,), # noqa: E501 - 'attributes': (int, none_type,), # noqa: E501 + 'attributes': (RetailMediaBrands,), # noqa: E501 } @cached_property @@ -97,7 +102,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ValueResourceOfInt64 - a model defined in OpenAPI + """ValueResourceOfRetailMediaBrands - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -131,7 +136,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) type (str, none_type): [optional] # noqa: E501 - attributes (int, none_type): [optional] # noqa: E501 + attributes (RetailMediaBrands): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -184,7 +189,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ValueResourceOfInt64 - a model defined in OpenAPI + """ValueResourceOfRetailMediaBrands - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -218,7 +223,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) type (str, none_type): [optional] # noqa: E501 - attributes (int, none_type): [optional] # noqa: E501 + attributes (RetailMediaBrands): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py new file mode 100644 index 00000000..6567dba4 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: Preview + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from criteo_api_retailmedia_preview.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_preview.model.retail_media_seller_account_creation import RetailMediaSellerAccountCreation + globals()['RetailMediaSellerAccountCreation'] = RetailMediaSellerAccountCreation + + +class ValueResourceOfRetailMediaSellerAccountCreation(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'type': (str, none_type,), # noqa: E501 + 'attributes': (RetailMediaSellerAccountCreation,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ValueResourceOfRetailMediaSellerAccountCreation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str, none_type): [optional] # noqa: E501 + attributes (RetailMediaSellerAccountCreation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ValueResourceOfRetailMediaSellerAccountCreation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str, none_type): [optional] # noqa: E501 + attributes (RetailMediaSellerAccountCreation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/models/__init__.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/models/__init__.py index ed58024b..0cdd0e52 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/models/__init__.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/models/__init__.py @@ -12,6 +12,9 @@ from criteo_api_retailmedia_preview.model.application_summary_model import ApplicationSummaryModel from criteo_api_retailmedia_preview.model.application_summary_model_resource import ApplicationSummaryModelResource from criteo_api_retailmedia_preview.model.application_summary_model_response import ApplicationSummaryModelResponse +from criteo_api_retailmedia_preview.model.async_accounts_report import AsyncAccountsReport +from criteo_api_retailmedia_preview.model.async_accounts_report_request import AsyncAccountsReportRequest +from criteo_api_retailmedia_preview.model.async_accounts_report_resource import AsyncAccountsReportResource from criteo_api_retailmedia_preview.model.async_campaigns_report import AsyncCampaignsReport from criteo_api_retailmedia_preview.model.async_campaigns_report_request import AsyncCampaignsReportRequest from criteo_api_retailmedia_preview.model.async_campaigns_report_resource import AsyncCampaignsReportResource @@ -19,6 +22,7 @@ from criteo_api_retailmedia_preview.model.async_line_items_report_request import AsyncLineItemsReportRequest from criteo_api_retailmedia_preview.model.async_line_items_report_resource import AsyncLineItemsReportResource from criteo_api_retailmedia_preview.model.async_report_response import AsyncReportResponse +from criteo_api_retailmedia_preview.model.batch_accepted_response import BatchAcceptedResponse from criteo_api_retailmedia_preview.model.brand import Brand from criteo_api_retailmedia_preview.model.brand_preview import BrandPreview from criteo_api_retailmedia_preview.model.brand_preview_list_response import BrandPreviewListResponse @@ -27,73 +31,89 @@ from criteo_api_retailmedia_preview.model.campaign_monthly_budget_override import CampaignMonthlyBudgetOverride from criteo_api_retailmedia_preview.model.category import Category from criteo_api_retailmedia_preview.model.category202204 import Category202204 -from criteo_api_retailmedia_preview.model.choice_option import ChoiceOption -from criteo_api_retailmedia_preview.model.choice_variable_specification import ChoiceVariableSpecification -from criteo_api_retailmedia_preview.model.choice_variable_value import ChoiceVariableValue -from criteo_api_retailmedia_preview.model.color_variable_value import ColorVariableValue +from criteo_api_retailmedia_preview.model.change_details import ChangeDetails from criteo_api_retailmedia_preview.model.common_error import CommonError from criteo_api_retailmedia_preview.model.common_problem import CommonProblem from criteo_api_retailmedia_preview.model.common_warning import CommonWarning from criteo_api_retailmedia_preview.model.cpc_rate_card_preview import CpcRateCardPreview from criteo_api_retailmedia_preview.model.cpc_rate_card_preview_response import CpcRateCardPreviewResponse -from criteo_api_retailmedia_preview.model.creative202210 import Creative202210 -from criteo_api_retailmedia_preview.model.creative202210_list_response import Creative202210ListResponse -from criteo_api_retailmedia_preview.model.creative202210_response import Creative202210Response -from criteo_api_retailmedia_preview.model.creative_create_model202207 import CreativeCreateModel202207 -from criteo_api_retailmedia_preview.model.creative_update_model202207 import CreativeUpdateModel202207 +from criteo_api_retailmedia_preview.model.custom_attribute import CustomAttribute from criteo_api_retailmedia_preview.model.daily_line_item_budget_override import DailyLineItemBudgetOverride from criteo_api_retailmedia_preview.model.export_report_column import ExportReportColumn from criteo_api_retailmedia_preview.model.export_report_meta_data import ExportReportMetaData from criteo_api_retailmedia_preview.model.external_account import ExternalAccount from criteo_api_retailmedia_preview.model.external_brand import ExternalBrand -from criteo_api_retailmedia_preview.model.external_catalog_request_preview import ExternalCatalogRequestPreview -from criteo_api_retailmedia_preview.model.external_catalog_status import ExternalCatalogStatus +from criteo_api_retailmedia_preview.model.external_line_item_capping_v2 import ExternalLineItemCappingV2 +from criteo_api_retailmedia_preview.model.external_line_item_page_category_v2 import ExternalLineItemPageCategoryV2 +from criteo_api_retailmedia_preview.model.external_line_item_page_v2 import ExternalLineItemPageV2 +from criteo_api_retailmedia_preview.model.external_preferred_line_item_create_model_v2 import ExternalPreferredLineItemCreateModelV2 +from criteo_api_retailmedia_preview.model.external_preferred_line_item_update_model_v2 import ExternalPreferredLineItemUpdateModelV2 +from criteo_api_retailmedia_preview.model.external_preferred_line_item_v2 import ExternalPreferredLineItemV2 from criteo_api_retailmedia_preview.model.external_product_button_request import ExternalProductButtonRequest from criteo_api_retailmedia_preview.model.external_product_button_response import ExternalProductButtonResponse from criteo_api_retailmedia_preview.model.external_retailer import ExternalRetailer -from criteo_api_retailmedia_preview.model.files_variable_value import FilesVariableValue -from criteo_api_retailmedia_preview.model.files_variables_specification import FilesVariablesSpecification +from criteo_api_retailmedia_preview.model.fail_response import FailResponse from criteo_api_retailmedia_preview.model.grant_consent_input import GrantConsentInput from criteo_api_retailmedia_preview.model.grant_consent_model import GrantConsentModel from criteo_api_retailmedia_preview.model.grant_consent_model_value_resource import GrantConsentModelValueResource -from criteo_api_retailmedia_preview.model.hyperlink_variable_value import HyperlinkVariableValue from criteo_api_retailmedia_preview.model.input_keywords import InputKeywords +from criteo_api_retailmedia_preview.model.input_resource_of_preferred_line_item_create_model_v2 import InputResourceOfPreferredLineItemCreateModelV2 +from criteo_api_retailmedia_preview.model.insertion_order_history_change_data_capture import InsertionOrderHistoryChangeDataCapture +from criteo_api_retailmedia_preview.model.installment import Installment from criteo_api_retailmedia_preview.model.json_api_body_with_id_of_int64_and_account_and_account import JsonApiBodyWithIdOfInt64AndAccountAndAccount from criteo_api_retailmedia_preview.model.json_api_body_with_id_of_int64_and_brand_and_brand import JsonApiBodyWithIdOfInt64AndBrandAndBrand -from criteo_api_retailmedia_preview.model.json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status import JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus from criteo_api_retailmedia_preview.model.json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers import JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers from criteo_api_retailmedia_preview.model.json_api_body_with_id_of_int64_and_retailer_and_retailer import JsonApiBodyWithIdOfInt64AndRetailerAndRetailer -from criteo_api_retailmedia_preview.model.json_api_body_without_id_of_catalog_request_and_catalog_request_preview import JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview from criteo_api_retailmedia_preview.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount from criteo_api_retailmedia_preview.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand from criteo_api_retailmedia_preview.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer -from criteo_api_retailmedia_preview.model.json_api_request_of_catalog_request_preview import JsonApiRequestOfCatalogRequestPreview -from criteo_api_retailmedia_preview.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers from criteo_api_retailmedia_preview.model.keywords import Keywords from criteo_api_retailmedia_preview.model.line_item_bid_multipliers import LineItemBidMultipliers from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse from criteo_api_retailmedia_preview.model.line_item_budget_overrides import LineItemBudgetOverrides +from criteo_api_retailmedia_preview.model.loyalty_points import LoyaltyPoints +from criteo_api_retailmedia_preview.model.metadata import Metadata from criteo_api_retailmedia_preview.model.monthly_line_item_budeget_override import MonthlyLineItemBudegetOverride from criteo_api_retailmedia_preview.model.page_metadata import PageMetadata -from criteo_api_retailmedia_preview.model.page_type_environment import PageTypeEnvironment +from criteo_api_retailmedia_preview.model.page_of_insertion_order_history_change_data_capture import PageOfInsertionOrderHistoryChangeDataCapture from criteo_api_retailmedia_preview.model.placement_preview import PlacementPreview from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse +from criteo_api_retailmedia_preview.model.preferred_line_item_create_model_v2_request import PreferredLineItemCreateModelV2Request +from criteo_api_retailmedia_preview.model.preferred_line_item_update_model_v2_request import PreferredLineItemUpdateModelV2Request +from criteo_api_retailmedia_preview.model.preferred_line_item_v2_paged_list_response import PreferredLineItemV2PagedListResponse +from criteo_api_retailmedia_preview.model.preferred_line_item_v2_response import PreferredLineItemV2Response +from criteo_api_retailmedia_preview.model.price import Price from criteo_api_retailmedia_preview.model.problem_details import ProblemDetails +from criteo_api_retailmedia_preview.model.product import Product from criteo_api_retailmedia_preview.model.product_button_list_request import ProductButtonListRequest from criteo_api_retailmedia_preview.model.product_button_list_response import ProductButtonListResponse from criteo_api_retailmedia_preview.model.product_button_request import ProductButtonRequest +from criteo_api_retailmedia_preview.model.product_importer_error import ProductImporterError +from criteo_api_retailmedia_preview.model.product_importer_warning import ProductImporterWarning +from criteo_api_retailmedia_preview.model.product_shipping import ProductShipping +from criteo_api_retailmedia_preview.model.product_shipping_dimension import ProductShippingDimension +from criteo_api_retailmedia_preview.model.product_shipping_weight import ProductShippingWeight +from criteo_api_retailmedia_preview.model.product_tax import ProductTax +from criteo_api_retailmedia_preview.model.product_unit_pricing_base_measure import ProductUnitPricingBaseMeasure +from criteo_api_retailmedia_preview.model.product_unit_pricing_measure import ProductUnitPricingMeasure +from criteo_api_retailmedia_preview.model.products_custom_batch_request import ProductsCustomBatchRequest +from criteo_api_retailmedia_preview.model.products_custom_batch_request_entry import ProductsCustomBatchRequestEntry from criteo_api_retailmedia_preview.model.recommended_keywords_result import RecommendedKeywordsResult from criteo_api_retailmedia_preview.model.report_data_response_resource import ReportDataResponseResource +from criteo_api_retailmedia_preview.model.report_detail_error import ReportDetailError +from criteo_api_retailmedia_preview.model.report_detail_errors import ReportDetailErrors +from criteo_api_retailmedia_preview.model.report_ok_response import ReportOkResponse from criteo_api_retailmedia_preview.model.report_outcome import ReportOutcome from criteo_api_retailmedia_preview.model.report_response import ReportResponse from criteo_api_retailmedia_preview.model.resource_collection_outcome_of_sku_search_result import ResourceCollectionOutcomeOfSkuSearchResult from criteo_api_retailmedia_preview.model.resource_of_brand_preview import ResourceOfBrandPreview from criteo_api_retailmedia_preview.model.resource_of_cpc_rate_card_preview import ResourceOfCpcRateCardPreview -from criteo_api_retailmedia_preview.model.resource_of_creative202210 import ResourceOfCreative202210 from criteo_api_retailmedia_preview.model.resource_of_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers from criteo_api_retailmedia_preview.model.resource_of_placement_preview import ResourceOfPlacementPreview +from criteo_api_retailmedia_preview.model.resource_of_preferred_line_item_update_model_v2 import ResourceOfPreferredLineItemUpdateModelV2 +from criteo_api_retailmedia_preview.model.resource_of_preferred_line_item_v2 import ResourceOfPreferredLineItemV2 from criteo_api_retailmedia_preview.model.resource_of_product_button_request import ResourceOfProductButtonRequest from criteo_api_retailmedia_preview.model.resource_of_product_button_response import ResourceOfProductButtonResponse from criteo_api_retailmedia_preview.model.resource_of_retail_media_account import ResourceOfRetailMediaAccount @@ -105,10 +125,10 @@ from criteo_api_retailmedia_preview.model.resource_of_sku_search_result import ResourceOfSkuSearchResult from criteo_api_retailmedia_preview.model.resource_of_sku_slim_data_preview import ResourceOfSkuSlimDataPreview from criteo_api_retailmedia_preview.model.resource_of_sku_slim_data_v2 import ResourceOfSkuSlimDataV2 -from criteo_api_retailmedia_preview.model.resource_of_template import ResourceOfTemplate from criteo_api_retailmedia_preview.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount from criteo_api_retailmedia_preview.model.retail_media_account import RetailMediaAccount from criteo_api_retailmedia_preview.model.retail_media_brand_account_creation import RetailMediaBrandAccountCreation +from criteo_api_retailmedia_preview.model.retail_media_brands import RetailMediaBrands from criteo_api_retailmedia_preview.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel from criteo_api_retailmedia_preview.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel from criteo_api_retailmedia_preview.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest @@ -139,7 +159,6 @@ from criteo_api_retailmedia_preview.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList from criteo_api_retailmedia_preview.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 from criteo_api_retailmedia_preview.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 -from criteo_api_retailmedia_preview.model.section import Section from criteo_api_retailmedia_preview.model.seller_preview import SellerPreview from criteo_api_retailmedia_preview.model.seller_preview_response import SellerPreviewResponse from criteo_api_retailmedia_preview.model.sku_data_preview import SkuDataPreview @@ -168,22 +187,20 @@ from criteo_api_retailmedia_preview.model.sync_line_items_report import SyncLineItemsReport from criteo_api_retailmedia_preview.model.sync_line_items_report_request import SyncLineItemsReportRequest from criteo_api_retailmedia_preview.model.sync_line_items_report_resource import SyncLineItemsReportResource -from criteo_api_retailmedia_preview.model.template import Template -from criteo_api_retailmedia_preview.model.template_list_response import TemplateListResponse -from criteo_api_retailmedia_preview.model.template_response import TemplateResponse -from criteo_api_retailmedia_preview.model.template_variable import TemplateVariable -from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue -from criteo_api_retailmedia_preview.model.text_variable_specification import TextVariableSpecification -from criteo_api_retailmedia_preview.model.text_variable_value import TextVariableValue -from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_int64 import ValueResourceCollectionOutcomeOfInt64 +from criteo_api_retailmedia_preview.model.value_resource_collection_input_of_retail_media_seller import ValueResourceCollectionInputOfRetailMediaSeller from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_retail_media_seller import ValueResourceCollectionOutcomeOfRetailMediaSeller from criteo_api_retailmedia_preview.model.value_resource_input_of_campaign_budget_overrides import ValueResourceInputOfCampaignBudgetOverrides from criteo_api_retailmedia_preview.model.value_resource_input_of_line_item_budget_overrides import ValueResourceInputOfLineItemBudgetOverrides +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brand_account_creation import ValueResourceInputOfRetailMediaBrandAccountCreation +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_seller_account_creation import ValueResourceInputOfRetailMediaSellerAccountCreation from criteo_api_retailmedia_preview.model.value_resource_of_campaign_budget_overrides import ValueResourceOfCampaignBudgetOverrides -from criteo_api_retailmedia_preview.model.value_resource_of_int64 import ValueResourceOfInt64 from criteo_api_retailmedia_preview.model.value_resource_of_line_item_budget_overrides import ValueResourceOfLineItemBudgetOverrides from criteo_api_retailmedia_preview.model.value_resource_of_recommended_keywords_result import ValueResourceOfRecommendedKeywordsResult +from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_brand_account_creation import ValueResourceOfRetailMediaBrandAccountCreation +from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_seller import ValueResourceOfRetailMediaSeller +from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_seller_account_creation import ValueResourceOfRetailMediaSellerAccountCreation from criteo_api_retailmedia_preview.model.value_resource_outcome_of_campaign_budget_overrides import ValueResourceOutcomeOfCampaignBudgetOverrides from criteo_api_retailmedia_preview.model.value_resource_outcome_of_line_item_budget_overrides import ValueResourceOutcomeOfLineItemBudgetOverrides from criteo_api_retailmedia_preview.model.value_resource_outcome_of_recommended_keywords_result import ValueResourceOutcomeOfRecommendedKeywordsResult diff --git a/sdks/retailmedia_preview/docs/AccountsApi.md b/sdks/retailmedia_preview/docs/AccountsApi.md index c4dd0a1b..1cf058ab 100644 --- a/sdks/retailmedia_preview/docs/AccountsApi.md +++ b/sdks/retailmedia_preview/docs/AccountsApi.md @@ -4,13 +4,118 @@ All URIs are relative to *https://api.criteo.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**add_brands**](AccountsApi.md#add_brands) | **POST** /preview/retail-media/account-management/accounts/{accountId}/brands/add | [**create_private_market_demand_brand_account**](AccountsApi.md#create_private_market_demand_brand_account) | **POST** /preview/retail-media/account-management/accounts/{accountId}/create-brand-account | [**create_private_market_demand_seller_account**](AccountsApi.md#create_private_market_demand_seller_account) | **POST** /preview/retail-media/account-management/accounts/{accountId}/create-seller-account | [**grant_consent**](AccountsApi.md#grant_consent) | **POST** /preview/retail-media/accounts/{accountId}/grant-consent | -[**update_brands**](AccountsApi.md#update_brands) | **PUT** /preview/retail-media/account-management/accounts/{accountId}/brands | +[**remove_brands**](AccountsApi.md#remove_brands) | **POST** /preview/retail-media/account-management/accounts/{accountId}/brands/remove | [**update_sellers**](AccountsApi.md#update_sellers) | **PUT** /preview/retail-media/account-management/accounts/{accountId}/sellers | +# **add_brands** +> ValueResourceOfRetailMediaBrands add_brands(account_id) + + + +Add brands to an account + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_preview +from criteo_api_retailmedia_preview.api import accounts_api +from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands +from pprint import pprint +# Defining the host is optional and defaults to https://api.criteo.com +# See configuration.py for a list of all supported configuration parameters. +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Enter a context with an instance of the API client +with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounts_api.AccountsApi(api_client) + account_id = "accountId_example" # str | the account id to update + value_resource_input_of_retail_media_brands = ValueResourceInputOfRetailMediaBrands( + data=ValueResourceOfRetailMediaBrands( + type="type_example", + attributes=RetailMediaBrands( + brand_ids=[ + 1, + ], + ), + ), + ) # ValueResourceInputOfRetailMediaBrands | brands to associate to account (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.add_brands(account_id) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling AccountsApi->add_brands: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.add_brands(account_id, value_resource_input_of_retail_media_brands=value_resource_input_of_retail_media_brands) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling AccountsApi->add_brands: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| the account id to update | + **value_resource_input_of_retail_media_brands** | [**ValueResourceInputOfRetailMediaBrands**](ValueResourceInputOfRetailMediaBrands.md)| brands to associate to account | [optional] + +### Return type + +[**ValueResourceOfRetailMediaBrands**](ValueResourceOfRetailMediaBrands.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **create_private_market_demand_brand_account** > ResourceOutcomeOfRetailMediaAccount create_private_market_demand_brand_account(account_id) @@ -28,7 +133,7 @@ import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import accounts_api from criteo_api_retailmedia_preview.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount -from criteo_api_retailmedia_preview.model.retail_media_brand_account_creation import RetailMediaBrandAccountCreation +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brand_account_creation import ValueResourceInputOfRetailMediaBrandAccountCreation from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -58,13 +163,18 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = accounts_api.AccountsApi(api_client) account_id = "accountId_example" # str | Account Id for the parent private market account - retail_media_brand_account_creation = RetailMediaBrandAccountCreation( - name="name_example", - company_name="company_name_example", - brands=[ - 1, - ], - ) # RetailMediaBrandAccountCreation | Initial creation and configuration options for the new account (optional) + value_resource_input_of_retail_media_brand_account_creation = ValueResourceInputOfRetailMediaBrandAccountCreation( + data=ValueResourceOfRetailMediaBrandAccountCreation( + type="type_example", + attributes=RetailMediaBrandAccountCreation( + name="name_example", + company_name="company_name_example", + brands=[ + 1, + ], + ), + ), + ) # ValueResourceInputOfRetailMediaBrandAccountCreation | Initial creation and configuration options for the new account (optional) # example passing only required values which don't have defaults set try: @@ -76,7 +186,7 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.create_private_market_demand_brand_account(account_id, retail_media_brand_account_creation=retail_media_brand_account_creation) + api_response = api_instance.create_private_market_demand_brand_account(account_id, value_resource_input_of_retail_media_brand_account_creation=value_resource_input_of_retail_media_brand_account_creation) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: print("Exception when calling AccountsApi->create_private_market_demand_brand_account: %s\n" % e) @@ -88,7 +198,7 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| Account Id for the parent private market account | - **retail_media_brand_account_creation** | [**RetailMediaBrandAccountCreation**](RetailMediaBrandAccountCreation.md)| Initial creation and configuration options for the new account | [optional] + **value_resource_input_of_retail_media_brand_account_creation** | [**ValueResourceInputOfRetailMediaBrandAccountCreation**](ValueResourceInputOfRetailMediaBrandAccountCreation.md)| Initial creation and configuration options for the new account | [optional] ### Return type @@ -128,7 +238,7 @@ Creates a new child Demand Seller Account for the provided parent private market import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import accounts_api -from criteo_api_retailmedia_preview.model.retail_media_seller_account_creation import RetailMediaSellerAccountCreation +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_seller_account_creation import ValueResourceInputOfRetailMediaSellerAccountCreation from criteo_api_retailmedia_preview.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com @@ -159,16 +269,21 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = accounts_api.AccountsApi(api_client) account_id = "accountId_example" # str | Account Id for the parent private market account - retail_media_seller_account_creation = RetailMediaSellerAccountCreation( - name="name_example", - company_name="company_name_example", - sellers=[ - RetailMediaSeller( - seller_id="seller_id_example", - retailer_id=1, + value_resource_input_of_retail_media_seller_account_creation = ValueResourceInputOfRetailMediaSellerAccountCreation( + data=ValueResourceOfRetailMediaSellerAccountCreation( + type="type_example", + attributes=RetailMediaSellerAccountCreation( + name="name_example", + company_name="company_name_example", + sellers=[ + RetailMediaSeller( + seller_id="seller_id_example", + retailer_id=1, + ), + ], ), - ], - ) # RetailMediaSellerAccountCreation | Initial creation and configuration options for the new account (optional) + ), + ) # ValueResourceInputOfRetailMediaSellerAccountCreation | Initial creation and configuration options for the new account (optional) # example passing only required values which don't have defaults set try: @@ -180,7 +295,7 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.create_private_market_demand_seller_account(account_id, retail_media_seller_account_creation=retail_media_seller_account_creation) + api_response = api_instance.create_private_market_demand_seller_account(account_id, value_resource_input_of_retail_media_seller_account_creation=value_resource_input_of_retail_media_seller_account_creation) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: print("Exception when calling AccountsApi->create_private_market_demand_seller_account: %s\n" % e) @@ -192,7 +307,7 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| Account Id for the parent private market account | - **retail_media_seller_account_creation** | [**RetailMediaSellerAccountCreation**](RetailMediaSellerAccountCreation.md)| Initial creation and configuration options for the new account | [optional] + **value_resource_input_of_retail_media_seller_account_creation** | [**ValueResourceInputOfRetailMediaSellerAccountCreation**](ValueResourceInputOfRetailMediaSellerAccountCreation.md)| Initial creation and configuration options for the new account | [optional] ### Return type @@ -317,12 +432,12 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_brands** -> ValueResourceCollectionOutcomeOfInt64 update_brands(account_id) +# **remove_brands** +> ValueResourceOfRetailMediaBrands remove_brands(account_id) -replace the brands for an account +Remove a brand from an account ### Example @@ -333,7 +448,8 @@ replace the brands for an account import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import accounts_api -from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_int64 import ValueResourceCollectionOutcomeOfInt64 +from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands +from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -363,24 +479,31 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = accounts_api.AccountsApi(api_client) account_id = "accountId_example" # str | the account id to update - request_body = [ - 1, - ] # [int] | brands to associate to account (optional) + value_resource_input_of_retail_media_brands = ValueResourceInputOfRetailMediaBrands( + data=ValueResourceOfRetailMediaBrands( + type="type_example", + attributes=RetailMediaBrands( + brand_ids=[ + 1, + ], + ), + ), + ) # ValueResourceInputOfRetailMediaBrands | (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.update_brands(account_id) + api_response = api_instance.remove_brands(account_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling AccountsApi->update_brands: %s\n" % e) + print("Exception when calling AccountsApi->remove_brands: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.update_brands(account_id, request_body=request_body) + api_response = api_instance.remove_brands(account_id, value_resource_input_of_retail_media_brands=value_resource_input_of_retail_media_brands) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling AccountsApi->update_brands: %s\n" % e) + print("Exception when calling AccountsApi->remove_brands: %s\n" % e) ``` @@ -389,11 +512,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| the account id to update | - **request_body** | **[int]**| brands to associate to account | [optional] + **value_resource_input_of_retail_media_brands** | [**ValueResourceInputOfRetailMediaBrands**](ValueResourceInputOfRetailMediaBrands.md)| | [optional] ### Return type -[**ValueResourceCollectionOutcomeOfInt64**](ValueResourceCollectionOutcomeOfInt64.md) +[**ValueResourceOfRetailMediaBrands**](ValueResourceOfRetailMediaBrands.md) ### Authorization @@ -429,7 +552,7 @@ replace the sellers assoiated with an account import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import accounts_api -from criteo_api_retailmedia_preview.model.retail_media_seller import RetailMediaSeller +from criteo_api_retailmedia_preview.model.value_resource_collection_input_of_retail_media_seller import ValueResourceCollectionInputOfRetailMediaSeller from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_retail_media_seller import ValueResourceCollectionOutcomeOfRetailMediaSeller from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com @@ -460,12 +583,17 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = accounts_api.AccountsApi(api_client) account_id = "accountId_example" # str | the account id to update - retail_media_seller = [ - RetailMediaSeller( - seller_id="seller_id_example", - retailer_id=1, - ), - ] # [RetailMediaSeller] | sellers to associate (optional) + value_resource_collection_input_of_retail_media_seller = ValueResourceCollectionInputOfRetailMediaSeller( + data=[ + ValueResourceOfRetailMediaSeller( + type="type_example", + attributes=RetailMediaSeller( + seller_id="seller_id_example", + retailer_id=1, + ), + ), + ], + ) # ValueResourceCollectionInputOfRetailMediaSeller | sellers to associate (optional) # example passing only required values which don't have defaults set try: @@ -477,7 +605,7 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.update_sellers(account_id, retail_media_seller=retail_media_seller) + api_response = api_instance.update_sellers(account_id, value_resource_collection_input_of_retail_media_seller=value_resource_collection_input_of_retail_media_seller) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: print("Exception when calling AccountsApi->update_sellers: %s\n" % e) @@ -489,7 +617,7 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| the account id to update | - **retail_media_seller** | [**[RetailMediaSeller]**](RetailMediaSeller.md)| sellers to associate | [optional] + **value_resource_collection_input_of_retail_media_seller** | [**ValueResourceCollectionInputOfRetailMediaSeller**](ValueResourceCollectionInputOfRetailMediaSeller.md)| sellers to associate | [optional] ### Return type diff --git a/sdks/retailmedia_preview/docs/AnalyticsApi.md b/sdks/retailmedia_preview/docs/AnalyticsApi.md index d4e47f7c..dce83c97 100644 --- a/sdks/retailmedia_preview/docs/AnalyticsApi.md +++ b/sdks/retailmedia_preview/docs/AnalyticsApi.md @@ -4,6 +4,7 @@ All URIs are relative to *https://api.criteo.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**generate_async_accounts_report**](AnalyticsApi.md#generate_async_accounts_report) | **POST** /preview/retail-media/reports/accounts | [**generate_async_campaigns_report**](AnalyticsApi.md#generate_async_campaigns_report) | **POST** /preview/retail-media/reports/campaigns | [**generate_async_line_items_report**](AnalyticsApi.md#generate_async_line_items_report) | **POST** /preview/retail-media/reports/line-items | [**generate_sync_attributed_transactions_report**](AnalyticsApi.md#generate_sync_attributed_transactions_report) | **POST** /preview/retail-media/reports/sync/attributed-transactions | @@ -13,6 +14,119 @@ Method | HTTP request | Description [**get_async_export_status**](AnalyticsApi.md#get_async_export_status) | **GET** /preview/retail-media/reports/{reportId}/status | +# **generate_async_accounts_report** +> AsyncReportResponse generate_async_accounts_report(async_accounts_report_request) + + + +Returns an asynchronous Accounts Report + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_preview +from criteo_api_retailmedia_preview.api import analytics_api +from criteo_api_retailmedia_preview.model.report_outcome import ReportOutcome +from criteo_api_retailmedia_preview.model.async_report_response import AsyncReportResponse +from criteo_api_retailmedia_preview.model.async_accounts_report_request import AsyncAccountsReportRequest +from pprint import pprint +# Defining the host is optional and defaults to https://api.criteo.com +# See configuration.py for a list of all supported configuration parameters. +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Enter a context with an instance of the API client +with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + async_accounts_report_request = AsyncAccountsReportRequest( + data=AsyncAccountsReportResource( + type="type_example", + attributes=AsyncAccountsReport( + account_ids=[ + "account_ids_example", + ], + report_type="summary", + aggregation_level="campaign", + campaign_type="sponsoredProducts", + sales_channel="offline", + format="json-compact", + click_attribution_window="none", + view_attribution_window="none", + dimensions=[ + "date", + ], + metrics=[ + "impressions", + ], + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="UTC", + ), + ), + ) # AsyncAccountsReportRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_async_accounts_report(async_accounts_report_request) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling AnalyticsApi->generate_async_accounts_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **async_accounts_report_request** | [**AsyncAccountsReportRequest**](AsyncAccountsReportRequest.md)| | + +### Return type + +[**AsyncReportResponse**](AsyncReportResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | +**403** | Forbidden | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **generate_async_campaigns_report** > AsyncReportResponse generate_async_campaigns_report(async_campaigns_report_request) @@ -64,22 +178,22 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: data=AsyncCampaignsReportResource( type="type_example", attributes=AsyncCampaignsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -177,22 +291,22 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: data=AsyncLineItemsReportResource( type="type_example", attributes=AsyncLineItemsReport( - metrics=[ - "impressions", - ], - dimensions=[ - "date", + ids=[ + "ids_example", ], + id="id_example", campaign_type="sponsoredProducts", sales_channel="offline", format="json-compact", report_type="summary", click_attribution_window="none", view_attribution_window="none", - ids=[ - "ids_example", + dimensions=[ + "date", + ], + metrics=[ + "impressions", ], - id="id_example", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -296,17 +410,17 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: line_item_ids=[ "line_item_ids_example", ], + account_id="account_id_example", + click_attribution_window="none", + view_attribution_window="none", + campaign_type="sponsoredProducts", + sales_channel="offline", dimensions=[ "campaignName", ], metrics=[ "attributedUnits", ], - account_id="account_id_example", - click_attribution_window="none", - view_attribution_window="none", - campaign_type="sponsoredProducts", - sales_channel="offline", start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -408,17 +522,17 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: campaign_ids=[ "campaign_ids_example", ], - metrics=[ - "impressions", - ], - dimensions=[ - "date", - ], account_id="account_id_example", click_attribution_window="none", view_attribution_window="none", campaign_type="sponsoredProducts", sales_channel="offline", + dimensions=[ + "date", + ], + metrics=[ + "impressions", + ], start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", @@ -523,17 +637,17 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: campaign_ids=[ "campaign_ids_example", ], - metrics=[ - "impressions", - ], - dimensions=[ - "date", - ], account_id="account_id_example", click_attribution_window="none", view_attribution_window="none", campaign_type="sponsoredProducts", sales_channel="offline", + dimensions=[ + "date", + ], + metrics=[ + "impressions", + ], start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), timezone="UTC", diff --git a/sdks/retailmedia_preview/docs/AsyncAccountsReport.md b/sdks/retailmedia_preview/docs/AsyncAccountsReport.md new file mode 100644 index 00000000..309cb4fc --- /dev/null +++ b/sdks/retailmedia_preview/docs/AsyncAccountsReport.md @@ -0,0 +1,25 @@ +# AsyncAccountsReport + +Async Accounts report body request + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_ids** | **[str]** | Account Ids to report on | +**start_date** | **datetime** | Start date | +**end_date** | **datetime** | End date | +**report_type** | **str, none_type** | 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" +**aggregation_level** | **str, none_type** | Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel | [optional] if omitted the server will use the default value of "campaign" +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] +**format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" +**click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" +**view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] +**timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/AsyncAccountsReportRequest.md b/sdks/retailmedia_preview/docs/AsyncAccountsReportRequest.md new file mode 100644 index 00000000..33ab480d --- /dev/null +++ b/sdks/retailmedia_preview/docs/AsyncAccountsReportRequest.md @@ -0,0 +1,13 @@ +# AsyncAccountsReportRequest + +A top-level object that encapsulates a Criteo API request for a single value + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AsyncAccountsReportResource**](AsyncAccountsReportResource.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/AsyncAccountsReportResource.md b/sdks/retailmedia_preview/docs/AsyncAccountsReportResource.md new file mode 100644 index 00000000..976c23c0 --- /dev/null +++ b/sdks/retailmedia_preview/docs/AsyncAccountsReportResource.md @@ -0,0 +1,14 @@ +# AsyncAccountsReportResource + +A top-level object that encapsulates a Criteo API response for a single value + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str, none_type** | | [optional] +**attributes** | [**AsyncAccountsReport**](AsyncAccountsReport.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/AsyncCampaignsReport.md b/sdks/retailmedia_preview/docs/AsyncCampaignsReport.md index 04625e77..21dd57bd 100644 --- a/sdks/retailmedia_preview/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_preview/docs/AsyncCampaignsReport.md @@ -1,22 +1,22 @@ # AsyncCampaignsReport -Campaign report body request +Async Campaigns report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Campaign ids to report on | [optional] +**id** | **str, none_type** | Campaign id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_preview/docs/AsyncLineItemsReport.md b/sdks/retailmedia_preview/docs/AsyncLineItemsReport.md index 223e1c26..ccb01090 100644 --- a/sdks/retailmedia_preview/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_preview/docs/AsyncLineItemsReport.md @@ -1,22 +1,22 @@ # AsyncLineItemsReport -Line Items report body request +Async Line Items report body request ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**ids** | **[str], none_type** | Line Item ids to report on | [optional] +**id** | **str, none_type** | Line Item id to report on | [optional] **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] **format** | **str, none_type** | Format of the output | [optional] if omitted the server will use the default value of "json-compact" **report_type** | **str, none_type** | 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" **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" -**ids** | **[str], none_type** | Ids to report on | [optional] -**id** | **str, none_type** | Id to report on | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_preview/docs/HyperlinkVariableValue.md b/sdks/retailmedia_preview/docs/BatchAcceptedResponse.md similarity index 76% rename from sdks/retailmedia_preview/docs/HyperlinkVariableValue.md rename to sdks/retailmedia_preview/docs/BatchAcceptedResponse.md index a2f66734..5a5b5444 100644 --- a/sdks/retailmedia_preview/docs/HyperlinkVariableValue.md +++ b/sdks/retailmedia_preview/docs/BatchAcceptedResponse.md @@ -1,11 +1,11 @@ -# HyperlinkVariableValue +# BatchAcceptedResponse -A value of a template hyperlink variable +A batch was accepted. The report can be accessed using the reporting endpoint. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**url** | **str** | The url to redirect to | +**operation_token** | **str** | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/CampaignApi.md b/sdks/retailmedia_preview/docs/CampaignApi.md index dc4b923b..b855b119 100644 --- a/sdks/retailmedia_preview/docs/CampaignApi.md +++ b/sdks/retailmedia_preview/docs/CampaignApi.md @@ -8,14 +8,9 @@ Method | HTTP request | Description [**delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id**](CampaignApi.md#delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id) | **DELETE** /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id} | [**fetch_keywords**](CampaignApi.md#fetch_keywords) | **GET** /preview/retail-media/line-items/{id}/keywords | [**fetch_proposal**](CampaignApi.md#fetch_proposal) | **GET** /preview/retail-media/preferred-deal-line-items/{id}/proposal | -[**get_api202207_external_retailer_by_retailer_id_templatestemplate_id**](CampaignApi.md#get_api202207_external_retailer_by_retailer_id_templatestemplate_id) | **GET** /preview/retail-media/retailers/{retailer-id}/templates/{template-id} | -[**get_api202207_external_retailer_templates_by_retailer_id**](CampaignApi.md#get_api202207_external_retailer_templates_by_retailer_id) | **GET** /preview/retail-media/retailers/{retailer-id}/templates | -[**get_api202210_external_account_by_account_id_creativescreative_id**](CampaignApi.md#get_api202210_external_account_by_account_id_creativescreative_id) | **GET** /preview/retail-media/accounts/{account-id}/creatives/{creative-id} | [**get_api202210_external_line_item_product_buttons_by_line_item_id**](CampaignApi.md#get_api202210_external_line_item_product_buttons_by_line_item_id) | **GET** /preview/retail-media/line-items/{line-item-id}/product-buttons | [**get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id**](CampaignApi.md#get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id) | **GET** /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id} | [**get_api202301_external_line_item_bid_multipliers_by_line_item_id**](CampaignApi.md#get_api202301_external_line_item_bid_multipliers_by_line_item_id) | **GET** /preview/retail-media/line-items/{line-item-id}/bid-multipliers | -[**get_api_v0_external_catalog_output_by_catalog_id**](CampaignApi.md#get_api_v0_external_catalog_output_by_catalog_id) | **GET** /preview/retail-media/catalogs/{catalogId}/output | -[**get_api_v0_external_catalog_status_by_catalog_id**](CampaignApi.md#get_api_v0_external_catalog_status_by_catalog_id) | **GET** /preview/retail-media/catalogs/{catalogId}/status | [**get_api_v1_external_account_brands_by_account_id**](CampaignApi.md#get_api_v1_external_account_brands_by_account_id) | **GET** /preview/retail-media/accounts/{accountId}/brands | [**get_api_v1_external_account_retailers_by_account_id**](CampaignApi.md#get_api_v1_external_account_retailers_by_account_id) | **GET** /preview/retail-media/accounts/{accountId}/retailers | [**get_api_v1_external_accounts**](CampaignApi.md#get_api_v1_external_accounts) | **GET** /preview/retail-media/accounts | @@ -23,19 +18,20 @@ Method | HTTP request | Description [**get_api_v1_external_retailer_by_retailer_id_seller_by_seller**](CampaignApi.md#get_api_v1_external_retailer_by_retailer_id_seller_by_seller) | **GET** /preview/retail-media/retailers/{retailerId}/sellers/{seller} | [**get_api_v1_external_retailer_category_cpc_rates_by_retailer_id**](CampaignApi.md#get_api_v1_external_retailer_category_cpc_rates_by_retailer_id) | **GET** /preview/retail-media/retailers/{retailer-id}/cpc-rates | [**get_api_v1_external_retailer_placements_by_retailer_id**](CampaignApi.md#get_api_v1_external_retailer_placements_by_retailer_id) | **GET** /preview/retail-media/retailers/{retailer-id}/placements | +[**get_api_v2_external_campaign_preferred_line_items_by_campaign_id**](CampaignApi.md#get_api_v2_external_campaign_preferred_line_items_by_campaign_id) | **GET** /preview/retail-media/campaigns/{campaign-id}/preferred-line-items | +[**get_api_v2_external_preferred_line_item_by_line_item_id**](CampaignApi.md#get_api_v2_external_preferred_line_item_by_line_item_id) | **GET** /preview/retail-media/preferred-line-items/{line-item-id} | [**get_campaign_budget_overrides**](CampaignApi.md#get_campaign_budget_overrides) | **GET** /preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides | +[**get_insertion_order_history_change_data_capture**](CampaignApi.md#get_insertion_order_history_change_data_capture) | **GET** /preview/retail-media/insertion-order-history/{insertionOrderId}/change-data-capture | [**get_line_item_budget_overrides**](CampaignApi.md#get_line_item_budget_overrides) | **GET** /preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides | [**get_recommended_keywords**](CampaignApi.md#get_recommended_keywords) | **GET** /preview/retail-media/line-items/{externalLineItemId}/keywords/recommended | [**get_sku_by_product_id**](CampaignApi.md#get_sku_by_product_id) | **POST** /preview/retail-media/catalogs/sku/search/accounts/{accountId}/retailers/{retailerId}/by-id | -[**post_api202210_external_account_creatives_by_account_id**](CampaignApi.md#post_api202210_external_account_creatives_by_account_id) | **POST** /preview/retail-media/accounts/{account-id}/creatives | -[**post_api202210_external_account_creatives_search_by_account_id**](CampaignApi.md#post_api202210_external_account_creatives_search_by_account_id) | **POST** /preview/retail-media/accounts/{account-id}/creatives/search | +[**post_api202110_external_campaign_preferred_line_items_by_campaign_id**](CampaignApi.md#post_api202110_external_campaign_preferred_line_items_by_campaign_id) | **POST** /preview/retail-media/campaigns/{campaign-id}/preferred-line-items | [**post_api202210_external_line_item_product_buttons_create_by_line_item_id**](CampaignApi.md#post_api202210_external_line_item_product_buttons_create_by_line_item_id) | **POST** /preview/retail-media/line-items/{line-item-id}/product-buttons/create | -[**post_api_v0_external_account_catalogs_by_account_id**](CampaignApi.md#post_api_v0_external_account_catalogs_by_account_id) | **POST** /preview/retail-media/accounts/{accountId}/catalogs | [**post_api_v1_external_catalogs_sku_retrieval**](CampaignApi.md#post_api_v1_external_catalogs_sku_retrieval) | **POST** /preview/retail-media/catalogs/sku-retrieval | [**post_api_v1_external_catalogs_sku_search**](CampaignApi.md#post_api_v1_external_catalogs_sku_search) | **POST** /preview/retail-media/catalogs/sku-search | [**post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id**](CampaignApi.md#post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id) | **POST** /preview/retail-media/catalogs/sku-search/accounts/{account-id}/retailers/{retailer-id} | [**post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id**](CampaignApi.md#post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id) | **POST** /preview/retail-media/catalogs/sku/search/retailers/{retailer-id} | -[**put_api202210_external_account_by_account_id_creativescreative_id**](CampaignApi.md#put_api202210_external_account_by_account_id_creativescreative_id) | **PUT** /preview/retail-media/accounts/{account-id}/creatives/{creative-id} | +[**put_api202110_external_preferred_line_item_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_by_line_item_id) | **PUT** /preview/retail-media/preferred-line-items/{line-item-id} | [**put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id**](CampaignApi.md#put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id) | **PUT** /preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id} | [**put_api202301_external_line_item_bid_multipliers_by_line_item_id**](CampaignApi.md#put_api202301_external_line_item_bid_multipliers_by_line_item_id) | **PUT** /preview/retail-media/line-items/{line-item-id}/bid-multipliers | [**set_keyword_bids**](CampaignApi.md#set_keyword_bids) | **POST** /preview/retail-media/line-items/{id}/keywords/set-bid | @@ -410,12 +406,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api202207_external_retailer_by_retailer_id_templatestemplate_id** -> TemplateResponse get_api202207_external_retailer_by_retailer_id_templatestemplate_id(retailer_id, template_id) +# **get_api202210_external_line_item_product_buttons_by_line_item_id** +> ProductButtonListResponse get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id) -Gets the template for the specified retailer id and template id +Get all the product buttons associated with a line item ### Example @@ -426,7 +422,7 @@ Gets the template for the specified retailer id and template id import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.template_response import TemplateResponse +from criteo_api_retailmedia_preview.model.product_button_list_response import ProductButtonListResponse from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -455,15 +451,14 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - retailer_id = 1 # int | Retailer Id - template_id = 1 # int | Template Id + line_item_id = "line-item-id_example" # str | Long external id of the associated line item # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api202207_external_retailer_by_retailer_id_templatestemplate_id(retailer_id, template_id) + api_response = api_instance.get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api202207_external_retailer_by_retailer_id_templatestemplate_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api202210_external_line_item_product_buttons_by_line_item_id: %s\n" % e) ``` @@ -471,12 +466,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **retailer_id** | **int**| Retailer Id | - **template_id** | **int**| Template Id | + **line_item_id** | **str**| Long external id of the associated line item | ### Return type -[**TemplateResponse**](TemplateResponse.md) +[**ProductButtonListResponse**](ProductButtonListResponse.md) ### Authorization @@ -492,16 +486,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Template found for the retailer | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api202207_external_retailer_templates_by_retailer_id** -> TemplateListResponse get_api202207_external_retailer_templates_by_retailer_id(retailer_id) +# **get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id** +> ProductButtonListResponse get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id) -Get retailer creative templates +Get a single product button ### Example @@ -512,7 +506,7 @@ Get retailer creative templates import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.template_list_response import TemplateListResponse +from criteo_api_retailmedia_preview.model.product_button_list_response import ProductButtonListResponse from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -541,14 +535,15 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - retailer_id = 1 # int | External retailer id to retrieve creative templates for + line_item_id = "line-item-id_example" # str | Long external id of the associated line item + product_button_id = "product-button-id_example" # str | Sequential id of the product button # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api202207_external_retailer_templates_by_retailer_id(retailer_id) + api_response = api_instance.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api202207_external_retailer_templates_by_retailer_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id: %s\n" % e) ``` @@ -556,11 +551,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **retailer_id** | **int**| External retailer id to retrieve creative templates for | + **line_item_id** | **str**| Long external id of the associated line item | + **product_button_id** | **str**| Sequential id of the product button | ### Return type -[**TemplateListResponse**](TemplateListResponse.md) +[**ProductButtonListResponse**](ProductButtonListResponse.md) ### Authorization @@ -576,16 +572,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Templates found | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api202210_external_account_by_account_id_creativescreative_id** -> Creative202210Response get_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id) +# **get_api202301_external_line_item_bid_multipliers_by_line_item_id** +> JsonApiSingleResponseOfLineItemBidMultipliers get_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) -Get the specified creative +Get bid multipliers by line item ### Example @@ -596,7 +592,7 @@ Get the specified creative import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.creative202210_response import Creative202210Response +from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -625,15 +621,14 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - account_id = "account-id_example" # str | External account id to retrieve creatives for - creative_id = "creative-id_example" # str | Creative to get + line_item_id = "line-item-id_example" # str | Long external id of the associated line item # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id) + api_response = api_instance.get_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api202210_external_account_by_account_id_creativescreative_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) ``` @@ -641,12 +636,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| External account id to retrieve creatives for | - **creative_id** | **str**| Creative to get | + **line_item_id** | **str**| Long external id of the associated line item | ### Return type -[**Creative202210Response**](Creative202210Response.md) +[**JsonApiSingleResponseOfLineItemBidMultipliers**](JsonApiSingleResponseOfLineItemBidMultipliers.md) ### Authorization @@ -655,23 +649,23 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Creatives found | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api202210_external_line_item_product_buttons_by_line_item_id** -> ProductButtonListResponse get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id) +# **get_api_v1_external_account_brands_by_account_id** +> JsonApiPageResponseOfBrand get_api_v1_external_account_brands_by_account_id(account_id) -Get all the product buttons associated with a line item +Gets page of retailer objects that are associated with the given account ### Example @@ -682,7 +676,7 @@ Get all the product buttons associated with a line item import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.product_button_list_response import ProductButtonListResponse +from criteo_api_retailmedia_preview.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -711,14 +705,27 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - line_item_id = "line-item-id_example" # str | Long external id of the associated line item + account_id = "accountId_example" # str | The given account id + limit_to_id = [ + "limitToId_example", + ] # [str] | The ids that you would like to limit your result set to (optional) + page_index = 1 # int | The 0 indexed page index you would like to receive given the page size (optional) + page_size = 1 # int | The maximum number of items you would like to receive in this request (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id) + api_response = api_instance.get_api_v1_external_account_brands_by_account_id(account_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api202210_external_line_item_product_buttons_by_line_item_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v1_external_account_brands_by_account_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_api_v1_external_account_brands_by_account_id(account_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_account_brands_by_account_id: %s\n" % e) ``` @@ -726,11 +733,14 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| Long external id of the associated line item | + **account_id** | **str**| The given account id | + **limit_to_id** | **[str]**| The ids that you would like to limit your result set to | [optional] + **page_index** | **int**| The 0 indexed page index you would like to receive given the page size | [optional] + **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] ### Return type -[**ProductButtonListResponse**](ProductButtonListResponse.md) +[**JsonApiPageResponseOfBrand**](JsonApiPageResponseOfBrand.md) ### Authorization @@ -750,12 +760,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id** -> ProductButtonListResponse get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id) +# **get_api_v1_external_account_retailers_by_account_id** +> JsonApiPageResponseOfRetailer get_api_v1_external_account_retailers_by_account_id(account_id) -Get a single product button +Gets page of retailer objects that are associated with the given account ### Example @@ -766,7 +776,7 @@ Get a single product button import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.product_button_list_response import ProductButtonListResponse +from criteo_api_retailmedia_preview.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -795,15 +805,27 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - line_item_id = "line-item-id_example" # str | Long external id of the associated line item - product_button_id = "product-button-id_example" # str | Sequential id of the product button + account_id = "accountId_example" # str | The given account id + limit_to_id = [ + "limitToId_example", + ] # [str] | The ids that you would like to limit your result set to (optional) + page_index = 1 # int | The 0 indexed page index you would like to receive given the page size (optional) + page_size = 1 # int | The maximum number of items you would like to receive in this request (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id) + api_response = api_instance.get_api_v1_external_account_retailers_by_account_id(account_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v1_external_account_retailers_by_account_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_api_v1_external_account_retailers_by_account_id(account_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_account_retailers_by_account_id: %s\n" % e) ``` @@ -811,12 +833,14 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| Long external id of the associated line item | - **product_button_id** | **str**| Sequential id of the product button | + **account_id** | **str**| The given account id | + **limit_to_id** | **[str]**| The ids that you would like to limit your result set to | [optional] + **page_index** | **int**| The 0 indexed page index you would like to receive given the page size | [optional] + **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] ### Return type -[**ProductButtonListResponse**](ProductButtonListResponse.md) +[**JsonApiPageResponseOfRetailer**](JsonApiPageResponseOfRetailer.md) ### Authorization @@ -836,12 +860,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api202301_external_line_item_bid_multipliers_by_line_item_id** -> JsonApiSingleResponseOfLineItemBidMultipliers get_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) +# **get_api_v1_external_accounts** +> JsonApiPageResponseOfAccount get_api_v1_external_accounts() -Get bid multipliers by line item +Gets page of account objects that the current user can access ### Example @@ -852,7 +876,7 @@ Get bid multipliers by line item import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers +from criteo_api_retailmedia_preview.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -881,14 +905,19 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - line_item_id = "line-item-id_example" # str | Long external id of the associated line item + limit_to_id = [ + "limitToId_example", + ] # [str] | The ids that you would like to limit your result set to (optional) + page_index = 1 # int | The 0 indexed page index you would like to receive given the page size (optional) + page_size = 1 # int | The maximum number of items you would like to receive in this request (optional) # example passing only required values which don't have defaults set + # and optional values try: - api_response = api_instance.get_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) + api_response = api_instance.get_api_v1_external_accounts(limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v1_external_accounts: %s\n" % e) ``` @@ -896,11 +925,13 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| Long external id of the associated line item | + **limit_to_id** | **[str]**| The ids that you would like to limit your result set to | [optional] + **page_index** | **int**| The 0 indexed page index you would like to receive given the page size | [optional] + **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] ### Return type -[**JsonApiSingleResponseOfLineItemBidMultipliers**](JsonApiSingleResponseOfLineItemBidMultipliers.md) +[**JsonApiPageResponseOfAccount**](JsonApiPageResponseOfAccount.md) ### Authorization @@ -909,7 +940,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -920,12 +951,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api_v0_external_catalog_output_by_catalog_id** -> get_api_v0_external_catalog_output_by_catalog_id(catalog_id) +# **get_api_v1_external_retailer_brands_by_retailer_id** +> BrandPreviewListResponse get_api_v1_external_retailer_brands_by_retailer_id(retailer_id) -Output the indicated catalog. Catalogs are only available for retrieval when their associated status request is at a Success status. Produces application/x-json-stream of CatalogProduct json objects. +Gets the brands for the given retailer ### Example @@ -936,6 +967,7 @@ Output the indicated catalog. Catalogs are only available for retrieval when the import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api +from criteo_api_retailmedia_preview.model.brand_preview_list_response import BrandPreviewListResponse from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -964,98 +996,24 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - catalog_id = "catalogId_example" # str | A catalog ID returned from an account catalog request. + retailer_id = 1 # int | The retailer id for which brands should be fetched. + sku_stock_type_filter = "first-party" # str | Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party (optional) + brand_type = "all" # str | Filter to narrow down brands [all|uc|retailer]. Defaults to uc (optional) # example passing only required values which don't have defaults set try: - api_instance.get_api_v0_external_catalog_output_by_catalog_id(catalog_id) + api_response = api_instance.get_api_v1_external_retailer_brands_by_retailer_id(retailer_id) + pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v0_external_catalog_output_by_catalog_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **catalog_id** | **str**| A catalog ID returned from an account catalog request. | - -### Return type - -void (empty response body) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/x-json-stream, application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Catalog download initiated. | - | -**400** | The indicated catalog is not available for retrieval, wait for a success status. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_api_v0_external_catalog_status_by_catalog_id** -> JsonApiSingleResponseOfCatalogStatus get_api_v0_external_catalog_status_by_catalog_id(catalog_id) - - - -Check the status of a catalog request. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_preview -from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus -from pprint import pprint -# Defining the host is optional and defaults to https://api.criteo.com -# See configuration.py for a list of all supported configuration parameters. -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Enter a context with an instance of the API client -with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - catalog_id = "catalogId_example" # str | A catalog ID returned from an account catalog request. + print("Exception when calling CampaignApi->get_api_v1_external_retailer_brands_by_retailer_id: %s\n" % e) # example passing only required values which don't have defaults set + # and optional values try: - api_response = api_instance.get_api_v0_external_catalog_status_by_catalog_id(catalog_id) + api_response = api_instance.get_api_v1_external_retailer_brands_by_retailer_id(retailer_id, sku_stock_type_filter=sku_stock_type_filter, brand_type=brand_type) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v0_external_catalog_status_by_catalog_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v1_external_retailer_brands_by_retailer_id: %s\n" % e) ``` @@ -1063,11 +1021,13 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **catalog_id** | **str**| A catalog ID returned from an account catalog request. | + **retailer_id** | **int**| The retailer id for which brands should be fetched. | + **sku_stock_type_filter** | **str**| Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party | [optional] + **brand_type** | **str**| Filter to narrow down brands [all|uc|retailer]. Defaults to uc | [optional] ### Return type -[**JsonApiSingleResponseOfCatalogStatus**](JsonApiSingleResponseOfCatalogStatus.md) +[**BrandPreviewListResponse**](BrandPreviewListResponse.md) ### Authorization @@ -1083,16 +1043,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Catalog request found. | - | +**200** | Brands found. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api_v1_external_account_brands_by_account_id** -> JsonApiPageResponseOfBrand get_api_v1_external_account_brands_by_account_id(account_id) +# **get_api_v1_external_retailer_by_retailer_id_seller_by_seller** +> SellerPreviewResponse get_api_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller) -Gets page of retailer objects that are associated with the given account +Endpoint to get market place seller id and name ### Example @@ -1103,7 +1063,7 @@ Gets page of retailer objects that are associated with the given account import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand +from criteo_api_retailmedia_preview.model.seller_preview_response import SellerPreviewResponse from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -1132,27 +1092,15 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - account_id = "accountId_example" # str | The given account id - limit_to_id = [ - "limitToId_example", - ] # [str] | The ids that you would like to limit your result set to (optional) - page_index = 1 # int | The 0 indexed page index you would like to receive given the page size (optional) - page_size = 1 # int | The maximum number of items you would like to receive in this request (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api_v1_external_account_brands_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_account_brands_by_account_id: %s\n" % e) + retailer_id = 1 # int | The retailer id for which seller should be fetched. + seller = "seller_example" # str | The seller id or seller name which should be validated. # example passing only required values which don't have defaults set - # and optional values try: - api_response = api_instance.get_api_v1_external_account_brands_by_account_id(account_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) + api_response = api_instance.get_api_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_account_brands_by_account_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v1_external_retailer_by_retailer_id_seller_by_seller: %s\n" % e) ``` @@ -1160,14 +1108,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The given account id | - **limit_to_id** | **[str]**| The ids that you would like to limit your result set to | [optional] - **page_index** | **int**| The 0 indexed page index you would like to receive given the page size | [optional] - **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] + **retailer_id** | **int**| The retailer id for which seller should be fetched. | + **seller** | **str**| The seller id or seller name which should be validated. | ### Return type -[**JsonApiPageResponseOfBrand**](JsonApiPageResponseOfBrand.md) +[**SellerPreviewResponse**](SellerPreviewResponse.md) ### Authorization @@ -1183,16 +1129,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Seller found. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api_v1_external_account_retailers_by_account_id** -> JsonApiPageResponseOfRetailer get_api_v1_external_account_retailers_by_account_id(account_id) +# **get_api_v1_external_retailer_category_cpc_rates_by_retailer_id** +> CpcRateCardPreviewResponse get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id) -Gets page of retailer objects that are associated with the given account +Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer ### Example @@ -1203,7 +1149,7 @@ Gets page of retailer objects that are associated with the given account import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer +from criteo_api_retailmedia_preview.model.cpc_rate_card_preview_response import CpcRateCardPreviewResponse from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -1232,27 +1178,25 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - account_id = "accountId_example" # str | The given account id - limit_to_id = [ - "limitToId_example", - ] # [str] | The ids that you would like to limit your result set to (optional) - page_index = 1 # int | The 0 indexed page index you would like to receive given the page size (optional) - page_size = 1 # int | The maximum number of items you would like to receive in this request (optional) + retailer_id = "retailer-id_example" # str | The retailer id + fields = [ + "fields_example", + ] # [str] | The fields in the response that is to be included (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api_v1_external_account_retailers_by_account_id(account_id) + api_response = api_instance.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_account_retailers_by_account_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v1_external_retailer_category_cpc_rates_by_retailer_id: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.get_api_v1_external_account_retailers_by_account_id(account_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) + api_response = api_instance.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id, fields=fields) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_account_retailers_by_account_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v1_external_retailer_category_cpc_rates_by_retailer_id: %s\n" % e) ``` @@ -1260,14 +1204,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The given account id | - **limit_to_id** | **[str]**| The ids that you would like to limit your result set to | [optional] - **page_index** | **int**| The 0 indexed page index you would like to receive given the page size | [optional] - **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] + **retailer_id** | **str**| The retailer id | + **fields** | **[str]**| The fields in the response that is to be included | [optional] ### Return type -[**JsonApiPageResponseOfRetailer**](JsonApiPageResponseOfRetailer.md) +[**CpcRateCardPreviewResponse**](CpcRateCardPreviewResponse.md) ### Authorization @@ -1283,16 +1225,17 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | bids found | - | +**403** | forbidden | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api_v1_external_accounts** -> JsonApiPageResponseOfAccount get_api_v1_external_accounts() +# **get_api_v1_external_retailer_placements_by_retailer_id** +> PlacementPreviewListResponse get_api_v1_external_retailer_placements_by_retailer_id(retailer_id) -Gets page of account objects that the current user can access +Gets all placement information for the given retailer ### Example @@ -1303,7 +1246,7 @@ Gets page of account objects that the current user can access import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount +from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -1332,19 +1275,14 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - limit_to_id = [ - "limitToId_example", - ] # [str] | The ids that you would like to limit your result set to (optional) - page_index = 1 # int | The 0 indexed page index you would like to receive given the page size (optional) - page_size = 1 # int | The maximum number of items you would like to receive in this request (optional) + retailer_id = "retailer-id_example" # str | The retailer id for which placements should be fetched. # example passing only required values which don't have defaults set - # and optional values try: - api_response = api_instance.get_api_v1_external_accounts(limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) + api_response = api_instance.get_api_v1_external_retailer_placements_by_retailer_id(retailer_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_accounts: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v1_external_retailer_placements_by_retailer_id: %s\n" % e) ``` @@ -1352,13 +1290,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **limit_to_id** | **[str]**| The ids that you would like to limit your result set to | [optional] - **page_index** | **int**| The 0 indexed page index you would like to receive given the page size | [optional] - **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] + **retailer_id** | **str**| The retailer id for which placements should be fetched. | ### Return type -[**JsonApiPageResponseOfAccount**](JsonApiPageResponseOfAccount.md) +[**PlacementPreviewListResponse**](PlacementPreviewListResponse.md) ### Authorization @@ -1374,16 +1310,17 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | placements records. | - | +**403** | Forbidden | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api_v1_external_retailer_brands_by_retailer_id** -> BrandPreviewListResponse get_api_v1_external_retailer_brands_by_retailer_id(retailer_id) +# **get_api_v2_external_campaign_preferred_line_items_by_campaign_id** +> PreferredLineItemV2PagedListResponse get_api_v2_external_campaign_preferred_line_items_by_campaign_id(campaign_id) -Gets the brands for the given retailer +Gets page of preferred line item objects for the given campaign id ### Example @@ -1394,7 +1331,7 @@ Gets the brands for the given retailer import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.brand_preview_list_response import BrandPreviewListResponse +from criteo_api_retailmedia_preview.model.preferred_line_item_v2_paged_list_response import PreferredLineItemV2PagedListResponse from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -1423,111 +1360,27 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - retailer_id = 1 # int | The retailer id for which brands should be fetched. - sku_stock_type_filter = "first-party" # str | Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party (optional) - brand_type = "all" # str | Filter to narrow down brands [all|uc|retailer]. Defaults to uc (optional) + campaign_id = "campaign-id_example" # str | The given campaign id + limit_to_id = [ + "limitToId_example", + ] # [str] | The ids that you would like to limit your result set to (optional) + page_index = 1 # int | The 0 indexed page index you would like to receive given the page size (optional) + page_size = 1 # int | The maximum number of items you would like to receive in this request (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api_v1_external_retailer_brands_by_retailer_id(retailer_id) + api_response = api_instance.get_api_v2_external_campaign_preferred_line_items_by_campaign_id(campaign_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_retailer_brands_by_retailer_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v2_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.get_api_v1_external_retailer_brands_by_retailer_id(retailer_id, sku_stock_type_filter=sku_stock_type_filter, brand_type=brand_type) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_retailer_brands_by_retailer_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **retailer_id** | **int**| The retailer id for which brands should be fetched. | - **sku_stock_type_filter** | **str**| Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party | [optional] - **brand_type** | **str**| Filter to narrow down brands [all|uc|retailer]. Defaults to uc | [optional] - -### Return type - -[**BrandPreviewListResponse**](BrandPreviewListResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Brands found. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_api_v1_external_retailer_by_retailer_id_seller_by_seller** -> SellerPreviewResponse get_api_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller) - - - -Endpoint to get market place seller id and name - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_preview -from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.seller_preview_response import SellerPreviewResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.criteo.com -# See configuration.py for a list of all supported configuration parameters. -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Enter a context with an instance of the API client -with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - retailer_id = 1 # int | The retailer id for which seller should be fetched. - seller = "seller_example" # str | The seller id or seller name which should be validated. - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller) + api_response = api_instance.get_api_v2_external_campaign_preferred_line_items_by_campaign_id(campaign_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_retailer_by_retailer_id_seller_by_seller: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v2_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) ``` @@ -1535,12 +1388,14 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **retailer_id** | **int**| The retailer id for which seller should be fetched. | - **seller** | **str**| The seller id or seller name which should be validated. | + **campaign_id** | **str**| The given campaign id | + **limit_to_id** | **[str]**| The ids that you would like to limit your result set to | [optional] + **page_index** | **int**| The 0 indexed page index you would like to receive given the page size | [optional] + **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] ### Return type -[**SellerPreviewResponse**](SellerPreviewResponse.md) +[**PreferredLineItemV2PagedListResponse**](PreferredLineItemV2PagedListResponse.md) ### Authorization @@ -1556,16 +1411,17 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Seller found. | - | +**200** | Success | - | +**400** | Bad Request | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api_v1_external_retailer_category_cpc_rates_by_retailer_id** -> CpcRateCardPreviewResponse get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id) +# **get_api_v2_external_preferred_line_item_by_line_item_id** +> PreferredLineItemV2Response get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id) -Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer +Gets the preferred line item for the given line item id ### Example @@ -1576,7 +1432,7 @@ Gets the minimum cpc bid for the retailer, and optionally the categories under t import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.cpc_rate_card_preview_response import CpcRateCardPreviewResponse +from criteo_api_retailmedia_preview.model.preferred_line_item_v2_response import PreferredLineItemV2Response from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -1605,25 +1461,14 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - retailer_id = "retailer-id_example" # str | The retailer id - fields = [ - "fields_example", - ] # [str] | The fields in the response that is to be included (optional) + line_item_id = "line-item-id_example" # str | The given line item id # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_retailer_category_cpc_rates_by_retailer_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id, fields=fields) + api_response = api_instance.get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_retailer_category_cpc_rates_by_retailer_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v2_external_preferred_line_item_by_line_item_id: %s\n" % e) ``` @@ -1631,12 +1476,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **retailer_id** | **str**| The retailer id | - **fields** | **[str]**| The fields in the response that is to be included | [optional] + **line_item_id** | **str**| The given line item id | ### Return type -[**CpcRateCardPreviewResponse**](CpcRateCardPreviewResponse.md) +[**PreferredLineItemV2Response**](PreferredLineItemV2Response.md) ### Authorization @@ -1652,17 +1496,17 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | bids found | - | -**403** | forbidden | - | +**200** | Success | - | +**400** | Bad Request | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_api_v1_external_retailer_placements_by_retailer_id** -> PlacementPreviewListResponse get_api_v1_external_retailer_placements_by_retailer_id(retailer_id) +# **get_campaign_budget_overrides** +> ValueResourceOutcomeOfCampaignBudgetOverrides get_campaign_budget_overrides(campaign_id) -Gets all placement information for the given retailer +Get current campaign budget overrides by given external campaign id. ### Example @@ -1673,7 +1517,7 @@ Gets all placement information for the given retailer import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse +from criteo_api_retailmedia_preview.model.value_resource_outcome_of_campaign_budget_overrides import ValueResourceOutcomeOfCampaignBudgetOverrides from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -1702,14 +1546,14 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - retailer_id = "retailer-id_example" # str | The retailer id for which placements should be fetched. + campaign_id = 1 # int | External campaign id. # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api_v1_external_retailer_placements_by_retailer_id(retailer_id) + api_response = api_instance.get_campaign_budget_overrides(campaign_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_retailer_placements_by_retailer_id: %s\n" % e) + print("Exception when calling CampaignApi->get_campaign_budget_overrides: %s\n" % e) ``` @@ -1717,11 +1561,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **retailer_id** | **str**| The retailer id for which placements should be fetched. | + **campaign_id** | **int**| External campaign id. | ### Return type -[**PlacementPreviewListResponse**](PlacementPreviewListResponse.md) +[**ValueResourceOutcomeOfCampaignBudgetOverrides**](ValueResourceOutcomeOfCampaignBudgetOverrides.md) ### Authorization @@ -1737,17 +1581,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | placements records. | - | -**403** | Forbidden | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_campaign_budget_overrides** -> ValueResourceOutcomeOfCampaignBudgetOverrides get_campaign_budget_overrides(campaign_id) +# **get_insertion_order_history_change_data_capture** +> PageOfInsertionOrderHistoryChangeDataCapture get_insertion_order_history_change_data_capture(insertion_order_id) -Get current campaign budget overrides by given external campaign id. +Gets the balance's historical data change capture. ### Example @@ -1758,7 +1601,7 @@ Get current campaign budget overrides by given external campaign id. import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.value_resource_outcome_of_campaign_budget_overrides import ValueResourceOutcomeOfCampaignBudgetOverrides +from criteo_api_retailmedia_preview.model.page_of_insertion_order_history_change_data_capture import PageOfInsertionOrderHistoryChangeDataCapture from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -1787,14 +1630,25 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - campaign_id = 1 # int | External campaign id. + insertion_order_id = "insertionOrderId_example" # str | External insertion order id. + offset = 0 # int | The (zero-based) starting offset in the collection. (optional) if omitted the server will use the default value of 0 + limit = 25 # int | The number of elements to be returned. (optional) if omitted the server will use the default value of 25 + limit_to_change_types = "limitToChangeTypes_example" # str | Comma separated change types string that will be queried. (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.get_campaign_budget_overrides(campaign_id) + api_response = api_instance.get_insertion_order_history_change_data_capture(insertion_order_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->get_campaign_budget_overrides: %s\n" % e) + print("Exception when calling CampaignApi->get_insertion_order_history_change_data_capture: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_insertion_order_history_change_data_capture(insertion_order_id, offset=offset, limit=limit, limit_to_change_types=limit_to_change_types) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->get_insertion_order_history_change_data_capture: %s\n" % e) ``` @@ -1802,11 +1656,14 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **campaign_id** | **int**| External campaign id. | + **insertion_order_id** | **str**| External insertion order id. | + **offset** | **int**| The (zero-based) starting offset in the collection. | [optional] if omitted the server will use the default value of 0 + **limit** | **int**| The number of elements to be returned. | [optional] if omitted the server will use the default value of 25 + **limit_to_change_types** | **str**| Comma separated change types string that will be queried. | [optional] ### Return type -[**ValueResourceOutcomeOfCampaignBudgetOverrides**](ValueResourceOutcomeOfCampaignBudgetOverrides.md) +[**PageOfInsertionOrderHistoryChangeDataCapture**](PageOfInsertionOrderHistoryChangeDataCapture.md) ### Authorization @@ -2102,12 +1959,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **post_api202210_external_account_creatives_by_account_id** -> Creative202210Response post_api202210_external_account_creatives_by_account_id(account_id) +# **post_api202110_external_campaign_preferred_line_items_by_campaign_id** +> PreferredLineItemV2Response post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, preferred_line_item_create_model_v2_request) -Create a creative for an account +Creates a new preferred line item with the specified settings ### Example @@ -2118,8 +1975,8 @@ Create a creative for an account import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.creative202210_response import Creative202210Response -from criteo_api_retailmedia_preview.model.creative_create_model202207 import CreativeCreateModel202207 +from criteo_api_retailmedia_preview.model.preferred_line_item_create_model_v2_request import PreferredLineItemCreateModelV2Request +from criteo_api_retailmedia_preview.model.preferred_line_item_v2_response import PreferredLineItemV2Response from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -2148,52 +2005,45 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - account_id = "account-id_example" # str | External account id to create a creative for - creative_create_model202207 = CreativeCreateModel202207( - name="name_example", - brand_id=1, - retailer_id=1, - template_id=1, - template_variable_values=[ - TemplateVariableValue( - id="id_example", - text_variable_value=TextVariableValue( - text="text_example", + campaign_id = "campaign-id_example" # str | The given campaign id + preferred_line_item_create_model_v2_request = PreferredLineItemCreateModelV2Request( + data=InputResourceOfPreferredLineItemCreateModelV2( + type="type_example", + attributes=ExternalPreferredLineItemCreateModelV2( + name="name_example", + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + status="unknown", + pacing="unknown", + capping=ExternalLineItemCappingV2( + type="unknown", + count=1, ), - choice_variable_value=ChoiceVariableValue( - chosen_options=[ - "chosen_options_example", + page=ExternalLineItemPageV2( + page_type="unknown", + categories=[ + ExternalLineItemPageCategoryV2( + category_id="category_id_example", + include_children=True, + ), ], - ), - color_variable_value=ColorVariableValue( - color="#2EC", - ), - files_variable_value=FilesVariableValue( - asset_ids=[ - "asset_ids_example", + search_keywords=[ + "search_keywords_example", ], ), - hyperlink_variable_value=HyperlinkVariableValue( - url="url_example", - ), + target_retailer_id="target_retailer_id_example", + budget=3.14, + creative_id="creative_id_example", ), - ], - ) # CreativeCreateModel202207 | The creative to create (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202210_external_account_creatives_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->post_api202210_external_account_creatives_by_account_id: %s\n" % e) + ), + ) # PreferredLineItemCreateModelV2Request | The line item settings to create a line item with # example passing only required values which don't have defaults set - # and optional values try: - api_response = api_instance.post_api202210_external_account_creatives_by_account_id(account_id, creative_create_model202207=creative_create_model202207) + api_response = api_instance.post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, preferred_line_item_create_model_v2_request) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->post_api202210_external_account_creatives_by_account_id: %s\n" % e) + print("Exception when calling CampaignApi->post_api202110_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) ``` @@ -2201,12 +2051,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| External account id to create a creative for | - **creative_create_model202207** | [**CreativeCreateModel202207**](CreativeCreateModel202207.md)| The creative to create | [optional] + **campaign_id** | **str**| The given campaign id | + **preferred_line_item_create_model_v2_request** | [**PreferredLineItemCreateModelV2Request**](PreferredLineItemCreateModelV2Request.md)| The line item settings to create a line item with | ### Return type -[**Creative202210Response**](Creative202210Response.md) +[**PreferredLineItemV2Response**](PreferredLineItemV2Response.md) ### Authorization @@ -2222,103 +2072,8 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Creatives created | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **post_api202210_external_account_creatives_search_by_account_id** -> Creative202210ListResponse post_api202210_external_account_creatives_search_by_account_id(account_id) - - - -Get account creatives - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_preview -from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.creative202210_list_response import Creative202210ListResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.criteo.com -# See configuration.py for a list of all supported configuration parameters. -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Enter a context with an instance of the API client -with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - account_id = "account-id_example" # str | External account id to retrieve creatives for - creative_ids = [ - "creative-ids_example", - ] # [str] | Creatives to filter by (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202210_external_account_creatives_search_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->post_api202210_external_account_creatives_search_by_account_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202210_external_account_creatives_search_by_account_id(account_id, creative_ids=creative_ids) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->post_api202210_external_account_creatives_search_by_account_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| External account id to retrieve creatives for | - **creative_ids** | **[str]**| Creatives to filter by | [optional] - -### Return type - -[**Creative202210ListResponse**](Creative202210ListResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Creatives found | - | +**201** | Success | - | +**400** | Bad Request | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -2432,108 +2187,6 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **post_api_v0_external_account_catalogs_by_account_id** -> JsonApiSingleResponseOfCatalogStatus post_api_v0_external_account_catalogs_by_account_id(account_id) - - - -Create a request for a Catalog available to the indicated account. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_preview -from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.json_api_request_of_catalog_request_preview import JsonApiRequestOfCatalogRequestPreview -from criteo_api_retailmedia_preview.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus -from pprint import pprint -# Defining the host is optional and defaults to https://api.criteo.com -# See configuration.py for a list of all supported configuration parameters. -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_preview.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Enter a context with an instance of the API client -with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - account_id = "accountId_example" # str | The account to request the catalog for. - json_api_request_of_catalog_request_preview = JsonApiRequestOfCatalogRequestPreview( - data=JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview( - type="type_example", - attributes=ExternalCatalogRequestPreview( - format="json-newline", - ), - ), - ) # JsonApiRequestOfCatalogRequestPreview | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api_v0_external_account_catalogs_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->post_api_v0_external_account_catalogs_by_account_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api_v0_external_account_catalogs_by_account_id(account_id, json_api_request_of_catalog_request_preview=json_api_request_of_catalog_request_preview) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->post_api_v0_external_account_catalogs_by_account_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The account to request the catalog for. | - **json_api_request_of_catalog_request_preview** | [**JsonApiRequestOfCatalogRequestPreview**](JsonApiRequestOfCatalogRequestPreview.md)| | [optional] - -### Return type - -[**JsonApiSingleResponseOfCatalogStatus**](JsonApiSingleResponseOfCatalogStatus.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Catalog request successfully created | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **post_api_v1_external_catalogs_sku_retrieval** > SkuDataPreviewListResponse post_api_v1_external_catalogs_sku_retrieval() @@ -2959,12 +2612,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **put_api202210_external_account_by_account_id_creativescreative_id** -> Creative202210Response put_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id) +# **put_api202110_external_preferred_line_item_by_line_item_id** +> PreferredLineItemV2Response put_api202110_external_preferred_line_item_by_line_item_id(line_item_id, preferred_line_item_update_model_v2_request) -Update a creative +Updates the preferred line item for the given line item id ### Example @@ -2975,8 +2628,8 @@ Update a creative import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.creative202210_response import Creative202210Response -from criteo_api_retailmedia_preview.model.creative_update_model202207 import CreativeUpdateModel202207 +from criteo_api_retailmedia_preview.model.preferred_line_item_v2_response import PreferredLineItemV2Response +from criteo_api_retailmedia_preview.model.preferred_line_item_update_model_v2_request import PreferredLineItemUpdateModelV2Request from pprint import pprint # Defining the host is optional and defaults to https://api.criteo.com # See configuration.py for a list of all supported configuration parameters. @@ -3005,53 +2658,45 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - account_id = "account-id_example" # str | External account id containing the creative - creative_id = "creative-id_example" # str | Creative to update - creative_update_model202207 = CreativeUpdateModel202207( - name="name_example", - brand_id=1, - retailer_id=1, - template_id=1, - template_variable_values=[ - TemplateVariableValue( - id="id_example", - text_variable_value=TextVariableValue( - text="text_example", + line_item_id = "line-item-id_example" # str | The given line item id + preferred_line_item_update_model_v2_request = PreferredLineItemUpdateModelV2Request( + data=ResourceOfPreferredLineItemUpdateModelV2( + id="id_example", + type="type_example", + attributes=ExternalPreferredLineItemUpdateModelV2( + name="name_example", + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + status="unknown", + pacing="accelerated", + capping=ExternalLineItemCappingV2( + type="unknown", + count=1, ), - choice_variable_value=ChoiceVariableValue( - chosen_options=[ - "chosen_options_example", + page=ExternalLineItemPageV2( + page_type="unknown", + categories=[ + ExternalLineItemPageCategoryV2( + category_id="category_id_example", + include_children=True, + ), ], - ), - color_variable_value=ColorVariableValue( - color="#2EC", - ), - files_variable_value=FilesVariableValue( - asset_ids=[ - "asset_ids_example", + search_keywords=[ + "search_keywords_example", ], ), - hyperlink_variable_value=HyperlinkVariableValue( - url="url_example", - ), + budget=3.14, + creative_id="creative_id_example", ), - ], - ) # CreativeUpdateModel202207 | The creative to create (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.put_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id) - pprint(api_response) - except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->put_api202210_external_account_by_account_id_creativescreative_id: %s\n" % e) + ), + ) # PreferredLineItemUpdateModelV2Request | The line item settings to create a line item with # example passing only required values which don't have defaults set - # and optional values try: - api_response = api_instance.put_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id, creative_update_model202207=creative_update_model202207) + api_response = api_instance.put_api202110_external_preferred_line_item_by_line_item_id(line_item_id, preferred_line_item_update_model_v2_request) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->put_api202210_external_account_by_account_id_creativescreative_id: %s\n" % e) + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_by_line_item_id: %s\n" % e) ``` @@ -3059,13 +2704,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| External account id containing the creative | - **creative_id** | **str**| Creative to update | - **creative_update_model202207** | [**CreativeUpdateModel202207**](CreativeUpdateModel202207.md)| The creative to create | [optional] + **line_item_id** | **str**| The given line item id | + **preferred_line_item_update_model_v2_request** | [**PreferredLineItemUpdateModelV2Request**](PreferredLineItemUpdateModelV2Request.md)| The line item settings to create a line item with | ### Return type -[**Creative202210Response**](Creative202210Response.md) +[**PreferredLineItemV2Response**](PreferredLineItemV2Response.md) ### Authorization @@ -3082,7 +2726,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | -**204** | Creative updated | - | +**400** | Bad Request | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/CatalogApi.md b/sdks/retailmedia_preview/docs/CatalogApi.md new file mode 100644 index 00000000..0ab12c12 --- /dev/null +++ b/sdks/retailmedia_preview/docs/CatalogApi.md @@ -0,0 +1,371 @@ +# criteo_api_retailmedia_preview.CatalogApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**preview_retail_media_catalog_products_batch_post**](CatalogApi.md#preview_retail_media_catalog_products_batch_post) | **POST** /preview/retail-media/catalog/products/batch | +[**preview_retail_media_catalog_products_batch_report_operation_token_get**](CatalogApi.md#preview_retail_media_catalog_products_batch_report_operation_token_get) | **GET** /preview/retail-media/catalog/products/batch/report/{operation-token} | + + +# **preview_retail_media_catalog_products_batch_post** +> BatchAcceptedResponse preview_retail_media_catalog_products_batch_post(products_custom_batch_request) + + + +Used to publish a batch of operations to insert, update and deletes products. The batch is processed asynchronously.The response provides an operationToken which can be used to track the status of the report of the operation. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_preview +from criteo_api_retailmedia_preview.api import catalog_api +from criteo_api_retailmedia_preview.model.fail_response import FailResponse +from criteo_api_retailmedia_preview.model.batch_accepted_response import BatchAcceptedResponse +from criteo_api_retailmedia_preview.model.products_custom_batch_request import ProductsCustomBatchRequest +from pprint import pprint +# Defining the host is optional and defaults to https://api.criteo.com +# See configuration.py for a list of all supported configuration parameters. +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Enter a context with an instance of the API client +with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = catalog_api.CatalogApi(api_client) + products_custom_batch_request = ProductsCustomBatchRequest( + entries=[ + ProductsCustomBatchRequestEntry( + batch_id=1, + merchant_id=1, + method="delete", + product_id="product_id_example", + item_group_id="item_group_id_example", + product=Product( + id="id_example", + offer_id="offer_id_example", + title="title_example", + description="description_example", + link="link_example", + image_link="image_link_example", + additional_image_links=[ + "additional_image_links_example", + ], + content_language="content_language_example", + target_country="target_country_example", + channel="online", + expiration_date="expiration_date_example", + adult=True, + kind="kind_example", + brand="brand_example", + color="color_example", + google_product_category="google_product_category_example", + gtin="gtin_example", + item_group_id="item_group_id_example", + material="material_example", + mpn="mpn_example", + pattern="pattern_example", + price=Price( + currency="currency_example", + value="value_example", + ), + sale_price=Price( + currency="currency_example", + value="value_example", + ), + sale_price_effective_date="sale_price_effective_date_example", + shipping=[ + ProductShipping( + price=Price( + currency="currency_example", + value="value_example", + ), + country="country_example", + region="region_example", + service="service_example", + location_id=1, + location_group_name="location_group_name_example", + postal_code="postal_code_example", + ), + ], + shipping_weight=ProductShippingWeight( + value=3.14, + unit="unit_example", + ), + sizes=[ + "sizes_example", + ], + taxes=[ + ProductTax( + rate=3.14, + country="country_example", + region="region_example", + tax_ship=True, + location_id=1, + postal_code="postal_code_example", + ), + ], + custom_attributes=[ + CustomAttribute( + name="name_example", + value="value_example", + ), + ], + identifier_exists=True, + installment=Installment( + months=1, + amount=Price( + currency="currency_example", + value="value_example", + ), + ), + loyalty_points=LoyaltyPoints( + name="name_example", + points_value=1, + ratio=3.14, + ), + multipack=1, + custom_label0="custom_label0_example", + custom_label1="custom_label1_example", + custom_label2="custom_label2_example", + custom_label3="custom_label3_example", + custom_label4="custom_label4_example", + is_bundle=True, + mobile_link="mobile_link_example", + availability_date="availability_date_example", + shipping_label="shipping_label_example", + unit_pricing_measure=ProductUnitPricingMeasure( + value=3.14, + unit="unit_example", + ), + unit_pricing_base_measure=ProductUnitPricingBaseMeasure( + value=1, + unit="unit_example", + ), + shipping_length=ProductShippingDimension( + value=3.14, + unit="unit_example", + ), + shipping_width=ProductShippingDimension( + value=3.14, + unit="unit_example", + ), + shipping_height=ProductShippingDimension( + value=3.14, + unit="unit_example", + ), + display_ads_id="display_ads_id_example", + display_ads_similar_ids=[ + "display_ads_similar_ids_example", + ], + display_ads_title="display_ads_title_example", + display_ads_link="display_ads_link_example", + display_ads_value=3.14, + sell_on_google_quantity=1, + promotion_ids=[ + "promotion_ids_example", + ], + max_handling_time=1, + min_handling_time=1, + cost_of_goods_sold=Price( + currency="currency_example", + value="value_example", + ), + source="source_example", + included_destinations=[ + "included_destinations_example", + ], + excluded_destinations=[ + "excluded_destinations_example", + ], + ads_grouping="ads_grouping_example", + ads_labels=[ + "ads_labels_example", + ], + ads_redirect="ads_redirect_example", + product_types=[ + "product_types_example", + ], + product_type_keys=[ + "product_type_keys_example", + ], + age_group="age_group_example", + availability="availability_example", + condition="condition_example", + gender="gender_example", + size_system="size_system_example", + size_type="size_type_example", + energy_efficiency_class="energy_efficiency_class_example", + min_energy_efficiency_class="min_energy_efficiency_class_example", + max_energy_efficiency_class="max_energy_efficiency_class_example", + tax_category="tax_category_example", + transit_time_label="transit_time_label_example", + seller_id="seller_id_example", + external_seller_id="external_seller_id_example", + external_seller_name="external_seller_name_example", + number_of_reviews=1, + product_rating="product_rating_example", + ), + feed_id="feed_id_example", + ), + ], + ) # ProductsCustomBatchRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_retail_media_catalog_products_batch_post(products_custom_batch_request) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CatalogApi->preview_retail_media_catalog_products_batch_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **products_custom_batch_request** | [**ProductsCustomBatchRequest**](ProductsCustomBatchRequest.md)| | + +### Return type + +[**BatchAcceptedResponse**](BatchAcceptedResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Batch accepted. The status of the operation can be tracked using the report endpoint and the operationToken. | - | +**400** | Bad Request. Allowed error types and errors: [(type=\"validation\", code=\"required-field\"),(type=\"validation\", code=\"required-field\"),(type=\"validation\", code=\"json-format\")] | - | +**401** | Unauthorized. Allowed error types and errors: [(type=\"authentication\", code=\"not-authenticated\")] | - | +**403** | Forbidden. Allowed error types and errors: [(type=\"authorization\", code=\"not-authorized\")] | - | +**413** | Request too large. By default, payload up to 16 MB is rejected. | - | +**429** | Too Many Requests. Allowed error types and errors: [(type=\"availability\", code=\"too-many-requests\")] | - | +**500** | Internal Server Error. Allowed error types and errors: [(type=\"availability\", code=\"internal-error\")] | - | +**503** | Service Unavailable. Allowed error types and errors: [(type=\"availability\", code=\"service-unavailable\")] | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **preview_retail_media_catalog_products_batch_report_operation_token_get** +> ReportOkResponse preview_retail_media_catalog_products_batch_report_operation_token_get(operation_token) + + + +Get the report of an asynchronous batch operation previously requested + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_preview +from criteo_api_retailmedia_preview.api import catalog_api +from criteo_api_retailmedia_preview.model.fail_response import FailResponse +from criteo_api_retailmedia_preview.model.report_ok_response import ReportOkResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.criteo.com +# See configuration.py for a list of all supported configuration parameters. +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_preview.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Enter a context with an instance of the API client +with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = catalog_api.CatalogApi(api_client) + operation_token = "operation-token_example" # str | The token returned by the batch endpoint. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.preview_retail_media_catalog_products_batch_report_operation_token_get(operation_token) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CatalogApi->preview_retail_media_catalog_products_batch_report_operation_token_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **operation_token** | **str**| The token returned by the batch endpoint. | + +### Return type + +[**ReportOkResponse**](ReportOkResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The report object | - | +**400** | Bad Request. Allowed error types and errors: [(type=\"validation\", code=\"catalog-operation-token-is-malformed\"),(type=\"validation\", code=\"catalog-operation-report-is-expired\")] | - | +**401** | Unauthorized. Allowed error types and errors: [(type=\"authentication\", code=\"not-authenticated\")] | - | +**403** | Forbidden. Allowed error types and errors: [(type=\"authorization\", code=\"not-authorized\")] | - | +**404** | Not Found. Allowed error types and errors: [(type=\"validation\", code=\"catalog-operation-not-found\")] | - | +**429** | Too Many Requests | - | +**500** | Internal Server Error. Allowed error types and errors: [(type=\"availability\", code=\"internal-error\")] | - | +**503** | Service Unavailable. Allowed error types and errors: [(type=\"availability\", code=\"service-unavailable\")] | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/sdks/retailmedia_preview/docs/ChangeDetails.md b/sdks/retailmedia_preview/docs/ChangeDetails.md new file mode 100644 index 00000000..04e5fe97 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ChangeDetails.md @@ -0,0 +1,14 @@ +# ChangeDetails + +Change details of a property of the insertion order. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previous_value** | **str, none_type** | Previous value of a property of the insertion order. | +**current_value** | **str, none_type** | Current value of a property of the insertion order. | +**change_value** | **str, none_type** | Change detail of a property of the insertion order. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ChoiceVariableSpecification.md b/sdks/retailmedia_preview/docs/ChoiceVariableSpecification.md deleted file mode 100644 index f0e876f8..00000000 --- a/sdks/retailmedia_preview/docs/ChoiceVariableSpecification.md +++ /dev/null @@ -1,15 +0,0 @@ -# ChoiceVariableSpecification - -Specification of choice variable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**options** | [**[ChoiceOption]**](ChoiceOption.md) | The available options | -**max_selected** | **int, none_type** | The maximum number of selectable options | [optional] -**min_selected** | **int, none_type** | The minimum number of selectable options | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/Creative202210.md b/sdks/retailmedia_preview/docs/Creative202210.md deleted file mode 100644 index 8557f68a..00000000 --- a/sdks/retailmedia_preview/docs/Creative202210.md +++ /dev/null @@ -1,24 +0,0 @@ -# Creative202210 - -A creative entity - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name | -**status** | **str** | Creative Status | -**retailer_id** | **int** | Retailer Id | -**template_id** | **int** | Template Id | -**template_name** | **str** | Template Name | -**format_id** | **int** | Format Id | -**creative_format_type** | **str** | Creative format type | -**environments** | [**[PageTypeEnvironment]**](PageTypeEnvironment.md) | Environment type (e.g. mobile, web, app) | -**template_variable_values** | [**[TemplateVariableValue]**](TemplateVariableValue.md) | The template chosen values | -**brand_id** | **int, none_type** | Brand Id | [optional] -**associated_line_item_ids** | **[str]** | Associated Line Item Ids | [optional] -**updated_at** | **datetime** | Updated at time | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/CreativeCreateModel202207.md b/sdks/retailmedia_preview/docs/CreativeCreateModel202207.md deleted file mode 100644 index 09881dc5..00000000 --- a/sdks/retailmedia_preview/docs/CreativeCreateModel202207.md +++ /dev/null @@ -1,17 +0,0 @@ -# CreativeCreateModel202207 - -Create model of a creative - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the creative | -**retailer_id** | **int** | The retailer associated to the creative | -**template_id** | **int** | The creative template used for this creative | -**template_variable_values** | [**[TemplateVariableValue]**](TemplateVariableValue.md) | The template chosen values | -**brand_id** | **int** | The brand associated to the creative | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/CreativeUpdateModel202207.md b/sdks/retailmedia_preview/docs/CreativeUpdateModel202207.md deleted file mode 100644 index bcee4a2f..00000000 --- a/sdks/retailmedia_preview/docs/CreativeUpdateModel202207.md +++ /dev/null @@ -1,17 +0,0 @@ -# CreativeUpdateModel202207 - -Update model of a creative - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the creative | -**retailer_id** | **int** | The retailer associated to the creative | -**template_id** | **int** | The creative template used for this creative | -**template_variable_values** | [**[TemplateVariableValue]**](TemplateVariableValue.md) | The template chosen values | -**brand_id** | **int** | The brand associated to the creative | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/ChoiceOption.md b/sdks/retailmedia_preview/docs/CustomAttribute.md similarity index 67% rename from sdks/retailmedia_preview/docs/ChoiceOption.md rename to sdks/retailmedia_preview/docs/CustomAttribute.md index 82b0e020..06341e6f 100644 --- a/sdks/retailmedia_preview/docs/ChoiceOption.md +++ b/sdks/retailmedia_preview/docs/CustomAttribute.md @@ -1,12 +1,12 @@ -# ChoiceOption +# CustomAttribute -An option given in a choice +Defines a custom attribute of a product. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dependent_variables** | [**[TemplateVariable]**](TemplateVariable.md) | Template variables unblocked when the option is chosen | -**id** | **str** | The id of the option | +**name** | **str** | The name of the attribute. Underscores will be replaced by spaces upon insertion. | +**value** | **str** | The value of the attribute. | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/ExportReportColumn.md b/sdks/retailmedia_preview/docs/ExportReportColumn.md index 6c09f675..b8656942 100644 --- a/sdks/retailmedia_preview/docs/ExportReportColumn.md +++ b/sdks/retailmedia_preview/docs/ExportReportColumn.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Name of the exported column | **type** | **str** | Type of the column | -**role** | **str** | Role of the colummn | +**role** | **str** | Role of the column | **title** | **str, none_type** | Title of the exported column | [optional] **description** | **str, none_type** | Description of the exported column | [optional] **timezone** | **str, none_type** | Timezone of the column | [optional] diff --git a/sdks/retailmedia_preview/docs/ExternalCatalogStatus.md b/sdks/retailmedia_preview/docs/ExternalCatalogStatus.md deleted file mode 100644 index ba111d84..00000000 --- a/sdks/retailmedia_preview/docs/ExternalCatalogStatus.md +++ /dev/null @@ -1,19 +0,0 @@ -# ExternalCatalogStatus - -The status of an asynchronous request to generate a catalog - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **str** | An enumeration of the status of the catalog. | -**currency** | **str** | An ISO4217 representation of the currency products are listed under in this catalog. | -**row_count** | **int, none_type** | An indication of the number of products contained in this catalog. Available when this catalog reaches a success status. | -**file_size_bytes** | **int, none_type** | The size of this catalog in bytes. Available when this catalog reaches a success status. | -**md5_checksum** | **str, none_type** | An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval. Available when this catalog reaches a success status. | -**created_at** | **datetime** | The time this catalog was created. Represented as a UTC ISO8601 string. | -**message** | **str, none_type** | An optional information message intended for developer consumption. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/ChoiceVariableValue.md b/sdks/retailmedia_preview/docs/ExternalLineItemCappingV2.md similarity index 74% rename from sdks/retailmedia_preview/docs/ChoiceVariableValue.md rename to sdks/retailmedia_preview/docs/ExternalLineItemCappingV2.md index 182abe3e..82180daf 100644 --- a/sdks/retailmedia_preview/docs/ChoiceVariableValue.md +++ b/sdks/retailmedia_preview/docs/ExternalLineItemCappingV2.md @@ -1,11 +1,12 @@ -# ChoiceVariableValue +# ExternalLineItemCappingV2 -A value of a template choice variable (among different accepted options) +Frequency Capping for a Preferred Line Item ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**chosen_options** | **[str]** | The chosen options | +**type** | **str** | Line Item Capping Type Enum | +**count** | **int** | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/ExternalLineItemPageCategoryV2.md b/sdks/retailmedia_preview/docs/ExternalLineItemPageCategoryV2.md new file mode 100644 index 00000000..5ae71ce9 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalLineItemPageCategoryV2.md @@ -0,0 +1,14 @@ +# ExternalLineItemPageCategoryV2 + +Category information for a preferred line item page + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category_id** | **str** | | +**include_children** | **bool** | | [optional] if omitted the server will use the default value of True +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ExternalLineItemPageV2.md b/sdks/retailmedia_preview/docs/ExternalLineItemPageV2.md new file mode 100644 index 00000000..15d9895d --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalLineItemPageV2.md @@ -0,0 +1,15 @@ +# ExternalLineItemPageV2 + +Page information for a preferred line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page_type** | **str** | Page Type Enum | +**categories** | [**[ExternalLineItemPageCategoryV2]**](ExternalLineItemPageCategoryV2.md) | | [optional] +**search_keywords** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ExternalPreferredLineItemCreateModelV2.md b/sdks/retailmedia_preview/docs/ExternalPreferredLineItemCreateModelV2.md new file mode 100644 index 00000000..55360ca8 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalPreferredLineItemCreateModelV2.md @@ -0,0 +1,22 @@ +# ExternalPreferredLineItemCreateModelV2 + +Model used to create a preferred line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**start_date** | **date** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | +**end_date** | **date** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | +**pacing** | **str** | Line Item Pacing Enum | +**page** | [**ExternalLineItemPageV2**](ExternalLineItemPageV2.md) | | +**target_retailer_id** | **str** | | +**budget** | **float** | | +**status** | **str** | Line Item Status Enum | [optional] +**capping** | [**ExternalLineItemCappingV2**](ExternalLineItemCappingV2.md) | | [optional] +**creative_id** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ExternalPreferredLineItemUpdateModelV2.md b/sdks/retailmedia_preview/docs/ExternalPreferredLineItemUpdateModelV2.md new file mode 100644 index 00000000..3ad4dc54 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalPreferredLineItemUpdateModelV2.md @@ -0,0 +1,21 @@ +# ExternalPreferredLineItemUpdateModelV2 + +Model used to update a preferred line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**start_date** | **date** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | +**end_date** | **date** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | +**status** | **str** | Line Item Status Enum | +**pacing** | **str** | | [optional] if omitted the server will use the default value of "accelerated" +**capping** | [**ExternalLineItemCappingV2**](ExternalLineItemCappingV2.md) | | [optional] +**page** | [**ExternalLineItemPageV2**](ExternalLineItemPageV2.md) | | [optional] +**budget** | **float** | | [optional] +**creative_id** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ExternalPreferredLineItemV2.md b/sdks/retailmedia_preview/docs/ExternalPreferredLineItemV2.md new file mode 100644 index 00000000..b058c359 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalPreferredLineItemV2.md @@ -0,0 +1,27 @@ +# ExternalPreferredLineItemV2 + +A Retail Media Preferred Line Item used to hold bid settings for one or many promoted products on a single retailer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**start_date** | **date** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | +**end_date** | **date** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | +**status** | **str** | Line Item Status Enum | +**target_retailer_id** | **str** | | +**campaign_id** | **str** | | +**created_at** | **datetime** | | +**updated_at** | **datetime** | | +**pacing** | **str, none_type** | | [optional] +**capping** | [**ExternalLineItemCappingV2**](ExternalLineItemCappingV2.md) | | [optional] +**page** | [**ExternalLineItemPageV2**](ExternalLineItemPageV2.md) | | [optional] +**budget** | **float, none_type** | | [optional] +**budget_spent** | **float, none_type** | | [optional] +**budget_remaining** | **float, none_type** | | [optional] +**creative_id** | **str, none_type** | External creative Id | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/FailResponse.md b/sdks/retailmedia_preview/docs/FailResponse.md new file mode 100644 index 00000000..9a37fb5b --- /dev/null +++ b/sdks/retailmedia_preview/docs/FailResponse.md @@ -0,0 +1,14 @@ +# FailResponse + +Error server response. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[ProductImporterError]**](ProductImporterError.md) | List of errors | +**warnings** | [**[ProductImporterWarning]**](ProductImporterWarning.md) | List of warnings | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/FilesVariablesSpecification.md b/sdks/retailmedia_preview/docs/FilesVariablesSpecification.md deleted file mode 100644 index 9c879487..00000000 --- a/sdks/retailmedia_preview/docs/FilesVariablesSpecification.md +++ /dev/null @@ -1,16 +0,0 @@ -# FilesVariablesSpecification - -Specification of a file variable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**extensions** | **[str]** | The accepted file extensions | -**min_files** | **int, none_type** | The minimum amount of files requires | -**max_bytes** | **int, none_type** | The maximum amount of bytes per file | [optional] -**max_file** | **int, none_type** | The maximum amount of files required | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/InputResourceOfPreferredLineItemCreateModelV2.md b/sdks/retailmedia_preview/docs/InputResourceOfPreferredLineItemCreateModelV2.md new file mode 100644 index 00000000..08baddc1 --- /dev/null +++ b/sdks/retailmedia_preview/docs/InputResourceOfPreferredLineItemCreateModelV2.md @@ -0,0 +1,14 @@ +# InputResourceOfPreferredLineItemCreateModelV2 + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] +**attributes** | [**ExternalPreferredLineItemCreateModelV2**](ExternalPreferredLineItemCreateModelV2.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/InsertionOrderHistoryChangeDataCapture.md b/sdks/retailmedia_preview/docs/InsertionOrderHistoryChangeDataCapture.md new file mode 100644 index 00000000..24868cd3 --- /dev/null +++ b/sdks/retailmedia_preview/docs/InsertionOrderHistoryChangeDataCapture.md @@ -0,0 +1,16 @@ +# InsertionOrderHistoryChangeDataCapture + +Data model represents the data change capture of insertion order history. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**date_of_modification** | **datetime** | Date when data change has occured. | +**modified_by_user** | **str** | User name who modified the insertion order. | +**change_type** | **str** | Represent the type of change states of the history. | +**change_details** | [**ChangeDetails**](ChangeDetails.md) | | +**memo** | **str, none_type** | Memo associate with the insertion order modification. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/Installment.md b/sdks/retailmedia_preview/docs/Installment.md new file mode 100644 index 00000000..9c85abd1 --- /dev/null +++ b/sdks/retailmedia_preview/docs/Installment.md @@ -0,0 +1,14 @@ +# Installment + +Defines the installment of a product. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**months** | **int, none_type** | The number of installments the buyer has to pay. | [optional] +**amount** | [**Price**](Price.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md b/sdks/retailmedia_preview/docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md deleted file mode 100644 index 1e9fab40..00000000 --- a/sdks/retailmedia_preview/docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md +++ /dev/null @@ -1,15 +0,0 @@ -# JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus - -A JSON:API wrapper class to format a with external Id, Type, and Attributes properties - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | -**type** | **str** | | -**attributes** | [**ExternalCatalogStatus**](ExternalCatalogStatus.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview.md b/sdks/retailmedia_preview/docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview.md deleted file mode 100644 index 2e177421..00000000 --- a/sdks/retailmedia_preview/docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview.md +++ /dev/null @@ -1,14 +0,0 @@ -# JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview - -A JSON:API wrapper class to format a with Type, and Attributes properties - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**attributes** | [**ExternalCatalogRequestPreview**](ExternalCatalogRequestPreview.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/JsonApiRequestOfCatalogRequestPreview.md b/sdks/retailmedia_preview/docs/JsonApiRequestOfCatalogRequestPreview.md deleted file mode 100644 index 2e349373..00000000 --- a/sdks/retailmedia_preview/docs/JsonApiRequestOfCatalogRequestPreview.md +++ /dev/null @@ -1,13 +0,0 @@ -# JsonApiRequestOfCatalogRequestPreview - -A JSON:API wrapper class to format a with Type, and Attributes properties - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview**](JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequestPreview.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/JsonApiSingleResponseOfCatalogStatus.md b/sdks/retailmedia_preview/docs/JsonApiSingleResponseOfCatalogStatus.md deleted file mode 100644 index 063bf069..00000000 --- a/sdks/retailmedia_preview/docs/JsonApiSingleResponseOfCatalogStatus.md +++ /dev/null @@ -1,15 +0,0 @@ -# JsonApiSingleResponseOfCatalogStatus - -A JSON:API wrapper class to add one JSON:API within a data property - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus**](JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md) | | -**errors** | [**[CommonError]**](CommonError.md) | | [optional] -**warnings** | [**[CommonWarning]**](CommonWarning.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/LoyaltyPoints.md b/sdks/retailmedia_preview/docs/LoyaltyPoints.md new file mode 100644 index 00000000..2a58615e --- /dev/null +++ b/sdks/retailmedia_preview/docs/LoyaltyPoints.md @@ -0,0 +1,15 @@ +# LoyaltyPoints + +Defines how a client earns loyalty points after buying this product. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. | [optional] +**points_value** | **int, none_type** | The retailer's loyalty points in absolute value. | [optional] +**ratio** | **float, none_type** | The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/Metadata.md b/sdks/retailmedia_preview/docs/Metadata.md new file mode 100644 index 00000000..84035cd2 --- /dev/null +++ b/sdks/retailmedia_preview/docs/Metadata.md @@ -0,0 +1,14 @@ +# Metadata + +Metadata related to the current request. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**offset** | **int** | The (zero-based) starting offset in the collection. | +**limit** | **int** | The number of elements to be returned. | +**count** | **int, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/PageOfInsertionOrderHistoryChangeDataCapture.md b/sdks/retailmedia_preview/docs/PageOfInsertionOrderHistoryChangeDataCapture.md new file mode 100644 index 00000000..cec70092 --- /dev/null +++ b/sdks/retailmedia_preview/docs/PageOfInsertionOrderHistoryChangeDataCapture.md @@ -0,0 +1,13 @@ +# PageOfInsertionOrderHistoryChangeDataCapture + +A wrapper class to return a single page of items with metadata. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**Metadata**](Metadata.md) | | +**data** | [**[InsertionOrderHistoryChangeDataCapture]**](InsertionOrderHistoryChangeDataCapture.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/PageTypeEnvironment.md b/sdks/retailmedia_preview/docs/PageTypeEnvironment.md deleted file mode 100644 index 66571a9a..00000000 --- a/sdks/retailmedia_preview/docs/PageTypeEnvironment.md +++ /dev/null @@ -1,14 +0,0 @@ -# PageTypeEnvironment - -The PageType-Environment Tuples for creatives - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**page_type** | **str** | Creative PageType | [optional] -**environments** | **[str]** | List of environments per PageType | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/PreferredLineItemCreateModelV2Request.md b/sdks/retailmedia_preview/docs/PreferredLineItemCreateModelV2Request.md new file mode 100644 index 00000000..4a997a7d --- /dev/null +++ b/sdks/retailmedia_preview/docs/PreferredLineItemCreateModelV2Request.md @@ -0,0 +1,13 @@ +# PreferredLineItemCreateModelV2Request + +Data model for a create input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**InputResourceOfPreferredLineItemCreateModelV2**](InputResourceOfPreferredLineItemCreateModelV2.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/FilesVariableValue.md b/sdks/retailmedia_preview/docs/PreferredLineItemUpdateModelV2Request.md similarity index 69% rename from sdks/retailmedia_preview/docs/FilesVariableValue.md rename to sdks/retailmedia_preview/docs/PreferredLineItemUpdateModelV2Request.md index ed5ebecb..eb2482f5 100644 --- a/sdks/retailmedia_preview/docs/FilesVariableValue.md +++ b/sdks/retailmedia_preview/docs/PreferredLineItemUpdateModelV2Request.md @@ -1,11 +1,11 @@ -# FilesVariableValue +# PreferredLineItemUpdateModelV2Request -A value of a template file variable (one or several files), like images in a creative +Data model for an input resource ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**asset_ids** | **[str]** | The assets representing the images to be displayed | +**data** | [**ResourceOfPreferredLineItemUpdateModelV2**](ResourceOfPreferredLineItemUpdateModelV2.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/Creative202210Response.md b/sdks/retailmedia_preview/docs/PreferredLineItemV2PagedListResponse.md similarity index 53% rename from sdks/retailmedia_preview/docs/Creative202210Response.md rename to sdks/retailmedia_preview/docs/PreferredLineItemV2PagedListResponse.md index 1a9c0135..e7281fa3 100644 --- a/sdks/retailmedia_preview/docs/Creative202210Response.md +++ b/sdks/retailmedia_preview/docs/PreferredLineItemV2PagedListResponse.md @@ -1,13 +1,14 @@ -# Creative202210Response +# PreferredLineItemV2PagedListResponse -Data model for response resource +Data model for a paged list of response resources ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**ResourceOfCreative202210**](ResourceOfCreative202210.md) | | [optional] -**warnings** | [**[ProblemDetails]**](ProblemDetails.md) | | [optional] [readonly] -**errors** | [**[ProblemDetails]**](ProblemDetails.md) | | [optional] [readonly] +**metadata** | [**PageMetadata**](PageMetadata.md) | | [optional] +**data** | [**[ResourceOfPreferredLineItemV2]**](ResourceOfPreferredLineItemV2.md) | | [optional] +**warnings** | [**[CommonProblem]**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem]**](CommonProblem.md) | | [optional] [readonly] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/Creative202210ListResponse.md b/sdks/retailmedia_preview/docs/PreferredLineItemV2Response.md similarity index 56% rename from sdks/retailmedia_preview/docs/Creative202210ListResponse.md rename to sdks/retailmedia_preview/docs/PreferredLineItemV2Response.md index 31ab557e..5686af0d 100644 --- a/sdks/retailmedia_preview/docs/Creative202210ListResponse.md +++ b/sdks/retailmedia_preview/docs/PreferredLineItemV2Response.md @@ -1,13 +1,13 @@ -# Creative202210ListResponse +# PreferredLineItemV2Response -Data model for a list of response resources +A top-level object that encapsulates a Criteo API response for a single entity ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[ResourceOfCreative202210]**](ResourceOfCreative202210.md) | | [optional] -**warnings** | [**[ProblemDetails]**](ProblemDetails.md) | | [optional] [readonly] -**errors** | [**[ProblemDetails]**](ProblemDetails.md) | | [optional] [readonly] +**data** | [**ResourceOfPreferredLineItemV2**](ResourceOfPreferredLineItemV2.md) | | [optional] +**warnings** | [**[CommonProblem]**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem]**](CommonProblem.md) | | [optional] [readonly] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/ExternalCatalogRequestPreview.md b/sdks/retailmedia_preview/docs/Price.md similarity index 65% rename from sdks/retailmedia_preview/docs/ExternalCatalogRequestPreview.md rename to sdks/retailmedia_preview/docs/Price.md index d70eab65..b0c82aa7 100644 --- a/sdks/retailmedia_preview/docs/ExternalCatalogRequestPreview.md +++ b/sdks/retailmedia_preview/docs/Price.md @@ -1,11 +1,12 @@ -# ExternalCatalogRequestPreview +# Price -A request for a catalog under the specified format. Currently \"json-newline\" is supported. +Defines a price. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**format** | **str** | | [optional] if omitted the server will use the default value of "json-newline" +**currency** | **str, none_type** | The currency of the price. | [optional] +**value** | **str, none_type** | The price represented as a number. See JSON's number specification for more details. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/Product.md b/sdks/retailmedia_preview/docs/Product.md new file mode 100644 index 00000000..9f654009 --- /dev/null +++ b/sdks/retailmedia_preview/docs/Product.md @@ -0,0 +1,93 @@ +# Product + +Defines a product to be inserted or updated. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier for the item. Aka Product ID. Don’t use casing to make IDs unique. | +**title** | **str** | Title of the item. (500 UTF8 characters max). | +**link** | **str** | URL directly linking to your item's page on your website. (1000 UTF8 characters max). | +**image_link** | **str** | URL of an image of the item. Supported formats: PNG, JPEG, GIF. (2000 UTF8 characters max). | +**channel** | **str** | The item's channel (online only). | defaults to "online" +**offer_id** | **str, none_type** | Not used by Criteo. | [optional] +**description** | **str, none_type** | Description of the item. RECOMMENDED. (5000 UTF8 characters max). | [optional] +**additional_image_links** | **[str], none_type** | Additional URLs of images of the item. | [optional] +**content_language** | **str, none_type** | The two-letter ISO 639-1 language code for the item. | [optional] +**target_country** | **str, none_type** | The CLDR territory code for the item. | [optional] +**expiration_date** | **str, none_type** | Date on which the item should expire, as specified upon insertion, in ISO 8601 format. | [optional] +**adult** | **bool, none_type** | Set to true if the item is targeted towards adults. RECOMMENDED. | [optional] +**kind** | **str, none_type** | Identifies what kind of resource this is. | [optional] +**brand** | **str, none_type** | Brand of the item. RECOMMENDED. | [optional] +**color** | **str, none_type** | Color of the item. | [optional] +**google_product_category** | **str, none_type** | Google's category of the item (see Google product taxonomy). RECOMMENDED. | [optional] +**gtin** | **str, none_type** | Global Trade Item Number (GTIN) of the item. RECOMMENDED. | [optional] +**item_group_id** | **str, none_type** | Shared identifier for all variants of the same product. RECOMMENDED. Don’t use casing to make IDs unique. (50 characters max) | [optional] +**material** | **str, none_type** | The material of which the item is made. | [optional] +**mpn** | **str, none_type** | Manufacturer Part Number (MPN) of the item. RECOMMENDED. | [optional] +**pattern** | **str, none_type** | The item's pattern (e.g. polka dots). | [optional] +**price** | [**Price**](Price.md) | | [optional] +**sale_price** | [**Price**](Price.md) | | [optional] +**sale_price_effective_date** | **str, none_type** | Date range during which the item is on sale. | [optional] +**shipping** | [**[ProductShipping], none_type**](ProductShipping.md) | Shipping rules. | [optional] +**shipping_weight** | [**ProductShippingWeight**](ProductShippingWeight.md) | | [optional] +**sizes** | **[str], none_type** | Size of the item. RECOMMENDED. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value. | [optional] +**taxes** | [**[ProductTax], none_type**](ProductTax.md) | Tax information. | [optional] +**custom_attributes** | [**[CustomAttribute], none_type**](CustomAttribute.md) | A list of custom (merchant-provided) attributes. This is useful for submitting attributes not explicitly exposed by the API. Declaring attributes explicitly exposed by the API using is forbidden | [optional] +**identifier_exists** | **bool, none_type** | False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada. | [optional] +**installment** | [**Installment**](Installment.md) | | [optional] +**loyalty_points** | [**LoyaltyPoints**](LoyaltyPoints.md) | | [optional] +**multipack** | **int, none_type** | The number of identical products in a merchant-defined multipack. To avoid any overflow issue, pass it as a string. | [optional] +**custom_label0** | **str, none_type** | Custom label 0 for custom grouping of items in a Shopping campaign. | [optional] +**custom_label1** | **str, none_type** | Custom label 1 for custom grouping of items in a Shopping campaign. | [optional] +**custom_label2** | **str, none_type** | Custom label 2 for custom grouping of items in a Shopping campaign. | [optional] +**custom_label3** | **str, none_type** | Custom label 3 for custom grouping of items in a Shopping campaign. | [optional] +**custom_label4** | **str, none_type** | Custom label 4 for custom grouping of items in a Shopping campaign. | [optional] +**is_bundle** | **bool, none_type** | Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price. | [optional] +**mobile_link** | **str, none_type** | accounts.link to a mobile-optimized version of the landing page. | [optional] +**availability_date** | **str, none_type** | The day a pre-ordered product becomes available for delivery, in ISO 8601 format. | [optional] +**shipping_label** | **str, none_type** | The shipping label of the product, used to group product in account-level shipping rules. | [optional] +**unit_pricing_measure** | [**ProductUnitPricingMeasure**](ProductUnitPricingMeasure.md) | | [optional] +**unit_pricing_base_measure** | [**ProductUnitPricingBaseMeasure**](ProductUnitPricingBaseMeasure.md) | | [optional] +**shipping_length** | [**ProductShippingDimension**](ProductShippingDimension.md) | | [optional] +**shipping_width** | [**ProductShippingDimension**](ProductShippingDimension.md) | | [optional] +**shipping_height** | [**ProductShippingDimension**](ProductShippingDimension.md) | | [optional] +**display_ads_id** | **str, none_type** | An identifier for an item for dynamic remarketing campaigns. | [optional] +**display_ads_similar_ids** | **[str], none_type** | Advertiser-specified recommendations. | [optional] +**display_ads_title** | **str, none_type** | Title of an item for dynamic remarketing campaigns. | [optional] +**display_ads_link** | **str, none_type** | URL directly to your item's landing page for dynamic remarketing campaigns. | [optional] +**display_ads_value** | **float, none_type** | Offer margin for dynamic remarketing campaigns. | [optional] +**sell_on_google_quantity** | **int, none_type** | The quantity of the product that is available for selling on Google. Supported only for online products. | [optional] +**promotion_ids** | **[str], none_type** | The unique ID of a promotion. | [optional] +**max_handling_time** | **int, none_type** | Maximal product handling time (in business days). | [optional] +**min_handling_time** | **int, none_type** | Minimal product handling time (in business days). | [optional] +**cost_of_goods_sold** | [**Price**](Price.md) | | [optional] +**source** | **str, none_type** | The source of the offer, i.e., how the offer was created. | [optional] +**included_destinations** | **[str], none_type** | The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. | [optional] +**excluded_destinations** | **[str], none_type** | The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). | [optional] +**ads_grouping** | **str, none_type** | Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. | [optional] +**ads_labels** | **[str], none_type** | Similar to adsGrouping, but only works on CPC. | [optional] +**ads_redirect** | **str, none_type** | Allows advertisers to override the item URL when the product is shown within the context of Product Ads. | [optional] +**product_types** | **[str], none_type** | Categories of the item (formatted as in products data specification). | [optional] +**product_type_keys** | **[str], none_type** | Category keys of the item (formatted as in productTypes). | [optional] +**age_group** | **str, none_type** | Target age group of the item. | [optional] +**availability** | **str, none_type** | Availability status of the item. RECOMMENDED. | [optional] +**condition** | **str, none_type** | Condition or state of the item. | [optional] +**gender** | **str, none_type** | Target gender of the item. | [optional] +**size_system** | **str, none_type** | System in which the size is specified. Recommended for apparel items. | [optional] +**size_type** | **str, none_type** | The cut of the item. Recommended for apparel items. | [optional] +**energy_efficiency_class** | **str, none_type** | The energy efficiency class as defined in EU directive 2010/30/EU. | [optional] +**min_energy_efficiency_class** | **str, none_type** | The energy efficiency class as defined in EU directive 2010/30/EU. | [optional] +**max_energy_efficiency_class** | **str, none_type** | The energy efficiency class as defined in EU directive 2010/30/EU. | [optional] +**tax_category** | **str, none_type** | The tax category of the product, used to configure detailed tax nexus in account-level tax settings. | [optional] +**transit_time_label** | **str, none_type** | The transit time label of the product, used to group product in account-level transit time tables. | [optional] +**seller_id** | **str, none_type** | (Deprecated Field) The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. | [optional] +**external_seller_id** | **str, none_type** | The external id of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. | [optional] +**external_seller_name** | **str, none_type** | The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. | [optional] +**number_of_reviews** | **int, none_type** | The number of customer reviews for the product | [optional] +**product_rating** | **str, none_type** | The product rating for the product | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ProductImporterError.md b/sdks/retailmedia_preview/docs/ProductImporterError.md new file mode 100644 index 00000000..7f607843 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductImporterError.md @@ -0,0 +1,18 @@ +# ProductImporterError + +Error descriptor. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trace_id** | **str** | The MACHINE-READABLE correlation ID provided by the gateway | +**type** | **str** | A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors. | +**code** | **str** | A MACHINE-READABLE error code string in kebab-case. Unique across Criteo | +**instance** | **str** | A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error. | +**title** | **str** | A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. | +**detail** | **str** | A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ProductImporterWarning.md b/sdks/retailmedia_preview/docs/ProductImporterWarning.md new file mode 100644 index 00000000..37701c72 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductImporterWarning.md @@ -0,0 +1,18 @@ +# ProductImporterWarning + +Warning descriptor. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trace_id** | **str** | The MACHINE-READABLE correlation ID provided by the gateway | +**type** | **str** | A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors. | +**code** | **str** | A MACHINE-READABLE error code string in kebab-case. Unique across Criteo | +**instance** | **str** | A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error. | +**title** | **str** | A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. | +**detail** | **str** | A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ProductShipping.md b/sdks/retailmedia_preview/docs/ProductShipping.md new file mode 100644 index 00000000..4bf62af1 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductShipping.md @@ -0,0 +1,19 @@ +# ProductShipping + +Defines the shipping information of a product. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**price** | [**Price**](Price.md) | | [optional] +**country** | **str, none_type** | The CLDR territory code of the country to which an item will ship. | [optional] +**region** | **str, none_type** | The geographic region to which a shipping rate applies. | [optional] +**service** | **str, none_type** | A free-form description of the service class or delivery speed. | [optional] +**location_id** | **int, none_type** | The numeric ID of a location that the shipping rate applies to as defined in the AdWords API. | [optional] +**location_group_name** | **str, none_type** | The location where the shipping is applicable, represented by a location group name. | [optional] +**postal_code** | **str, none_type** | The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ProductShippingDimension.md b/sdks/retailmedia_preview/docs/ProductShippingDimension.md new file mode 100644 index 00000000..3ebb5e96 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductShippingDimension.md @@ -0,0 +1,14 @@ +# ProductShippingDimension + +Defines the shipping dimension of a product. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **float, none_type** | The dimension of the product used to calculate the shipping cost of the item. | [optional] +**unit** | **str, none_type** | The unit of value. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ProductShippingWeight.md b/sdks/retailmedia_preview/docs/ProductShippingWeight.md new file mode 100644 index 00000000..e78569c7 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductShippingWeight.md @@ -0,0 +1,14 @@ +# ProductShippingWeight + +Defines the shipping weight of a product. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **float, none_type** | The weight of the product used to calculate the shipping cost of the item. | [optional] +**unit** | **str, none_type** | The unit of value. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ProductTax.md b/sdks/retailmedia_preview/docs/ProductTax.md new file mode 100644 index 00000000..f147fe10 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductTax.md @@ -0,0 +1,18 @@ +# ProductTax + +Defines the tax information of a product. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rate** | **float, none_type** | The percentage of tax rate that applies to the item price. | [optional] +**country** | **str, none_type** | The country within which the item is taxed, specified as a CLDR territory code. | [optional] +**region** | **str, none_type** | The geographic region to which the tax rate applies. | [optional] +**tax_ship** | **bool, none_type** | Set to true if tax is charged on shipping. | [optional] +**location_id** | **int, none_type** | The numeric ID of a location that the tax rate applies to as defined in the AdWords API. | [optional] +**postal_code** | **str, none_type** | The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ProductUnitPricingBaseMeasure.md b/sdks/retailmedia_preview/docs/ProductUnitPricingBaseMeasure.md new file mode 100644 index 00000000..1f839962 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductUnitPricingBaseMeasure.md @@ -0,0 +1,14 @@ +# ProductUnitPricingBaseMeasure + +Defines a measurement. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **int, none_type** | The denominator of the unit price. | [optional] +**unit** | **str, none_type** | The unit of the denominator. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ColorVariableValue.md b/sdks/retailmedia_preview/docs/ProductUnitPricingMeasure.md similarity index 69% rename from sdks/retailmedia_preview/docs/ColorVariableValue.md rename to sdks/retailmedia_preview/docs/ProductUnitPricingMeasure.md index b8eb6e74..a13a6fb3 100644 --- a/sdks/retailmedia_preview/docs/ColorVariableValue.md +++ b/sdks/retailmedia_preview/docs/ProductUnitPricingMeasure.md @@ -1,11 +1,12 @@ -# ColorVariableValue +# ProductUnitPricingMeasure -A value of a template color variable +Defines a measurement. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**color** | **str** | The displayed color (HEX format) | +**value** | **float, none_type** | The measurement of an item. | [optional] +**unit** | **str, none_type** | The unit of measure. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/ProductsCustomBatchRequest.md b/sdks/retailmedia_preview/docs/ProductsCustomBatchRequest.md new file mode 100644 index 00000000..0a2068df --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductsCustomBatchRequest.md @@ -0,0 +1,13 @@ +# ProductsCustomBatchRequest + +Defines a batch of operations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entries** | [**[ProductsCustomBatchRequestEntry]**](ProductsCustomBatchRequestEntry.md) | The request entries to be processed in the batch. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ProductsCustomBatchRequestEntry.md b/sdks/retailmedia_preview/docs/ProductsCustomBatchRequestEntry.md new file mode 100644 index 00000000..f54d23ac --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductsCustomBatchRequestEntry.md @@ -0,0 +1,19 @@ +# ProductsCustomBatchRequestEntry + +A product event for a batch request. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_id** | **int** | The ID of the managing account. Criteo: the partnerId. | +**method** | **str** | The method of the batch entry. | +**batch_id** | **int, none_type** | An entry ID, unique within the batch request. | [optional] +**product_id** | **str, none_type** | The Product ID to delete. Only defined if the method is delete. | [optional] +**item_group_id** | **str, none_type** | Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant. | [optional] +**product** | [**Product**](Product.md) | | [optional] +**feed_id** | **str, none_type** | Not used by Criteo. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/TextVariableValue.md b/sdks/retailmedia_preview/docs/ReportDetailError.md similarity index 75% rename from sdks/retailmedia_preview/docs/TextVariableValue.md rename to sdks/retailmedia_preview/docs/ReportDetailError.md index 76d1425b..7b971ee8 100644 --- a/sdks/retailmedia_preview/docs/TextVariableValue.md +++ b/sdks/retailmedia_preview/docs/ReportDetailError.md @@ -1,11 +1,13 @@ -# TextVariableValue +# ReportDetailError -A value of a template text variable +An error on a batch operation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**text** | **str** | The displayed text | +**type** | **str** | | +**message** | **str** | | +**is_server_related** | **bool** | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/Section.md b/sdks/retailmedia_preview/docs/ReportDetailErrors.md similarity index 70% rename from sdks/retailmedia_preview/docs/Section.md rename to sdks/retailmedia_preview/docs/ReportDetailErrors.md index 09186289..d123807c 100644 --- a/sdks/retailmedia_preview/docs/Section.md +++ b/sdks/retailmedia_preview/docs/ReportDetailErrors.md @@ -1,12 +1,12 @@ -# Section +# ReportDetailErrors -Section object that hold template variables +A list of errors on a batch operation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**title** | **str** | | -**template_variables** | [**[TemplateVariable]**](TemplateVariable.md) | | +**product_id** | **str** | The product ID in lowercase | +**errors** | [**[ReportDetailError]**](ReportDetailError.md) | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/ReportOkResponse.md b/sdks/retailmedia_preview/docs/ReportOkResponse.md new file mode 100644 index 00000000..bfb3c05e --- /dev/null +++ b/sdks/retailmedia_preview/docs/ReportOkResponse.md @@ -0,0 +1,19 @@ +# ReportOkResponse + +The report on a given operationToken is ready. The report is available for 4 days + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | The status of the operation. The operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED) | +**import_request_timestamp** | **int** | The date when the original batch request was sent. | +**number_of_products_in_the_batch** | **int** | The number of products present in the batch. | +**number_of_products_upserted** | **int** | The number of products upserted. | +**number_of_products_deleted** | **int** | The number of products deleted. | +**number_of_products_with_errors** | **int** | The number of products with errors. | +**error_details** | [**[ReportDetailErrors]**](ReportDetailErrors.md) | The list of errors with details. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ResourceOfTemplate.md b/sdks/retailmedia_preview/docs/ResourceOfPreferredLineItemUpdateModelV2.md similarity index 78% rename from sdks/retailmedia_preview/docs/ResourceOfTemplate.md rename to sdks/retailmedia_preview/docs/ResourceOfPreferredLineItemUpdateModelV2.md index 8584916d..9eee8ae5 100644 --- a/sdks/retailmedia_preview/docs/ResourceOfTemplate.md +++ b/sdks/retailmedia_preview/docs/ResourceOfPreferredLineItemUpdateModelV2.md @@ -1,13 +1,13 @@ -# ResourceOfTemplate +# ResourceOfPreferredLineItemUpdateModelV2 Data model for a Resource ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**Template**](Template.md) | | [optional] **id** | **str, none_type** | Id of the entity | [optional] **type** | **str, none_type** | Canonical type name of the entity | [optional] +**attributes** | [**ExternalPreferredLineItemUpdateModelV2**](ExternalPreferredLineItemUpdateModelV2.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/ResourceOfCreative202210.md b/sdks/retailmedia_preview/docs/ResourceOfPreferredLineItemV2.md similarity index 82% rename from sdks/retailmedia_preview/docs/ResourceOfCreative202210.md rename to sdks/retailmedia_preview/docs/ResourceOfPreferredLineItemV2.md index 271e4580..6a5a1ec9 100644 --- a/sdks/retailmedia_preview/docs/ResourceOfCreative202210.md +++ b/sdks/retailmedia_preview/docs/ResourceOfPreferredLineItemV2.md @@ -1,13 +1,13 @@ -# ResourceOfCreative202210 +# ResourceOfPreferredLineItemV2 Data model for a Resource ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**Creative202210**](Creative202210.md) | | [optional] **id** | **str, none_type** | Id of the entity | [optional] **type** | **str, none_type** | Canonical type name of the entity | [optional] +**attributes** | [**ExternalPreferredLineItemV2**](ExternalPreferredLineItemV2.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/RetailMediaBrands.md b/sdks/retailmedia_preview/docs/RetailMediaBrands.md new file mode 100644 index 00000000..b9adf29b --- /dev/null +++ b/sdks/retailmedia_preview/docs/RetailMediaBrands.md @@ -0,0 +1,12 @@ +# RetailMediaBrands + +A collection of brand ids + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**brand_ids** | **[int], none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/SyncAttributedTransactionsReport.md b/sdks/retailmedia_preview/docs/SyncAttributedTransactionsReport.md index b51194aa..2859ee1a 100644 --- a/sdks/retailmedia_preview/docs/SyncAttributedTransactionsReport.md +++ b/sdks/retailmedia_preview/docs/SyncAttributedTransactionsReport.md @@ -1,6 +1,6 @@ # SyncAttributedTransactionsReport -Attributed transactions report body request +Attributed Transactions report body request ## Properties Name | Type | Description | Notes @@ -8,14 +8,14 @@ Name | Type | Description | Notes **account_id** | **str** | Account id to report on | **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | -**campaign_ids** | **[str], none_type** | Campaign ids to report on | [optional] -**line_item_ids** | **[str], none_type** | Line item ids to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] -**metrics** | **[str], none_type** | List of metrics to report on | [optional] +**campaign_ids** | **[str], none_type** | Campaign ids to filter | [optional] +**line_item_ids** | **[str], none_type** | Line item ids to filter | [optional] **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_preview/docs/SyncCampaignsReport.md b/sdks/retailmedia_preview/docs/SyncCampaignsReport.md index 6ea79df3..8a16b255 100644 --- a/sdks/retailmedia_preview/docs/SyncCampaignsReport.md +++ b/sdks/retailmedia_preview/docs/SyncCampaignsReport.md @@ -1,6 +1,6 @@ # SyncCampaignsReport -Campaign report body request +Campaigns report body request ## Properties Name | Type | Description | Notes @@ -9,13 +9,13 @@ Name | Type | Description | Notes **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | **report_type** | **str, none_type** | 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" -**campaign_ids** | **[str], none_type** | List of campaign Ids to filter | [optional] -**metrics** | **[str], none_type** | List of Metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**campaign_ids** | **[str], none_type** | Campaign ids to filter | [optional] **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_preview/docs/SyncLineItemsReport.md b/sdks/retailmedia_preview/docs/SyncLineItemsReport.md index 7bab212e..c800acf5 100644 --- a/sdks/retailmedia_preview/docs/SyncLineItemsReport.md +++ b/sdks/retailmedia_preview/docs/SyncLineItemsReport.md @@ -9,14 +9,14 @@ Name | Type | Description | Notes **start_date** | **datetime** | Start date | **end_date** | **datetime** | End date | **report_type** | **str, none_type** | 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" -**line_item_ids** | **[str], none_type** | Line item ids to report on | [optional] -**campaign_ids** | **[str], none_type** | Campaign ids to report on | [optional] -**metrics** | **[str], none_type** | List of metrics to report on | [optional] -**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**line_item_ids** | **[str], none_type** | Line Item ids to filter | [optional] +**campaign_ids** | **[str], none_type** | Campaign ids to filter | [optional] **click_attribution_window** | **str, none_type** | Click attribution window | [optional] if omitted the server will use the default value of "none" **view_attribution_window** | **str, none_type** | View attribution window | [optional] if omitted the server will use the default value of "none" **campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] **sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] +**dimensions** | **[str], none_type** | List of dimensions to report on | [optional] +**metrics** | **[str], none_type** | List of metrics to report on | [optional] **timezone** | **str, none_type** | Time zone : see criteo developer portal for supported time zones | [optional] if omitted the server will use the default value of "UTC" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/sdks/retailmedia_preview/docs/Template.md b/sdks/retailmedia_preview/docs/Template.md deleted file mode 100644 index 5fdc579f..00000000 --- a/sdks/retailmedia_preview/docs/Template.md +++ /dev/null @@ -1,24 +0,0 @@ -# Template - -A template for creating creatives. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creative_format** | **str** | The kind of creative this template can be used to build. | -**name** | **str** | The name of the template | -**sku_collection_min** | **int** | TODO: what is it ? | -**sku_per_collection_min** | **int** | TODO: what is it ? | -**all_collections_mandatory** | **bool** | TODO: what is it ? | -**created_at** | **datetime** | The time at which the template was created | -**updated_at** | **datetime** | The time at which the template was updated | -**sections** | [**[Section]**](Section.md) | The sections holding various template variables | -**retailer_id** | **int** | The retailer associated to the template | [optional] -**sku_collection_max** | **int, none_type** | TODO: what is it ? | [optional] -**sku_per_collection_max** | **int, none_type** | TODO: what is it ? | [optional] -**displayable_skus_max** | **int, none_type** | TODO: what is it ? | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/TemplateListResponse.md b/sdks/retailmedia_preview/docs/TemplateListResponse.md deleted file mode 100644 index 9276b044..00000000 --- a/sdks/retailmedia_preview/docs/TemplateListResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# TemplateListResponse - -Data model for a list of response resources - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**[ResourceOfTemplate]**](ResourceOfTemplate.md) | | [optional] -**warnings** | [**[ProblemDetails]**](ProblemDetails.md) | | [optional] [readonly] -**errors** | [**[ProblemDetails]**](ProblemDetails.md) | | [optional] [readonly] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/TemplateResponse.md b/sdks/retailmedia_preview/docs/TemplateResponse.md deleted file mode 100644 index 6d48cf2f..00000000 --- a/sdks/retailmedia_preview/docs/TemplateResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# TemplateResponse - -Data model for response resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**ResourceOfTemplate**](ResourceOfTemplate.md) | | [optional] -**warnings** | [**[ProblemDetails]**](ProblemDetails.md) | | [optional] [readonly] -**errors** | [**[ProblemDetails]**](ProblemDetails.md) | | [optional] [readonly] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/TemplateVariable.md b/sdks/retailmedia_preview/docs/TemplateVariable.md deleted file mode 100644 index 2bab7da3..00000000 --- a/sdks/retailmedia_preview/docs/TemplateVariable.md +++ /dev/null @@ -1,18 +0,0 @@ -# TemplateVariable - -A variable in a creative template - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | The id of the variable | -**required** | **bool** | Whether the variable is required | -**type** | **str** | The type of the variable | -**choice_variable_specification** | [**ChoiceVariableSpecification**](ChoiceVariableSpecification.md) | | [optional] -**text_variable_specification** | [**TextVariableSpecification**](TextVariableSpecification.md) | | [optional] -**files_variables_specification** | [**FilesVariablesSpecification**](FilesVariablesSpecification.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/TemplateVariableValue.md b/sdks/retailmedia_preview/docs/TemplateVariableValue.md deleted file mode 100644 index 117bd4dc..00000000 --- a/sdks/retailmedia_preview/docs/TemplateVariableValue.md +++ /dev/null @@ -1,18 +0,0 @@ -# TemplateVariableValue - -A value for a variable in a creative template. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | The id of the template variable the value is applied to | -**text_variable_value** | [**TextVariableValue**](TextVariableValue.md) | | [optional] -**choice_variable_value** | [**ChoiceVariableValue**](ChoiceVariableValue.md) | | [optional] -**color_variable_value** | [**ColorVariableValue**](ColorVariableValue.md) | | [optional] -**files_variable_value** | [**FilesVariableValue**](FilesVariableValue.md) | | [optional] -**hyperlink_variable_value** | [**HyperlinkVariableValue**](HyperlinkVariableValue.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/TextVariableSpecification.md b/sdks/retailmedia_preview/docs/TextVariableSpecification.md deleted file mode 100644 index 94193172..00000000 --- a/sdks/retailmedia_preview/docs/TextVariableSpecification.md +++ /dev/null @@ -1,13 +0,0 @@ -# TextVariableSpecification - -Specification of a text variable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**max_chars** | **int, none_type** | The maximum amount of characters accepted for the text | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/ValueResourceCollectionInputOfRetailMediaSeller.md b/sdks/retailmedia_preview/docs/ValueResourceCollectionInputOfRetailMediaSeller.md new file mode 100644 index 00000000..98663f8a --- /dev/null +++ b/sdks/retailmedia_preview/docs/ValueResourceCollectionInputOfRetailMediaSeller.md @@ -0,0 +1,12 @@ +# ValueResourceCollectionInputOfRetailMediaSeller + +A top-level object that encapsulates a Criteo API request for several values. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[ValueResourceOfRetailMediaSeller], none_type**](ValueResourceOfRetailMediaSeller.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ValueResourceCollectionOutcomeOfInt64.md b/sdks/retailmedia_preview/docs/ValueResourceCollectionOutcomeOfInt64.md deleted file mode 100644 index 98513948..00000000 --- a/sdks/retailmedia_preview/docs/ValueResourceCollectionOutcomeOfInt64.md +++ /dev/null @@ -1,14 +0,0 @@ -# ValueResourceCollectionOutcomeOfInt64 - -A top-level object that encapsulates a Criteo API response for several values. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**[ValueResourceOfInt64], none_type**](ValueResourceOfInt64.md) | | [optional] -**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] -**errors** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md b/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md new file mode 100644 index 00000000..c36494ce --- /dev/null +++ b/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md @@ -0,0 +1,12 @@ +# ValueResourceInputOfRetailMediaBrandAccountCreation + +A top-level object that encapsulates a Criteo API request for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ValueResourceOfRetailMediaBrandAccountCreation**](ValueResourceOfRetailMediaBrandAccountCreation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaBrands.md b/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaBrands.md new file mode 100644 index 00000000..bc448e22 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaBrands.md @@ -0,0 +1,12 @@ +# ValueResourceInputOfRetailMediaBrands + +A top-level object that encapsulates a Criteo API request for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ValueResourceOfRetailMediaBrands**](ValueResourceOfRetailMediaBrands.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaSellerAccountCreation.md b/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaSellerAccountCreation.md new file mode 100644 index 00000000..cc08bf10 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ValueResourceInputOfRetailMediaSellerAccountCreation.md @@ -0,0 +1,12 @@ +# ValueResourceInputOfRetailMediaSellerAccountCreation + +A top-level object that encapsulates a Criteo API request for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ValueResourceOfRetailMediaSellerAccountCreation**](ValueResourceOfRetailMediaSellerAccountCreation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaBrandAccountCreation.md b/sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaBrandAccountCreation.md new file mode 100644 index 00000000..4f96750f --- /dev/null +++ b/sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaBrandAccountCreation.md @@ -0,0 +1,13 @@ +# ValueResourceOfRetailMediaBrandAccountCreation + +A top-level object that encapsulates a Criteo API response for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str, none_type** | | [optional] +**attributes** | [**RetailMediaBrandAccountCreation**](RetailMediaBrandAccountCreation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/docs/ValueResourceOfInt64.md b/sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaBrands.md similarity index 77% rename from sdks/retailmedia_preview/docs/ValueResourceOfInt64.md rename to sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaBrands.md index 601b65bb..a13d9bc9 100644 --- a/sdks/retailmedia_preview/docs/ValueResourceOfInt64.md +++ b/sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaBrands.md @@ -1,4 +1,4 @@ -# ValueResourceOfInt64 +# ValueResourceOfRetailMediaBrands A top-level object that encapsulates a Criteo API response for a single value. @@ -6,7 +6,7 @@ A top-level object that encapsulates a Criteo API response for a single value. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str, none_type** | | [optional] -**attributes** | **int, none_type** | | [optional] +**attributes** | [**RetailMediaBrands**](RetailMediaBrands.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaSellerAccountCreation.md b/sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaSellerAccountCreation.md new file mode 100644 index 00000000..d8c45011 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ValueResourceOfRetailMediaSellerAccountCreation.md @@ -0,0 +1,13 @@ +# ValueResourceOfRetailMediaSellerAccountCreation + +A top-level object that encapsulates a Criteo API response for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str, none_type** | | [optional] +**attributes** | [**RetailMediaSellerAccountCreation**](RetailMediaSellerAccountCreation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/retailmedia_preview/setup.py b/sdks/retailmedia_preview/setup.py index daacec08..9e56711d 100644 --- a/sdks/retailmedia_preview/setup.py +++ b/sdks/retailmedia_preview/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "criteo-api-retailmedia-sdk" -VERSION = "0.0.240207" +VERSION = "0.0.240404" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-retailmedia-sdk==0.0.240207 +pip install criteo-api-retailmedia-sdk==0.0.240404 ``` -(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.240207`) +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.240404`) Then import the package: ```python