diff --git a/sdks/marketingsolutions_2023-01/.gitlab-ci.yml b/sdks/marketingsolutions_2023-01/.gitlab-ci.yml deleted file mode 100644 index 67facaf2..00000000 --- a/sdks/marketingsolutions_2023-01/.gitlab-ci.yml +++ /dev/null @@ -1,24 +0,0 @@ -# ref: https://docs.gitlab.com/ee/ci/README.html - -stages: - - test - -.tests: - stage: test - script: - - pip install -r requirements.txt - - pip install -r test-requirements.txt - - pytest --cov=criteo_api_marketingsolutions_v2023_01 - -test-3.6: - extends: .tests - image: python:3.6-alpine -test-3.7: - extends: .tests - image: python:3.7-alpine -test-3.8: - extends: .tests - image: python:3.8-alpine -test-3.9: - extends: .tests - image: python:3.9-alpine diff --git a/sdks/marketingsolutions_2023-01/.openapi-generator/FILES b/sdks/marketingsolutions_2023-01/.openapi-generator/FILES deleted file mode 100644 index 9e9755f4..00000000 --- a/sdks/marketingsolutions_2023-01/.openapi-generator/FILES +++ /dev/null @@ -1,246 +0,0 @@ -.gitignore -.gitlab-ci.yml -.openapi-generator-ignore -.travis.yml -README.md -criteo_api_marketingsolutions_v2023_01/__init__.py -criteo_api_marketingsolutions_v2023_01/api/__init__.py -criteo_api_marketingsolutions_v2023_01/api/advertiser_api.py -criteo_api_marketingsolutions_v2023_01/api/analytics_api.py -criteo_api_marketingsolutions_v2023_01/api/audience_api.py -criteo_api_marketingsolutions_v2023_01/api/campaign_api.py -criteo_api_marketingsolutions_v2023_01/api/gateway_api.py -criteo_api_marketingsolutions_v2023_01/api_client.py -criteo_api_marketingsolutions_v2023_01/api_client_builder.py -criteo_api_marketingsolutions_v2023_01/apis/__init__.py -criteo_api_marketingsolutions_v2023_01/configuration.py -criteo_api_marketingsolutions_v2023_01/criteo_api_client.py -criteo_api_marketingsolutions_v2023_01/criteo_auth.py -criteo_api_marketingsolutions_v2023_01/criteo_rest.py -criteo_api_marketingsolutions_v2023_01/exceptions.py -criteo_api_marketingsolutions_v2023_01/flow_constants.py -criteo_api_marketingsolutions_v2023_01/model/__init__.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid_list_response.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid_resource.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_delivery_limitations.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier_list_response.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier_resource.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_frequency_capping.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_geo_location.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_search_filter.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_targeting.py -criteo_api_marketingsolutions_v2023_01/model/ad_set_targeting_rule.py -criteo_api_marketingsolutions_v2023_01/model/application_summary_model.py -criteo_api_marketingsolutions_v2023_01/model/application_summary_model_resource.py -criteo_api_marketingsolutions_v2023_01/model/application_summary_model_response.py -criteo_api_marketingsolutions_v2023_01/model/audience.py -criteo_api_marketingsolutions_v2023_01/model/audience_attributes.py -criteo_api_marketingsolutions_v2023_01/model/audience_error.py -criteo_api_marketingsolutions_v2023_01/model/audience_name_description.py -criteo_api_marketingsolutions_v2023_01/model/audience_warning.py -criteo_api_marketingsolutions_v2023_01/model/basic_audience_definition.py -criteo_api_marketingsolutions_v2023_01/model/campaign.py -criteo_api_marketingsolutions_v2023_01/model/campaign_list_response.py -criteo_api_marketingsolutions_v2023_01/model/campaign_read_resource.py -criteo_api_marketingsolutions_v2023_01/model/campaign_response.py -criteo_api_marketingsolutions_v2023_01/model/campaign_search_filters.py -criteo_api_marketingsolutions_v2023_01/model/campaign_search_request.py -criteo_api_marketingsolutions_v2023_01/model/campaign_spend_limit.py -criteo_api_marketingsolutions_v2023_01/model/common_problem.py -criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment.py -criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment_attributes.py -criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment_request.py -criteo_api_marketingsolutions_v2023_01/model/contactlist_operation.py -criteo_api_marketingsolutions_v2023_01/model/contactlist_operation_attributes.py -criteo_api_marketingsolutions_v2023_01/model/criteo_api_error.py -criteo_api_marketingsolutions_v2023_01/model/criteo_api_warning.py -criteo_api_marketingsolutions_v2023_01/model/delete_audience_contact_list_response.py -criteo_api_marketingsolutions_v2023_01/model/delete_audience_response.py -criteo_api_marketingsolutions_v2023_01/model/entity_of_portfolio_message.py -criteo_api_marketingsolutions_v2023_01/model/error_code_response.py -criteo_api_marketingsolutions_v2023_01/model/get_audiences_response.py -criteo_api_marketingsolutions_v2023_01/model/get_portfolio_response.py -criteo_api_marketingsolutions_v2023_01/model/modify_audience_response.py -criteo_api_marketingsolutions_v2023_01/model/new_audience.py -criteo_api_marketingsolutions_v2023_01/model/new_audience_attributes.py -criteo_api_marketingsolutions_v2023_01/model/new_audience_request.py -criteo_api_marketingsolutions_v2023_01/model/new_audience_response.py -criteo_api_marketingsolutions_v2023_01/model/nillable_ad_set_targeting_rule.py -criteo_api_marketingsolutions_v2023_01/model/nillable_ad_set_targeting_rule_value.py -criteo_api_marketingsolutions_v2023_01/model/nillable_date_time.py -criteo_api_marketingsolutions_v2023_01/model/nillable_decimal.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_bidding.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_budget.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_list_request.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_resource.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_result_list_response.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_result_resource.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_list_request.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_resource.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_result_list_response.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_result_resource.py -criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_scheduling.py -criteo_api_marketingsolutions_v2023_01/model/patch_campaign.py -criteo_api_marketingsolutions_v2023_01/model/patch_campaign_list_request.py -criteo_api_marketingsolutions_v2023_01/model/patch_campaign_spend_limit.py -criteo_api_marketingsolutions_v2023_01/model/patch_campaign_write_resource.py -criteo_api_marketingsolutions_v2023_01/model/patch_result_campaign_list_response.py -criteo_api_marketingsolutions_v2023_01/model/patch_result_campaign_read_resource.py -criteo_api_marketingsolutions_v2023_01/model/placements_report_query_data_message.py -criteo_api_marketingsolutions_v2023_01/model/placements_report_query_entity_message.py -criteo_api_marketingsolutions_v2023_01/model/placements_report_query_message.py -criteo_api_marketingsolutions_v2023_01/model/portfolio_message.py -criteo_api_marketingsolutions_v2023_01/model/problem_details.py -criteo_api_marketingsolutions_v2023_01/model/problems_details.py -criteo_api_marketingsolutions_v2023_01/model/read_ad_set.py -criteo_api_marketingsolutions_v2023_01/model/read_ad_set_bidding.py -criteo_api_marketingsolutions_v2023_01/model/read_ad_set_budget.py -criteo_api_marketingsolutions_v2023_01/model/read_ad_set_schedule.py -criteo_api_marketingsolutions_v2023_01/model/read_model_ad_set_id.py -criteo_api_marketingsolutions_v2023_01/model/read_model_read_ad_set.py -criteo_api_marketingsolutions_v2023_01/model/replace_audience.py -criteo_api_marketingsolutions_v2023_01/model/replace_audience_request.py -criteo_api_marketingsolutions_v2023_01/model/replace_audience_response.py -criteo_api_marketingsolutions_v2023_01/model/request_ad_set_search.py -criteo_api_marketingsolutions_v2023_01/model/requests_ad_set_id.py -criteo_api_marketingsolutions_v2023_01/model/requests_patch_ad_set.py -criteo_api_marketingsolutions_v2023_01/model/response_read_ad_set.py -criteo_api_marketingsolutions_v2023_01/model/responses_ad_set_id.py -criteo_api_marketingsolutions_v2023_01/model/responses_read_ad_set.py -criteo_api_marketingsolutions_v2023_01/model/statistics_report_query_message.py -criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_data_message.py -criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_entity_message.py -criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_message.py -criteo_api_marketingsolutions_v2023_01/model/transparency_query_message.py -criteo_api_marketingsolutions_v2023_01/model/transparency_report_attributes.py -criteo_api_marketingsolutions_v2023_01/model/transparency_report_data_message.py -criteo_api_marketingsolutions_v2023_01/model/transparency_report_entity_message.py -criteo_api_marketingsolutions_v2023_01/model/transparency_report_file.py -criteo_api_marketingsolutions_v2023_01/model/write_model_ad_set_id.py -criteo_api_marketingsolutions_v2023_01/model/write_model_patch_ad_set.py -criteo_api_marketingsolutions_v2023_01/model_utils.py -criteo_api_marketingsolutions_v2023_01/models/__init__.py -criteo_api_marketingsolutions_v2023_01/rest.py -docs/AdSetCategoryBid.md -docs/AdSetCategoryBidListResponse.md -docs/AdSetCategoryBidResource.md -docs/AdSetDeliveryLimitations.md -docs/AdSetDisplayMultiplier.md -docs/AdSetDisplayMultiplierListResponse.md -docs/AdSetDisplayMultiplierResource.md -docs/AdSetFrequencyCapping.md -docs/AdSetGeoLocation.md -docs/AdSetSearchFilter.md -docs/AdSetTargeting.md -docs/AdSetTargetingRule.md -docs/AdvertiserApi.md -docs/AnalyticsApi.md -docs/ApplicationSummaryModel.md -docs/ApplicationSummaryModelResource.md -docs/ApplicationSummaryModelResponse.md -docs/Audience.md -docs/AudienceApi.md -docs/AudienceAttributes.md -docs/AudienceError.md -docs/AudienceNameDescription.md -docs/AudienceWarning.md -docs/BasicAudienceDefinition.md -docs/Campaign.md -docs/CampaignApi.md -docs/CampaignListResponse.md -docs/CampaignReadResource.md -docs/CampaignResponse.md -docs/CampaignSearchFilters.md -docs/CampaignSearchRequest.md -docs/CampaignSpendLimit.md -docs/CommonProblem.md -docs/ContactlistAmendment.md -docs/ContactlistAmendmentAttributes.md -docs/ContactlistAmendmentRequest.md -docs/ContactlistOperation.md -docs/ContactlistOperationAttributes.md -docs/CriteoApiError.md -docs/CriteoApiWarning.md -docs/DeleteAudienceContactListResponse.md -docs/DeleteAudienceResponse.md -docs/EntityOfPortfolioMessage.md -docs/ErrorCodeResponse.md -docs/GatewayApi.md -docs/GetAudiencesResponse.md -docs/GetPortfolioResponse.md -docs/ModifyAudienceResponse.md -docs/NewAudience.md -docs/NewAudienceAttributes.md -docs/NewAudienceRequest.md -docs/NewAudienceResponse.md -docs/NillableAdSetTargetingRule.md -docs/NillableAdSetTargetingRuleValue.md -docs/NillableDateTime.md -docs/NillableDecimal.md -docs/PatchAdSet.md -docs/PatchAdSetBidding.md -docs/PatchAdSetBudget.md -docs/PatchAdSetCategoryBid.md -docs/PatchAdSetCategoryBidListRequest.md -docs/PatchAdSetCategoryBidResource.md -docs/PatchAdSetCategoryBidResultListResponse.md -docs/PatchAdSetCategoryBidResultResource.md -docs/PatchAdSetDisplayMultiplier.md -docs/PatchAdSetDisplayMultiplierListRequest.md -docs/PatchAdSetDisplayMultiplierResource.md -docs/PatchAdSetDisplayMultiplierResultListResponse.md -docs/PatchAdSetDisplayMultiplierResultResource.md -docs/PatchAdSetScheduling.md -docs/PatchCampaign.md -docs/PatchCampaignListRequest.md -docs/PatchCampaignSpendLimit.md -docs/PatchCampaignWriteResource.md -docs/PatchResultCampaignListResponse.md -docs/PatchResultCampaignReadResource.md -docs/PlacementsReportQueryDataMessage.md -docs/PlacementsReportQueryEntityMessage.md -docs/PlacementsReportQueryMessage.md -docs/PortfolioMessage.md -docs/ProblemDetails.md -docs/ProblemsDetails.md -docs/ReadAdSet.md -docs/ReadAdSetBidding.md -docs/ReadAdSetBudget.md -docs/ReadAdSetSchedule.md -docs/ReadModelAdSetId.md -docs/ReadModelReadAdSet.md -docs/ReplaceAudience.md -docs/ReplaceAudienceRequest.md -docs/ReplaceAudienceResponse.md -docs/RequestAdSetSearch.md -docs/RequestsAdSetId.md -docs/RequestsPatchAdSet.md -docs/ResponseReadAdSet.md -docs/ResponsesAdSetId.md -docs/ResponsesReadAdSet.md -docs/StatisticsReportQueryMessage.md -docs/TransactionsReportQueryDataMessage.md -docs/TransactionsReportQueryEntityMessage.md -docs/TransactionsReportQueryMessage.md -docs/TransparencyQueryMessage.md -docs/TransparencyReportAttributes.md -docs/TransparencyReportDataMessage.md -docs/TransparencyReportEntityMessage.md -docs/TransparencyReportFile.md -docs/WriteModelAdSetId.md -docs/WriteModelPatchAdSet.md -git_push.sh -requirements.txt -setup.cfg -setup.py -test-requirements.txt -test/example_application_with_auth_code.py -test/example_application_with_client_credentials.py -test/example_application_with_refresh_token.py -test/test_gateway_api.py -tox.ini diff --git a/sdks/marketingsolutions_2023-01/README.md b/sdks/marketingsolutions_2023-01/README.md deleted file mode 100644 index 159e4e82..00000000 --- a/sdks/marketingsolutions_2023-01/README.md +++ /dev/null @@ -1,170 +0,0 @@ -# Criteo API SDK for Python - -## Introduction -API Client Libraries can facilitate your use of the Criteo API allowing you to build unique and customized solutions to serve your businesses and clients. -These libraries can reduce the amount of code you need to write in order to start accessing Criteo programmatically. They also can help expedite troubleshooting, should you encounter any issues. - -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.240404 - -## Requirements - -Python 2.7 and 3.5+ - -## Installation & Usage -### pip install - -```sh -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.240404`) - -Then import the package: -```python -import criteo_api_marketingsolutions_v2023_01 -``` - -### Manual Installation using [Setuptools](http://pypi.python.org/pypi/setuptools) - -Download the code or clone the repository locally, then execute the following command: - -```sh -python setup.py install --user -``` -(or `sudo python setup.py install` to install the package for all users) - -Then import the package: -```python -import criteo_api_marketingsolutions_v2023_01 -``` - -## Example -There are multiple examples for the different OAuth flows that the SDK supports. -- See [test/example_application_with_client_credentials.py](test/example_application_with_client_credentials.py) for an example with Client Credentials. -- See [test/example_application_with_auth_code.py](test/example_application_with_auth_code.py) for an example with Authorization Code. -Once you follow the authorization code flow, you will have a refresh token that has to be used to regenerate access token for future usage. - - See [test/example_application_with_refresh_token.py](test/example_application_with_refresh_token.py) for an example with Refresh Token . - -## Documentation for API Endpoints - -The developers documentation is available at: *https://developers.criteo.com*. - -All URIs are relative to *https://api.criteo.com*. - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- - - -## Documentation For Models - - - [AdSetCategoryBid](docs/AdSetCategoryBid.md) - - [AdSetCategoryBidListResponse](docs/AdSetCategoryBidListResponse.md) - - [AdSetCategoryBidResource](docs/AdSetCategoryBidResource.md) - - [AdSetDeliveryLimitations](docs/AdSetDeliveryLimitations.md) - - [AdSetDisplayMultiplier](docs/AdSetDisplayMultiplier.md) - - [AdSetDisplayMultiplierListResponse](docs/AdSetDisplayMultiplierListResponse.md) - - [AdSetDisplayMultiplierResource](docs/AdSetDisplayMultiplierResource.md) - - [AdSetFrequencyCapping](docs/AdSetFrequencyCapping.md) - - [AdSetGeoLocation](docs/AdSetGeoLocation.md) - - [AdSetSearchFilter](docs/AdSetSearchFilter.md) - - [AdSetTargeting](docs/AdSetTargeting.md) - - [AdSetTargetingRule](docs/AdSetTargetingRule.md) - - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) - - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) - - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) - - [Audience](docs/Audience.md) - - [AudienceAttributes](docs/AudienceAttributes.md) - - [AudienceError](docs/AudienceError.md) - - [AudienceNameDescription](docs/AudienceNameDescription.md) - - [AudienceWarning](docs/AudienceWarning.md) - - [BasicAudienceDefinition](docs/BasicAudienceDefinition.md) - - [Campaign](docs/Campaign.md) - - [CampaignListResponse](docs/CampaignListResponse.md) - - [CampaignReadResource](docs/CampaignReadResource.md) - - [CampaignResponse](docs/CampaignResponse.md) - - [CampaignSearchFilters](docs/CampaignSearchFilters.md) - - [CampaignSearchRequest](docs/CampaignSearchRequest.md) - - [CampaignSpendLimit](docs/CampaignSpendLimit.md) - - [CommonProblem](docs/CommonProblem.md) - - [ContactlistAmendment](docs/ContactlistAmendment.md) - - [ContactlistAmendmentAttributes](docs/ContactlistAmendmentAttributes.md) - - [ContactlistAmendmentRequest](docs/ContactlistAmendmentRequest.md) - - [ContactlistOperation](docs/ContactlistOperation.md) - - [ContactlistOperationAttributes](docs/ContactlistOperationAttributes.md) - - [CriteoApiError](docs/CriteoApiError.md) - - [CriteoApiWarning](docs/CriteoApiWarning.md) - - [DeleteAudienceContactListResponse](docs/DeleteAudienceContactListResponse.md) - - [DeleteAudienceResponse](docs/DeleteAudienceResponse.md) - - [EntityOfPortfolioMessage](docs/EntityOfPortfolioMessage.md) - - [ErrorCodeResponse](docs/ErrorCodeResponse.md) - - [GetAudiencesResponse](docs/GetAudiencesResponse.md) - - [GetPortfolioResponse](docs/GetPortfolioResponse.md) - - [ModifyAudienceResponse](docs/ModifyAudienceResponse.md) - - [NewAudience](docs/NewAudience.md) - - [NewAudienceAttributes](docs/NewAudienceAttributes.md) - - [NewAudienceRequest](docs/NewAudienceRequest.md) - - [NewAudienceResponse](docs/NewAudienceResponse.md) - - [NillableAdSetTargetingRule](docs/NillableAdSetTargetingRule.md) - - [NillableAdSetTargetingRuleValue](docs/NillableAdSetTargetingRuleValue.md) - - [NillableDateTime](docs/NillableDateTime.md) - - [NillableDecimal](docs/NillableDecimal.md) - - [PatchAdSet](docs/PatchAdSet.md) - - [PatchAdSetBidding](docs/PatchAdSetBidding.md) - - [PatchAdSetBudget](docs/PatchAdSetBudget.md) - - [PatchAdSetCategoryBid](docs/PatchAdSetCategoryBid.md) - - [PatchAdSetCategoryBidListRequest](docs/PatchAdSetCategoryBidListRequest.md) - - [PatchAdSetCategoryBidResource](docs/PatchAdSetCategoryBidResource.md) - - [PatchAdSetCategoryBidResultListResponse](docs/PatchAdSetCategoryBidResultListResponse.md) - - [PatchAdSetCategoryBidResultResource](docs/PatchAdSetCategoryBidResultResource.md) - - [PatchAdSetDisplayMultiplier](docs/PatchAdSetDisplayMultiplier.md) - - [PatchAdSetDisplayMultiplierListRequest](docs/PatchAdSetDisplayMultiplierListRequest.md) - - [PatchAdSetDisplayMultiplierResource](docs/PatchAdSetDisplayMultiplierResource.md) - - [PatchAdSetDisplayMultiplierResultListResponse](docs/PatchAdSetDisplayMultiplierResultListResponse.md) - - [PatchAdSetDisplayMultiplierResultResource](docs/PatchAdSetDisplayMultiplierResultResource.md) - - [PatchAdSetScheduling](docs/PatchAdSetScheduling.md) - - [PatchCampaign](docs/PatchCampaign.md) - - [PatchCampaignListRequest](docs/PatchCampaignListRequest.md) - - [PatchCampaignSpendLimit](docs/PatchCampaignSpendLimit.md) - - [PatchCampaignWriteResource](docs/PatchCampaignWriteResource.md) - - [PatchResultCampaignListResponse](docs/PatchResultCampaignListResponse.md) - - [PatchResultCampaignReadResource](docs/PatchResultCampaignReadResource.md) - - [PlacementsReportQueryDataMessage](docs/PlacementsReportQueryDataMessage.md) - - [PlacementsReportQueryEntityMessage](docs/PlacementsReportQueryEntityMessage.md) - - [PlacementsReportQueryMessage](docs/PlacementsReportQueryMessage.md) - - [PortfolioMessage](docs/PortfolioMessage.md) - - [ProblemDetails](docs/ProblemDetails.md) - - [ProblemsDetails](docs/ProblemsDetails.md) - - [ReadAdSet](docs/ReadAdSet.md) - - [ReadAdSetBidding](docs/ReadAdSetBidding.md) - - [ReadAdSetBudget](docs/ReadAdSetBudget.md) - - [ReadAdSetSchedule](docs/ReadAdSetSchedule.md) - - [ReadModelAdSetId](docs/ReadModelAdSetId.md) - - [ReadModelReadAdSet](docs/ReadModelReadAdSet.md) - - [ReplaceAudience](docs/ReplaceAudience.md) - - [ReplaceAudienceRequest](docs/ReplaceAudienceRequest.md) - - [ReplaceAudienceResponse](docs/ReplaceAudienceResponse.md) - - [RequestAdSetSearch](docs/RequestAdSetSearch.md) - - [RequestsAdSetId](docs/RequestsAdSetId.md) - - [RequestsPatchAdSet](docs/RequestsPatchAdSet.md) - - [ResponseReadAdSet](docs/ResponseReadAdSet.md) - - [ResponsesAdSetId](docs/ResponsesAdSetId.md) - - [ResponsesReadAdSet](docs/ResponsesReadAdSet.md) - - [StatisticsReportQueryMessage](docs/StatisticsReportQueryMessage.md) - - [TransactionsReportQueryDataMessage](docs/TransactionsReportQueryDataMessage.md) - - [TransactionsReportQueryEntityMessage](docs/TransactionsReportQueryEntityMessage.md) - - [TransactionsReportQueryMessage](docs/TransactionsReportQueryMessage.md) - - [TransparencyQueryMessage](docs/TransparencyQueryMessage.md) - - [TransparencyReportAttributes](docs/TransparencyReportAttributes.md) - - [TransparencyReportDataMessage](docs/TransparencyReportDataMessage.md) - - [TransparencyReportEntityMessage](docs/TransparencyReportEntityMessage.md) - - [TransparencyReportFile](docs/TransparencyReportFile.md) - - [WriteModelAdSetId](docs/WriteModelAdSetId.md) - - [WriteModelPatchAdSet](docs/WriteModelPatchAdSet.md) - - -## Disclaimer - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file 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 deleted file mode 100644 index 07c72862..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/__init__.py +++ /dev/null @@ -1,31 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -__version__ = "2023.01.0.240404" - -# import ApiClient -from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient -from criteo_api_marketingsolutions_v2023_01.criteo_api_client import CriteoApiClient -from criteo_api_marketingsolutions_v2023_01.api_client_builder import ApiClientBuilder -from criteo_api_marketingsolutions_v2023_01 import flow_constants - -# import Configuration -from criteo_api_marketingsolutions_v2023_01.configuration import Configuration - -# import exceptions -from criteo_api_marketingsolutions_v2023_01.exceptions import OpenApiException -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiTypeError -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiValueError -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiKeyError -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiException - - - diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/__init__.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/__init__.py deleted file mode 100644 index 6cfd76aa..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -# do not import all apis into this module because that uses a lot of memory and stack frames -# if you need the ability to import all apis from one package, import them with -# from criteo_api_marketingsolutions_v2023_01.apis import AdvertiserApi diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/analytics_api.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/analytics_api.py deleted file mode 100644 index 77a8f0bd..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/analytics_api.py +++ /dev/null @@ -1,604 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from criteo_api_marketingsolutions_v2023_01.model.placements_report_query_data_message import PlacementsReportQueryDataMessage -from criteo_api_marketingsolutions_v2023_01.model.problems_details import ProblemsDetails -from criteo_api_marketingsolutions_v2023_01.model.statistics_report_query_message import StatisticsReportQueryMessage -from criteo_api_marketingsolutions_v2023_01.model.transactions_report_query_data_message import TransactionsReportQueryDataMessage -from criteo_api_marketingsolutions_v2023_01.model.transparency_query_message import TransparencyQueryMessage -from criteo_api_marketingsolutions_v2023_01.model.transparency_report_data_message import TransparencyReportDataMessage - - -class AnalyticsApi(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.get_adset_report_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/statistics/report', - 'operation_id': 'get_adset_report', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'statistics_report_query_message', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'statistics_report_query_message': - (StatisticsReportQueryMessage,), - }, - 'attribute_map': { - }, - 'location_map': { - 'statistics_report_query_message': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json', - 'text/csv', - 'text/xml', - 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' - ], - 'content_type': [ - 'application/json-patch+json', - 'application/json', - 'text/json', - 'application/*+json' - ] - }, - api_client=api_client - ) - self.get_placements_report_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/placements/report', - 'operation_id': 'get_placements_report', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'placements_report_query_data_message', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'placements_report_query_data_message': - (PlacementsReportQueryDataMessage,), - }, - 'attribute_map': { - }, - 'location_map': { - 'placements_report_query_data_message': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json', - 'text/csv', - 'text/xml', - 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' - ], - 'content_type': [ - 'application/json-patch+json', - 'application/json', - 'text/json', - 'application/*+json' - ] - }, - api_client=api_client - ) - self.get_transactions_report_endpoint = _Endpoint( - settings={ - 'response_type': (file_type,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/transactions/report', - 'operation_id': 'get_transactions_report', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'transactions_report_query_data_message', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'transactions_report_query_data_message': - (TransactionsReportQueryDataMessage,), - }, - 'attribute_map': { - }, - 'location_map': { - 'transactions_report_query_data_message': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json', - 'text/csv', - 'text/xml', - 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' - ], - 'content_type': [ - 'application/json-patch+json', - 'application/json', - 'text/json', - 'application/*+json' - ] - }, - api_client=api_client - ) - self.get_transparency_report_endpoint = _Endpoint( - settings={ - 'response_type': (TransparencyReportDataMessage,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/log-level/advertisers/{advertiser-id}/report', - 'operation_id': 'get_transparency_report', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'advertiser_id', - 'transparency_query_message', - ], - 'required': [ - 'advertiser_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'advertiser_id': - (int,), - 'transparency_query_message': - (TransparencyQueryMessage,), - }, - 'attribute_map': { - 'advertiser_id': 'advertiser-id', - }, - 'location_map': { - 'advertiser_id': 'path', - 'transparency_query_message': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'text/plain', - 'text/json' - ], - 'content_type': [ - 'application/json-patch+json', - 'application/json', - 'text/json', - 'application/*+json' - ] - }, - api_client=api_client - ) - - def get_adset_report( - self, - **kwargs - ): - """get_adset_report # noqa: E501 - - This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities. # 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_adset_report(async_req=True) - >>> result = thread.get() - - - Keyword Args: - statistics_report_query_message (StatisticsReportQueryMessage): [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: - file_type - 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) - return self.get_adset_report_endpoint.call_with_http_info(**kwargs) - - def get_placements_report( - self, - **kwargs - ): - """get_placements_report # noqa: E501 - - Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated. # 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_placements_report(async_req=True) - >>> result = thread.get() - - - Keyword Args: - placements_report_query_data_message (PlacementsReportQueryDataMessage): [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: - file_type - 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) - return self.get_placements_report_endpoint.call_with_http_info(**kwargs) - - def get_transactions_report( - self, - **kwargs - ): - """get_transactions_report # noqa: E501 - - This Transactions endpoint provides transactions id related data. # 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_transactions_report(async_req=True) - >>> result = thread.get() - - - Keyword Args: - transactions_report_query_data_message (TransactionsReportQueryDataMessage): [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: - file_type - 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) - return self.get_transactions_report_endpoint.call_with_http_info(**kwargs) - - def get_transparency_report( - self, - advertiser_id, - **kwargs - ): - """get_transparency_report # noqa: E501 - - This Statistics endpoint provides publisher data. # 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_transparency_report(advertiser_id, async_req=True) - >>> result = thread.get() - - Args: - advertiser_id (int): The advertiser id to fetch the transparency data. - - Keyword Args: - transparency_query_message (TransparencyQueryMessage): [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: - TransparencyReportDataMessage - 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['advertiser_id'] = \ - advertiser_id - return self.get_transparency_report_endpoint.call_with_http_info(**kwargs) - diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/audience_api.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/audience_api.py deleted file mode 100644 index bd0082fd..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/audience_api.py +++ /dev/null @@ -1,874 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from criteo_api_marketingsolutions_v2023_01.model.contactlist_amendment_request import ContactlistAmendmentRequest -from criteo_api_marketingsolutions_v2023_01.model.delete_audience_contact_list_response import DeleteAudienceContactListResponse -from criteo_api_marketingsolutions_v2023_01.model.delete_audience_response import DeleteAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.error_code_response import ErrorCodeResponse -from criteo_api_marketingsolutions_v2023_01.model.get_audiences_response import GetAudiencesResponse -from criteo_api_marketingsolutions_v2023_01.model.modify_audience_response import ModifyAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.new_audience_request import NewAudienceRequest -from criteo_api_marketingsolutions_v2023_01.model.new_audience_response import NewAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.replace_audience_request import ReplaceAudienceRequest -from criteo_api_marketingsolutions_v2023_01.model.replace_audience_response import ReplaceAudienceResponse - - -class AudienceApi(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.create_audience_endpoint = _Endpoint( - settings={ - 'response_type': (NewAudienceResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/audiences', - 'operation_id': 'create_audience', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'new_audience_request', - ], - 'required': [ - 'new_audience_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'new_audience_request': - (NewAudienceRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'new_audience_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.delete_identifiers_endpoint = _Endpoint( - settings={ - 'response_type': (DeleteAudienceContactListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/audiences/{audience-id}/contactlist', - 'operation_id': 'delete_identifiers', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'audience_id', - ], - 'required': [ - 'audience_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'audience_id': - (str,), - }, - 'attribute_map': { - 'audience_id': 'audience-id', - }, - 'location_map': { - 'audience_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_audiences_endpoint = _Endpoint( - settings={ - 'response_type': (GetAudiencesResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/audiences', - 'operation_id': 'get_audiences', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'advertiser_id', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'advertiser_id': - (str,), - }, - 'attribute_map': { - 'advertiser_id': 'advertiser-id', - }, - 'location_map': { - 'advertiser_id': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.modify_audience_endpoint = _Endpoint( - settings={ - 'response_type': (ReplaceAudienceResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/audiences/{audience-id}', - 'operation_id': 'modify_audience', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'audience_id', - 'replace_audience_request', - ], - 'required': [ - 'audience_id', - 'replace_audience_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'audience_id': - (str,), - 'replace_audience_request': - (ReplaceAudienceRequest,), - }, - 'attribute_map': { - 'audience_id': 'audience-id', - }, - 'location_map': { - 'audience_id': 'path', - 'replace_audience_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.modify_audience_users_endpoint = _Endpoint( - settings={ - 'response_type': (ModifyAudienceResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/audiences/{audience-id}/contactlist', - 'operation_id': 'modify_audience_users', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'audience_id', - 'contactlist_amendment_request', - ], - 'required': [ - 'audience_id', - 'contactlist_amendment_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'audience_id': - (str,), - 'contactlist_amendment_request': - (ContactlistAmendmentRequest,), - }, - 'attribute_map': { - 'audience_id': 'audience-id', - }, - 'location_map': { - 'audience_id': 'path', - 'contactlist_amendment_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.remove_audience_endpoint = _Endpoint( - settings={ - 'response_type': (DeleteAudienceResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/audiences/{audience-id}', - 'operation_id': 'remove_audience', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'audience_id', - ], - 'required': [ - 'audience_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'audience_id': - (str,), - }, - 'attribute_map': { - 'audience_id': 'audience-id', - }, - 'location_map': { - 'audience_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - - def create_audience( - self, - new_audience_request, - **kwargs - ): - """create_audience # noqa: E501 - - Create an Audience for an Advertiser # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_audience(new_audience_request, async_req=True) - >>> result = thread.get() - - Args: - new_audience_request (NewAudienceRequest): - - 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: - NewAudienceResponse - 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['new_audience_request'] = \ - new_audience_request - return self.create_audience_endpoint.call_with_http_info(**kwargs) - - def delete_identifiers( - self, - audience_id, - **kwargs - ): - """delete_identifiers # noqa: E501 - - Delete all identifiers from a contact list audience-segment. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_identifiers(audience_id, async_req=True) - >>> result = thread.get() - - Args: - audience_id (str): The id of the audience to amend - - 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: - DeleteAudienceContactListResponse - 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['audience_id'] = \ - audience_id - return self.delete_identifiers_endpoint.call_with_http_info(**kwargs) - - def get_audiences( - self, - **kwargs - ): - """get_audiences # noqa: E501 - - Get a list of all the audiences for the user or for the given advertiser_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_audiences(async_req=True) - >>> result = thread.get() - - - Keyword Args: - advertiser_id (str): The advertiser id to get all the audiences for. Mandatory for internal users. For external users, if you don't provide it, we will take into account the advertisers from your portfolio. [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: - GetAudiencesResponse - 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) - return self.get_audiences_endpoint.call_with_http_info(**kwargs) - - def modify_audience( - self, - audience_id, - replace_audience_request, - **kwargs - ): - """modify_audience # noqa: E501 - - Update user audience specified by the audience 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.modify_audience(audience_id, replace_audience_request, async_req=True) - >>> result = thread.get() - - Args: - audience_id (str): The id of the audience to amend - replace_audience_request (ReplaceAudienceRequest): - - 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: - ReplaceAudienceResponse - 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['audience_id'] = \ - audience_id - kwargs['replace_audience_request'] = \ - replace_audience_request - return self.modify_audience_endpoint.call_with_http_info(**kwargs) - - def modify_audience_users( - self, - audience_id, - contactlist_amendment_request, - **kwargs - ): - """modify_audience_users # noqa: E501 - - Add/remove users to or from a contact list audience-segment. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.modify_audience_users(audience_id, contactlist_amendment_request, async_req=True) - >>> result = thread.get() - - Args: - audience_id (str): The id of the audience to amend - contactlist_amendment_request (ContactlistAmendmentRequest): - - 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: - ModifyAudienceResponse - 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['audience_id'] = \ - audience_id - kwargs['contactlist_amendment_request'] = \ - contactlist_amendment_request - return self.modify_audience_users_endpoint.call_with_http_info(**kwargs) - - def remove_audience( - self, - audience_id, - **kwargs - ): - """remove_audience # noqa: E501 - - Delete an audience by 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.remove_audience(audience_id, async_req=True) - >>> result = thread.get() - - Args: - audience_id (str): The id of the audience to amend - - 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: - DeleteAudienceResponse - 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['audience_id'] = \ - audience_id - return self.remove_audience_endpoint.call_with_http_info(**kwargs) - diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/campaign_api.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/campaign_api.py deleted file mode 100644 index 3502c25d..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/campaign_api.py +++ /dev/null @@ -1,1706 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from criteo_api_marketingsolutions_v2023_01.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse -from criteo_api_marketingsolutions_v2023_01.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse -from criteo_api_marketingsolutions_v2023_01.model.campaign_list_response import CampaignListResponse -from criteo_api_marketingsolutions_v2023_01.model.campaign_response import CampaignResponse -from criteo_api_marketingsolutions_v2023_01.model.campaign_search_request import CampaignSearchRequest -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_list_request import PatchAdSetCategoryBidListRequest -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_result_list_response import PatchAdSetCategoryBidResultListResponse -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_list_request import PatchAdSetDisplayMultiplierListRequest -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_result_list_response import PatchAdSetDisplayMultiplierResultListResponse -from criteo_api_marketingsolutions_v2023_01.model.patch_campaign_list_request import PatchCampaignListRequest -from criteo_api_marketingsolutions_v2023_01.model.patch_result_campaign_list_response import PatchResultCampaignListResponse -from criteo_api_marketingsolutions_v2023_01.model.request_ad_set_search import RequestAdSetSearch -from criteo_api_marketingsolutions_v2023_01.model.requests_ad_set_id import RequestsAdSetId -from criteo_api_marketingsolutions_v2023_01.model.requests_patch_ad_set import RequestsPatchAdSet -from criteo_api_marketingsolutions_v2023_01.model.response_read_ad_set import ResponseReadAdSet -from criteo_api_marketingsolutions_v2023_01.model.responses_ad_set_id import ResponsesAdSetId -from criteo_api_marketingsolutions_v2023_01.model.responses_read_ad_set import ResponsesReadAdSet - - -class CampaignApi(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.get_ad_set_endpoint = _Endpoint( - settings={ - 'response_type': (ResponseReadAdSet,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets/{adSetId}', - 'operation_id': 'get_ad_set', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'ad_set_id', - ], - 'required': [ - 'ad_set_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'ad_set_id': - (str,), - }, - 'attribute_map': { - 'ad_set_id': 'adSetId', - }, - 'location_map': { - 'ad_set_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_campaign_endpoint = _Endpoint( - settings={ - 'response_type': (CampaignResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/campaigns/{campaign-id}', - 'operation_id': 'get_campaign', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'campaign_id', - ], - 'required': [ - 'campaign_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'campaign_id': - (str,), - }, - 'attribute_map': { - 'campaign_id': 'campaign-id', - }, - 'location_map': { - 'campaign_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_category_bid_list_endpoint = _Endpoint( - settings={ - 'response_type': (AdSetCategoryBidListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets/{ad-set-id}/category-bids', - 'operation_id': 'get_category_bid_list', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'ad_set_id', - ], - 'required': [ - 'ad_set_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'ad_set_id': - (str,), - }, - 'attribute_map': { - 'ad_set_id': 'ad-set-id', - }, - 'location_map': { - 'ad_set_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_display_multipliers_endpoint = _Endpoint( - settings={ - 'response_type': (AdSetDisplayMultiplierListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers', - 'operation_id': 'get_display_multipliers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'ad_set_id', - ], - 'required': [ - 'ad_set_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'ad_set_id': - (str,), - }, - 'attribute_map': { - 'ad_set_id': 'ad-set-id', - }, - 'location_map': { - 'ad_set_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.patch_ad_sets_endpoint = _Endpoint( - settings={ - 'response_type': (ResponsesAdSetId,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets', - 'operation_id': 'patch_ad_sets', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'requests_patch_ad_set', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'requests_patch_ad_set': - (RequestsPatchAdSet,), - }, - 'attribute_map': { - }, - 'location_map': { - 'requests_patch_ad_set': '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.patch_campaigns_endpoint = _Endpoint( - settings={ - 'response_type': (PatchResultCampaignListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/campaigns', - 'operation_id': 'patch_campaigns', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'patch_campaign_list_request', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'patch_campaign_list_request': - (PatchCampaignListRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'patch_campaign_list_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.patch_category_bid_list_endpoint = _Endpoint( - settings={ - 'response_type': (PatchAdSetCategoryBidResultListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets/{ad-set-id}/category-bids', - 'operation_id': 'patch_category_bid_list', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'ad_set_id', - 'patch_ad_set_category_bid_list_request', - ], - 'required': [ - 'ad_set_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'ad_set_id': - (str,), - 'patch_ad_set_category_bid_list_request': - (PatchAdSetCategoryBidListRequest,), - }, - 'attribute_map': { - 'ad_set_id': 'ad-set-id', - }, - 'location_map': { - 'ad_set_id': 'path', - 'patch_ad_set_category_bid_list_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.patch_display_multipliers_endpoint = _Endpoint( - settings={ - 'response_type': (PatchAdSetDisplayMultiplierResultListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers', - 'operation_id': 'patch_display_multipliers', - 'http_method': 'PATCH', - 'servers': None, - }, - params_map={ - 'all': [ - 'ad_set_id', - 'patch_ad_set_display_multiplier_list_request', - ], - 'required': [ - 'ad_set_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'ad_set_id': - (str,), - 'patch_ad_set_display_multiplier_list_request': - (PatchAdSetDisplayMultiplierListRequest,), - }, - 'attribute_map': { - 'ad_set_id': 'ad-set-id', - }, - 'location_map': { - 'ad_set_id': 'path', - 'patch_ad_set_display_multiplier_list_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.search_ad_sets_endpoint = _Endpoint( - settings={ - 'response_type': (ResponsesReadAdSet,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets/search', - 'operation_id': 'search_ad_sets', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'request_ad_set_search', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'request_ad_set_search': - (RequestAdSetSearch,), - }, - 'attribute_map': { - }, - 'location_map': { - 'request_ad_set_search': '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.search_campaigns_endpoint = _Endpoint( - settings={ - 'response_type': (CampaignListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/campaigns/search', - 'operation_id': 'search_campaigns', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'campaign_search_request', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'campaign_search_request': - (CampaignSearchRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'campaign_search_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.start_ad_sets_endpoint = _Endpoint( - settings={ - 'response_type': (ResponsesAdSetId,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets/start', - 'operation_id': 'start_ad_sets', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'requests_ad_set_id', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'requests_ad_set_id': - (RequestsAdSetId,), - }, - 'attribute_map': { - }, - 'location_map': { - 'requests_ad_set_id': '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.stop_ad_sets_endpoint = _Endpoint( - settings={ - 'response_type': (ResponsesAdSetId,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/ad-sets/stop', - 'operation_id': 'stop_ad_sets', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'requests_ad_set_id', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'requests_ad_set_id': - (RequestsAdSetId,), - }, - 'attribute_map': { - }, - 'location_map': { - 'requests_ad_set_id': '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 - ) - - def get_ad_set( - self, - ad_set_id, - **kwargs - ): - """get_ad_set # noqa: E501 - - Get the data for the specified ad set # 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_ad_set(ad_set_id, async_req=True) - >>> result = thread.get() - - Args: - ad_set_id (str): Id of the ad set - - 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: - ResponseReadAdSet - 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['ad_set_id'] = \ - ad_set_id - return self.get_ad_set_endpoint.call_with_http_info(**kwargs) - - def get_campaign( - self, - campaign_id, - **kwargs - ): - """get_campaign # noqa: E501 - - Get the data for the specified campaign # 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(campaign_id, async_req=True) - >>> result = thread.get() - - Args: - campaign_id (str): Id of the campaign - - 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: - CampaignResponse - 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['campaign_id'] = \ - campaign_id - return self.get_campaign_endpoint.call_with_http_info(**kwargs) - - def get_category_bid_list( - self, - ad_set_id, - **kwargs - ): - """get_category_bid_list # noqa: E501 - - Get the Category Bids for all valid Categories associated to an Ad Set # 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_category_bid_list(ad_set_id, async_req=True) - >>> result = thread.get() - - Args: - ad_set_id (str): Id of the Ad Set - - 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: - AdSetCategoryBidListResponse - 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['ad_set_id'] = \ - ad_set_id - return self.get_category_bid_list_endpoint.call_with_http_info(**kwargs) - - def get_display_multipliers( - self, - ad_set_id, - **kwargs - ): - """get_display_multipliers # noqa: E501 - - Get the Display Multipliers for all valid Categories associated to an Ad Set # 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_display_multipliers(ad_set_id, async_req=True) - >>> result = thread.get() - - Args: - ad_set_id (str): Id of the Ad Set - - 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: - AdSetDisplayMultiplierListResponse - 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['ad_set_id'] = \ - ad_set_id - return self.get_display_multipliers_endpoint.call_with_http_info(**kwargs) - - def patch_ad_sets( - self, - **kwargs - ): - """patch_ad_sets # noqa: E501 - - Patch a list of AdSets. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_ad_sets(async_req=True) - >>> result = thread.get() - - - Keyword Args: - requests_patch_ad_set (RequestsPatchAdSet): List of adsets to patch.. [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: - ResponsesAdSetId - 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) - return self.patch_ad_sets_endpoint.call_with_http_info(**kwargs) - - def patch_campaigns( - self, - **kwargs - ): - """patch_campaigns # noqa: E501 - - Patch a list of Campaigns. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_campaigns(async_req=True) - >>> result = thread.get() - - - Keyword Args: - patch_campaign_list_request (PatchCampaignListRequest): List of campaigns to patch.. [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: - PatchResultCampaignListResponse - 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) - return self.patch_campaigns_endpoint.call_with_http_info(**kwargs) - - def patch_category_bid_list( - self, - ad_set_id, - **kwargs - ): - """patch_category_bid_list # noqa: E501 - - Patch Category Bids for one or more Categories in a single request. Partial success policy is followed. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_category_bid_list(ad_set_id, async_req=True) - >>> result = thread.get() - - Args: - ad_set_id (str): Id of the Ad Set - - Keyword Args: - patch_ad_set_category_bid_list_request (PatchAdSetCategoryBidListRequest): [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: - PatchAdSetCategoryBidResultListResponse - 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['ad_set_id'] = \ - ad_set_id - return self.patch_category_bid_list_endpoint.call_with_http_info(**kwargs) - - def patch_display_multipliers( - self, - ad_set_id, - **kwargs - ): - """patch_display_multipliers # noqa: E501 - - Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_display_multipliers(ad_set_id, async_req=True) - >>> result = thread.get() - - Args: - ad_set_id (str): Id of the Ad Set - - Keyword Args: - patch_ad_set_display_multiplier_list_request (PatchAdSetDisplayMultiplierListRequest): [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: - PatchAdSetDisplayMultiplierResultListResponse - 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['ad_set_id'] = \ - ad_set_id - return self.patch_display_multipliers_endpoint.call_with_http_info(**kwargs) - - def search_ad_sets( - self, - **kwargs - ): - """search_ad_sets # noqa: E501 - - Search for ad sets # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_ad_sets(async_req=True) - >>> result = thread.get() - - - Keyword Args: - request_ad_set_search (RequestAdSetSearch): [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: - ResponsesReadAdSet - 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) - return self.search_ad_sets_endpoint.call_with_http_info(**kwargs) - - def search_campaigns( - self, - **kwargs - ): - """search_campaigns # noqa: E501 - - Search for campaigns # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.search_campaigns(async_req=True) - >>> result = thread.get() - - - Keyword Args: - campaign_search_request (CampaignSearchRequest): filters on campaigns. [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: - CampaignListResponse - 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) - return self.search_campaigns_endpoint.call_with_http_info(**kwargs) - - def start_ad_sets( - self, - **kwargs - ): - """start_ad_sets # noqa: E501 - - Start the specified list of ad sets # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.start_ad_sets(async_req=True) - >>> result = thread.get() - - - Keyword Args: - requests_ad_set_id (RequestsAdSetId): All the ad sets to start. [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: - ResponsesAdSetId - 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) - return self.start_ad_sets_endpoint.call_with_http_info(**kwargs) - - def stop_ad_sets( - self, - **kwargs - ): - """stop_ad_sets # noqa: E501 - - Stop the specified list of ad sets # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.stop_ad_sets(async_req=True) - >>> result = thread.get() - - - Keyword Args: - requests_ad_set_id (RequestsAdSetId): All the ad sets to stop. [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: - ResponsesAdSetId - 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) - return self.stop_ad_sets_endpoint.call_with_http_info(**kwargs) - diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/gateway_api.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/gateway_api.py deleted file mode 100644 index 325adeda..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/gateway_api.py +++ /dev/null @@ -1,161 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from criteo_api_marketingsolutions_v2023_01.model.application_summary_model_response import ApplicationSummaryModelResponse - - -class GatewayApi(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.get_current_application_endpoint = _Endpoint( - settings={ - 'response_type': (ApplicationSummaryModelResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/marketing-solutions/me', - 'operation_id': 'get_current_application', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - - def get_current_application( - self, - **kwargs - ): - """get_current_application # noqa: E501 - - Get information about the currently logged application # 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_current_application(async_req=True) - >>> result = thread.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: - ApplicationSummaryModelResponse - 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) - return self.get_current_application_endpoint.call_with_http_info(**kwargs) - 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 deleted file mode 100644 index 04fa8607..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api_client.py +++ /dev/null @@ -1,898 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import json -import atexit -import mimetypes -from multiprocessing.pool import ThreadPool -import io -import os -import re -import typing -from urllib.parse import quote -from urllib3.fields import RequestField - - -from criteo_api_marketingsolutions_v2023_01 import rest -from criteo_api_marketingsolutions_v2023_01.configuration import Configuration -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiTypeError, ApiValueError, ApiException -from criteo_api_marketingsolutions_v2023_01.model_utils import ( - ModelNormal, - ModelSimple, - ModelComposed, - check_allowed_values, - check_validations, - date, - datetime, - deserialize_file, - file_type, - model_to_dict, - none_type, - validate_and_convert_types -) - - -class ApiClient(object): - """Generic API client for OpenAPI client library builds. - - OpenAPI generic API client. This client handles the client- - server communication, and is invariant across implementations. Specifics of - the methods and models for each application are generated from the OpenAPI - templates. - - NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - Do not edit the class manually. - - :param configuration: .Configuration object for this client - :param header_name: a header to pass when making calls to the API. - :param header_value: a header value to pass when making calls to - the API. - :param cookie: a cookie to include in the header when making calls - to the API - :param pool_threads: The number of threads to use for async requests - to the API. More threads means more concurrent API requests. - """ - - _pool = None - - def __init__(self, configuration=None, header_name=None, header_value=None, - cookie=None, pool_threads=1): - if configuration is None: - configuration = Configuration.get_default_copy() - self.configuration = configuration - self.pool_threads = pool_threads - - self.rest_client = rest.RESTClientObject(configuration) - self.default_headers = {} - if header_name is not None: - self.default_headers[header_name] = header_value - self.cookie = cookie - # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.01.0.240404/python' - - def __enter__(self): - return self - - def __exit__(self, exc_type, exc_value, traceback): - self.close() - - def close(self): - if self._pool: - self._pool.close() - self._pool.join() - self._pool = None - if hasattr(atexit, 'unregister'): - atexit.unregister(self.close) - - @property - def pool(self): - """Create thread pool on first request - avoids instantiating unused threadpool for blocking clients. - """ - if self._pool is None: - atexit.register(self.close) - self._pool = ThreadPool(self.pool_threads) - return self._pool - - @property - def user_agent(self): - """User agent for this API client""" - return self.default_headers['User-Agent'] - - @user_agent.setter - def user_agent(self, value): - self.default_headers['User-Agent'] = value - - def set_default_header(self, header_name, header_value): - self.default_headers[header_name] = header_value - - def __call_api( - self, - resource_path: str, - method: str, - path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - body: typing.Optional[typing.Any] = None, - post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, - response_type: typing.Optional[typing.Tuple[typing.Any]] = None, - auth_settings: typing.Optional[typing.List[str]] = None, - _return_http_data_only: typing.Optional[bool] = None, - collection_formats: typing.Optional[typing.Dict[str, str]] = None, - _preload_content: bool = True, - _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, - _host: typing.Optional[str] = None, - _check_type: typing.Optional[bool] = None, - _content_type: typing.Optional[str] = None, - _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None - ): - - config = self.configuration - - # header parameters - header_params = header_params or {} - header_params.update(self.default_headers) - if self.cookie: - header_params['Cookie'] = self.cookie - if header_params: - header_params = self.sanitize_for_serialization(header_params) - header_params = dict(self.parameters_to_tuples(header_params, - collection_formats)) - - # path parameters - if path_params: - path_params = self.sanitize_for_serialization(path_params) - path_params = self.parameters_to_tuples(path_params, - collection_formats) - for k, v in path_params: - # specified safe chars, encode everything - resource_path = resource_path.replace( - '{%s}' % k, - quote(str(v), safe=config.safe_chars_for_path_param) - ) - - # query parameters - if query_params: - query_params = self.sanitize_for_serialization(query_params) - query_params = self.parameters_to_tuples(query_params, - collection_formats) - - # post parameters - if post_params or files: - post_params = post_params if post_params else [] - post_params = self.sanitize_for_serialization(post_params) - post_params = self.parameters_to_tuples(post_params, - collection_formats) - post_params.extend(self.files_parameters(files)) - if header_params['Content-Type'].startswith("multipart"): - post_params = self.parameters_to_multipart(post_params, - (dict)) - - # body - if body: - body = self.sanitize_for_serialization(body) - - # auth setting - self.update_params_for_auth(header_params, query_params, - auth_settings, resource_path, method, body, - request_auths=_request_auths) - - # request url - if _host is None: - url = self.configuration.host + resource_path - else: - # use server/host defined in path or operation instead - url = _host + resource_path - - try: - # perform request and return response - response_data = self.request( - method, url, query_params=query_params, headers=header_params, - post_params=post_params, body=body, - _preload_content=_preload_content, - _request_timeout=_request_timeout) - except ApiException as e: - e.body = e.body.decode('utf-8') - raise e - - self.last_response = response_data - - return_data = response_data - - if not _preload_content: - return (return_data) - return return_data - - # deserialize response data - if response_type: - if response_type != (file_type,): - encoding = "utf-8" - content_type = response_data.getheader('content-type') - if content_type is not None: - match = re.search(r"charset=([a-zA-Z\-\d]+)[\s\;]?", content_type) - if match: - encoding = match.group(1) - response_data.data = response_data.data.decode(encoding) - - return_data = self.deserialize( - response_data, - response_type, - _check_type - ) - else: - return_data = None - - if _return_http_data_only: - return (return_data) - else: - return (return_data, response_data.status, - response_data.getheaders()) - - def parameters_to_multipart(self, params, collection_types): - """Get parameters as list of tuples, formatting as json if value is collection_types - - :param params: Parameters as list of two-tuples - :param dict collection_types: Parameter collection types - :return: Parameters as list of tuple or urllib3.fields.RequestField - """ - new_params = [] - if collection_types is None: - collection_types = (dict) - for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 - if isinstance( - v, collection_types): # v is instance of collection_type, formatting as application/json - v = json.dumps(v, ensure_ascii=False).encode("utf-8") - field = RequestField(k, v) - field.make_multipart(content_type="application/json; charset=utf-8") - new_params.append(field) - else: - new_params.append((k, v)) - return new_params - - @classmethod - def sanitize_for_serialization(cls, obj): - """Prepares data for transmission before it is sent with the rest client - If obj is None, return None. - If obj is str, int, long, float, bool, return directly. - If obj is datetime.datetime, datetime.date - convert to string in iso8601 format. - If obj is list, sanitize each element in the list. - If obj is dict, return the dict. - If obj is OpenAPI model, return the properties dict. - If obj is io.IOBase, return the bytes - :param obj: The data to serialize. - :return: The serialized form of data. - """ - if isinstance(obj, (ModelNormal, ModelComposed)): - return { - key: cls.sanitize_for_serialization(val) for key, - val in model_to_dict( - obj, - serialize=True).items()} - elif isinstance(obj, io.IOBase): - return cls.get_file_data_and_close_file(obj) - elif isinstance(obj, (str, int, float, none_type, bool)): - return obj - elif isinstance(obj, (datetime, date)): - return obj.isoformat() - elif isinstance(obj, ModelSimple): - return cls.sanitize_for_serialization(obj.value) - elif isinstance(obj, list): - return [cls.sanitize_for_serialization(item) for item in obj] - elif isinstance(obj, tuple): - return tuple(cls.sanitize_for_serialization(item) for item in obj) - if isinstance(obj, dict): - return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} - raise ApiValueError( - 'Unable to prepare type {} for serialization'.format( - obj.__class__.__name__)) - - def deserialize(self, response, response_type, _check_type): - """Deserializes response into an object. - - :param response: RESTResponse object to be deserialized. - :param response_type: For the response, a tuple containing: - valid classes - a list containing valid classes (for list schemas) - a dict containing a tuple of valid classes as the value - Example values: - (str,) - (Pet,) - (float, none_type) - ([int, none_type],) - ({str: (bool, str, int, float, date, datetime, str, none_type)},) - :param _check_type: boolean, whether to check the types of the data - received from the server - :type _check_type: bool - - :return: deserialized object. - """ - # handle file downloading - # save response body into a tmp file and return the instance - if response_type == (file_type,): - content_disposition = response.getheader("Content-Disposition") - return deserialize_file(response.data, self.configuration, - content_disposition=content_disposition) - - # fetch data from response object - try: - received_data = json.loads(response.data) - except ValueError: - received_data = response.data - - # store our data under the key of 'received_data' so users have some - # context if they are deserializing a string and the data type is wrong - deserialized_data = validate_and_convert_types( - received_data, - response_type, - ['received_data'], - True, - _check_type, - configuration=self.configuration - ) - return deserialized_data - - def call_api( - self, - resource_path: str, - method: str, - path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - body: typing.Optional[typing.Any] = None, - post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, - response_type: typing.Optional[typing.Tuple[typing.Any]] = None, - auth_settings: typing.Optional[typing.List[str]] = None, - async_req: typing.Optional[bool] = None, - _return_http_data_only: typing.Optional[bool] = None, - collection_formats: typing.Optional[typing.Dict[str, str]] = None, - _preload_content: bool = True, - _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, - _host: typing.Optional[str] = None, - _check_type: typing.Optional[bool] = None, - _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None - ): - """Makes the HTTP request (synchronous) and returns deserialized data. - - To make an async_req request, set the async_req parameter. - - :param resource_path: Path to method endpoint. - :param method: Method to call. - :param path_params: Path parameters in the url. - :param query_params: Query parameters in the url. - :param header_params: Header parameters to be - placed in the request header. - :param body: Request body. - :param post_params dict: Request post form parameters, - for `application/x-www-form-urlencoded`, `multipart/form-data`. - :param auth_settings list: Auth Settings names for the request. - :param response_type: For the response, a tuple containing: - valid classes - a list containing valid classes (for list schemas) - a dict containing a tuple of valid classes as the value - Example values: - (str,) - (Pet,) - (float, none_type) - ([int, none_type],) - ({str: (bool, str, int, float, date, datetime, str, none_type)},) - :param files: key -> field name, value -> a list of open file - objects for `multipart/form-data`. - :type files: dict - :param async_req bool: execute request asynchronously - :type async_req: bool, optional - :param _return_http_data_only: response data without head status code - and headers - :type _return_http_data_only: bool, optional - :param collection_formats: dict of collection formats for path, query, - header, and post parameters. - :type collection_formats: dict, optional - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :type _preload_content: bool, optional - :param _request_timeout: 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. - :param _check_type: boolean describing if the data back from the server - should have its type checked. - :type _check_type: bool, optional - :param _request_auths: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auths: list, optional - :return: - If async_req parameter is True, - the request will be called asynchronously. - The method will return the request thread. - If parameter async_req is False or missing, - then the method will return the response directly. - """ - if not async_req: - return self.__call_api(resource_path, method, - path_params, query_params, header_params, - body, post_params, files, - response_type, auth_settings, - _return_http_data_only, collection_formats, - _preload_content, _request_timeout, _host, - _check_type, _request_auths=_request_auths) - - return self.pool.apply_async(self.__call_api, (resource_path, - method, path_params, - query_params, - header_params, body, - post_params, files, - response_type, - auth_settings, - _return_http_data_only, - collection_formats, - _preload_content, - _request_timeout, - _host, _check_type, None, _request_auths)) - - def request(self, method, url, query_params=None, headers=None, - post_params=None, body=None, _preload_content=True, - _request_timeout=None): - """Makes the HTTP request using RESTClient.""" - if method == "GET": - return self.rest_client.GET(url, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - headers=headers) - elif method == "HEAD": - return self.rest_client.HEAD(url, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - headers=headers) - elif method == "OPTIONS": - return self.rest_client.OPTIONS(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "POST": - return self.rest_client.POST(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "PUT": - return self.rest_client.PUT(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "PATCH": - return self.rest_client.PATCH(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "DELETE": - return self.rest_client.DELETE(url, - query_params=query_params, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - else: - raise ApiValueError( - "http method must be `GET`, `HEAD`, `OPTIONS`," - " `POST`, `PATCH`, `PUT` or `DELETE`." - ) - - def parameters_to_tuples(self, params, collection_formats): - """Get parameters as list of tuples, formatting collections. - - :param params: Parameters as dict or list of two-tuples - :param dict collection_formats: Parameter collection formats - :return: Parameters as list of tuples, collections formatted - """ - new_params = [] - if collection_formats is None: - collection_formats = {} - for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 - if k in collection_formats: - collection_format = collection_formats[k] - if collection_format == 'multi': - new_params.extend((k, value) for value in v) - else: - if collection_format == 'ssv': - delimiter = ' ' - elif collection_format == 'tsv': - delimiter = '\t' - elif collection_format == 'pipes': - delimiter = '|' - else: # csv is the default - delimiter = ',' - new_params.append( - (k, delimiter.join(str(value) for value in v))) - else: - new_params.append((k, v)) - return new_params - - @staticmethod - def get_file_data_and_close_file(file_instance: io.IOBase) -> bytes: - file_data = file_instance.read() - file_instance.close() - return file_data - - def files_parameters(self, - files: typing.Optional[typing.Dict[str, - typing.List[io.IOBase]]] = None): - """Builds form parameters. - - :param files: None or a dict with key=param_name and - value is a list of open file objects - :return: List of tuples of form parameters with file data - """ - if files is None: - return [] - - params = [] - for param_name, file_instances in files.items(): - if file_instances is None: - # if the file field is nullable, skip None values - continue - for file_instance in file_instances: - if file_instance is None: - # if the file field is nullable, skip None values - continue - if file_instance.closed is True: - raise ApiValueError( - "Cannot read a closed file. The passed in file_type " - "for %s must be open." % param_name - ) - filename = os.path.basename(file_instance.name) - filedata = self.get_file_data_and_close_file(file_instance) - mimetype = (mimetypes.guess_type(filename)[0] or - 'application/octet-stream') - params.append( - tuple([param_name, tuple([filename, filedata, mimetype])])) - - return params - - def select_header_accept(self, accepts): - """Returns `Accept` based on an array of accepts provided. - - :param accepts: List of headers. - :return: Accept (e.g. application/json). - """ - if not accepts: - return - - accepts = [x.lower() for x in accepts] - - if 'application/json' in accepts: - return 'application/json' - else: - return ', '.join(accepts) - - def select_header_content_type(self, content_types, method=None, body=None): - """Returns `Content-Type` based on an array of content_types provided. - - :param content_types: List of content-types. - :param method: http method (e.g. POST, PATCH). - :param body: http body to send. - :return: Content-Type (e.g. application/json). - """ - if not content_types: - return None - - content_types = [x.lower() for x in content_types] - - if (method == 'PATCH' and - 'application/json-patch+json' in content_types and - isinstance(body, list)): - return 'application/json-patch+json' - - if 'application/json' in content_types or '*/*' in content_types: - return 'application/json' - else: - return content_types[0] - - def update_params_for_auth(self, headers, queries, auth_settings, - resource_path, method, body, request_auths=None): - """Updates header and query params based on authentication setting. - - :param headers: Header parameters dict to be updated. - :param queries: Query parameters tuple list to be updated. - :param auth_settings: Authentication setting identifiers list. - :param resource_path: A string representation of the HTTP request resource path. - :param method: A string representation of the HTTP request method. - :param body: A object representing the body of the HTTP request. - The object type is the return value of _encoder.default(). - :param request_auths: if set, the provided settings will - override the token in the configuration. - """ - if not auth_settings: - return - - if request_auths: - for auth_setting in request_auths: - self._apply_auth_params( - headers, queries, resource_path, method, body, auth_setting) - return - - for auth in auth_settings: - auth_setting = self.configuration.auth_settings().get(auth) - if auth_setting: - self._apply_auth_params( - headers, queries, resource_path, method, body, auth_setting) - - def _apply_auth_params(self, headers, queries, resource_path, method, body, auth_setting): - if auth_setting['in'] == 'cookie': - headers['Cookie'] = auth_setting['key'] + "=" + auth_setting['value'] - elif auth_setting['in'] == 'header': - if auth_setting['type'] != 'http-signature': - headers[auth_setting['key']] = auth_setting['value'] - elif auth_setting['in'] == 'query': - queries.append((auth_setting['key'], auth_setting['value'])) - else: - raise ApiValueError( - 'Authentication token must be in `query` or `header`' - ) - - -class Endpoint(object): - def __init__(self, settings=None, params_map=None, root_map=None, - headers_map=None, api_client=None, callable=None): - """Creates an endpoint - - Args: - settings (dict): see below key value pairs - 'response_type' (tuple/None): response type - 'auth' (list): a list of auth type keys - 'endpoint_path' (str): the endpoint path - 'operation_id' (str): endpoint string identifier - 'http_method' (str): POST/PUT/PATCH/GET etc - 'servers' (list): list of str servers that this endpoint is at - params_map (dict): see below key value pairs - 'all' (list): list of str endpoint parameter names - 'required' (list): list of required parameter names - 'nullable' (list): list of nullable parameter names - 'enum' (list): list of parameters with enum values - 'validation' (list): list of parameters with validations - root_map - 'validations' (dict): the dict mapping endpoint parameter tuple - paths to their validation dictionaries - 'allowed_values' (dict): the dict mapping endpoint parameter - tuple paths to their allowed_values (enum) dictionaries - 'openapi_types' (dict): param_name to openapi type - 'attribute_map' (dict): param_name to camelCase name - 'location_map' (dict): param_name to 'body', 'file', 'form', - 'header', 'path', 'query' - collection_format_map (dict): param_name to `csv` etc. - headers_map (dict): see below key value pairs - 'accept' (list): list of Accept header strings - 'content_type' (list): list of Content-Type header strings - api_client (ApiClient) api client instance - callable (function): the function which is invoked when the - Endpoint is called - """ - self.settings = settings - self.params_map = params_map - self.params_map['all'].extend([ - 'async_req', - '_host_index', - '_preload_content', - '_request_timeout', - '_return_http_data_only', - '_check_input_type', - '_check_return_type', - '_content_type', - '_spec_property_naming', - '_request_auths' - ]) - self.params_map['nullable'].extend(['_request_timeout']) - self.validations = root_map['validations'] - self.allowed_values = root_map['allowed_values'] - self.openapi_types = root_map['openapi_types'] - extra_types = { - 'async_req': (bool,), - '_host_index': (none_type, int), - '_preload_content': (bool,), - '_request_timeout': (none_type, float, (float,), [float], int, (int,), [int]), - '_return_http_data_only': (bool,), - '_check_input_type': (bool,), - '_check_return_type': (bool,), - '_spec_property_naming': (bool,), - '_content_type': (none_type, str), - '_request_auths': (none_type, list) - } - self.openapi_types.update(extra_types) - self.attribute_map = root_map['attribute_map'] - self.location_map = root_map['location_map'] - self.collection_format_map = root_map['collection_format_map'] - self.headers_map = headers_map - self.api_client = api_client - self.callable = callable - - def __validate_inputs(self, kwargs): - for param in self.params_map['enum']: - if param in kwargs: - check_allowed_values( - self.allowed_values, - (param,), - kwargs[param] - ) - - for param in self.params_map['validation']: - if param in kwargs: - check_validations( - self.validations, - (param,), - kwargs[param], - configuration=self.api_client.configuration - ) - - if kwargs['_check_input_type'] is False: - return - - for key, value in kwargs.items(): - fixed_val = validate_and_convert_types( - value, - self.openapi_types[key], - [key], - kwargs['_spec_property_naming'], - kwargs['_check_input_type'], - configuration=self.api_client.configuration - ) - kwargs[key] = fixed_val - - def __gather_params(self, kwargs): - params = { - 'body': None, - 'collection_format': {}, - 'file': {}, - 'form': [], - 'header': {}, - 'path': {}, - 'query': [] - } - - for param_name, param_value in kwargs.items(): - param_location = self.location_map.get(param_name) - if param_location is None: - continue - if param_location: - if param_location == 'body': - params['body'] = param_value - continue - base_name = self.attribute_map[param_name] - if (param_location == 'form' and - self.openapi_types[param_name] == (file_type,)): - params['file'][base_name] = [param_value] - elif (param_location == 'form' and - self.openapi_types[param_name] == ([file_type],)): - # param_value is already a list - params['file'][base_name] = param_value - elif param_location in {'form', 'query'}: - param_value_full = (base_name, param_value) - params[param_location].append(param_value_full) - if param_location not in {'form', 'query'}: - params[param_location][base_name] = param_value - collection_format = self.collection_format_map.get(param_name) - if collection_format: - params['collection_format'][base_name] = collection_format - - return params - - def __call__(self, *args, **kwargs): - """ This method is invoked when endpoints are called - Example: - - api_instance = AdvertiserApi() - api_instance.api_portfolio_get # this is an instance of the class Endpoint - api_instance.api_portfolio_get() # this invokes api_instance.api_portfolio_get.__call__() - which then invokes the callable functions stored in that endpoint at - api_instance.api_portfolio_get.callable or self.callable in this class - - """ - return self.callable(self, *args, **kwargs) - - def call_with_http_info(self, **kwargs): - - try: - index = self.api_client.configuration.server_operation_index.get( - self.settings['operation_id'], self.api_client.configuration.server_index - ) if kwargs['_host_index'] is None else kwargs['_host_index'] - server_variables = self.api_client.configuration.server_operation_variables.get( - self.settings['operation_id'], self.api_client.configuration.server_variables - ) - _host = self.api_client.configuration.get_host_from_settings( - index, variables=server_variables, servers=self.settings['servers'] - ) - except IndexError: - if self.settings['servers']: - raise ApiValueError( - "Invalid host index. Must be 0 <= index < %s" % - len(self.settings['servers']) - ) - _host = None - - for key, value in kwargs.items(): - if key not in self.params_map['all']: - raise ApiTypeError( - "Got an unexpected parameter '%s'" - " to method `%s`" % - (key, self.settings['operation_id']) - ) - # only throw this nullable ApiValueError if _check_input_type - # is False, if _check_input_type==True we catch this case - # in self.__validate_inputs - if (key not in self.params_map['nullable'] and value is None - and kwargs['_check_input_type'] is False): - raise ApiValueError( - "Value may not be None for non-nullable parameter `%s`" - " when calling `%s`" % - (key, self.settings['operation_id']) - ) - - for key in self.params_map['required']: - if key not in kwargs.keys(): - raise ApiValueError( - "Missing the required parameter `%s` when calling " - "`%s`" % (key, self.settings['operation_id']) - ) - - self.__validate_inputs(kwargs) - - params = self.__gather_params(kwargs) - - accept_headers_list = self.headers_map['accept'] - if accept_headers_list: - params['header']['Accept'] = self.api_client.select_header_accept( - accept_headers_list) - - if kwargs.get('_content_type'): - params['header']['Content-Type'] = kwargs['_content_type'] - else: - content_type_headers_list = self.headers_map['content_type'] - if content_type_headers_list: - if params['body'] != "": - content_types_list = self.api_client.select_header_content_type( - content_type_headers_list, self.settings['http_method'], - params['body']) - if content_types_list: - params['header']['Content-Type'] = content_types_list - - return self.api_client.call_api( - self.settings['endpoint_path'], self.settings['http_method'], - params['path'], - params['query'], - params['header'], - body=params['body'], - post_params=params['form'], - files=params['file'], - response_type=self.settings['response_type'], - auth_settings=self.settings['auth'], - async_req=kwargs['async_req'], - _check_type=kwargs['_check_return_type'], - _return_http_data_only=kwargs['_return_http_data_only'], - _preload_content=kwargs['_preload_content'], - _request_timeout=kwargs['_request_timeout'], - _host=_host, - _request_auths=kwargs['_request_auths'], - collection_formats=params['collection_format']) diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api_client_builder.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api_client_builder.py deleted file mode 100644 index 89e763f0..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api_client_builder.py +++ /dev/null @@ -1,37 +0,0 @@ -from criteo_api_marketingsolutions_v2023_01.configuration import Configuration -from criteo_api_marketingsolutions_v2023_01.criteo_api_client import CriteoApiClient -from criteo_api_marketingsolutions_v2023_01 import flow_constants - -class ApiClientBuilder : - - @staticmethod - def WithClientCredentials(clientId, clientSecret, host=None): - configuration = Configuration(username=clientId, password=clientSecret, host=host) - - return CriteoApiClient(configuration) - - @staticmethod - def WithNoAuthorization(): - - return CriteoApiClient() - - @staticmethod - def WithAuthorizationCode(clientId, clientSecret, authorization_code, redirect_uri, host=None): - configuration = Configuration(username=clientId, password=clientSecret, host=host) - additional_parameters = { - 'flow' : flow_constants.AUTHORIZATION_CODE_FLOW, - 'authorization_code': authorization_code, - 'redirect_uri': redirect_uri - } - - return CriteoApiClient(configuration = configuration, additional_parameters = additional_parameters) - - @staticmethod - def WithRefreshToken(clientId, clientSecret, refreshToken, host=None): - configuration = Configuration(username=clientId, password=clientSecret, host=host) - additional_parameters = { - 'flow' : flow_constants.REFRESH_TOKEN_FLOW, - 'refresh_token': refreshToken - } - - return CriteoApiClient(configuration = configuration, additional_parameters = additional_parameters) \ No newline at end of file diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/apis/__init__.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/apis/__init__.py deleted file mode 100644 index 42904cc7..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/apis/__init__.py +++ /dev/null @@ -1,21 +0,0 @@ - -# flake8: noqa - -# Import all APIs into this package. -# If you have many APIs here with many many models used in each API this may -# raise a `RecursionError`. -# In order to avoid this, import only the API that you directly need like: -# -# from criteo_api_marketingsolutions_v2023_01.api.advertiser_api import AdvertiserApi -# -# or import this package, but before doing it, use: -# -# import sys -# sys.setrecursionlimit(n) - -# Import APIs into API package: -from criteo_api_marketingsolutions_v2023_01.api.advertiser_api import AdvertiserApi -from criteo_api_marketingsolutions_v2023_01.api.analytics_api import AnalyticsApi -from criteo_api_marketingsolutions_v2023_01.api.audience_api import AudienceApi -from criteo_api_marketingsolutions_v2023_01.api.campaign_api import CampaignApi -from criteo_api_marketingsolutions_v2023_01.api.gateway_api import GatewayApi 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 deleted file mode 100644 index 3761708d..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/configuration.py +++ /dev/null @@ -1,461 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import copy -import logging -import multiprocessing -import sys -import urllib3 - -from http import client as http_client -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiValueError - - -JSON_SCHEMA_VALIDATION_KEYWORDS = { - 'multipleOf', 'maximum', 'exclusiveMaximum', - 'minimum', 'exclusiveMinimum', 'maxLength', - 'minLength', 'pattern', 'maxItems', 'minItems' -} - -class Configuration(object): - """NOTE: This class is auto generated by OpenAPI Generator - - Ref: https://openapi-generator.tech - Do not edit the class manually. - - :param host: Base url - :param api_key: Dict to store API key(s). - Each entry in the dict specifies an API key. - The dict key is the name of the security scheme in the OAS specification. - The dict value is the API key secret. - :param api_key_prefix: Dict to store API prefix (e.g. Bearer) - The dict key is the name of the security scheme in the OAS specification. - The dict value is an API key prefix when generating the auth data. - :param username: Username for HTTP basic authentication - :param password: Password for HTTP basic authentication - :param discard_unknown_keys: Boolean value indicating whether to discard - unknown properties. A server may send a response that includes additional - properties that are not known by the client in the following scenarios: - 1. The OpenAPI document is incomplete, i.e. it does not match the server - implementation. - 2. The client was generated using an older version of the OpenAPI document - and the server has been upgraded since then. - If a schema in the OpenAPI document defines the additionalProperties attribute, - then all undeclared properties received by the server are injected into the - additional properties map. In that case, there are undeclared properties, and - nothing to discard. - :param disabled_client_side_validations (string): Comma-separated list of - JSON schema validation keywords to disable JSON schema structural validation - rules. The following keywords may be specified: multipleOf, maximum, - exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, - maxItems, minItems. - By default, the validation is performed for data generated locally by the client - and data received from the server, independent of any validation performed by - the server side. If the input data does not satisfy the JSON schema validation - rules specified in the OpenAPI document, an exception is raised. - If disabled_client_side_validations is set, structural validation is - disabled. This can be useful to troubleshoot data validation problem, such as - when the OpenAPI document validation rules do not match the actual API data - received by the server. - :param server_index: Index to servers configuration. - :param server_variables: Mapping with string values to replace variables in - templated server configuration. The validation of enums is performed for - variables with defined enum values before. - :param server_operation_index: Mapping from operation ID to an index to server - configuration. - :param server_operation_variables: Mapping from operation ID to a mapping with - string values to replace variables in templated server configuration. - The validation of enums is performed for variables with defined enum values before. - :param ssl_ca_cert: str - the path to a file of concatenated CA certificates - in PEM format - - :Example: - """ - - _default = None - - def __init__(self, host=None, - api_key=None, api_key_prefix=None, - access_token=None, - username=None, password=None, - discard_unknown_keys=False, - disabled_client_side_validations="", - server_index=None, server_variables=None, - server_operation_index=None, server_operation_variables=None, - ssl_ca_cert=None, - ): - """Constructor - """ - self._base_path = "https://api.criteo.com" if host is None else host - """Default Base url - """ - self.server_index = 0 if server_index is None and host is None else server_index - self.server_operation_index = server_operation_index or {} - """Default server index - """ - self.server_variables = server_variables or {} - self.server_operation_variables = server_operation_variables or {} - """Default server variables - """ - self.temp_folder_path = None - """Temp file folder for downloading files - """ - # Authentication Settings - self.access_token = access_token - self.api_key = {} - if api_key: - self.api_key = api_key - """dict to store API key(s) - """ - self.api_key_prefix = {} - if api_key_prefix: - self.api_key_prefix = api_key_prefix - """dict to store API prefix (e.g. Bearer) - """ - self.refresh_api_key_hook = None - """function hook to refresh API key if expired - """ - self.username = username - """Username for HTTP basic authentication - """ - self.password = password - """Password for HTTP basic authentication - """ - self.discard_unknown_keys = discard_unknown_keys - self.disabled_client_side_validations = disabled_client_side_validations - self.logger = {} - """Logging Settings - """ - self.logger["package_logger"] = logging.getLogger("criteo_api_marketingsolutions_v2023_01") - self.logger["urllib3_logger"] = logging.getLogger("urllib3") - self.logger_format = '%(asctime)s %(levelname)s %(message)s' - """Log format - """ - self.logger_stream_handler = None - """Log stream handler - """ - self.logger_file_handler = None - """Log file handler - """ - self.logger_file = None - """Debug file location - """ - self.debug = False - """Debug switch - """ - - self.verify_ssl = True - """SSL/TLS verification - Set this to false to skip verifying SSL certificate when calling API - from https server. - """ - self.ssl_ca_cert = ssl_ca_cert - """Set this to customize the certificate file to verify the peer. - """ - self.cert_file = None - """client certificate file - """ - self.key_file = None - """client key file - """ - self.assert_hostname = None - """Set this to True/False to enable/disable SSL hostname verification. - """ - - self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 - """urllib3 connection pool's maximum number of connections saved - per pool. urllib3 uses 1 connection as default value, but this is - not the best value when you are making a lot of possibly parallel - requests to the same host, which is often the case here. - cpu_count * 5 is used as default value to increase performance. - """ - - self.proxy = None - """Proxy URL - """ - self.no_proxy = None - """bypass proxy for host in the no_proxy list. - """ - self.proxy_headers = None - """Proxy headers - """ - self.safe_chars_for_path_param = '' - """Safe chars for path_param - """ - self.retries = None - """Adding retries to override urllib3 default value 3 - """ - # Enable client side validation - self.client_side_validation = True - - # Options to pass down to the underlying urllib3 socket - self.socket_options = None - - def __deepcopy__(self, memo): - cls = self.__class__ - result = cls.__new__(cls) - memo[id(self)] = result - for k, v in self.__dict__.items(): - if k not in ('logger', 'logger_file_handler'): - setattr(result, k, copy.deepcopy(v, memo)) - # shallow copy of loggers - result.logger = copy.copy(self.logger) - # use setters to configure loggers - result.logger_file = self.logger_file - result.debug = self.debug - return result - - def __setattr__(self, name, value): - object.__setattr__(self, name, value) - if name == 'disabled_client_side_validations': - s = set(filter(None, value.split(','))) - for v in s: - if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: - raise ApiValueError( - "Invalid keyword: '{0}''".format(v)) - self._disabled_client_side_validations = s - - @classmethod - def set_default(cls, default): - """Set default instance of configuration. - - It stores default configuration, which can be - returned by get_default_copy method. - - :param default: object of Configuration - """ - cls._default = copy.deepcopy(default) - - @classmethod - def get_default_copy(cls): - """Return new instance of configuration. - - This method returns newly created, based on default constructor, - object of Configuration class or returns a copy of default - configuration passed by the set_default method. - - :return: The configuration object. - """ - if cls._default is not None: - return copy.deepcopy(cls._default) - return Configuration() - - @property - def logger_file(self): - """The logger file. - - If the logger_file is None, then add stream handler and remove file - handler. Otherwise, add file handler and remove stream handler. - - :param value: The logger_file path. - :type: str - """ - return self.__logger_file - - @logger_file.setter - def logger_file(self, value): - """The logger file. - - If the logger_file is None, then add stream handler and remove file - handler. Otherwise, add file handler and remove stream handler. - - :param value: The logger_file path. - :type: str - """ - self.__logger_file = value - if self.__logger_file: - # If set logging file, - # then add file handler and remove stream handler. - self.logger_file_handler = logging.FileHandler(self.__logger_file) - self.logger_file_handler.setFormatter(self.logger_formatter) - for _, logger in self.logger.items(): - logger.addHandler(self.logger_file_handler) - - @property - def debug(self): - """Debug status - - :param value: The debug status, True or False. - :type: bool - """ - return self.__debug - - @debug.setter - def debug(self, value): - """Debug status - - :param value: The debug status, True or False. - :type: bool - """ - self.__debug = value - if self.__debug: - # if debug status is True, turn on debug logging - for _, logger in self.logger.items(): - logger.setLevel(logging.DEBUG) - # turn on http_client debug - http_client.HTTPConnection.debuglevel = 1 - else: - # if debug status is False, turn off debug logging, - # setting log level to default `logging.WARNING` - for _, logger in self.logger.items(): - logger.setLevel(logging.WARNING) - # turn off http_client debug - http_client.HTTPConnection.debuglevel = 0 - - @property - def logger_format(self): - """The logger format. - - The logger_formatter will be updated when sets logger_format. - - :param value: The format string. - :type: str - """ - return self.__logger_format - - @logger_format.setter - def logger_format(self, value): - """The logger format. - - The logger_formatter will be updated when sets logger_format. - - :param value: The format string. - :type: str - """ - self.__logger_format = value - self.logger_formatter = logging.Formatter(self.__logger_format) - - def get_api_key_with_prefix(self, identifier, alias=None): - """Gets API key (with prefix if set). - - :param identifier: The identifier of apiKey. - :param alias: The alternative identifier of apiKey. - :return: The token for api key authentication. - """ - if self.refresh_api_key_hook is not None: - self.refresh_api_key_hook(self) - key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) - if key: - prefix = self.api_key_prefix.get(identifier) - if prefix: - return "%s %s" % (prefix, key) - else: - return key - - def get_basic_auth_token(self): - """Gets HTTP basic authentication header (string). - - :return: The token for basic HTTP authentication. - """ - username = "" - if self.username is not None: - username = self.username - password = "" - if self.password is not None: - password = self.password - return urllib3.util.make_headers( - basic_auth=username + ':' + password - ).get('authorization') - - def auth_settings(self): - """Gets Auth Settings dict for api client. - - :return: The Auth Settings information dict. - """ - auth = {} - if self.access_token is not None: - auth['oauth'] = { - 'type': 'oauth2', - 'in': 'header', - 'key': 'Authorization', - 'value': 'Bearer ' + self.access_token - } - if self.access_token is not None: - auth['oauth'] = { - 'type': 'oauth2', - 'in': 'header', - 'key': 'Authorization', - 'value': 'Bearer ' + self.access_token - } - return auth - - def to_debug_report(self): - """Gets the essential information for debugging. - - :return: The report for debugging. - """ - return "Python SDK Debug Report:\n"\ - "OS: {env}\n"\ - "Python Version: {pyversion}\n"\ - "Version of the API: 2023-01\n"\ - "SDK Package Version: 2023.01.0.240404".\ - format(env=sys.platform, pyversion=sys.version) - - def get_host_settings(self): - """Gets an array of host settings - - :return: An array of host settings - """ - return [ - { - 'url': "https://api.criteo.com", - 'description': "No description provided", - } - ] - - def get_host_from_settings(self, index, variables=None, servers=None): - """Gets host URL based on the index and variables - :param index: array index of the host settings - :param variables: hash of variable and the corresponding value - :param servers: an array of host settings or None - :return: URL based on host settings - """ - if index is None: - return self._base_path - - variables = {} if variables is None else variables - servers = self.get_host_settings() if servers is None else servers - - try: - server = servers[index] - except IndexError: - raise ValueError( - "Invalid index {0} when selecting the host settings. " - "Must be less than {1}".format(index, len(servers))) - - url = server['url'] - - # go through variables and replace placeholders - for variable_name, variable in server.get('variables', {}).items(): - used_value = variables.get( - variable_name, variable['default_value']) - - if 'enum_values' in variable \ - and used_value not in variable['enum_values']: - raise ValueError( - "The variable `{0}` in the host URL has invalid value " - "{1}. Must be {2}.".format( - variable_name, variables[variable_name], - variable['enum_values'])) - - url = url.replace("{" + variable_name + "}", used_value) - - return url - - @property - def host(self): - """Return generated host.""" - return self.get_host_from_settings(self.server_index, variables=self.server_variables) - - @host.setter - def host(self, value): - """Fix base path.""" - self._base_path = value - self.server_index = None diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_api_client.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_api_client.py deleted file mode 100644 index 3dcb756c..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_api_client.py +++ /dev/null @@ -1,11 +0,0 @@ -from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient -from criteo_api_marketingsolutions_v2023_01.criteo_rest import CriteoRESTClientObject - -class CriteoApiClient(ApiClient): - def __init__(self, configuration=None, header_name=None, header_value=None, - cookie=None, pool_threads=1, additional_parameters= {}): - super().__init__(configuration=configuration,header_name=header_name, header_value=header_value, cookie=cookie, pool_threads=pool_threads) - self.rest_client = CriteoRESTClientObject(self.configuration, additional_parameters) - - def get_refresh_token(self): - return self.rest_client.get_refresh_token() \ No newline at end of file diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_auth.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_auth.py deleted file mode 100644 index 665c3186..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_auth.py +++ /dev/null @@ -1,121 +0,0 @@ -import json -from datetime import datetime, timedelta -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiException -from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient -from criteo_api_marketingsolutions_v2023_01 import flow_constants - -class Token(object): - - def __init__(self, token_string , expiration_date = None): - self.expiration_date = expiration_date - self.token_string = token_string - - def has_expired(self): - if not self.expiration_date: - return False - return self.expiration_date > datetime.utcnow() - -class BasicAuth(object): - - def __init__(self, token_string): - self.token = Token(token_string) - - def get_token(self, client : ApiClient, headers) -> str: - return self.token - -class RetryingOAuth(object): - - def __init__(self, grant_type, client_id, client_secret): - self.grant_type = grant_type - self.client_id = client_id - self.client_secret = client_secret - self.token = None - self.refreshToken = None - - def get_token(self, client : ApiClient, headers) -> str: - if self.token and not self.token.has_expired(): - self.token = None - if self.grant_type == flow_constants.AUTHORIZATION_CODE_FLOW: - self.grant_type = flow_constants.REFRESH_TOKEN_FLOW - - if self.token is None: - self.refresh_token(client, headers) - - return self.token - - def refresh_token(self, client : ApiClient, headers, parameters_dict= {}): - oauth_url = client.host + '/oauth2/token' - new_headers = {'Accept': 'application/json', - 'Content-Type': 'application/x-www-form-urlencoded', - 'User-Agent': headers['User-Agent']} - params = dict(parameters_dict, **{ - 'client_id': self.client_id, - 'client_secret': self.client_secret, - 'grant_type' : self.grant_type - }) - try: - if self.grant_type == flow_constants.REFRESH_TOKEN_FLOW: - params['refresh_token'] = self.refreshToken - - response = client.request('POST', oauth_url, - headers=new_headers, - query_params=[], - post_params=list(params.items()), - _preload_content=True, - _request_timeout=None, - body=None, - no_auth=True) - data = json.loads(response.data) - self.token = Token('Bearer '+ (data['access_token'] or ''), - RetryingOAuth.compute_expiration_date(data['expires_in'])) - self.refreshToken = data['refresh_token'] - - return self.token - except ApiException as e: - raise self._enrich_exception_message(e, oauth_url) - - def get_refresh_token(self): - return self.refreshToken - - def _enrich_exception_message(self, e, url): - try: - data = json.loads(e.body or {}) - except ValueError: - data = {} - data['token_error'] = "Cannot refresh token by calling '" + url + "'" - e.body = json.dumps(data).encode() - return e - - @staticmethod - def compute_expiration_date(expires_in): - return datetime.utcnow() + timedelta(seconds=int(expires_in) + 15) - -class RetryingClientCredentials(RetryingOAuth): - - def __init__(self, client_id, client_secret): - super().__init__(flow_constants.CLIENT_CREDENTIALS_FLOW, client_id, client_secret) - -class RetryingAuthorizationCode(RetryingOAuth): - def __init__(self, client_id, client_secret, code, redirect_uri): - super().__init__(flow_constants.AUTHORIZATION_CODE_FLOW, client_id, client_secret) - self.authorization_code = code - self.redirect_uri = redirect_uri - - def refresh_token(self, client : ApiClient, headers, parameters_dict= {}): - params = dict(parameters_dict, **{ - 'code' : self.authorization_code, - 'redirect_uri' : self.redirect_uri - }) - return super().refresh_token(client, headers, params) - -class RetryingRefreshToken(RetryingOAuth): - - def __init__(self, client_id, client_secret, refresh_token): - super().__init__(flow_constants.REFRESH_TOKEN_FLOW, client_id, client_secret) - self.refreshToken = refresh_token - - def refresh_token(self, client: ApiClient, headers, parameters_dict = {}): - params = dict(parameters_dict, **{ - 'refresh_token' : self.refreshToken - }) - return super().refresh_token(client, headers,params) diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_rest.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_rest.py deleted file mode 100644 index 880c83bb..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/criteo_rest.py +++ /dev/null @@ -1,75 +0,0 @@ -from criteo_api_marketingsolutions_v2023_01.rest import RESTClientObject -from criteo_api_marketingsolutions_v2023_01.criteo_auth import * -from criteo_api_marketingsolutions_v2023_01 import flow_constants - - -class CriteoRESTClientObject(RESTClientObject): - - def __init__(self, configuration, additional_parameters = {}, pools_size=4, maxsize=None): - super().__init__(configuration, pools_size, maxsize) - - self.host = configuration.host - client_id = configuration.username - client_secret = configuration.password - - grant_type = additional_parameters.get('flow', 'client_credentials') - if grant_type == flow_constants.AUTHORIZATION_CODE_FLOW : - self.authorization = RetryingAuthorizationCode( - client_id, - client_secret, - additional_parameters.get('authorization_code',''), - additional_parameters.get('redirect_uri','') - ) - elif grant_type == flow_constants.REFRESH_TOKEN_FLOW : - self.authorization = RetryingRefreshToken( - client_id, - client_secret, - additional_parameters.get('refresh_token', '') - ) - else: - self.authorization = RetryingClientCredentials( - client_id, - client_secret - ) - - def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None, _preload_content=True, - _request_timeout=None): - return self.request(method, url, query_params, headers, body,post_params, _preload_content, _request_timeout, no_auth=False) - - def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None, _preload_content=True, - _request_timeout=None, no_auth=False): - """Perform requests. - - :param method: http request method - :param url: http request url - :param query_params: query parameters in the url - :param headers: http request headers - :param body: request json body, for `application/json` - :param post_params: request post parameters, - `application/x-www-form-urlencoded` - and `multipart/form-data` - :param no_auth: if True, token is not refreshed - and authorization header is not set - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: 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. - """ - - headers = headers or {} - if not no_auth: - token = self.authorization.get_token(self, headers) - headers['Authorization'] = token.token_string - - if 'Content-Type' not in headers: - headers['Content-Type'] = 'application/json' - - return super().request(method, url, query_params, headers, body, post_params, _preload_content, _request_timeout) - - def get_refresh_token(self): - return self.authorization.get_refresh_token() \ No newline at end of file diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/exceptions.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/exceptions.py deleted file mode 100644 index 324a3832..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/exceptions.py +++ /dev/null @@ -1,158 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -class OpenApiException(Exception): - """The base exception class for all OpenAPIExceptions""" - - -class ApiTypeError(OpenApiException, TypeError): - def __init__(self, msg, path_to_item=None, valid_classes=None, - key_type=None): - """ Raises an exception for TypeErrors - - Args: - msg (str): the exception message - - Keyword Args: - path_to_item (list): a list of keys an indices to get to the - current_item - None if unset - valid_classes (tuple): the primitive classes that current item - should be an instance of - None if unset - key_type (bool): False if our value is a value in a dict - True if it is a key in a dict - False if our item is an item in a list - None if unset - """ - self.path_to_item = path_to_item - self.valid_classes = valid_classes - self.key_type = key_type - full_msg = msg - if path_to_item: - full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) - super(ApiTypeError, self).__init__(full_msg) - - -class ApiValueError(OpenApiException, ValueError): - def __init__(self, msg, path_to_item=None): - """ - Args: - msg (str): the exception message - - Keyword Args: - path_to_item (list) the path to the exception in the - received_data dict. None if unset - """ - - self.path_to_item = path_to_item - full_msg = msg - if path_to_item: - full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) - super(ApiValueError, self).__init__(full_msg) - - -class ApiAttributeError(OpenApiException, AttributeError): - def __init__(self, msg, path_to_item=None): - """ - Raised when an attribute reference or assignment fails. - - Args: - msg (str): the exception message - - Keyword Args: - path_to_item (None/list) the path to the exception in the - received_data dict - """ - self.path_to_item = path_to_item - full_msg = msg - if path_to_item: - full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) - super(ApiAttributeError, self).__init__(full_msg) - - -class ApiKeyError(OpenApiException, KeyError): - def __init__(self, msg, path_to_item=None): - """ - Args: - msg (str): the exception message - - Keyword Args: - path_to_item (None/list) the path to the exception in the - received_data dict - """ - self.path_to_item = path_to_item - full_msg = msg - if path_to_item: - full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) - super(ApiKeyError, self).__init__(full_msg) - - -class ApiException(OpenApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - if http_resp: - self.status = http_resp.status - self.reason = http_resp.reason - self.body = http_resp.data - self.headers = http_resp.getheaders() - else: - self.status = status - self.reason = reason - self.body = None - self.headers = None - - def __str__(self): - """Custom error messages for exception""" - error_message = "Status Code: {0}\n"\ - "Reason: {1}\n".format(self.status, self.reason) - if self.headers: - error_message += "HTTP response headers: {0}\n".format( - self.headers) - - if self.body: - error_message += "HTTP response body: {0}\n".format(self.body) - - return error_message - - -class NotFoundException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(NotFoundException, self).__init__(status, reason, http_resp) - - -class UnauthorizedException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(UnauthorizedException, self).__init__(status, reason, http_resp) - - -class ForbiddenException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(ForbiddenException, self).__init__(status, reason, http_resp) - - -class ServiceException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(ServiceException, self).__init__(status, reason, http_resp) - - -def render_path(path_to_item): - """Returns a string representation of a path""" - result = "" - for pth in path_to_item: - if isinstance(pth, int): - result += "[{0}]".format(pth) - else: - result += "['{0}']".format(pth) - return result diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/__init__.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/__init__.py deleted file mode 100644 index eb09c35f..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -# we can not import model classes here because that would create a circular -# reference which would not work in python2 -# do not import all models into this module because that uses a lot of memory and stack frames -# if you need the ability to import all models from one package, import them with -# from criteo_api_marketingsolutions_v2023_01.models import ModelA, ModelB diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_search_filter.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_search_filter.py deleted file mode 100644 index c7bd9e78..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_search_filter.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class AdSetSearchFilter(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 { - 'ad_set_ids': ([str], none_type,), # noqa: E501 - 'advertiser_ids': ([str], none_type,), # noqa: E501 - 'campaign_ids': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'ad_set_ids': 'adSetIds', # noqa: E501 - 'advertiser_ids': 'advertiserIds', # noqa: E501 - 'campaign_ids': 'campaignIds', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AdSetSearchFilter - 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,) - ad_set_ids ([str], none_type): [optional] # noqa: E501 - advertiser_ids ([str], none_type): [optional] # noqa: E501 - campaign_ids ([str], 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 - """AdSetSearchFilter - 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,) - ad_set_ids ([str], none_type): [optional] # noqa: E501 - advertiser_ids ([str], none_type): [optional] # noqa: E501 - campaign_ids ([str], 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model.py deleted file mode 100644 index 98cbf9e1..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class ApplicationSummaryModel(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 { - 'application_id': (int, none_type,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - 'organization_id': (int, none_type,), # noqa: E501 - 'description': (str, none_type,), # noqa: E501 - 'criteo_service': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'application_id': 'applicationId', # noqa: E501 - 'name': 'name', # noqa: E501 - 'organization_id': 'organizationId', # noqa: E501 - 'description': 'description', # noqa: E501 - 'criteo_service': 'criteoService', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ApplicationSummaryModel - 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,) - application_id (int, none_type): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - organization_id (int, none_type): [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - criteo_service (str, 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 - """ApplicationSummaryModel - 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,) - application_id (int, none_type): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - organization_id (int, none_type): [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - criteo_service (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model_resource.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model_resource.py deleted file mode 100644 index 1cd2e54a..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model_resource.py +++ /dev/null @@ -1,273 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.application_summary_model import ApplicationSummaryModel - globals()['ApplicationSummaryModel'] = ApplicationSummaryModel - - -class ApplicationSummaryModelResource(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': (ApplicationSummaryModel,), # 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 - """ApplicationSummaryModelResource - 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 (ApplicationSummaryModel): [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 - """ApplicationSummaryModelResource - 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 (ApplicationSummaryModel): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model_response.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model_response.py deleted file mode 100644 index d4a1c6ed..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/application_summary_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.application_summary_model_resource import ApplicationSummaryModelResource - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - globals()['ApplicationSummaryModelResource'] = ApplicationSummaryModelResource - globals()['CommonProblem'] = CommonProblem - - -class ApplicationSummaryModelResponse(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 = { - ('warnings',): { - }, - ('errors',): { - }, - } - - @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': (ApplicationSummaryModelResource,), # noqa: E501 - 'warnings': ([CommonProblem], none_type,), # noqa: E501 - 'errors': ([CommonProblem], none_type,), # 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 - """ApplicationSummaryModelResponse - 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 (ApplicationSummaryModelResource): [optional] # noqa: E501 - warnings ([CommonProblem], none_type): [optional] # noqa: E501 - errors ([CommonProblem], 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 - """ApplicationSummaryModelResponse - 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 (ApplicationSummaryModelResource): [optional] # noqa: E501 - warnings ([CommonProblem], none_type): [optional] # noqa: E501 - errors ([CommonProblem], 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience.py deleted file mode 100644 index af0b139c..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_attributes import AudienceAttributes - globals()['AudienceAttributes'] = AudienceAttributes - - -class Audience(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,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'attributes': (AudienceAttributes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, id, attributes, *args, **kwargs): # noqa: E501 - """Audience - a model defined in OpenAPI - - Args: - type (str): the name of the entity type - id (str): id of the Audience - attributes (AudienceAttributes): - - 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.type = type - self.id = id - self.attributes = attributes - 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, type, id, attributes, *args, **kwargs): # noqa: E501 - """Audience - a model defined in OpenAPI - - Args: - type (str): the name of the entity type - id (str): id of the Audience - attributes (AudienceAttributes): - - 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.type = type - self.id = id - self.attributes = attributes - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_attributes.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_attributes.py deleted file mode 100644 index 6115db61..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_attributes.py +++ /dev/null @@ -1,303 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class AudienceAttributes(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,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'created': (datetime,), # noqa: E501 - 'updated': (datetime,), # noqa: E501 - 'advertiser_id': (str, none_type,), # noqa: E501 - 'nb_lines': (int, none_type,), # noqa: E501 - 'nb_lines_email': (int, none_type,), # noqa: E501 - 'nb_matches_email': (int, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'description': 'description', # noqa: E501 - 'created': 'created', # noqa: E501 - 'updated': 'updated', # noqa: E501 - 'advertiser_id': 'advertiserId', # noqa: E501 - 'nb_lines': 'nbLines', # noqa: E501 - 'nb_lines_email': 'nbLinesEmail', # noqa: E501 - 'nb_matches_email': 'nbMatchesEmail', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, description, created, updated, *args, **kwargs): # noqa: E501 - """AudienceAttributes - a model defined in OpenAPI - - Args: - name (str): The name of the Audience - description (str): The string description of the Audience - created (datetime): Date and time ISO 8601 formatted string - updated (datetime): Date and time ISO 8601 formatted string - - 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,) - advertiser_id (str, none_type): The advertiser id that owns this Audience. [optional] # noqa: E501 - nb_lines (int, none_type): The number of line in the audience available once processed. [optional] # noqa: E501 - nb_lines_email (int, none_type): The number of email line in the audience available once processed. [optional] # noqa: E501 - nb_matches_email (int, none_type): The number of email matches in the audience available once processed. [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.name = name - self.description = description - self.created = created - self.updated = updated - 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, name, description, created, updated, *args, **kwargs): # noqa: E501 - """AudienceAttributes - a model defined in OpenAPI - - Args: - name (str): The name of the Audience - description (str): The string description of the Audience - created (datetime): Date and time ISO 8601 formatted string - updated (datetime): Date and time ISO 8601 formatted string - - 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,) - advertiser_id (str, none_type): The advertiser id that owns this Audience. [optional] # noqa: E501 - nb_lines (int, none_type): The number of line in the audience available once processed. [optional] # noqa: E501 - nb_lines_email (int, none_type): The number of email line in the audience available once processed. [optional] # noqa: E501 - nb_matches_email (int, none_type): The number of email matches in the audience available once processed. [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.name = name - self.description = description - self.created = created - self.updated = updated - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_error.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_error.py deleted file mode 100644 index 7dcacb48..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_error.py +++ /dev/null @@ -1,310 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class AudienceError(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 = { - ('type',): { - 'ACCESS-CONTROL': "access-control", - 'AUTHENTICATION': "authentication", - 'AUTHORIZATION': "authorization", - 'AVAILABILITY': "availability", - 'DEPRECATION': "deprecation", - 'QUOTA': "quota", - 'VALIDATION': "validation", - }, - } - - 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 { - 'type': (str,), # noqa: E501 - 'code': (str,), # noqa: E501 - 'instance': (str,), # noqa: E501 - 'trace_id': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'source': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 - 'stack_trace': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'code': 'code', # noqa: E501 - 'instance': 'instance', # noqa: E501 - 'trace_id': 'traceId', # noqa: E501 - 'title': 'title', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, code, instance, *args, **kwargs): # noqa: E501 - """AudienceError - a model defined in OpenAPI - - Args: - type (str): (REQUIRED) The classification of the error - code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. - instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem - - 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,) - trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 - detail (str, none_type): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type - self.code = code - self.instance = instance - 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, type, code, instance, *args, **kwargs): # noqa: E501 - """AudienceError - a model defined in OpenAPI - - Args: - type (str): (REQUIRED) The classification of the error - code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. - instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem - - 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,) - trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 - detail (str, none_type): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type - self.code = code - self.instance = instance - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_warning.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_warning.py deleted file mode 100644 index ae43dd5c..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_warning.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class AudienceWarning(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 = { - ('type',): { - 'ACCESS-CONTROL': "access-control", - 'AUTHENTICATION': "authentication", - 'AUTHORIZATION': "authorization", - 'AVAILABILITY': "availability", - 'DEPRECATION': "deprecation", - 'QUOTA': "quota", - 'VALIDATION': "validation", - }, - } - - 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 { - 'type': (str,), # noqa: E501 - 'code': (str,), # noqa: E501 - 'instance': (str,), # noqa: E501 - 'detail': (str,), # noqa: E501 - 'trace_id': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'source': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 - 'stack_trace': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'code': 'code', # noqa: E501 - 'instance': 'instance', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'trace_id': 'traceId', # noqa: E501 - 'title': 'title', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, code, instance, detail, *args, **kwargs): # noqa: E501 - """AudienceWarning - a model defined in OpenAPI - - Args: - type (str): (REQUIRED) The classification of the error - code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. - instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem - detail (str): (REQUIRED) A human-readable explanation specific to this occurrence of the problem - - 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,) - trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 - source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type - self.code = code - self.instance = instance - 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, type, code, instance, detail, *args, **kwargs): # noqa: E501 - """AudienceWarning - a model defined in OpenAPI - - Args: - type (str): (REQUIRED) The classification of the error - code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. - instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem - detail (str): (REQUIRED) A human-readable explanation specific to this occurrence of the problem - - 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,) - trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 - source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type - self.code = code - self.instance = instance - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign.py deleted file mode 100644 index ef23dfe0..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.campaign_spend_limit import CampaignSpendLimit - globals()['CampaignSpendLimit'] = CampaignSpendLimit - - -class Campaign(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 = { - ('goal',): { - 'None': None, - 'UNSPECIFIED': "Unspecified", - 'ACQUISITION': "Acquisition", - 'RETENTION': "Retention", - }, - } - - 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 { - 'name': (str, none_type,), # noqa: E501 - 'advertiser_id': (str, none_type,), # noqa: E501 - 'objective': (str, none_type,), # noqa: E501 - 'spend_limit': (CampaignSpendLimit,), # noqa: E501 - 'goal': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'advertiser_id': 'advertiserId', # noqa: E501 - 'objective': 'objective', # noqa: E501 - 'spend_limit': 'spendLimit', # noqa: E501 - 'goal': 'goal', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Campaign - 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): [optional] # noqa: E501 - advertiser_id (str, none_type): [optional] # noqa: E501 - objective (str, none_type): [optional] # noqa: E501 - spend_limit (CampaignSpendLimit): [optional] # noqa: E501 - goal (str, 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 - """Campaign - 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): [optional] # noqa: E501 - advertiser_id (str, none_type): [optional] # noqa: E501 - objective (str, none_type): [optional] # noqa: E501 - spend_limit (CampaignSpendLimit): [optional] # noqa: E501 - goal (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_list_response.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_list_response.py deleted file mode 100644 index d7d6d2e6..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_list_response.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.campaign_read_resource import CampaignReadResource - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - globals()['CampaignReadResource'] = CampaignReadResource - globals()['CommonProblem'] = CommonProblem - - -class CampaignListResponse(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': ([CampaignReadResource], none_type,), # noqa: E501 - 'warnings': ([CommonProblem], none_type,), # noqa: E501 - 'errors': ([CommonProblem], none_type,), # 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 = { - 'data', # noqa: E501 - 'warnings', # noqa: E501 - 'errors', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CampaignListResponse - 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 ([CampaignReadResource], 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) - _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 - """CampaignListResponse - 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 ([CampaignReadResource], 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) - _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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_read_resource.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_read_resource.py deleted file mode 100644 index 7b74d9dc..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_read_resource.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.campaign import Campaign - globals()['Campaign'] = Campaign - - -class CampaignReadResource(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 { - 'id': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'attributes': (Campaign,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - 'id', # noqa: E501 - 'type', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CampaignReadResource - 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,) - id (str, none_type): Id of the entity. [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - attributes (Campaign): [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 - """CampaignReadResource - 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,) - id (str, none_type): Id of the entity. [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - attributes (Campaign): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_response.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_response.py deleted file mode 100644 index cb367cc2..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_response.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.campaign_read_resource import CampaignReadResource - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - globals()['CampaignReadResource'] = CampaignReadResource - globals()['CommonProblem'] = CommonProblem - - -class CampaignResponse(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': (CampaignReadResource,), # noqa: E501 - 'warnings': ([CommonProblem], none_type,), # noqa: E501 - 'errors': ([CommonProblem], none_type,), # 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 - """CampaignResponse - 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 (CampaignReadResource): [optional] # noqa: E501 - warnings ([CommonProblem], none_type): [optional] # noqa: E501 - errors ([CommonProblem], 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 - """CampaignResponse - 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 (CampaignReadResource): [optional] # noqa: E501 - warnings ([CommonProblem], none_type): [optional] # noqa: E501 - errors ([CommonProblem], 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_search_filters.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_search_filters.py deleted file mode 100644 index 4caadaf5..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_search_filters.py +++ /dev/null @@ -1,267 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class CampaignSearchFilters(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 { - 'campaign_ids': ([str], none_type,), # noqa: E501 - 'advertiser_ids': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'campaign_ids': 'campaignIds', # noqa: E501 - 'advertiser_ids': 'advertiserIds', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CampaignSearchFilters - 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,) - campaign_ids ([str], none_type): [optional] # noqa: E501 - advertiser_ids ([str], 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 - """CampaignSearchFilters - 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,) - campaign_ids ([str], none_type): [optional] # noqa: E501 - advertiser_ids ([str], 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_search_request.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_search_request.py deleted file mode 100644 index 82bf18f4..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_search_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.campaign_search_filters import CampaignSearchFilters - globals()['CampaignSearchFilters'] = CampaignSearchFilters - - -class CampaignSearchRequest(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 { - 'filters': (CampaignSearchFilters,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filters': 'filters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CampaignSearchRequest - 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,) - filters (CampaignSearchFilters): [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 - """CampaignSearchRequest - 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,) - filters (CampaignSearchFilters): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_spend_limit.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_spend_limit.py deleted file mode 100644 index 91b83314..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/campaign_spend_limit.py +++ /dev/null @@ -1,289 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_decimal import NillableDecimal - globals()['NillableDecimal'] = NillableDecimal - - -class CampaignSpendLimit(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 = { - ('spend_limit_type',): { - 'None': None, - 'CAPPED': "capped", - 'UNCAPPED': "uncapped", - }, - ('spend_limit_renewal',): { - 'None': None, - 'UNDEFINED': "undefined", - 'DAILY': "daily", - 'MONTHLY': "monthly", - 'LIFETIME': "lifetime", - }, - } - - 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 { - 'spend_limit_type': (str, none_type,), # noqa: E501 - 'spend_limit_renewal': (str, none_type,), # noqa: E501 - 'spend_limit_amount': (NillableDecimal,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'spend_limit_type': 'spendLimitType', # noqa: E501 - 'spend_limit_renewal': 'spendLimitRenewal', # noqa: E501 - 'spend_limit_amount': 'spendLimitAmount', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CampaignSpendLimit - 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,) - spend_limit_type (str, none_type): [optional] # noqa: E501 - spend_limit_renewal (str, none_type): [optional] # noqa: E501 - spend_limit_amount (NillableDecimal): [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 - """CampaignSpendLimit - 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,) - spend_limit_type (str, none_type): [optional] # noqa: E501 - spend_limit_renewal (str, none_type): [optional] # noqa: E501 - spend_limit_amount (NillableDecimal): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/common_problem.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/common_problem.py deleted file mode 100644 index f8b66e20..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/common_problem.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class CommonProblem(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 = { - ('type',): { - 'None': None, - 'UNKNOWN': "unknown", - 'ACCESS-CONTROL': "access-control", - 'AUTHENTICATION': "authentication", - 'AUTHORIZATION': "authorization", - 'AVAILABILITY': "availability", - 'DEPRECATION': "deprecation", - 'QUOTA': "quota", - 'VALIDATION': "validation", - }, - } - - 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, none_type,), # noqa: E501 - 'trace_identifier': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'code': (str, none_type,), # noqa: E501 - 'instance': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'source': ({str: (str,)}, none_type,), # noqa: E501 - 'stack_trace': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_id': 'traceId', # noqa: E501 - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'type': 'type', # noqa: E501 - 'code': 'code', # noqa: E501 - 'instance': 'instance', # noqa: E501 - 'title': 'title', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CommonProblem - 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,) - trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 - trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 - type (str, none_type): The problem's category.. [optional] # noqa: E501 - code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 - instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 - detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace (str, 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 - """CommonProblem - 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,) - trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 - trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 - type (str, none_type): The problem's category.. [optional] # noqa: E501 - code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 - instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 - detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/delete_audience_response.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/delete_audience_response.py deleted file mode 100644 index 5054188f..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/delete_audience_response.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_error import AudienceError - from criteo_api_marketingsolutions_v2023_01.model.audience_warning import AudienceWarning - from criteo_api_marketingsolutions_v2023_01.model.basic_audience_definition import BasicAudienceDefinition - globals()['AudienceError'] = AudienceError - globals()['AudienceWarning'] = AudienceWarning - globals()['BasicAudienceDefinition'] = BasicAudienceDefinition - - -class DeleteAudienceResponse(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': (BasicAudienceDefinition,), # noqa: E501 - 'errors': ([AudienceError],), # noqa: E501 - 'warnings': ([AudienceWarning],), # 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, errors, warnings, *args, **kwargs): # noqa: E501 - """DeleteAudienceResponse - a model defined in OpenAPI - - Args: - data (BasicAudienceDefinition): - errors ([AudienceError]): - warnings ([AudienceWarning]): - - 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.data = data - 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 \ - 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, errors, warnings, *args, **kwargs): # noqa: E501 - """DeleteAudienceResponse - a model defined in OpenAPI - - Args: - data (BasicAudienceDefinition): - errors ([AudienceError]): - warnings ([AudienceWarning]): - - 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.data = data - 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 \ - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/error_code_response.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/error_code_response.py deleted file mode 100644 index 58df6181..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/error_code_response.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_error import AudienceError - from criteo_api_marketingsolutions_v2023_01.model.audience_warning import AudienceWarning - globals()['AudienceError'] = AudienceError - globals()['AudienceWarning'] = AudienceWarning - - -class ErrorCodeResponse(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 { - 'errors': ([AudienceError],), # noqa: E501 - 'warnings': ([AudienceWarning], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - '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, errors, *args, **kwargs): # noqa: E501 - """ErrorCodeResponse - a model defined in OpenAPI - - Args: - errors ([AudienceError]): - - 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,) - warnings ([AudienceWarning], 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.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, errors, *args, **kwargs): # noqa: E501 - """ErrorCodeResponse - a model defined in OpenAPI - - Args: - errors ([AudienceError]): - - 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,) - warnings ([AudienceWarning], 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.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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/get_audiences_response.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/get_audiences_response.py deleted file mode 100644 index 153d269e..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/get_audiences_response.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience import Audience - from criteo_api_marketingsolutions_v2023_01.model.audience_error import AudienceError - from criteo_api_marketingsolutions_v2023_01.model.audience_warning import AudienceWarning - globals()['Audience'] = Audience - globals()['AudienceError'] = AudienceError - globals()['AudienceWarning'] = AudienceWarning - - -class GetAudiencesResponse(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': ([Audience],), # noqa: E501 - 'errors': ([AudienceError],), # noqa: E501 - 'warnings': ([AudienceWarning],), # 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, errors, warnings, *args, **kwargs): # noqa: E501 - """GetAudiencesResponse - a model defined in OpenAPI - - Args: - data ([Audience]): - errors ([AudienceError]): - warnings ([AudienceWarning]): - - 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.data = data - 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 \ - 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, errors, warnings, *args, **kwargs): # noqa: E501 - """GetAudiencesResponse - a model defined in OpenAPI - - Args: - data ([Audience]): - errors ([AudienceError]): - warnings ([AudienceWarning]): - - 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.data = data - 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 \ - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience.py deleted file mode 100644 index 484ce30a..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.new_audience_attributes import NewAudienceAttributes - globals()['NewAudienceAttributes'] = NewAudienceAttributes - - -class NewAudience(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,), # noqa: E501 - 'attributes': (NewAudienceAttributes,), # 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, type, attributes, *args, **kwargs): # noqa: E501 - """NewAudience - a model defined in OpenAPI - - Args: - type (str): the name of the entity type - attributes (NewAudienceAttributes): - - 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.type = type - self.attributes = attributes - 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, type, attributes, *args, **kwargs): # noqa: E501 - """NewAudience - a model defined in OpenAPI - - Args: - type (str): the name of the entity type - attributes (NewAudienceAttributes): - - 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.type = type - self.attributes = attributes - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_attributes.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_attributes.py deleted file mode 100644 index 09156941..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_attributes.py +++ /dev/null @@ -1,277 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class NewAudienceAttributes(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,), # noqa: E501 - 'advertiser_id': (str, none_type,), # noqa: E501 - 'description': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'advertiser_id': 'advertiserId', # noqa: E501 - 'description': 'description', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 - """NewAudienceAttributes - a model defined in OpenAPI - - Args: - name (str): The name of the new audience - - 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,) - advertiser_id (str, none_type): The advertiser id to create the audience for. [optional] # noqa: E501 - description (str, none_type): The description of the audience. [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.name = name - 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, name, *args, **kwargs): # noqa: E501 - """NewAudienceAttributes - a model defined in OpenAPI - - Args: - name (str): The name of the new audience - - 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,) - advertiser_id (str, none_type): The advertiser id to create the audience for. [optional] # noqa: E501 - description (str, none_type): The description of the audience. [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.name = name - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_request.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_request.py deleted file mode 100644 index 2babe887..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.new_audience import NewAudience - globals()['NewAudience'] = NewAudience - - -class NewAudienceRequest(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': (NewAudience,), # 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 - """NewAudienceRequest - 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 (NewAudience): [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 - """NewAudienceRequest - 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 (NewAudience): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_response.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_response.py deleted file mode 100644 index e300ca9f..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/new_audience_response.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_error import AudienceError - from criteo_api_marketingsolutions_v2023_01.model.audience_warning import AudienceWarning - from criteo_api_marketingsolutions_v2023_01.model.basic_audience_definition import BasicAudienceDefinition - globals()['AudienceError'] = AudienceError - globals()['AudienceWarning'] = AudienceWarning - globals()['BasicAudienceDefinition'] = BasicAudienceDefinition - - -class NewAudienceResponse(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': (BasicAudienceDefinition,), # noqa: E501 - 'errors': ([AudienceError],), # noqa: E501 - 'warnings': ([AudienceWarning],), # 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, errors, warnings, *args, **kwargs): # noqa: E501 - """NewAudienceResponse - a model defined in OpenAPI - - Args: - data (BasicAudienceDefinition): - errors ([AudienceError]): - warnings ([AudienceWarning]): - - 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.data = data - 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 \ - 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, errors, warnings, *args, **kwargs): # noqa: E501 - """NewAudienceResponse - a model defined in OpenAPI - - Args: - data (BasicAudienceDefinition): - errors ([AudienceError]): - warnings ([AudienceWarning]): - - 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.data = data - 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 \ - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/problem_details.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/problem_details.py deleted file mode 100644 index d380f3fa..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/problem_details.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - - -class ProblemDetails(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 = { - ('type',): { - 'None': None, - 'UNKNOWN': "unknown", - 'ACCESS-CONTROL': "access-control", - 'AUTHENTICATION': "authentication", - 'AUTHORIZATION': "authorization", - 'AVAILABILITY': "availability", - 'DEPRECATION': "deprecation", - 'QUOTA': "quota", - 'VALIDATION': "validation", - }, - } - - 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, none_type,), # noqa: E501 - 'trace_identifier': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'code': (str, none_type,), # noqa: E501 - 'instance': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'source': ({str: (str,)}, none_type,), # noqa: E501 - 'stack_trace': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_id': 'traceId', # noqa: E501 - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'type': 'type', # noqa: E501 - 'code': 'code', # noqa: E501 - 'instance': 'instance', # noqa: E501 - 'title': 'title', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ProblemDetails - 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,) - trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 - trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 - type (str, none_type): The problem's category.. [optional] # noqa: E501 - code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 - instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 - detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace (str, 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 - """ProblemDetails - 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,) - trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 - trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 - type (str, none_type): The problem's category.. [optional] # noqa: E501 - code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 - instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 - detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience.py deleted file mode 100644 index 989e48e2..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_name_description import AudienceNameDescription - globals()['AudienceNameDescription'] = AudienceNameDescription - - -class ReplaceAudience(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,), # noqa: E501 - 'attributes': (AudienceNameDescription,), # 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, type, attributes, *args, **kwargs): # noqa: E501 - """ReplaceAudience - a model defined in OpenAPI - - Args: - type (str): the name of the entity type - attributes (AudienceNameDescription): - - 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.type = type - self.attributes = attributes - 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, type, attributes, *args, **kwargs): # noqa: E501 - """ReplaceAudience - a model defined in OpenAPI - - Args: - type (str): the name of the entity type - attributes (AudienceNameDescription): - - 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.type = type - self.attributes = attributes - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience_request.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience_request.py deleted file mode 100644 index 3aaea088..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience_request.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.replace_audience import ReplaceAudience - globals()['ReplaceAudience'] = ReplaceAudience - - -class ReplaceAudienceRequest(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': (ReplaceAudience,), # 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, data, *args, **kwargs): # noqa: E501 - """ReplaceAudienceRequest - a model defined in OpenAPI - - Args: - data (ReplaceAudience): - - 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.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 - """ReplaceAudienceRequest - a model defined in OpenAPI - - Args: - data (ReplaceAudience): - - 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.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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience_response.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience_response.py deleted file mode 100644 index 57607b17..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/replace_audience_response.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_error import AudienceError - from criteo_api_marketingsolutions_v2023_01.model.audience_warning import AudienceWarning - from criteo_api_marketingsolutions_v2023_01.model.basic_audience_definition import BasicAudienceDefinition - globals()['AudienceError'] = AudienceError - globals()['AudienceWarning'] = AudienceWarning - globals()['BasicAudienceDefinition'] = BasicAudienceDefinition - - -class ReplaceAudienceResponse(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': (BasicAudienceDefinition,), # noqa: E501 - 'errors': ([AudienceError],), # noqa: E501 - 'warnings': ([AudienceWarning],), # 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, errors, warnings, *args, **kwargs): # noqa: E501 - """ReplaceAudienceResponse - a model defined in OpenAPI - - Args: - data (BasicAudienceDefinition): - errors ([AudienceError]): - warnings ([AudienceWarning]): - - 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.data = data - 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 \ - 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, errors, warnings, *args, **kwargs): # noqa: E501 - """ReplaceAudienceResponse - a model defined in OpenAPI - - Args: - data (BasicAudienceDefinition): - errors ([AudienceError]): - warnings ([AudienceWarning]): - - 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.data = data - 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 \ - 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/request_ad_set_search.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/request_ad_set_search.py deleted file mode 100644 index 1b58a131..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/request_ad_set_search.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_search_filter import AdSetSearchFilter - globals()['AdSetSearchFilter'] = AdSetSearchFilter - - -class RequestAdSetSearch(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 { - 'filters': (AdSetSearchFilter,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'filters': 'filters', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RequestAdSetSearch - 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,) - filters (AdSetSearchFilter): [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 - """RequestAdSetSearch - 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,) - filters (AdSetSearchFilter): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/responses_read_ad_set.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/responses_read_ad_set.py deleted file mode 100644 index b49cb470..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/responses_read_ad_set.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - from criteo_api_marketingsolutions_v2023_01.model.read_model_read_ad_set import ReadModelReadAdSet - globals()['CommonProblem'] = CommonProblem - globals()['ReadModelReadAdSet'] = ReadModelReadAdSet - - -class ResponsesReadAdSet(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': ([ReadModelReadAdSet], none_type,), # noqa: E501 - 'warnings': ([CommonProblem], none_type,), # noqa: E501 - 'errors': ([CommonProblem], none_type,), # 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 = { - 'data', # noqa: E501 - 'warnings', # noqa: E501 - 'errors', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResponsesReadAdSet - 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 ([ReadModelReadAdSet], 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) - _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 - """ResponsesReadAdSet - 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 ([ReadModelReadAdSet], 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) - _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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model_utils.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model_utils.py deleted file mode 100644 index 7f0370a8..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model_utils.py +++ /dev/null @@ -1,2058 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -from datetime import date, datetime # noqa: F401 -from copy import deepcopy -import inspect -import io -import os -import pprint -import re -import tempfile -import uuid - -from dateutil.parser import parse - -from criteo_api_marketingsolutions_v2023_01.exceptions import ( - ApiKeyError, - ApiAttributeError, - ApiTypeError, - ApiValueError, -) - -none_type = type(None) -file_type = io.IOBase - - -def convert_js_args_to_python_args(fn): - from functools import wraps - @wraps(fn) - def wrapped_init(_self, *args, **kwargs): - """ - An attribute named `self` received from the api will conflicts with the reserved `self` - parameter of a class method. During generation, `self` attributes are mapped - to `_self` in models. Here, we name `_self` instead of `self` to avoid conflicts. - """ - spec_property_naming = kwargs.get('_spec_property_naming', False) - if spec_property_naming: - kwargs = change_keys_js_to_python( - kwargs, _self if isinstance( - _self, type) else _self.__class__) - return fn(_self, *args, **kwargs) - return wrapped_init - - -class cached_property(object): - # this caches the result of the function call for fn with no inputs - # use this as a decorator on function methods that you want converted - # into cached properties - result_key = '_results' - - def __init__(self, fn): - self._fn = fn - - def __get__(self, instance, cls=None): - if self.result_key in vars(self): - return vars(self)[self.result_key] - else: - result = self._fn() - setattr(self, self.result_key, result) - return result - - -PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) - - -def allows_single_value_input(cls): - """ - This function returns True if the input composed schema model or any - descendant model allows a value only input - This is true for cases where oneOf contains items like: - oneOf: - - float - - NumberWithValidation - - StringEnum - - ArrayModel - - null - TODO: lru_cache this - """ - if ( - issubclass(cls, ModelSimple) or - cls in PRIMITIVE_TYPES - ): - return True - elif issubclass(cls, ModelComposed): - if not cls._composed_schemas['oneOf']: - return False - return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) - return False - - -def composed_model_input_classes(cls): - """ - This function returns a list of the possible models that can be accepted as - inputs. - TODO: lru_cache this - """ - if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: - return [cls] - elif issubclass(cls, ModelNormal): - if cls.discriminator is None: - return [cls] - else: - return get_discriminated_classes(cls) - elif issubclass(cls, ModelComposed): - if not cls._composed_schemas['oneOf']: - return [] - if cls.discriminator is None: - input_classes = [] - for c in cls._composed_schemas['oneOf']: - input_classes.extend(composed_model_input_classes(c)) - return input_classes - else: - return get_discriminated_classes(cls) - return [] - - -class OpenApiModel(object): - """The base class for all OpenAPIModels""" - - def set_attribute(self, name, value): - # this is only used to set properties on self - - path_to_item = [] - if self._path_to_item: - path_to_item.extend(self._path_to_item) - path_to_item.append(name) - - if name in self.openapi_types: - required_types_mixed = self.openapi_types[name] - elif self.additional_properties_type is None: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - path_to_item - ) - elif self.additional_properties_type is not None: - required_types_mixed = self.additional_properties_type - - if get_simple_class(name) != str: - error_msg = type_error_message( - var_name=name, - var_value=name, - valid_classes=(str,), - key_type=True - ) - raise ApiTypeError( - error_msg, - path_to_item=path_to_item, - valid_classes=(str,), - key_type=True - ) - - if self._check_type: - value = validate_and_convert_types( - value, required_types_mixed, path_to_item, self._spec_property_naming, - self._check_type, configuration=self._configuration) - if (name,) in self.allowed_values: - check_allowed_values( - self.allowed_values, - (name,), - value - ) - if (name,) in self.validations: - check_validations( - self.validations, - (name,), - value, - self._configuration - ) - self.__dict__['_data_store'][name] = value - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other - - def __setattr__(self, attr, value): - """set the value of an attribute using dot notation: `instance.attr = val`""" - self[attr] = value - - def __getattr__(self, attr): - """get the value of an attribute using dot notation: `instance.attr`""" - return self.__getitem__(attr) - - def __copy__(self): - cls = self.__class__ - if self.get("_spec_property_naming", False): - return cls._new_from_openapi_data(**self.__dict__) - else: - return cls.__new__(cls, **self.__dict__) - - def __deepcopy__(self, memo): - cls = self.__class__ - - if self.get("_spec_property_naming", False): - new_inst = cls._new_from_openapi_data() - else: - new_inst = cls.__new__(cls, **self.__dict__) - - for k, v in self.__dict__.items(): - setattr(new_inst, k, deepcopy(v, memo)) - return new_inst - - - def __new__(cls, *args, **kwargs): - # this function uses the discriminator to - # pick a new schema/class to instantiate because a discriminator - # propertyName value was passed in - - if len(args) == 1: - arg = args[0] - if arg is None and is_type_nullable(cls): - # The input data is the 'null' value and the type is nullable. - return None - - if issubclass(cls, ModelComposed) and allows_single_value_input(cls): - model_kwargs = {} - oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) - return oneof_instance - - visited_composed_classes = kwargs.get('_visited_composed_classes', ()) - if ( - cls.discriminator is None or - cls in visited_composed_classes - ): - # Use case 1: this openapi schema (cls) does not have a discriminator - # Use case 2: we have already visited this class before and are sure that we - # want to instantiate it this time. We have visited this class deserializing - # a payload with a discriminator. During that process we traveled through - # this class but did not make an instance of it. Now we are making an - # instance of a composed class which contains cls in it, so this time make an instance of cls. - # - # Here's an example of use case 2: 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 the composed schema dog Dog, we will make an instance of the - # Animal class (because Dal has allOf: Animal) but this time we won't travel - # through Animal's discriminator because we passed in - # _visited_composed_classes = (Animal,) - - return super(OpenApiModel, cls).__new__(cls) - - # Get the name and value of the discriminator property. - # The discriminator name is obtained from the discriminator meta-data - # and the discriminator value is obtained from the input data. - discr_propertyname_py = list(cls.discriminator.keys())[0] - discr_propertyname_js = cls.attribute_map[discr_propertyname_py] - if discr_propertyname_js in kwargs: - discr_value = kwargs[discr_propertyname_js] - elif discr_propertyname_py in kwargs: - discr_value = kwargs[discr_propertyname_py] - else: - # The input data does not contain the discriminator property. - path_to_item = kwargs.get('_path_to_item', ()) - raise ApiValueError( - "Cannot deserialize input data due to missing discriminator. " - "The discriminator property '%s' is missing at path: %s" % - (discr_propertyname_js, path_to_item) - ) - - # Implementation note: the last argument to get_discriminator_class - # is a list of visited classes. get_discriminator_class may recursively - # call itself and update the list of visited classes, and the initial - # value must be an empty list. Hence not using 'visited_composed_classes' - new_cls = get_discriminator_class( - cls, discr_propertyname_py, discr_value, []) - if new_cls is None: - path_to_item = kwargs.get('_path_to_item', ()) - disc_prop_value = kwargs.get( - discr_propertyname_js, kwargs.get(discr_propertyname_py)) - raise ApiValueError( - "Cannot deserialize input data due to invalid discriminator " - "value. The OpenAPI document has no mapping for discriminator " - "property '%s'='%s' at path: %s" % - (discr_propertyname_js, disc_prop_value, path_to_item) - ) - - if new_cls in visited_composed_classes: - # if we are making an instance of a composed schema Descendent - # which allOf includes Ancestor, then Ancestor contains - # a discriminator that includes Descendent. - # So if we make an instance of Descendent, we have to make an - # instance of Ancestor to hold the allOf properties. - # This code detects that use case and makes the instance of Ancestor - # For example: - # When making an instance of Dog, _visited_composed_classes = (Dog,) - # then we make an instance of Animal to include in dog._composed_instances - # so when we are here, cls is Animal - # cls.discriminator != None - # cls not in _visited_composed_classes - # new_cls = Dog - # but we know we know that we already have Dog - # because it is in visited_composed_classes - # so make Animal here - return super(OpenApiModel, cls).__new__(cls) - - # Build a list containing all oneOf and anyOf descendants. - oneof_anyof_classes = None - if cls._composed_schemas is not None: - oneof_anyof_classes = ( - cls._composed_schemas.get('oneOf', ()) + - cls._composed_schemas.get('anyOf', ())) - oneof_anyof_child = new_cls in oneof_anyof_classes - kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) - - if cls._composed_schemas.get('allOf') and oneof_anyof_child: - # Validate that we can make self because when we make the - # new_cls it will not include the allOf validations in self - self_inst = super(OpenApiModel, cls).__new__(cls) - self_inst.__init__(*args, **kwargs) - - if kwargs.get("_spec_property_naming", False): - # when true, implies new is from deserialization - new_inst = new_cls._new_from_openapi_data(*args, **kwargs) - else: - new_inst = new_cls.__new__(new_cls, *args, **kwargs) - new_inst.__init__(*args, **kwargs) - - return new_inst - - @classmethod - @convert_js_args_to_python_args - def _new_from_openapi_data(cls, *args, **kwargs): - # this function uses the discriminator to - # pick a new schema/class to instantiate because a discriminator - # propertyName value was passed in - - if len(args) == 1: - arg = args[0] - if arg is None and is_type_nullable(cls): - # The input data is the 'null' value and the type is nullable. - return None - - if issubclass(cls, ModelComposed) and allows_single_value_input(cls): - model_kwargs = {} - oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) - return oneof_instance - - visited_composed_classes = kwargs.get('_visited_composed_classes', ()) - if ( - cls.discriminator is None or - cls in visited_composed_classes - ): - # Use case 1: this openapi schema (cls) does not have a discriminator - # Use case 2: we have already visited this class before and are sure that we - # want to instantiate it this time. We have visited this class deserializing - # a payload with a discriminator. During that process we traveled through - # this class but did not make an instance of it. Now we are making an - # instance of a composed class which contains cls in it, so this time make an instance of cls. - # - # Here's an example of use case 2: 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 the composed schema dog Dog, we will make an instance of the - # Animal class (because Dal has allOf: Animal) but this time we won't travel - # through Animal's discriminator because we passed in - # _visited_composed_classes = (Animal,) - - return cls._from_openapi_data(*args, **kwargs) - - # Get the name and value of the discriminator property. - # The discriminator name is obtained from the discriminator meta-data - # and the discriminator value is obtained from the input data. - discr_propertyname_py = list(cls.discriminator.keys())[0] - discr_propertyname_js = cls.attribute_map[discr_propertyname_py] - if discr_propertyname_js in kwargs: - discr_value = kwargs[discr_propertyname_js] - elif discr_propertyname_py in kwargs: - discr_value = kwargs[discr_propertyname_py] - else: - # The input data does not contain the discriminator property. - path_to_item = kwargs.get('_path_to_item', ()) - raise ApiValueError( - "Cannot deserialize input data due to missing discriminator. " - "The discriminator property '%s' is missing at path: %s" % - (discr_propertyname_js, path_to_item) - ) - - # Implementation note: the last argument to get_discriminator_class - # is a list of visited classes. get_discriminator_class may recursively - # call itself and update the list of visited classes, and the initial - # value must be an empty list. Hence not using 'visited_composed_classes' - new_cls = get_discriminator_class( - cls, discr_propertyname_py, discr_value, []) - if new_cls is None: - path_to_item = kwargs.get('_path_to_item', ()) - disc_prop_value = kwargs.get( - discr_propertyname_js, kwargs.get(discr_propertyname_py)) - raise ApiValueError( - "Cannot deserialize input data due to invalid discriminator " - "value. The OpenAPI document has no mapping for discriminator " - "property '%s'='%s' at path: %s" % - (discr_propertyname_js, disc_prop_value, path_to_item) - ) - - if new_cls in visited_composed_classes: - # if we are making an instance of a composed schema Descendent - # which allOf includes Ancestor, then Ancestor contains - # a discriminator that includes Descendent. - # So if we make an instance of Descendent, we have to make an - # instance of Ancestor to hold the allOf properties. - # This code detects that use case and makes the instance of Ancestor - # For example: - # When making an instance of Dog, _visited_composed_classes = (Dog,) - # then we make an instance of Animal to include in dog._composed_instances - # so when we are here, cls is Animal - # cls.discriminator != None - # cls not in _visited_composed_classes - # new_cls = Dog - # but we know we know that we already have Dog - # because it is in visited_composed_classes - # so make Animal here - return cls._from_openapi_data(*args, **kwargs) - - # Build a list containing all oneOf and anyOf descendants. - oneof_anyof_classes = None - if cls._composed_schemas is not None: - oneof_anyof_classes = ( - cls._composed_schemas.get('oneOf', ()) + - cls._composed_schemas.get('anyOf', ())) - oneof_anyof_child = new_cls in oneof_anyof_classes - kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) - - if cls._composed_schemas.get('allOf') and oneof_anyof_child: - # Validate that we can make self because when we make the - # new_cls it will not include the allOf validations in self - self_inst = cls._from_openapi_data(*args, **kwargs) - - new_inst = new_cls._new_from_openapi_data(*args, **kwargs) - return new_inst - - -class ModelSimple(OpenApiModel): - """the parent class of models whose type != object in their - swagger/openapi""" - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - self.set_attribute(name, value) - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - return self.__dict__['_data_store'].get(name, default) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - if name in self: - return self.get(name) - - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - if name in self.required_properties: - return name in self.__dict__ - - return name in self.__dict__['_data_store'] - - def to_str(self): - """Returns the string representation of the model""" - return str(self.value) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - this_val = self._data_store['value'] - that_val = other._data_store['value'] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - return vals_equal - - -class ModelNormal(OpenApiModel): - """the parent class of models whose type == object in their - swagger/openapi""" - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - self.set_attribute(name, value) - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - return self.__dict__['_data_store'].get(name, default) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - if name in self: - return self.get(name) - - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - if name in self.required_properties: - return name in self.__dict__ - - return name in self.__dict__['_data_store'] - - def to_dict(self): - """Returns the model properties as a dict""" - return model_to_dict(self, serialize=False) - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - if not set(self._data_store.keys()) == set(other._data_store.keys()): - return False - for _var_name, this_val in self._data_store.items(): - that_val = other._data_store[_var_name] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - if not vals_equal: - return False - return True - - -class ModelComposed(OpenApiModel): - """the parent class of models whose type == object in their - swagger/openapi and have oneOf/allOf/anyOf - - When one sets a property we use var_name_to_model_instances to store the value in - the correct class instances + run any type checking + validation code. - When one gets a property we use var_name_to_model_instances to get the value - from the correct class instances. - This allows multiple composed schemas to contain the same property with additive - constraints on the value. - - _composed_schemas (dict) stores the anyOf/allOf/oneOf classes - key (str): allOf/oneOf/anyOf - value (list): the classes in the XOf definition. - Note: none_type can be included when the openapi document version >= 3.1.0 - _composed_instances (list): stores a list of instances of the composed schemas - defined in _composed_schemas. When properties are accessed in the self instance, - they are returned from the self._data_store or the data stores in the instances - in self._composed_schemas - _var_name_to_model_instances (dict): maps between a variable name on self and - the composed instances (self included) which contain that data - key (str): property name - value (list): list of class instances, self or instances in _composed_instances - which contain the value that the key is referring to. - """ - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - """ - Use cases: - 1. additional_properties_type is None (additionalProperties == False in spec) - Check for property presence in self.openapi_types - if not present then throw an error - if present set in self, set attribute - always set on composed schemas - 2. additional_properties_type exists - set attribute on self - always set on composed schemas - """ - if self.additional_properties_type is None: - """ - For an attribute to exist on a composed schema it must: - - fulfill schema_requirements in the self composed schema not considering oneOf/anyOf/allOf schemas AND - - fulfill schema_requirements in each oneOf/anyOf/allOf schemas - - schema_requirements: - For an attribute to exist on a schema it must: - - be present in properties at the schema OR - - have additionalProperties unset (defaults additionalProperties = any type) OR - - have additionalProperties set - """ - if name not in self.openapi_types: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - # attribute must be set on self and composed instances - self.set_attribute(name, value) - for model_instance in self._composed_instances: - setattr(model_instance, name, value) - if name not in self._var_name_to_model_instances: - # we assigned an additional property - self.__dict__['_var_name_to_model_instances'][name] = self._composed_instances + [self] - return None - - __unset_attribute_value__ = object() - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - # get the attribute from the correct instance - model_instances = self._var_name_to_model_instances.get(name) - values = [] - # A composed model stores self and child (oneof/anyOf/allOf) models under - # self._var_name_to_model_instances. - # Any property must exist in self and all model instances - # The value stored in all model instances must be the same - if model_instances: - for model_instance in model_instances: - if name in model_instance._data_store: - v = model_instance._data_store[name] - if v not in values: - values.append(v) - len_values = len(values) - if len_values == 0: - return default - elif len_values == 1: - return values[0] - elif len_values > 1: - raise ApiValueError( - "Values stored for property {0} in {1} differ when looking " - "at self and self's composed instances. All values must be " - "the same".format(name, type(self).__name__), - [e for e in [self._path_to_item, name] if e] - ) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - value = self.get(name, self.__unset_attribute_value__) - if value is self.__unset_attribute_value__: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - return value - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - - if name in self.required_properties: - return name in self.__dict__ - - model_instances = self._var_name_to_model_instances.get( - name, self._additional_properties_model_instances) - - if model_instances: - for model_instance in model_instances: - if name in model_instance._data_store: - return True - - return False - - def to_dict(self): - """Returns the model properties as a dict""" - return model_to_dict(self, serialize=False) - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - if not set(self._data_store.keys()) == set(other._data_store.keys()): - return False - for _var_name, this_val in self._data_store.items(): - that_val = other._data_store[_var_name] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - if not vals_equal: - return False - return True - - -COERCION_INDEX_BY_TYPE = { - ModelComposed: 0, - ModelNormal: 1, - ModelSimple: 2, - none_type: 3, # The type of 'None'. - list: 4, - dict: 5, - float: 6, - int: 7, - bool: 8, - datetime: 9, - date: 10, - str: 11, - file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. -} - -# these are used to limit what type conversions we try to do -# when we have a valid type already and we want to try converting -# to another type -UPCONVERSION_TYPE_PAIRS = ( - (str, datetime), - (str, date), - # A float may be serialized as an integer, e.g. '3' is a valid serialized float. - (int, float), - (list, ModelComposed), - (dict, ModelComposed), - (str, ModelComposed), - (int, ModelComposed), - (float, ModelComposed), - (list, ModelComposed), - (list, ModelNormal), - (dict, ModelNormal), - (str, ModelSimple), - (int, ModelSimple), - (float, ModelSimple), - (list, ModelSimple), -) - -COERCIBLE_TYPE_PAIRS = { - False: ( # client instantiation of a model with client data - # (dict, ModelComposed), - # (list, ModelComposed), - # (dict, ModelNormal), - # (list, ModelNormal), - # (str, ModelSimple), - # (int, ModelSimple), - # (float, ModelSimple), - # (list, ModelSimple), - # (str, int), - # (str, float), - # (str, datetime), - # (str, date), - # (int, str), - # (float, str), - ), - True: ( # server -> client data - (dict, ModelComposed), - (list, ModelComposed), - (dict, ModelNormal), - (list, ModelNormal), - (str, ModelSimple), - (int, ModelSimple), - (float, ModelSimple), - (list, ModelSimple), - # (str, int), - # (str, float), - (str, datetime), - (str, date), - # (int, str), - # (float, str), - (str, file_type) - ), -} - - -def get_simple_class(input_value): - """Returns an input_value's simple class that we will use for type checking - Python2: - float and int will return int, where int is the python3 int backport - str and unicode will return str, where str is the python3 str backport - Note: float and int ARE both instances of int backport - Note: str_py2 and unicode_py2 are NOT both instances of str backport - - Args: - input_value (class/class_instance): the item for which we will return - the simple class - """ - if isinstance(input_value, type): - # input_value is a class - return input_value - elif isinstance(input_value, tuple): - return tuple - elif isinstance(input_value, list): - return list - elif isinstance(input_value, dict): - return dict - elif isinstance(input_value, none_type): - return none_type - elif isinstance(input_value, file_type): - return file_type - elif isinstance(input_value, bool): - # this must be higher than the int check because - # isinstance(True, int) == True - return bool - elif isinstance(input_value, int): - return int - elif isinstance(input_value, datetime): - # this must be higher than the date check because - # isinstance(datetime_instance, date) == True - return datetime - elif isinstance(input_value, date): - return date - elif isinstance(input_value, str): - return str - return type(input_value) - - -def check_allowed_values(allowed_values, input_variable_path, input_values): - """Raises an exception if the input_values are not allowed - - Args: - allowed_values (dict): the allowed_values dict - input_variable_path (tuple): the path to the input variable - input_values (list/str/int/float/date/datetime): the values that we - are checking to see if they are in allowed_values - """ - these_allowed_values = list(allowed_values[input_variable_path].values()) - if (isinstance(input_values, list) - and not set(input_values).issubset( - set(these_allowed_values))): - invalid_values = ", ".join( - map(str, set(input_values) - set(these_allowed_values))), - raise ApiValueError( - "Invalid values for `%s` [%s], must be a subset of [%s]" % - ( - input_variable_path[0], - invalid_values, - ", ".join(map(str, these_allowed_values)) - ) - ) - elif (isinstance(input_values, dict) - and not set( - input_values.keys()).issubset(set(these_allowed_values))): - invalid_values = ", ".join( - map(str, set(input_values.keys()) - set(these_allowed_values))) - raise ApiValueError( - "Invalid keys in `%s` [%s], must be a subset of [%s]" % - ( - input_variable_path[0], - invalid_values, - ", ".join(map(str, these_allowed_values)) - ) - ) - elif (not isinstance(input_values, (list, dict)) - and input_values not in these_allowed_values): - raise ApiValueError( - "Invalid value for `%s` (%s), must be one of %s" % - ( - input_variable_path[0], - input_values, - these_allowed_values - ) - ) - - -def is_json_validation_enabled(schema_keyword, configuration=None): - """Returns true if JSON schema validation is enabled for the specified - validation keyword. This can be used to skip JSON schema structural validation - as requested in the configuration. - - Args: - schema_keyword (string): the name of a JSON schema validation keyword. - configuration (Configuration): the configuration class. - """ - - return (configuration is None or - not hasattr(configuration, '_disabled_client_side_validations') or - schema_keyword not in configuration._disabled_client_side_validations) - - -def check_validations( - validations, input_variable_path, input_values, - configuration=None): - """Raises an exception if the input_values are invalid - - Args: - validations (dict): the validation dictionary. - input_variable_path (tuple): the path to the input variable. - input_values (list/str/int/float/date/datetime): the values that we - are checking. - configuration (Configuration): the configuration class. - """ - - if input_values is None: - return - - current_validations = validations[input_variable_path] - if (is_json_validation_enabled('multipleOf', configuration) and - 'multiple_of' in current_validations and - isinstance(input_values, (int, float)) and - not (float(input_values) / current_validations['multiple_of']).is_integer()): - # Note 'multipleOf' will be as good as the floating point arithmetic. - raise ApiValueError( - "Invalid value for `%s`, value must be a multiple of " - "`%s`" % ( - input_variable_path[0], - current_validations['multiple_of'] - ) - ) - - if (is_json_validation_enabled('maxLength', configuration) and - 'max_length' in current_validations and - len(input_values) > current_validations['max_length']): - raise ApiValueError( - "Invalid value for `%s`, length must be less than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['max_length'] - ) - ) - - if (is_json_validation_enabled('minLength', configuration) and - 'min_length' in current_validations and - len(input_values) < current_validations['min_length']): - raise ApiValueError( - "Invalid value for `%s`, length must be greater than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['min_length'] - ) - ) - - if (is_json_validation_enabled('maxItems', configuration) and - 'max_items' in current_validations and - len(input_values) > current_validations['max_items']): - raise ApiValueError( - "Invalid value for `%s`, number of items must be less than or " - "equal to `%s`" % ( - input_variable_path[0], - current_validations['max_items'] - ) - ) - - if (is_json_validation_enabled('minItems', configuration) and - 'min_items' in current_validations and - len(input_values) < current_validations['min_items']): - raise ValueError( - "Invalid value for `%s`, number of items must be greater than or " - "equal to `%s`" % ( - input_variable_path[0], - current_validations['min_items'] - ) - ) - - items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', - 'inclusive_minimum') - if (any(item in current_validations for item in items)): - if isinstance(input_values, list): - max_val = max(input_values) - min_val = min(input_values) - elif isinstance(input_values, dict): - max_val = max(input_values.values()) - min_val = min(input_values.values()) - else: - max_val = input_values - min_val = input_values - - if (is_json_validation_enabled('exclusiveMaximum', configuration) and - 'exclusive_maximum' in current_validations and - max_val >= current_validations['exclusive_maximum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value less than `%s`" % ( - input_variable_path[0], - current_validations['exclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('maximum', configuration) and - 'inclusive_maximum' in current_validations and - max_val > current_validations['inclusive_maximum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value less than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['inclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('exclusiveMinimum', configuration) and - 'exclusive_minimum' in current_validations and - min_val <= current_validations['exclusive_minimum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value greater than `%s`" % - ( - input_variable_path[0], - current_validations['exclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('minimum', configuration) and - 'inclusive_minimum' in current_validations and - min_val < current_validations['inclusive_minimum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value greater than or equal " - "to `%s`" % ( - input_variable_path[0], - current_validations['inclusive_minimum'] - ) - ) - flags = current_validations.get('regex', {}).get('flags', 0) - if (is_json_validation_enabled('pattern', configuration) and - 'regex' in current_validations and - not re.search(current_validations['regex']['pattern'], - input_values, flags=flags)): - err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( - input_variable_path[0], - current_validations['regex']['pattern'] - ) - if flags != 0: - # Don't print the regex flags if the flags are not - # specified in the OAS document. - err_msg = r"%s with flags=`%s`" % (err_msg, flags) - raise ApiValueError(err_msg) - - -def order_response_types(required_types): - """Returns the required types sorted in coercion order - - Args: - required_types (list/tuple): collection of classes or instance of - list or dict with class information inside it. - - Returns: - (list): coercion order sorted collection of classes or instance - of list or dict with class information inside it. - """ - - def index_getter(class_or_instance): - if isinstance(class_or_instance, list): - return COERCION_INDEX_BY_TYPE[list] - elif isinstance(class_or_instance, dict): - return COERCION_INDEX_BY_TYPE[dict] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelComposed)): - return COERCION_INDEX_BY_TYPE[ModelComposed] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelNormal)): - return COERCION_INDEX_BY_TYPE[ModelNormal] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelSimple)): - return COERCION_INDEX_BY_TYPE[ModelSimple] - elif class_or_instance in COERCION_INDEX_BY_TYPE: - return COERCION_INDEX_BY_TYPE[class_or_instance] - raise ApiValueError("Unsupported type: %s" % class_or_instance) - - sorted_types = sorted( - required_types, - key=lambda class_or_instance: index_getter(class_or_instance) - ) - return sorted_types - - -def remove_uncoercible(required_types_classes, current_item, spec_property_naming, - must_convert=True): - """Only keeps the type conversions that are possible - - Args: - required_types_classes (tuple): tuple of classes that are required - these should be ordered by COERCION_INDEX_BY_TYPE - 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 variables names in the input data are python - variable names in PEP-8 snake case. - current_item (any): the current item (input data) to be converted - - Keyword Args: - must_convert (bool): if True the item to convert is of the wrong - type and we want a big list of coercibles - if False, we want a limited list of coercibles - - Returns: - (list): the remaining coercible required types, classes only - """ - current_type_simple = get_simple_class(current_item) - - results_classes = [] - for required_type_class in required_types_classes: - # convert our models to OpenApiModel - required_type_class_simplified = required_type_class - if isinstance(required_type_class_simplified, type): - if issubclass(required_type_class_simplified, ModelComposed): - required_type_class_simplified = ModelComposed - elif issubclass(required_type_class_simplified, ModelNormal): - required_type_class_simplified = ModelNormal - elif issubclass(required_type_class_simplified, ModelSimple): - required_type_class_simplified = ModelSimple - - if required_type_class_simplified == current_type_simple: - # don't consider converting to one's own class - continue - - class_pair = (current_type_simple, required_type_class_simplified) - if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: - results_classes.append(required_type_class) - elif class_pair in UPCONVERSION_TYPE_PAIRS: - results_classes.append(required_type_class) - return results_classes - - -def get_discriminated_classes(cls): - """ - Returns all the classes that a discriminator converts to - TODO: lru_cache this - """ - possible_classes = [] - key = list(cls.discriminator.keys())[0] - if is_type_nullable(cls): - possible_classes.append(cls) - for discr_cls in cls.discriminator[key].values(): - if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: - possible_classes.extend(get_discriminated_classes(discr_cls)) - else: - possible_classes.append(discr_cls) - return possible_classes - - -def get_possible_classes(cls, from_server_context): - # TODO: lru_cache this - possible_classes = [cls] - if from_server_context: - return possible_classes - if hasattr(cls, 'discriminator') and cls.discriminator is not None: - possible_classes = [] - possible_classes.extend(get_discriminated_classes(cls)) - elif issubclass(cls, ModelComposed): - possible_classes.extend(composed_model_input_classes(cls)) - return possible_classes - - -def get_required_type_classes(required_types_mixed, spec_property_naming): - """Converts the tuple required_types into a tuple and a dict described - below - - Args: - required_types_mixed (tuple/list): will contain either classes or - instance of list or dict - spec_property_naming (bool): if True these values came from the - server, and we use the data types in our endpoints. - If False, we are client side and we need to include - oneOf and discriminator classes inside the data types in our endpoints - - Returns: - (valid_classes, dict_valid_class_to_child_types_mixed): - valid_classes (tuple): the valid classes that the current item - should be - dict_valid_class_to_child_types_mixed (dict): - valid_class (class): this is the key - child_types_mixed (list/dict/tuple): describes the valid child - types - """ - valid_classes = [] - child_req_types_by_current_type = {} - for required_type in required_types_mixed: - if isinstance(required_type, list): - valid_classes.append(list) - child_req_types_by_current_type[list] = required_type - elif isinstance(required_type, tuple): - valid_classes.append(tuple) - child_req_types_by_current_type[tuple] = required_type - elif isinstance(required_type, dict): - valid_classes.append(dict) - child_req_types_by_current_type[dict] = required_type[str] - else: - valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) - return tuple(valid_classes), child_req_types_by_current_type - - -def change_keys_js_to_python(input_dict, model_class): - """ - Converts from javascript_key keys in the input_dict to python_keys in - the output dict using the mapping in model_class. - If the input_dict contains a key which does not declared in the model_class, - the key is added to the output dict as is. The assumption is the model_class - may have undeclared properties (additionalProperties attribute in the OAS - document). - """ - - if getattr(model_class, 'attribute_map', None) is None: - return input_dict - output_dict = {} - reversed_attr_map = {value: key for key, value in - model_class.attribute_map.items()} - for javascript_key, value in input_dict.items(): - python_key = reversed_attr_map.get(javascript_key) - if python_key is None: - # if the key is unknown, it is in error or it is an - # additionalProperties variable - python_key = javascript_key - output_dict[python_key] = value - return output_dict - - -def get_type_error(var_value, path_to_item, valid_classes, key_type=False): - error_msg = type_error_message( - var_name=path_to_item[-1], - var_value=var_value, - valid_classes=valid_classes, - key_type=key_type - ) - return ApiTypeError( - error_msg, - path_to_item=path_to_item, - valid_classes=valid_classes, - key_type=key_type - ) - - -def deserialize_primitive(data, klass, path_to_item): - """Deserializes string to primitive type. - - :param data: str/int/float - :param klass: str/class the class to convert to - - :return: int, float, str, bool, date, datetime - """ - additional_message = "" - try: - if klass in {datetime, date}: - additional_message = ( - "If you need your parameter to have a fallback " - "string value, please set its type as `type: {}` in your " - "spec. That allows the value to be any type. " - ) - if klass == datetime: - if len(data) < 8: - raise ValueError("This is not a datetime") - # The string should be in iso8601 datetime format. - parsed_datetime = parse(data) - date_only = ( - parsed_datetime.hour == 0 and - parsed_datetime.minute == 0 and - parsed_datetime.second == 0 and - parsed_datetime.tzinfo is None and - 8 <= len(data) <= 10 - ) - if date_only: - raise ValueError("This is a date, not a datetime") - return parsed_datetime - elif klass == date: - if len(data) < 8: - raise ValueError("This is not a date") - return parse(data).date() - else: - converted_value = klass(data) - if isinstance(data, str) and klass == float: - if str(converted_value) != data: - # '7' -> 7.0 -> '7.0' != '7' - raise ValueError('This is not a float') - return converted_value - except (OverflowError, ValueError) as ex: - # parse can raise OverflowError - raise ApiValueError( - "{0}Failed to parse {1} as {2}".format( - additional_message, repr(data), klass.__name__ - ), - path_to_item=path_to_item - ) from ex - - -def get_discriminator_class(model_class, - discr_name, - discr_value, cls_visited): - """Returns the child class specified by the discriminator. - - Args: - model_class (OpenApiModel): the model class. - discr_name (string): the name of the discriminator property. - discr_value (any): the discriminator value. - cls_visited (list): list of model classes that have been visited. - Used to determine the discriminator class without - visiting circular references indefinitely. - - Returns: - used_model_class (class/None): the chosen child class that will be used - to deserialize the data, for example dog.Dog. - If a class is not found, None is returned. - """ - - if model_class in cls_visited: - # The class has already been visited and no suitable class was found. - return None - cls_visited.append(model_class) - used_model_class = None - if discr_name in model_class.discriminator: - class_name_to_discr_class = model_class.discriminator[discr_name] - used_model_class = class_name_to_discr_class.get(discr_value) - if used_model_class is None: - # We didn't find a discriminated class in class_name_to_discr_class. - # So look in the ancestor or descendant discriminators - # The discriminator mapping may exist in a descendant (anyOf, oneOf) - # or ancestor (allOf). - # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat - # hierarchy, the discriminator mappings may be defined at any level - # in the hierarchy. - # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig - # if we try to make BasquePig from mammal, we need to travel through - # the oneOf descendant discriminators to find BasquePig - descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ - model_class._composed_schemas.get('anyOf', ()) - ancestor_classes = model_class._composed_schemas.get('allOf', ()) - possible_classes = descendant_classes + ancestor_classes - for cls in possible_classes: - # Check if the schema has inherited discriminators. - if hasattr(cls, 'discriminator') and cls.discriminator is not None: - used_model_class = get_discriminator_class( - cls, discr_name, discr_value, cls_visited) - if used_model_class is not None: - return used_model_class - return used_model_class - - -def deserialize_model(model_data, model_class, path_to_item, check_type, - configuration, spec_property_naming): - """Deserializes model_data to model instance. - - Args: - model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model - model_class (OpenApiModel): the model class - path_to_item (list): path to the model in the received data - check_type (bool): whether to check the data tupe for the values in - the model - configuration (Configuration): the instance to use to convert files - 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 variables names in the input data are python - variable names in PEP-8 snake case. - - Returns: - model instance - - Raise: - ApiTypeError - ApiValueError - ApiKeyError - """ - - kw_args = dict(_check_type=check_type, - _path_to_item=path_to_item, - _configuration=configuration, - _spec_property_naming=spec_property_naming) - - if issubclass(model_class, ModelSimple): - return model_class._new_from_openapi_data(model_data, **kw_args) - elif isinstance(model_data, list): - return model_class._new_from_openapi_data(*model_data, **kw_args) - if isinstance(model_data, dict): - kw_args.update(model_data) - return model_class._new_from_openapi_data(**kw_args) - elif isinstance(model_data, PRIMITIVE_TYPES): - return model_class._new_from_openapi_data(model_data, **kw_args) - - -def deserialize_file(response_data, configuration, content_disposition=None): - """Deserializes body to file - - Saves response body into a file in a temporary folder, - using the filename from the `Content-Disposition` header if provided. - - Args: - param response_data (str): the file data to write - configuration (Configuration): the instance to use to convert files - - Keyword Args: - content_disposition (str): the value of the Content-Disposition - header - - Returns: - (file_type): the deserialized file which is open - The user is responsible for closing and reading the file - """ - fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) - os.close(fd) - os.remove(path) - - if content_disposition: - filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', - content_disposition, - flags=re.I) - if filename is not None: - filename = filename.group(1) - else: - filename = "default_" + str(uuid.uuid4()) - - path = os.path.join(os.path.dirname(path), filename) - - with open(path, "wb") as f: - if isinstance(response_data, str): - # change str to bytes so we can write it - response_data = response_data.encode('utf-8') - f.write(response_data) - - f = open(path, "rb") - return f - - -def attempt_convert_item(input_value, valid_classes, path_to_item, - configuration, spec_property_naming, key_type=False, - must_convert=False, check_type=True): - """ - Args: - input_value (any): the data to convert - valid_classes (any): the classes that are valid - path_to_item (list): the path to the item to convert - configuration (Configuration): the instance to use to convert files - 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 variables names in the input data are python - variable names in PEP-8 snake case. - key_type (bool): if True we need to convert a key type (not supported) - must_convert (bool): if True we must convert - check_type (bool): if True we check the type or the returned data in - ModelComposed/ModelNormal/ModelSimple instances - - Returns: - instance (any) the fixed item - - Raises: - ApiTypeError - ApiValueError - ApiKeyError - """ - valid_classes_ordered = order_response_types(valid_classes) - valid_classes_coercible = remove_uncoercible( - valid_classes_ordered, input_value, spec_property_naming) - if not valid_classes_coercible or key_type: - # we do not handle keytype errors, json will take care - # of this for us - if configuration is None or not configuration.discard_unknown_keys: - raise get_type_error(input_value, path_to_item, valid_classes, - key_type=key_type) - for valid_class in valid_classes_coercible: - try: - if issubclass(valid_class, OpenApiModel): - return deserialize_model(input_value, valid_class, - path_to_item, check_type, - configuration, spec_property_naming) - elif valid_class == file_type: - return deserialize_file(input_value, configuration) - return deserialize_primitive(input_value, valid_class, - path_to_item) - except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: - if must_convert: - raise conversion_exc - # if we have conversion errors when must_convert == False - # we ignore the exception and move on to the next class - continue - # we were unable to convert, must_convert == False - return input_value - - -def is_type_nullable(input_type): - """ - Returns true if None is an allowed value for the specified input_type. - - A type is nullable if at least one of the following conditions is true: - 1. The OAS 'nullable' attribute has been specified, - 1. The type is the 'null' type, - 1. The type is a anyOf/oneOf composed schema, and a child schema is - the 'null' type. - Args: - input_type (type): the class of the input_value that we are - checking - Returns: - bool - """ - if input_type is none_type: - return True - if issubclass(input_type, OpenApiModel) and input_type._nullable: - return True - if issubclass(input_type, ModelComposed): - # If oneOf/anyOf, check if the 'null' type is one of the allowed types. - for t in input_type._composed_schemas.get('oneOf', ()): - if is_type_nullable(t): - return True - for t in input_type._composed_schemas.get('anyOf', ()): - if is_type_nullable(t): - return True - return False - - -def is_valid_type(input_class_simple, valid_classes): - """ - Args: - input_class_simple (class): the class of the input_value that we are - checking - valid_classes (tuple): the valid classes that the current item - should be - Returns: - bool - """ - if issubclass(input_class_simple, OpenApiModel) and \ - valid_classes == (bool, date, datetime, dict, float, int, list, str, none_type,): - return True - valid_type = input_class_simple in valid_classes - if not valid_type and ( - issubclass(input_class_simple, OpenApiModel) or - input_class_simple is none_type): - for valid_class in valid_classes: - if input_class_simple is none_type and is_type_nullable(valid_class): - # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. - return True - if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): - continue - discr_propertyname_py = list(valid_class.discriminator.keys())[0] - discriminator_classes = ( - valid_class.discriminator[discr_propertyname_py].values() - ) - valid_type = is_valid_type(input_class_simple, discriminator_classes) - if valid_type: - return True - return valid_type - - -def validate_and_convert_types(input_value, required_types_mixed, path_to_item, - spec_property_naming, _check_type, configuration=None): - """Raises a TypeError is there is a problem, otherwise returns value - - Args: - input_value (any): the data to validate/convert - required_types_mixed (list/dict/tuple): A list of - valid classes, or a list tuples of valid classes, or a dict where - the value is a tuple of value classes - path_to_item: (list) the path to the data being validated - this stores a list of keys or indices to get to the data being - validated - 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 variables names in the input data are python - variable names in PEP-8 snake case. - _check_type: (boolean) if true, type will be checked and conversion - will be attempted. - configuration: (Configuration): the configuration class to use - when converting file_type items. - If passed, conversion will be attempted when possible - If not passed, no conversions will be attempted and - exceptions will be raised - - Returns: - the correctly typed value - - Raises: - ApiTypeError - """ - results = get_required_type_classes(required_types_mixed, spec_property_naming) - valid_classes, child_req_types_by_current_type = results - - input_class_simple = get_simple_class(input_value) - valid_type = is_valid_type(input_class_simple, valid_classes) - if not valid_type: - if (configuration - or (input_class_simple == dict - and dict not in valid_classes)): - # if input_value is not valid_type try to convert it - converted_instance = attempt_convert_item( - input_value, - valid_classes, - path_to_item, - configuration, - spec_property_naming, - key_type=False, - must_convert=True, - check_type=_check_type - ) - return converted_instance - else: - raise get_type_error(input_value, path_to_item, valid_classes, - key_type=False) - - # input_value's type is in valid_classes - if len(valid_classes) > 1 and configuration: - # there are valid classes which are not the current class - valid_classes_coercible = remove_uncoercible( - valid_classes, input_value, spec_property_naming, must_convert=False) - if valid_classes_coercible: - converted_instance = attempt_convert_item( - input_value, - valid_classes_coercible, - path_to_item, - configuration, - spec_property_naming, - key_type=False, - must_convert=False, - check_type=_check_type - ) - return converted_instance - - if child_req_types_by_current_type == {}: - # all types are of the required types and there are no more inner - # variables left to look at - return input_value - inner_required_types = child_req_types_by_current_type.get( - type(input_value) - ) - if inner_required_types is None: - # for this type, there are not more inner variables left to look at - return input_value - if isinstance(input_value, list): - if input_value == []: - # allow an empty list - return input_value - for index, inner_value in enumerate(input_value): - inner_path = list(path_to_item) - inner_path.append(index) - input_value[index] = validate_and_convert_types( - inner_value, - inner_required_types, - inner_path, - spec_property_naming, - _check_type, - configuration=configuration - ) - elif isinstance(input_value, dict): - if input_value == {}: - # allow an empty dict - return input_value - for inner_key, inner_val in input_value.items(): - inner_path = list(path_to_item) - inner_path.append(inner_key) - if get_simple_class(inner_key) != str: - raise get_type_error(inner_key, inner_path, valid_classes, - key_type=True) - input_value[inner_key] = validate_and_convert_types( - inner_val, - inner_required_types, - inner_path, - spec_property_naming, - _check_type, - configuration=configuration - ) - return input_value - - -def model_to_dict(model_instance, serialize=True): - """Returns the model properties as a dict - - Args: - model_instance (one of your model instances): the model instance that - will be converted to a dict. - - Keyword Args: - serialize (bool): if True, the keys in the dict will be values from - attribute_map - """ - result = {} - - def extract_item(item): return ( - item[0], model_to_dict( - item[1], serialize=serialize)) if hasattr( - item[1], '_data_store') else item - - model_instances = [model_instance] - if model_instance._composed_schemas: - model_instances.extend(model_instance._composed_instances) - seen_json_attribute_names = set() - used_fallback_python_attribute_names = set() - py_to_json_map = {} - for model_instance in model_instances: - for attr, value in model_instance._data_store.items(): - if serialize: - # we use get here because additional property key names do not - # exist in attribute_map - try: - attr = model_instance.attribute_map[attr] - py_to_json_map.update(model_instance.attribute_map) - seen_json_attribute_names.add(attr) - except KeyError: - used_fallback_python_attribute_names.add(attr) - if isinstance(value, list): - if not value: - # empty list or None - result[attr] = value - else: - res = [] - for v in value: - if isinstance(v, PRIMITIVE_TYPES) or v is None: - res.append(v) - elif isinstance(v, ModelSimple): - res.append(v.value) - elif isinstance(v, dict): - res.append(dict(map( - extract_item, - v.items() - ))) - else: - res.append(model_to_dict(v, serialize=serialize)) - result[attr] = res - elif isinstance(value, dict): - result[attr] = dict(map( - extract_item, - value.items() - )) - elif isinstance(value, ModelSimple): - result[attr] = value.value - elif hasattr(value, '_data_store'): - result[attr] = model_to_dict(value, serialize=serialize) - else: - result[attr] = value - if serialize: - for python_key in used_fallback_python_attribute_names: - json_key = py_to_json_map.get(python_key) - if json_key is None: - continue - if python_key == json_key: - continue - json_key_assigned_no_need_for_python_key = json_key in seen_json_attribute_names - if json_key_assigned_no_need_for_python_key: - del result[python_key] - - return result - - -def type_error_message(var_value=None, var_name=None, valid_classes=None, - key_type=None): - """ - Keyword Args: - var_value (any): the variable which has the type_error - var_name (str): the name of the variable which has the typ error - valid_classes (tuple): the accepted classes for current_item's - value - key_type (bool): False if our value is a value in a dict - True if it is a key in a dict - False if our item is an item in a list - """ - key_or_value = 'value' - if key_type: - key_or_value = 'key' - valid_classes_phrase = get_valid_classes_phrase(valid_classes) - msg = ( - "Invalid type for variable '{0}'. Required {1} type {2} and " - "passed type was {3}".format( - var_name, - key_or_value, - valid_classes_phrase, - type(var_value).__name__, - ) - ) - return msg - - -def get_valid_classes_phrase(input_classes): - """Returns a string phrase describing what types are allowed - """ - all_classes = list(input_classes) - all_classes = sorted(all_classes, key=lambda cls: cls.__name__) - all_class_names = [cls.__name__ for cls in all_classes] - if len(all_class_names) == 1: - return 'is {0}'.format(all_class_names[0]) - return "is one of [{0}]".format(", ".join(all_class_names)) - - -def get_allof_instances(self, model_args, constant_args): - """ - Args: - self: the class we are handling - model_args (dict): var_name to var_value - used to make instances - constant_args (dict): - metadata arguments: - _check_type - _path_to_item - _spec_property_naming - _configuration - _visited_composed_classes - - Returns - composed_instances (list) - """ - composed_instances = [] - for allof_class in self._composed_schemas['allOf']: - - try: - if constant_args.get('_spec_property_naming'): - allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) - else: - allof_instance = allof_class(**model_args, **constant_args) - composed_instances.append(allof_instance) - except Exception as ex: - raise ApiValueError( - "Invalid inputs given to generate an instance of '%s'. The " - "input data was invalid for the allOf schema '%s' in the composed " - "schema '%s'. Error=%s" % ( - allof_class.__name__, - allof_class.__name__, - self.__class__.__name__, - str(ex) - ) - ) from ex - return composed_instances - - -def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): - """ - Find the oneOf schema that matches the input data (e.g. payload). - If exactly one schema matches the input data, an instance of that schema - is returned. - If zero or more than one schema match the input data, an exception is raised. - In OAS 3.x, the payload MUST, by validation, match exactly one of the - schemas described by oneOf. - - Args: - cls: the class we are handling - model_kwargs (dict): var_name to var_value - The input data, e.g. the payload that must match a oneOf schema - in the OpenAPI document. - constant_kwargs (dict): var_name to var_value - args that every model requires, including configuration, server - and path to item. - - Kwargs: - model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): - the value to assign to a primitive class or ModelSimple class - Notes: - - this is only passed in when oneOf includes types which are not object - - None is used to suppress handling of model_arg, nullable models are handled in __new__ - - Returns - oneof_instance (instance) - """ - if len(cls._composed_schemas['oneOf']) == 0: - return None - - oneof_instances = [] - # Iterate over each oneOf schema and determine if the input data - # matches the oneOf schemas. - for oneof_class in cls._composed_schemas['oneOf']: - # The composed oneOf schema allows the 'null' type and the input data - # is the null value. This is a OAS >= 3.1 feature. - if oneof_class is none_type: - # skip none_types because we are deserializing dict data. - # none_type deserialization is handled in the __new__ method - continue - - single_value_input = allows_single_value_input(oneof_class) - - try: - if not single_value_input: - if constant_kwargs.get('_spec_property_naming'): - oneof_instance = oneof_class._from_openapi_data( - **model_kwargs, **constant_kwargs) - else: - oneof_instance = oneof_class(**model_kwargs, **constant_kwargs) - else: - if issubclass(oneof_class, ModelSimple): - if constant_kwargs.get('_spec_property_naming'): - oneof_instance = oneof_class._from_openapi_data( - model_arg, **constant_kwargs) - else: - oneof_instance = oneof_class(model_arg, **constant_kwargs) - elif oneof_class in PRIMITIVE_TYPES: - oneof_instance = validate_and_convert_types( - model_arg, - (oneof_class,), - constant_kwargs['_path_to_item'], - constant_kwargs['_spec_property_naming'], - constant_kwargs['_check_type'], - configuration=constant_kwargs['_configuration'] - ) - oneof_instances.append(oneof_instance) - except Exception: - pass - if len(oneof_instances) == 0: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. None " - "of the oneOf schemas matched the input data." % - cls.__name__ - ) - elif len(oneof_instances) > 1: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. Multiple " - "oneOf schemas matched the inputs, but a max of one is allowed." % - cls.__name__ - ) - return oneof_instances[0] - - -def get_anyof_instances(self, model_args, constant_args): - """ - Args: - self: the class we are handling - model_args (dict): var_name to var_value - The input data, e.g. the payload that must match at least one - anyOf child schema in the OpenAPI document. - constant_args (dict): var_name to var_value - args that every model requires, including configuration, server - and path to item. - - Returns - anyof_instances (list) - """ - anyof_instances = [] - if len(self._composed_schemas['anyOf']) == 0: - return anyof_instances - - for anyof_class in self._composed_schemas['anyOf']: - # The composed oneOf schema allows the 'null' type and the input data - # is the null value. This is a OAS >= 3.1 feature. - if anyof_class is none_type: - # skip none_types because we are deserializing dict data. - # none_type deserialization is handled in the __new__ method - continue - - try: - if constant_args.get('_spec_property_naming'): - anyof_instance = anyof_class._from_openapi_data(**model_args, **constant_args) - else: - anyof_instance = anyof_class(**model_args, **constant_args) - anyof_instances.append(anyof_instance) - except Exception: - pass - if len(anyof_instances) == 0: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. None of the " - "anyOf schemas matched the inputs." % - self.__class__.__name__ - ) - return anyof_instances - - -def get_discarded_args(self, composed_instances, model_args): - """ - Gathers the args that were discarded by configuration.discard_unknown_keys - """ - model_arg_keys = model_args.keys() - discarded_args = set() - # arguments passed to self were already converted to python names - # before __init__ was called - for instance in composed_instances: - if instance.__class__ in self._composed_schemas['allOf']: - try: - keys = instance.to_dict().keys() - discarded_keys = model_args - keys - discarded_args.update(discarded_keys) - except Exception: - # allOf integer schema will throw exception - pass - else: - try: - all_keys = set(model_to_dict(instance, serialize=False).keys()) - js_keys = model_to_dict(instance, serialize=True).keys() - all_keys.update(js_keys) - discarded_keys = model_arg_keys - all_keys - discarded_args.update(discarded_keys) - except Exception: - # allOf integer schema will throw exception - pass - return discarded_args - - -def validate_get_composed_info(constant_args, model_args, self): - """ - For composed schemas, generate schema instances for - all schemas in the oneOf/anyOf/allOf definition. If additional - properties are allowed, also assign those properties on - all matched schemas that contain additionalProperties. - Openapi schemas are python classes. - - Exceptions are raised if: - - 0 or > 1 oneOf schema matches the model_args input data - - no anyOf schema matches the model_args input data - - any of the allOf schemas do not match the model_args input data - - Args: - constant_args (dict): these are the args that every model requires - model_args (dict): these are the required and optional spec args that - were passed in to make this model - self (class): the class that we are instantiating - This class contains self._composed_schemas - - Returns: - composed_info (list): length three - composed_instances (list): the composed instances which are not - self - var_name_to_model_instances (dict): a dict going from var_name - to the model_instance which holds that var_name - the model_instance may be self or an instance of one of the - classes in self.composed_instances() - additional_properties_model_instances (list): a list of the - model instances which have the property - additional_properties_type. This list can include self - """ - # create composed_instances - composed_instances = [] - allof_instances = get_allof_instances(self, model_args, constant_args) - composed_instances.extend(allof_instances) - oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) - if oneof_instance is not None: - composed_instances.append(oneof_instance) - anyof_instances = get_anyof_instances(self, model_args, constant_args) - composed_instances.extend(anyof_instances) - """ - set additional_properties_model_instances - additional properties must be evaluated at the schema level - so self's additional properties are most important - If self is a composed schema with: - - no properties defined in self - - additionalProperties: False - Then for object payloads every property is an additional property - and they are not allowed, so only empty dict is allowed - - Properties must be set on all matching schemas - so when a property is assigned toa composed instance, it must be set on all - composed instances regardless of additionalProperties presence - keeping it to prevent breaking changes in v5.0.1 - TODO remove cls._additional_properties_model_instances in 6.0.0 - """ - additional_properties_model_instances = [] - if self.additional_properties_type is not None: - additional_properties_model_instances = [self] - - """ - no need to set properties on self in here, they will be set in __init__ - By here all composed schema oneOf/anyOf/allOf instances have their properties set using - model_args - """ - discarded_args = get_discarded_args(self, composed_instances, model_args) - - # map variable names to composed_instances - var_name_to_model_instances = {} - for prop_name in model_args: - if prop_name not in discarded_args: - var_name_to_model_instances[prop_name] = [self] + list( - filter( - lambda x: prop_name in x.openapi_types, composed_instances)) - - return [ - composed_instances, - var_name_to_model_instances, - additional_properties_model_instances, - discarded_args - ] diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/models/__init__.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/models/__init__.py deleted file mode 100644 index 9afedffb..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/models/__init__.py +++ /dev/null @@ -1,114 +0,0 @@ -# flake8: noqa - -# import all models into this package -# if you have many models here with many references from one model to another this may -# raise a RecursionError -# to avoid this, import only the models that you directly need like: -# from criteo_api_marketingsolutions_v2023_01.model.pet import Pet -# or import this package, but before doing it, use: -# import sys -# sys.setrecursionlimit(n) - -from criteo_api_marketingsolutions_v2023_01.model.ad_set_category_bid import AdSetCategoryBid -from criteo_api_marketingsolutions_v2023_01.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse -from criteo_api_marketingsolutions_v2023_01.model.ad_set_category_bid_resource import AdSetCategoryBidResource -from criteo_api_marketingsolutions_v2023_01.model.ad_set_delivery_limitations import AdSetDeliveryLimitations -from criteo_api_marketingsolutions_v2023_01.model.ad_set_display_multiplier import AdSetDisplayMultiplier -from criteo_api_marketingsolutions_v2023_01.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse -from criteo_api_marketingsolutions_v2023_01.model.ad_set_display_multiplier_resource import AdSetDisplayMultiplierResource -from criteo_api_marketingsolutions_v2023_01.model.ad_set_frequency_capping import AdSetFrequencyCapping -from criteo_api_marketingsolutions_v2023_01.model.ad_set_geo_location import AdSetGeoLocation -from criteo_api_marketingsolutions_v2023_01.model.ad_set_search_filter import AdSetSearchFilter -from criteo_api_marketingsolutions_v2023_01.model.ad_set_targeting import AdSetTargeting -from criteo_api_marketingsolutions_v2023_01.model.ad_set_targeting_rule import AdSetTargetingRule -from criteo_api_marketingsolutions_v2023_01.model.application_summary_model import ApplicationSummaryModel -from criteo_api_marketingsolutions_v2023_01.model.application_summary_model_resource import ApplicationSummaryModelResource -from criteo_api_marketingsolutions_v2023_01.model.application_summary_model_response import ApplicationSummaryModelResponse -from criteo_api_marketingsolutions_v2023_01.model.audience import Audience -from criteo_api_marketingsolutions_v2023_01.model.audience_attributes import AudienceAttributes -from criteo_api_marketingsolutions_v2023_01.model.audience_error import AudienceError -from criteo_api_marketingsolutions_v2023_01.model.audience_name_description import AudienceNameDescription -from criteo_api_marketingsolutions_v2023_01.model.audience_warning import AudienceWarning -from criteo_api_marketingsolutions_v2023_01.model.basic_audience_definition import BasicAudienceDefinition -from criteo_api_marketingsolutions_v2023_01.model.campaign import Campaign -from criteo_api_marketingsolutions_v2023_01.model.campaign_list_response import CampaignListResponse -from criteo_api_marketingsolutions_v2023_01.model.campaign_read_resource import CampaignReadResource -from criteo_api_marketingsolutions_v2023_01.model.campaign_response import CampaignResponse -from criteo_api_marketingsolutions_v2023_01.model.campaign_search_filters import CampaignSearchFilters -from criteo_api_marketingsolutions_v2023_01.model.campaign_search_request import CampaignSearchRequest -from criteo_api_marketingsolutions_v2023_01.model.campaign_spend_limit import CampaignSpendLimit -from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem -from criteo_api_marketingsolutions_v2023_01.model.contactlist_amendment import ContactlistAmendment -from criteo_api_marketingsolutions_v2023_01.model.contactlist_amendment_attributes import ContactlistAmendmentAttributes -from criteo_api_marketingsolutions_v2023_01.model.contactlist_amendment_request import ContactlistAmendmentRequest -from criteo_api_marketingsolutions_v2023_01.model.contactlist_operation import ContactlistOperation -from criteo_api_marketingsolutions_v2023_01.model.contactlist_operation_attributes import ContactlistOperationAttributes -from criteo_api_marketingsolutions_v2023_01.model.criteo_api_error import CriteoApiError -from criteo_api_marketingsolutions_v2023_01.model.criteo_api_warning import CriteoApiWarning -from criteo_api_marketingsolutions_v2023_01.model.delete_audience_contact_list_response import DeleteAudienceContactListResponse -from criteo_api_marketingsolutions_v2023_01.model.delete_audience_response import DeleteAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.entity_of_portfolio_message import EntityOfPortfolioMessage -from criteo_api_marketingsolutions_v2023_01.model.error_code_response import ErrorCodeResponse -from criteo_api_marketingsolutions_v2023_01.model.get_audiences_response import GetAudiencesResponse -from criteo_api_marketingsolutions_v2023_01.model.get_portfolio_response import GetPortfolioResponse -from criteo_api_marketingsolutions_v2023_01.model.modify_audience_response import ModifyAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.new_audience import NewAudience -from criteo_api_marketingsolutions_v2023_01.model.new_audience_attributes import NewAudienceAttributes -from criteo_api_marketingsolutions_v2023_01.model.new_audience_request import NewAudienceRequest -from criteo_api_marketingsolutions_v2023_01.model.new_audience_response import NewAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.nillable_ad_set_targeting_rule import NillableAdSetTargetingRule -from criteo_api_marketingsolutions_v2023_01.model.nillable_ad_set_targeting_rule_value import NillableAdSetTargetingRuleValue -from criteo_api_marketingsolutions_v2023_01.model.nillable_date_time import NillableDateTime -from criteo_api_marketingsolutions_v2023_01.model.nillable_decimal import NillableDecimal -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set import PatchAdSet -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_bidding import PatchAdSetBidding -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_budget import PatchAdSetBudget -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid import PatchAdSetCategoryBid -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_list_request import PatchAdSetCategoryBidListRequest -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_resource import PatchAdSetCategoryBidResource -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_result_list_response import PatchAdSetCategoryBidResultListResponse -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_result_resource import PatchAdSetCategoryBidResultResource -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier import PatchAdSetDisplayMultiplier -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_list_request import PatchAdSetDisplayMultiplierListRequest -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_resource import PatchAdSetDisplayMultiplierResource -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_result_list_response import PatchAdSetDisplayMultiplierResultListResponse -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_result_resource import PatchAdSetDisplayMultiplierResultResource -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_scheduling import PatchAdSetScheduling -from criteo_api_marketingsolutions_v2023_01.model.patch_campaign import PatchCampaign -from criteo_api_marketingsolutions_v2023_01.model.patch_campaign_list_request import PatchCampaignListRequest -from criteo_api_marketingsolutions_v2023_01.model.patch_campaign_spend_limit import PatchCampaignSpendLimit -from criteo_api_marketingsolutions_v2023_01.model.patch_campaign_write_resource import PatchCampaignWriteResource -from criteo_api_marketingsolutions_v2023_01.model.patch_result_campaign_list_response import PatchResultCampaignListResponse -from criteo_api_marketingsolutions_v2023_01.model.patch_result_campaign_read_resource import PatchResultCampaignReadResource -from criteo_api_marketingsolutions_v2023_01.model.placements_report_query_data_message import PlacementsReportQueryDataMessage -from criteo_api_marketingsolutions_v2023_01.model.placements_report_query_entity_message import PlacementsReportQueryEntityMessage -from criteo_api_marketingsolutions_v2023_01.model.placements_report_query_message import PlacementsReportQueryMessage -from criteo_api_marketingsolutions_v2023_01.model.portfolio_message import PortfolioMessage -from criteo_api_marketingsolutions_v2023_01.model.problem_details import ProblemDetails -from criteo_api_marketingsolutions_v2023_01.model.problems_details import ProblemsDetails -from criteo_api_marketingsolutions_v2023_01.model.read_ad_set import ReadAdSet -from criteo_api_marketingsolutions_v2023_01.model.read_ad_set_bidding import ReadAdSetBidding -from criteo_api_marketingsolutions_v2023_01.model.read_ad_set_budget import ReadAdSetBudget -from criteo_api_marketingsolutions_v2023_01.model.read_ad_set_schedule import ReadAdSetSchedule -from criteo_api_marketingsolutions_v2023_01.model.read_model_ad_set_id import ReadModelAdSetId -from criteo_api_marketingsolutions_v2023_01.model.read_model_read_ad_set import ReadModelReadAdSet -from criteo_api_marketingsolutions_v2023_01.model.replace_audience import ReplaceAudience -from criteo_api_marketingsolutions_v2023_01.model.replace_audience_request import ReplaceAudienceRequest -from criteo_api_marketingsolutions_v2023_01.model.replace_audience_response import ReplaceAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.request_ad_set_search import RequestAdSetSearch -from criteo_api_marketingsolutions_v2023_01.model.requests_ad_set_id import RequestsAdSetId -from criteo_api_marketingsolutions_v2023_01.model.requests_patch_ad_set import RequestsPatchAdSet -from criteo_api_marketingsolutions_v2023_01.model.response_read_ad_set import ResponseReadAdSet -from criteo_api_marketingsolutions_v2023_01.model.responses_ad_set_id import ResponsesAdSetId -from criteo_api_marketingsolutions_v2023_01.model.responses_read_ad_set import ResponsesReadAdSet -from criteo_api_marketingsolutions_v2023_01.model.statistics_report_query_message import StatisticsReportQueryMessage -from criteo_api_marketingsolutions_v2023_01.model.transactions_report_query_data_message import TransactionsReportQueryDataMessage -from criteo_api_marketingsolutions_v2023_01.model.transactions_report_query_entity_message import TransactionsReportQueryEntityMessage -from criteo_api_marketingsolutions_v2023_01.model.transactions_report_query_message import TransactionsReportQueryMessage -from criteo_api_marketingsolutions_v2023_01.model.transparency_query_message import TransparencyQueryMessage -from criteo_api_marketingsolutions_v2023_01.model.transparency_report_attributes import TransparencyReportAttributes -from criteo_api_marketingsolutions_v2023_01.model.transparency_report_data_message import TransparencyReportDataMessage -from criteo_api_marketingsolutions_v2023_01.model.transparency_report_entity_message import TransparencyReportEntityMessage -from criteo_api_marketingsolutions_v2023_01.model.transparency_report_file import TransparencyReportFile -from criteo_api_marketingsolutions_v2023_01.model.write_model_ad_set_id import WriteModelAdSetId -from criteo_api_marketingsolutions_v2023_01.model.write_model_patch_ad_set import WriteModelPatchAdSet diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/rest.py b/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/rest.py deleted file mode 100644 index 2b2549be..00000000 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/rest.py +++ /dev/null @@ -1,352 +0,0 @@ -""" - Criteo API - - Criteo API - MarketingSolutions # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import io -import json -import logging -import re -import ssl -from urllib.parse import urlencode -from urllib.parse import urlparse -from urllib.request import proxy_bypass_environment -import urllib3 -import ipaddress - -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError - - -logger = logging.getLogger(__name__) - - -class RESTResponse(io.IOBase): - - def __init__(self, resp): - self.urllib3_response = resp - self.status = resp.status - self.reason = resp.reason - self.data = resp.data - - def getheaders(self): - """Returns a dictionary of the response headers.""" - return self.urllib3_response.getheaders() - - def getheader(self, name, default=None): - """Returns a given response header.""" - return self.urllib3_response.getheader(name, default) - - -class RESTClientObject(object): - - def __init__(self, configuration, pools_size=4, maxsize=None): - # urllib3.PoolManager will pass all kw parameters to connectionpool - # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 - # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 - # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 - # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 - - # cert_reqs - if configuration.verify_ssl: - cert_reqs = ssl.CERT_REQUIRED - else: - cert_reqs = ssl.CERT_NONE - - addition_pool_args = {} - if configuration.assert_hostname is not None: - addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 - - if configuration.retries is not None: - addition_pool_args['retries'] = configuration.retries - - if configuration.socket_options is not None: - addition_pool_args['socket_options'] = configuration.socket_options - - if maxsize is None: - if configuration.connection_pool_maxsize is not None: - maxsize = configuration.connection_pool_maxsize - else: - maxsize = 4 - - # https pool manager - if configuration.proxy and not should_bypass_proxies( - configuration.host, no_proxy=configuration.no_proxy or ''): - self.pool_manager = urllib3.ProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=configuration.ssl_ca_cert, - cert_file=configuration.cert_file, - key_file=configuration.key_file, - proxy_url=configuration.proxy, - proxy_headers=configuration.proxy_headers, - **addition_pool_args - ) - else: - self.pool_manager = urllib3.PoolManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=configuration.ssl_ca_cert, - cert_file=configuration.cert_file, - key_file=configuration.key_file, - **addition_pool_args - ) - - def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None, _preload_content=True, - _request_timeout=None): - """Perform requests. - - :param method: http request method - :param url: http request url - :param query_params: query parameters in the url - :param headers: http request headers - :param body: request json body, for `application/json` - :param post_params: request post parameters, - `application/x-www-form-urlencoded` - and `multipart/form-data` - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: 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. - """ - method = method.upper() - assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', - 'PATCH', 'OPTIONS'] - - if post_params and body: - raise ApiValueError( - "body parameter cannot be used with post_params parameter." - ) - - post_params = post_params or {} - headers = headers or {} - - timeout = None - if _request_timeout: - if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 - timeout = urllib3.Timeout(total=_request_timeout) - elif (isinstance(_request_timeout, tuple) and - len(_request_timeout) == 2): - timeout = urllib3.Timeout( - connect=_request_timeout[0], read=_request_timeout[1]) - - try: - # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` - if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: - # Only set a default Content-Type for POST, PUT, PATCH and OPTIONS requests - if (method != 'DELETE') and ('Content-Type' not in headers): - headers['Content-Type'] = 'application/json' - if query_params: - url += '?' + urlencode(query_params) - if ('Content-Type' not in headers) or (re.search('json', - headers['Content-Type'], re.IGNORECASE)): - request_body = None - if body is not None: - request_body = json.dumps(body) - r = self.pool_manager.request( - method, url, - body=request_body, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 - r = self.pool_manager.request( - method, url, - fields=post_params, - encode_multipart=False, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - elif headers['Content-Type'] == 'multipart/form-data': - # must del headers['Content-Type'], or the correct - # Content-Type which generated by urllib3 will be - # overwritten. - del headers['Content-Type'] - r = self.pool_manager.request( - method, url, - fields=post_params, - encode_multipart=True, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - # Pass a `string` parameter directly in the body to support - # other content types than Json when `body` argument is - # provided in serialized form - elif isinstance(body, str) or isinstance(body, bytes): - request_body = body - r = self.pool_manager.request( - method, url, - body=request_body, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - else: - # Cannot generate the request from given parameters - msg = """Cannot prepare a request message for provided - arguments. Please check that your arguments match - declared content type.""" - raise ApiException(status=0, reason=msg) - # For `GET`, `HEAD` - else: - r = self.pool_manager.request(method, url, - fields=query_params, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - except urllib3.exceptions.SSLError as e: - msg = "{0}\n{1}".format(type(e).__name__, str(e)) - raise ApiException(status=0, reason=msg) - - if _preload_content: - r = RESTResponse(r) - - # log response body - logger.debug("response body: %s", r.data) - - if not 200 <= r.status <= 299: - if r.status == 401: - raise UnauthorizedException(http_resp=r) - - if r.status == 403: - raise ForbiddenException(http_resp=r) - - if r.status == 404: - raise NotFoundException(http_resp=r) - - if 500 <= r.status <= 599: - raise ServiceException(http_resp=r) - - raise ApiException(http_resp=r) - - return r - - def GET(self, url, headers=None, query_params=None, _preload_content=True, - _request_timeout=None): - return self.request("GET", url, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - query_params=query_params) - - def HEAD(self, url, headers=None, query_params=None, _preload_content=True, - _request_timeout=None): - return self.request("HEAD", url, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - query_params=query_params) - - def OPTIONS(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("OPTIONS", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def DELETE(self, url, headers=None, query_params=None, body=None, - _preload_content=True, _request_timeout=None): - return self.request("DELETE", url, - headers=headers, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def POST(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("POST", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def PUT(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("PUT", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def PATCH(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("PATCH", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - -# end of class RESTClientObject - - -def is_ipv4(target): - """ Test if IPv4 address or not - """ - try: - chk = ipaddress.IPv4Address(target) - return True - except ipaddress.AddressValueError: - return False - - -def in_ipv4net(target, net): - """ Test if target belongs to given IPv4 network - """ - try: - nw = ipaddress.IPv4Network(net) - ip = ipaddress.IPv4Address(target) - if ip in nw: - return True - return False - except ipaddress.AddressValueError: - return False - except ipaddress.NetmaskValueError: - return False - - -def should_bypass_proxies(url, no_proxy=None): - """ Yet another requests.should_bypass_proxies - Test if proxies should not be used for a particular url. - """ - - parsed = urlparse(url) - - # special cases - if parsed.hostname in [None, '']: - return True - - # special cases - if no_proxy in [None, '']: - return False - if no_proxy == '*': - return True - - no_proxy = no_proxy.lower().replace(' ', ''); - entries = ( - host for host in no_proxy.split(',') if host - ) - - if is_ipv4(parsed.hostname): - for item in entries: - if in_ipv4net(parsed.hostname, item): - return True - return proxy_bypass_environment(parsed.hostname, {'no': no_proxy}) diff --git a/sdks/marketingsolutions_2023-01/docs/AdSetSearchFilter.md b/sdks/marketingsolutions_2023-01/docs/AdSetSearchFilter.md deleted file mode 100644 index 860098d3..00000000 --- a/sdks/marketingsolutions_2023-01/docs/AdSetSearchFilter.md +++ /dev/null @@ -1,15 +0,0 @@ -# AdSetSearchFilter - -filter on ad set ids - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ad_set_ids** | **[str], none_type** | | [optional] -**advertiser_ids** | **[str], none_type** | | [optional] -**campaign_ids** | **[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/marketingsolutions_2023-01/docs/AnalyticsApi.md b/sdks/marketingsolutions_2023-01/docs/AnalyticsApi.md deleted file mode 100644 index 1e42a0aa..00000000 --- a/sdks/marketingsolutions_2023-01/docs/AnalyticsApi.md +++ /dev/null @@ -1,440 +0,0 @@ -# criteo_api_marketingsolutions_v2023_01.AnalyticsApi - -All URIs are relative to *https://api.criteo.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_adset_report**](AnalyticsApi.md#get_adset_report) | **POST** /2023-01/statistics/report | -[**get_placements_report**](AnalyticsApi.md#get_placements_report) | **POST** /2023-01/placements/report | -[**get_transactions_report**](AnalyticsApi.md#get_transactions_report) | **POST** /2023-01/transactions/report | -[**get_transparency_report**](AnalyticsApi.md#get_transparency_report) | **POST** /2023-01/log-level/advertisers/{advertiser-id}/report | - - -# **get_adset_report** -> file_type get_adset_report() - - - -This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import analytics_api -from criteo_api_marketingsolutions_v2023_01.model.statistics_report_query_message import StatisticsReportQueryMessage -from criteo_api_marketingsolutions_v2023_01.model.problems_details import ProblemsDetails -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = analytics_api.AnalyticsApi(api_client) - statistics_report_query_message = StatisticsReportQueryMessage( - advertiser_ids="advertiser_ids_example", - ad_set_ids=[ - "ad_set_ids_example", - ], - ad_set_names=[ - "ad_set_names_example", - ], - ad_set_status=[ - "ad_set_status_example", - ], - dimensions=[ - "AdsetId", - ], - metrics=[ - "metrics_example", - ], - currency="currency_example", - format="format_example", - timezone="UTC", - start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - ) # StatisticsReportQueryMessage | (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_adset_report(statistics_report_query_message=statistics_report_query_message) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->get_adset_report: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **statistics_report_query_message** | [**StatisticsReportQueryMessage**](StatisticsReportQueryMessage.md)| | [optional] - -### Return type - -**file_type** - -### 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, text/csv, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - - -### 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) - -# **get_placements_report** -> file_type get_placements_report() - - - -Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import analytics_api -from criteo_api_marketingsolutions_v2023_01.model.placements_report_query_data_message import PlacementsReportQueryDataMessage -from criteo_api_marketingsolutions_v2023_01.model.problems_details import ProblemsDetails -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = analytics_api.AnalyticsApi(api_client) - placements_report_query_data_message = PlacementsReportQueryDataMessage( - data=[ - PlacementsReportQueryEntityMessage( - type="type_example", - attributes=PlacementsReportQueryMessage( - advertiser_ids="advertiser_ids_example", - campaign_ids="campaign_ids_example", - adset_ids="adset_ids_example", - environment="environment_example", - placement="placement_example", - dimensions=[ - "AdsetId", - ], - metrics=[ - "metrics_example", - ], - currency="currency_example", - disclosed=True, - format="format_example", - timezone="UTC", - start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - ), - ], - ) # PlacementsReportQueryDataMessage | (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_placements_report(placements_report_query_data_message=placements_report_query_data_message) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->get_placements_report: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **placements_report_query_data_message** | [**PlacementsReportQueryDataMessage**](PlacementsReportQueryDataMessage.md)| | [optional] - -### Return type - -**file_type** - -### 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, text/csv, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - - -### 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) - -# **get_transactions_report** -> file_type get_transactions_report() - - - -This Transactions endpoint provides transactions id related data. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import analytics_api -from criteo_api_marketingsolutions_v2023_01.model.transactions_report_query_data_message import TransactionsReportQueryDataMessage -from criteo_api_marketingsolutions_v2023_01.model.problems_details import ProblemsDetails -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = analytics_api.AnalyticsApi(api_client) - transactions_report_query_data_message = TransactionsReportQueryDataMessage( - data=[ - TransactionsReportQueryEntityMessage( - type="type_example", - attributes=TransactionsReportQueryMessage( - advertiser_ids="advertiser_ids_example", - event_type="event_type_example", - currency="currency_example", - format="format_example", - timezone="UTC", - start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - ), - ], - ) # TransactionsReportQueryDataMessage | (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_transactions_report(transactions_report_query_data_message=transactions_report_query_data_message) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->get_transactions_report: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactions_report_query_data_message** | [**TransactionsReportQueryDataMessage**](TransactionsReportQueryDataMessage.md)| | [optional] - -### Return type - -**file_type** - -### 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, text/csv, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - - -### 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) - -# **get_transparency_report** -> TransparencyReportDataMessage get_transparency_report(advertiser_id) - - - -This Statistics endpoint provides publisher data. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import analytics_api -from criteo_api_marketingsolutions_v2023_01.model.transparency_report_data_message import TransparencyReportDataMessage -from criteo_api_marketingsolutions_v2023_01.model.transparency_query_message import TransparencyQueryMessage -from criteo_api_marketingsolutions_v2023_01.model.problems_details import ProblemsDetails -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = analytics_api.AnalyticsApi(api_client) - advertiser_id = 1 # int | The advertiser id to fetch the transparency data. - transparency_query_message = TransparencyQueryMessage( - should_display_product_ids=False, - start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - ) # TransparencyQueryMessage | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_transparency_report(advertiser_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->get_transparency_report: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_transparency_report(advertiser_id, transparency_query_message=transparency_query_message) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->get_transparency_report: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **advertiser_id** | **int**| The advertiser id to fetch the transparency data. | - **transparency_query_message** | [**TransparencyQueryMessage**](TransparencyQueryMessage.md)| | [optional] - -### Return type - -[**TransparencyReportDataMessage**](TransparencyReportDataMessage.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, text/plain, 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) - diff --git a/sdks/marketingsolutions_2023-01/docs/Audience.md b/sdks/marketingsolutions_2023-01/docs/Audience.md deleted file mode 100644 index 24156138..00000000 --- a/sdks/marketingsolutions_2023-01/docs/Audience.md +++ /dev/null @@ -1,15 +0,0 @@ -# Audience - -Definition of an audience and all its information - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | the name of the entity type | -**id** | **str** | id of the Audience | -**attributes** | [**AudienceAttributes**](AudienceAttributes.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/marketingsolutions_2023-01/docs/AudienceApi.md b/sdks/marketingsolutions_2023-01/docs/AudienceApi.md deleted file mode 100644 index 4b7c21e6..00000000 --- a/sdks/marketingsolutions_2023-01/docs/AudienceApi.md +++ /dev/null @@ -1,568 +0,0 @@ -# criteo_api_marketingsolutions_v2023_01.AudienceApi - -All URIs are relative to *https://api.criteo.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_audience**](AudienceApi.md#create_audience) | **POST** /2023-01/audiences | -[**delete_identifiers**](AudienceApi.md#delete_identifiers) | **DELETE** /2023-01/audiences/{audience-id}/contactlist | -[**get_audiences**](AudienceApi.md#get_audiences) | **GET** /2023-01/audiences | -[**modify_audience**](AudienceApi.md#modify_audience) | **PATCH** /2023-01/audiences/{audience-id} | -[**modify_audience_users**](AudienceApi.md#modify_audience_users) | **PATCH** /2023-01/audiences/{audience-id}/contactlist | -[**remove_audience**](AudienceApi.md#remove_audience) | **DELETE** /2023-01/audiences/{audience-id} | - - -# **create_audience** -> NewAudienceResponse create_audience(new_audience_request) - - - -Create an Audience for an Advertiser - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import audience_api -from criteo_api_marketingsolutions_v2023_01.model.new_audience_request import NewAudienceRequest -from criteo_api_marketingsolutions_v2023_01.model.error_code_response import ErrorCodeResponse -from criteo_api_marketingsolutions_v2023_01.model.new_audience_response import NewAudienceResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - new_audience_request = NewAudienceRequest( - data=NewAudience( - type="Audience", - attributes=NewAudienceAttributes( - advertiser_id="advertiser_id_example", - name="name_example", - description="description_example", - ), - ), - ) # NewAudienceRequest | - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.create_audience(new_audience_request) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->create_audience: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **new_audience_request** | [**NewAudienceRequest**](NewAudienceRequest.md)| | - -### Return type - -[**NewAudienceResponse**](NewAudienceResponse.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** | The audience was created | - | -**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) - -# **delete_identifiers** -> DeleteAudienceContactListResponse delete_identifiers(audience_id) - - - -Delete all identifiers from a contact list audience-segment. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import audience_api -from criteo_api_marketingsolutions_v2023_01.model.delete_audience_contact_list_response import DeleteAudienceContactListResponse -from criteo_api_marketingsolutions_v2023_01.model.error_code_response import ErrorCodeResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - audience_id = "audience-id_example" # str | The id of the audience to amend - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.delete_identifiers(audience_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->delete_identifiers: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **audience_id** | **str**| The id of the audience to amend | - -### Return type - -[**DeleteAudienceContactListResponse**](DeleteAudienceContactListResponse.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 contactlist was deleted | - | -**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_audiences** -> GetAudiencesResponse get_audiences() - - - -Get a list of all the audiences for the user or for the given advertiser_id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import audience_api -from criteo_api_marketingsolutions_v2023_01.model.get_audiences_response import GetAudiencesResponse -from criteo_api_marketingsolutions_v2023_01.model.error_code_response import ErrorCodeResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - advertiser_id = "advertiser-id_example" # str | The advertiser id to get all the audiences for. Mandatory for internal users. For external users, if you don't provide it, we will take into account the advertisers from your portfolio (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_audiences(advertiser_id=advertiser_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->get_audiences: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **advertiser_id** | **str**| The advertiser id to get all the audiences for. Mandatory for internal users. For external users, if you don't provide it, we will take into account the advertisers from your portfolio | [optional] - -### Return type - -[**GetAudiencesResponse**](GetAudiencesResponse.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 list was retrieved. | - | -**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) - -# **modify_audience** -> ReplaceAudienceResponse modify_audience(audience_id, replace_audience_request) - - - -Update user audience specified by the audience id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import audience_api -from criteo_api_marketingsolutions_v2023_01.model.replace_audience_response import ReplaceAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.error_code_response import ErrorCodeResponse -from criteo_api_marketingsolutions_v2023_01.model.replace_audience_request import ReplaceAudienceRequest -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - audience_id = "audience-id_example" # str | The id of the audience to amend - replace_audience_request = ReplaceAudienceRequest( - data=ReplaceAudience( - type="Audience", - attributes=AudienceNameDescription( - name="name_example", - description="description_example", - ), - ), - ) # ReplaceAudienceRequest | - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.modify_audience(audience_id, replace_audience_request) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->modify_audience: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **audience_id** | **str**| The id of the audience to amend | - **replace_audience_request** | [**ReplaceAudienceRequest**](ReplaceAudienceRequest.md)| | - -### Return type - -[**ReplaceAudienceResponse**](ReplaceAudienceResponse.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** | The audience was updated | - | -**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) - -# **modify_audience_users** -> ModifyAudienceResponse modify_audience_users(audience_id, contactlist_amendment_request) - - - -Add/remove users to or from a contact list audience-segment. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import audience_api -from criteo_api_marketingsolutions_v2023_01.model.contactlist_amendment_request import ContactlistAmendmentRequest -from criteo_api_marketingsolutions_v2023_01.model.modify_audience_response import ModifyAudienceResponse -from criteo_api_marketingsolutions_v2023_01.model.error_code_response import ErrorCodeResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - audience_id = "audience-id_example" # str | The id of the audience to amend - contactlist_amendment_request = ContactlistAmendmentRequest( - data=ContactlistAmendment( - type="ContactlistAmendment", - attributes=ContactlistAmendmentAttributes( - operation="add", - identifier_type="email", - identifiers=[ - "identifiers_example", - ], - gum_caller_id=1, - ), - ), - ) # ContactlistAmendmentRequest | - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.modify_audience_users(audience_id, contactlist_amendment_request) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->modify_audience_users: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **audience_id** | **str**| The id of the audience to amend | - **contactlist_amendment_request** | [**ContactlistAmendmentRequest**](ContactlistAmendmentRequest.md)| | - -### Return type - -[**ModifyAudienceResponse**](ModifyAudienceResponse.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** | Summary of created request | - | -**403** | Forbidden | - | -**404** | Audience 123 not 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) - -# **remove_audience** -> DeleteAudienceResponse remove_audience(audience_id) - - - -Delete an audience by id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import audience_api -from criteo_api_marketingsolutions_v2023_01.model.error_code_response import ErrorCodeResponse -from criteo_api_marketingsolutions_v2023_01.model.delete_audience_response import DeleteAudienceResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - audience_id = "audience-id_example" # str | The id of the audience to amend - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.remove_audience(audience_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->remove_audience: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **audience_id** | **str**| The id of the audience to amend | - -### Return type - -[**DeleteAudienceResponse**](DeleteAudienceResponse.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 audience was deleted | - | -**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) - diff --git a/sdks/marketingsolutions_2023-01/docs/AudienceAttributes.md b/sdks/marketingsolutions_2023-01/docs/AudienceAttributes.md deleted file mode 100644 index 0c5ac128..00000000 --- a/sdks/marketingsolutions_2023-01/docs/AudienceAttributes.md +++ /dev/null @@ -1,19 +0,0 @@ -# AudienceAttributes - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the Audience | -**description** | **str** | The string description of the Audience | -**created** | **datetime** | Date and time ISO 8601 formatted string | -**updated** | **datetime** | Date and time ISO 8601 formatted string | -**advertiser_id** | **str, none_type** | The advertiser id that owns this Audience | [optional] -**nb_lines** | **int, none_type** | The number of line in the audience available once processed | [optional] -**nb_lines_email** | **int, none_type** | The number of email line in the audience available once processed | [optional] -**nb_matches_email** | **int, none_type** | The number of email matches in the audience available once processed | [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_2023-01/docs/Campaign.md b/sdks/marketingsolutions_2023-01/docs/Campaign.md deleted file mode 100644 index 8040548f..00000000 --- a/sdks/marketingsolutions_2023-01/docs/Campaign.md +++ /dev/null @@ -1,17 +0,0 @@ -# Campaign - -campaign read model - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str, none_type** | | [optional] -**advertiser_id** | **str, none_type** | | [optional] -**objective** | **str, none_type** | | [optional] -**spend_limit** | [**CampaignSpendLimit**](CampaignSpendLimit.md) | | [optional] -**goal** | **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/marketingsolutions_2023-01/docs/CampaignApi.md b/sdks/marketingsolutions_2023-01/docs/CampaignApi.md deleted file mode 100644 index b90aa42e..00000000 --- a/sdks/marketingsolutions_2023-01/docs/CampaignApi.md +++ /dev/null @@ -1,1223 +0,0 @@ -# criteo_api_marketingsolutions_v2023_01.CampaignApi - -All URIs are relative to *https://api.criteo.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_ad_set**](CampaignApi.md#get_ad_set) | **GET** /2023-01/marketing-solutions/ad-sets/{adSetId} | -[**get_campaign**](CampaignApi.md#get_campaign) | **GET** /2023-01/marketing-solutions/campaigns/{campaign-id} | -[**get_category_bid_list**](CampaignApi.md#get_category_bid_list) | **GET** /2023-01/marketing-solutions/ad-sets/{ad-set-id}/category-bids | -[**get_display_multipliers**](CampaignApi.md#get_display_multipliers) | **GET** /2023-01/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers | -[**patch_ad_sets**](CampaignApi.md#patch_ad_sets) | **PATCH** /2023-01/marketing-solutions/ad-sets | -[**patch_campaigns**](CampaignApi.md#patch_campaigns) | **PATCH** /2023-01/marketing-solutions/campaigns | -[**patch_category_bid_list**](CampaignApi.md#patch_category_bid_list) | **PATCH** /2023-01/marketing-solutions/ad-sets/{ad-set-id}/category-bids | -[**patch_display_multipliers**](CampaignApi.md#patch_display_multipliers) | **PATCH** /2023-01/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers | -[**search_ad_sets**](CampaignApi.md#search_ad_sets) | **POST** /2023-01/marketing-solutions/ad-sets/search | -[**search_campaigns**](CampaignApi.md#search_campaigns) | **POST** /2023-01/marketing-solutions/campaigns/search | -[**start_ad_sets**](CampaignApi.md#start_ad_sets) | **POST** /2023-01/marketing-solutions/ad-sets/start | -[**stop_ad_sets**](CampaignApi.md#stop_ad_sets) | **POST** /2023-01/marketing-solutions/ad-sets/stop | - - -# **get_ad_set** -> ResponseReadAdSet get_ad_set(ad_set_id) - - - -Get the data for the specified ad set - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.response_read_ad_set import ResponseReadAdSet -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - ad_set_id = "adSetId_example" # str | Id of the ad set - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_ad_set(ad_set_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_ad_set: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ad_set_id** | **str**| Id of the ad set | - -### Return type - -[**ResponseReadAdSet**](ResponseReadAdSet.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | data for the ad set | - | -**401** | The API client is not properly authenticated. | - | -**403** | The API client is not authorized to access this resource or the resource does not exist. | - | - -[[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** -> CampaignResponse get_campaign(campaign_id) - - - -Get the data for the specified campaign - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.campaign_response import CampaignResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - campaign_id = "campaign-id_example" # str | Id of the campaign - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_campaign(campaign_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_campaign: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **campaign_id** | **str**| Id of the campaign | - -### Return type - -[**CampaignResponse**](CampaignResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | data for the campaign | - | -**401** | The API client is not properly authenticated. | - | -**403** | The API client is not authorized to access this resource or the resource does not exist. | - | - -[[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_category_bid_list** -> AdSetCategoryBidListResponse get_category_bid_list(ad_set_id) - - - -Get the Category Bids for all valid Categories associated to an Ad Set - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - ad_set_id = "ad-set-id_example" # str | Id of the Ad Set - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_category_bid_list(ad_set_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_category_bid_list: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ad_set_id** | **str**| Id of the Ad Set | - -### Return type - -[**AdSetCategoryBidListResponse**](AdSetCategoryBidListResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Category Bids for all valid Categories associated to an Ad Set. | - | -**401** | The API client is not properly authenticated. | - | -**400** | Bad Request | - | -**403** | The API client is not authorized to access this resource or the resource does not exist. | - | - -[[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_display_multipliers** -> AdSetDisplayMultiplierListResponse get_display_multipliers(ad_set_id) - - - -Get the Display Multipliers for all valid Categories associated to an Ad Set - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - ad_set_id = "ad-set-id_example" # str | Id of the Ad Set - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_display_multipliers(ad_set_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_display_multipliers: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ad_set_id** | **str**| Id of the Ad Set | - -### Return type - -[**AdSetDisplayMultiplierListResponse**](AdSetDisplayMultiplierListResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Display Multipliers for all valid Categories associated to an Ad Set. | - | -**401** | The API client is not properly authenticated. | - | -**400** | Bad Request | - | -**403** | The API client is not authorized to access this resource or the resource does not exist. | - | - -[[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) - -# **patch_ad_sets** -> ResponsesAdSetId patch_ad_sets() - - - -Patch a list of AdSets. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.responses_ad_set_id import ResponsesAdSetId -from criteo_api_marketingsolutions_v2023_01.model.requests_patch_ad_set import RequestsPatchAdSet -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - requests_patch_ad_set = RequestsPatchAdSet( - data=[ - WriteModelPatchAdSet( - id="id_example", - type="PatchAdSet", - attributes=PatchAdSet( - name="name_example", - scheduling=PatchAdSetScheduling( - start_date=NillableDateTime( - value=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - end_date=NillableDateTime( - value=dateutil_parser('1970-01-01T00:00:00.00Z'), - ), - ), - bidding=PatchAdSetBidding( - bid_amount=NillableDecimal( - value=3.14, - ), - ), - targeting=AdSetTargeting( - delivery_limitations=AdSetDeliveryLimitations( - environments=[ - "web", - ], - devices=[ - "other", - ], - operating_systems=[ - "android", - ], - ), - geo_location=AdSetGeoLocation( - countries=NillableAdSetTargetingRule( - value=NillableAdSetTargetingRuleValue(), - ), - subdivisions=NillableAdSetTargetingRule( - value=NillableAdSetTargetingRuleValue(), - ), - zip_codes=NillableAdSetTargetingRule( - value=NillableAdSetTargetingRuleValue(), - ), - ), - frequency_capping=AdSetFrequencyCapping( - frequency="hourly", - maximum_impressions=1, - ), - ), - budget=PatchAdSetBudget( - budget_strategy="capped", - budget_renewal="undefined", - budget_delivery_smoothing="accelerated", - budget_delivery_week="undefined", - budget_amount=NillableDecimal( - value=3.14, - ), - ), - ), - ), - ], - ) # RequestsPatchAdSet | List of adsets to patch. (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.patch_ad_sets(requests_patch_ad_set=requests_patch_ad_set) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->patch_ad_sets: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **requests_patch_ad_set** | [**RequestsPatchAdSet**](RequestsPatchAdSet.md)| List of adsets to patch. | [optional] - -### Return type - -[**ResponsesAdSetId**](ResponsesAdSetId.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** | List of patched adSets. | - | -**401** | The API client is not properly authenticated. | - | -**403** | The API client is not authorized to access this resource or the resource does not exist. | - | - -[[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) - -# **patch_campaigns** -> PatchResultCampaignListResponse patch_campaigns() - - - -Patch a list of Campaigns. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.patch_campaign_list_request import PatchCampaignListRequest -from criteo_api_marketingsolutions_v2023_01.model.patch_result_campaign_list_response import PatchResultCampaignListResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - patch_campaign_list_request = PatchCampaignListRequest( - data=[ - PatchCampaignWriteResource( - id="id_example", - type="Campaign", - attributes=PatchCampaign( - spend_limit=PatchCampaignSpendLimit( - spend_limit_type="capped", - spend_limit_renewal="undefined", - spend_limit_amount=NillableDecimal( - value=3.14, - ), - ), - ), - ), - ], - ) # PatchCampaignListRequest | List of campaigns to patch. (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.patch_campaigns(patch_campaign_list_request=patch_campaign_list_request) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->patch_campaigns: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **patch_campaign_list_request** | [**PatchCampaignListRequest**](PatchCampaignListRequest.md)| List of campaigns to patch. | [optional] - -### Return type - -[**PatchResultCampaignListResponse**](PatchResultCampaignListResponse.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** | List of patched campaigns. | - | -**401** | The API client is not properly authenticated. | - | -**403** | The API client is not authorized to access this resource or the resource does not exist. | - | - -[[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) - -# **patch_category_bid_list** -> PatchAdSetCategoryBidResultListResponse patch_category_bid_list(ad_set_id) - - - -Patch Category Bids for one or more Categories in a single request. Partial success policy is followed. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_result_list_response import PatchAdSetCategoryBidResultListResponse -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_list_request import PatchAdSetCategoryBidListRequest -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - ad_set_id = "ad-set-id_example" # str | Id of the Ad Set - patch_ad_set_category_bid_list_request = PatchAdSetCategoryBidListRequest( - data=[ - PatchAdSetCategoryBidResource( - attributes=PatchAdSetCategoryBid( - bid_amount=3.14, - ), - id="id_example", - type="AdSetCategoryBid", - ), - ], - ) # PatchAdSetCategoryBidListRequest | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.patch_category_bid_list(ad_set_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->patch_category_bid_list: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.patch_category_bid_list(ad_set_id, patch_ad_set_category_bid_list_request=patch_ad_set_category_bid_list_request) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->patch_category_bid_list: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ad_set_id** | **str**| Id of the Ad Set | - **patch_ad_set_category_bid_list_request** | [**PatchAdSetCategoryBidListRequest**](PatchAdSetCategoryBidListRequest.md)| | [optional] - -### Return type - -[**PatchAdSetCategoryBidResultListResponse**](PatchAdSetCategoryBidResultListResponse.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** | List of updated Category Bids for given Categories associated to an Ad Set. | - | -**401** | The API client is not properly authenticated. | - | -**400** | Bad Request | - | -**403** | The API client is not authorized to access this resource or the resource does not exist. | - | - -[[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) - -# **patch_display_multipliers** -> PatchAdSetDisplayMultiplierResultListResponse patch_display_multipliers(ad_set_id) - - - -Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_result_list_response import PatchAdSetDisplayMultiplierResultListResponse -from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_list_request import PatchAdSetDisplayMultiplierListRequest -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - ad_set_id = "ad-set-id_example" # str | Id of the Ad Set - patch_ad_set_display_multiplier_list_request = PatchAdSetDisplayMultiplierListRequest( - data=[ - PatchAdSetDisplayMultiplierResource( - attributes=PatchAdSetDisplayMultiplier( - display_multiplier=3.14, - ), - id="id_example", - type="AdSetDisplayMultiplier", - ), - ], - ) # PatchAdSetDisplayMultiplierListRequest | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.patch_display_multipliers(ad_set_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->patch_display_multipliers: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.patch_display_multipliers(ad_set_id, patch_ad_set_display_multiplier_list_request=patch_ad_set_display_multiplier_list_request) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->patch_display_multipliers: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ad_set_id** | **str**| Id of the Ad Set | - **patch_ad_set_display_multiplier_list_request** | [**PatchAdSetDisplayMultiplierListRequest**](PatchAdSetDisplayMultiplierListRequest.md)| | [optional] - -### Return type - -[**PatchAdSetDisplayMultiplierResultListResponse**](PatchAdSetDisplayMultiplierResultListResponse.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** | List of updated Display Multipliers for given Categories associated to an Ad Set. | - | -**401** | The API client is not properly authenticated. | - | -**400** | Bad Request | - | -**403** | The API client is not authorized to access this resource or the resource does not exist. | - | - -[[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) - -# **search_ad_sets** -> ResponsesReadAdSet search_ad_sets() - - - -Search for ad sets - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.responses_read_ad_set import ResponsesReadAdSet -from criteo_api_marketingsolutions_v2023_01.model.request_ad_set_search import RequestAdSetSearch -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - request_ad_set_search = RequestAdSetSearch( - filters=AdSetSearchFilter( - ad_set_ids=[ - "ad_set_ids_example", - ], - advertiser_ids=[ - "advertiser_ids_example", - ], - campaign_ids=[ - "campaign_ids_example", - ], - ), - ) # RequestAdSetSearch | (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.search_ad_sets(request_ad_set_search=request_ad_set_search) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->search_ad_sets: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request_ad_set_search** | [**RequestAdSetSearch**](RequestAdSetSearch.md)| | [optional] - -### Return type - -[**ResponsesReadAdSet**](ResponsesReadAdSet.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** | data for the ad sets | - | -**400** | Bad Request | - | -**403** | Forbidden | - | -**401** | The API client is not properly authenticated. | - | - -[[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) - -# **search_campaigns** -> CampaignListResponse search_campaigns() - - - -Search for campaigns - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.campaign_list_response import CampaignListResponse -from criteo_api_marketingsolutions_v2023_01.model.campaign_search_request import CampaignSearchRequest -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - campaign_search_request = CampaignSearchRequest( - filters=CampaignSearchFilters( - campaign_ids=[ - "campaign_ids_example", - ], - advertiser_ids=[ - "advertiser_ids_example", - ], - ), - ) # CampaignSearchRequest | filters on campaigns (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.search_campaigns(campaign_search_request=campaign_search_request) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->search_campaigns: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **campaign_search_request** | [**CampaignSearchRequest**](CampaignSearchRequest.md)| filters on campaigns | [optional] - -### Return type - -[**CampaignListResponse**](CampaignListResponse.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** | data for the campaigns | - | -**400** | Bad Request | - | -**403** | Forbidden | - | -**401** | The API client is not properly authenticated. | - | - -[[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) - -# **start_ad_sets** -> ResponsesAdSetId start_ad_sets() - - - -Start the specified list of ad sets - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.responses_ad_set_id import ResponsesAdSetId -from criteo_api_marketingsolutions_v2023_01.model.requests_ad_set_id import RequestsAdSetId -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - requests_ad_set_id = RequestsAdSetId( - data=[ - WriteModelAdSetId( - id="id_example", - type="AdSetId", - ), - ], - ) # RequestsAdSetId | All the ad sets to start (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.start_ad_sets(requests_ad_set_id=requests_ad_set_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->start_ad_sets: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **requests_ad_set_id** | [**RequestsAdSetId**](RequestsAdSetId.md)| All the ad sets to start | [optional] - -### Return type - -[**ResponsesAdSetId**](ResponsesAdSetId.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** | List of ad sets that have been started and errors / warnings by ad set | - | -**400** | Bad Request | - | -**401** | The API client is not properly authenticated. | - | - -[[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) - -# **stop_ad_sets** -> ResponsesAdSetId stop_ad_sets() - - - -Stop the specified list of ad sets - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import campaign_api -from criteo_api_marketingsolutions_v2023_01.model.responses_ad_set_id import ResponsesAdSetId -from criteo_api_marketingsolutions_v2023_01.model.requests_ad_set_id import RequestsAdSetId -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - requests_ad_set_id = RequestsAdSetId( - data=[ - WriteModelAdSetId( - id="id_example", - type="AdSetId", - ), - ], - ) # RequestsAdSetId | All the ad sets to stop (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.stop_ad_sets(requests_ad_set_id=requests_ad_set_id) - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->stop_ad_sets: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **requests_ad_set_id** | [**RequestsAdSetId**](RequestsAdSetId.md)| All the ad sets to stop | [optional] - -### Return type - -[**ResponsesAdSetId**](ResponsesAdSetId.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** | List of ad sets that have been stopped and errors / warnings by ad set | - | -**400** | Bad Request | - | -**401** | The API client is not properly authenticated. | - | - -[[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/marketingsolutions_2023-01/docs/CampaignListResponse.md b/sdks/marketingsolutions_2023-01/docs/CampaignListResponse.md deleted file mode 100644 index 6f271b6b..00000000 --- a/sdks/marketingsolutions_2023-01/docs/CampaignListResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# CampaignListResponse - -List of output resources - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**[CampaignReadResource], none_type**](CampaignReadResource.md) | | [optional] [readonly] -**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] -**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2023-01/docs/CampaignReadResource.md b/sdks/marketingsolutions_2023-01/docs/CampaignReadResource.md deleted file mode 100644 index 23e03d72..00000000 --- a/sdks/marketingsolutions_2023-01/docs/CampaignReadResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# CampaignReadResource - -read model data for resources - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str, none_type** | Id of the entity | [optional] [readonly] -**type** | **str, none_type** | | [optional] [readonly] -**attributes** | [**Campaign**](Campaign.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/marketingsolutions_2023-01/docs/CampaignResponse.md b/sdks/marketingsolutions_2023-01/docs/CampaignResponse.md deleted file mode 100644 index 4577f8f2..00000000 --- a/sdks/marketingsolutions_2023-01/docs/CampaignResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# CampaignResponse - -output resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**CampaignReadResource**](CampaignReadResource.md) | | [optional] -**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] -**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2023-01/docs/CampaignSearchFilters.md b/sdks/marketingsolutions_2023-01/docs/CampaignSearchFilters.md deleted file mode 100644 index eed9641d..00000000 --- a/sdks/marketingsolutions_2023-01/docs/CampaignSearchFilters.md +++ /dev/null @@ -1,14 +0,0 @@ -# CampaignSearchFilters - -filters on campaign - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**campaign_ids** | **[str], none_type** | | [optional] -**advertiser_ids** | **[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/marketingsolutions_2023-01/docs/CampaignSearchRequest.md b/sdks/marketingsolutions_2023-01/docs/CampaignSearchRequest.md deleted file mode 100644 index 1f980099..00000000 --- a/sdks/marketingsolutions_2023-01/docs/CampaignSearchRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# CampaignSearchRequest - -request payload of the search endpoint - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**filters** | [**CampaignSearchFilters**](CampaignSearchFilters.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/marketingsolutions_2023-01/docs/CampaignSpendLimit.md b/sdks/marketingsolutions_2023-01/docs/CampaignSpendLimit.md deleted file mode 100644 index 2c2c3130..00000000 --- a/sdks/marketingsolutions_2023-01/docs/CampaignSpendLimit.md +++ /dev/null @@ -1,15 +0,0 @@ -# CampaignSpendLimit - -campaign spend limit model - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spend_limit_type** | **str, none_type** | | [optional] -**spend_limit_renewal** | **str, none_type** | | [optional] -**spend_limit_amount** | [**NillableDecimal**](NillableDecimal.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/marketingsolutions_2023-01/docs/DeleteAudienceResponse.md b/sdks/marketingsolutions_2023-01/docs/DeleteAudienceResponse.md deleted file mode 100644 index 2ac1615c..00000000 --- a/sdks/marketingsolutions_2023-01/docs/DeleteAudienceResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# DeleteAudienceResponse - -Response of an audience deletion - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**BasicAudienceDefinition**](BasicAudienceDefinition.md) | | -**errors** | [**[AudienceError]**](AudienceError.md) | | -**warnings** | [**[AudienceWarning]**](AudienceWarning.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/marketingsolutions_2023-01/docs/GatewayApi.md b/sdks/marketingsolutions_2023-01/docs/GatewayApi.md deleted file mode 100644 index 5cecec7d..00000000 --- a/sdks/marketingsolutions_2023-01/docs/GatewayApi.md +++ /dev/null @@ -1,90 +0,0 @@ -# criteo_api_marketingsolutions_v2023_01.GatewayApi - -All URIs are relative to *https://api.criteo.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_current_application**](GatewayApi.md#get_current_application) | **GET** /2023-01/marketing-solutions/me | - - -# **get_current_application** -> ApplicationSummaryModelResponse get_current_application() - - - -Get information about the currently logged application - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import gateway_api -from criteo_api_marketingsolutions_v2023_01.model.application_summary_model_response import ApplicationSummaryModelResponse -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_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = gateway_api.GatewayApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.get_current_application() - pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: - print("Exception when calling GatewayApi->get_current_application: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**ApplicationSummaryModelResponse**](ApplicationSummaryModelResponse.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** | Success | - | -**404** | Not 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) - diff --git a/sdks/marketingsolutions_2023-01/docs/GetAudiencesResponse.md b/sdks/marketingsolutions_2023-01/docs/GetAudiencesResponse.md deleted file mode 100644 index 9de4b05b..00000000 --- a/sdks/marketingsolutions_2023-01/docs/GetAudiencesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# GetAudiencesResponse - -Body of the GET audience operation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**[Audience]**](Audience.md) | | -**errors** | [**[AudienceError]**](AudienceError.md) | | -**warnings** | [**[AudienceWarning]**](AudienceWarning.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/marketingsolutions_2023-01/docs/NewAudience.md b/sdks/marketingsolutions_2023-01/docs/NewAudience.md deleted file mode 100644 index a0e97880..00000000 --- a/sdks/marketingsolutions_2023-01/docs/NewAudience.md +++ /dev/null @@ -1,14 +0,0 @@ -# NewAudience - -Body for the creation of a new audience (name, advertiserId, etc) - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | the name of the entity type | -**attributes** | [**NewAudienceAttributes**](NewAudienceAttributes.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/marketingsolutions_2023-01/docs/NewAudienceAttributes.md b/sdks/marketingsolutions_2023-01/docs/NewAudienceAttributes.md deleted file mode 100644 index 083b3d66..00000000 --- a/sdks/marketingsolutions_2023-01/docs/NewAudienceAttributes.md +++ /dev/null @@ -1,14 +0,0 @@ -# NewAudienceAttributes - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the new audience | -**advertiser_id** | **str, none_type** | The advertiser id to create the audience for | [optional] -**description** | **str, none_type** | The description of the audience | [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_2023-01/docs/NewAudienceRequest.md b/sdks/marketingsolutions_2023-01/docs/NewAudienceRequest.md deleted file mode 100644 index 865562e7..00000000 --- a/sdks/marketingsolutions_2023-01/docs/NewAudienceRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# NewAudienceRequest - -Body of creation of a new audience - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**NewAudience**](NewAudience.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/marketingsolutions_2023-01/docs/NewAudienceResponse.md b/sdks/marketingsolutions_2023-01/docs/NewAudienceResponse.md deleted file mode 100644 index 842c3125..00000000 --- a/sdks/marketingsolutions_2023-01/docs/NewAudienceResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# NewAudienceResponse - -Response of a newly created audience - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**BasicAudienceDefinition**](BasicAudienceDefinition.md) | | -**errors** | [**[AudienceError]**](AudienceError.md) | | -**warnings** | [**[AudienceWarning]**](AudienceWarning.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/marketingsolutions_2023-01/docs/ReplaceAudience.md b/sdks/marketingsolutions_2023-01/docs/ReplaceAudience.md deleted file mode 100644 index 87863984..00000000 --- a/sdks/marketingsolutions_2023-01/docs/ReplaceAudience.md +++ /dev/null @@ -1,14 +0,0 @@ -# ReplaceAudience - -Parameters required to replace an audience - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | the name of the entity type | -**attributes** | [**AudienceNameDescription**](AudienceNameDescription.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/marketingsolutions_2023-01/docs/ReplaceAudienceRequest.md b/sdks/marketingsolutions_2023-01/docs/ReplaceAudienceRequest.md deleted file mode 100644 index 36739af4..00000000 --- a/sdks/marketingsolutions_2023-01/docs/ReplaceAudienceRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReplaceAudienceRequest - -Request to replace an audience - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**ReplaceAudience**](ReplaceAudience.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/marketingsolutions_2023-01/docs/ReplaceAudienceResponse.md b/sdks/marketingsolutions_2023-01/docs/ReplaceAudienceResponse.md deleted file mode 100644 index db420997..00000000 --- a/sdks/marketingsolutions_2023-01/docs/ReplaceAudienceResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# ReplaceAudienceResponse - -Response of an audience replacement - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**BasicAudienceDefinition**](BasicAudienceDefinition.md) | | -**errors** | [**[AudienceError]**](AudienceError.md) | | -**warnings** | [**[AudienceWarning]**](AudienceWarning.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/marketingsolutions_2023-01/docs/RequestAdSetSearch.md b/sdks/marketingsolutions_2023-01/docs/RequestAdSetSearch.md deleted file mode 100644 index f3f8cff6..00000000 --- a/sdks/marketingsolutions_2023-01/docs/RequestAdSetSearch.md +++ /dev/null @@ -1,13 +0,0 @@ -# RequestAdSetSearch - -request payload of the search endpoint - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**filters** | [**AdSetSearchFilter**](AdSetSearchFilter.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/marketingsolutions_2023-01/docs/ResponsesReadAdSet.md b/sdks/marketingsolutions_2023-01/docs/ResponsesReadAdSet.md deleted file mode 100644 index 9d8943c9..00000000 --- a/sdks/marketingsolutions_2023-01/docs/ResponsesReadAdSet.md +++ /dev/null @@ -1,15 +0,0 @@ -# ResponsesReadAdSet - -List of output resources - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**[ReadModelReadAdSet], none_type**](ReadModelReadAdSet.md) | | [optional] [readonly] -**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] -**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2023-01/setup.py b/sdks/marketingsolutions_2023-01/setup.py deleted file mode 100644 index bb2d29dc..00000000 --- a/sdks/marketingsolutions_2023-01/setup.py +++ /dev/null @@ -1,68 +0,0 @@ -# coding: utf-8 - -from setuptools import setup, find_packages # noqa: H301 - -NAME = "criteo-api-marketingsolutions-sdk" -VERSION = "2023.01.0.240404" -# To install the library, run the following -# -# python setup.py install -# -# prerequisite: setuptools -# http://pypi.python.org/pypi/setuptools - -REQUIRES = ["urllib3 >= 1.25.3", "python-dateutil"] - -AUTHOR='Criteo' -README_CONTENT_TYPE='text/markdown' -PACKAGE_LONG_DESCRIPTION = """# Criteo API SDK for Python - -IMPORTANT: This Python package links to Criteo production environment. Any test applied here will thus impact real data. - -## Installation & Usage -### pip install - - -```sh -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.240404`) - -Then import the package: -```python -import criteo_api_marketingsolutions_v2023_01 -``` - -Full documentation on [Github](https://github.com/criteo/criteo-api-python-sdk). - -## Disclaimer - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE -WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -""" - -setup( - name=NAME, - version=VERSION, - description="Criteo API SDK", - author_email="", - author=AUTHOR, - url="https://github.com/criteo/criteo-api-python-sdk", - keywords=[AUTHOR, "OpenAPI-Generator", "Criteo API SDK"], - install_requires=REQUIRES, - packages=find_packages(), - include_package_data=True, - long_description_content_type=README_CONTENT_TYPE, - long_description=PACKAGE_LONG_DESCRIPTION, - classifiers=[ - "Development Status :: 4 - Beta", - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Natural Language :: English", - "Operating System :: OS Independent", - "Topic :: Software Development :: Libraries", - ], - python_requires=">=3.6", -) diff --git a/sdks/marketingsolutions_2023-01/test/example_application_with_auth_code.py b/sdks/marketingsolutions_2023-01/test/example_application_with_auth_code.py deleted file mode 100644 index a63f348a..00000000 --- a/sdks/marketingsolutions_2023-01/test/example_application_with_auth_code.py +++ /dev/null @@ -1,27 +0,0 @@ -from criteo_api_marketingsolutions_v2023_01.api.gateway_api import GatewayApi -from criteo_api_marketingsolutions_v2023_01 import ApiClientBuilder - -class ExampleApplication: - - def call_then_application_endpoint(self, clientId, clientSecret, authorization_code, redirect_uri): - # Create a client using your choosen OAuth flow, Authorization Code in this case. The client will handle the token generation/renewal for you - client = ApiClientBuilder.WithAuthorizationCode(clientId, clientSecret, authorization_code, redirect_uri) - - # The Gateway API regroups common technical endpoints that exists for all versions - # You can find the other endpoints in the other *Api - # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials - api = GatewayApi(client) - - # Perform the call to the application introspection endpoint - response = api.get_current_application() - - # Most of Criteo's API response follow the same structure: - # The response consists of a Data, Errors and Warnings fields - # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object - myApplication = response.data.attributes - print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') - - # You will need to save the refresh_token to use it in the refresh_token flow - # You can fetch the refresh token like this: - refreshToken = client.get_refresh_token() - print('The refresh token to be saved is ', refreshToken) \ No newline at end of file diff --git a/sdks/marketingsolutions_2023-01/test/example_application_with_client_credentials.py b/sdks/marketingsolutions_2023-01/test/example_application_with_client_credentials.py deleted file mode 100644 index ec74dae9..00000000 --- a/sdks/marketingsolutions_2023-01/test/example_application_with_client_credentials.py +++ /dev/null @@ -1,22 +0,0 @@ -from criteo_api_marketingsolutions_v2023_01.api.gateway_api import GatewayApi -from criteo_api_marketingsolutions_v2023_01 import ApiClientBuilder - -class ExampleApplication: - - def call_then_application_endpoint(self, clientId, clientSecret): - # Create a client using your choosen OAuth flow, Client Credentials in this case. The client will handle the token generation/renewal for you - client = ApiClientBuilder.WithClientCredentials(clientId=clientId, clientSecret=clientSecret) - - # The Gateway API regroups common technical endpoints that exists for all versions - # You can find the other endpoints in the other *Api - # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials - api = GatewayApi(client) - - # Perform the call to the application introspection endpoint - response = api.get_current_application() - - # Most of Criteo's API response follow the same structure: - # The response consists of a Data, Errors and Warnings fields - # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object - myApplication = response.data.attributes - print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') \ No newline at end of file diff --git a/sdks/marketingsolutions_2023-01/test/example_application_with_refresh_token.py b/sdks/marketingsolutions_2023-01/test/example_application_with_refresh_token.py deleted file mode 100644 index e562d455..00000000 --- a/sdks/marketingsolutions_2023-01/test/example_application_with_refresh_token.py +++ /dev/null @@ -1,27 +0,0 @@ -from criteo_api_marketingsolutions_v2023_01.api.gateway_api import GatewayApi -from criteo_api_marketingsolutions_v2023_01 import ApiClientBuilder - -class ExampleApplication: - - def call_then_application_endpoint(self, clientId, clientSecret, refresh_token): - # Create a client using your choosen OAuth flow, Refresh Token in this case. The client will handle the token generation/renewal for you - client = ApiClientBuilder.WithRefreshToken(clientId, clientSecret, refresh_token) - - # The Gateway API regroups common technical endpoints that exists for all versions - # You can find the other endpoints in the other *Api - # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials - api = GatewayApi(client) - - # Perform the call to the application introspection endpoint - response = api.get_current_application() - - # Most of Criteo's API response follow the same structure: - # The response consists of a Data, Errors and Warnings fields - # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object - myApplication = response.data.attributes - print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') - - # You will need to save the new refresh_token to use it again in the future - # You can fetch the refresh token like this: - refreshToken = client.get_refresh_token() - print('The refresh token to be saved is ', refreshToken) \ No newline at end of file diff --git a/sdks/marketingsolutions_2023-01/test/test_gateway_api.py b/sdks/marketingsolutions_2023-01/test/test_gateway_api.py deleted file mode 100644 index 0e69b4a3..00000000 --- a/sdks/marketingsolutions_2023-01/test/test_gateway_api.py +++ /dev/null @@ -1,62 +0,0 @@ -import pytest -import os - -from criteo_api_marketingsolutions_v2023_01.api.gateway_api import GatewayApi -from criteo_api_marketingsolutions_v2023_01.api_client_builder import ApiClientBuilder -from criteo_api_marketingsolutions_v2023_01.rest import ApiException -from example_application_with_client_credentials import ExampleApplication - -class TestGatewayApi: - @pytest.fixture(autouse=True) - def before_each(self): - self.client_id = os.environ.get("TEST_CLIENT_ID") - self.client_secret = os.environ.get("TEST_CLIENT_SECRET") - self.application_id = int(os.environ.get("TEST_APPLICATION_ID")) - - self.client = ApiClientBuilder.WithClientCredentials(clientId=self.client_id, clientSecret=self.client_secret) - - def test_environment_variables(self): - assert len(self.client_id) > 0, "Environment variable \"TEST_CLIENT_ID\" not found." - assert len(self.client_secret) > 0, "Environment variable \"TEST_CLIENT_SECRET\" not found." - assert self.application_id > 0, "Environment variable \"TEST_APPLICATION_ID\" not found." - - def test_example_works(self): - # Arrange - exampleApplication = ExampleApplication() - exampleApplication.call_then_application_endpoint(self.client_id, self.client_secret) - - def test_get_current_application_should_succeed_with_valid_token(self): - # Arrange - api = GatewayApi(self.client) - - # Act - http_response = api.get_current_application() - - # Assert - assert self.application_id == http_response.data.attributes.application_id - - - def test_get_current_application_should_succeed_with_renewed_invalid_token(self): - # Arrange - invalid_token = "invalid.access.token" - self.client.configuration.access_token = invalid_token - api = GatewayApi(self.client) - - # Act - http_response = api.get_current_application() - - # Assert - assert self.application_id == http_response.data.attributes.application_id - - - def test_get_current_application_should_fail_without_token(self): - # Arrange - api = GatewayApi(ApiClientBuilder.WithNoAuthorization()) - - # Act - try: - api.get_current_application() - - # Assert - except ApiException as exception: - assert exception.status == 401 diff --git a/sdks/marketingsolutions_2023-01/tox.ini b/sdks/marketingsolutions_2023-01/tox.ini deleted file mode 100644 index 8b94d9dd..00000000 --- a/sdks/marketingsolutions_2023-01/tox.ini +++ /dev/null @@ -1,9 +0,0 @@ -[tox] -envlist = py3 - -[testenv] -deps=-r{toxinidir}/requirements.txt - -r{toxinidir}/test-requirements.txt - -commands= - pytest --cov=criteo_api_marketingsolutions_v2023_01 diff --git a/sdks/marketingsolutions_2023-04/README.md b/sdks/marketingsolutions_2023-04/README.md index 3b400e8a..691fc5a7 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.240404 +- Package version: 2023.04.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2023.04.0.240404 +pip install criteo-api-marketingsolutions-sdk==2023.04.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) 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 4f23e4fe..9440fbc7 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.240404" +__version__ = "2023.04.0.240515" # 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 5dd86d20..11031f0e 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.240404/python' + self.user_agent = 'OpenAPI-Generator/2023.04.0.240515/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 e9d32be2..5ffe1c89 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.240404".\ + "SDK Package Version: 2023.04.0.240515".\ 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 b96e5866..6ade1594 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.240404" +VERSION = "2023.04.0.240515" # 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.240404 +pip install criteo-api-marketingsolutions-sdk==2023.04.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-07/README.md b/sdks/marketingsolutions_2023-07/README.md index 16714173..1c47f827 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.240404 +- Package version: 2023.07.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2023.07.0.240404 +pip install criteo-api-marketingsolutions-sdk==2023.07.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) 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 9731a7cc..de58e4fc 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.240404" +__version__ = "2023.07.0.240515" # 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 726183c4..60c73767 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.240404/python' + self.user_agent = 'OpenAPI-Generator/2023.07.0.240515/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 7d096fab..e5e11ad6 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.240404".\ + "SDK Package Version: 2023.07.0.240515".\ 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 ce556a7a..d202b534 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.240404" +VERSION = "2023.07.0.240515" # 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.240404 +pip install criteo-api-marketingsolutions-sdk==2023.07.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-10/README.md b/sdks/marketingsolutions_2023-10/README.md index b28eb72b..92bbed60 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.240404 +- Package version: 2023.10.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2023.10.0.240404 +pip install criteo-api-marketingsolutions-sdk==2023.10.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) 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 b17c0d25..213c2a32 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.240404" +__version__ = "2023.10.0.240515" # 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 af5eb2b7..9c70610e 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.240404/python' + self.user_agent = 'OpenAPI-Generator/2023.10.0.240515/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 67db4b77..c09a6ee7 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.240404".\ + "SDK Package Version: 2023.10.0.240515".\ 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 7eb88802..7aa70b46 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.240404" +VERSION = "2023.10.0.240515" # 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.240404 +pip install criteo-api-marketingsolutions-sdk==2023.10.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2024-01/README.md b/sdks/marketingsolutions_2024-01/README.md index 4b98afe4..a17e23d6 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.240404 +- Package version: 2024.01.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==2024.01.0.240404 +pip install criteo-api-marketingsolutions-sdk==2024.01.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) 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 569b54ae..d87ae584 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.240404" +__version__ = "2024.01.0.240515" # 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 8fb2977d..d45cfae5 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.240404/python' + self.user_agent = 'OpenAPI-Generator/2024.01.0.240515/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 3a9b0d89..5cf5b815 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.240404".\ + "SDK Package Version: 2024.01.0.240515".\ 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 bd2280b3..224ac33f 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.240404" +VERSION = "2024.01.0.240515" # 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.240404 +pip install criteo-api-marketingsolutions-sdk==2024.01.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/marketingsolutions_2023-01/.gitignore b/sdks/marketingsolutions_2024-04/.gitignore similarity index 100% rename from sdks/marketingsolutions_2023-01/.gitignore rename to sdks/marketingsolutions_2024-04/.gitignore diff --git a/sdks/marketingsolutions_2024-04/.gitlab-ci.yml b/sdks/marketingsolutions_2024-04/.gitlab-ci.yml new file mode 100644 index 00000000..f6526625 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/.gitlab-ci.yml @@ -0,0 +1,24 @@ +# ref: https://docs.gitlab.com/ee/ci/README.html + +stages: + - test + +.tests: + stage: test + script: + - pip install -r requirements.txt + - pip install -r test-requirements.txt + - pytest --cov=criteo_api_marketingsolutions_v2024_04 + +test-3.6: + extends: .tests + image: python:3.6-alpine +test-3.7: + extends: .tests + image: python:3.7-alpine +test-3.8: + extends: .tests + image: python:3.8-alpine +test-3.9: + extends: .tests + image: python:3.9-alpine diff --git a/sdks/marketingsolutions_2024-04/.openapi-generator/FILES b/sdks/marketingsolutions_2024-04/.openapi-generator/FILES new file mode 100644 index 00000000..61d754e4 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/.openapi-generator/FILES @@ -0,0 +1,554 @@ +.gitignore +.gitlab-ci.yml +.openapi-generator-ignore +.travis.yml +README.md +criteo_api_marketingsolutions_v2024_04/__init__.py +criteo_api_marketingsolutions_v2024_04/api/__init__.py +criteo_api_marketingsolutions_v2024_04/api/advertiser_api.py +criteo_api_marketingsolutions_v2024_04/api/analytics_api.py +criteo_api_marketingsolutions_v2024_04/api/audience_api.py +criteo_api_marketingsolutions_v2024_04/api/campaign_api.py +criteo_api_marketingsolutions_v2024_04/api/creative_api.py +criteo_api_marketingsolutions_v2024_04/api/gateway_api.py +criteo_api_marketingsolutions_v2024_04/api_client.py +criteo_api_marketingsolutions_v2024_04/api_client_builder.py +criteo_api_marketingsolutions_v2024_04/apis/__init__.py +criteo_api_marketingsolutions_v2024_04/configuration.py +criteo_api_marketingsolutions_v2024_04/criteo_api_client.py +criteo_api_marketingsolutions_v2024_04/criteo_auth.py +criteo_api_marketingsolutions_v2024_04/criteo_rest.py +criteo_api_marketingsolutions_v2024_04/exceptions.py +criteo_api_marketingsolutions_v2024_04/flow_constants.py +criteo_api_marketingsolutions_v2024_04/model/__init__.py +criteo_api_marketingsolutions_v2024_04/model/ad.py +criteo_api_marketingsolutions_v2024_04/model/ad_list_response.py +criteo_api_marketingsolutions_v2024_04/model/ad_resource.py +criteo_api_marketingsolutions_v2024_04/model/ad_response.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1_response.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_input_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid_list_response.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid_resource.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_delivery_limitations.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_delivery_limitations_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier_list_response.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier_resource.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_frequency_capping.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_frequency_capping_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_geo_location.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_geo_location_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_search_filter_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_search_request_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_rule.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_rule_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/ad_write.py +criteo_api_marketingsolutions_v2024_04/model/ad_write_request.py +criteo_api_marketingsolutions_v2024_04/model/ad_write_resource.py +criteo_api_marketingsolutions_v2024_04/model/adaptive_attributes.py +criteo_api_marketingsolutions_v2024_04/model/adaptive_colors.py +criteo_api_marketingsolutions_v2024_04/model/adaptive_write_attributes.py +criteo_api_marketingsolutions_v2024_04/model/algebra_node_v1.py +criteo_api_marketingsolutions_v2024_04/model/application_summary_model.py +criteo_api_marketingsolutions_v2024_04/model/application_summary_model_resource.py +criteo_api_marketingsolutions_v2024_04/model/application_summary_model_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_bulk_create_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_bulk_delete_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_bulk_update_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_compute_size_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_compute_sizes_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_create_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_create_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_delete_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_audience_search_metadata_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_error.py +criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_id_entity_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_id_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_name_description.py +criteo_api_marketingsolutions_v2024_04/model/audience_search_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_search_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_search_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_search_metadata_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_create_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_delete_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_update_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_compute_size_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_compute_sizes_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_create_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_create_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_delete_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_estimate_size_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_id_entity_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_id_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_input_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_metadata_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_update_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_segment_update_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1_response.py +criteo_api_marketingsolutions_v2024_04/model/audience_update_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/audience_update_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/audience_warning.py +criteo_api_marketingsolutions_v2024_04/model/basic_audience_definition.py +criteo_api_marketingsolutions_v2024_04/model/behavioral_v1.py +criteo_api_marketingsolutions_v2024_04/model/campaign_search_filters_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/campaign_search_request_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/campaign_spend_limit_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_resource.py +criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_response.py +criteo_api_marketingsolutions_v2024_04/model/common_problem.py +criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1_response.py +criteo_api_marketingsolutions_v2024_04/model/contact_list_v1.py +criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment.py +criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment_attributes.py +criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment_request.py +criteo_api_marketingsolutions_v2024_04/model/contactlist_operation.py +criteo_api_marketingsolutions_v2024_04/model/contactlist_operation_attributes.py +criteo_api_marketingsolutions_v2024_04/model/coupon.py +criteo_api_marketingsolutions_v2024_04/model/coupon_list_response.py +criteo_api_marketingsolutions_v2024_04/model/coupon_resource.py +criteo_api_marketingsolutions_v2024_04/model/coupon_response.py +criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes.py +criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes_resource.py +criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes_response.py +criteo_api_marketingsolutions_v2024_04/model/create_ad_set.py +criteo_api_marketingsolutions_v2024_04/model/create_ad_set_bidding.py +criteo_api_marketingsolutions_v2024_04/model/create_ad_set_budget.py +criteo_api_marketingsolutions_v2024_04/model/create_ad_set_geo_location.py +criteo_api_marketingsolutions_v2024_04/model/create_ad_set_request.py +criteo_api_marketingsolutions_v2024_04/model/create_ad_set_resource.py +criteo_api_marketingsolutions_v2024_04/model/create_ad_set_schedule.py +criteo_api_marketingsolutions_v2024_04/model/create_ad_set_targeting.py +criteo_api_marketingsolutions_v2024_04/model/create_campaign.py +criteo_api_marketingsolutions_v2024_04/model/create_campaign_request.py +criteo_api_marketingsolutions_v2024_04/model/create_campaign_resource.py +criteo_api_marketingsolutions_v2024_04/model/create_campaign_spend_limit.py +criteo_api_marketingsolutions_v2024_04/model/create_coupon.py +criteo_api_marketingsolutions_v2024_04/model/create_coupon_request.py +criteo_api_marketingsolutions_v2024_04/model/create_coupon_resource.py +criteo_api_marketingsolutions_v2024_04/model/create_image_slide.py +criteo_api_marketingsolutions_v2024_04/model/creative.py +criteo_api_marketingsolutions_v2024_04/model/creative_list_response.py +criteo_api_marketingsolutions_v2024_04/model/creative_resource.py +criteo_api_marketingsolutions_v2024_04/model/creative_response.py +criteo_api_marketingsolutions_v2024_04/model/creative_write.py +criteo_api_marketingsolutions_v2024_04/model/creative_write_request.py +criteo_api_marketingsolutions_v2024_04/model/creative_write_resource.py +criteo_api_marketingsolutions_v2024_04/model/criteo_api_error.py +criteo_api_marketingsolutions_v2024_04/model/criteo_api_warning.py +criteo_api_marketingsolutions_v2024_04/model/delete_audience_contact_list_response.py +criteo_api_marketingsolutions_v2024_04/model/dynamic_attributes.py +criteo_api_marketingsolutions_v2024_04/model/dynamic_write_attributes.py +criteo_api_marketingsolutions_v2024_04/model/entity_of_portfolio_message.py +criteo_api_marketingsolutions_v2024_04/model/error_code_response.py +criteo_api_marketingsolutions_v2024_04/model/get_portfolio_response.py +criteo_api_marketingsolutions_v2024_04/model/html_tag_attributes.py +criteo_api_marketingsolutions_v2024_04/model/html_tag_write_attributes.py +criteo_api_marketingsolutions_v2024_04/model/image_attributes.py +criteo_api_marketingsolutions_v2024_04/model/image_set.py +criteo_api_marketingsolutions_v2024_04/model/image_set_base64.py +criteo_api_marketingsolutions_v2024_04/model/image_shape.py +criteo_api_marketingsolutions_v2024_04/model/image_slide.py +criteo_api_marketingsolutions_v2024_04/model/image_write_attributes.py +criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1.py +criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1_list_response.py +criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1_resource.py +criteo_api_marketingsolutions_v2024_04/model/in_market_create_v1.py +criteo_api_marketingsolutions_v2024_04/model/in_market_size_estimation_v1.py +criteo_api_marketingsolutions_v2024_04/model/in_market_update_v1.py +criteo_api_marketingsolutions_v2024_04/model/in_market_v1.py +criteo_api_marketingsolutions_v2024_04/model/location_create_v1.py +criteo_api_marketingsolutions_v2024_04/model/location_size_estimation_v1.py +criteo_api_marketingsolutions_v2024_04/model/location_update_v1.py +criteo_api_marketingsolutions_v2024_04/model/location_v1.py +criteo_api_marketingsolutions_v2024_04/model/lookalike_create_v1.py +criteo_api_marketingsolutions_v2024_04/model/lookalike_update_v1.py +criteo_api_marketingsolutions_v2024_04/model/lookalike_v1.py +criteo_api_marketingsolutions_v2024_04/model/modify_audience_response.py +criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule.py +criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_v23_q1_value.py +criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_value.py +criteo_api_marketingsolutions_v2024_04/model/nillable_date_time.py +criteo_api_marketingsolutions_v2024_04/model/nillable_decimal.py +criteo_api_marketingsolutions_v2024_04/model/nillable_gender_v1.py +criteo_api_marketingsolutions_v2024_04/model/nillable_int32.py +criteo_api_marketingsolutions_v2024_04/model/nillable_string.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_bidding.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_budget.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_list_request.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_resource.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_result_list_response.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_result_resource.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_list_request.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_resource.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_result_list_response.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_result_resource.py +criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_scheduling.py +criteo_api_marketingsolutions_v2024_04/model/patch_campaign.py +criteo_api_marketingsolutions_v2024_04/model/patch_campaign_list_request.py +criteo_api_marketingsolutions_v2024_04/model/patch_campaign_spend_limit.py +criteo_api_marketingsolutions_v2024_04/model/patch_campaign_write_resource.py +criteo_api_marketingsolutions_v2024_04/model/patch_result_campaign_list_response.py +criteo_api_marketingsolutions_v2024_04/model/patch_result_campaign_read_resource.py +criteo_api_marketingsolutions_v2024_04/model/placements_report_query_data_message.py +criteo_api_marketingsolutions_v2024_04/model/placements_report_query_entity_message.py +criteo_api_marketingsolutions_v2024_04/model/placements_report_query_message.py +criteo_api_marketingsolutions_v2024_04/model/point_of_interest_v1.py +criteo_api_marketingsolutions_v2024_04/model/portfolio_message.py +criteo_api_marketingsolutions_v2024_04/model/problem_details.py +criteo_api_marketingsolutions_v2024_04/model/problems_details.py +criteo_api_marketingsolutions_v2024_04/model/prospecting_create_v1.py +criteo_api_marketingsolutions_v2024_04/model/prospecting_update_v1.py +criteo_api_marketingsolutions_v2024_04/model/prospecting_v1.py +criteo_api_marketingsolutions_v2024_04/model/read_ad_set.py +criteo_api_marketingsolutions_v2024_04/model/read_ad_set_bidding.py +criteo_api_marketingsolutions_v2024_04/model/read_ad_set_bidding_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/read_ad_set_budget.py +criteo_api_marketingsolutions_v2024_04/model/read_ad_set_budget_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/read_ad_set_schedule.py +criteo_api_marketingsolutions_v2024_04/model/read_ad_set_schedule_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/read_ad_set_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/read_model_ad_set_id.py +criteo_api_marketingsolutions_v2024_04/model/read_model_read_ad_set.py +criteo_api_marketingsolutions_v2024_04/model/read_model_read_ad_set_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/requests_ad_set_id.py +criteo_api_marketingsolutions_v2024_04/model/requests_patch_ad_set.py +criteo_api_marketingsolutions_v2024_04/model/response_read_ad_set.py +criteo_api_marketingsolutions_v2024_04/model/response_read_ad_set_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/responses_ad_set_id.py +criteo_api_marketingsolutions_v2024_04/model/responses_read_ad_set_v23_q1.py +criteo_api_marketingsolutions_v2024_04/model/retargeting_create_v1.py +criteo_api_marketingsolutions_v2024_04/model/retargeting_update_v1.py +criteo_api_marketingsolutions_v2024_04/model/retargeting_v1.py +criteo_api_marketingsolutions_v2024_04/model/size.py +criteo_api_marketingsolutions_v2024_04/model/statistics_report_query_message.py +criteo_api_marketingsolutions_v2024_04/model/tag.py +criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_data_message.py +criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_entity_message.py +criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_message.py +criteo_api_marketingsolutions_v2024_04/model/transparency_query_message.py +criteo_api_marketingsolutions_v2024_04/model/transparency_report_attributes.py +criteo_api_marketingsolutions_v2024_04/model/transparency_report_data_message.py +criteo_api_marketingsolutions_v2024_04/model/transparency_report_entity_message.py +criteo_api_marketingsolutions_v2024_04/model/transparency_report_file.py +criteo_api_marketingsolutions_v2024_04/model/update_coupon.py +criteo_api_marketingsolutions_v2024_04/model/update_coupon_request.py +criteo_api_marketingsolutions_v2024_04/model/update_coupon_resource.py +criteo_api_marketingsolutions_v2024_04/model/video_detail.py +criteo_api_marketingsolutions_v2024_04/model/write_model_ad_set_id.py +criteo_api_marketingsolutions_v2024_04/model/write_model_patch_ad_set.py +criteo_api_marketingsolutions_v2024_04/model_utils.py +criteo_api_marketingsolutions_v2024_04/models/__init__.py +criteo_api_marketingsolutions_v2024_04/rest.py +docs/Ad.md +docs/AdListResponse.md +docs/AdResource.md +docs/AdResponse.md +docs/AdSetAudienceLinkEntityV1.md +docs/AdSetAudienceLinkEntityV1Resource.md +docs/AdSetAudienceLinkEntityV1Response.md +docs/AdSetAudienceLinkInputEntityV1.md +docs/AdSetCategoryBid.md +docs/AdSetCategoryBidListResponse.md +docs/AdSetCategoryBidResource.md +docs/AdSetDeliveryLimitations.md +docs/AdSetDeliveryLimitationsV23Q1.md +docs/AdSetDisplayMultiplier.md +docs/AdSetDisplayMultiplierListResponse.md +docs/AdSetDisplayMultiplierResource.md +docs/AdSetFrequencyCapping.md +docs/AdSetFrequencyCappingV23Q1.md +docs/AdSetGeoLocation.md +docs/AdSetGeoLocationV23Q1.md +docs/AdSetSearchFilterV23Q1.md +docs/AdSetSearchRequestV23Q1.md +docs/AdSetTargeting.md +docs/AdSetTargetingRule.md +docs/AdSetTargetingRuleV23Q1.md +docs/AdSetTargetingV23Q1.md +docs/AdWrite.md +docs/AdWriteRequest.md +docs/AdWriteResource.md +docs/AdaptiveAttributes.md +docs/AdaptiveColors.md +docs/AdaptiveWriteAttributes.md +docs/AdvertiserApi.md +docs/AlgebraNodeV1.md +docs/AnalyticsApi.md +docs/ApplicationSummaryModel.md +docs/ApplicationSummaryModelResource.md +docs/ApplicationSummaryModelResponse.md +docs/AudienceApi.md +docs/AudienceBulkCreateInputV1.md +docs/AudienceBulkDeleteInputV1.md +docs/AudienceBulkUpdateInputV1.md +docs/AudienceComputeSizeEntityV1Resource.md +docs/AudienceComputeSizesInputV1.md +docs/AudienceCreateEntityV1.md +docs/AudienceCreateEntityV1Resource.md +docs/AudienceDeleteEntityV1Resource.md +docs/AudienceEntityV1.md +docs/AudienceEntityV1AudienceSearchMetadataV1ListResponse.md +docs/AudienceEntityV1ListResponse.md +docs/AudienceEntityV1Resource.md +docs/AudienceError.md +docs/AudienceEstimateSizeEntityV1.md +docs/AudienceEstimateSizeEntityV1Resource.md +docs/AudienceEstimateSizeInputV1.md +docs/AudienceIdEntityV1ListResponse.md +docs/AudienceIdEntityV1Resource.md +docs/AudienceNameDescription.md +docs/AudienceSearchEntityV1.md +docs/AudienceSearchEntityV1Resource.md +docs/AudienceSearchInputV1.md +docs/AudienceSearchMetadataV1.md +docs/AudienceSegmentBulkCreateInputV1.md +docs/AudienceSegmentBulkDeleteInputV1.md +docs/AudienceSegmentBulkUpdateInputV1.md +docs/AudienceSegmentComputeSizeEntityV1Resource.md +docs/AudienceSegmentComputeSizesInputV1.md +docs/AudienceSegmentCreateEntityV1.md +docs/AudienceSegmentCreateEntityV1Resource.md +docs/AudienceSegmentDeleteEntityV1Resource.md +docs/AudienceSegmentEntityV1.md +docs/AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse.md +docs/AudienceSegmentEntityV1ListResponse.md +docs/AudienceSegmentEntityV1Resource.md +docs/AudienceSegmentEstimateSizeInputV1.md +docs/AudienceSegmentIdEntityV1ListResponse.md +docs/AudienceSegmentIdEntityV1Resource.md +docs/AudienceSegmentSearchEntityV1.md +docs/AudienceSegmentSearchEntityV1Resource.md +docs/AudienceSegmentSearchInputV1.md +docs/AudienceSegmentSearchMetadataV1.md +docs/AudienceSegmentSizeEntityV1.md +docs/AudienceSegmentSizeEntityV1ListResponse.md +docs/AudienceSegmentSizeEntityV1Resource.md +docs/AudienceSegmentSizeEstimationEntityV1.md +docs/AudienceSegmentSizeEstimationEntityV1Resource.md +docs/AudienceSegmentSizeEstimationV1.md +docs/AudienceSegmentSizeEstimationV1Resource.md +docs/AudienceSegmentSizeEstimationV1Response.md +docs/AudienceSegmentUpdateEntityV1.md +docs/AudienceSegmentUpdateEntityV1Resource.md +docs/AudienceSizeEntityV1.md +docs/AudienceSizeEntityV1ListResponse.md +docs/AudienceSizeEntityV1Resource.md +docs/AudienceSizeEstimationV1.md +docs/AudienceSizeEstimationV1Resource.md +docs/AudienceSizeEstimationV1Response.md +docs/AudienceUpdateEntityV1.md +docs/AudienceUpdateEntityV1Resource.md +docs/AudienceWarning.md +docs/BasicAudienceDefinition.md +docs/BehavioralV1.md +docs/CampaignApi.md +docs/CampaignSearchFiltersV23Q1.md +docs/CampaignSearchRequestV23Q1.md +docs/CampaignSpendLimitV23Q1.md +docs/CampaignV23Q1.md +docs/CampaignV23Q1ListResponse.md +docs/CampaignV23Q1Resource.md +docs/CampaignV23Q1Response.md +docs/CommonProblem.md +docs/ContactListStatisticsEntityV1.md +docs/ContactListStatisticsEntityV1Resource.md +docs/ContactListStatisticsEntityV1Response.md +docs/ContactListV1.md +docs/ContactlistAmendment.md +docs/ContactlistAmendmentAttributes.md +docs/ContactlistAmendmentRequest.md +docs/ContactlistOperation.md +docs/ContactlistOperationAttributes.md +docs/Coupon.md +docs/CouponListResponse.md +docs/CouponResource.md +docs/CouponResponse.md +docs/CouponSupportedSizes.md +docs/CouponSupportedSizesResource.md +docs/CouponSupportedSizesResponse.md +docs/CreateAdSet.md +docs/CreateAdSetBidding.md +docs/CreateAdSetBudget.md +docs/CreateAdSetGeoLocation.md +docs/CreateAdSetRequest.md +docs/CreateAdSetResource.md +docs/CreateAdSetSchedule.md +docs/CreateAdSetTargeting.md +docs/CreateCampaign.md +docs/CreateCampaignRequest.md +docs/CreateCampaignResource.md +docs/CreateCampaignSpendLimit.md +docs/CreateCoupon.md +docs/CreateCouponRequest.md +docs/CreateCouponResource.md +docs/CreateImageSlide.md +docs/Creative.md +docs/CreativeApi.md +docs/CreativeListResponse.md +docs/CreativeResource.md +docs/CreativeResponse.md +docs/CreativeWrite.md +docs/CreativeWriteRequest.md +docs/CreativeWriteResource.md +docs/CriteoApiError.md +docs/CriteoApiWarning.md +docs/DeleteAudienceContactListResponse.md +docs/DynamicAttributes.md +docs/DynamicWriteAttributes.md +docs/EntityOfPortfolioMessage.md +docs/ErrorCodeResponse.md +docs/GatewayApi.md +docs/GetPortfolioResponse.md +docs/HtmlTagAttributes.md +docs/HtmlTagWriteAttributes.md +docs/ImageAttributes.md +docs/ImageSet.md +docs/ImageSetBase64.md +docs/ImageShape.md +docs/ImageSlide.md +docs/ImageWriteAttributes.md +docs/InMarketAudienceSegmentBrandEntityV1.md +docs/InMarketAudienceSegmentBrandEntityV1ListResponse.md +docs/InMarketAudienceSegmentBrandEntityV1Resource.md +docs/InMarketAudienceSegmentInterestEntityV1.md +docs/InMarketAudienceSegmentInterestEntityV1ListResponse.md +docs/InMarketAudienceSegmentInterestEntityV1Resource.md +docs/InMarketCreateV1.md +docs/InMarketSizeEstimationV1.md +docs/InMarketUpdateV1.md +docs/InMarketV1.md +docs/LocationCreateV1.md +docs/LocationSizeEstimationV1.md +docs/LocationUpdateV1.md +docs/LocationV1.md +docs/LookalikeCreateV1.md +docs/LookalikeUpdateV1.md +docs/LookalikeV1.md +docs/ModifyAudienceResponse.md +docs/NillableAdSetTargetingRule.md +docs/NillableAdSetTargetingRuleV23Q1.md +docs/NillableAdSetTargetingRuleV23Q1Value.md +docs/NillableAdSetTargetingRuleValue.md +docs/NillableDateTime.md +docs/NillableDecimal.md +docs/NillableGenderV1.md +docs/NillableInt32.md +docs/NillableString.md +docs/PatchAdSet.md +docs/PatchAdSetBidding.md +docs/PatchAdSetBudget.md +docs/PatchAdSetCategoryBid.md +docs/PatchAdSetCategoryBidListRequest.md +docs/PatchAdSetCategoryBidResource.md +docs/PatchAdSetCategoryBidResultListResponse.md +docs/PatchAdSetCategoryBidResultResource.md +docs/PatchAdSetDisplayMultiplier.md +docs/PatchAdSetDisplayMultiplierListRequest.md +docs/PatchAdSetDisplayMultiplierResource.md +docs/PatchAdSetDisplayMultiplierResultListResponse.md +docs/PatchAdSetDisplayMultiplierResultResource.md +docs/PatchAdSetScheduling.md +docs/PatchCampaign.md +docs/PatchCampaignListRequest.md +docs/PatchCampaignSpendLimit.md +docs/PatchCampaignWriteResource.md +docs/PatchResultCampaignListResponse.md +docs/PatchResultCampaignReadResource.md +docs/PlacementsReportQueryDataMessage.md +docs/PlacementsReportQueryEntityMessage.md +docs/PlacementsReportQueryMessage.md +docs/PointOfInterestV1.md +docs/PortfolioMessage.md +docs/ProblemDetails.md +docs/ProblemsDetails.md +docs/ProspectingCreateV1.md +docs/ProspectingUpdateV1.md +docs/ProspectingV1.md +docs/ReadAdSet.md +docs/ReadAdSetBidding.md +docs/ReadAdSetBiddingV23Q1.md +docs/ReadAdSetBudget.md +docs/ReadAdSetBudgetV23Q1.md +docs/ReadAdSetSchedule.md +docs/ReadAdSetScheduleV23Q1.md +docs/ReadAdSetV23Q1.md +docs/ReadModelAdSetId.md +docs/ReadModelReadAdSet.md +docs/ReadModelReadAdSetV23Q1.md +docs/RequestsAdSetId.md +docs/RequestsPatchAdSet.md +docs/ResponseReadAdSet.md +docs/ResponseReadAdSetV23Q1.md +docs/ResponsesAdSetId.md +docs/ResponsesReadAdSetV23Q1.md +docs/RetargetingCreateV1.md +docs/RetargetingUpdateV1.md +docs/RetargetingV1.md +docs/Size.md +docs/StatisticsReportQueryMessage.md +docs/Tag.md +docs/TransactionsReportQueryDataMessage.md +docs/TransactionsReportQueryEntityMessage.md +docs/TransactionsReportQueryMessage.md +docs/TransparencyQueryMessage.md +docs/TransparencyReportAttributes.md +docs/TransparencyReportDataMessage.md +docs/TransparencyReportEntityMessage.md +docs/TransparencyReportFile.md +docs/UpdateCoupon.md +docs/UpdateCouponRequest.md +docs/UpdateCouponResource.md +docs/VideoDetail.md +docs/WriteModelAdSetId.md +docs/WriteModelPatchAdSet.md +git_push.sh +requirements.txt +setup.cfg +setup.py +test-requirements.txt +test/example_application_with_auth_code.py +test/example_application_with_client_credentials.py +test/example_application_with_refresh_token.py +test/test_gateway_api.py +tox.ini diff --git a/sdks/marketingsolutions_2023-01/.openapi-generator/VERSION b/sdks/marketingsolutions_2024-04/.openapi-generator/VERSION similarity index 100% rename from sdks/marketingsolutions_2023-01/.openapi-generator/VERSION rename to sdks/marketingsolutions_2024-04/.openapi-generator/VERSION diff --git a/sdks/marketingsolutions_2024-04/README.md b/sdks/marketingsolutions_2024-04/README.md new file mode 100644 index 00000000..edde6347 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/README.md @@ -0,0 +1,323 @@ +# Criteo API SDK for Python + +## Introduction +API Client Libraries can facilitate your use of the Criteo API allowing you to build unique and customized solutions to serve your businesses and clients. +These libraries can reduce the amount of code you need to write in order to start accessing Criteo programmatically. They also can help expedite troubleshooting, should you encounter any issues. + +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.04.0.240515 + +## Requirements + +Python 2.7 and 3.5+ + +## Installation & Usage +### pip install + +```sh +pip install criteo-api-marketingsolutions-sdk==2024.04.0.240515 +``` +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2024.04.0.240515`) + +Then import the package: +```python +import criteo_api_marketingsolutions_v2024_04 +``` + +### Manual Installation using [Setuptools](http://pypi.python.org/pypi/setuptools) + +Download the code or clone the repository locally, then execute the following command: + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) + +Then import the package: +```python +import criteo_api_marketingsolutions_v2024_04 +``` + +## Example +There are multiple examples for the different OAuth flows that the SDK supports. +- See [test/example_application_with_client_credentials.py](test/example_application_with_client_credentials.py) for an example with Client Credentials. +- See [test/example_application_with_auth_code.py](test/example_application_with_auth_code.py) for an example with Authorization Code. +Once you follow the authorization code flow, you will have a refresh token that has to be used to regenerate access token for future usage. + - See [test/example_application_with_refresh_token.py](test/example_application_with_refresh_token.py) for an example with Refresh Token . + +## Documentation for API Endpoints + +The developers documentation is available at: *https://developers.criteo.com*. + +All URIs are relative to *https://api.criteo.com*. + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- + + +## Documentation For Models + + - [Ad](docs/Ad.md) + - [AdListResponse](docs/AdListResponse.md) + - [AdResource](docs/AdResource.md) + - [AdResponse](docs/AdResponse.md) + - [AdSetAudienceLinkEntityV1](docs/AdSetAudienceLinkEntityV1.md) + - [AdSetAudienceLinkEntityV1Resource](docs/AdSetAudienceLinkEntityV1Resource.md) + - [AdSetAudienceLinkEntityV1Response](docs/AdSetAudienceLinkEntityV1Response.md) + - [AdSetAudienceLinkInputEntityV1](docs/AdSetAudienceLinkInputEntityV1.md) + - [AdSetCategoryBid](docs/AdSetCategoryBid.md) + - [AdSetCategoryBidListResponse](docs/AdSetCategoryBidListResponse.md) + - [AdSetCategoryBidResource](docs/AdSetCategoryBidResource.md) + - [AdSetDeliveryLimitations](docs/AdSetDeliveryLimitations.md) + - [AdSetDeliveryLimitationsV23Q1](docs/AdSetDeliveryLimitationsV23Q1.md) + - [AdSetDisplayMultiplier](docs/AdSetDisplayMultiplier.md) + - [AdSetDisplayMultiplierListResponse](docs/AdSetDisplayMultiplierListResponse.md) + - [AdSetDisplayMultiplierResource](docs/AdSetDisplayMultiplierResource.md) + - [AdSetFrequencyCapping](docs/AdSetFrequencyCapping.md) + - [AdSetFrequencyCappingV23Q1](docs/AdSetFrequencyCappingV23Q1.md) + - [AdSetGeoLocation](docs/AdSetGeoLocation.md) + - [AdSetGeoLocationV23Q1](docs/AdSetGeoLocationV23Q1.md) + - [AdSetSearchFilterV23Q1](docs/AdSetSearchFilterV23Q1.md) + - [AdSetSearchRequestV23Q1](docs/AdSetSearchRequestV23Q1.md) + - [AdSetTargeting](docs/AdSetTargeting.md) + - [AdSetTargetingRule](docs/AdSetTargetingRule.md) + - [AdSetTargetingRuleV23Q1](docs/AdSetTargetingRuleV23Q1.md) + - [AdSetTargetingV23Q1](docs/AdSetTargetingV23Q1.md) + - [AdWrite](docs/AdWrite.md) + - [AdWriteRequest](docs/AdWriteRequest.md) + - [AdWriteResource](docs/AdWriteResource.md) + - [AdaptiveAttributes](docs/AdaptiveAttributes.md) + - [AdaptiveColors](docs/AdaptiveColors.md) + - [AdaptiveWriteAttributes](docs/AdaptiveWriteAttributes.md) + - [AlgebraNodeV1](docs/AlgebraNodeV1.md) + - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) + - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) + - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) + - [AudienceBulkCreateInputV1](docs/AudienceBulkCreateInputV1.md) + - [AudienceBulkDeleteInputV1](docs/AudienceBulkDeleteInputV1.md) + - [AudienceBulkUpdateInputV1](docs/AudienceBulkUpdateInputV1.md) + - [AudienceComputeSizeEntityV1Resource](docs/AudienceComputeSizeEntityV1Resource.md) + - [AudienceComputeSizesInputV1](docs/AudienceComputeSizesInputV1.md) + - [AudienceCreateEntityV1](docs/AudienceCreateEntityV1.md) + - [AudienceCreateEntityV1Resource](docs/AudienceCreateEntityV1Resource.md) + - [AudienceDeleteEntityV1Resource](docs/AudienceDeleteEntityV1Resource.md) + - [AudienceEntityV1](docs/AudienceEntityV1.md) + - [AudienceEntityV1AudienceSearchMetadataV1ListResponse](docs/AudienceEntityV1AudienceSearchMetadataV1ListResponse.md) + - [AudienceEntityV1ListResponse](docs/AudienceEntityV1ListResponse.md) + - [AudienceEntityV1Resource](docs/AudienceEntityV1Resource.md) + - [AudienceError](docs/AudienceError.md) + - [AudienceEstimateSizeEntityV1](docs/AudienceEstimateSizeEntityV1.md) + - [AudienceEstimateSizeEntityV1Resource](docs/AudienceEstimateSizeEntityV1Resource.md) + - [AudienceEstimateSizeInputV1](docs/AudienceEstimateSizeInputV1.md) + - [AudienceIdEntityV1ListResponse](docs/AudienceIdEntityV1ListResponse.md) + - [AudienceIdEntityV1Resource](docs/AudienceIdEntityV1Resource.md) + - [AudienceNameDescription](docs/AudienceNameDescription.md) + - [AudienceSearchEntityV1](docs/AudienceSearchEntityV1.md) + - [AudienceSearchEntityV1Resource](docs/AudienceSearchEntityV1Resource.md) + - [AudienceSearchInputV1](docs/AudienceSearchInputV1.md) + - [AudienceSearchMetadataV1](docs/AudienceSearchMetadataV1.md) + - [AudienceSegmentBulkCreateInputV1](docs/AudienceSegmentBulkCreateInputV1.md) + - [AudienceSegmentBulkDeleteInputV1](docs/AudienceSegmentBulkDeleteInputV1.md) + - [AudienceSegmentBulkUpdateInputV1](docs/AudienceSegmentBulkUpdateInputV1.md) + - [AudienceSegmentComputeSizeEntityV1Resource](docs/AudienceSegmentComputeSizeEntityV1Resource.md) + - [AudienceSegmentComputeSizesInputV1](docs/AudienceSegmentComputeSizesInputV1.md) + - [AudienceSegmentCreateEntityV1](docs/AudienceSegmentCreateEntityV1.md) + - [AudienceSegmentCreateEntityV1Resource](docs/AudienceSegmentCreateEntityV1Resource.md) + - [AudienceSegmentDeleteEntityV1Resource](docs/AudienceSegmentDeleteEntityV1Resource.md) + - [AudienceSegmentEntityV1](docs/AudienceSegmentEntityV1.md) + - [AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse](docs/AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse.md) + - [AudienceSegmentEntityV1ListResponse](docs/AudienceSegmentEntityV1ListResponse.md) + - [AudienceSegmentEntityV1Resource](docs/AudienceSegmentEntityV1Resource.md) + - [AudienceSegmentEstimateSizeInputV1](docs/AudienceSegmentEstimateSizeInputV1.md) + - [AudienceSegmentIdEntityV1ListResponse](docs/AudienceSegmentIdEntityV1ListResponse.md) + - [AudienceSegmentIdEntityV1Resource](docs/AudienceSegmentIdEntityV1Resource.md) + - [AudienceSegmentSearchEntityV1](docs/AudienceSegmentSearchEntityV1.md) + - [AudienceSegmentSearchEntityV1Resource](docs/AudienceSegmentSearchEntityV1Resource.md) + - [AudienceSegmentSearchInputV1](docs/AudienceSegmentSearchInputV1.md) + - [AudienceSegmentSearchMetadataV1](docs/AudienceSegmentSearchMetadataV1.md) + - [AudienceSegmentSizeEntityV1](docs/AudienceSegmentSizeEntityV1.md) + - [AudienceSegmentSizeEntityV1ListResponse](docs/AudienceSegmentSizeEntityV1ListResponse.md) + - [AudienceSegmentSizeEntityV1Resource](docs/AudienceSegmentSizeEntityV1Resource.md) + - [AudienceSegmentSizeEstimationEntityV1](docs/AudienceSegmentSizeEstimationEntityV1.md) + - [AudienceSegmentSizeEstimationEntityV1Resource](docs/AudienceSegmentSizeEstimationEntityV1Resource.md) + - [AudienceSegmentSizeEstimationV1](docs/AudienceSegmentSizeEstimationV1.md) + - [AudienceSegmentSizeEstimationV1Resource](docs/AudienceSegmentSizeEstimationV1Resource.md) + - [AudienceSegmentSizeEstimationV1Response](docs/AudienceSegmentSizeEstimationV1Response.md) + - [AudienceSegmentUpdateEntityV1](docs/AudienceSegmentUpdateEntityV1.md) + - [AudienceSegmentUpdateEntityV1Resource](docs/AudienceSegmentUpdateEntityV1Resource.md) + - [AudienceSizeEntityV1](docs/AudienceSizeEntityV1.md) + - [AudienceSizeEntityV1ListResponse](docs/AudienceSizeEntityV1ListResponse.md) + - [AudienceSizeEntityV1Resource](docs/AudienceSizeEntityV1Resource.md) + - [AudienceSizeEstimationV1](docs/AudienceSizeEstimationV1.md) + - [AudienceSizeEstimationV1Resource](docs/AudienceSizeEstimationV1Resource.md) + - [AudienceSizeEstimationV1Response](docs/AudienceSizeEstimationV1Response.md) + - [AudienceUpdateEntityV1](docs/AudienceUpdateEntityV1.md) + - [AudienceUpdateEntityV1Resource](docs/AudienceUpdateEntityV1Resource.md) + - [AudienceWarning](docs/AudienceWarning.md) + - [BasicAudienceDefinition](docs/BasicAudienceDefinition.md) + - [BehavioralV1](docs/BehavioralV1.md) + - [CampaignSearchFiltersV23Q1](docs/CampaignSearchFiltersV23Q1.md) + - [CampaignSearchRequestV23Q1](docs/CampaignSearchRequestV23Q1.md) + - [CampaignSpendLimitV23Q1](docs/CampaignSpendLimitV23Q1.md) + - [CampaignV23Q1](docs/CampaignV23Q1.md) + - [CampaignV23Q1ListResponse](docs/CampaignV23Q1ListResponse.md) + - [CampaignV23Q1Resource](docs/CampaignV23Q1Resource.md) + - [CampaignV23Q1Response](docs/CampaignV23Q1Response.md) + - [CommonProblem](docs/CommonProblem.md) + - [ContactListStatisticsEntityV1](docs/ContactListStatisticsEntityV1.md) + - [ContactListStatisticsEntityV1Resource](docs/ContactListStatisticsEntityV1Resource.md) + - [ContactListStatisticsEntityV1Response](docs/ContactListStatisticsEntityV1Response.md) + - [ContactListV1](docs/ContactListV1.md) + - [ContactlistAmendment](docs/ContactlistAmendment.md) + - [ContactlistAmendmentAttributes](docs/ContactlistAmendmentAttributes.md) + - [ContactlistAmendmentRequest](docs/ContactlistAmendmentRequest.md) + - [ContactlistOperation](docs/ContactlistOperation.md) + - [ContactlistOperationAttributes](docs/ContactlistOperationAttributes.md) + - [Coupon](docs/Coupon.md) + - [CouponListResponse](docs/CouponListResponse.md) + - [CouponResource](docs/CouponResource.md) + - [CouponResponse](docs/CouponResponse.md) + - [CouponSupportedSizes](docs/CouponSupportedSizes.md) + - [CouponSupportedSizesResource](docs/CouponSupportedSizesResource.md) + - [CouponSupportedSizesResponse](docs/CouponSupportedSizesResponse.md) + - [CreateAdSet](docs/CreateAdSet.md) + - [CreateAdSetBidding](docs/CreateAdSetBidding.md) + - [CreateAdSetBudget](docs/CreateAdSetBudget.md) + - [CreateAdSetGeoLocation](docs/CreateAdSetGeoLocation.md) + - [CreateAdSetRequest](docs/CreateAdSetRequest.md) + - [CreateAdSetResource](docs/CreateAdSetResource.md) + - [CreateAdSetSchedule](docs/CreateAdSetSchedule.md) + - [CreateAdSetTargeting](docs/CreateAdSetTargeting.md) + - [CreateCampaign](docs/CreateCampaign.md) + - [CreateCampaignRequest](docs/CreateCampaignRequest.md) + - [CreateCampaignResource](docs/CreateCampaignResource.md) + - [CreateCampaignSpendLimit](docs/CreateCampaignSpendLimit.md) + - [CreateCoupon](docs/CreateCoupon.md) + - [CreateCouponRequest](docs/CreateCouponRequest.md) + - [CreateCouponResource](docs/CreateCouponResource.md) + - [CreateImageSlide](docs/CreateImageSlide.md) + - [Creative](docs/Creative.md) + - [CreativeListResponse](docs/CreativeListResponse.md) + - [CreativeResource](docs/CreativeResource.md) + - [CreativeResponse](docs/CreativeResponse.md) + - [CreativeWrite](docs/CreativeWrite.md) + - [CreativeWriteRequest](docs/CreativeWriteRequest.md) + - [CreativeWriteResource](docs/CreativeWriteResource.md) + - [CriteoApiError](docs/CriteoApiError.md) + - [CriteoApiWarning](docs/CriteoApiWarning.md) + - [DeleteAudienceContactListResponse](docs/DeleteAudienceContactListResponse.md) + - [DynamicAttributes](docs/DynamicAttributes.md) + - [DynamicWriteAttributes](docs/DynamicWriteAttributes.md) + - [EntityOfPortfolioMessage](docs/EntityOfPortfolioMessage.md) + - [ErrorCodeResponse](docs/ErrorCodeResponse.md) + - [GetPortfolioResponse](docs/GetPortfolioResponse.md) + - [HtmlTagAttributes](docs/HtmlTagAttributes.md) + - [HtmlTagWriteAttributes](docs/HtmlTagWriteAttributes.md) + - [ImageAttributes](docs/ImageAttributes.md) + - [ImageSet](docs/ImageSet.md) + - [ImageSetBase64](docs/ImageSetBase64.md) + - [ImageShape](docs/ImageShape.md) + - [ImageSlide](docs/ImageSlide.md) + - [ImageWriteAttributes](docs/ImageWriteAttributes.md) + - [InMarketAudienceSegmentBrandEntityV1](docs/InMarketAudienceSegmentBrandEntityV1.md) + - [InMarketAudienceSegmentBrandEntityV1ListResponse](docs/InMarketAudienceSegmentBrandEntityV1ListResponse.md) + - [InMarketAudienceSegmentBrandEntityV1Resource](docs/InMarketAudienceSegmentBrandEntityV1Resource.md) + - [InMarketAudienceSegmentInterestEntityV1](docs/InMarketAudienceSegmentInterestEntityV1.md) + - [InMarketAudienceSegmentInterestEntityV1ListResponse](docs/InMarketAudienceSegmentInterestEntityV1ListResponse.md) + - [InMarketAudienceSegmentInterestEntityV1Resource](docs/InMarketAudienceSegmentInterestEntityV1Resource.md) + - [InMarketCreateV1](docs/InMarketCreateV1.md) + - [InMarketSizeEstimationV1](docs/InMarketSizeEstimationV1.md) + - [InMarketUpdateV1](docs/InMarketUpdateV1.md) + - [InMarketV1](docs/InMarketV1.md) + - [LocationCreateV1](docs/LocationCreateV1.md) + - [LocationSizeEstimationV1](docs/LocationSizeEstimationV1.md) + - [LocationUpdateV1](docs/LocationUpdateV1.md) + - [LocationV1](docs/LocationV1.md) + - [LookalikeCreateV1](docs/LookalikeCreateV1.md) + - [LookalikeUpdateV1](docs/LookalikeUpdateV1.md) + - [LookalikeV1](docs/LookalikeV1.md) + - [ModifyAudienceResponse](docs/ModifyAudienceResponse.md) + - [NillableAdSetTargetingRule](docs/NillableAdSetTargetingRule.md) + - [NillableAdSetTargetingRuleV23Q1](docs/NillableAdSetTargetingRuleV23Q1.md) + - [NillableAdSetTargetingRuleV23Q1Value](docs/NillableAdSetTargetingRuleV23Q1Value.md) + - [NillableAdSetTargetingRuleValue](docs/NillableAdSetTargetingRuleValue.md) + - [NillableDateTime](docs/NillableDateTime.md) + - [NillableDecimal](docs/NillableDecimal.md) + - [NillableGenderV1](docs/NillableGenderV1.md) + - [NillableInt32](docs/NillableInt32.md) + - [NillableString](docs/NillableString.md) + - [PatchAdSet](docs/PatchAdSet.md) + - [PatchAdSetBidding](docs/PatchAdSetBidding.md) + - [PatchAdSetBudget](docs/PatchAdSetBudget.md) + - [PatchAdSetCategoryBid](docs/PatchAdSetCategoryBid.md) + - [PatchAdSetCategoryBidListRequest](docs/PatchAdSetCategoryBidListRequest.md) + - [PatchAdSetCategoryBidResource](docs/PatchAdSetCategoryBidResource.md) + - [PatchAdSetCategoryBidResultListResponse](docs/PatchAdSetCategoryBidResultListResponse.md) + - [PatchAdSetCategoryBidResultResource](docs/PatchAdSetCategoryBidResultResource.md) + - [PatchAdSetDisplayMultiplier](docs/PatchAdSetDisplayMultiplier.md) + - [PatchAdSetDisplayMultiplierListRequest](docs/PatchAdSetDisplayMultiplierListRequest.md) + - [PatchAdSetDisplayMultiplierResource](docs/PatchAdSetDisplayMultiplierResource.md) + - [PatchAdSetDisplayMultiplierResultListResponse](docs/PatchAdSetDisplayMultiplierResultListResponse.md) + - [PatchAdSetDisplayMultiplierResultResource](docs/PatchAdSetDisplayMultiplierResultResource.md) + - [PatchAdSetScheduling](docs/PatchAdSetScheduling.md) + - [PatchCampaign](docs/PatchCampaign.md) + - [PatchCampaignListRequest](docs/PatchCampaignListRequest.md) + - [PatchCampaignSpendLimit](docs/PatchCampaignSpendLimit.md) + - [PatchCampaignWriteResource](docs/PatchCampaignWriteResource.md) + - [PatchResultCampaignListResponse](docs/PatchResultCampaignListResponse.md) + - [PatchResultCampaignReadResource](docs/PatchResultCampaignReadResource.md) + - [PlacementsReportQueryDataMessage](docs/PlacementsReportQueryDataMessage.md) + - [PlacementsReportQueryEntityMessage](docs/PlacementsReportQueryEntityMessage.md) + - [PlacementsReportQueryMessage](docs/PlacementsReportQueryMessage.md) + - [PointOfInterestV1](docs/PointOfInterestV1.md) + - [PortfolioMessage](docs/PortfolioMessage.md) + - [ProblemDetails](docs/ProblemDetails.md) + - [ProblemsDetails](docs/ProblemsDetails.md) + - [ProspectingCreateV1](docs/ProspectingCreateV1.md) + - [ProspectingUpdateV1](docs/ProspectingUpdateV1.md) + - [ProspectingV1](docs/ProspectingV1.md) + - [ReadAdSet](docs/ReadAdSet.md) + - [ReadAdSetBidding](docs/ReadAdSetBidding.md) + - [ReadAdSetBiddingV23Q1](docs/ReadAdSetBiddingV23Q1.md) + - [ReadAdSetBudget](docs/ReadAdSetBudget.md) + - [ReadAdSetBudgetV23Q1](docs/ReadAdSetBudgetV23Q1.md) + - [ReadAdSetSchedule](docs/ReadAdSetSchedule.md) + - [ReadAdSetScheduleV23Q1](docs/ReadAdSetScheduleV23Q1.md) + - [ReadAdSetV23Q1](docs/ReadAdSetV23Q1.md) + - [ReadModelAdSetId](docs/ReadModelAdSetId.md) + - [ReadModelReadAdSet](docs/ReadModelReadAdSet.md) + - [ReadModelReadAdSetV23Q1](docs/ReadModelReadAdSetV23Q1.md) + - [RequestsAdSetId](docs/RequestsAdSetId.md) + - [RequestsPatchAdSet](docs/RequestsPatchAdSet.md) + - [ResponseReadAdSet](docs/ResponseReadAdSet.md) + - [ResponseReadAdSetV23Q1](docs/ResponseReadAdSetV23Q1.md) + - [ResponsesAdSetId](docs/ResponsesAdSetId.md) + - [ResponsesReadAdSetV23Q1](docs/ResponsesReadAdSetV23Q1.md) + - [RetargetingCreateV1](docs/RetargetingCreateV1.md) + - [RetargetingUpdateV1](docs/RetargetingUpdateV1.md) + - [RetargetingV1](docs/RetargetingV1.md) + - [Size](docs/Size.md) + - [StatisticsReportQueryMessage](docs/StatisticsReportQueryMessage.md) + - [Tag](docs/Tag.md) + - [TransactionsReportQueryDataMessage](docs/TransactionsReportQueryDataMessage.md) + - [TransactionsReportQueryEntityMessage](docs/TransactionsReportQueryEntityMessage.md) + - [TransactionsReportQueryMessage](docs/TransactionsReportQueryMessage.md) + - [TransparencyQueryMessage](docs/TransparencyQueryMessage.md) + - [TransparencyReportAttributes](docs/TransparencyReportAttributes.md) + - [TransparencyReportDataMessage](docs/TransparencyReportDataMessage.md) + - [TransparencyReportEntityMessage](docs/TransparencyReportEntityMessage.md) + - [TransparencyReportFile](docs/TransparencyReportFile.md) + - [UpdateCoupon](docs/UpdateCoupon.md) + - [UpdateCouponRequest](docs/UpdateCouponRequest.md) + - [UpdateCouponResource](docs/UpdateCouponResource.md) + - [VideoDetail](docs/VideoDetail.md) + - [WriteModelAdSetId](docs/WriteModelAdSetId.md) + - [WriteModelPatchAdSet](docs/WriteModelPatchAdSet.md) + + +## Disclaimer + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/__init__.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/__init__.py new file mode 100644 index 00000000..d9367fd3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/__init__.py @@ -0,0 +1,31 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +__version__ = "2024.04.0.240515" + +# import ApiClient +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient +from criteo_api_marketingsolutions_v2024_04.criteo_api_client import CriteoApiClient +from criteo_api_marketingsolutions_v2024_04.api_client_builder import ApiClientBuilder +from criteo_api_marketingsolutions_v2024_04 import flow_constants + +# import Configuration +from criteo_api_marketingsolutions_v2024_04.configuration import Configuration + +# import exceptions +from criteo_api_marketingsolutions_v2024_04.exceptions import OpenApiException +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiTypeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiValueError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiKeyError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiException + + + diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/__init__.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/__init__.py new file mode 100644 index 00000000..9212556f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/__init__.py @@ -0,0 +1,3 @@ +# do not import all apis into this module because that uses a lot of memory and stack frames +# if you need the ability to import all apis from one package, import them with +# from criteo_api_marketingsolutions_v2024_04.apis import AdvertiserApi diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/advertiser_api.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/advertiser_api.py similarity index 94% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/advertiser_api.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/advertiser_api.py index cf186f73..dc291d7c 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/api/advertiser_api.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/advertiser_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,8 +11,8 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 check_allowed_values, check_validations, date, @@ -21,7 +21,7 @@ none_type, validate_and_convert_types ) -from criteo_api_marketingsolutions_v2023_01.model.get_portfolio_response import GetPortfolioResponse +from criteo_api_marketingsolutions_v2024_04.model.get_portfolio_response import GetPortfolioResponse class AdvertiserApi(object): @@ -42,7 +42,7 @@ def __init__(self, api_client=None): 'oauth', 'oauth' ], - 'endpoint_path': '/2023-01/advertisers/me', + 'endpoint_path': '/2024-04/advertisers/me', 'operation_id': 'api_portfolio_get', 'http_method': 'GET', 'servers': None, diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/analytics_api.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/analytics_api.py new file mode 100644 index 00000000..c996bead --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/analytics_api.py @@ -0,0 +1,604 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_marketingsolutions_v2024_04.model.placements_report_query_data_message import PlacementsReportQueryDataMessage +from criteo_api_marketingsolutions_v2024_04.model.problems_details import ProblemsDetails +from criteo_api_marketingsolutions_v2024_04.model.statistics_report_query_message import StatisticsReportQueryMessage +from criteo_api_marketingsolutions_v2024_04.model.transactions_report_query_data_message import TransactionsReportQueryDataMessage +from criteo_api_marketingsolutions_v2024_04.model.transparency_query_message import TransparencyQueryMessage +from criteo_api_marketingsolutions_v2024_04.model.transparency_report_data_message import TransparencyReportDataMessage + + +class AnalyticsApi(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.get_adset_report_endpoint = _Endpoint( + settings={ + 'response_type': (file_type,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/statistics/report', + 'operation_id': 'get_adset_report', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'statistics_report_query_message', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'statistics_report_query_message': + (StatisticsReportQueryMessage,), + }, + 'attribute_map': { + }, + 'location_map': { + 'statistics_report_query_message': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json', + 'text/csv', + 'text/xml', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ], + 'content_type': [ + 'application/json-patch+json', + 'application/json', + 'text/json', + 'application/*+json' + ] + }, + api_client=api_client + ) + self.get_placements_report_endpoint = _Endpoint( + settings={ + 'response_type': (file_type,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/placements/report', + 'operation_id': 'get_placements_report', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'placements_report_query_data_message', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'placements_report_query_data_message': + (PlacementsReportQueryDataMessage,), + }, + 'attribute_map': { + }, + 'location_map': { + 'placements_report_query_data_message': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json', + 'text/csv', + 'text/xml', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ], + 'content_type': [ + 'application/json-patch+json', + 'application/json', + 'text/json', + 'application/*+json' + ] + }, + api_client=api_client + ) + self.get_transactions_report_endpoint = _Endpoint( + settings={ + 'response_type': (file_type,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/transactions/report', + 'operation_id': 'get_transactions_report', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'transactions_report_query_data_message', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'transactions_report_query_data_message': + (TransactionsReportQueryDataMessage,), + }, + 'attribute_map': { + }, + 'location_map': { + 'transactions_report_query_data_message': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json', + 'text/csv', + 'text/xml', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ], + 'content_type': [ + 'application/json-patch+json', + 'application/json', + 'text/json', + 'application/*+json' + ] + }, + api_client=api_client + ) + self.get_transparency_report_endpoint = _Endpoint( + settings={ + 'response_type': (TransparencyReportDataMessage,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/log-level/advertisers/{advertiser-id}/report', + 'operation_id': 'get_transparency_report', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'transparency_query_message', + ], + 'required': [ + 'advertiser_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (int,), + 'transparency_query_message': + (TransparencyQueryMessage,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + }, + 'location_map': { + 'advertiser_id': 'path', + 'transparency_query_message': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'text/plain', + 'text/json' + ], + 'content_type': [ + 'application/json-patch+json', + 'application/json', + 'text/json', + 'application/*+json' + ] + }, + api_client=api_client + ) + + def get_adset_report( + self, + **kwargs + ): + """get_adset_report # noqa: E501 + + This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities. # 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_adset_report(async_req=True) + >>> result = thread.get() + + + Keyword Args: + statistics_report_query_message (StatisticsReportQueryMessage): [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: + file_type + 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) + return self.get_adset_report_endpoint.call_with_http_info(**kwargs) + + def get_placements_report( + self, + **kwargs + ): + """get_placements_report # noqa: E501 + + Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated. # 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_placements_report(async_req=True) + >>> result = thread.get() + + + Keyword Args: + placements_report_query_data_message (PlacementsReportQueryDataMessage): [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: + file_type + 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) + return self.get_placements_report_endpoint.call_with_http_info(**kwargs) + + def get_transactions_report( + self, + **kwargs + ): + """get_transactions_report # noqa: E501 + + This Transactions endpoint provides transactions id related data. # 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_transactions_report(async_req=True) + >>> result = thread.get() + + + Keyword Args: + transactions_report_query_data_message (TransactionsReportQueryDataMessage): [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: + file_type + 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) + return self.get_transactions_report_endpoint.call_with_http_info(**kwargs) + + def get_transparency_report( + self, + advertiser_id, + **kwargs + ): + """get_transparency_report # noqa: E501 + + This Statistics endpoint provides publisher data. # 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_transparency_report(advertiser_id, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (int): The advertiser id to fetch the transparency data. + + Keyword Args: + transparency_query_message (TransparencyQueryMessage): [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: + TransparencyReportDataMessage + 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['advertiser_id'] = \ + advertiser_id + return self.get_transparency_report_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/audience_api.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/audience_api.py new file mode 100644 index 00000000..f891b9c8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/audience_api.py @@ -0,0 +1,2506 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_create_input_v1 import AudienceBulkCreateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_delete_input_v1 import AudienceBulkDeleteInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_update_input_v1 import AudienceBulkUpdateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_compute_sizes_input_v1 import AudienceComputeSizesInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_audience_search_metadata_v1_list_response import AudienceEntityV1AudienceSearchMetadataV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_list_response import AudienceEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_estimate_size_input_v1 import AudienceEstimateSizeInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_id_entity_v1_list_response import AudienceIdEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_search_input_v1 import AudienceSearchInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_create_input_v1 import AudienceSegmentBulkCreateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_delete_input_v1 import AudienceSegmentBulkDeleteInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_update_input_v1 import AudienceSegmentBulkUpdateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_compute_sizes_input_v1 import AudienceSegmentComputeSizesInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response import AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_list_response import AudienceSegmentEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_estimate_size_input_v1 import AudienceSegmentEstimateSizeInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_id_entity_v1_list_response import AudienceSegmentIdEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_input_v1 import AudienceSegmentSearchInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_entity_v1_list_response import AudienceSegmentSizeEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_v1_response import AudienceSegmentSizeEstimationV1Response +from criteo_api_marketingsolutions_v2024_04.model.audience_size_entity_v1_list_response import AudienceSizeEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_size_estimation_v1_response import AudienceSizeEstimationV1Response +from criteo_api_marketingsolutions_v2024_04.model.contact_list_statistics_entity_v1_response import ContactListStatisticsEntityV1Response +from criteo_api_marketingsolutions_v2024_04.model.contactlist_amendment_request import ContactlistAmendmentRequest +from criteo_api_marketingsolutions_v2024_04.model.delete_audience_contact_list_response import DeleteAudienceContactListResponse +from criteo_api_marketingsolutions_v2024_04.model.error_code_response import ErrorCodeResponse +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_brand_entity_v1_list_response import InMarketAudienceSegmentBrandEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_interest_entity_v1_list_response import InMarketAudienceSegmentInterestEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.modify_audience_response import ModifyAudienceResponse + + +class AudienceApi(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.bulk_create_audience_segments_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceSegmentEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/create', + 'operation_id': 'bulk_create_audience_segments', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_bulk_create_input_v1', + ], + 'required': [ + 'audience_segment_bulk_create_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_bulk_create_input_v1': + (AudienceSegmentBulkCreateInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_segment_bulk_create_input_v1': '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.bulk_create_audiences_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audiences/create', + 'operation_id': 'bulk_create_audiences', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_bulk_create_input_v1', + ], + 'required': [ + 'audience_bulk_create_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_bulk_create_input_v1': + (AudienceBulkCreateInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_bulk_create_input_v1': '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.bulk_delete_audience_segments_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceSegmentIdEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/delete', + 'operation_id': 'bulk_delete_audience_segments', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_bulk_delete_input_v1', + ], + 'required': [ + 'audience_segment_bulk_delete_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_bulk_delete_input_v1': + (AudienceSegmentBulkDeleteInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_segment_bulk_delete_input_v1': '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.bulk_delete_audiences_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceIdEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audiences/delete', + 'operation_id': 'bulk_delete_audiences', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_bulk_delete_input_v1', + ], + 'required': [ + 'audience_bulk_delete_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_bulk_delete_input_v1': + (AudienceBulkDeleteInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_bulk_delete_input_v1': '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.bulk_update_audience_segments_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceSegmentEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments', + 'operation_id': 'bulk_update_audience_segments', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_bulk_update_input_v1', + ], + 'required': [ + 'audience_segment_bulk_update_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_bulk_update_input_v1': + (AudienceSegmentBulkUpdateInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_segment_bulk_update_input_v1': '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.bulk_update_audiences_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audiences', + 'operation_id': 'bulk_update_audiences', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_bulk_update_input_v1', + ], + 'required': [ + 'audience_bulk_update_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_bulk_update_input_v1': + (AudienceBulkUpdateInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_bulk_update_input_v1': '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.compute_audience_segments_sizes_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceSegmentSizeEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/compute-sizes', + 'operation_id': 'compute_audience_segments_sizes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_compute_sizes_input_v1', + ], + 'required': [ + 'audience_segment_compute_sizes_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_compute_sizes_input_v1': + (AudienceSegmentComputeSizesInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_segment_compute_sizes_input_v1': '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.compute_audiences_sizes_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceSizeEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audiences/compute-sizes', + 'operation_id': 'compute_audiences_sizes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_compute_sizes_input_v1', + ], + 'required': [ + 'audience_compute_sizes_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_compute_sizes_input_v1': + (AudienceComputeSizesInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_compute_sizes_input_v1': '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.delete_contact_list_identifiers_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteAudienceContactListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/{audience-segment-id}/contact-list', + 'operation_id': 'delete_contact_list_identifiers', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_id', + ], + 'required': [ + 'audience_segment_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_id': + (str,), + }, + 'attribute_map': { + 'audience_segment_id': 'audience-segment-id', + }, + 'location_map': { + 'audience_segment_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.estimate_audience_segment_size_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceSegmentSizeEstimationV1Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/estimate-size', + 'operation_id': 'estimate_audience_segment_size', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_estimate_size_input_v1', + ], + 'required': [ + 'audience_segment_estimate_size_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_estimate_size_input_v1': + (AudienceSegmentEstimateSizeInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_segment_estimate_size_input_v1': '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.estimate_audience_size_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceSizeEstimationV1Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audiences/estimate-size', + 'operation_id': 'estimate_audience_size', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_estimate_size_input_v1', + ], + 'required': [ + 'audience_estimate_size_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_estimate_size_input_v1': + (AudienceEstimateSizeInputV1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'audience_estimate_size_input_v1': '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.get_audience_segment_contact_list_statistics_endpoint = _Endpoint( + settings={ + 'response_type': (ContactListStatisticsEntityV1Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/{audience-segment-id}/contact-list/statistics', + 'operation_id': 'get_audience_segment_contact_list_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_id', + ], + 'required': [ + 'audience_segment_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_id': + (int,), + }, + 'attribute_map': { + 'audience_segment_id': 'audience-segment-id', + }, + 'location_map': { + 'audience_segment_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_audience_segments_in_market_brands_endpoint = _Endpoint( + settings={ + 'response_type': (InMarketAudienceSegmentBrandEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/in-market-brands', + 'operation_id': 'get_audience_segments_in_market_brands', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'country', + ], + 'required': [ + 'advertiser_id', + 'country', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'country': + (str,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'country': 'country', + }, + 'location_map': { + 'advertiser_id': 'query', + 'country': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_audience_segments_in_market_interests_endpoint = _Endpoint( + settings={ + 'response_type': (InMarketAudienceSegmentInterestEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/in-market-interests', + 'operation_id': 'get_audience_segments_in_market_interests', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'country', + ], + 'required': [ + 'advertiser_id', + 'country', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'country': + (str,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'country': 'country', + }, + 'location_map': { + 'advertiser_id': 'query', + 'country': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.search_audience_segments_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/search', + 'operation_id': 'search_audience_segments', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_search_input_v1', + 'limit', + 'offset', + ], + 'required': [ + 'audience_segment_search_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 100, + 'inclusive_minimum': 0, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_search_input_v1': + (AudienceSegmentSearchInputV1,), + 'limit': + (int,), + 'offset': + (int,), + }, + 'attribute_map': { + 'limit': 'limit', + 'offset': 'offset', + }, + 'location_map': { + 'audience_segment_search_input_v1': 'body', + 'limit': 'query', + 'offset': 'query', + }, + '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.search_audiences_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceEntityV1AudienceSearchMetadataV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audiences/search', + 'operation_id': 'search_audiences', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_search_input_v1', + 'limit', + 'offset', + ], + 'required': [ + 'audience_search_input_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 100, + 'inclusive_minimum': 0, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_search_input_v1': + (AudienceSearchInputV1,), + 'limit': + (int,), + 'offset': + (int,), + }, + 'attribute_map': { + 'limit': 'limit', + 'offset': 'offset', + }, + 'location_map': { + 'audience_search_input_v1': 'body', + 'limit': 'query', + 'offset': 'query', + }, + '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.update_contact_list_identifiers_endpoint = _Endpoint( + settings={ + 'response_type': (ModifyAudienceResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/audience-segments/{audience-segment-id}/contact-list', + 'operation_id': 'update_contact_list_identifiers', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_id', + 'contactlist_amendment_request', + ], + 'required': [ + 'audience_segment_id', + 'contactlist_amendment_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_id': + (str,), + 'contactlist_amendment_request': + (ContactlistAmendmentRequest,), + }, + 'attribute_map': { + 'audience_segment_id': 'audience-segment-id', + }, + 'location_map': { + 'audience_segment_id': 'path', + 'contactlist_amendment_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def bulk_create_audience_segments( + self, + audience_segment_bulk_create_input_v1, + **kwargs + ): + """bulk_create_audience_segments # noqa: E501 + + Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bulk_create_audience_segments(audience_segment_bulk_create_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_bulk_create_input_v1 (AudienceSegmentBulkCreateInputV1): Segment creation parameter + + 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: + AudienceSegmentEntityV1ListResponse + 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['audience_segment_bulk_create_input_v1'] = \ + audience_segment_bulk_create_input_v1 + return self.bulk_create_audience_segments_endpoint.call_with_http_info(**kwargs) + + def bulk_create_audiences( + self, + audience_bulk_create_input_v1, + **kwargs + ): + """bulk_create_audiences # noqa: E501 + + Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bulk_create_audiences(audience_bulk_create_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_bulk_create_input_v1 (AudienceBulkCreateInputV1): + + 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: + AudienceEntityV1ListResponse + 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['audience_bulk_create_input_v1'] = \ + audience_bulk_create_input_v1 + return self.bulk_create_audiences_endpoint.call_with_http_info(**kwargs) + + def bulk_delete_audience_segments( + self, + audience_segment_bulk_delete_input_v1, + **kwargs + ): + """bulk_delete_audience_segments # noqa: E501 + + Delete the segments associated to the given audience 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.bulk_delete_audience_segments(audience_segment_bulk_delete_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_bulk_delete_input_v1 (AudienceSegmentBulkDeleteInputV1): Segment delete request. + + 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: + AudienceSegmentIdEntityV1ListResponse + 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['audience_segment_bulk_delete_input_v1'] = \ + audience_segment_bulk_delete_input_v1 + return self.bulk_delete_audience_segments_endpoint.call_with_http_info(**kwargs) + + def bulk_delete_audiences( + self, + audience_bulk_delete_input_v1, + **kwargs + ): + """bulk_delete_audiences # noqa: E501 + + Deletes the audiences associated to the given audience 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.bulk_delete_audiences(audience_bulk_delete_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_bulk_delete_input_v1 (AudienceBulkDeleteInputV1): + + 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: + AudienceIdEntityV1ListResponse + 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['audience_bulk_delete_input_v1'] = \ + audience_bulk_delete_input_v1 + return self.bulk_delete_audiences_endpoint.call_with_http_info(**kwargs) + + def bulk_update_audience_segments( + self, + audience_segment_bulk_update_input_v1, + **kwargs + ): + """bulk_update_audience_segments # noqa: E501 + + Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bulk_update_audience_segments(audience_segment_bulk_update_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_bulk_update_input_v1 (AudienceSegmentBulkUpdateInputV1): Segment Update request + + 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: + AudienceSegmentEntityV1ListResponse + 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['audience_segment_bulk_update_input_v1'] = \ + audience_segment_bulk_update_input_v1 + return self.bulk_update_audience_segments_endpoint.call_with_http_info(**kwargs) + + def bulk_update_audiences( + self, + audience_bulk_update_input_v1, + **kwargs + ): + """bulk_update_audiences # noqa: E501 + + Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bulk_update_audiences(audience_bulk_update_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_bulk_update_input_v1 (AudienceBulkUpdateInputV1): + + 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: + AudienceEntityV1ListResponse + 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['audience_bulk_update_input_v1'] = \ + audience_bulk_update_input_v1 + return self.bulk_update_audiences_endpoint.call_with_http_info(**kwargs) + + def compute_audience_segments_sizes( + self, + audience_segment_compute_sizes_input_v1, + **kwargs + ): + """compute_audience_segments_sizes # noqa: E501 + + Gets the size of all segments. An error is returned for those whose size calculation is not supported. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.compute_audience_segments_sizes(audience_segment_compute_sizes_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_compute_sizes_input_v1 (AudienceSegmentComputeSizesInputV1): + + 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: + AudienceSegmentSizeEntityV1ListResponse + 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['audience_segment_compute_sizes_input_v1'] = \ + audience_segment_compute_sizes_input_v1 + return self.compute_audience_segments_sizes_endpoint.call_with_http_info(**kwargs) + + def compute_audiences_sizes( + self, + audience_compute_sizes_input_v1, + **kwargs + ): + """compute_audiences_sizes # noqa: E501 + + Gets the size of all audiences. An error is returned for those whose size calculation is not supported. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.compute_audiences_sizes(audience_compute_sizes_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_compute_sizes_input_v1 (AudienceComputeSizesInputV1): + + 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: + AudienceSizeEntityV1ListResponse + 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['audience_compute_sizes_input_v1'] = \ + audience_compute_sizes_input_v1 + return self.compute_audiences_sizes_endpoint.call_with_http_info(**kwargs) + + def delete_contact_list_identifiers( + self, + audience_segment_id, + **kwargs + ): + """delete_contact_list_identifiers # noqa: E501 + + Delete all identifiers from a contact list audience-segment. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_contact_list_identifiers(audience_segment_id, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_id (str): The id of the contact list audience-segment to amend + + 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: + DeleteAudienceContactListResponse + 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['audience_segment_id'] = \ + audience_segment_id + return self.delete_contact_list_identifiers_endpoint.call_with_http_info(**kwargs) + + def estimate_audience_segment_size( + self, + audience_segment_estimate_size_input_v1, + **kwargs + ): + """estimate_audience_segment_size # noqa: E501 + + Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.estimate_audience_segment_size(audience_segment_estimate_size_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_estimate_size_input_v1 (AudienceSegmentEstimateSizeInputV1): + + 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: + AudienceSegmentSizeEstimationV1Response + 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['audience_segment_estimate_size_input_v1'] = \ + audience_segment_estimate_size_input_v1 + return self.estimate_audience_segment_size_endpoint.call_with_http_info(**kwargs) + + def estimate_audience_size( + self, + audience_estimate_size_input_v1, + **kwargs + ): + """estimate_audience_size # noqa: E501 + + Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.estimate_audience_size(audience_estimate_size_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_estimate_size_input_v1 (AudienceEstimateSizeInputV1): + + 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: + AudienceSizeEstimationV1Response + 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['audience_estimate_size_input_v1'] = \ + audience_estimate_size_input_v1 + return self.estimate_audience_size_endpoint.call_with_http_info(**kwargs) + + def get_audience_segment_contact_list_statistics( + self, + audience_segment_id, + **kwargs + ): + """get_audience_segment_contact_list_statistics # noqa: E501 + + Returns the statistics of a contact list segment. # 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_audience_segment_contact_list_statistics(audience_segment_id, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_id (int): The segment 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: + ContactListStatisticsEntityV1Response + 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['audience_segment_id'] = \ + audience_segment_id + return self.get_audience_segment_contact_list_statistics_endpoint.call_with_http_info(**kwargs) + + def get_audience_segments_in_market_brands( + self, + advertiser_id, + country, + **kwargs + ): + """get_audience_segments_in_market_brands # noqa: E501 + + Returns a list with all available in-market brands that can be used to define an in-market segment. # 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_audience_segments_in_market_brands(advertiser_id, country, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser ID. + country (str): The ISO 3166-1 alpha-2 country code. + + 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: + InMarketAudienceSegmentBrandEntityV1ListResponse + 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['advertiser_id'] = \ + advertiser_id + kwargs['country'] = \ + country + return self.get_audience_segments_in_market_brands_endpoint.call_with_http_info(**kwargs) + + def get_audience_segments_in_market_interests( + self, + advertiser_id, + country, + **kwargs + ): + """get_audience_segments_in_market_interests # noqa: E501 + + Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy. # 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_audience_segments_in_market_interests(advertiser_id, country, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser ID. + country (str): The ISO 3166-1 alpha-2 country code. + + 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: + InMarketAudienceSegmentInterestEntityV1ListResponse + 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['advertiser_id'] = \ + advertiser_id + kwargs['country'] = \ + country + return self.get_audience_segments_in_market_interests_endpoint.call_with_http_info(**kwargs) + + def search_audience_segments( + self, + audience_segment_search_input_v1, + **kwargs + ): + """search_audience_segments # noqa: E501 + + Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_audience_segments(audience_segment_search_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_search_input_v1 (AudienceSegmentSearchInputV1): Segment search filters. + + Keyword Args: + limit (int): The number of elements to be returned. The default is 50 and the maximum is 100.. [optional] if omitted the server will use the default value of 50 + offset (int): The (zero-based) offset into the collection. The default is 0.. [optional] if omitted the server will use the default value of 0 + _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: + AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse + 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['audience_segment_search_input_v1'] = \ + audience_segment_search_input_v1 + return self.search_audience_segments_endpoint.call_with_http_info(**kwargs) + + def search_audiences( + self, + audience_search_input_v1, + **kwargs + ): + """search_audiences # noqa: E501 + + Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_audiences(audience_search_input_v1, async_req=True) + >>> result = thread.get() + + Args: + audience_search_input_v1 (AudienceSearchInputV1): Audience search filters. + + Keyword Args: + limit (int): The number of elements to be returned. The default is 50 and the maximum is 100.. [optional] if omitted the server will use the default value of 50 + offset (int): The (zero-based) offset into the collection. The default is 0.. [optional] if omitted the server will use the default value of 0 + _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: + AudienceEntityV1AudienceSearchMetadataV1ListResponse + 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['audience_search_input_v1'] = \ + audience_search_input_v1 + return self.search_audiences_endpoint.call_with_http_info(**kwargs) + + def update_contact_list_identifiers( + self, + audience_segment_id, + contactlist_amendment_request, + **kwargs + ): + """update_contact_list_identifiers # noqa: E501 + + Add/remove identifiers to or from a contact list audience-segment. # 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_contact_list_identifiers(audience_segment_id, contactlist_amendment_request, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_id (str): The id of the contact list audience-segment to amend + contactlist_amendment_request (ContactlistAmendmentRequest): + + 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: + ModifyAudienceResponse + 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['audience_segment_id'] = \ + audience_segment_id + kwargs['contactlist_amendment_request'] = \ + contactlist_amendment_request + return self.update_contact_list_identifiers_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/campaign_api.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/campaign_api.py new file mode 100644 index 00000000..6c402d6a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/campaign_api.py @@ -0,0 +1,2144 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_entity_v1_response import AdSetAudienceLinkEntityV1Response +from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_input_entity_v1 import AdSetAudienceLinkInputEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_set_search_request_v23_q1 import AdSetSearchRequestV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.campaign_search_request_v23_q1 import CampaignSearchRequestV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_list_response import CampaignV23Q1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_response import CampaignV23Q1Response +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_request import CreateAdSetRequest +from criteo_api_marketingsolutions_v2024_04.model.create_campaign_request import CreateCampaignRequest +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_list_request import PatchAdSetCategoryBidListRequest +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_result_list_response import PatchAdSetCategoryBidResultListResponse +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_list_request import PatchAdSetDisplayMultiplierListRequest +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_result_list_response import PatchAdSetDisplayMultiplierResultListResponse +from criteo_api_marketingsolutions_v2024_04.model.patch_campaign_list_request import PatchCampaignListRequest +from criteo_api_marketingsolutions_v2024_04.model.patch_result_campaign_list_response import PatchResultCampaignListResponse +from criteo_api_marketingsolutions_v2024_04.model.requests_ad_set_id import RequestsAdSetId +from criteo_api_marketingsolutions_v2024_04.model.requests_patch_ad_set import RequestsPatchAdSet +from criteo_api_marketingsolutions_v2024_04.model.response_read_ad_set import ResponseReadAdSet +from criteo_api_marketingsolutions_v2024_04.model.response_read_ad_set_v23_q1 import ResponseReadAdSetV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.responses_ad_set_id import ResponsesAdSetId +from criteo_api_marketingsolutions_v2024_04.model.responses_read_ad_set_v23_q1 import ResponsesReadAdSetV23Q1 + + +class CampaignApi(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.create_ad_set_endpoint = _Endpoint( + settings={ + 'response_type': (ResponseReadAdSet,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets', + 'operation_id': 'create_ad_set', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'create_ad_set_request', + ], + 'required': [ + 'create_ad_set_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'create_ad_set_request': + (CreateAdSetRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'create_ad_set_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.create_campaign_endpoint = _Endpoint( + settings={ + 'response_type': (CampaignV23Q1Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/campaigns', + 'operation_id': 'create_campaign', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'create_campaign_request', + ], + 'required': [ + 'create_campaign_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'create_campaign_request': + (CreateCampaignRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'create_campaign_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.get_ad_set_v23_q1_endpoint = _Endpoint( + settings={ + 'response_type': (ResponseReadAdSetV23Q1,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/{ad-set-id}', + 'operation_id': 'get_ad_set_v23_q1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'ad_set_id', + ], + 'required': [ + 'ad_set_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ad_set_id': + (str,), + }, + 'attribute_map': { + 'ad_set_id': 'ad-set-id', + }, + 'location_map': { + 'ad_set_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_campaign_v23_q1_endpoint = _Endpoint( + settings={ + 'response_type': (CampaignV23Q1Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/campaigns/{campaign-id}', + 'operation_id': 'get_campaign_v23_q1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'campaign_id', + ], + 'required': [ + 'campaign_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (str,), + }, + 'attribute_map': { + 'campaign_id': 'campaign-id', + }, + 'location_map': { + 'campaign_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_category_bid_list_endpoint = _Endpoint( + settings={ + 'response_type': (AdSetCategoryBidListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/{ad-set-id}/category-bids', + 'operation_id': 'get_category_bid_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'ad_set_id', + ], + 'required': [ + 'ad_set_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ad_set_id': + (str,), + }, + 'attribute_map': { + 'ad_set_id': 'ad-set-id', + }, + 'location_map': { + 'ad_set_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_display_multipliers_endpoint = _Endpoint( + settings={ + 'response_type': (AdSetDisplayMultiplierListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers', + 'operation_id': 'get_display_multipliers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'ad_set_id', + ], + 'required': [ + 'ad_set_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ad_set_id': + (str,), + }, + 'attribute_map': { + 'ad_set_id': 'ad-set-id', + }, + 'location_map': { + 'ad_set_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_ad_sets_endpoint = _Endpoint( + settings={ + 'response_type': (ResponsesAdSetId,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets', + 'operation_id': 'patch_ad_sets', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'requests_patch_ad_set', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'requests_patch_ad_set': + (RequestsPatchAdSet,), + }, + 'attribute_map': { + }, + 'location_map': { + 'requests_patch_ad_set': '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.patch_campaigns_endpoint = _Endpoint( + settings={ + 'response_type': (PatchResultCampaignListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/campaigns', + 'operation_id': 'patch_campaigns', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'patch_campaign_list_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'patch_campaign_list_request': + (PatchCampaignListRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'patch_campaign_list_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.patch_category_bid_list_endpoint = _Endpoint( + settings={ + 'response_type': (PatchAdSetCategoryBidResultListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/{ad-set-id}/category-bids', + 'operation_id': 'patch_category_bid_list', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'ad_set_id', + 'patch_ad_set_category_bid_list_request', + ], + 'required': [ + 'ad_set_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ad_set_id': + (str,), + 'patch_ad_set_category_bid_list_request': + (PatchAdSetCategoryBidListRequest,), + }, + 'attribute_map': { + 'ad_set_id': 'ad-set-id', + }, + 'location_map': { + 'ad_set_id': 'path', + 'patch_ad_set_category_bid_list_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.patch_display_multipliers_endpoint = _Endpoint( + settings={ + 'response_type': (PatchAdSetDisplayMultiplierResultListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers', + 'operation_id': 'patch_display_multipliers', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'ad_set_id', + 'patch_ad_set_display_multiplier_list_request', + ], + 'required': [ + 'ad_set_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ad_set_id': + (str,), + 'patch_ad_set_display_multiplier_list_request': + (PatchAdSetDisplayMultiplierListRequest,), + }, + 'attribute_map': { + 'ad_set_id': 'ad-set-id', + }, + 'location_map': { + 'ad_set_id': 'path', + 'patch_ad_set_display_multiplier_list_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.search_ad_sets_v23_q1_endpoint = _Endpoint( + settings={ + 'response_type': (ResponsesReadAdSetV23Q1,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/search', + 'operation_id': 'search_ad_sets_v23_q1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'ad_set_search_request_v23_q1', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ad_set_search_request_v23_q1': + (AdSetSearchRequestV23Q1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'ad_set_search_request_v23_q1': '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.search_campaigns_v23_q1_endpoint = _Endpoint( + settings={ + 'response_type': (CampaignV23Q1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/campaigns/search', + 'operation_id': 'search_campaigns_v23_q1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'campaign_search_request_v23_q1', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_search_request_v23_q1': + (CampaignSearchRequestV23Q1,), + }, + 'attribute_map': { + }, + 'location_map': { + 'campaign_search_request_v23_q1': '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.start_ad_sets_endpoint = _Endpoint( + settings={ + 'response_type': (ResponsesAdSetId,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/start', + 'operation_id': 'start_ad_sets', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'requests_ad_set_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'requests_ad_set_id': + (RequestsAdSetId,), + }, + 'attribute_map': { + }, + 'location_map': { + 'requests_ad_set_id': '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.stop_ad_sets_endpoint = _Endpoint( + settings={ + 'response_type': (ResponsesAdSetId,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/stop', + 'operation_id': 'stop_ad_sets', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'requests_ad_set_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'requests_ad_set_id': + (RequestsAdSetId,), + }, + 'attribute_map': { + }, + 'location_map': { + 'requests_ad_set_id': '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.update_ad_set_audience_endpoint = _Endpoint( + settings={ + 'response_type': (AdSetAudienceLinkEntityV1Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ad-sets/{ad-set-id}/audience', + 'operation_id': 'update_ad_set_audience', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'ad_set_id', + 'ad_set_audience_link_input_entity_v1', + ], + 'required': [ + 'ad_set_id', + 'ad_set_audience_link_input_entity_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ad_set_id': + (str,), + 'ad_set_audience_link_input_entity_v1': + (AdSetAudienceLinkInputEntityV1,), + }, + 'attribute_map': { + 'ad_set_id': 'ad-set-id', + }, + 'location_map': { + 'ad_set_id': 'path', + 'ad_set_audience_link_input_entity_v1': '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 + ) + + def create_ad_set( + self, + create_ad_set_request, + **kwargs + ): + """create_ad_set # noqa: E501 + + Create the specified ad set # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_ad_set(create_ad_set_request, async_req=True) + >>> result = thread.get() + + Args: + create_ad_set_request (CreateAdSetRequest): the ad sets to create + + 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: + ResponseReadAdSet + 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['create_ad_set_request'] = \ + create_ad_set_request + return self.create_ad_set_endpoint.call_with_http_info(**kwargs) + + def create_campaign( + self, + create_campaign_request, + **kwargs + ): + """create_campaign # noqa: E501 + + Create the specified campaign # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_campaign(create_campaign_request, async_req=True) + >>> result = thread.get() + + Args: + create_campaign_request (CreateCampaignRequest): the campaigns to create + + 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: + CampaignV23Q1Response + 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['create_campaign_request'] = \ + create_campaign_request + return self.create_campaign_endpoint.call_with_http_info(**kwargs) + + def get_ad_set_v23_q1( + self, + ad_set_id, + **kwargs + ): + """get_ad_set_v23_q1 # noqa: E501 + + Get the data for the specified ad set # 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_ad_set_v23_q1(ad_set_id, async_req=True) + >>> result = thread.get() + + Args: + ad_set_id (str): Id of the ad set + + 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: + ResponseReadAdSetV23Q1 + 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['ad_set_id'] = \ + ad_set_id + return self.get_ad_set_v23_q1_endpoint.call_with_http_info(**kwargs) + + def get_campaign_v23_q1( + self, + campaign_id, + **kwargs + ): + """get_campaign_v23_q1 # noqa: E501 + + Get the data for the specified campaign # 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_v23_q1(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + campaign_id (str): Id of the campaign + + 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: + CampaignV23Q1Response + 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['campaign_id'] = \ + campaign_id + return self.get_campaign_v23_q1_endpoint.call_with_http_info(**kwargs) + + def get_category_bid_list( + self, + ad_set_id, + **kwargs + ): + """get_category_bid_list # noqa: E501 + + Get the Category Bids for all valid Categories associated to an Ad Set # 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_category_bid_list(ad_set_id, async_req=True) + >>> result = thread.get() + + Args: + ad_set_id (str): Id of the Ad Set + + 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: + AdSetCategoryBidListResponse + 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['ad_set_id'] = \ + ad_set_id + return self.get_category_bid_list_endpoint.call_with_http_info(**kwargs) + + def get_display_multipliers( + self, + ad_set_id, + **kwargs + ): + """get_display_multipliers # noqa: E501 + + Get the Display Multipliers for all valid Categories associated to an Ad Set # 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_display_multipliers(ad_set_id, async_req=True) + >>> result = thread.get() + + Args: + ad_set_id (str): Id of the Ad Set + + 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: + AdSetDisplayMultiplierListResponse + 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['ad_set_id'] = \ + ad_set_id + return self.get_display_multipliers_endpoint.call_with_http_info(**kwargs) + + def patch_ad_sets( + self, + **kwargs + ): + """patch_ad_sets # noqa: E501 + + Patch a list of AdSets. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_ad_sets(async_req=True) + >>> result = thread.get() + + + Keyword Args: + requests_patch_ad_set (RequestsPatchAdSet): List of adsets to patch.. [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: + ResponsesAdSetId + 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) + return self.patch_ad_sets_endpoint.call_with_http_info(**kwargs) + + def patch_campaigns( + self, + **kwargs + ): + """patch_campaigns # noqa: E501 + + Patch a list of Campaigns. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_campaigns(async_req=True) + >>> result = thread.get() + + + Keyword Args: + patch_campaign_list_request (PatchCampaignListRequest): List of campaigns to patch.. [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: + PatchResultCampaignListResponse + 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) + return self.patch_campaigns_endpoint.call_with_http_info(**kwargs) + + def patch_category_bid_list( + self, + ad_set_id, + **kwargs + ): + """patch_category_bid_list # noqa: E501 + + Patch Category Bids for one or more Categories in a single request. Partial success policy is followed. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_category_bid_list(ad_set_id, async_req=True) + >>> result = thread.get() + + Args: + ad_set_id (str): Id of the Ad Set + + Keyword Args: + patch_ad_set_category_bid_list_request (PatchAdSetCategoryBidListRequest): [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: + PatchAdSetCategoryBidResultListResponse + 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['ad_set_id'] = \ + ad_set_id + return self.patch_category_bid_list_endpoint.call_with_http_info(**kwargs) + + def patch_display_multipliers( + self, + ad_set_id, + **kwargs + ): + """patch_display_multipliers # noqa: E501 + + Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_display_multipliers(ad_set_id, async_req=True) + >>> result = thread.get() + + Args: + ad_set_id (str): Id of the Ad Set + + Keyword Args: + patch_ad_set_display_multiplier_list_request (PatchAdSetDisplayMultiplierListRequest): [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: + PatchAdSetDisplayMultiplierResultListResponse + 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['ad_set_id'] = \ + ad_set_id + return self.patch_display_multipliers_endpoint.call_with_http_info(**kwargs) + + def search_ad_sets_v23_q1( + self, + **kwargs + ): + """search_ad_sets_v23_q1 # noqa: E501 + + Search for ad sets # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_ad_sets_v23_q1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + ad_set_search_request_v23_q1 (AdSetSearchRequestV23Q1): [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: + ResponsesReadAdSetV23Q1 + 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) + return self.search_ad_sets_v23_q1_endpoint.call_with_http_info(**kwargs) + + def search_campaigns_v23_q1( + self, + **kwargs + ): + """search_campaigns_v23_q1 # noqa: E501 + + Search for campaigns # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_campaigns_v23_q1(async_req=True) + >>> result = thread.get() + + + Keyword Args: + campaign_search_request_v23_q1 (CampaignSearchRequestV23Q1): filters on campaigns. [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: + CampaignV23Q1ListResponse + 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) + return self.search_campaigns_v23_q1_endpoint.call_with_http_info(**kwargs) + + def start_ad_sets( + self, + **kwargs + ): + """start_ad_sets # noqa: E501 + + Start the specified list of ad sets # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.start_ad_sets(async_req=True) + >>> result = thread.get() + + + Keyword Args: + requests_ad_set_id (RequestsAdSetId): All the ad sets to start. [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: + ResponsesAdSetId + 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) + return self.start_ad_sets_endpoint.call_with_http_info(**kwargs) + + def stop_ad_sets( + self, + **kwargs + ): + """stop_ad_sets # noqa: E501 + + Stop the specified list of ad sets # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.stop_ad_sets(async_req=True) + >>> result = thread.get() + + + Keyword Args: + requests_ad_set_id (RequestsAdSetId): All the ad sets to stop. [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: + ResponsesAdSetId + 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) + return self.stop_ad_sets_endpoint.call_with_http_info(**kwargs) + + def update_ad_set_audience( + self, + ad_set_id, + ad_set_audience_link_input_entity_v1, + **kwargs + ): + """update_ad_set_audience # noqa: E501 + + Link or unlink an audience with an ad set # 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_ad_set_audience(ad_set_id, ad_set_audience_link_input_entity_v1, async_req=True) + >>> result = thread.get() + + Args: + ad_set_id (str): The ad set ID. + ad_set_audience_link_input_entity_v1 (AdSetAudienceLinkInputEntityV1): Ad set-Audience update request. + + 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: + AdSetAudienceLinkEntityV1Response + 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['ad_set_id'] = \ + ad_set_id + kwargs['ad_set_audience_link_input_entity_v1'] = \ + ad_set_audience_link_input_entity_v1 + return self.update_ad_set_audience_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/creative_api.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/creative_api.py new file mode 100644 index 00000000..b8fd753a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/creative_api.py @@ -0,0 +1,2541 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_marketingsolutions_v2024_04.model.ad_list_response import AdListResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_response import AdResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_write_request import AdWriteRequest +from criteo_api_marketingsolutions_v2024_04.model.coupon_list_response import CouponListResponse +from criteo_api_marketingsolutions_v2024_04.model.coupon_response import CouponResponse +from criteo_api_marketingsolutions_v2024_04.model.coupon_supported_sizes_response import CouponSupportedSizesResponse +from criteo_api_marketingsolutions_v2024_04.model.create_coupon_request import CreateCouponRequest +from criteo_api_marketingsolutions_v2024_04.model.creative_list_response import CreativeListResponse +from criteo_api_marketingsolutions_v2024_04.model.creative_response import CreativeResponse +from criteo_api_marketingsolutions_v2024_04.model.creative_write_request import CreativeWriteRequest +from criteo_api_marketingsolutions_v2024_04.model.update_coupon_request import UpdateCouponRequest + + +class CreativeApi(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.create_advertiser_ad_endpoint = _Endpoint( + settings={ + 'response_type': (AdResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/ads', + 'operation_id': 'create_advertiser_ad', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'ad_write_request', + ], + 'required': [ + 'advertiser_id', + 'ad_write_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'ad_write_request': + (AdWriteRequest,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + }, + 'location_map': { + 'advertiser_id': 'path', + 'ad_write_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.create_advertiser_coupon_endpoint = _Endpoint( + settings={ + 'response_type': (CouponResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons', + 'operation_id': 'create_advertiser_coupon', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'create_coupon_request', + ], + 'required': [ + 'advertiser_id', + 'create_coupon_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'create_coupon_request': + (CreateCouponRequest,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + }, + 'location_map': { + 'advertiser_id': 'path', + 'create_coupon_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.create_advertiser_creative_endpoint = _Endpoint( + settings={ + 'response_type': (CreativeResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/creatives', + 'operation_id': 'create_advertiser_creative', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'creative_write_request', + ], + 'required': [ + 'advertiser_id', + 'creative_write_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'creative_write_request': + (CreativeWriteRequest,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + }, + 'location_map': { + 'advertiser_id': 'path', + 'creative_write_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.delete_ad_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ads/{id}', + 'operation_id': 'delete_ad', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (int,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_advertiser_coupon_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}', + 'operation_id': 'delete_advertiser_coupon', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'id', + ], + 'required': [ + 'advertiser_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'id': + (str,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'id': 'id', + }, + 'location_map': { + 'advertiser_id': 'path', + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_creative_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/creatives/{id}', + 'operation_id': 'delete_creative', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.edit_advertiser_coupon_endpoint = _Endpoint( + settings={ + 'response_type': (CouponResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}', + 'operation_id': 'edit_advertiser_coupon', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'id', + 'update_coupon_request', + ], + 'required': [ + 'advertiser_id', + 'id', + 'update_coupon_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'id': + (str,), + 'update_coupon_request': + (UpdateCouponRequest,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'id': 'id', + }, + 'location_map': { + 'advertiser_id': 'path', + 'id': 'path', + 'update_coupon_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.edit_creative_endpoint = _Endpoint( + settings={ + 'response_type': (CreativeResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/creatives/{id}', + 'operation_id': 'edit_creative', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'creative_write_request', + ], + 'required': [ + 'id', + 'creative_write_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'creative_write_request': + (CreativeWriteRequest,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'creative_write_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_creative_preview_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/creatives/{id}/preview', + 'operation_id': 'generate_creative_preview', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'width', + 'height', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'width': + (int,), + 'height': + (int,), + }, + 'attribute_map': { + 'id': 'id', + 'width': 'width', + 'height': 'height', + }, + 'location_map': { + 'id': 'path', + 'width': 'query', + 'height': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/html', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_ad_endpoint = _Endpoint( + settings={ + 'response_type': (AdResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/ads/{id}', + 'operation_id': 'get_ad', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (int,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_advertiser_ads_endpoint = _Endpoint( + settings={ + 'response_type': (AdListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/ads', + 'operation_id': 'get_advertiser_ads', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'limit', + 'offset', + ], + 'required': [ + 'advertiser_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'limit': + (int,), + 'offset': + (int,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'limit': 'limit', + 'offset': 'offset', + }, + 'location_map': { + 'advertiser_id': 'path', + 'limit': 'query', + 'offset': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_advertiser_coupon_endpoint = _Endpoint( + settings={ + 'response_type': (CouponResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}', + 'operation_id': 'get_advertiser_coupon', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'id', + ], + 'required': [ + 'advertiser_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'id': + (str,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'id': 'id', + }, + 'location_map': { + 'advertiser_id': 'path', + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_advertiser_coupon_preview_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}/preview', + 'operation_id': 'get_advertiser_coupon_preview', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'id', + 'width', + 'height', + ], + 'required': [ + 'advertiser_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'id': + (str,), + 'width': + (int,), + 'height': + (int,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'id': 'id', + 'width': 'width', + 'height': 'height', + }, + 'location_map': { + 'advertiser_id': 'path', + 'id': 'path', + 'width': 'query', + 'height': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/html', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_advertiser_coupon_supported_sizes_endpoint = _Endpoint( + settings={ + 'response_type': (CouponSupportedSizesResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons-supported-sizes', + 'operation_id': 'get_advertiser_coupon_supported_sizes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'ad_set_id', + ], + 'required': [ + 'advertiser_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'ad_set_id': + (str,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'ad_set_id': 'ad-set-id', + }, + 'location_map': { + 'advertiser_id': 'path', + 'ad_set_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_advertiser_coupons_endpoint = _Endpoint( + settings={ + 'response_type': (CouponListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons', + 'operation_id': 'get_advertiser_coupons', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'limit', + 'offset', + ], + 'required': [ + 'advertiser_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'limit': + (int,), + 'offset': + (int,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'limit': 'limit', + 'offset': 'offset', + }, + 'location_map': { + 'advertiser_id': 'path', + 'limit': 'query', + 'offset': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_advertiser_creatives_endpoint = _Endpoint( + settings={ + 'response_type': (CreativeListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/advertisers/{advertiser-id}/creatives', + 'operation_id': 'get_advertiser_creatives', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'advertiser_id', + 'limit', + 'offset', + ], + 'required': [ + 'advertiser_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'advertiser_id': + (str,), + 'limit': + (int,), + 'offset': + (int,), + }, + 'attribute_map': { + 'advertiser_id': 'advertiser-id', + 'limit': 'limit', + 'offset': 'offset', + }, + 'location_map': { + 'advertiser_id': 'path', + 'limit': 'query', + 'offset': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_creative_endpoint = _Endpoint( + settings={ + 'response_type': (CreativeResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/creatives/{id}', + 'operation_id': 'get_creative', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_advertiser_ad( + self, + advertiser_id, + ad_write_request, + **kwargs + ): + """create_advertiser_ad # noqa: E501 + + Create an Ad # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_advertiser_ad(advertiser_id, ad_write_request, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + ad_write_request (AdWriteRequest): + + 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: + AdResponse + 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['advertiser_id'] = \ + advertiser_id + kwargs['ad_write_request'] = \ + ad_write_request + return self.create_advertiser_ad_endpoint.call_with_http_info(**kwargs) + + def create_advertiser_coupon( + self, + advertiser_id, + create_coupon_request, + **kwargs + ): + """create_advertiser_coupon # noqa: E501 + + Create a Coupon # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_advertiser_coupon(advertiser_id, create_coupon_request, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + create_coupon_request (CreateCouponRequest): + + 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: + CouponResponse + 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['advertiser_id'] = \ + advertiser_id + kwargs['create_coupon_request'] = \ + create_coupon_request + return self.create_advertiser_coupon_endpoint.call_with_http_info(**kwargs) + + def create_advertiser_creative( + self, + advertiser_id, + creative_write_request, + **kwargs + ): + """create_advertiser_creative # noqa: E501 + + Create a 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.create_advertiser_creative(advertiser_id, creative_write_request, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + creative_write_request (CreativeWriteRequest): + + 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: + CreativeResponse + 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['advertiser_id'] = \ + advertiser_id + kwargs['creative_write_request'] = \ + creative_write_request + return self.create_advertiser_creative_endpoint.call_with_http_info(**kwargs) + + def delete_ad( + self, + id, + **kwargs + ): + """delete_ad # noqa: E501 + + Delete an Ad # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_ad(id, async_req=True) + >>> result = thread.get() + + Args: + id (int): The ad identifier to delete. + + 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: + None + 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.delete_ad_endpoint.call_with_http_info(**kwargs) + + def delete_advertiser_coupon( + self, + advertiser_id, + id, + **kwargs + ): + """delete_advertiser_coupon # noqa: E501 + + Delete a Coupon # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_advertiser_coupon(advertiser_id, id, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + id (str): The Coupon identifier to delete. + + 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: + None + 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['advertiser_id'] = \ + advertiser_id + kwargs['id'] = \ + id + return self.delete_advertiser_coupon_endpoint.call_with_http_info(**kwargs) + + def delete_creative( + self, + id, + **kwargs + ): + """delete_creative # noqa: E501 + + Delete a Creative if there are no ads binded to it # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_creative(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): The creative identifier to delete. + + 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: + None + 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.delete_creative_endpoint.call_with_http_info(**kwargs) + + def edit_advertiser_coupon( + self, + advertiser_id, + id, + update_coupon_request, + **kwargs + ): + """edit_advertiser_coupon # noqa: E501 + + Edit a specific Coupon # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.edit_advertiser_coupon(advertiser_id, id, update_coupon_request, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + id (str): The Coupon identifier to edit. + update_coupon_request (UpdateCouponRequest): + + 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: + CouponResponse + 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['advertiser_id'] = \ + advertiser_id + kwargs['id'] = \ + id + kwargs['update_coupon_request'] = \ + update_coupon_request + return self.edit_advertiser_coupon_endpoint.call_with_http_info(**kwargs) + + def edit_creative( + self, + id, + creative_write_request, + **kwargs + ): + """edit_creative # noqa: E501 + + Edit a specific 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.edit_creative(id, creative_write_request, async_req=True) + >>> result = thread.get() + + Args: + id (str): The creative identifier to edit. + creative_write_request (CreativeWriteRequest): + + 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: + CreativeResponse + 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 + kwargs['creative_write_request'] = \ + creative_write_request + return self.edit_creative_endpoint.call_with_http_info(**kwargs) + + def generate_creative_preview( + self, + id, + **kwargs + ): + """generate_creative_preview # noqa: E501 + + Generate a preview of a specific 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.generate_creative_preview(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): The Creative identifier to preview. + + Keyword Args: + width (int): The width of the Creative to preview.. [optional] + height (int): The height of the Creative to preview.. [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: + str + 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.generate_creative_preview_endpoint.call_with_http_info(**kwargs) + + def get_ad( + self, + id, + **kwargs + ): + """get_ad # noqa: E501 + + Get an Ad from its 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_ad(id, async_req=True) + >>> result = thread.get() + + Args: + id (int): The ad identifier to retrieve. + + 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: + AdResponse + 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.get_ad_endpoint.call_with_http_info(**kwargs) + + def get_advertiser_ads( + self, + advertiser_id, + **kwargs + ): + """get_advertiser_ads # noqa: E501 + + Get the list of self-services Ads for a given advertiser # 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_advertiser_ads(advertiser_id, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + + Keyword Args: + limit (int): The number of ads to be returned. The default is 50.. [optional] + offset (int): The (zero-based) offset into the collection of ads. The default is 0.. [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: + AdListResponse + 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['advertiser_id'] = \ + advertiser_id + return self.get_advertiser_ads_endpoint.call_with_http_info(**kwargs) + + def get_advertiser_coupon( + self, + advertiser_id, + id, + **kwargs + ): + """get_advertiser_coupon # noqa: E501 + + Get a Coupon from its 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_advertiser_coupon(advertiser_id, id, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + id (str): The Coupon identifier to retrieve. + + 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: + CouponResponse + 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['advertiser_id'] = \ + advertiser_id + kwargs['id'] = \ + id + return self.get_advertiser_coupon_endpoint.call_with_http_info(**kwargs) + + def get_advertiser_coupon_preview( + self, + advertiser_id, + id, + **kwargs + ): + """get_advertiser_coupon_preview # noqa: E501 + + Get the preview of a specific Coupon # 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_advertiser_coupon_preview(advertiser_id, id, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + id (str): The Coupon identifier to preview. + + Keyword Args: + width (int): The width of the coupon to preview.. [optional] + height (int): The height of the coupon to preview.. [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: + str + 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['advertiser_id'] = \ + advertiser_id + kwargs['id'] = \ + id + return self.get_advertiser_coupon_preview_endpoint.call_with_http_info(**kwargs) + + def get_advertiser_coupon_supported_sizes( + self, + advertiser_id, + **kwargs + ): + """get_advertiser_coupon_supported_sizes # noqa: E501 + + Get the list of Coupon supported sizes # 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_advertiser_coupon_supported_sizes(advertiser_id, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + + Keyword Args: + ad_set_id (str): The ad set id on which you want to check the Coupon supported sizes.. [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: + CouponSupportedSizesResponse + 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['advertiser_id'] = \ + advertiser_id + return self.get_advertiser_coupon_supported_sizes_endpoint.call_with_http_info(**kwargs) + + def get_advertiser_coupons( + self, + advertiser_id, + **kwargs + ): + """get_advertiser_coupons # noqa: E501 + + Get the list of self-services Coupons for a given advertiser # 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_advertiser_coupons(advertiser_id, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + + Keyword Args: + limit (int): The number of coupons to be returned. The default is 50.. [optional] + offset (int): The (zero-based) offset into the collection of coupons. The default is 0.. [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: + CouponListResponse + 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['advertiser_id'] = \ + advertiser_id + return self.get_advertiser_coupons_endpoint.call_with_http_info(**kwargs) + + def get_advertiser_creatives( + self, + advertiser_id, + **kwargs + ): + """get_advertiser_creatives # noqa: E501 + + Get the list of self-services Creatives for a given advertiser # 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_advertiser_creatives(advertiser_id, async_req=True) + >>> result = thread.get() + + Args: + advertiser_id (str): The advertiser identifier. + + Keyword Args: + limit (int): The number of creatives to be returned. The default is 50.. [optional] + offset (int): The (zero-based) offset into the collection of creatives. The default is 0.. [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: + CreativeListResponse + 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['advertiser_id'] = \ + advertiser_id + return self.get_advertiser_creatives_endpoint.call_with_http_info(**kwargs) + + def get_creative( + self, + id, + **kwargs + ): + """get_creative # noqa: E501 + + Get a Creative from its 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_creative(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): The creative identifier to retrieve. + + 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: + CreativeResponse + 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.get_creative_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/gateway_api.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/gateway_api.py new file mode 100644 index 00000000..0e89dc02 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api/gateway_api.py @@ -0,0 +1,161 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_marketingsolutions_v2024_04.model.application_summary_model_response import ApplicationSummaryModelResponse + + +class GatewayApi(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.get_current_application_endpoint = _Endpoint( + settings={ + 'response_type': (ApplicationSummaryModelResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/marketing-solutions/me', + 'operation_id': 'get_current_application', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_current_application( + self, + **kwargs + ): + """get_current_application # noqa: E501 + + Get information about the currently logged application # 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_current_application(async_req=True) + >>> result = thread.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: + ApplicationSummaryModelResponse + 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) + return self.get_current_application_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api_client.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api_client.py new file mode 100644 index 00000000..a002fe57 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api_client.py @@ -0,0 +1,898 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import json +import atexit +import mimetypes +from multiprocessing.pool import ThreadPool +import io +import os +import re +import typing +from urllib.parse import quote +from urllib3.fields import RequestField + + +from criteo_api_marketingsolutions_v2024_04 import rest +from criteo_api_marketingsolutions_v2024_04.configuration import Configuration +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiTypeError, ApiValueError, ApiException +from criteo_api_marketingsolutions_v2024_04.model_utils import ( + ModelNormal, + ModelSimple, + ModelComposed, + check_allowed_values, + check_validations, + date, + datetime, + deserialize_file, + file_type, + model_to_dict, + none_type, + validate_and_convert_types +) + + +class ApiClient(object): + """Generic API client for OpenAPI client library builds. + + OpenAPI generic API client. This client handles the client- + server communication, and is invariant across implementations. Specifics of + the methods and models for each application are generated from the OpenAPI + templates. + + NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param configuration: .Configuration object for this client + :param header_name: a header to pass when making calls to the API. + :param header_value: a header value to pass when making calls to + the API. + :param cookie: a cookie to include in the header when making calls + to the API + :param pool_threads: The number of threads to use for async requests + to the API. More threads means more concurrent API requests. + """ + + _pool = None + + def __init__(self, configuration=None, header_name=None, header_value=None, + cookie=None, pool_threads=1): + if configuration is None: + configuration = Configuration.get_default_copy() + self.configuration = configuration + self.pool_threads = pool_threads + + self.rest_client = rest.RESTClientObject(configuration) + self.default_headers = {} + if header_name is not None: + self.default_headers[header_name] = header_value + self.cookie = cookie + # Set default User-Agent. + self.user_agent = 'OpenAPI-Generator/2024.04.0.240515/python' + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_value, traceback): + self.close() + + def close(self): + if self._pool: + self._pool.close() + self._pool.join() + self._pool = None + if hasattr(atexit, 'unregister'): + atexit.unregister(self.close) + + @property + def pool(self): + """Create thread pool on first request + avoids instantiating unused threadpool for blocking clients. + """ + if self._pool is None: + atexit.register(self.close) + self._pool = ThreadPool(self.pool_threads) + return self._pool + + @property + def user_agent(self): + """User agent for this API client""" + return self.default_headers['User-Agent'] + + @user_agent.setter + def user_agent(self, value): + self.default_headers['User-Agent'] = value + + def set_default_header(self, header_name, header_value): + self.default_headers[header_name] = header_value + + def __call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None, + _content_type: typing.Optional[str] = None, + _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None + ): + + config = self.configuration + + # header parameters + header_params = header_params or {} + header_params.update(self.default_headers) + if self.cookie: + header_params['Cookie'] = self.cookie + if header_params: + header_params = self.sanitize_for_serialization(header_params) + header_params = dict(self.parameters_to_tuples(header_params, + collection_formats)) + + # path parameters + if path_params: + path_params = self.sanitize_for_serialization(path_params) + path_params = self.parameters_to_tuples(path_params, + collection_formats) + for k, v in path_params: + # specified safe chars, encode everything + resource_path = resource_path.replace( + '{%s}' % k, + quote(str(v), safe=config.safe_chars_for_path_param) + ) + + # query parameters + if query_params: + query_params = self.sanitize_for_serialization(query_params) + query_params = self.parameters_to_tuples(query_params, + collection_formats) + + # post parameters + if post_params or files: + post_params = post_params if post_params else [] + post_params = self.sanitize_for_serialization(post_params) + post_params = self.parameters_to_tuples(post_params, + collection_formats) + post_params.extend(self.files_parameters(files)) + if header_params['Content-Type'].startswith("multipart"): + post_params = self.parameters_to_multipart(post_params, + (dict)) + + # body + if body: + body = self.sanitize_for_serialization(body) + + # auth setting + self.update_params_for_auth(header_params, query_params, + auth_settings, resource_path, method, body, + request_auths=_request_auths) + + # request url + if _host is None: + url = self.configuration.host + resource_path + else: + # use server/host defined in path or operation instead + url = _host + resource_path + + try: + # perform request and return response + response_data = self.request( + method, url, query_params=query_params, headers=header_params, + post_params=post_params, body=body, + _preload_content=_preload_content, + _request_timeout=_request_timeout) + except ApiException as e: + e.body = e.body.decode('utf-8') + raise e + + self.last_response = response_data + + return_data = response_data + + if not _preload_content: + return (return_data) + return return_data + + # deserialize response data + if response_type: + if response_type != (file_type,): + encoding = "utf-8" + content_type = response_data.getheader('content-type') + if content_type is not None: + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s\;]?", content_type) + if match: + encoding = match.group(1) + response_data.data = response_data.data.decode(encoding) + + return_data = self.deserialize( + response_data, + response_type, + _check_type + ) + else: + return_data = None + + if _return_http_data_only: + return (return_data) + else: + return (return_data, response_data.status, + response_data.getheaders()) + + def parameters_to_multipart(self, params, collection_types): + """Get parameters as list of tuples, formatting as json if value is collection_types + + :param params: Parameters as list of two-tuples + :param dict collection_types: Parameter collection types + :return: Parameters as list of tuple or urllib3.fields.RequestField + """ + new_params = [] + if collection_types is None: + collection_types = (dict) + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if isinstance( + v, collection_types): # v is instance of collection_type, formatting as application/json + v = json.dumps(v, ensure_ascii=False).encode("utf-8") + field = RequestField(k, v) + field.make_multipart(content_type="application/json; charset=utf-8") + new_params.append(field) + else: + new_params.append((k, v)) + return new_params + + @classmethod + def sanitize_for_serialization(cls, obj): + """Prepares data for transmission before it is sent with the rest client + If obj is None, return None. + If obj is str, int, long, float, bool, return directly. + If obj is datetime.datetime, datetime.date + convert to string in iso8601 format. + If obj is list, sanitize each element in the list. + If obj is dict, return the dict. + If obj is OpenAPI model, return the properties dict. + If obj is io.IOBase, return the bytes + :param obj: The data to serialize. + :return: The serialized form of data. + """ + if isinstance(obj, (ModelNormal, ModelComposed)): + return { + key: cls.sanitize_for_serialization(val) for key, + val in model_to_dict( + obj, + serialize=True).items()} + elif isinstance(obj, io.IOBase): + return cls.get_file_data_and_close_file(obj) + elif isinstance(obj, (str, int, float, none_type, bool)): + return obj + elif isinstance(obj, (datetime, date)): + return obj.isoformat() + elif isinstance(obj, ModelSimple): + return cls.sanitize_for_serialization(obj.value) + elif isinstance(obj, list): + return [cls.sanitize_for_serialization(item) for item in obj] + elif isinstance(obj, tuple): + return tuple(cls.sanitize_for_serialization(item) for item in obj) + if isinstance(obj, dict): + return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} + raise ApiValueError( + 'Unable to prepare type {} for serialization'.format( + obj.__class__.__name__)) + + def deserialize(self, response, response_type, _check_type): + """Deserializes response into an object. + + :param response: RESTResponse object to be deserialized. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param _check_type: boolean, whether to check the types of the data + received from the server + :type _check_type: bool + + :return: deserialized object. + """ + # handle file downloading + # save response body into a tmp file and return the instance + if response_type == (file_type,): + content_disposition = response.getheader("Content-Disposition") + return deserialize_file(response.data, self.configuration, + content_disposition=content_disposition) + + # fetch data from response object + try: + received_data = json.loads(response.data) + except ValueError: + received_data = response.data + + # store our data under the key of 'received_data' so users have some + # context if they are deserializing a string and the data type is wrong + deserialized_data = validate_and_convert_types( + received_data, + response_type, + ['received_data'], + True, + _check_type, + configuration=self.configuration + ) + return deserialized_data + + def call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + async_req: typing.Optional[bool] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None, + _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None + ): + """Makes the HTTP request (synchronous) and returns deserialized data. + + To make an async_req request, set the async_req parameter. + + :param resource_path: Path to method endpoint. + :param method: Method to call. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param files: key -> field name, value -> a list of open file + objects for `multipart/form-data`. + :type files: dict + :param async_req bool: execute request asynchronously + :type async_req: bool, optional + :param _return_http_data_only: response data without head status code + and headers + :type _return_http_data_only: bool, optional + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :type collection_formats: dict, optional + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :type _preload_content: bool, optional + :param _request_timeout: 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. + :param _check_type: boolean describing if the data back from the server + should have its type checked. + :type _check_type: bool, optional + :param _request_auths: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auths: list, optional + :return: + If async_req parameter is True, + the request will be called asynchronously. + The method will return the request thread. + If parameter async_req is False or missing, + then the method will return the response directly. + """ + if not async_req: + return self.__call_api(resource_path, method, + path_params, query_params, header_params, + body, post_params, files, + response_type, auth_settings, + _return_http_data_only, collection_formats, + _preload_content, _request_timeout, _host, + _check_type, _request_auths=_request_auths) + + return self.pool.apply_async(self.__call_api, (resource_path, + method, path_params, + query_params, + header_params, body, + post_params, files, + response_type, + auth_settings, + _return_http_data_only, + collection_formats, + _preload_content, + _request_timeout, + _host, _check_type, None, _request_auths)) + + def request(self, method, url, query_params=None, headers=None, + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + """Makes the HTTP request using RESTClient.""" + if method == "GET": + return self.rest_client.GET(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "HEAD": + return self.rest_client.HEAD(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "OPTIONS": + return self.rest_client.OPTIONS(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "POST": + return self.rest_client.POST(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PUT": + return self.rest_client.PUT(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PATCH": + return self.rest_client.PATCH(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "DELETE": + return self.rest_client.DELETE(url, + query_params=query_params, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + else: + raise ApiValueError( + "http method must be `GET`, `HEAD`, `OPTIONS`," + " `POST`, `PATCH`, `PUT` or `DELETE`." + ) + + def parameters_to_tuples(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: Parameters as list of tuples, collections formatted + """ + new_params = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, value) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(str(value) for value in v))) + else: + new_params.append((k, v)) + return new_params + + @staticmethod + def get_file_data_and_close_file(file_instance: io.IOBase) -> bytes: + file_data = file_instance.read() + file_instance.close() + return file_data + + def files_parameters(self, + files: typing.Optional[typing.Dict[str, + typing.List[io.IOBase]]] = None): + """Builds form parameters. + + :param files: None or a dict with key=param_name and + value is a list of open file objects + :return: List of tuples of form parameters with file data + """ + if files is None: + return [] + + params = [] + for param_name, file_instances in files.items(): + if file_instances is None: + # if the file field is nullable, skip None values + continue + for file_instance in file_instances: + if file_instance is None: + # if the file field is nullable, skip None values + continue + if file_instance.closed is True: + raise ApiValueError( + "Cannot read a closed file. The passed in file_type " + "for %s must be open." % param_name + ) + filename = os.path.basename(file_instance.name) + filedata = self.get_file_data_and_close_file(file_instance) + mimetype = (mimetypes.guess_type(filename)[0] or + 'application/octet-stream') + params.append( + tuple([param_name, tuple([filename, filedata, mimetype])])) + + return params + + def select_header_accept(self, accepts): + """Returns `Accept` based on an array of accepts provided. + + :param accepts: List of headers. + :return: Accept (e.g. application/json). + """ + if not accepts: + return + + accepts = [x.lower() for x in accepts] + + if 'application/json' in accepts: + return 'application/json' + else: + return ', '.join(accepts) + + def select_header_content_type(self, content_types, method=None, body=None): + """Returns `Content-Type` based on an array of content_types provided. + + :param content_types: List of content-types. + :param method: http method (e.g. POST, PATCH). + :param body: http body to send. + :return: Content-Type (e.g. application/json). + """ + if not content_types: + return None + + content_types = [x.lower() for x in content_types] + + if (method == 'PATCH' and + 'application/json-patch+json' in content_types and + isinstance(body, list)): + return 'application/json-patch+json' + + if 'application/json' in content_types or '*/*' in content_types: + return 'application/json' + else: + return content_types[0] + + def update_params_for_auth(self, headers, queries, auth_settings, + resource_path, method, body, request_auths=None): + """Updates header and query params based on authentication setting. + + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :param auth_settings: Authentication setting identifiers list. + :param resource_path: A string representation of the HTTP request resource path. + :param method: A string representation of the HTTP request method. + :param body: A object representing the body of the HTTP request. + The object type is the return value of _encoder.default(). + :param request_auths: if set, the provided settings will + override the token in the configuration. + """ + if not auth_settings: + return + + if request_auths: + for auth_setting in request_auths: + self._apply_auth_params( + headers, queries, resource_path, method, body, auth_setting) + return + + for auth in auth_settings: + auth_setting = self.configuration.auth_settings().get(auth) + if auth_setting: + self._apply_auth_params( + headers, queries, resource_path, method, body, auth_setting) + + def _apply_auth_params(self, headers, queries, resource_path, method, body, auth_setting): + if auth_setting['in'] == 'cookie': + headers['Cookie'] = auth_setting['key'] + "=" + auth_setting['value'] + elif auth_setting['in'] == 'header': + if auth_setting['type'] != 'http-signature': + headers[auth_setting['key']] = auth_setting['value'] + elif auth_setting['in'] == 'query': + queries.append((auth_setting['key'], auth_setting['value'])) + else: + raise ApiValueError( + 'Authentication token must be in `query` or `header`' + ) + + +class Endpoint(object): + def __init__(self, settings=None, params_map=None, root_map=None, + headers_map=None, api_client=None, callable=None): + """Creates an endpoint + + Args: + settings (dict): see below key value pairs + 'response_type' (tuple/None): response type + 'auth' (list): a list of auth type keys + 'endpoint_path' (str): the endpoint path + 'operation_id' (str): endpoint string identifier + 'http_method' (str): POST/PUT/PATCH/GET etc + 'servers' (list): list of str servers that this endpoint is at + params_map (dict): see below key value pairs + 'all' (list): list of str endpoint parameter names + 'required' (list): list of required parameter names + 'nullable' (list): list of nullable parameter names + 'enum' (list): list of parameters with enum values + 'validation' (list): list of parameters with validations + root_map + 'validations' (dict): the dict mapping endpoint parameter tuple + paths to their validation dictionaries + 'allowed_values' (dict): the dict mapping endpoint parameter + tuple paths to their allowed_values (enum) dictionaries + 'openapi_types' (dict): param_name to openapi type + 'attribute_map' (dict): param_name to camelCase name + 'location_map' (dict): param_name to 'body', 'file', 'form', + 'header', 'path', 'query' + collection_format_map (dict): param_name to `csv` etc. + headers_map (dict): see below key value pairs + 'accept' (list): list of Accept header strings + 'content_type' (list): list of Content-Type header strings + api_client (ApiClient) api client instance + callable (function): the function which is invoked when the + Endpoint is called + """ + self.settings = settings + self.params_map = params_map + self.params_map['all'].extend([ + 'async_req', + '_host_index', + '_preload_content', + '_request_timeout', + '_return_http_data_only', + '_check_input_type', + '_check_return_type', + '_content_type', + '_spec_property_naming', + '_request_auths' + ]) + self.params_map['nullable'].extend(['_request_timeout']) + self.validations = root_map['validations'] + self.allowed_values = root_map['allowed_values'] + self.openapi_types = root_map['openapi_types'] + extra_types = { + 'async_req': (bool,), + '_host_index': (none_type, int), + '_preload_content': (bool,), + '_request_timeout': (none_type, float, (float,), [float], int, (int,), [int]), + '_return_http_data_only': (bool,), + '_check_input_type': (bool,), + '_check_return_type': (bool,), + '_spec_property_naming': (bool,), + '_content_type': (none_type, str), + '_request_auths': (none_type, list) + } + self.openapi_types.update(extra_types) + self.attribute_map = root_map['attribute_map'] + self.location_map = root_map['location_map'] + self.collection_format_map = root_map['collection_format_map'] + self.headers_map = headers_map + self.api_client = api_client + self.callable = callable + + def __validate_inputs(self, kwargs): + for param in self.params_map['enum']: + if param in kwargs: + check_allowed_values( + self.allowed_values, + (param,), + kwargs[param] + ) + + for param in self.params_map['validation']: + if param in kwargs: + check_validations( + self.validations, + (param,), + kwargs[param], + configuration=self.api_client.configuration + ) + + if kwargs['_check_input_type'] is False: + return + + for key, value in kwargs.items(): + fixed_val = validate_and_convert_types( + value, + self.openapi_types[key], + [key], + kwargs['_spec_property_naming'], + kwargs['_check_input_type'], + configuration=self.api_client.configuration + ) + kwargs[key] = fixed_val + + def __gather_params(self, kwargs): + params = { + 'body': None, + 'collection_format': {}, + 'file': {}, + 'form': [], + 'header': {}, + 'path': {}, + 'query': [] + } + + for param_name, param_value in kwargs.items(): + param_location = self.location_map.get(param_name) + if param_location is None: + continue + if param_location: + if param_location == 'body': + params['body'] = param_value + continue + base_name = self.attribute_map[param_name] + if (param_location == 'form' and + self.openapi_types[param_name] == (file_type,)): + params['file'][base_name] = [param_value] + elif (param_location == 'form' and + self.openapi_types[param_name] == ([file_type],)): + # param_value is already a list + params['file'][base_name] = param_value + elif param_location in {'form', 'query'}: + param_value_full = (base_name, param_value) + params[param_location].append(param_value_full) + if param_location not in {'form', 'query'}: + params[param_location][base_name] = param_value + collection_format = self.collection_format_map.get(param_name) + if collection_format: + params['collection_format'][base_name] = collection_format + + return params + + def __call__(self, *args, **kwargs): + """ This method is invoked when endpoints are called + Example: + + api_instance = AdvertiserApi() + api_instance.api_portfolio_get # this is an instance of the class Endpoint + api_instance.api_portfolio_get() # this invokes api_instance.api_portfolio_get.__call__() + which then invokes the callable functions stored in that endpoint at + api_instance.api_portfolio_get.callable or self.callable in this class + + """ + return self.callable(self, *args, **kwargs) + + def call_with_http_info(self, **kwargs): + + try: + index = self.api_client.configuration.server_operation_index.get( + self.settings['operation_id'], self.api_client.configuration.server_index + ) if kwargs['_host_index'] is None else kwargs['_host_index'] + server_variables = self.api_client.configuration.server_operation_variables.get( + self.settings['operation_id'], self.api_client.configuration.server_variables + ) + _host = self.api_client.configuration.get_host_from_settings( + index, variables=server_variables, servers=self.settings['servers'] + ) + except IndexError: + if self.settings['servers']: + raise ApiValueError( + "Invalid host index. Must be 0 <= index < %s" % + len(self.settings['servers']) + ) + _host = None + + for key, value in kwargs.items(): + if key not in self.params_map['all']: + raise ApiTypeError( + "Got an unexpected parameter '%s'" + " to method `%s`" % + (key, self.settings['operation_id']) + ) + # only throw this nullable ApiValueError if _check_input_type + # is False, if _check_input_type==True we catch this case + # in self.__validate_inputs + if (key not in self.params_map['nullable'] and value is None + and kwargs['_check_input_type'] is False): + raise ApiValueError( + "Value may not be None for non-nullable parameter `%s`" + " when calling `%s`" % + (key, self.settings['operation_id']) + ) + + for key in self.params_map['required']: + if key not in kwargs.keys(): + raise ApiValueError( + "Missing the required parameter `%s` when calling " + "`%s`" % (key, self.settings['operation_id']) + ) + + self.__validate_inputs(kwargs) + + params = self.__gather_params(kwargs) + + accept_headers_list = self.headers_map['accept'] + if accept_headers_list: + params['header']['Accept'] = self.api_client.select_header_accept( + accept_headers_list) + + if kwargs.get('_content_type'): + params['header']['Content-Type'] = kwargs['_content_type'] + else: + content_type_headers_list = self.headers_map['content_type'] + if content_type_headers_list: + if params['body'] != "": + content_types_list = self.api_client.select_header_content_type( + content_type_headers_list, self.settings['http_method'], + params['body']) + if content_types_list: + params['header']['Content-Type'] = content_types_list + + return self.api_client.call_api( + self.settings['endpoint_path'], self.settings['http_method'], + params['path'], + params['query'], + params['header'], + body=params['body'], + post_params=params['form'], + files=params['file'], + response_type=self.settings['response_type'], + auth_settings=self.settings['auth'], + async_req=kwargs['async_req'], + _check_type=kwargs['_check_return_type'], + _return_http_data_only=kwargs['_return_http_data_only'], + _preload_content=kwargs['_preload_content'], + _request_timeout=kwargs['_request_timeout'], + _host=_host, + _request_auths=kwargs['_request_auths'], + collection_formats=params['collection_format']) diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api_client_builder.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api_client_builder.py new file mode 100644 index 00000000..13d4b49d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/api_client_builder.py @@ -0,0 +1,37 @@ +from criteo_api_marketingsolutions_v2024_04.configuration import Configuration +from criteo_api_marketingsolutions_v2024_04.criteo_api_client import CriteoApiClient +from criteo_api_marketingsolutions_v2024_04 import flow_constants + +class ApiClientBuilder : + + @staticmethod + def WithClientCredentials(clientId, clientSecret, host=None): + configuration = Configuration(username=clientId, password=clientSecret, host=host) + + return CriteoApiClient(configuration) + + @staticmethod + def WithNoAuthorization(): + + return CriteoApiClient() + + @staticmethod + def WithAuthorizationCode(clientId, clientSecret, authorization_code, redirect_uri, host=None): + configuration = Configuration(username=clientId, password=clientSecret, host=host) + additional_parameters = { + 'flow' : flow_constants.AUTHORIZATION_CODE_FLOW, + 'authorization_code': authorization_code, + 'redirect_uri': redirect_uri + } + + return CriteoApiClient(configuration = configuration, additional_parameters = additional_parameters) + + @staticmethod + def WithRefreshToken(clientId, clientSecret, refreshToken, host=None): + configuration = Configuration(username=clientId, password=clientSecret, host=host) + additional_parameters = { + 'flow' : flow_constants.REFRESH_TOKEN_FLOW, + 'refresh_token': refreshToken + } + + return CriteoApiClient(configuration = configuration, additional_parameters = additional_parameters) \ No newline at end of file diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/apis/__init__.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/apis/__init__.py new file mode 100644 index 00000000..b12be10e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/apis/__init__.py @@ -0,0 +1,22 @@ + +# flake8: noqa + +# Import all APIs into this package. +# If you have many APIs here with many many models used in each API this may +# raise a `RecursionError`. +# In order to avoid this, import only the API that you directly need like: +# +# from criteo_api_marketingsolutions_v2024_04.api.advertiser_api import AdvertiserApi +# +# or import this package, but before doing it, use: +# +# import sys +# sys.setrecursionlimit(n) + +# Import APIs into API package: +from criteo_api_marketingsolutions_v2024_04.api.advertiser_api import AdvertiserApi +from criteo_api_marketingsolutions_v2024_04.api.analytics_api import AnalyticsApi +from criteo_api_marketingsolutions_v2024_04.api.audience_api import AudienceApi +from criteo_api_marketingsolutions_v2024_04.api.campaign_api import CampaignApi +from criteo_api_marketingsolutions_v2024_04.api.creative_api import CreativeApi +from criteo_api_marketingsolutions_v2024_04.api.gateway_api import GatewayApi diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/configuration.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/configuration.py new file mode 100644 index 00000000..54256151 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/configuration.py @@ -0,0 +1,461 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import copy +import logging +import multiprocessing +import sys +import urllib3 + +from http import client as http_client +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiValueError + + +JSON_SCHEMA_VALIDATION_KEYWORDS = { + 'multipleOf', 'maximum', 'exclusiveMaximum', + 'minimum', 'exclusiveMinimum', 'maxLength', + 'minLength', 'pattern', 'maxItems', 'minItems' +} + +class Configuration(object): + """NOTE: This class is auto generated by OpenAPI Generator + + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param host: Base url + :param api_key: Dict to store API key(s). + Each entry in the dict specifies an API key. + The dict key is the name of the security scheme in the OAS specification. + The dict value is the API key secret. + :param api_key_prefix: Dict to store API prefix (e.g. Bearer) + The dict key is the name of the security scheme in the OAS specification. + The dict value is an API key prefix when generating the auth data. + :param username: Username for HTTP basic authentication + :param password: Password for HTTP basic authentication + :param discard_unknown_keys: Boolean value indicating whether to discard + unknown properties. A server may send a response that includes additional + properties that are not known by the client in the following scenarios: + 1. The OpenAPI document is incomplete, i.e. it does not match the server + implementation. + 2. The client was generated using an older version of the OpenAPI document + and the server has been upgraded since then. + If a schema in the OpenAPI document defines the additionalProperties attribute, + then all undeclared properties received by the server are injected into the + additional properties map. In that case, there are undeclared properties, and + nothing to discard. + :param disabled_client_side_validations (string): Comma-separated list of + JSON schema validation keywords to disable JSON schema structural validation + rules. The following keywords may be specified: multipleOf, maximum, + exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, + maxItems, minItems. + By default, the validation is performed for data generated locally by the client + and data received from the server, independent of any validation performed by + the server side. If the input data does not satisfy the JSON schema validation + rules specified in the OpenAPI document, an exception is raised. + If disabled_client_side_validations is set, structural validation is + disabled. This can be useful to troubleshoot data validation problem, such as + when the OpenAPI document validation rules do not match the actual API data + received by the server. + :param server_index: Index to servers configuration. + :param server_variables: Mapping with string values to replace variables in + templated server configuration. The validation of enums is performed for + variables with defined enum values before. + :param server_operation_index: Mapping from operation ID to an index to server + configuration. + :param server_operation_variables: Mapping from operation ID to a mapping with + string values to replace variables in templated server configuration. + The validation of enums is performed for variables with defined enum values before. + :param ssl_ca_cert: str - the path to a file of concatenated CA certificates + in PEM format + + :Example: + """ + + _default = None + + def __init__(self, host=None, + api_key=None, api_key_prefix=None, + access_token=None, + username=None, password=None, + discard_unknown_keys=False, + disabled_client_side_validations="", + server_index=None, server_variables=None, + server_operation_index=None, server_operation_variables=None, + ssl_ca_cert=None, + ): + """Constructor + """ + self._base_path = "https://api.criteo.com" if host is None else host + """Default Base url + """ + self.server_index = 0 if server_index is None and host is None else server_index + self.server_operation_index = server_operation_index or {} + """Default server index + """ + self.server_variables = server_variables or {} + self.server_operation_variables = server_operation_variables or {} + """Default server variables + """ + self.temp_folder_path = None + """Temp file folder for downloading files + """ + # Authentication Settings + self.access_token = access_token + self.api_key = {} + if api_key: + self.api_key = api_key + """dict to store API key(s) + """ + self.api_key_prefix = {} + if api_key_prefix: + self.api_key_prefix = api_key_prefix + """dict to store API prefix (e.g. Bearer) + """ + self.refresh_api_key_hook = None + """function hook to refresh API key if expired + """ + self.username = username + """Username for HTTP basic authentication + """ + self.password = password + """Password for HTTP basic authentication + """ + self.discard_unknown_keys = discard_unknown_keys + self.disabled_client_side_validations = disabled_client_side_validations + self.logger = {} + """Logging Settings + """ + self.logger["package_logger"] = logging.getLogger("criteo_api_marketingsolutions_v2024_04") + self.logger["urllib3_logger"] = logging.getLogger("urllib3") + self.logger_format = '%(asctime)s %(levelname)s %(message)s' + """Log format + """ + self.logger_stream_handler = None + """Log stream handler + """ + self.logger_file_handler = None + """Log file handler + """ + self.logger_file = None + """Debug file location + """ + self.debug = False + """Debug switch + """ + + self.verify_ssl = True + """SSL/TLS verification + Set this to false to skip verifying SSL certificate when calling API + from https server. + """ + self.ssl_ca_cert = ssl_ca_cert + """Set this to customize the certificate file to verify the peer. + """ + self.cert_file = None + """client certificate file + """ + self.key_file = None + """client key file + """ + self.assert_hostname = None + """Set this to True/False to enable/disable SSL hostname verification. + """ + + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + """urllib3 connection pool's maximum number of connections saved + per pool. urllib3 uses 1 connection as default value, but this is + not the best value when you are making a lot of possibly parallel + requests to the same host, which is often the case here. + cpu_count * 5 is used as default value to increase performance. + """ + + self.proxy = None + """Proxy URL + """ + self.no_proxy = None + """bypass proxy for host in the no_proxy list. + """ + self.proxy_headers = None + """Proxy headers + """ + self.safe_chars_for_path_param = '' + """Safe chars for path_param + """ + self.retries = None + """Adding retries to override urllib3 default value 3 + """ + # Enable client side validation + self.client_side_validation = True + + # Options to pass down to the underlying urllib3 socket + self.socket_options = None + + def __deepcopy__(self, memo): + cls = self.__class__ + result = cls.__new__(cls) + memo[id(self)] = result + for k, v in self.__dict__.items(): + if k not in ('logger', 'logger_file_handler'): + setattr(result, k, copy.deepcopy(v, memo)) + # shallow copy of loggers + result.logger = copy.copy(self.logger) + # use setters to configure loggers + result.logger_file = self.logger_file + result.debug = self.debug + return result + + def __setattr__(self, name, value): + object.__setattr__(self, name, value) + if name == 'disabled_client_side_validations': + s = set(filter(None, value.split(','))) + for v in s: + if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: + raise ApiValueError( + "Invalid keyword: '{0}''".format(v)) + self._disabled_client_side_validations = s + + @classmethod + def set_default(cls, default): + """Set default instance of configuration. + + It stores default configuration, which can be + returned by get_default_copy method. + + :param default: object of Configuration + """ + cls._default = copy.deepcopy(default) + + @classmethod + def get_default_copy(cls): + """Return new instance of configuration. + + This method returns newly created, based on default constructor, + object of Configuration class or returns a copy of default + configuration passed by the set_default method. + + :return: The configuration object. + """ + if cls._default is not None: + return copy.deepcopy(cls._default) + return Configuration() + + @property + def logger_file(self): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + return self.__logger_file + + @logger_file.setter + def logger_file(self, value): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + self.__logger_file = value + if self.__logger_file: + # If set logging file, + # then add file handler and remove stream handler. + self.logger_file_handler = logging.FileHandler(self.__logger_file) + self.logger_file_handler.setFormatter(self.logger_formatter) + for _, logger in self.logger.items(): + logger.addHandler(self.logger_file_handler) + + @property + def debug(self): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + return self.__debug + + @debug.setter + def debug(self, value): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + self.__debug = value + if self.__debug: + # if debug status is True, turn on debug logging + for _, logger in self.logger.items(): + logger.setLevel(logging.DEBUG) + # turn on http_client debug + http_client.HTTPConnection.debuglevel = 1 + else: + # if debug status is False, turn off debug logging, + # setting log level to default `logging.WARNING` + for _, logger in self.logger.items(): + logger.setLevel(logging.WARNING) + # turn off http_client debug + http_client.HTTPConnection.debuglevel = 0 + + @property + def logger_format(self): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + return self.__logger_format + + @logger_format.setter + def logger_format(self, value): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + self.__logger_format = value + self.logger_formatter = logging.Formatter(self.__logger_format) + + def get_api_key_with_prefix(self, identifier, alias=None): + """Gets API key (with prefix if set). + + :param identifier: The identifier of apiKey. + :param alias: The alternative identifier of apiKey. + :return: The token for api key authentication. + """ + if self.refresh_api_key_hook is not None: + self.refresh_api_key_hook(self) + key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) + if key: + prefix = self.api_key_prefix.get(identifier) + if prefix: + return "%s %s" % (prefix, key) + else: + return key + + def get_basic_auth_token(self): + """Gets HTTP basic authentication header (string). + + :return: The token for basic HTTP authentication. + """ + username = "" + if self.username is not None: + username = self.username + password = "" + if self.password is not None: + password = self.password + return urllib3.util.make_headers( + basic_auth=username + ':' + password + ).get('authorization') + + def auth_settings(self): + """Gets Auth Settings dict for api client. + + :return: The Auth Settings information dict. + """ + auth = {} + if self.access_token is not None: + auth['oauth'] = { + 'type': 'oauth2', + 'in': 'header', + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } + if self.access_token is not None: + auth['oauth'] = { + 'type': 'oauth2', + 'in': 'header', + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } + return auth + + def to_debug_report(self): + """Gets the essential information for debugging. + + :return: The report for debugging. + """ + return "Python SDK Debug Report:\n"\ + "OS: {env}\n"\ + "Python Version: {pyversion}\n"\ + "Version of the API: 2024-04\n"\ + "SDK Package Version: 2024.04.0.240515".\ + format(env=sys.platform, pyversion=sys.version) + + def get_host_settings(self): + """Gets an array of host settings + + :return: An array of host settings + """ + return [ + { + 'url': "https://api.criteo.com", + 'description': "No description provided", + } + ] + + def get_host_from_settings(self, index, variables=None, servers=None): + """Gets host URL based on the index and variables + :param index: array index of the host settings + :param variables: hash of variable and the corresponding value + :param servers: an array of host settings or None + :return: URL based on host settings + """ + if index is None: + return self._base_path + + variables = {} if variables is None else variables + servers = self.get_host_settings() if servers is None else servers + + try: + server = servers[index] + except IndexError: + raise ValueError( + "Invalid index {0} when selecting the host settings. " + "Must be less than {1}".format(index, len(servers))) + + url = server['url'] + + # go through variables and replace placeholders + for variable_name, variable in server.get('variables', {}).items(): + used_value = variables.get( + variable_name, variable['default_value']) + + if 'enum_values' in variable \ + and used_value not in variable['enum_values']: + raise ValueError( + "The variable `{0}` in the host URL has invalid value " + "{1}. Must be {2}.".format( + variable_name, variables[variable_name], + variable['enum_values'])) + + url = url.replace("{" + variable_name + "}", used_value) + + return url + + @property + def host(self): + """Return generated host.""" + return self.get_host_from_settings(self.server_index, variables=self.server_variables) + + @host.setter + def host(self, value): + """Fix base path.""" + self._base_path = value + self.server_index = None diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_api_client.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_api_client.py new file mode 100644 index 00000000..e9588c46 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_api_client.py @@ -0,0 +1,11 @@ +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient +from criteo_api_marketingsolutions_v2024_04.criteo_rest import CriteoRESTClientObject + +class CriteoApiClient(ApiClient): + def __init__(self, configuration=None, header_name=None, header_value=None, + cookie=None, pool_threads=1, additional_parameters= {}): + super().__init__(configuration=configuration,header_name=header_name, header_value=header_value, cookie=cookie, pool_threads=pool_threads) + self.rest_client = CriteoRESTClientObject(self.configuration, additional_parameters) + + def get_refresh_token(self): + return self.rest_client.get_refresh_token() \ No newline at end of file diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_auth.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_auth.py new file mode 100644 index 00000000..34fbb6ac --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_auth.py @@ -0,0 +1,121 @@ +import json +from datetime import datetime, timedelta +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiException +from criteo_api_marketingsolutions_v2024_04.api_client import ApiClient +from criteo_api_marketingsolutions_v2024_04 import flow_constants + +class Token(object): + + def __init__(self, token_string , expiration_date = None): + self.expiration_date = expiration_date + self.token_string = token_string + + def has_expired(self): + if not self.expiration_date: + return False + return self.expiration_date > datetime.utcnow() + +class BasicAuth(object): + + def __init__(self, token_string): + self.token = Token(token_string) + + def get_token(self, client : ApiClient, headers) -> str: + return self.token + +class RetryingOAuth(object): + + def __init__(self, grant_type, client_id, client_secret): + self.grant_type = grant_type + self.client_id = client_id + self.client_secret = client_secret + self.token = None + self.refreshToken = None + + def get_token(self, client : ApiClient, headers) -> str: + if self.token and not self.token.has_expired(): + self.token = None + if self.grant_type == flow_constants.AUTHORIZATION_CODE_FLOW: + self.grant_type = flow_constants.REFRESH_TOKEN_FLOW + + if self.token is None: + self.refresh_token(client, headers) + + return self.token + + def refresh_token(self, client : ApiClient, headers, parameters_dict= {}): + oauth_url = client.host + '/oauth2/token' + new_headers = {'Accept': 'application/json', + 'Content-Type': 'application/x-www-form-urlencoded', + 'User-Agent': headers['User-Agent']} + params = dict(parameters_dict, **{ + 'client_id': self.client_id, + 'client_secret': self.client_secret, + 'grant_type' : self.grant_type + }) + try: + if self.grant_type == flow_constants.REFRESH_TOKEN_FLOW: + params['refresh_token'] = self.refreshToken + + response = client.request('POST', oauth_url, + headers=new_headers, + query_params=[], + post_params=list(params.items()), + _preload_content=True, + _request_timeout=None, + body=None, + no_auth=True) + data = json.loads(response.data) + self.token = Token('Bearer '+ (data['access_token'] or ''), + RetryingOAuth.compute_expiration_date(data['expires_in'])) + self.refreshToken = data['refresh_token'] + + return self.token + except ApiException as e: + raise self._enrich_exception_message(e, oauth_url) + + def get_refresh_token(self): + return self.refreshToken + + def _enrich_exception_message(self, e, url): + try: + data = json.loads(e.body or {}) + except ValueError: + data = {} + data['token_error'] = "Cannot refresh token by calling '" + url + "'" + e.body = json.dumps(data).encode() + return e + + @staticmethod + def compute_expiration_date(expires_in): + return datetime.utcnow() + timedelta(seconds=int(expires_in) + 15) + +class RetryingClientCredentials(RetryingOAuth): + + def __init__(self, client_id, client_secret): + super().__init__(flow_constants.CLIENT_CREDENTIALS_FLOW, client_id, client_secret) + +class RetryingAuthorizationCode(RetryingOAuth): + def __init__(self, client_id, client_secret, code, redirect_uri): + super().__init__(flow_constants.AUTHORIZATION_CODE_FLOW, client_id, client_secret) + self.authorization_code = code + self.redirect_uri = redirect_uri + + def refresh_token(self, client : ApiClient, headers, parameters_dict= {}): + params = dict(parameters_dict, **{ + 'code' : self.authorization_code, + 'redirect_uri' : self.redirect_uri + }) + return super().refresh_token(client, headers, params) + +class RetryingRefreshToken(RetryingOAuth): + + def __init__(self, client_id, client_secret, refresh_token): + super().__init__(flow_constants.REFRESH_TOKEN_FLOW, client_id, client_secret) + self.refreshToken = refresh_token + + def refresh_token(self, client: ApiClient, headers, parameters_dict = {}): + params = dict(parameters_dict, **{ + 'refresh_token' : self.refreshToken + }) + return super().refresh_token(client, headers,params) diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_rest.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_rest.py new file mode 100644 index 00000000..8286383b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/criteo_rest.py @@ -0,0 +1,75 @@ +from criteo_api_marketingsolutions_v2024_04.rest import RESTClientObject +from criteo_api_marketingsolutions_v2024_04.criteo_auth import * +from criteo_api_marketingsolutions_v2024_04 import flow_constants + + +class CriteoRESTClientObject(RESTClientObject): + + def __init__(self, configuration, additional_parameters = {}, pools_size=4, maxsize=None): + super().__init__(configuration, pools_size, maxsize) + + self.host = configuration.host + client_id = configuration.username + client_secret = configuration.password + + grant_type = additional_parameters.get('flow', 'client_credentials') + if grant_type == flow_constants.AUTHORIZATION_CODE_FLOW : + self.authorization = RetryingAuthorizationCode( + client_id, + client_secret, + additional_parameters.get('authorization_code',''), + additional_parameters.get('redirect_uri','') + ) + elif grant_type == flow_constants.REFRESH_TOKEN_FLOW : + self.authorization = RetryingRefreshToken( + client_id, + client_secret, + additional_parameters.get('refresh_token', '') + ) + else: + self.authorization = RetryingClientCredentials( + client_id, + client_secret + ) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + return self.request(method, url, query_params, headers, body,post_params, _preload_content, _request_timeout, no_auth=False) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None, no_auth=False): + """Perform requests. + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param no_auth: if True, token is not refreshed + and authorization header is not set + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: 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. + """ + + headers = headers or {} + if not no_auth: + token = self.authorization.get_token(self, headers) + headers['Authorization'] = token.token_string + + if 'Content-Type' not in headers: + headers['Content-Type'] = 'application/json' + + return super().request(method, url, query_params, headers, body, post_params, _preload_content, _request_timeout) + + def get_refresh_token(self): + return self.authorization.get_refresh_token() \ No newline at end of file diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/exceptions.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/exceptions.py new file mode 100644 index 00000000..4c259f08 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/exceptions.py @@ -0,0 +1,158 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +class OpenApiException(Exception): + """The base exception class for all OpenAPIExceptions""" + + +class ApiTypeError(OpenApiException, TypeError): + def __init__(self, msg, path_to_item=None, valid_classes=None, + key_type=None): + """ Raises an exception for TypeErrors + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list): a list of keys an indices to get to the + current_item + None if unset + valid_classes (tuple): the primitive classes that current item + should be an instance of + None if unset + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + None if unset + """ + self.path_to_item = path_to_item + self.valid_classes = valid_classes + self.key_type = key_type + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiTypeError, self).__init__(full_msg) + + +class ApiValueError(OpenApiException, ValueError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list) the path to the exception in the + received_data dict. None if unset + """ + + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiValueError, self).__init__(full_msg) + + +class ApiAttributeError(OpenApiException, AttributeError): + def __init__(self, msg, path_to_item=None): + """ + Raised when an attribute reference or assignment fails. + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiAttributeError, self).__init__(full_msg) + + +class ApiKeyError(OpenApiException, KeyError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiKeyError, self).__init__(full_msg) + + +class ApiException(OpenApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + if http_resp: + self.status = http_resp.status + self.reason = http_resp.reason + self.body = http_resp.data + self.headers = http_resp.getheaders() + else: + self.status = status + self.reason = reason + self.body = None + self.headers = None + + def __str__(self): + """Custom error messages for exception""" + error_message = "Status Code: {0}\n"\ + "Reason: {1}\n".format(self.status, self.reason) + if self.headers: + error_message += "HTTP response headers: {0}\n".format( + self.headers) + + if self.body: + error_message += "HTTP response body: {0}\n".format(self.body) + + return error_message + + +class NotFoundException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(NotFoundException, self).__init__(status, reason, http_resp) + + +class UnauthorizedException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(UnauthorizedException, self).__init__(status, reason, http_resp) + + +class ForbiddenException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ForbiddenException, self).__init__(status, reason, http_resp) + + +class ServiceException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ServiceException, self).__init__(status, reason, http_resp) + + +def render_path(path_to_item): + """Returns a string representation of a path""" + result = "" + for pth in path_to_item: + if isinstance(pth, int): + result += "[{0}]".format(pth) + else: + result += "['{0}']".format(pth) + return result diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/flow_constants.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/flow_constants.py similarity index 100% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/flow_constants.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/flow_constants.py diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/__init__.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/__init__.py new file mode 100644 index 00000000..935fda30 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/__init__.py @@ -0,0 +1,5 @@ +# we can not import model classes here because that would create a circular +# reference which would not work in python2 +# do not import all models into this module because that uses a lot of memory and stack frames +# if you need the ability to import all models from one package, import them with +# from criteo_api_marketingsolutions_v2024_04.models import ModelA, ModelB diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad.py new file mode 100644 index 00000000..de113ee3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad.py @@ -0,0 +1,293 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class Ad(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 = { + ('inventory_type',): { + 'None': None, + 'NATIVE': "Native", + 'DISPLAY': "Display", + 'VIDEO': "Video", + }, + } + + 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 + 'description': (str, none_type,), # noqa: E501 + 'creative_id': (str, none_type,), # noqa: E501 + 'ad_set_id': (str, none_type,), # noqa: E501 + 'inventory_type': (str, none_type,), # noqa: E501 + 'start_date': (str, none_type,), # noqa: E501 + 'end_date': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'creative_id': 'creativeId', # noqa: E501 + 'ad_set_id': 'adSetId', # noqa: E501 + 'inventory_type': 'inventoryType', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Ad - 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): The name of the ad. [optional] # noqa: E501 + description (str, none_type): The description of the ad. [optional] # noqa: E501 + creative_id (str, none_type): The id of the Creative binded to this Ad. [optional] # noqa: E501 + ad_set_id (str, none_type): The id of the Ad Set binded to this Ad. [optional] # noqa: E501 + inventory_type (str, none_type): The inventory the Ad belongs to. Possible values are \"Display\" and \"Native\". This is optional since this doesn't make sense for every creative type but will throw an error if not set for a dynamic creative.. [optional] # noqa: E501 + start_date (str, none_type): The date when the ad will be launched String must be in ISO8601 format. [optional] # noqa: E501 + end_date (str, none_type): The date when when we will stop to show this ad. If the end date is not specified (i.e. null) then the ad will go on forever String must be in ISO8601 format. [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 + """Ad - 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): The name of the ad. [optional] # noqa: E501 + description (str, none_type): The description of the ad. [optional] # noqa: E501 + creative_id (str, none_type): The id of the Creative binded to this Ad. [optional] # noqa: E501 + ad_set_id (str, none_type): The id of the Ad Set binded to this Ad. [optional] # noqa: E501 + inventory_type (str, none_type): The inventory the Ad belongs to. Possible values are \"Display\" and \"Native\". This is optional since this doesn't make sense for every creative type but will throw an error if not set for a dynamic creative.. [optional] # noqa: E501 + start_date (str, none_type): The date when the ad will be launched String must be in ISO8601 format. [optional] # noqa: E501 + end_date (str, none_type): The date when when we will stop to show this ad. If the end date is not specified (i.e. null) then the ad will go on forever String must be in ISO8601 format. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_list_response.py new file mode 100644 index 00000000..7dfe3183 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_list_response.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_resource import AdResource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AdResource'] = AdResource + globals()['CommonProblem'] = CommonProblem + + +class AdListResponse(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 = { + ('data',): { + }, + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': ([AdResource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AdListResponse - 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 ([AdResource], 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) + _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 + """AdListResponse - 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 ([AdResource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_resource.py new file mode 100644 index 00000000..2291bb19 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad import Ad + globals()['Ad'] = Ad + + +class AdResource(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 { + 'attributes': (Ad,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdResource - 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,) + attributes (Ad): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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 + """AdResource - 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,) + attributes (Ad): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_response.py new file mode 100644 index 00000000..742e1999 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_response.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_resource import AdResource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AdResource'] = AdResource + globals()['CommonProblem'] = CommonProblem + + +class AdResponse(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 = { + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': (AdResource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AdResponse - 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 (AdResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """AdResponse - 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 (AdResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1.py new file mode 100644 index 00000000..3d8b2806 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AdSetAudienceLinkEntityV1(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 { + 'audience_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'audience_id': 'audienceId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetAudienceLinkEntityV1 - 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,) + audience_id (str, 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 + """AdSetAudienceLinkEntityV1 - 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,) + audience_id (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1_resource.py new file mode 100644 index 00000000..105a96bd --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_entity_v1 import AdSetAudienceLinkEntityV1 + globals()['AdSetAudienceLinkEntityV1'] = AdSetAudienceLinkEntityV1 + + +class AdSetAudienceLinkEntityV1Resource(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 { + 'attributes': (AdSetAudienceLinkEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetAudienceLinkEntityV1Resource - 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,) + attributes (AdSetAudienceLinkEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AdSetAudienceLinkEntityV1Resource - 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,) + attributes (AdSetAudienceLinkEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1_response.py new file mode 100644 index 00000000..63d57018 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_entity_v1_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_entity_v1_resource import AdSetAudienceLinkEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AdSetAudienceLinkEntityV1Resource'] = AdSetAudienceLinkEntityV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AdSetAudienceLinkEntityV1Response(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': (AdSetAudienceLinkEntityV1Resource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AdSetAudienceLinkEntityV1Response - 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 (AdSetAudienceLinkEntityV1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """AdSetAudienceLinkEntityV1Response - 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 (AdSetAudienceLinkEntityV1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_input_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_input_entity_v1.py new file mode 100644 index 00000000..ea151f66 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_audience_link_input_entity_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_entity_v1_resource import AdSetAudienceLinkEntityV1Resource + globals()['AdSetAudienceLinkEntityV1Resource'] = AdSetAudienceLinkEntityV1Resource + + +class AdSetAudienceLinkInputEntityV1(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': (AdSetAudienceLinkEntityV1Resource,), # 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 + """AdSetAudienceLinkInputEntityV1 - 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 (AdSetAudienceLinkEntityV1Resource): [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 + """AdSetAudienceLinkInputEntityV1 - 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 (AdSetAudienceLinkEntityV1Resource): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid.py index 49ee22e6..e62ee2ee 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid_list_response.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid_list_response.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid_list_response.py index 78f1f501..27a41207 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid_list_response.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_category_bid_resource import AdSetCategoryBidResource - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.ad_set_category_bid_resource import AdSetCategoryBidResource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem globals()['AdSetCategoryBidResource'] = AdSetCategoryBidResource globals()['CommonProblem'] = CommonProblem diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid_resource.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid_resource.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid_resource.py index 83cba9e7..17e0c402 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_category_bid_resource.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_category_bid_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_category_bid import AdSetCategoryBid + from criteo_api_marketingsolutions_v2024_04.model.ad_set_category_bid import AdSetCategoryBid globals()['AdSetCategoryBid'] = AdSetCategoryBid diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_delivery_limitations.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_delivery_limitations.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_delivery_limitations.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_delivery_limitations.py index c4e4a175..78e347a2 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_delivery_limitations.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_delivery_limitations.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_delivery_limitations_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_delivery_limitations_v23_q1.py new file mode 100644 index 00000000..3a3f0851 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_delivery_limitations_v23_q1.py @@ -0,0 +1,289 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AdSetDeliveryLimitationsV23Q1(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 = { + ('environments',): { + 'None': None, + 'WEB': "web", + 'INAPP': "inApp", + }, + ('devices',): { + 'None': None, + 'OTHER': "other", + 'DESKTOP': "desktop", + 'MOBILE': "mobile", + 'TABLET': "tablet", + }, + ('operating_systems',): { + 'None': None, + 'ANDROID': "android", + 'IOS': "ios", + 'UNKNOWN': "unknown", + }, + } + + 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 { + 'environments': ([str], none_type,), # noqa: E501 + 'devices': ([str], none_type,), # noqa: E501 + 'operating_systems': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'environments': 'environments', # noqa: E501 + 'devices': 'devices', # noqa: E501 + 'operating_systems': 'operatingSystems', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetDeliveryLimitationsV23Q1 - 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,) + environments ([str], none_type): [optional] # noqa: E501 + devices ([str], none_type): [optional] # noqa: E501 + operating_systems ([str], 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 + """AdSetDeliveryLimitationsV23Q1 - 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,) + environments ([str], none_type): [optional] # noqa: E501 + devices ([str], none_type): [optional] # noqa: E501 + operating_systems ([str], 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier.py index 6b56153e..78518b3a 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier_list_response.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier_list_response.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier_list_response.py index c45dd93e..93435d46 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier_list_response.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_display_multiplier_resource import AdSetDisplayMultiplierResource - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.ad_set_display_multiplier_resource import AdSetDisplayMultiplierResource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem globals()['AdSetDisplayMultiplierResource'] = AdSetDisplayMultiplierResource globals()['CommonProblem'] = CommonProblem diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier_resource.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier_resource.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier_resource.py index 1d34727a..dde41ecf 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_display_multiplier_resource.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_display_multiplier_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_display_multiplier import AdSetDisplayMultiplier + from criteo_api_marketingsolutions_v2024_04.model.ad_set_display_multiplier import AdSetDisplayMultiplier globals()['AdSetDisplayMultiplier'] = AdSetDisplayMultiplier diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_frequency_capping.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_frequency_capping.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_frequency_capping.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_frequency_capping.py index 3ce5657a..f5d15dba 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_frequency_capping.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_frequency_capping.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_frequency_capping_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_frequency_capping_v23_q1.py new file mode 100644 index 00000000..fa4c7bfe --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_frequency_capping_v23_q1.py @@ -0,0 +1,283 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AdSetFrequencyCappingV23Q1(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 = { + ('frequency',): { + 'None': None, + 'HOURLY': "hourly", + 'DAILY': "daily", + 'LIFETIME': "lifetime", + 'ADVANCED': "advanced", + }, + ('mode',): { + 'None': None, + 'MANUAL': "manual", + 'AUTOMATIC': "automatic", + }, + } + + 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 { + 'frequency': (str, none_type,), # noqa: E501 + 'maximum_impressions': (int, none_type,), # noqa: E501 + 'mode': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'frequency': 'frequency', # noqa: E501 + 'maximum_impressions': 'maximumImpressions', # noqa: E501 + 'mode': 'mode', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetFrequencyCappingV23Q1 - 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,) + frequency (str, none_type): [optional] # noqa: E501 + maximum_impressions (int, none_type): [optional] # noqa: E501 + mode (str, 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 + """AdSetFrequencyCappingV23Q1 - 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,) + frequency (str, none_type): [optional] # noqa: E501 + maximum_impressions (int, none_type): [optional] # noqa: E501 + mode (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_geo_location.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_geo_location.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_geo_location.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_geo_location.py index 5286ab9f..cce57217 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_geo_location.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_geo_location.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_ad_set_targeting_rule import NillableAdSetTargetingRule + from criteo_api_marketingsolutions_v2024_04.model.nillable_ad_set_targeting_rule import NillableAdSetTargetingRule globals()['NillableAdSetTargetingRule'] = NillableAdSetTargetingRule diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_geo_location_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_geo_location_v23_q1.py new file mode 100644 index 00000000..73e790f6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_geo_location_v23_q1.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.nillable_ad_set_targeting_rule_v23_q1 import NillableAdSetTargetingRuleV23Q1 + globals()['NillableAdSetTargetingRuleV23Q1'] = NillableAdSetTargetingRuleV23Q1 + + +class AdSetGeoLocationV23Q1(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 { + 'countries': (NillableAdSetTargetingRuleV23Q1,), # noqa: E501 + 'subdivisions': (NillableAdSetTargetingRuleV23Q1,), # noqa: E501 + 'zip_codes': (NillableAdSetTargetingRuleV23Q1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'countries': 'countries', # noqa: E501 + 'subdivisions': 'subdivisions', # noqa: E501 + 'zip_codes': 'zipCodes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetGeoLocationV23Q1 - 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,) + countries (NillableAdSetTargetingRuleV23Q1): [optional] # noqa: E501 + subdivisions (NillableAdSetTargetingRuleV23Q1): [optional] # noqa: E501 + zip_codes (NillableAdSetTargetingRuleV23Q1): [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 + """AdSetGeoLocationV23Q1 - 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,) + countries (NillableAdSetTargetingRuleV23Q1): [optional] # noqa: E501 + subdivisions (NillableAdSetTargetingRuleV23Q1): [optional] # noqa: E501 + zip_codes (NillableAdSetTargetingRuleV23Q1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_search_filter_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_search_filter_v23_q1.py new file mode 100644 index 00000000..4bb82125 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_search_filter_v23_q1.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AdSetSearchFilterV23Q1(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 { + 'ad_set_ids': ([str], none_type,), # noqa: E501 + 'advertiser_ids': ([str], none_type,), # noqa: E501 + 'campaign_ids': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'ad_set_ids': 'adSetIds', # noqa: E501 + 'advertiser_ids': 'advertiserIds', # noqa: E501 + 'campaign_ids': 'campaignIds', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetSearchFilterV23Q1 - 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,) + ad_set_ids ([str], none_type): [optional] # noqa: E501 + advertiser_ids ([str], none_type): [optional] # noqa: E501 + campaign_ids ([str], 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 + """AdSetSearchFilterV23Q1 - 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,) + ad_set_ids ([str], none_type): [optional] # noqa: E501 + advertiser_ids ([str], none_type): [optional] # noqa: E501 + campaign_ids ([str], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_search_request_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_search_request_v23_q1.py new file mode 100644 index 00000000..e9f2c100 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_search_request_v23_q1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_search_filter_v23_q1 import AdSetSearchFilterV23Q1 + globals()['AdSetSearchFilterV23Q1'] = AdSetSearchFilterV23Q1 + + +class AdSetSearchRequestV23Q1(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 { + 'filters': (AdSetSearchFilterV23Q1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filters': 'filters', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetSearchRequestV23Q1 - 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,) + filters (AdSetSearchFilterV23Q1): [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 + """AdSetSearchRequestV23Q1 - 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,) + filters (AdSetSearchFilterV23Q1): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_targeting.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_targeting.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting.py index b95c0b5a..28e06609 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_targeting.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_delivery_limitations import AdSetDeliveryLimitations - from criteo_api_marketingsolutions_v2023_01.model.ad_set_frequency_capping import AdSetFrequencyCapping - from criteo_api_marketingsolutions_v2023_01.model.ad_set_geo_location import AdSetGeoLocation + from criteo_api_marketingsolutions_v2024_04.model.ad_set_delivery_limitations import AdSetDeliveryLimitations + from criteo_api_marketingsolutions_v2024_04.model.ad_set_frequency_capping import AdSetFrequencyCapping + from criteo_api_marketingsolutions_v2024_04.model.ad_set_geo_location import AdSetGeoLocation globals()['AdSetDeliveryLimitations'] = AdSetDeliveryLimitations globals()['AdSetFrequencyCapping'] = AdSetFrequencyCapping globals()['AdSetGeoLocation'] = AdSetGeoLocation diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_targeting_rule.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_rule.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_targeting_rule.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_rule.py index 9881d699..cc8f9121 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/ad_set_targeting_rule.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_rule.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_rule_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_rule_v23_q1.py new file mode 100644 index 00000000..15c73cd6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_rule_v23_q1.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AdSetTargetingRuleV23Q1(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 = { + ('operand',): { + 'None': None, + 'UNDEFINED': "undefined", + 'IN': "in", + 'NOTIN': "notIn", + }, + } + + 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 { + 'operand': (str, none_type,), # noqa: E501 + 'values': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'operand': 'operand', # noqa: E501 + 'values': 'values', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetTargetingRuleV23Q1 - 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,) + operand (str, none_type): [optional] # noqa: E501 + values ([str], 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 + """AdSetTargetingRuleV23Q1 - 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,) + operand (str, none_type): [optional] # noqa: E501 + values ([str], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_v23_q1.py new file mode 100644 index 00000000..a77c1b1a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_set_targeting_v23_q1.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_delivery_limitations_v23_q1 import AdSetDeliveryLimitationsV23Q1 + from criteo_api_marketingsolutions_v2024_04.model.ad_set_frequency_capping_v23_q1 import AdSetFrequencyCappingV23Q1 + from criteo_api_marketingsolutions_v2024_04.model.ad_set_geo_location_v23_q1 import AdSetGeoLocationV23Q1 + globals()['AdSetDeliveryLimitationsV23Q1'] = AdSetDeliveryLimitationsV23Q1 + globals()['AdSetFrequencyCappingV23Q1'] = AdSetFrequencyCappingV23Q1 + globals()['AdSetGeoLocationV23Q1'] = AdSetGeoLocationV23Q1 + + +class AdSetTargetingV23Q1(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 { + 'delivery_limitations': (AdSetDeliveryLimitationsV23Q1,), # noqa: E501 + 'geo_location': (AdSetGeoLocationV23Q1,), # noqa: E501 + 'frequency_capping': (AdSetFrequencyCappingV23Q1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'delivery_limitations': 'deliveryLimitations', # noqa: E501 + 'geo_location': 'geoLocation', # noqa: E501 + 'frequency_capping': 'frequencyCapping', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdSetTargetingV23Q1 - 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,) + delivery_limitations (AdSetDeliveryLimitationsV23Q1): [optional] # noqa: E501 + geo_location (AdSetGeoLocationV23Q1): [optional] # noqa: E501 + frequency_capping (AdSetFrequencyCappingV23Q1): [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 + """AdSetTargetingV23Q1 - 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,) + delivery_limitations (AdSetDeliveryLimitationsV23Q1): [optional] # noqa: E501 + geo_location (AdSetGeoLocationV23Q1): [optional] # noqa: E501 + frequency_capping (AdSetFrequencyCappingV23Q1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write.py new file mode 100644 index 00000000..d1267eff --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write.py @@ -0,0 +1,304 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AdWrite(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 = { + ('inventory_type',): { + 'None': None, + 'DISPLAY': "Display", + 'NATIVE': "Native", + }, + } + + 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,), # noqa: E501 + 'creative_id': (str,), # noqa: E501 + 'ad_set_id': (str,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'inventory_type': (str, none_type,), # noqa: E501 + 'end_date': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'creative_id': 'creativeId', # noqa: E501 + 'ad_set_id': 'adSetId', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'description': 'description', # noqa: E501 + 'inventory_type': 'inventoryType', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, creative_id, ad_set_id, start_date, *args, **kwargs): # noqa: E501 + """AdWrite - a model defined in OpenAPI + + Args: + name (str): The name of the ad + creative_id (str): The id of the Creative bound to this Ad + ad_set_id (str): The id of the Ad Set bound to this Ad + start_date (str): The date when the ad will be launched String must be in ISO8601 format + + 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,) + description (str, none_type): The description of the ad. [optional] # noqa: E501 + inventory_type (str, none_type): The inventory the Ad to be created or updated belongs to. Possible values are \"Display\" and \"Native\". This is optional since this doesn't make sense for every creative type but will throw an error if not set for a dynamic creative.. [optional] # noqa: E501 + end_date (str, none_type): The date when when we will stop to show this ad. If the end date is not specified (i.e. null) then the ad will go on forever String must be in ISO8601 format. [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.name = name + self.creative_id = creative_id + self.ad_set_id = ad_set_id + self.start_date = start_date + 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, name, creative_id, ad_set_id, start_date, *args, **kwargs): # noqa: E501 + """AdWrite - a model defined in OpenAPI + + Args: + name (str): The name of the ad + creative_id (str): The id of the Creative bound to this Ad + ad_set_id (str): The id of the Ad Set bound to this Ad + start_date (str): The date when the ad will be launched String must be in ISO8601 format + + 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,) + description (str, none_type): The description of the ad. [optional] # noqa: E501 + inventory_type (str, none_type): The inventory the Ad to be created or updated belongs to. Possible values are \"Display\" and \"Native\". This is optional since this doesn't make sense for every creative type but will throw an error if not set for a dynamic creative.. [optional] # noqa: E501 + end_date (str, none_type): The date when when we will stop to show this ad. If the end date is not specified (i.e. null) then the ad will go on forever String must be in ISO8601 format. [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.name = name + self.creative_id = creative_id + self.ad_set_id = ad_set_id + self.start_date = start_date + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write_request.py new file mode 100644 index 00000000..005835e3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_write_resource import AdWriteResource + globals()['AdWriteResource'] = AdWriteResource + + +class AdWriteRequest(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': (AdWriteResource,), # 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 + """AdWriteRequest - 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 (AdWriteResource): [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 + """AdWriteRequest - 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 (AdWriteResource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write_resource.py new file mode 100644 index 00000000..41502785 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/ad_write_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_write import AdWrite + globals()['AdWrite'] = AdWrite + + +class AdWriteResource(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 { + 'attributes': (AdWrite,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AdWriteResource - 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,) + attributes (AdWrite): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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 + """AdWriteResource - 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,) + attributes (AdWrite): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_attributes.py new file mode 100644 index 00000000..bfa25ec2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_attributes.py @@ -0,0 +1,361 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.adaptive_colors import AdaptiveColors + from criteo_api_marketingsolutions_v2024_04.model.image_set import ImageSet + from criteo_api_marketingsolutions_v2024_04.model.image_shape import ImageShape + from criteo_api_marketingsolutions_v2024_04.model.video_detail import VideoDetail + globals()['AdaptiveColors'] = AdaptiveColors + globals()['ImageSet'] = ImageSet + globals()['ImageShape'] = ImageShape + globals()['VideoDetail'] = VideoDetail + + +class AdaptiveAttributes(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 = { + ('layouts',): { + 'EDITORIAL': "Editorial", + 'MONTAGE': "Montage", + 'INBANNERVIDEO': "InBannerVideo", + }, + ('image_display',): { + 'None': None, + 'SHOWFULLIMAGE': "ShowFullImage", + 'ZOOMONIMAGE': "ZoomOnImage", + }, + } + + validations = { + ('layouts',): { + }, + ('logos',): { + }, + ('calls_to_action',): { + }, + ('image_sets',): { + }, + ('videos',): { + }, + } + + @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 { + 'layouts': ([str],), # noqa: E501 + 'logos': ([ImageShape],), # noqa: E501 + 'headline_text': (str,), # noqa: E501 + 'headline_font': (str,), # noqa: E501 + 'description_text': (str,), # noqa: E501 + 'description_font': (str,), # noqa: E501 + 'calls_to_action': ([str],), # noqa: E501 + 'colors': (AdaptiveColors,), # noqa: E501 + 'landing_page_url': (str,), # noqa: E501 + 'image_sets': ([ImageSet], none_type,), # noqa: E501 + 'image_display': (str, none_type,), # noqa: E501 + 'videos': ([VideoDetail], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'layouts': 'layouts', # noqa: E501 + 'logos': 'logos', # noqa: E501 + 'headline_text': 'headlineText', # noqa: E501 + 'headline_font': 'headlineFont', # noqa: E501 + 'description_text': 'descriptionText', # noqa: E501 + 'description_font': 'descriptionFont', # noqa: E501 + 'calls_to_action': 'callsToAction', # noqa: E501 + 'colors': 'colors', # noqa: E501 + 'landing_page_url': 'landingPageUrl', # noqa: E501 + 'image_sets': 'imageSets', # noqa: E501 + 'image_display': 'imageDisplay', # noqa: E501 + 'videos': 'videos', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, layouts, logos, headline_text, headline_font, description_text, description_font, calls_to_action, colors, landing_page_url, *args, **kwargs): # noqa: E501 + """AdaptiveAttributes - a model defined in OpenAPI + + Args: + layouts ([str]): The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\". + logos ([ImageShape]): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net + headline_text (str): The headline text of the banner + headline_font (str): Font of the headline Valid supported font like \"Arial\" + description_text (str): The description text of the banner + description_font (str): Font of the description Valid supported font like \"Arial\" + calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. + colors (AdaptiveColors): + landing_page_url (str): Web redirection of the landing page url + + 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,) + image_sets ([ImageSet], none_type): Multiple image sets, each image set consists of multiple images and a headline text.. [optional] # noqa: E501 + image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping.. [optional] # noqa: E501 + videos ([VideoDetail], none_type): Multiple videos potentially in different shapes.. [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.layouts = layouts + self.logos = logos + self.headline_text = headline_text + self.headline_font = headline_font + self.description_text = description_text + self.description_font = description_font + self.calls_to_action = calls_to_action + self.colors = colors + self.landing_page_url = landing_page_url + 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, layouts, logos, headline_text, headline_font, description_text, description_font, calls_to_action, colors, landing_page_url, *args, **kwargs): # noqa: E501 + """AdaptiveAttributes - a model defined in OpenAPI + + Args: + layouts ([str]): The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\". + logos ([ImageShape]): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net + headline_text (str): The headline text of the banner + headline_font (str): Font of the headline Valid supported font like \"Arial\" + description_text (str): The description text of the banner + description_font (str): Font of the description Valid supported font like \"Arial\" + calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. + colors (AdaptiveColors): + landing_page_url (str): Web redirection of the landing page url + + 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,) + image_sets ([ImageSet], none_type): Multiple image sets, each image set consists of multiple images and a headline text.. [optional] # noqa: E501 + image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping.. [optional] # noqa: E501 + videos ([VideoDetail], none_type): Multiple videos potentially in different shapes.. [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.layouts = layouts + self.logos = logos + self.headline_text = headline_text + self.headline_font = headline_font + self.description_text = description_text + self.description_font = description_font + self.calls_to_action = calls_to_action + self.colors = colors + self.landing_page_url = landing_page_url + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_colors.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_colors.py new file mode 100644 index 00000000..aaf92a4c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_colors.py @@ -0,0 +1,299 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AdaptiveColors(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 { + 'logo_area_and_title_color': (str,), # noqa: E501 + 'background_color': (str,), # noqa: E501 + 'text1_color': (str,), # noqa: E501 + 'text2_color': (str,), # noqa: E501 + 'cta_background_color': (str,), # noqa: E501 + 'cta_text_color': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'logo_area_and_title_color': 'logoAreaAndTitleColor', # noqa: E501 + 'background_color': 'backgroundColor', # noqa: E501 + 'text1_color': 'text1Color', # noqa: E501 + 'text2_color': 'text2Color', # noqa: E501 + 'cta_background_color': 'ctaBackgroundColor', # noqa: E501 + 'cta_text_color': 'ctaTextColor', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, logo_area_and_title_color, background_color, text1_color, text2_color, cta_background_color, cta_text_color, *args, **kwargs): # noqa: E501 + """AdaptiveColors - a model defined in OpenAPI + + Args: + logo_area_and_title_color (str): Color of the creative's logo area. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). + background_color (str): Color of the creative's background. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") + text1_color (str): Color of the headline and the description texts. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") + text2_color (str): Color of the image set's headline text. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") + cta_background_color (str): Color of the background of the CTA. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). + cta_text_color (str): Color of the text of the CTA. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). + + 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.logo_area_and_title_color = logo_area_and_title_color + self.background_color = background_color + self.text1_color = text1_color + self.text2_color = text2_color + self.cta_background_color = cta_background_color + self.cta_text_color = cta_text_color + 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, logo_area_and_title_color, background_color, text1_color, text2_color, cta_background_color, cta_text_color, *args, **kwargs): # noqa: E501 + """AdaptiveColors - a model defined in OpenAPI + + Args: + logo_area_and_title_color (str): Color of the creative's logo area. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). + background_color (str): Color of the creative's background. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") + text1_color (str): Color of the headline and the description texts. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") + text2_color (str): Color of the image set's headline text. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") + cta_background_color (str): Color of the background of the CTA. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). + cta_text_color (str): Color of the text of the CTA. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). + + 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.logo_area_and_title_color = logo_area_and_title_color + self.background_color = background_color + self.text1_color = text1_color + self.text2_color = text2_color + self.cta_background_color = cta_background_color + self.cta_text_color = cta_text_color + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_write_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_write_attributes.py new file mode 100644 index 00000000..4c77ed77 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/adaptive_write_attributes.py @@ -0,0 +1,357 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.adaptive_colors import AdaptiveColors + from criteo_api_marketingsolutions_v2024_04.model.image_set_base64 import ImageSetBase64 + globals()['AdaptiveColors'] = AdaptiveColors + globals()['ImageSetBase64'] = ImageSetBase64 + + +class AdaptiveWriteAttributes(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 = { + ('layouts',): { + 'EDITORIAL': "Editorial", + 'MONTAGE': "Montage", + 'INBANNERVIDEO': "InBannerVideo", + }, + ('image_display',): { + 'None': None, + 'SHOWFULLIMAGE': "ShowFullImage", + 'ZOOMONIMAGE': "ZoomOnImage", + }, + } + + validations = { + ('layouts',): { + 'min_items': 1, + }, + ('calls_to_action',): { + 'min_items': 1, + }, + ('image_sets_base64',): { + }, + ('video_base64_strings',): { + }, + } + + @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 { + 'layouts': ([str],), # noqa: E501 + 'logo_base64_string': (str,), # noqa: E501 + 'headline_text': (str,), # noqa: E501 + 'headline_font': (str,), # noqa: E501 + 'description_text': (str,), # noqa: E501 + 'description_font': (str,), # noqa: E501 + 'calls_to_action': ([str],), # noqa: E501 + 'colors': (AdaptiveColors,), # noqa: E501 + 'landing_page_url': (str,), # noqa: E501 + 'image_sets_base64': ([ImageSetBase64], none_type,), # noqa: E501 + 'image_display': (str, none_type,), # noqa: E501 + 'video_base64_strings': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'layouts': 'layouts', # noqa: E501 + 'logo_base64_string': 'logoBase64String', # noqa: E501 + 'headline_text': 'headlineText', # noqa: E501 + 'headline_font': 'headlineFont', # noqa: E501 + 'description_text': 'descriptionText', # noqa: E501 + 'description_font': 'descriptionFont', # noqa: E501 + 'calls_to_action': 'callsToAction', # noqa: E501 + 'colors': 'colors', # noqa: E501 + 'landing_page_url': 'landingPageUrl', # noqa: E501 + 'image_sets_base64': 'imageSetsBase64', # noqa: E501 + 'image_display': 'imageDisplay', # noqa: E501 + 'video_base64_strings': 'videoBase64Strings', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, layouts, logo_base64_string, headline_text, headline_font, description_text, description_font, calls_to_action, colors, landing_page_url, *args, **kwargs): # noqa: E501 + """AdaptiveWriteAttributes - a model defined in OpenAPI + + Args: + layouts ([str]): The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\". + logo_base64_string (str): Logo image as a base-64 encoded string + headline_text (str): The headline text of the banner + headline_font (str): Font of the headline Valid supported font like \"Arial\" + description_text (str): The description text of the banner + description_font (str): Font of the description Valid supported font like \"Arial\" + calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. + colors (AdaptiveColors): + landing_page_url (str): Web redirection of the landing page url. + + 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,) + image_sets_base64 ([ImageSetBase64], none_type): Multiple image sets, each image set consists of multiple images as a base-64 encoded string and a headline text.. [optional] # noqa: E501 + image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping.. [optional] # noqa: E501 + video_base64_strings ([str], none_type): Multiple videos potentially in different shapes, each video is a base-64 encoded string.. [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.layouts = layouts + self.logo_base64_string = logo_base64_string + self.headline_text = headline_text + self.headline_font = headline_font + self.description_text = description_text + self.description_font = description_font + self.calls_to_action = calls_to_action + self.colors = colors + self.landing_page_url = landing_page_url + 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, layouts, logo_base64_string, headline_text, headline_font, description_text, description_font, calls_to_action, colors, landing_page_url, *args, **kwargs): # noqa: E501 + """AdaptiveWriteAttributes - a model defined in OpenAPI + + Args: + layouts ([str]): The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\". + logo_base64_string (str): Logo image as a base-64 encoded string + headline_text (str): The headline text of the banner + headline_font (str): Font of the headline Valid supported font like \"Arial\" + description_text (str): The description text of the banner + description_font (str): Font of the description Valid supported font like \"Arial\" + calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. + colors (AdaptiveColors): + landing_page_url (str): Web redirection of the landing page url. + + 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,) + image_sets_base64 ([ImageSetBase64], none_type): Multiple image sets, each image set consists of multiple images as a base-64 encoded string and a headline text.. [optional] # noqa: E501 + image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping.. [optional] # noqa: E501 + video_base64_strings ([str], none_type): Multiple videos potentially in different shapes, each video is a base-64 encoded string.. [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.layouts = layouts + self.logo_base64_string = logo_base64_string + self.headline_text = headline_text + self.headline_font = headline_font + self.description_text = description_text + self.description_font = description_font + self.calls_to_action = calls_to_action + self.colors = colors + self.landing_page_url = landing_page_url + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/algebra_node_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/algebra_node_v1.py new file mode 100644 index 00000000..962d15e8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/algebra_node_v1.py @@ -0,0 +1,275 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AlgebraNodeV1(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 { + '_and': ([AlgebraNodeV1], none_type,), # noqa: E501 + '_or': ([AlgebraNodeV1], none_type,), # noqa: E501 + '_not': (AlgebraNodeV1,), # noqa: E501 + 'audience_segment_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '_and': 'and', # noqa: E501 + '_or': 'or', # noqa: E501 + '_not': 'not', # noqa: E501 + 'audience_segment_id': 'audienceSegmentId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AlgebraNodeV1 - 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,) + _and ([AlgebraNodeV1], none_type): [optional] # noqa: E501 + _or ([AlgebraNodeV1], none_type): [optional] # noqa: E501 + _not (AlgebraNodeV1): [optional] # noqa: E501 + audience_segment_id (str, 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 + """AlgebraNodeV1 - 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,) + _and ([AlgebraNodeV1], none_type): [optional] # noqa: E501 + _or ([AlgebraNodeV1], none_type): [optional] # noqa: E501 + _not (AlgebraNodeV1): [optional] # noqa: E501 + audience_segment_id (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model.py new file mode 100644 index 00000000..a5d90879 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model.py @@ -0,0 +1,279 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ApplicationSummaryModel(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 { + 'application_id': (int, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'organization_id': (int, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'criteo_service': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'application_id': 'applicationId', # noqa: E501 + 'name': 'name', # noqa: E501 + 'organization_id': 'organizationId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'criteo_service': 'criteoService', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApplicationSummaryModel - 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,) + application_id (int, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + organization_id (int, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + criteo_service (str, 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 + """ApplicationSummaryModel - 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,) + application_id (int, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + organization_id (int, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + criteo_service (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model_resource.py new file mode 100644 index 00000000..7bf547f8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.application_summary_model import ApplicationSummaryModel + globals()['ApplicationSummaryModel'] = ApplicationSummaryModel + + +class ApplicationSummaryModelResource(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': (ApplicationSummaryModel,), # 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 + """ApplicationSummaryModelResource - 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 (ApplicationSummaryModel): [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 + """ApplicationSummaryModelResource - 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 (ApplicationSummaryModel): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model_response.py new file mode 100644 index 00000000..3feaf2f7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/application_summary_model_response.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.application_summary_model_resource import ApplicationSummaryModelResource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['ApplicationSummaryModelResource'] = ApplicationSummaryModelResource + globals()['CommonProblem'] = CommonProblem + + +class ApplicationSummaryModelResponse(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 = { + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': (ApplicationSummaryModelResource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """ApplicationSummaryModelResponse - 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 (ApplicationSummaryModelResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """ApplicationSummaryModelResponse - 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 (ApplicationSummaryModelResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_create_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_create_input_v1.py new file mode 100644 index 00000000..81850928 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_create_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_create_entity_v1_resource import AudienceCreateEntityV1Resource + globals()['AudienceCreateEntityV1Resource'] = AudienceCreateEntityV1Resource + + +class AudienceBulkCreateInputV1(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': ([AudienceCreateEntityV1Resource], 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 + """AudienceBulkCreateInputV1 - 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 ([AudienceCreateEntityV1Resource], 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 + """AudienceBulkCreateInputV1 - 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 ([AudienceCreateEntityV1Resource], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_delete_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_delete_input_v1.py new file mode 100644 index 00000000..760338c5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_delete_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_delete_entity_v1_resource import AudienceDeleteEntityV1Resource + globals()['AudienceDeleteEntityV1Resource'] = AudienceDeleteEntityV1Resource + + +class AudienceBulkDeleteInputV1(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': ([AudienceDeleteEntityV1Resource], 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 + """AudienceBulkDeleteInputV1 - 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 ([AudienceDeleteEntityV1Resource], 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 + """AudienceBulkDeleteInputV1 - 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 ([AudienceDeleteEntityV1Resource], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_update_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_update_input_v1.py new file mode 100644 index 00000000..bd0a41c1 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_bulk_update_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_update_entity_v1_resource import AudienceUpdateEntityV1Resource + globals()['AudienceUpdateEntityV1Resource'] = AudienceUpdateEntityV1Resource + + +class AudienceBulkUpdateInputV1(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': ([AudienceUpdateEntityV1Resource], 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 + """AudienceBulkUpdateInputV1 - 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 ([AudienceUpdateEntityV1Resource], 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 + """AudienceBulkUpdateInputV1 - 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 ([AudienceUpdateEntityV1Resource], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_compute_size_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_compute_size_entity_v1_resource.py new file mode 100644 index 00000000..952ceb01 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_compute_size_entity_v1_resource.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceComputeSizeEntityV1Resource(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 { + 'attributes': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceComputeSizeEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audience of people of interest for a marketer.. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceComputeSizeEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audience of people of interest for a marketer.. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_compute_sizes_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_compute_sizes_input_v1.py new file mode 100644 index 00000000..0abc3757 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_compute_sizes_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_compute_size_entity_v1_resource import AudienceComputeSizeEntityV1Resource + globals()['AudienceComputeSizeEntityV1Resource'] = AudienceComputeSizeEntityV1Resource + + +class AudienceComputeSizesInputV1(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': ([AudienceComputeSizeEntityV1Resource], 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 + """AudienceComputeSizesInputV1 - 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 ([AudienceComputeSizeEntityV1Resource], 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 + """AudienceComputeSizesInputV1 - 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 ([AudienceComputeSizeEntityV1Resource], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_create_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_create_entity_v1.py new file mode 100644 index 00000000..296cc094 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_create_entity_v1.py @@ -0,0 +1,291 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.algebra_node_v1 import AlgebraNodeV1 + globals()['AlgebraNodeV1'] = AlgebraNodeV1 + + +class AudienceCreateEntityV1(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 { + 'name': (str,), # noqa: E501 + 'advertiser_id': (str,), # noqa: E501 + 'algebra': (AlgebraNodeV1,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'algebra': 'algebra', # noqa: E501 + 'description': 'description', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, advertiser_id, algebra, *args, **kwargs): # noqa: E501 + """AudienceCreateEntityV1 - a model defined in OpenAPI + + Args: + name (str): Name of the audience + advertiser_id (str): Advertiser associated to the audience + algebra (AlgebraNodeV1): + + 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,) + description (str, none_type): Description of the audience. [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.name = name + self.advertiser_id = advertiser_id + self.algebra = algebra + 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, name, advertiser_id, algebra, *args, **kwargs): # noqa: E501 + """AudienceCreateEntityV1 - a model defined in OpenAPI + + Args: + name (str): Name of the audience + advertiser_id (str): Advertiser associated to the audience + algebra (AlgebraNodeV1): + + 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,) + description (str, none_type): Description of the audience. [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.name = name + self.advertiser_id = advertiser_id + self.algebra = algebra + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_create_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_create_entity_v1_resource.py new file mode 100644 index 00000000..d3b5ccd5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_create_entity_v1_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_create_entity_v1 import AudienceCreateEntityV1 + globals()['AudienceCreateEntityV1'] = AudienceCreateEntityV1 + + +class AudienceCreateEntityV1Resource(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': (AudienceCreateEntityV1,), # 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 + """AudienceCreateEntityV1Resource - 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 (AudienceCreateEntityV1): [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 + """AudienceCreateEntityV1Resource - 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 (AudienceCreateEntityV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_delete_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_delete_entity_v1_resource.py new file mode 100644 index 00000000..4c34aeb2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_delete_entity_v1_resource.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceDeleteEntityV1Resource(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 { + 'attributes': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceDeleteEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audience to delete. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceDeleteEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audience to delete. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1.py new file mode 100644 index 00000000..41dd4d2a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1.py @@ -0,0 +1,295 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.algebra_node_v1 import AlgebraNodeV1 + globals()['AlgebraNodeV1'] = AlgebraNodeV1 + + +class AudienceEntityV1(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 = { + ('ad_set_ids',): { + }, + } + + @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 { + 'name': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + 'advertiser_id': (str, none_type,), # noqa: E501 + 'ad_set_ids': ([str], none_type,), # noqa: E501 + 'algebra': (AlgebraNodeV1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'ad_set_ids': 'adSetIds', # noqa: E501 + 'algebra': 'algebra', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceEntityV1 - 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 the audience. [optional] # noqa: E501 + description (str, none_type): Description of the audience. [optional] # noqa: E501 + created_at (datetime, none_type): ISO-8601 timestamp in UTC of audience creation (read-only). [optional] # noqa: E501 + updated_at (datetime, none_type): ISO-8601 timestamp in UTC of audience update (read-only). [optional] # noqa: E501 + advertiser_id (str, none_type): Advertiser associated to the audience. [optional] # noqa: E501 + ad_set_ids ([str], none_type): Ad sets associated to the audience. [optional] # noqa: E501 + algebra (AlgebraNodeV1): [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 + """AudienceEntityV1 - 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 the audience. [optional] # noqa: E501 + description (str, none_type): Description of the audience. [optional] # noqa: E501 + created_at (datetime, none_type): ISO-8601 timestamp in UTC of audience creation (read-only). [optional] # noqa: E501 + updated_at (datetime, none_type): ISO-8601 timestamp in UTC of audience update (read-only). [optional] # noqa: E501 + advertiser_id (str, none_type): Advertiser associated to the audience. [optional] # noqa: E501 + ad_set_ids ([str], none_type): Ad sets associated to the audience. [optional] # noqa: E501 + algebra (AlgebraNodeV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_audience_search_metadata_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_audience_search_metadata_v1_list_response.py new file mode 100644 index 00000000..d5eb8cb9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_audience_search_metadata_v1_list_response.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_resource import AudienceEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.audience_search_metadata_v1 import AudienceSearchMetadataV1 + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceEntityV1Resource'] = AudienceEntityV1Resource + globals()['AudienceSearchMetadataV1'] = AudienceSearchMetadataV1 + globals()['CommonProblem'] = CommonProblem + + +class AudienceEntityV1AudienceSearchMetadataV1ListResponse(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 { + 'meta': (AudienceSearchMetadataV1,), # noqa: E501 + 'data': ([AudienceEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'meta': 'meta', # noqa: E501 + '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 + """AudienceEntityV1AudienceSearchMetadataV1ListResponse - 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,) + meta (AudienceSearchMetadataV1): [optional] # noqa: E501 + data ([AudienceEntityV1Resource], 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) + _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 + """AudienceEntityV1AudienceSearchMetadataV1ListResponse - 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,) + meta (AudienceSearchMetadataV1): [optional] # noqa: E501 + data ([AudienceEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_list_response.py new file mode 100644 index 00000000..92480db7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_resource import AudienceEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceEntityV1Resource'] = AudienceEntityV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AudienceEntityV1ListResponse(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': ([AudienceEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AudienceEntityV1ListResponse - 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 ([AudienceEntityV1Resource], 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) + _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 + """AudienceEntityV1ListResponse - 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 ([AudienceEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_resource.py new file mode 100644 index 00000000..70672e63 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1 import AudienceEntityV1 + globals()['AudienceEntityV1'] = AudienceEntityV1 + + +class AudienceEntityV1Resource(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 { + 'attributes': (AudienceEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceEntityV1Resource - 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,) + attributes (AudienceEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceEntityV1Resource - 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,) + attributes (AudienceEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_error.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_error.py new file mode 100644 index 00000000..9345c79a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_error.py @@ -0,0 +1,310 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceError(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 = { + ('type',): { + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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 { + 'type': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'instance': (str,), # noqa: E501 + 'trace_id': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'stack_trace': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'trace_id': 'traceId', # noqa: E501 + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, code, instance, *args, **kwargs): # noqa: E501 + """AudienceError - a model defined in OpenAPI + + Args: + type (str): (REQUIRED) The classification of the error + code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. + instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem + + 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,) + trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 + detail (str, none_type): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type + self.code = code + self.instance = instance + 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, type, code, instance, *args, **kwargs): # noqa: E501 + """AudienceError - a model defined in OpenAPI + + Args: + type (str): (REQUIRED) The classification of the error + code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. + instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem + + 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,) + trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 + detail (str, none_type): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type + self.code = code + self.instance = instance + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_entity_v1.py new file mode 100644 index 00000000..b048134b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_entity_v1.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.algebra_node_v1 import AlgebraNodeV1 + globals()['AlgebraNodeV1'] = AlgebraNodeV1 + + +class AudienceEstimateSizeEntityV1(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 { + 'advertiser_id': (str,), # noqa: E501 + 'algebra': (AlgebraNodeV1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'advertiser_id': 'advertiserId', # noqa: E501 + 'algebra': 'algebra', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, advertiser_id, algebra, *args, **kwargs): # noqa: E501 + """AudienceEstimateSizeEntityV1 - a model defined in OpenAPI + + Args: + advertiser_id (str): Advertiser associated to the audience + algebra (AlgebraNodeV1): + + 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.advertiser_id = advertiser_id + self.algebra = algebra + 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, advertiser_id, algebra, *args, **kwargs): # noqa: E501 + """AudienceEstimateSizeEntityV1 - a model defined in OpenAPI + + Args: + advertiser_id (str): Advertiser associated to the audience + algebra (AlgebraNodeV1): + + 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.advertiser_id = advertiser_id + self.algebra = algebra + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_entity_v1_resource.py new file mode 100644 index 00000000..406533c8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_entity_v1_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_estimate_size_entity_v1 import AudienceEstimateSizeEntityV1 + globals()['AudienceEstimateSizeEntityV1'] = AudienceEstimateSizeEntityV1 + + +class AudienceEstimateSizeEntityV1Resource(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': (AudienceEstimateSizeEntityV1,), # 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 + """AudienceEstimateSizeEntityV1Resource - 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 (AudienceEstimateSizeEntityV1): [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 + """AudienceEstimateSizeEntityV1Resource - 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 (AudienceEstimateSizeEntityV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_input_v1.py new file mode 100644 index 00000000..bd240aef --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_estimate_size_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_estimate_size_entity_v1_resource import AudienceEstimateSizeEntityV1Resource + globals()['AudienceEstimateSizeEntityV1Resource'] = AudienceEstimateSizeEntityV1Resource + + +class AudienceEstimateSizeInputV1(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': (AudienceEstimateSizeEntityV1Resource,), # 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 + """AudienceEstimateSizeInputV1 - 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 (AudienceEstimateSizeEntityV1Resource): [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 + """AudienceEstimateSizeInputV1 - 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 (AudienceEstimateSizeEntityV1Resource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_id_entity_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_id_entity_v1_list_response.py new file mode 100644 index 00000000..66c6a35d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_id_entity_v1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_id_entity_v1_resource import AudienceIdEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceIdEntityV1Resource'] = AudienceIdEntityV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AudienceIdEntityV1ListResponse(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': ([AudienceIdEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AudienceIdEntityV1ListResponse - 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 ([AudienceIdEntityV1Resource], 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) + _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 + """AudienceIdEntityV1ListResponse - 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 ([AudienceIdEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_id_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_id_entity_v1_resource.py new file mode 100644 index 00000000..a2b0e2e1 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_id_entity_v1_resource.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceIdEntityV1Resource(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 { + 'attributes': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceIdEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audience entity with only its ID. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceIdEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audience entity with only its ID. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_name_description.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_name_description.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_name_description.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_name_description.py index 235ad0e1..27fd862f 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/audience_name_description.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_name_description.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_entity_v1.py new file mode 100644 index 00000000..51776f37 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_entity_v1.py @@ -0,0 +1,275 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSearchEntityV1(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 { + 'audience_ids': ([str], none_type,), # noqa: E501 + 'advertiser_ids': ([str], none_type,), # noqa: E501 + 'audience_segment_ids': ([str], none_type,), # noqa: E501 + 'ad_set_ids': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'audience_ids': 'audienceIds', # noqa: E501 + 'advertiser_ids': 'advertiserIds', # noqa: E501 + 'audience_segment_ids': 'audienceSegmentIds', # noqa: E501 + 'ad_set_ids': 'adSetIds', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSearchEntityV1 - 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,) + audience_ids ([str], none_type): List of audience ids. [optional] # noqa: E501 + advertiser_ids ([str], none_type): List of advertiser ids. [optional] # noqa: E501 + audience_segment_ids ([str], none_type): List of segment ids (linked to the result audiences). [optional] # noqa: E501 + ad_set_ids ([str], none_type): List of AdSet ids. [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 + """AudienceSearchEntityV1 - 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,) + audience_ids ([str], none_type): List of audience ids. [optional] # noqa: E501 + advertiser_ids ([str], none_type): List of advertiser ids. [optional] # noqa: E501 + audience_segment_ids ([str], none_type): List of segment ids (linked to the result audiences). [optional] # noqa: E501 + ad_set_ids ([str], none_type): List of AdSet ids. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_entity_v1_resource.py new file mode 100644 index 00000000..82bcf642 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_entity_v1_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_search_entity_v1 import AudienceSearchEntityV1 + globals()['AudienceSearchEntityV1'] = AudienceSearchEntityV1 + + +class AudienceSearchEntityV1Resource(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': (AudienceSearchEntityV1,), # 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 + """AudienceSearchEntityV1Resource - 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 (AudienceSearchEntityV1): [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 + """AudienceSearchEntityV1Resource - 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 (AudienceSearchEntityV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_input_v1.py new file mode 100644 index 00000000..47fcd074 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_search_entity_v1_resource import AudienceSearchEntityV1Resource + globals()['AudienceSearchEntityV1Resource'] = AudienceSearchEntityV1Resource + + +class AudienceSearchInputV1(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': (AudienceSearchEntityV1Resource,), # 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 + """AudienceSearchInputV1 - 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 (AudienceSearchEntityV1Resource): [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 + """AudienceSearchInputV1 - 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 (AudienceSearchEntityV1Resource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_metadata_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_metadata_v1.py new file mode 100644 index 00000000..a7ed0f63 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_search_metadata_v1.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSearchMetadataV1(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 { + 'total_items': (int, none_type,), # noqa: E501 + 'limit': (int, none_type,), # noqa: E501 + 'offset': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total_items': 'totalItems', # noqa: E501 + 'limit': 'limit', # noqa: E501 + 'offset': 'offset', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSearchMetadataV1 - 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,) + total_items (int, none_type): Total number of items. [optional] # noqa: E501 + limit (int, none_type): Max item of the current page. [optional] # noqa: E501 + offset (int, none_type): Number of item to skip. [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 + """AudienceSearchMetadataV1 - 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,) + total_items (int, none_type): Total number of items. [optional] # noqa: E501 + limit (int, none_type): Max item of the current page. [optional] # noqa: E501 + offset (int, none_type): Number of item to skip. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_create_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_create_input_v1.py new file mode 100644 index 00000000..a7b93486 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_create_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_create_entity_v1_resource import AudienceSegmentCreateEntityV1Resource + globals()['AudienceSegmentCreateEntityV1Resource'] = AudienceSegmentCreateEntityV1Resource + + +class AudienceSegmentBulkCreateInputV1(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': ([AudienceSegmentCreateEntityV1Resource], 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 + """AudienceSegmentBulkCreateInputV1 - 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 ([AudienceSegmentCreateEntityV1Resource], 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 + """AudienceSegmentBulkCreateInputV1 - 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 ([AudienceSegmentCreateEntityV1Resource], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_delete_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_delete_input_v1.py new file mode 100644 index 00000000..a33d53f6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_delete_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_delete_entity_v1_resource import AudienceSegmentDeleteEntityV1Resource + globals()['AudienceSegmentDeleteEntityV1Resource'] = AudienceSegmentDeleteEntityV1Resource + + +class AudienceSegmentBulkDeleteInputV1(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': ([AudienceSegmentDeleteEntityV1Resource], 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 + """AudienceSegmentBulkDeleteInputV1 - 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 ([AudienceSegmentDeleteEntityV1Resource], 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 + """AudienceSegmentBulkDeleteInputV1 - 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 ([AudienceSegmentDeleteEntityV1Resource], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_update_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_update_input_v1.py new file mode 100644 index 00000000..6e9b8f06 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_bulk_update_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_update_entity_v1_resource import AudienceSegmentUpdateEntityV1Resource + globals()['AudienceSegmentUpdateEntityV1Resource'] = AudienceSegmentUpdateEntityV1Resource + + +class AudienceSegmentBulkUpdateInputV1(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': ([AudienceSegmentUpdateEntityV1Resource], 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 + """AudienceSegmentBulkUpdateInputV1 - 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 ([AudienceSegmentUpdateEntityV1Resource], 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 + """AudienceSegmentBulkUpdateInputV1 - 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 ([AudienceSegmentUpdateEntityV1Resource], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_compute_size_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_compute_size_entity_v1_resource.py new file mode 100644 index 00000000..6c57dc88 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_compute_size_entity_v1_resource.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSegmentComputeSizeEntityV1Resource(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 { + 'attributes': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentComputeSizeEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Set of rules that defines specific people to target.. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceSegmentComputeSizeEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Set of rules that defines specific people to target.. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_compute_sizes_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_compute_sizes_input_v1.py new file mode 100644 index 00000000..98cedfdd --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_compute_sizes_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_compute_size_entity_v1_resource import AudienceSegmentComputeSizeEntityV1Resource + globals()['AudienceSegmentComputeSizeEntityV1Resource'] = AudienceSegmentComputeSizeEntityV1Resource + + +class AudienceSegmentComputeSizesInputV1(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': ([AudienceSegmentComputeSizeEntityV1Resource], 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 + """AudienceSegmentComputeSizesInputV1 - 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 ([AudienceSegmentComputeSizeEntityV1Resource], 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 + """AudienceSegmentComputeSizesInputV1 - 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 ([AudienceSegmentComputeSizeEntityV1Resource], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_create_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_create_entity_v1.py new file mode 100644 index 00000000..04fa56c6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_create_entity_v1.py @@ -0,0 +1,317 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.in_market_create_v1 import InMarketCreateV1 + from criteo_api_marketingsolutions_v2024_04.model.location_create_v1 import LocationCreateV1 + from criteo_api_marketingsolutions_v2024_04.model.lookalike_create_v1 import LookalikeCreateV1 + from criteo_api_marketingsolutions_v2024_04.model.prospecting_create_v1 import ProspectingCreateV1 + from criteo_api_marketingsolutions_v2024_04.model.retargeting_create_v1 import RetargetingCreateV1 + globals()['InMarketCreateV1'] = InMarketCreateV1 + globals()['LocationCreateV1'] = LocationCreateV1 + globals()['LookalikeCreateV1'] = LookalikeCreateV1 + globals()['ProspectingCreateV1'] = ProspectingCreateV1 + globals()['RetargetingCreateV1'] = RetargetingCreateV1 + + +class AudienceSegmentCreateEntityV1(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 { + 'name': (str,), # noqa: E501 + 'advertiser_id': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'in_market': (InMarketCreateV1,), # noqa: E501 + 'prospecting': (ProspectingCreateV1,), # noqa: E501 + 'contact_list': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'location': (LocationCreateV1,), # noqa: E501 + 'retargeting': (RetargetingCreateV1,), # noqa: E501 + 'lookalike': (LookalikeCreateV1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'in_market': 'inMarket', # noqa: E501 + 'prospecting': 'prospecting', # noqa: E501 + 'contact_list': 'contactList', # noqa: E501 + 'location': 'location', # noqa: E501 + 'retargeting': 'retargeting', # noqa: E501 + 'lookalike': 'lookalike', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, advertiser_id, *args, **kwargs): # noqa: E501 + """AudienceSegmentCreateEntityV1 - a model defined in OpenAPI + + Args: + name (str): Name of the segment + advertiser_id (str): Advertiser associated to the segment + + 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,) + description (str, none_type): Description of the segment. [optional] # noqa: E501 + in_market (InMarketCreateV1): [optional] # noqa: E501 + prospecting (ProspectingCreateV1): [optional] # noqa: E501 + contact_list ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Settings to target users with your contact lists.. [optional] # noqa: E501 + location (LocationCreateV1): [optional] # noqa: E501 + retargeting (RetargetingCreateV1): [optional] # noqa: E501 + lookalike (LookalikeCreateV1): [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.name = name + self.advertiser_id = advertiser_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, name, advertiser_id, *args, **kwargs): # noqa: E501 + """AudienceSegmentCreateEntityV1 - a model defined in OpenAPI + + Args: + name (str): Name of the segment + advertiser_id (str): Advertiser associated to the segment + + 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,) + description (str, none_type): Description of the segment. [optional] # noqa: E501 + in_market (InMarketCreateV1): [optional] # noqa: E501 + prospecting (ProspectingCreateV1): [optional] # noqa: E501 + contact_list ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Settings to target users with your contact lists.. [optional] # noqa: E501 + location (LocationCreateV1): [optional] # noqa: E501 + retargeting (RetargetingCreateV1): [optional] # noqa: E501 + lookalike (LookalikeCreateV1): [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.name = name + self.advertiser_id = advertiser_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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_create_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_create_entity_v1_resource.py new file mode 100644 index 00000000..10aeaa68 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_create_entity_v1_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_create_entity_v1 import AudienceSegmentCreateEntityV1 + globals()['AudienceSegmentCreateEntityV1'] = AudienceSegmentCreateEntityV1 + + +class AudienceSegmentCreateEntityV1Resource(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': (AudienceSegmentCreateEntityV1,), # 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 + """AudienceSegmentCreateEntityV1Resource - 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 (AudienceSegmentCreateEntityV1): [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 + """AudienceSegmentCreateEntityV1Resource - 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 (AudienceSegmentCreateEntityV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_delete_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_delete_entity_v1_resource.py new file mode 100644 index 00000000..71662d1d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_delete_entity_v1_resource.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSegmentDeleteEntityV1Resource(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 { + 'attributes': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentDeleteEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Segment to delete. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceSegmentDeleteEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Segment to delete. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1.py new file mode 100644 index 00000000..9b1ed809 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1.py @@ -0,0 +1,340 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.behavioral_v1 import BehavioralV1 + from criteo_api_marketingsolutions_v2024_04.model.contact_list_v1 import ContactListV1 + from criteo_api_marketingsolutions_v2024_04.model.in_market_v1 import InMarketV1 + from criteo_api_marketingsolutions_v2024_04.model.location_v1 import LocationV1 + from criteo_api_marketingsolutions_v2024_04.model.lookalike_v1 import LookalikeV1 + from criteo_api_marketingsolutions_v2024_04.model.prospecting_v1 import ProspectingV1 + from criteo_api_marketingsolutions_v2024_04.model.retargeting_v1 import RetargetingV1 + globals()['BehavioralV1'] = BehavioralV1 + globals()['ContactListV1'] = ContactListV1 + globals()['InMarketV1'] = InMarketV1 + globals()['LocationV1'] = LocationV1 + globals()['LookalikeV1'] = LookalikeV1 + globals()['ProspectingV1'] = ProspectingV1 + globals()['RetargetingV1'] = RetargetingV1 + + +class AudienceSegmentEntityV1(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'INMARKET': "InMarket", + 'PROSPECTING': "Prospecting", + 'CONTACTLIST': "ContactList", + 'LOCATION': "Location", + 'BEHAVIORAL': "Behavioral", + 'RETARGETING': "Retargeting", + 'LOOKALIKE': "Lookalike", + }, + } + + 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 { + 'name': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + 'advertiser_id': (str, none_type,), # noqa: E501 + 'in_market': (InMarketV1,), # noqa: E501 + 'prospecting': (ProspectingV1,), # noqa: E501 + 'contact_list': (ContactListV1,), # noqa: E501 + 'location': (LocationV1,), # noqa: E501 + 'behavioral': (BehavioralV1,), # noqa: E501 + 'retargeting': (RetargetingV1,), # noqa: E501 + 'lookalike': (LookalikeV1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'type': 'type', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'in_market': 'inMarket', # noqa: E501 + 'prospecting': 'prospecting', # noqa: E501 + 'contact_list': 'contactList', # noqa: E501 + 'location': 'location', # noqa: E501 + 'behavioral': 'behavioral', # noqa: E501 + 'retargeting': 'retargeting', # noqa: E501 + 'lookalike': 'lookalike', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentEntityV1 - 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 the segment. [optional] # noqa: E501 + description (str, none_type): Description of the segment. [optional] # noqa: E501 + type (str, none_type): Type of segment (read-only). [optional] # noqa: E501 + created_at (datetime, none_type): ISO-8601 timestamp in UTC of segment creation (read-only). [optional] # noqa: E501 + updated_at (datetime, none_type): ISO-8601 timestamp in UTC of segment update (read-only). [optional] # noqa: E501 + advertiser_id (str, none_type): Advertiser associated to the segment. [optional] # noqa: E501 + in_market (InMarketV1): [optional] # noqa: E501 + prospecting (ProspectingV1): [optional] # noqa: E501 + contact_list (ContactListV1): [optional] # noqa: E501 + location (LocationV1): [optional] # noqa: E501 + behavioral (BehavioralV1): [optional] # noqa: E501 + retargeting (RetargetingV1): [optional] # noqa: E501 + lookalike (LookalikeV1): [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 + """AudienceSegmentEntityV1 - 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 the segment. [optional] # noqa: E501 + description (str, none_type): Description of the segment. [optional] # noqa: E501 + type (str, none_type): Type of segment (read-only). [optional] # noqa: E501 + created_at (datetime, none_type): ISO-8601 timestamp in UTC of segment creation (read-only). [optional] # noqa: E501 + updated_at (datetime, none_type): ISO-8601 timestamp in UTC of segment update (read-only). [optional] # noqa: E501 + advertiser_id (str, none_type): Advertiser associated to the segment. [optional] # noqa: E501 + in_market (InMarketV1): [optional] # noqa: E501 + prospecting (ProspectingV1): [optional] # noqa: E501 + contact_list (ContactListV1): [optional] # noqa: E501 + location (LocationV1): [optional] # noqa: E501 + behavioral (BehavioralV1): [optional] # noqa: E501 + retargeting (RetargetingV1): [optional] # noqa: E501 + lookalike (LookalikeV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response.py new file mode 100644 index 00000000..32396d50 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_resource import AudienceSegmentEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_metadata_v1 import AudienceSegmentSearchMetadataV1 + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceSegmentEntityV1Resource'] = AudienceSegmentEntityV1Resource + globals()['AudienceSegmentSearchMetadataV1'] = AudienceSegmentSearchMetadataV1 + globals()['CommonProblem'] = CommonProblem + + +class AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse(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 { + 'meta': (AudienceSegmentSearchMetadataV1,), # noqa: E501 + 'data': ([AudienceSegmentEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'meta': 'meta', # noqa: E501 + '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 + """AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse - 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,) + meta (AudienceSegmentSearchMetadataV1): [optional] # noqa: E501 + data ([AudienceSegmentEntityV1Resource], 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) + _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 + """AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse - 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,) + meta (AudienceSegmentSearchMetadataV1): [optional] # noqa: E501 + data ([AudienceSegmentEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_list_response.py new file mode 100644 index 00000000..c91e471a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_resource import AudienceSegmentEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceSegmentEntityV1Resource'] = AudienceSegmentEntityV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AudienceSegmentEntityV1ListResponse(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': ([AudienceSegmentEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AudienceSegmentEntityV1ListResponse - 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 ([AudienceSegmentEntityV1Resource], 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) + _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 + """AudienceSegmentEntityV1ListResponse - 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 ([AudienceSegmentEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_resource.py new file mode 100644 index 00000000..f0aff450 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1 import AudienceSegmentEntityV1 + globals()['AudienceSegmentEntityV1'] = AudienceSegmentEntityV1 + + +class AudienceSegmentEntityV1Resource(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 { + 'attributes': (AudienceSegmentEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentEntityV1Resource - 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,) + attributes (AudienceSegmentEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceSegmentEntityV1Resource - 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,) + attributes (AudienceSegmentEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_estimate_size_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_estimate_size_input_v1.py new file mode 100644 index 00000000..028c3ea6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_estimate_size_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_entity_v1_resource import AudienceSegmentSizeEstimationEntityV1Resource + globals()['AudienceSegmentSizeEstimationEntityV1Resource'] = AudienceSegmentSizeEstimationEntityV1Resource + + +class AudienceSegmentEstimateSizeInputV1(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': (AudienceSegmentSizeEstimationEntityV1Resource,), # 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 + """AudienceSegmentEstimateSizeInputV1 - 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 (AudienceSegmentSizeEstimationEntityV1Resource): [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 + """AudienceSegmentEstimateSizeInputV1 - 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 (AudienceSegmentSizeEstimationEntityV1Resource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_id_entity_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_id_entity_v1_list_response.py new file mode 100644 index 00000000..50ced8aa --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_id_entity_v1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_id_entity_v1_resource import AudienceSegmentIdEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceSegmentIdEntityV1Resource'] = AudienceSegmentIdEntityV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AudienceSegmentIdEntityV1ListResponse(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': ([AudienceSegmentIdEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AudienceSegmentIdEntityV1ListResponse - 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 ([AudienceSegmentIdEntityV1Resource], 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) + _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 + """AudienceSegmentIdEntityV1ListResponse - 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 ([AudienceSegmentIdEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_id_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_id_entity_v1_resource.py new file mode 100644 index 00000000..fe87d600 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_id_entity_v1_resource.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSegmentIdEntityV1Resource(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 { + 'attributes': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentIdEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audience Segment entity only with its ID. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceSegmentIdEntityV1Resource - 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,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Audience Segment entity only with its ID. [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_entity_v1.py new file mode 100644 index 00000000..65da014f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_entity_v1.py @@ -0,0 +1,282 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSegmentSearchEntityV1(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 = { + ('audience_segment_types',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'INMARKET': "InMarket", + 'PROSPECTING': "Prospecting", + 'CONTACTLIST': "ContactList", + 'LOCATION': "Location", + 'BEHAVIORAL': "Behavioral", + 'RETARGETING': "Retargeting", + 'LOOKALIKE': "Lookalike", + }, + } + + 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 { + 'audience_segment_ids': ([str], none_type,), # noqa: E501 + 'advertiser_ids': ([str], none_type,), # noqa: E501 + 'audience_segment_types': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'audience_segment_ids': 'audienceSegmentIds', # noqa: E501 + 'advertiser_ids': 'advertiserIds', # noqa: E501 + 'audience_segment_types': 'audienceSegmentTypes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentSearchEntityV1 - 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,) + audience_segment_ids ([str], none_type): List of segment ids. [optional] # noqa: E501 + advertiser_ids ([str], none_type): List of advertiser ids. [optional] # noqa: E501 + audience_segment_types ([str], none_type): List of segment types. [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 + """AudienceSegmentSearchEntityV1 - 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,) + audience_segment_ids ([str], none_type): List of segment ids. [optional] # noqa: E501 + advertiser_ids ([str], none_type): List of advertiser ids. [optional] # noqa: E501 + audience_segment_types ([str], none_type): List of segment types. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_entity_v1_resource.py new file mode 100644 index 00000000..6660221b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_entity_v1_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_entity_v1 import AudienceSegmentSearchEntityV1 + globals()['AudienceSegmentSearchEntityV1'] = AudienceSegmentSearchEntityV1 + + +class AudienceSegmentSearchEntityV1Resource(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': (AudienceSegmentSearchEntityV1,), # 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 + """AudienceSegmentSearchEntityV1Resource - 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 (AudienceSegmentSearchEntityV1): [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 + """AudienceSegmentSearchEntityV1Resource - 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 (AudienceSegmentSearchEntityV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_input_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_input_v1.py new file mode 100644 index 00000000..4068f60f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_input_v1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_entity_v1_resource import AudienceSegmentSearchEntityV1Resource + globals()['AudienceSegmentSearchEntityV1Resource'] = AudienceSegmentSearchEntityV1Resource + + +class AudienceSegmentSearchInputV1(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': (AudienceSegmentSearchEntityV1Resource,), # 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 + """AudienceSegmentSearchInputV1 - 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 (AudienceSegmentSearchEntityV1Resource): [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 + """AudienceSegmentSearchInputV1 - 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 (AudienceSegmentSearchEntityV1Resource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_metadata_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_metadata_v1.py new file mode 100644 index 00000000..497d4e34 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_search_metadata_v1.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSegmentSearchMetadataV1(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 { + 'total_items': (int, none_type,), # noqa: E501 + 'limit': (int, none_type,), # noqa: E501 + 'offset': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total_items': 'totalItems', # noqa: E501 + 'limit': 'limit', # noqa: E501 + 'offset': 'offset', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentSearchMetadataV1 - 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,) + total_items (int, none_type): Total number of items. [optional] # noqa: E501 + limit (int, none_type): Max item of the current page. [optional] # noqa: E501 + offset (int, none_type): Number of item to skip. [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 + """AudienceSegmentSearchMetadataV1 - 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,) + total_items (int, none_type): Total number of items. [optional] # noqa: E501 + limit (int, none_type): Max item of the current page. [optional] # noqa: E501 + offset (int, none_type): Number of item to skip. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1.py new file mode 100644 index 00000000..478ca499 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSegmentSizeEntityV1(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 { + 'size': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'size': 'size', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentSizeEntityV1 - 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,) + size (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 + """AudienceSegmentSizeEntityV1 - 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,) + size (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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1_list_response.py new file mode 100644 index 00000000..01488427 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_entity_v1_resource import AudienceSegmentSizeEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceSegmentSizeEntityV1Resource'] = AudienceSegmentSizeEntityV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AudienceSegmentSizeEntityV1ListResponse(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': ([AudienceSegmentSizeEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AudienceSegmentSizeEntityV1ListResponse - 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 ([AudienceSegmentSizeEntityV1Resource], 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) + _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 + """AudienceSegmentSizeEntityV1ListResponse - 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 ([AudienceSegmentSizeEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1_resource.py new file mode 100644 index 00000000..0020f369 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_entity_v1 import AudienceSegmentSizeEntityV1 + globals()['AudienceSegmentSizeEntityV1'] = AudienceSegmentSizeEntityV1 + + +class AudienceSegmentSizeEntityV1Resource(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 { + 'attributes': (AudienceSegmentSizeEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentSizeEntityV1Resource - 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,) + attributes (AudienceSegmentSizeEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceSegmentSizeEntityV1Resource - 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,) + attributes (AudienceSegmentSizeEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_entity_v1.py new file mode 100644 index 00000000..a7a5445d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_entity_v1.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.in_market_size_estimation_v1 import InMarketSizeEstimationV1 + from criteo_api_marketingsolutions_v2024_04.model.location_size_estimation_v1 import LocationSizeEstimationV1 + globals()['InMarketSizeEstimationV1'] = InMarketSizeEstimationV1 + globals()['LocationSizeEstimationV1'] = LocationSizeEstimationV1 + + +class AudienceSegmentSizeEstimationEntityV1(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 { + 'advertiser_id': (str,), # noqa: E501 + 'in_market': (InMarketSizeEstimationV1,), # noqa: E501 + 'location': (LocationSizeEstimationV1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'advertiser_id': 'advertiserId', # noqa: E501 + 'in_market': 'inMarket', # noqa: E501 + 'location': 'location', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, advertiser_id, *args, **kwargs): # noqa: E501 + """AudienceSegmentSizeEstimationEntityV1 - a model defined in OpenAPI + + Args: + advertiser_id (str): Advertiser associated to the segment + + 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,) + in_market (InMarketSizeEstimationV1): [optional] # noqa: E501 + location (LocationSizeEstimationV1): [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.advertiser_id = advertiser_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, advertiser_id, *args, **kwargs): # noqa: E501 + """AudienceSegmentSizeEstimationEntityV1 - a model defined in OpenAPI + + Args: + advertiser_id (str): Advertiser associated to the segment + + 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,) + in_market (InMarketSizeEstimationV1): [optional] # noqa: E501 + location (LocationSizeEstimationV1): [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.advertiser_id = advertiser_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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_entity_v1_resource.py new file mode 100644 index 00000000..9b194e8e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_entity_v1_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_entity_v1 import AudienceSegmentSizeEstimationEntityV1 + globals()['AudienceSegmentSizeEstimationEntityV1'] = AudienceSegmentSizeEstimationEntityV1 + + +class AudienceSegmentSizeEstimationEntityV1Resource(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': (AudienceSegmentSizeEstimationEntityV1,), # 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 + """AudienceSegmentSizeEstimationEntityV1Resource - 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 (AudienceSegmentSizeEstimationEntityV1): [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 + """AudienceSegmentSizeEstimationEntityV1Resource - 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 (AudienceSegmentSizeEstimationEntityV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1.py new file mode 100644 index 00000000..9e696800 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSegmentSizeEstimationV1(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 { + 'size': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'size': 'size', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentSizeEstimationV1 - 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,) + size (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 + """AudienceSegmentSizeEstimationV1 - 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,) + size (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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1_resource.py new file mode 100644 index 00000000..832fc3fb --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_v1 import AudienceSegmentSizeEstimationV1 + globals()['AudienceSegmentSizeEstimationV1'] = AudienceSegmentSizeEstimationV1 + + +class AudienceSegmentSizeEstimationV1Resource(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': (AudienceSegmentSizeEstimationV1,), # 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 + """AudienceSegmentSizeEstimationV1Resource - 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 (AudienceSegmentSizeEstimationV1): [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 + """AudienceSegmentSizeEstimationV1Resource - 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 (AudienceSegmentSizeEstimationV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1_response.py new file mode 100644 index 00000000..60fc48e5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_size_estimation_v1_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_v1_resource import AudienceSegmentSizeEstimationV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceSegmentSizeEstimationV1Resource'] = AudienceSegmentSizeEstimationV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AudienceSegmentSizeEstimationV1Response(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': (AudienceSegmentSizeEstimationV1Resource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AudienceSegmentSizeEstimationV1Response - 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 (AudienceSegmentSizeEstimationV1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """AudienceSegmentSizeEstimationV1Response - 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 (AudienceSegmentSizeEstimationV1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_update_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_update_entity_v1.py new file mode 100644 index 00000000..45f3218d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_update_entity_v1.py @@ -0,0 +1,303 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.in_market_update_v1 import InMarketUpdateV1 + from criteo_api_marketingsolutions_v2024_04.model.location_update_v1 import LocationUpdateV1 + from criteo_api_marketingsolutions_v2024_04.model.lookalike_update_v1 import LookalikeUpdateV1 + from criteo_api_marketingsolutions_v2024_04.model.nillable_string import NillableString + from criteo_api_marketingsolutions_v2024_04.model.prospecting_update_v1 import ProspectingUpdateV1 + from criteo_api_marketingsolutions_v2024_04.model.retargeting_update_v1 import RetargetingUpdateV1 + globals()['InMarketUpdateV1'] = InMarketUpdateV1 + globals()['LocationUpdateV1'] = LocationUpdateV1 + globals()['LookalikeUpdateV1'] = LookalikeUpdateV1 + globals()['NillableString'] = NillableString + globals()['ProspectingUpdateV1'] = ProspectingUpdateV1 + globals()['RetargetingUpdateV1'] = RetargetingUpdateV1 + + +class AudienceSegmentUpdateEntityV1(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 { + 'name': (str, none_type,), # noqa: E501 + 'description': (NillableString,), # noqa: E501 + 'in_market': (InMarketUpdateV1,), # noqa: E501 + 'location': (LocationUpdateV1,), # noqa: E501 + 'retargeting': (RetargetingUpdateV1,), # noqa: E501 + 'lookalike': (LookalikeUpdateV1,), # noqa: E501 + 'prospecting': (ProspectingUpdateV1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'in_market': 'inMarket', # noqa: E501 + 'location': 'location', # noqa: E501 + 'retargeting': 'retargeting', # noqa: E501 + 'lookalike': 'lookalike', # noqa: E501 + 'prospecting': 'prospecting', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentUpdateEntityV1 - 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 the segment. [optional] # noqa: E501 + description (NillableString): [optional] # noqa: E501 + in_market (InMarketUpdateV1): [optional] # noqa: E501 + location (LocationUpdateV1): [optional] # noqa: E501 + retargeting (RetargetingUpdateV1): [optional] # noqa: E501 + lookalike (LookalikeUpdateV1): [optional] # noqa: E501 + prospecting (ProspectingUpdateV1): [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 + """AudienceSegmentUpdateEntityV1 - 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 the segment. [optional] # noqa: E501 + description (NillableString): [optional] # noqa: E501 + in_market (InMarketUpdateV1): [optional] # noqa: E501 + location (LocationUpdateV1): [optional] # noqa: E501 + retargeting (RetargetingUpdateV1): [optional] # noqa: E501 + lookalike (LookalikeUpdateV1): [optional] # noqa: E501 + prospecting (ProspectingUpdateV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_update_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_update_entity_v1_resource.py new file mode 100644 index 00000000..36f68676 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_segment_update_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_segment_update_entity_v1 import AudienceSegmentUpdateEntityV1 + globals()['AudienceSegmentUpdateEntityV1'] = AudienceSegmentUpdateEntityV1 + + +class AudienceSegmentUpdateEntityV1Resource(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 { + 'attributes': (AudienceSegmentUpdateEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSegmentUpdateEntityV1Resource - 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,) + attributes (AudienceSegmentUpdateEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceSegmentUpdateEntityV1Resource - 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,) + attributes (AudienceSegmentUpdateEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1.py new file mode 100644 index 00000000..173f0646 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSizeEntityV1(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 { + 'size': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'size': 'size', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSizeEntityV1 - 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,) + size (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 + """AudienceSizeEntityV1 - 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,) + size (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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1_list_response.py new file mode 100644 index 00000000..27180192 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_size_entity_v1_resource import AudienceSizeEntityV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceSizeEntityV1Resource'] = AudienceSizeEntityV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AudienceSizeEntityV1ListResponse(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': ([AudienceSizeEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AudienceSizeEntityV1ListResponse - 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 ([AudienceSizeEntityV1Resource], 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) + _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 + """AudienceSizeEntityV1ListResponse - 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 ([AudienceSizeEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1_resource.py new file mode 100644 index 00000000..3a9b2d35 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_size_entity_v1 import AudienceSizeEntityV1 + globals()['AudienceSizeEntityV1'] = AudienceSizeEntityV1 + + +class AudienceSizeEntityV1Resource(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 { + 'attributes': (AudienceSizeEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSizeEntityV1Resource - 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,) + attributes (AudienceSizeEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceSizeEntityV1Resource - 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,) + attributes (AudienceSizeEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1.py new file mode 100644 index 00000000..c3840255 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceSizeEstimationV1(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 { + 'size': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'size': 'size', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceSizeEstimationV1 - 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,) + size (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 + """AudienceSizeEstimationV1 - 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,) + size (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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1_resource.py new file mode 100644 index 00000000..e3f30042 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_size_estimation_v1 import AudienceSizeEstimationV1 + globals()['AudienceSizeEstimationV1'] = AudienceSizeEstimationV1 + + +class AudienceSizeEstimationV1Resource(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': (AudienceSizeEstimationV1,), # 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 + """AudienceSizeEstimationV1Resource - 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 (AudienceSizeEstimationV1): [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 + """AudienceSizeEstimationV1Resource - 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 (AudienceSizeEstimationV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1_response.py new file mode 100644 index 00000000..f55818a3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_size_estimation_v1_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_size_estimation_v1_resource import AudienceSizeEstimationV1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['AudienceSizeEstimationV1Resource'] = AudienceSizeEstimationV1Resource + globals()['CommonProblem'] = CommonProblem + + +class AudienceSizeEstimationV1Response(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': (AudienceSizeEstimationV1Resource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """AudienceSizeEstimationV1Response - 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 (AudienceSizeEstimationV1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """AudienceSizeEstimationV1Response - 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 (AudienceSizeEstimationV1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_update_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_update_entity_v1.py new file mode 100644 index 00000000..84f81a3f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_update_entity_v1.py @@ -0,0 +1,279 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.algebra_node_v1 import AlgebraNodeV1 + from criteo_api_marketingsolutions_v2024_04.model.nillable_string import NillableString + globals()['AlgebraNodeV1'] = AlgebraNodeV1 + globals()['NillableString'] = NillableString + + +class AudienceUpdateEntityV1(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 { + 'name': (str, none_type,), # noqa: E501 + 'description': (NillableString,), # noqa: E501 + 'algebra': (AlgebraNodeV1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'algebra': 'algebra', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceUpdateEntityV1 - 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 the audience. [optional] # noqa: E501 + description (NillableString): [optional] # noqa: E501 + algebra (AlgebraNodeV1): [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 + """AudienceUpdateEntityV1 - 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 the audience. [optional] # noqa: E501 + description (NillableString): [optional] # noqa: E501 + algebra (AlgebraNodeV1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_update_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_update_entity_v1_resource.py new file mode 100644 index 00000000..5ce2fdd8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_update_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_update_entity_v1 import AudienceUpdateEntityV1 + globals()['AudienceUpdateEntityV1'] = AudienceUpdateEntityV1 + + +class AudienceUpdateEntityV1Resource(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 { + 'attributes': (AudienceUpdateEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AudienceUpdateEntityV1Resource - 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,) + attributes (AudienceUpdateEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """AudienceUpdateEntityV1Resource - 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,) + attributes (AudienceUpdateEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_warning.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_warning.py new file mode 100644 index 00000000..b9c34842 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/audience_warning.py @@ -0,0 +1,312 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class AudienceWarning(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 = { + ('type',): { + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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 { + 'type': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'instance': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 + 'trace_id': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'source': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'stack_trace': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'trace_id': 'traceId', # noqa: E501 + 'title': 'title', # noqa: E501 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, code, instance, detail, *args, **kwargs): # noqa: E501 + """AudienceWarning - a model defined in OpenAPI + + Args: + type (str): (REQUIRED) The classification of the error + code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. + instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem + detail (str): (REQUIRED) A human-readable explanation specific to this occurrence of the problem + + 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,) + trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 + source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type + self.code = code + self.instance = instance + 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, type, code, instance, detail, *args, **kwargs): # noqa: E501 + """AudienceWarning - a model defined in OpenAPI + + Args: + type (str): (REQUIRED) The classification of the error + code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. + instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem + detail (str): (REQUIRED) A human-readable explanation specific to this occurrence of the problem + + 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,) + trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 + source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type + self.code = code + self.instance = instance + 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/basic_audience_definition.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/basic_audience_definition.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/basic_audience_definition.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/basic_audience_definition.py index 6d1f0f10..a763cc75 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/basic_audience_definition.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/basic_audience_definition.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_name_description import AudienceNameDescription + from criteo_api_marketingsolutions_v2024_04.model.audience_name_description import AudienceNameDescription globals()['AudienceNameDescription'] = AudienceNameDescription diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/behavioral_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/behavioral_v1.py new file mode 100644 index 00000000..a2f263ee --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/behavioral_v1.py @@ -0,0 +1,288 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class BehavioralV1(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 = { + ('category',): { + 'UNKNOWN': "Unknown", + 'LIFESTYLES': "Lifestyles", + 'LIFEEVENTS': "LifeEvents", + 'SEASONAL': "Seasonal", + 'BUYINGPATTERNS': "BuyingPatterns", + }, + } + + 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': (str,), # noqa: E501 + 'country': (str, none_type,), # noqa: E501 + 'start_date': (datetime, none_type,), # noqa: E501 + 'end_date': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'category': 'category', # noqa: E501 + 'country': 'country', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, category, *args, **kwargs): # noqa: E501 + """BehavioralV1 - a model defined in OpenAPI + + Args: + category (str): The type of behavioral + + 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,) + country (str, none_type): The users' country. [optional] # noqa: E501 + start_date (datetime, none_type): Desired date when the behavioral will start. [optional] # noqa: E501 + end_date (datetime, none_type): Desired date when the behavioral will end. [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.category = category + 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, *args, **kwargs): # noqa: E501 + """BehavioralV1 - a model defined in OpenAPI + + Args: + category (str): The type of behavioral + + 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,) + country (str, none_type): The users' country. [optional] # noqa: E501 + start_date (datetime, none_type): Desired date when the behavioral will start. [optional] # noqa: E501 + end_date (datetime, none_type): Desired date when the behavioral will end. [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.category = category + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_search_filters_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_search_filters_v23_q1.py new file mode 100644 index 00000000..bc7567ce --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_search_filters_v23_q1.py @@ -0,0 +1,267 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class CampaignSearchFiltersV23Q1(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 { + 'campaign_ids': ([str], none_type,), # noqa: E501 + 'advertiser_ids': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'campaign_ids': 'campaignIds', # noqa: E501 + 'advertiser_ids': 'advertiserIds', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CampaignSearchFiltersV23Q1 - 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,) + campaign_ids ([str], none_type): [optional] # noqa: E501 + advertiser_ids ([str], 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 + """CampaignSearchFiltersV23Q1 - 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,) + campaign_ids ([str], none_type): [optional] # noqa: E501 + advertiser_ids ([str], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_search_request_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_search_request_v23_q1.py new file mode 100644 index 00000000..b7e8db42 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_search_request_v23_q1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.campaign_search_filters_v23_q1 import CampaignSearchFiltersV23Q1 + globals()['CampaignSearchFiltersV23Q1'] = CampaignSearchFiltersV23Q1 + + +class CampaignSearchRequestV23Q1(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 { + 'filters': (CampaignSearchFiltersV23Q1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filters': 'filters', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CampaignSearchRequestV23Q1 - 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,) + filters (CampaignSearchFiltersV23Q1): [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 + """CampaignSearchRequestV23Q1 - 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,) + filters (CampaignSearchFiltersV23Q1): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_spend_limit_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_spend_limit_v23_q1.py new file mode 100644 index 00000000..ef8efea4 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_spend_limit_v23_q1.py @@ -0,0 +1,289 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal + globals()['NillableDecimal'] = NillableDecimal + + +class CampaignSpendLimitV23Q1(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 = { + ('spend_limit_type',): { + 'None': None, + 'CAPPED': "capped", + 'UNCAPPED': "uncapped", + }, + ('spend_limit_renewal',): { + 'None': None, + 'UNDEFINED': "undefined", + 'DAILY': "daily", + 'MONTHLY': "monthly", + 'LIFETIME': "lifetime", + }, + } + + 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 { + 'spend_limit_type': (str, none_type,), # noqa: E501 + 'spend_limit_renewal': (str, none_type,), # noqa: E501 + 'spend_limit_amount': (NillableDecimal,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'spend_limit_type': 'spendLimitType', # noqa: E501 + 'spend_limit_renewal': 'spendLimitRenewal', # noqa: E501 + 'spend_limit_amount': 'spendLimitAmount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CampaignSpendLimitV23Q1 - 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,) + spend_limit_type (str, none_type): [optional] # noqa: E501 + spend_limit_renewal (str, none_type): [optional] # noqa: E501 + spend_limit_amount (NillableDecimal): [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 + """CampaignSpendLimitV23Q1 - 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,) + spend_limit_type (str, none_type): [optional] # noqa: E501 + spend_limit_renewal (str, none_type): [optional] # noqa: E501 + spend_limit_amount (NillableDecimal): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1.py new file mode 100644 index 00000000..8c65447f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.campaign_spend_limit_v23_q1 import CampaignSpendLimitV23Q1 + globals()['CampaignSpendLimitV23Q1'] = CampaignSpendLimitV23Q1 + + +class CampaignV23Q1(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 = { + ('goal',): { + 'None': None, + 'UNSPECIFIED': "unspecified", + 'ACQUISITION': "acquisition", + 'RETENTION': "retention", + }, + } + + 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 { + 'name': (str, none_type,), # noqa: E501 + 'advertiser_id': (str, none_type,), # noqa: E501 + 'spend_limit': (CampaignSpendLimitV23Q1,), # noqa: E501 + 'goal': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'spend_limit': 'spendLimit', # noqa: E501 + 'goal': 'goal', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CampaignV23Q1 - 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): [optional] # noqa: E501 + advertiser_id (str, none_type): [optional] # noqa: E501 + spend_limit (CampaignSpendLimitV23Q1): [optional] # noqa: E501 + goal (str, 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 + """CampaignV23Q1 - 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): [optional] # noqa: E501 + advertiser_id (str, none_type): [optional] # noqa: E501 + spend_limit (CampaignSpendLimitV23Q1): [optional] # noqa: E501 + goal (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_list_response.py new file mode 100644 index 00000000..24418fe3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_resource import CampaignV23Q1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['CampaignV23Q1Resource'] = CampaignV23Q1Resource + globals()['CommonProblem'] = CommonProblem + + +class CampaignV23Q1ListResponse(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': ([CampaignV23Q1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CampaignV23Q1ListResponse - 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 ([CampaignV23Q1Resource], 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) + _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 + """CampaignV23Q1ListResponse - 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 ([CampaignV23Q1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_resource.py new file mode 100644 index 00000000..49fdc831 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1 import CampaignV23Q1 + globals()['CampaignV23Q1'] = CampaignV23Q1 + + +class CampaignV23Q1Resource(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 { + 'attributes': (CampaignV23Q1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CampaignV23Q1Resource - 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,) + attributes (CampaignV23Q1): [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 + """ + + _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 + """CampaignV23Q1Resource - 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,) + attributes (CampaignV23Q1): [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 + """ + + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_response.py new file mode 100644 index 00000000..e9394388 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/campaign_v23_q1_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_resource import CampaignV23Q1Resource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + globals()['CampaignV23Q1Resource'] = CampaignV23Q1Resource + globals()['CommonProblem'] = CommonProblem + + +class CampaignV23Q1Response(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': (CampaignV23Q1Resource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CampaignV23Q1Response - 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 (CampaignV23Q1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """CampaignV23Q1Response - 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 (CampaignV23Q1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/common_problem.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/common_problem.py new file mode 100644 index 00000000..eafc999a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/common_problem.py @@ -0,0 +1,306 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class CommonProblem(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'trace_identifier': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'trace_id': 'traceId', # noqa: E501 + 'trace_identifier': 'traceIdentifier', # noqa: E501 + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, 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 + """CommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1.py new file mode 100644 index 00000000..f1c1ed63 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ContactListStatisticsEntityV1(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 { + 'number_of_identifiers': (int, none_type,), # noqa: E501 + 'number_of_matches': (int, none_type,), # noqa: E501 + 'match_rate': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'number_of_identifiers': 'numberOfIdentifiers', # noqa: E501 + 'number_of_matches': 'numberOfMatches', # noqa: E501 + 'match_rate': 'matchRate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ContactListStatisticsEntityV1 - 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,) + number_of_identifiers (int, none_type): Number of identifiers in the contact list.. [optional] # noqa: E501 + number_of_matches (int, none_type): Number of matched identifiers in the contact list.. [optional] # noqa: E501 + match_rate (float, none_type): Percentage of matched identifiers in the contact list. Can differ from matches/identifiers depending on the contact list 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 + """ContactListStatisticsEntityV1 - 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,) + number_of_identifiers (int, none_type): Number of identifiers in the contact list.. [optional] # noqa: E501 + number_of_matches (int, none_type): Number of matched identifiers in the contact list.. [optional] # noqa: E501 + match_rate (float, none_type): Percentage of matched identifiers in the contact list. Can differ from matches/identifiers depending on the contact list 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1_resource.py new file mode 100644 index 00000000..7a012dde --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.contact_list_statistics_entity_v1 import ContactListStatisticsEntityV1 + globals()['ContactListStatisticsEntityV1'] = ContactListStatisticsEntityV1 + + +class ContactListStatisticsEntityV1Resource(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 { + 'attributes': (ContactListStatisticsEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ContactListStatisticsEntityV1Resource - 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,) + attributes (ContactListStatisticsEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """ContactListStatisticsEntityV1Resource - 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,) + attributes (ContactListStatisticsEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1_response.py new file mode 100644 index 00000000..c621343c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_statistics_entity_v1_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.contact_list_statistics_entity_v1_resource import ContactListStatisticsEntityV1Resource + globals()['CommonProblem'] = CommonProblem + globals()['ContactListStatisticsEntityV1Resource'] = ContactListStatisticsEntityV1Resource + + +class ContactListStatisticsEntityV1Response(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': (ContactListStatisticsEntityV1Resource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """ContactListStatisticsEntityV1Response - 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 (ContactListStatisticsEntityV1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """ContactListStatisticsEntityV1Response - 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 (ContactListStatisticsEntityV1Resource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_v1.py new file mode 100644 index 00000000..2564e533 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contact_list_v1.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ContactListV1(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 { + 'is_read_only': (bool, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'is_read_only': 'isReadOnly', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ContactListV1 - 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,) + is_read_only (bool, none_type): Is the segment read-only. [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 + """ContactListV1 - 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,) + is_read_only (bool, none_type): Is the segment read-only. [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment.py index e83b825a..943f155d 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.contactlist_amendment_attributes import ContactlistAmendmentAttributes + from criteo_api_marketingsolutions_v2024_04.model.contactlist_amendment_attributes import ContactlistAmendmentAttributes globals()['ContactlistAmendmentAttributes'] = ContactlistAmendmentAttributes diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment_attributes.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment_attributes.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment_attributes.py index 7e793c33..1f5d91f8 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment_attributes.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment_request.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment_request.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment_request.py index 69d20268..49ece916 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_amendment_request.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_amendment_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.contactlist_amendment import ContactlistAmendment + from criteo_api_marketingsolutions_v2024_04.model.contactlist_amendment import ContactlistAmendment globals()['ContactlistAmendment'] = ContactlistAmendment diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_operation.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_operation.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_operation.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_operation.py index 6b7d75ac..f5077f16 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_operation.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_operation.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.contactlist_operation_attributes import ContactlistOperationAttributes + from criteo_api_marketingsolutions_v2024_04.model.contactlist_operation_attributes import ContactlistOperationAttributes globals()['ContactlistOperationAttributes'] = ContactlistOperationAttributes diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_operation_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_operation_attributes.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_operation_attributes.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_operation_attributes.py index 150679d8..cfa2b4dd 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/contactlist_operation_attributes.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/contactlist_operation_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon.py new file mode 100644 index 00000000..5ff82a7c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon.py @@ -0,0 +1,323 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.image_slide import ImageSlide + globals()['ImageSlide'] = ImageSlide + + +class Coupon(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 = { + ('images',): { + }, + } + + @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 { + 'name': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'author': (str, none_type,), # noqa: E501 + 'advertiser_id': (str, none_type,), # noqa: E501 + 'ad_set_id': (str, none_type,), # noqa: E501 + 'landing_page_url': (str, none_type,), # noqa: E501 + 'start_date': (str, none_type,), # noqa: E501 + 'end_date': (str, none_type,), # noqa: E501 + 'format': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'images': ([ImageSlide], none_type,), # noqa: E501 + 'show_every': (int, none_type,), # noqa: E501 + 'show_duration': (int, none_type,), # noqa: E501 + 'rotations_number': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'author': 'author', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'ad_set_id': 'adSetId', # noqa: E501 + 'landing_page_url': 'landingPageUrl', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'format': 'format', # noqa: E501 + 'status': 'status', # noqa: E501 + 'images': 'images', # noqa: E501 + 'show_every': 'showEvery', # noqa: E501 + 'show_duration': 'showDuration', # noqa: E501 + 'rotations_number': 'rotationsNumber', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Coupon - 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): The name of the Coupon. [optional] # noqa: E501 + description (str, none_type): The description of the Coupon. [optional] # noqa: E501 + author (str, none_type): The login of the person who created this Coupon. [optional] # noqa: E501 + advertiser_id (str, none_type): Advertiser linked to the Coupon. [optional] # noqa: E501 + ad_set_id (str, none_type): The id of the Ad Set on which the Coupon is applied to. [optional] # noqa: E501 + landing_page_url (str, none_type): Web redirection of the landing page url. [optional] # noqa: E501 + start_date (str, none_type): The date when the Coupon will be launched String must be in ISO8601 format. [optional] # noqa: E501 + end_date (str, none_type): The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format. [optional] # noqa: E501 + format (str, none_type): Format of the Coupon, it can have two values: \"FullFrame\" or \"LogoZone\". [optional] # noqa: E501 + status (str, none_type): The status of the Coupon. [optional] # noqa: E501 + images ([ImageSlide], none_type): List of slides containing the image URLs. [optional] # noqa: E501 + show_every (int, none_type): Show the Coupon every N seconds (between 1 and 10). [optional] # noqa: E501 + show_duration (int, none_type): Show Coupon for a duration of N seconds (between 1 and 5). [optional] # noqa: E501 + rotations_number (int, none_type): Number of rotations for the Coupons (from 1 to 10 times). [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 + """Coupon - 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): The name of the Coupon. [optional] # noqa: E501 + description (str, none_type): The description of the Coupon. [optional] # noqa: E501 + author (str, none_type): The login of the person who created this Coupon. [optional] # noqa: E501 + advertiser_id (str, none_type): Advertiser linked to the Coupon. [optional] # noqa: E501 + ad_set_id (str, none_type): The id of the Ad Set on which the Coupon is applied to. [optional] # noqa: E501 + landing_page_url (str, none_type): Web redirection of the landing page url. [optional] # noqa: E501 + start_date (str, none_type): The date when the Coupon will be launched String must be in ISO8601 format. [optional] # noqa: E501 + end_date (str, none_type): The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format. [optional] # noqa: E501 + format (str, none_type): Format of the Coupon, it can have two values: \"FullFrame\" or \"LogoZone\". [optional] # noqa: E501 + status (str, none_type): The status of the Coupon. [optional] # noqa: E501 + images ([ImageSlide], none_type): List of slides containing the image URLs. [optional] # noqa: E501 + show_every (int, none_type): Show the Coupon every N seconds (between 1 and 10). [optional] # noqa: E501 + show_duration (int, none_type): Show Coupon for a duration of N seconds (between 1 and 5). [optional] # noqa: E501 + rotations_number (int, none_type): Number of rotations for the Coupons (from 1 to 10 times). [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_list_response.py new file mode 100644 index 00000000..2b06e482 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_list_response.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.coupon_resource import CouponResource + globals()['CommonProblem'] = CommonProblem + globals()['CouponResource'] = CouponResource + + +class CouponListResponse(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 = { + ('data',): { + }, + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': ([CouponResource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CouponListResponse - 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 ([CouponResource], 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) + _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 + """CouponListResponse - 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 ([CouponResource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_resource.py new file mode 100644 index 00000000..4cae0a4c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.coupon import Coupon + globals()['Coupon'] = Coupon + + +class CouponResource(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 { + 'attributes': (Coupon,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CouponResource - 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,) + attributes (Coupon): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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 + """CouponResource - 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,) + attributes (Coupon): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_response.py new file mode 100644 index 00000000..c8cb6e04 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_response.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.coupon_resource import CouponResource + globals()['CommonProblem'] = CommonProblem + globals()['CouponResource'] = CouponResource + + +class CouponResponse(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 = { + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': (CouponResource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CouponResponse - 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 (CouponResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """CouponResponse - 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 (CouponResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes.py new file mode 100644 index 00000000..cb91db85 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class CouponSupportedSizes(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 = { + ('logo_zone',): { + }, + ('full_frame',): { + }, + } + + @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 { + 'logo_zone': ([str], none_type,), # noqa: E501 + 'full_frame': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'logo_zone': 'logoZone', # noqa: E501 + 'full_frame': 'fullFrame', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CouponSupportedSizes - 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,) + logo_zone ([str], none_type): Array of LogoZone sizes as string in width x height format. [optional] # noqa: E501 + full_frame ([str], none_type): Array of FullFrame sizes as string in width x height format. [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 + """CouponSupportedSizes - 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,) + logo_zone ([str], none_type): Array of LogoZone sizes as string in width x height format. [optional] # noqa: E501 + full_frame ([str], none_type): Array of FullFrame sizes as string in width x height format. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes_resource.py new file mode 100644 index 00000000..4acd47f9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.coupon_supported_sizes import CouponSupportedSizes + globals()['CouponSupportedSizes'] = CouponSupportedSizes + + +class CouponSupportedSizesResource(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 { + 'attributes': (CouponSupportedSizes,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CouponSupportedSizesResource - 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,) + attributes (CouponSupportedSizes): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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 + """CouponSupportedSizesResource - 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,) + attributes (CouponSupportedSizes): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes_response.py new file mode 100644 index 00000000..125d94c8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/coupon_supported_sizes_response.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.coupon_supported_sizes_resource import CouponSupportedSizesResource + globals()['CommonProblem'] = CommonProblem + globals()['CouponSupportedSizesResource'] = CouponSupportedSizesResource + + +class CouponSupportedSizesResponse(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 = { + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': (CouponSupportedSizesResource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CouponSupportedSizesResponse - 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 (CouponSupportedSizesResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """CouponSupportedSizesResponse - 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 (CouponSupportedSizesResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set.py new file mode 100644 index 00000000..832f2706 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set.py @@ -0,0 +1,352 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_bidding import CreateAdSetBidding + from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_budget import CreateAdSetBudget + from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_schedule import CreateAdSetSchedule + from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_targeting import CreateAdSetTargeting + globals()['CreateAdSetBidding'] = CreateAdSetBidding + globals()['CreateAdSetBudget'] = CreateAdSetBudget + globals()['CreateAdSetSchedule'] = CreateAdSetSchedule + globals()['CreateAdSetTargeting'] = CreateAdSetTargeting + + +class CreateAdSet(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 = { + ('objective',): { + 'CUSTOMACTION': "customAction", + 'CLICKS': "clicks", + 'CONVERSIONS': "conversions", + 'DISPLAYS': "displays", + 'APPPROMOTION': "appPromotion", + 'REVENUE': "revenue", + 'STORECONVERSIONS': "storeConversions", + 'VALUE': "value", + 'REACH': "reach", + 'VISITS': "visits", + 'VIDEOVIEWS': "videoViews", + }, + ('media_type',): { + 'DISPLAY': "display", + 'VIDEO': "video", + }, + } + + 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 { + 'name': (str, none_type,), # noqa: E501 + 'dataset_id': (str, none_type,), # noqa: E501 + 'campaign_id': (str, none_type,), # noqa: E501 + 'objective': (str,), # noqa: E501 + 'schedule': (CreateAdSetSchedule,), # noqa: E501 + 'bidding': (CreateAdSetBidding,), # noqa: E501 + 'targeting': (CreateAdSetTargeting,), # noqa: E501 + 'budget': (CreateAdSetBudget,), # noqa: E501 + 'tracking_code': (str, none_type,), # noqa: E501 + 'media_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'dataset_id': 'datasetId', # noqa: E501 + 'campaign_id': 'campaignId', # noqa: E501 + 'objective': 'objective', # noqa: E501 + 'schedule': 'schedule', # noqa: E501 + 'bidding': 'bidding', # noqa: E501 + 'targeting': 'targeting', # noqa: E501 + 'budget': 'budget', # noqa: E501 + 'tracking_code': 'trackingCode', # noqa: E501 + 'media_type': 'mediaType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, dataset_id, campaign_id, objective, schedule, bidding, targeting, budget, tracking_code, media_type, *args, **kwargs): # noqa: E501 + """CreateAdSet - a model defined in OpenAPI + + Args: + name (str, none_type): Name of the ad set + dataset_id (str, none_type): Dataset id of this ad set + campaign_id (str, none_type): Campaign id this ad set belongs to + objective (str): Objective of the ad set + schedule (CreateAdSetSchedule): + bidding (CreateAdSetBidding): + targeting (CreateAdSetTargeting): + budget (CreateAdSetBudget): + tracking_code (str, none_type): The click tracking code associated to this Ad Set. + media_type (str): Media type for the ad set + + 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.name = name + self.dataset_id = dataset_id + self.campaign_id = campaign_id + self.objective = objective + self.schedule = schedule + self.bidding = bidding + self.targeting = targeting + self.budget = budget + self.tracking_code = tracking_code + self.media_type = media_type + 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, name, dataset_id, campaign_id, objective, schedule, bidding, targeting, budget, tracking_code, media_type, *args, **kwargs): # noqa: E501 + """CreateAdSet - a model defined in OpenAPI + + Args: + name (str, none_type): Name of the ad set + dataset_id (str, none_type): Dataset id of this ad set + campaign_id (str, none_type): Campaign id this ad set belongs to + objective (str): Objective of the ad set + schedule (CreateAdSetSchedule): + bidding (CreateAdSetBidding): + targeting (CreateAdSetTargeting): + budget (CreateAdSetBudget): + tracking_code (str, none_type): The click tracking code associated to this Ad Set. + media_type (str): Media type for the ad set + + 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.name = name + self.dataset_id = dataset_id + self.campaign_id = campaign_id + self.objective = objective + self.schedule = schedule + self.bidding = bidding + self.targeting = targeting + self.budget = budget + self.tracking_code = tracking_code + self.media_type = media_type + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_bidding.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_bidding.py new file mode 100644 index 00000000..ad1190d6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_bidding.py @@ -0,0 +1,283 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class CreateAdSetBidding(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 = { + ('cost_controller',): { + 'COS': "COS", + 'CPC': "CPC", + 'CPI': "CPI", + 'CPM': "CPM", + 'CPO': "CPO", + 'CPSV': "CPSV", + 'CPV': "CPV", + 'DAILYBUDGET': "dailyBudget", + }, + } + + 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 { + 'cost_controller': (str,), # noqa: E501 + 'bid_amount': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'cost_controller': 'costController', # noqa: E501 + 'bid_amount': 'bidAmount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, cost_controller, *args, **kwargs): # noqa: E501 + """CreateAdSetBidding - a model defined in OpenAPI + + Args: + cost_controller (str): How spend is controlled + + 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,) + bid_amount (float, none_type): Decimal value target relating to the `bidStrategy` specified. May be `null` for strategies that do not require a target value. At most 4 decimals are supported. Additional decimals are rounded.. [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.cost_controller = cost_controller + 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, cost_controller, *args, **kwargs): # noqa: E501 + """CreateAdSetBidding - a model defined in OpenAPI + + Args: + cost_controller (str): How spend is controlled + + 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,) + bid_amount (float, none_type): Decimal value target relating to the `bidStrategy` specified. May be `null` for strategies that do not require a target value. At most 4 decimals are supported. Additional decimals are rounded.. [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.cost_controller = cost_controller + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_budget.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_budget.py new file mode 100644 index 00000000..acb668cb --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_budget.py @@ -0,0 +1,312 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class CreateAdSetBudget(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 = { + ('budget_strategy',): { + 'CAPPED': "capped", + 'UNCAPPED': "uncapped", + }, + ('budget_renewal',): { + 'None': None, + 'UNDEFINED': "undefined", + 'DAILY': "daily", + 'MONTHLY': "monthly", + 'LIFETIME': "lifetime", + }, + ('budget_delivery_smoothing',): { + 'None': None, + 'ACCELERATED': "accelerated", + 'STANDARD': "standard", + }, + ('budget_delivery_week',): { + 'None': None, + 'UNDEFINED': "undefined", + 'MONDAYTOSUNDAY': "mondayToSunday", + 'TUESDAYTOMONDAY': "tuesdayToMonday", + 'WEDNESDAYTOTUESDAY': "wednesdayToTuesday", + 'THURSDAYTOWEDNESDAY': "thursdayToWednesday", + 'FRIDAYTOTHURSDAY': "fridayToThursday", + 'SATURDAYTOFRIDAY': "saturdayToFriday", + 'SUNDAYTOSATURDAY': "sundayToSaturday", + }, + } + + 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 { + 'budget_strategy': (str,), # 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': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'budget_strategy': 'budgetStrategy', # noqa: E501 + 'budget_renewal': 'budgetRenewal', # noqa: E501 + 'budget_delivery_smoothing': 'budgetDeliverySmoothing', # noqa: E501 + 'budget_delivery_week': 'budgetDeliveryWeek', # noqa: E501 + 'budget_amount': 'budgetAmount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, budget_strategy, *args, **kwargs): # noqa: E501 + """CreateAdSetBudget - a model defined in OpenAPI + + Args: + budget_strategy (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,) + 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 (float, 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.budget_strategy = budget_strategy + 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, budget_strategy, *args, **kwargs): # noqa: E501 + """CreateAdSetBudget - a model defined in OpenAPI + + Args: + budget_strategy (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,) + 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 (float, 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.budget_strategy = budget_strategy + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_geo_location.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_geo_location.py new file mode 100644 index 00000000..d3f4690b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_geo_location.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting_rule import AdSetTargetingRule + globals()['AdSetTargetingRule'] = AdSetTargetingRule + + +class CreateAdSetGeoLocation(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 { + 'countries': (AdSetTargetingRule,), # noqa: E501 + 'subdivisions': (AdSetTargetingRule,), # noqa: E501 + 'zip_codes': (AdSetTargetingRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'countries': 'countries', # noqa: E501 + 'subdivisions': 'subdivisions', # noqa: E501 + 'zip_codes': 'zipCodes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreateAdSetGeoLocation - 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,) + countries (AdSetTargetingRule): [optional] # noqa: E501 + subdivisions (AdSetTargetingRule): [optional] # noqa: E501 + zip_codes (AdSetTargetingRule): [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 + """CreateAdSetGeoLocation - 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,) + countries (AdSetTargetingRule): [optional] # noqa: E501 + subdivisions (AdSetTargetingRule): [optional] # noqa: E501 + zip_codes (AdSetTargetingRule): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_request.py new file mode 100644 index 00000000..7f448d3e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_resource import CreateAdSetResource + globals()['CreateAdSetResource'] = CreateAdSetResource + + +class CreateAdSetRequest(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': (CreateAdSetResource,), # 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 + """CreateAdSetRequest - 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 (CreateAdSetResource): [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 + """CreateAdSetRequest - 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 (CreateAdSetResource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_resource.py new file mode 100644 index 00000000..90029ae0 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_ad_set import CreateAdSet + globals()['CreateAdSet'] = CreateAdSet + + +class CreateAdSetResource(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 { + 'attributes': (CreateAdSet,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreateAdSetResource - 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,) + attributes (CreateAdSet): [optional] # noqa: E501 + type (str, none_type): Canonical type name of the entity. [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 + """CreateAdSetResource - 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,) + attributes (CreateAdSet): [optional] # noqa: E501 + type (str, none_type): Canonical type name of the entity. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_schedule.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_schedule.py new file mode 100644 index 00000000..ba8fe4a3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_schedule.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class CreateAdSetSchedule(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 { + 'start_date': (datetime,), # noqa: E501 + 'end_date': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, start_date, *args, **kwargs): # noqa: E501 + """CreateAdSetSchedule - a model defined in OpenAPI + + Args: + start_date (datetime): + + 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,) + end_date (datetime, 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.start_date = start_date + 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, start_date, *args, **kwargs): # noqa: E501 + """CreateAdSetSchedule - a model defined in OpenAPI + + Args: + start_date (datetime): + + 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,) + end_date (datetime, 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.start_date = start_date + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_targeting.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_targeting.py new file mode 100644 index 00000000..8a5d4192 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_ad_set_targeting.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_delivery_limitations import AdSetDeliveryLimitations + from criteo_api_marketingsolutions_v2024_04.model.ad_set_frequency_capping import AdSetFrequencyCapping + from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_geo_location import CreateAdSetGeoLocation + globals()['AdSetDeliveryLimitations'] = AdSetDeliveryLimitations + globals()['AdSetFrequencyCapping'] = AdSetFrequencyCapping + globals()['CreateAdSetGeoLocation'] = CreateAdSetGeoLocation + + +class CreateAdSetTargeting(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 { + 'frequency_capping': (AdSetFrequencyCapping,), # noqa: E501 + 'delivery_limitations': (AdSetDeliveryLimitations,), # noqa: E501 + 'geo_location': (CreateAdSetGeoLocation,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'frequency_capping': 'frequencyCapping', # noqa: E501 + 'delivery_limitations': 'deliveryLimitations', # noqa: E501 + 'geo_location': 'geoLocation', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, frequency_capping, *args, **kwargs): # noqa: E501 + """CreateAdSetTargeting - a model defined in OpenAPI + + Args: + frequency_capping (AdSetFrequencyCapping): + + 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,) + delivery_limitations (AdSetDeliveryLimitations): [optional] # noqa: E501 + geo_location (CreateAdSetGeoLocation): [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.frequency_capping = frequency_capping + 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, frequency_capping, *args, **kwargs): # noqa: E501 + """CreateAdSetTargeting - a model defined in OpenAPI + + Args: + frequency_capping (AdSetFrequencyCapping): + + 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,) + delivery_limitations (AdSetDeliveryLimitations): [optional] # noqa: E501 + geo_location (CreateAdSetGeoLocation): [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.frequency_capping = frequency_capping + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign.py new file mode 100644 index 00000000..e127fdeb --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign.py @@ -0,0 +1,298 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_campaign_spend_limit import CreateCampaignSpendLimit + globals()['CreateCampaignSpendLimit'] = CreateCampaignSpendLimit + + +class CreateCampaign(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 = { + ('goal',): { + 'UNSPECIFIED': "Unspecified", + 'ACQUISITION': "Acquisition", + 'RETENTION': "Retention", + }, + } + + 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 { + 'name': (str, none_type,), # noqa: E501 + 'advertiser_id': (str, none_type,), # noqa: E501 + 'goal': (str,), # noqa: E501 + 'spend_limit': (CreateCampaignSpendLimit,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'goal': 'goal', # noqa: E501 + 'spend_limit': 'spendLimit', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, advertiser_id, goal, spend_limit, *args, **kwargs): # noqa: E501 + """CreateCampaign - a model defined in OpenAPI + + Args: + name (str, none_type): Name of the campaign + advertiser_id (str, none_type): Advertiser id this campaign belongs to + goal (str): Goal for the marketing campaign + spend_limit (CreateCampaignSpendLimit): + + 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.name = name + self.advertiser_id = advertiser_id + self.goal = goal + self.spend_limit = spend_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, name, advertiser_id, goal, spend_limit, *args, **kwargs): # noqa: E501 + """CreateCampaign - a model defined in OpenAPI + + Args: + name (str, none_type): Name of the campaign + advertiser_id (str, none_type): Advertiser id this campaign belongs to + goal (str): Goal for the marketing campaign + spend_limit (CreateCampaignSpendLimit): + + 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.name = name + self.advertiser_id = advertiser_id + self.goal = goal + self.spend_limit = spend_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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_request.py new file mode 100644 index 00000000..2bd67cb7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_campaign_resource import CreateCampaignResource + globals()['CreateCampaignResource'] = CreateCampaignResource + + +class CreateCampaignRequest(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': (CreateCampaignResource,), # 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 + """CreateCampaignRequest - 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 (CreateCampaignResource): [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 + """CreateCampaignRequest - 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 (CreateCampaignResource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_resource.py new file mode 100644 index 00000000..a6d701d0 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_campaign import CreateCampaign + globals()['CreateCampaign'] = CreateCampaign + + +class CreateCampaignResource(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 { + 'attributes': (CreateCampaign,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreateCampaignResource - 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,) + attributes (CreateCampaign): [optional] # noqa: E501 + type (str, none_type): Canonical type name of the entity. [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 + """CreateCampaignResource - 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,) + attributes (CreateCampaign): [optional] # noqa: E501 + type (str, none_type): Canonical type name of the entity. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_spend_limit.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_spend_limit.py new file mode 100644 index 00000000..6908b9d5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_campaign_spend_limit.py @@ -0,0 +1,288 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class CreateCampaignSpendLimit(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 = { + ('spend_limit_type',): { + 'CAPPED': "capped", + 'UNCAPPED': "uncapped", + }, + ('spend_limit_renewal',): { + 'None': None, + 'UNDEFINED': "undefined", + 'DAILY': "daily", + 'MONTHLY': "monthly", + 'LIFETIME': "lifetime", + }, + } + + 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 { + 'spend_limit_type': (str,), # noqa: E501 + 'spend_limit_renewal': (str, none_type,), # noqa: E501 + 'spend_limit_amount': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'spend_limit_type': 'spendLimitType', # noqa: E501 + 'spend_limit_renewal': 'spendLimitRenewal', # noqa: E501 + 'spend_limit_amount': 'spendLimitAmount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, spend_limit_type, *args, **kwargs): # noqa: E501 + """CreateCampaignSpendLimit - a model defined in OpenAPI + + Args: + spend_limit_type (str): Whether your spend limit is capped or not + + 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,) + spend_limit_renewal (str, none_type): The pace of the spend limit renewal. [optional] # noqa: E501 + spend_limit_amount (float, none_type): The amount of the spend limit. null if spendLimitType is uncapped.. [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.spend_limit_type = spend_limit_type + 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, spend_limit_type, *args, **kwargs): # noqa: E501 + """CreateCampaignSpendLimit - a model defined in OpenAPI + + Args: + spend_limit_type (str): Whether your spend limit is capped or not + + 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,) + spend_limit_renewal (str, none_type): The pace of the spend limit renewal. [optional] # noqa: E501 + spend_limit_amount (float, none_type): The amount of the spend limit. null if spendLimitType is uncapped.. [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.spend_limit_type = spend_limit_type + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon.py new file mode 100644 index 00000000..67914823 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon.py @@ -0,0 +1,349 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_image_slide import CreateImageSlide + globals()['CreateImageSlide'] = CreateImageSlide + + +class CreateCoupon(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 = { + ('format',): { + 'FULLFRAME': "FullFrame", + 'LOGOZONE': "LogoZone", + }, + } + + validations = { + ('images',): { + }, + ('show_every',): { + 'inclusive_maximum': 10, + 'inclusive_minimum': 1, + }, + ('show_duration',): { + 'inclusive_maximum': 5, + 'inclusive_minimum': 1, + }, + ('rotations_number',): { + 'inclusive_maximum': 10, + 'inclusive_minimum': 1, + }, + } + + @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 { + 'name': (str,), # noqa: E501 + 'ad_set_id': (str,), # noqa: E501 + 'landing_page_url': (str,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'format': (str,), # noqa: E501 + 'images': ([CreateImageSlide],), # noqa: E501 + 'show_every': (int,), # noqa: E501 + 'show_duration': (int,), # noqa: E501 + 'rotations_number': (int,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'end_date': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'ad_set_id': 'adSetId', # noqa: E501 + 'landing_page_url': 'landingPageUrl', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'format': 'format', # noqa: E501 + 'images': 'images', # noqa: E501 + 'show_every': 'showEvery', # noqa: E501 + 'show_duration': 'showDuration', # noqa: E501 + 'rotations_number': 'rotationsNumber', # noqa: E501 + 'description': 'description', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, ad_set_id, landing_page_url, start_date, format, images, show_every, show_duration, rotations_number, *args, **kwargs): # noqa: E501 + """CreateCoupon - a model defined in OpenAPI + + Args: + name (str): The name of the Coupon + ad_set_id (str): The id of the Ad Set on which the Coupon is applied to + landing_page_url (str): Web redirection of the landing page url + start_date (str): The date when the coupon will be launched String must be in ISO8601 format + format (str): Format of the Coupon, it can have two values: \"FullFrame\" or \"LogoZone\" + images ([CreateImageSlide]): List of slides containing the images as a base-64 encoded string + show_every (int): Show the Coupon every N seconds (between 1 and 10) + show_duration (int): Show Coupon for a duration of N seconds (between 1 and 5) + rotations_number (int): Number of rotations for the Coupons (from 1 to 10 times) + + 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,) + description (str, none_type): The description of the Coupon. [optional] # noqa: E501 + end_date (str, none_type): The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format. [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.name = name + self.ad_set_id = ad_set_id + self.landing_page_url = landing_page_url + self.start_date = start_date + self.format = format + self.images = images + self.show_every = show_every + self.show_duration = show_duration + self.rotations_number = rotations_number + 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, name, ad_set_id, landing_page_url, start_date, format, images, show_every, show_duration, rotations_number, *args, **kwargs): # noqa: E501 + """CreateCoupon - a model defined in OpenAPI + + Args: + name (str): The name of the Coupon + ad_set_id (str): The id of the Ad Set on which the Coupon is applied to + landing_page_url (str): Web redirection of the landing page url + start_date (str): The date when the coupon will be launched String must be in ISO8601 format + format (str): Format of the Coupon, it can have two values: \"FullFrame\" or \"LogoZone\" + images ([CreateImageSlide]): List of slides containing the images as a base-64 encoded string + show_every (int): Show the Coupon every N seconds (between 1 and 10) + show_duration (int): Show Coupon for a duration of N seconds (between 1 and 5) + rotations_number (int): Number of rotations for the Coupons (from 1 to 10 times) + + 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,) + description (str, none_type): The description of the Coupon. [optional] # noqa: E501 + end_date (str, none_type): The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format. [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.name = name + self.ad_set_id = ad_set_id + self.landing_page_url = landing_page_url + self.start_date = start_date + self.format = format + self.images = images + self.show_every = show_every + self.show_duration = show_duration + self.rotations_number = rotations_number + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon_request.py new file mode 100644 index 00000000..d4c83612 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_coupon_resource import CreateCouponResource + globals()['CreateCouponResource'] = CreateCouponResource + + +class CreateCouponRequest(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': (CreateCouponResource,), # 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 + """CreateCouponRequest - 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 (CreateCouponResource): [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 + """CreateCouponRequest - 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 (CreateCouponResource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon_resource.py new file mode 100644 index 00000000..a380816f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_coupon_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.create_coupon import CreateCoupon + globals()['CreateCoupon'] = CreateCoupon + + +class CreateCouponResource(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 { + 'attributes': (CreateCoupon,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreateCouponResource - 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,) + attributes (CreateCoupon): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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 + """CreateCouponResource - 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,) + attributes (CreateCoupon): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_image_slide.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_image_slide.py new file mode 100644 index 00000000..c7ccd3df --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/create_image_slide.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class CreateImageSlide(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 = { + ('slide_base64_strings',): { + }, + } + + @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 { + 'width': (int, none_type,), # noqa: E501 + 'height': (int, none_type,), # noqa: E501 + 'slide_base64_strings': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'width': 'width', # noqa: E501 + 'height': 'height', # noqa: E501 + 'slide_base64_strings': 'slideBase64Strings', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreateImageSlide - 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,) + width (int, none_type): Width of the Coupon slide. [optional] # noqa: E501 + height (int, none_type): Height of the Coupon slide. [optional] # noqa: E501 + slide_base64_strings ([str], none_type): Array of images of the same size as a base-64 encoded string. [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 + """CreateImageSlide - 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,) + width (int, none_type): Width of the Coupon slide. [optional] # noqa: E501 + height (int, none_type): Height of the Coupon slide. [optional] # noqa: E501 + slide_base64_strings ([str], none_type): Array of images of the same size as a base-64 encoded string. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative.py new file mode 100644 index 00000000..7285cdd8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative.py @@ -0,0 +1,327 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.adaptive_attributes import AdaptiveAttributes + from criteo_api_marketingsolutions_v2024_04.model.dynamic_attributes import DynamicAttributes + from criteo_api_marketingsolutions_v2024_04.model.html_tag_attributes import HtmlTagAttributes + from criteo_api_marketingsolutions_v2024_04.model.image_attributes import ImageAttributes + globals()['AdaptiveAttributes'] = AdaptiveAttributes + globals()['DynamicAttributes'] = DynamicAttributes + globals()['HtmlTagAttributes'] = HtmlTagAttributes + globals()['ImageAttributes'] = ImageAttributes + + +class Creative(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 { + 'name': (str,), # noqa: E501 + 'author': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'advertiser_id': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'format': (str, none_type,), # noqa: E501 + 'dataset_id': (str, none_type,), # noqa: E501 + 'image_attributes': (ImageAttributes,), # noqa: E501 + 'html_tag_attributes': (HtmlTagAttributes,), # noqa: E501 + 'dynamic_attributes': (DynamicAttributes,), # noqa: E501 + 'adaptive_attributes': (AdaptiveAttributes,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'author': 'author', # noqa: E501 + 'status': 'status', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'format': 'format', # noqa: E501 + 'dataset_id': 'datasetId', # noqa: E501 + 'image_attributes': 'imageAttributes', # noqa: E501 + 'html_tag_attributes': 'htmlTagAttributes', # noqa: E501 + 'dynamic_attributes': 'dynamicAttributes', # noqa: E501 + 'adaptive_attributes': 'adaptiveAttributes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, author, status, advertiser_id, *args, **kwargs): # noqa: E501 + """Creative - a model defined in OpenAPI + + Args: + name (str): The name of the creative + author (str): The login of the person who created this creative ( + status (str): The status of the creative + advertiser_id (str): Advertiser linked to the Creative + + 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,) + description (str, none_type): The description of the creative. [optional] # noqa: E501 + format (str, none_type): The format of the creative. [optional] # noqa: E501 + dataset_id (str, none_type): Data set id linked to the Creative. [optional] # noqa: E501 + image_attributes (ImageAttributes): [optional] # noqa: E501 + html_tag_attributes (HtmlTagAttributes): [optional] # noqa: E501 + dynamic_attributes (DynamicAttributes): [optional] # noqa: E501 + adaptive_attributes (AdaptiveAttributes): [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.name = name + self.author = author + self.status = status + self.advertiser_id = advertiser_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, name, author, status, advertiser_id, *args, **kwargs): # noqa: E501 + """Creative - a model defined in OpenAPI + + Args: + name (str): The name of the creative + author (str): The login of the person who created this creative ( + status (str): The status of the creative + advertiser_id (str): Advertiser linked to the Creative + + 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,) + description (str, none_type): The description of the creative. [optional] # noqa: E501 + format (str, none_type): The format of the creative. [optional] # noqa: E501 + dataset_id (str, none_type): Data set id linked to the Creative. [optional] # noqa: E501 + image_attributes (ImageAttributes): [optional] # noqa: E501 + html_tag_attributes (HtmlTagAttributes): [optional] # noqa: E501 + dynamic_attributes (DynamicAttributes): [optional] # noqa: E501 + adaptive_attributes (AdaptiveAttributes): [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.name = name + self.author = author + self.status = status + self.advertiser_id = advertiser_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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_list_response.py new file mode 100644 index 00000000..52ed396d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_list_response.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.creative_resource import CreativeResource + globals()['CommonProblem'] = CommonProblem + globals()['CreativeResource'] = CreativeResource + + +class CreativeListResponse(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 = { + ('data',): { + }, + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': ([CreativeResource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CreativeListResponse - 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 ([CreativeResource], 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) + _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 + """CreativeListResponse - 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 ([CreativeResource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_resource.py new file mode 100644 index 00000000..c7fbc26d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.creative import Creative + globals()['Creative'] = Creative + + +class CreativeResource(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 { + 'attributes': (Creative,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreativeResource - 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,) + attributes (Creative): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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 + """CreativeResource - 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,) + attributes (Creative): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_response.py new file mode 100644 index 00000000..dca86546 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_response.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.creative_resource import CreativeResource + globals()['CommonProblem'] = CommonProblem + globals()['CreativeResource'] = CreativeResource + + +class CreativeResponse(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 = { + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': (CreativeResource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CreativeResponse - 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 (CreativeResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """CreativeResponse - 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 (CreativeResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write.py new file mode 100644 index 00000000..09f1560b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write.py @@ -0,0 +1,319 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.adaptive_write_attributes import AdaptiveWriteAttributes + from criteo_api_marketingsolutions_v2024_04.model.dynamic_write_attributes import DynamicWriteAttributes + from criteo_api_marketingsolutions_v2024_04.model.html_tag_write_attributes import HtmlTagWriteAttributes + from criteo_api_marketingsolutions_v2024_04.model.image_write_attributes import ImageWriteAttributes + globals()['AdaptiveWriteAttributes'] = AdaptiveWriteAttributes + globals()['DynamicWriteAttributes'] = DynamicWriteAttributes + globals()['HtmlTagWriteAttributes'] = HtmlTagWriteAttributes + globals()['ImageWriteAttributes'] = ImageWriteAttributes + + +class CreativeWrite(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 = { + ('format',): { + 'IMAGE': "Image", + 'HTMLTAG': "HtmlTag", + 'DYNAMIC': "Dynamic", + 'ADAPTIVE': "Adaptive", + }, + } + + 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 { + 'name': (str,), # noqa: E501 + 'format': (str,), # noqa: E501 + 'dataset_id': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'image_write_attributes': (ImageWriteAttributes,), # noqa: E501 + 'html_tag_write_attributes': (HtmlTagWriteAttributes,), # noqa: E501 + 'dynamic_write_attributes': (DynamicWriteAttributes,), # noqa: E501 + 'adaptive_write_attributes': (AdaptiveWriteAttributes,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'format': 'format', # noqa: E501 + 'dataset_id': 'datasetId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'image_write_attributes': 'imageWriteAttributes', # noqa: E501 + 'html_tag_write_attributes': 'htmlTagWriteAttributes', # noqa: E501 + 'dynamic_write_attributes': 'dynamicWriteAttributes', # noqa: E501 + 'adaptive_write_attributes': 'adaptiveWriteAttributes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, format, dataset_id, *args, **kwargs): # noqa: E501 + """CreativeWrite - a model defined in OpenAPI + + Args: + name (str): The name of the creative + format (str): The format of the creative You can use \"Image\", \" HtmlTag\", \"Dynamic\" or \"Adaptive\" + dataset_id (str): Dataset linked to the Creative + + 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,) + description (str, none_type): The description of the creative. [optional] # noqa: E501 + image_write_attributes (ImageWriteAttributes): [optional] # noqa: E501 + html_tag_write_attributes (HtmlTagWriteAttributes): [optional] # noqa: E501 + dynamic_write_attributes (DynamicWriteAttributes): [optional] # noqa: E501 + adaptive_write_attributes (AdaptiveWriteAttributes): [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.name = name + self.format = format + self.dataset_id = dataset_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, name, format, dataset_id, *args, **kwargs): # noqa: E501 + """CreativeWrite - a model defined in OpenAPI + + Args: + name (str): The name of the creative + format (str): The format of the creative You can use \"Image\", \" HtmlTag\", \"Dynamic\" or \"Adaptive\" + dataset_id (str): Dataset linked to the Creative + + 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,) + description (str, none_type): The description of the creative. [optional] # noqa: E501 + image_write_attributes (ImageWriteAttributes): [optional] # noqa: E501 + html_tag_write_attributes (HtmlTagWriteAttributes): [optional] # noqa: E501 + dynamic_write_attributes (DynamicWriteAttributes): [optional] # noqa: E501 + adaptive_write_attributes (AdaptiveWriteAttributes): [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.name = name + self.format = format + self.dataset_id = dataset_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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write_request.py new file mode 100644 index 00000000..44f9fbdf --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.creative_write_resource import CreativeWriteResource + globals()['CreativeWriteResource'] = CreativeWriteResource + + +class CreativeWriteRequest(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': (CreativeWriteResource,), # 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 + """CreativeWriteRequest - 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 (CreativeWriteResource): [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 + """CreativeWriteRequest - 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 (CreativeWriteResource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write_resource.py new file mode 100644 index 00000000..77b50538 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/creative_write_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.creative_write import CreativeWrite + globals()['CreativeWrite'] = CreativeWrite + + +class CreativeWriteResource(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 { + 'attributes': (CreativeWrite,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CreativeWriteResource - 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,) + attributes (CreativeWrite): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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 + """CreativeWriteResource - 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,) + attributes (CreativeWrite): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/criteo_api_error.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/criteo_api_error.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/criteo_api_error.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/criteo_api_error.py index 26c79d1a..8562b9d4 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/criteo_api_error.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/criteo_api_error.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/criteo_api_warning.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/criteo_api_warning.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/criteo_api_warning.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/criteo_api_warning.py index 0ca3d1ab..2ee96b96 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/criteo_api_warning.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/criteo_api_warning.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/delete_audience_contact_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/delete_audience_contact_list_response.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/delete_audience_contact_list_response.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/delete_audience_contact_list_response.py index 39acabae..860d91c5 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/delete_audience_contact_list_response.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/delete_audience_contact_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_error import AudienceError - from criteo_api_marketingsolutions_v2023_01.model.audience_warning import AudienceWarning - from criteo_api_marketingsolutions_v2023_01.model.basic_audience_definition import BasicAudienceDefinition + from criteo_api_marketingsolutions_v2024_04.model.audience_error import AudienceError + from criteo_api_marketingsolutions_v2024_04.model.audience_warning import AudienceWarning + from criteo_api_marketingsolutions_v2024_04.model.basic_audience_definition import BasicAudienceDefinition globals()['AudienceError'] = AudienceError globals()['AudienceWarning'] = AudienceWarning globals()['BasicAudienceDefinition'] = BasicAudienceDefinition diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/dynamic_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/dynamic_attributes.py new file mode 100644 index 00000000..e6d81d81 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/dynamic_attributes.py @@ -0,0 +1,302 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.image_shape import ImageShape + globals()['ImageShape'] = ImageShape + + +class DynamicAttributes(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 = { + ('product_image_display',): { + 'None': None, + 'SHOWFULLIMAGE': "ShowFullImage", + 'ZOOMONIMAGE': "ZoomOnImage", + }, + } + + validations = { + ('logos',): { + }, + ('calls_to_action',): { + }, + } + + @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 { + 'logos': ([ImageShape], none_type,), # noqa: E501 + 'creative_background_color': (str, none_type,), # noqa: E501 + 'body_text_color': (str, none_type,), # noqa: E501 + 'prices_color': (str, none_type,), # noqa: E501 + 'primary_font': (str, none_type,), # noqa: E501 + 'calls_to_action': ([str], none_type,), # noqa: E501 + 'product_image_display': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'logos': 'logos', # noqa: E501 + 'creative_background_color': 'creativeBackgroundColor', # noqa: E501 + 'body_text_color': 'bodyTextColor', # noqa: E501 + 'prices_color': 'pricesColor', # noqa: E501 + 'primary_font': 'primaryFont', # noqa: E501 + 'calls_to_action': 'callsToAction', # noqa: E501 + 'product_image_display': 'productImageDisplay', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DynamicAttributes - 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,) + logos ([ImageShape], none_type): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [optional] # noqa: E501 + creative_background_color (str, none_type): Color of the creative's background Valid hexadecimal color (e.g. \"AB00FF\"). [optional] # noqa: E501 + body_text_color (str, none_type): Color of the creative's body text Valid hexadecimal color (e.g. \"AB00FF\"). [optional] # noqa: E501 + prices_color (str, none_type): Color of the creative's prices Valid hexadecimal color (e.g. \"AB00FF\"). [optional] # noqa: E501 + primary_font (str, none_type): Font of the primary font Valid supported font like \"Arial\". [optional] # noqa: E501 + calls_to_action ([str], none_type): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”.. [optional] # noqa: E501 + product_image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your product catalog images should fit inside the allocated space (\"ShowFullImage\") or whether they should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping.. [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 + """DynamicAttributes - 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,) + logos ([ImageShape], none_type): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [optional] # noqa: E501 + creative_background_color (str, none_type): Color of the creative's background Valid hexadecimal color (e.g. \"AB00FF\"). [optional] # noqa: E501 + body_text_color (str, none_type): Color of the creative's body text Valid hexadecimal color (e.g. \"AB00FF\"). [optional] # noqa: E501 + prices_color (str, none_type): Color of the creative's prices Valid hexadecimal color (e.g. \"AB00FF\"). [optional] # noqa: E501 + primary_font (str, none_type): Font of the primary font Valid supported font like \"Arial\". [optional] # noqa: E501 + calls_to_action ([str], none_type): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”.. [optional] # noqa: E501 + product_image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your product catalog images should fit inside the allocated space (\"ShowFullImage\") or whether they should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping.. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/dynamic_write_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/dynamic_write_attributes.py new file mode 100644 index 00000000..26b2801d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/dynamic_write_attributes.py @@ -0,0 +1,308 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class DynamicWriteAttributes(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 = { + ('product_image_display',): { + 'SHOWFULLIMAGE': "ShowFullImage", + 'ZOOMONIMAGE': "ZoomOnImage", + }, + } + + validations = { + ('calls_to_action',): { + 'min_items': 1, + }, + } + + @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 { + 'logo_base64_string': (str,), # noqa: E501 + 'body_text_color': (str,), # noqa: E501 + 'prices_color': (str,), # noqa: E501 + 'calls_to_action': ([str],), # noqa: E501 + 'product_image_display': (str,), # noqa: E501 + 'creative_background_color': (str, none_type,), # noqa: E501 + 'primary_font': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'logo_base64_string': 'logoBase64String', # noqa: E501 + 'body_text_color': 'bodyTextColor', # noqa: E501 + 'prices_color': 'pricesColor', # noqa: E501 + 'calls_to_action': 'callsToAction', # noqa: E501 + 'product_image_display': 'productImageDisplay', # noqa: E501 + 'creative_background_color': 'creativeBackgroundColor', # noqa: E501 + 'primary_font': 'primaryFont', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, logo_base64_string, body_text_color, prices_color, calls_to_action, product_image_display, *args, **kwargs): # noqa: E501 + """DynamicWriteAttributes - a model defined in OpenAPI + + Args: + logo_base64_string (str): Logo image as a base-64 encoded string + body_text_color (str): Color of the creative's body text Valid hexadecimal RGB color (e.g. \"AB00FF\") + prices_color (str): Color of the creative's prices Valid hexadecimal RGB color (e.g. \"AB00FF\") + calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. + product_image_display (str): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your product catalog images should fit inside the allocated space (\"ShowFullImage\") or whether they should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping. + + 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,) + creative_background_color (str, none_type): Color of the creative's background Valid hexadecimal RGB color (e.g. \"AB00FF\"). [optional] # noqa: E501 + primary_font (str, none_type): Font of the primary font Valid supported font like \"Arial\". [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.logo_base64_string = logo_base64_string + self.body_text_color = body_text_color + self.prices_color = prices_color + self.calls_to_action = calls_to_action + self.product_image_display = product_image_display + 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, logo_base64_string, body_text_color, prices_color, calls_to_action, product_image_display, *args, **kwargs): # noqa: E501 + """DynamicWriteAttributes - a model defined in OpenAPI + + Args: + logo_base64_string (str): Logo image as a base-64 encoded string + body_text_color (str): Color of the creative's body text Valid hexadecimal RGB color (e.g. \"AB00FF\") + prices_color (str): Color of the creative's prices Valid hexadecimal RGB color (e.g. \"AB00FF\") + calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. + product_image_display (str): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your product catalog images should fit inside the allocated space (\"ShowFullImage\") or whether they should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping. + + 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,) + creative_background_color (str, none_type): Color of the creative's background Valid hexadecimal RGB color (e.g. \"AB00FF\"). [optional] # noqa: E501 + primary_font (str, none_type): Font of the primary font Valid supported font like \"Arial\". [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.logo_base64_string = logo_base64_string + self.body_text_color = body_text_color + self.prices_color = prices_color + self.calls_to_action = calls_to_action + self.product_image_display = product_image_display + 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/entity_of_portfolio_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/entity_of_portfolio_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/entity_of_portfolio_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/entity_of_portfolio_message.py index 3e092ef2..1745052f 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/entity_of_portfolio_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/entity_of_portfolio_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.portfolio_message import PortfolioMessage + from criteo_api_marketingsolutions_v2024_04.model.portfolio_message import PortfolioMessage globals()['PortfolioMessage'] = PortfolioMessage diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/error_code_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/error_code_response.py new file mode 100644 index 00000000..e6c521c9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/error_code_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.audience_error import AudienceError + from criteo_api_marketingsolutions_v2024_04.model.audience_warning import AudienceWarning + globals()['AudienceError'] = AudienceError + globals()['AudienceWarning'] = AudienceWarning + + +class ErrorCodeResponse(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 { + 'errors': ([AudienceError],), # noqa: E501 + 'warnings': ([AudienceWarning], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '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, errors, *args, **kwargs): # noqa: E501 + """ErrorCodeResponse - a model defined in OpenAPI + + Args: + errors ([AudienceError]): + + 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,) + warnings ([AudienceWarning], 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.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, errors, *args, **kwargs): # noqa: E501 + """ErrorCodeResponse - a model defined in OpenAPI + + Args: + errors ([AudienceError]): + + 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,) + warnings ([AudienceWarning], 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.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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/get_portfolio_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/get_portfolio_response.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/get_portfolio_response.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/get_portfolio_response.py index 2a128cf2..0ded986e 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/get_portfolio_response.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/get_portfolio_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.criteo_api_error import CriteoApiError - from criteo_api_marketingsolutions_v2023_01.model.criteo_api_warning import CriteoApiWarning - from criteo_api_marketingsolutions_v2023_01.model.entity_of_portfolio_message import EntityOfPortfolioMessage + from criteo_api_marketingsolutions_v2024_04.model.criteo_api_error import CriteoApiError + from criteo_api_marketingsolutions_v2024_04.model.criteo_api_warning import CriteoApiWarning + from criteo_api_marketingsolutions_v2024_04.model.entity_of_portfolio_message import EntityOfPortfolioMessage globals()['CriteoApiError'] = CriteoApiError globals()['CriteoApiWarning'] = CriteoApiWarning globals()['EntityOfPortfolioMessage'] = EntityOfPortfolioMessage diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/html_tag_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/html_tag_attributes.py new file mode 100644 index 00000000..14bb3648 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/html_tag_attributes.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.tag import Tag + globals()['Tag'] = Tag + + +class HtmlTagAttributes(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 = { + ('tags',): { + }, + } + + @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 { + 'tags': ([Tag], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """HtmlTagAttributes - 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,) + tags ([Tag], none_type): An array containing the html tags. [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 + """HtmlTagAttributes - 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,) + tags ([Tag], none_type): An array containing the html tags. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/html_tag_write_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/html_tag_write_attributes.py new file mode 100644 index 00000000..6a941793 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/html_tag_write_attributes.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.tag import Tag + globals()['Tag'] = Tag + + +class HtmlTagWriteAttributes(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 = { + ('tags',): { + }, + } + + @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 { + 'tags': ([Tag],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, tags, *args, **kwargs): # noqa: E501 + """HtmlTagWriteAttributes - a model defined in OpenAPI + + Args: + tags ([Tag]): An array containing the html tags + + 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.tags = tags + 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, tags, *args, **kwargs): # noqa: E501 + """HtmlTagWriteAttributes - a model defined in OpenAPI + + Args: + tags ([Tag]): An array containing the html tags + + 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.tags = tags + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_attributes.py new file mode 100644 index 00000000..482e8937 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_attributes.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ImageAttributes(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 = { + ('urls',): { + }, + } + + @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 { + 'urls': ([str], none_type,), # noqa: E501 + 'landing_page_url': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'urls': 'urls', # noqa: E501 + 'landing_page_url': 'landingPageUrl', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ImageAttributes - 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,) + urls ([str], none_type): Array of images uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [optional] # noqa: E501 + landing_page_url (str, none_type): Web redirection of the landing page url. [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 + """ImageAttributes - 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,) + urls ([str], none_type): Array of images uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [optional] # noqa: E501 + landing_page_url (str, none_type): Web redirection of the landing page url. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_set.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_set.py new file mode 100644 index 00000000..5bd40eee --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_set.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.image_shape import ImageShape + globals()['ImageShape'] = ImageShape + + +class ImageSet(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 = { + ('images',): { + }, + } + + @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 { + 'images': ([ImageShape],), # noqa: E501 + 'headline_text': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'images': 'images', # noqa: E501 + 'headline_text': 'headlineText', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, images, *args, **kwargs): # noqa: E501 + """ImageSet - a model defined in OpenAPI + + Args: + images ([ImageShape]): The images' urls with their shapes. + + 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,) + headline_text (str, none_type): The headline of the image set. [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.images = images + 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, images, *args, **kwargs): # noqa: E501 + """ImageSet - a model defined in OpenAPI + + Args: + images ([ImageShape]): The images' urls with their shapes. + + 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,) + headline_text (str, none_type): The headline of the image set. [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.images = images + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_set_base64.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_set_base64.py new file mode 100644 index 00000000..0f406e08 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_set_base64.py @@ -0,0 +1,276 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ImageSetBase64(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 = { + ('image_base64_strings',): { + 'min_items': 1, + }, + } + + @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 { + 'image_base64_strings': ([str],), # noqa: E501 + 'headline_text': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'image_base64_strings': 'imageBase64Strings', # noqa: E501 + 'headline_text': 'headlineText', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, image_base64_strings, *args, **kwargs): # noqa: E501 + """ImageSetBase64 - a model defined in OpenAPI + + Args: + image_base64_strings ([str]): Multiple images potentially in different shapes, each image is a base-64 encoded string. + + 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,) + headline_text (str, none_type): The headline of the image set. [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.image_base64_strings = image_base64_strings + 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, image_base64_strings, *args, **kwargs): # noqa: E501 + """ImageSetBase64 - a model defined in OpenAPI + + Args: + image_base64_strings ([str]): Multiple images potentially in different shapes, each image is a base-64 encoded string. + + 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,) + headline_text (str, none_type): The headline of the image set. [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.image_base64_strings = image_base64_strings + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_shape.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_shape.py new file mode 100644 index 00000000..52c96c0a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_shape.py @@ -0,0 +1,280 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ImageShape(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 = { + ('shape',): { + 'HORIZONTAL': "Horizontal", + 'VERTICAL': "Vertical", + 'SQUARE': "Square", + }, + } + + 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 { + 'shape': (str,), # noqa: E501 + 'url': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'shape': 'shape', # noqa: E501 + 'url': 'url', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, shape, url, *args, **kwargs): # noqa: E501 + """ImageShape - a model defined in OpenAPI + + Args: + shape (str): Ratio of the image + url (str): URL of the image uploaded on demostatic.criteo.com when deploying and then static.criteo.net + + 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.shape = shape + self.url = url + 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, shape, url, *args, **kwargs): # noqa: E501 + """ImageShape - a model defined in OpenAPI + + Args: + shape (str): Ratio of the image + url (str): URL of the image uploaded on demostatic.criteo.com when deploying and then static.criteo.net + + 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.shape = shape + self.url = url + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_slide.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_slide.py new file mode 100644 index 00000000..0441a222 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_slide.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ImageSlide(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 = { + ('slide_urls',): { + }, + } + + @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 { + 'width': (int, none_type,), # noqa: E501 + 'height': (int, none_type,), # noqa: E501 + 'slide_urls': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'width': 'width', # noqa: E501 + 'height': 'height', # noqa: E501 + 'slide_urls': 'slideUrls', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ImageSlide - 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,) + width (int, none_type): Width of the Coupon slide. [optional] # noqa: E501 + height (int, none_type): Height of the Coupon slide. [optional] # noqa: E501 + slide_urls ([str], none_type): Array of images of the same size uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [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 + """ImageSlide - 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,) + width (int, none_type): Width of the Coupon slide. [optional] # noqa: E501 + height (int, none_type): Height of the Coupon slide. [optional] # noqa: E501 + slide_urls ([str], none_type): Array of images of the same size uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_write_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_write_attributes.py new file mode 100644 index 00000000..84fb9c67 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/image_write_attributes.py @@ -0,0 +1,278 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ImageWriteAttributes(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 = { + ('base64_strings',): { + 'min_items': 1, + }, + } + + @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 { + 'base64_strings': ([str],), # noqa: E501 + 'landing_page_url': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'base64_strings': 'base64Strings', # noqa: E501 + 'landing_page_url': 'landingPageUrl', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, base64_strings, landing_page_url, *args, **kwargs): # noqa: E501 + """ImageWriteAttributes - a model defined in OpenAPI + + Args: + base64_strings ([str]): Array of images as a base-64 encoded string + landing_page_url (str): Web redirection of the landing page url + + 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.base64_strings = base64_strings + self.landing_page_url = landing_page_url + 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, base64_strings, landing_page_url, *args, **kwargs): # noqa: E501 + """ImageWriteAttributes - a model defined in OpenAPI + + Args: + base64_strings ([str]): Array of images as a base-64 encoded string + landing_page_url (str): Web redirection of the landing page url + + 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.base64_strings = base64_strings + self.landing_page_url = landing_page_url + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1.py new file mode 100644 index 00000000..a26ac593 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1.py @@ -0,0 +1,267 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class InMarketAudienceSegmentBrandEntityV1(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 + 'size': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'size': 'size', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InMarketAudienceSegmentBrandEntityV1 - 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 the in-market segment brand. [optional] # noqa: E501 + size (int, none_type): Size of the in-market segment brand. [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 + """InMarketAudienceSegmentBrandEntityV1 - 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 the in-market segment brand. [optional] # noqa: E501 + size (int, none_type): Size of the in-market segment brand. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1_list_response.py new file mode 100644 index 00000000..cbb12bd1 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_brand_entity_v1_resource import InMarketAudienceSegmentBrandEntityV1Resource + globals()['CommonProblem'] = CommonProblem + globals()['InMarketAudienceSegmentBrandEntityV1Resource'] = InMarketAudienceSegmentBrandEntityV1Resource + + +class InMarketAudienceSegmentBrandEntityV1ListResponse(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': ([InMarketAudienceSegmentBrandEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """InMarketAudienceSegmentBrandEntityV1ListResponse - 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 ([InMarketAudienceSegmentBrandEntityV1Resource], 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) + _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 + """InMarketAudienceSegmentBrandEntityV1ListResponse - 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 ([InMarketAudienceSegmentBrandEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1_resource.py new file mode 100644 index 00000000..4a88031c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_brand_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_brand_entity_v1 import InMarketAudienceSegmentBrandEntityV1 + globals()['InMarketAudienceSegmentBrandEntityV1'] = InMarketAudienceSegmentBrandEntityV1 + + +class InMarketAudienceSegmentBrandEntityV1Resource(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 { + 'attributes': (InMarketAudienceSegmentBrandEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InMarketAudienceSegmentBrandEntityV1Resource - 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,) + attributes (InMarketAudienceSegmentBrandEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """InMarketAudienceSegmentBrandEntityV1Resource - 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,) + attributes (InMarketAudienceSegmentBrandEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1.py new file mode 100644 index 00000000..31a2458b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class InMarketAudienceSegmentInterestEntityV1(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 { + 'parent_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'parent_id': 'parentId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InMarketAudienceSegmentInterestEntityV1 - 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,) + parent_id (str, none_type): Id of the parent in-market segment interest. [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 + """InMarketAudienceSegmentInterestEntityV1 - 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,) + parent_id (str, none_type): Id of the parent in-market segment interest. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1_list_response.py new file mode 100644 index 00000000..602c1cdb --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_interest_entity_v1_resource import InMarketAudienceSegmentInterestEntityV1Resource + globals()['CommonProblem'] = CommonProblem + globals()['InMarketAudienceSegmentInterestEntityV1Resource'] = InMarketAudienceSegmentInterestEntityV1Resource + + +class InMarketAudienceSegmentInterestEntityV1ListResponse(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': ([InMarketAudienceSegmentInterestEntityV1Resource], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """InMarketAudienceSegmentInterestEntityV1ListResponse - 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 ([InMarketAudienceSegmentInterestEntityV1Resource], 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) + _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 + """InMarketAudienceSegmentInterestEntityV1ListResponse - 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 ([InMarketAudienceSegmentInterestEntityV1Resource], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1_resource.py new file mode 100644 index 00000000..bd6a759c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_audience_segment_interest_entity_v1_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_interest_entity_v1 import InMarketAudienceSegmentInterestEntityV1 + globals()['InMarketAudienceSegmentInterestEntityV1'] = InMarketAudienceSegmentInterestEntityV1 + + +class InMarketAudienceSegmentInterestEntityV1Resource(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 { + 'attributes': (InMarketAudienceSegmentInterestEntityV1,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InMarketAudienceSegmentInterestEntityV1Resource - 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,) + attributes (InMarketAudienceSegmentInterestEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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 + """InMarketAudienceSegmentInterestEntityV1Resource - 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,) + attributes (InMarketAudienceSegmentInterestEntityV1): [optional] # noqa: E501 + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_create_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_create_v1.py new file mode 100644 index 00000000..7c610db9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_create_v1.py @@ -0,0 +1,315 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class InMarketCreateV1(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 = { + ('buying_power',): { + 'None': None, + 'LOW': "Low", + 'MEDIUM': "Medium", + 'HIGH': "High", + 'VERYHIGH': "VeryHigh", + }, + ('gender',): { + 'None': None, + 'MALE': "Male", + 'FEMALE': "Female", + }, + ('price_range',): { + 'None': None, + 'LOW': "Low", + 'MEDIUM': "Medium", + 'HIGH': "High", + }, + } + + validations = { + ('buying_power',): { + }, + ('interest_ids',): { + }, + ('brand_ids',): { + }, + ('price_range',): { + }, + } + + @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 { + 'country': (str,), # noqa: E501 + 'buying_power': ([str], none_type,), # noqa: E501 + 'gender': (str, none_type,), # noqa: E501 + 'interest_ids': ([str], none_type,), # noqa: E501 + 'brand_ids': ([str], none_type,), # noqa: E501 + 'price_range': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'country': 'country', # noqa: E501 + 'buying_power': 'buyingPower', # noqa: E501 + 'gender': 'gender', # noqa: E501 + 'interest_ids': 'interestIds', # noqa: E501 + 'brand_ids': 'brandIds', # noqa: E501 + 'price_range': 'priceRange', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, country, *args, **kwargs): # noqa: E501 + """InMarketCreateV1 - a model defined in OpenAPI + + Args: + country (str): Reach people of a specific country + + 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,) + buying_power ([str], none_type): Reach people who frequently purchase high price range items to lower price range items. [optional] # noqa: E501 + gender (str, none_type): Reach people who’ve shown interest in products made for a specific gender. [optional] # noqa: E501 + interest_ids ([str], none_type): Reach new people based on their interests. [optional] # noqa: E501 + brand_ids ([str], none_type): Choose the brands your segment might be interested in. [optional] # noqa: E501 + price_range ([str], none_type): Reach people who’ve shown interest in products within a specific price range. [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.country = country + 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, country, *args, **kwargs): # noqa: E501 + """InMarketCreateV1 - a model defined in OpenAPI + + Args: + country (str): Reach people of a specific country + + 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,) + buying_power ([str], none_type): Reach people who frequently purchase high price range items to lower price range items. [optional] # noqa: E501 + gender (str, none_type): Reach people who’ve shown interest in products made for a specific gender. [optional] # noqa: E501 + interest_ids ([str], none_type): Reach new people based on their interests. [optional] # noqa: E501 + brand_ids ([str], none_type): Choose the brands your segment might be interested in. [optional] # noqa: E501 + price_range ([str], none_type): Reach people who’ve shown interest in products within a specific price range. [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.country = country + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_size_estimation_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_size_estimation_v1.py new file mode 100644 index 00000000..cc13df7f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_size_estimation_v1.py @@ -0,0 +1,315 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class InMarketSizeEstimationV1(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 = { + ('buying_power',): { + 'None': None, + 'LOW': "Low", + 'MEDIUM': "Medium", + 'HIGH': "High", + 'VERYHIGH': "VeryHigh", + }, + ('gender',): { + 'None': None, + 'MALE': "Male", + 'FEMALE': "Female", + }, + ('price_range',): { + 'None': None, + 'LOW': "Low", + 'MEDIUM': "Medium", + 'HIGH': "High", + }, + } + + validations = { + ('buying_power',): { + }, + ('interest_ids',): { + }, + ('brand_ids',): { + }, + ('price_range',): { + }, + } + + @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 { + 'country': (str,), # noqa: E501 + 'buying_power': ([str], none_type,), # noqa: E501 + 'gender': (str, none_type,), # noqa: E501 + 'interest_ids': ([str], none_type,), # noqa: E501 + 'brand_ids': ([str], none_type,), # noqa: E501 + 'price_range': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'country': 'country', # noqa: E501 + 'buying_power': 'buyingPower', # noqa: E501 + 'gender': 'gender', # noqa: E501 + 'interest_ids': 'interestIds', # noqa: E501 + 'brand_ids': 'brandIds', # noqa: E501 + 'price_range': 'priceRange', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, country, *args, **kwargs): # noqa: E501 + """InMarketSizeEstimationV1 - a model defined in OpenAPI + + Args: + country (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,) + buying_power ([str], none_type): [optional] # noqa: E501 + gender (str, none_type): [optional] # noqa: E501 + interest_ids ([str], none_type): [optional] # noqa: E501 + brand_ids ([str], none_type): [optional] # noqa: E501 + price_range ([str], 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.country = country + 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, country, *args, **kwargs): # noqa: E501 + """InMarketSizeEstimationV1 - a model defined in OpenAPI + + Args: + country (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,) + buying_power ([str], none_type): [optional] # noqa: E501 + gender (str, none_type): [optional] # noqa: E501 + interest_ids ([str], none_type): [optional] # noqa: E501 + brand_ids ([str], none_type): [optional] # noqa: E501 + price_range ([str], 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.country = country + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_update_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_update_v1.py new file mode 100644 index 00000000..8647978e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_update_v1.py @@ -0,0 +1,310 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.nillable_gender_v1 import NillableGenderV1 + globals()['NillableGenderV1'] = NillableGenderV1 + + +class InMarketUpdateV1(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 = { + ('buying_power',): { + 'None': None, + 'LOW': "Low", + 'MEDIUM': "Medium", + 'HIGH': "High", + 'VERYHIGH': "VeryHigh", + }, + ('price_range',): { + 'None': None, + 'LOW': "Low", + 'MEDIUM': "Medium", + 'HIGH': "High", + }, + } + + validations = { + ('buying_power',): { + }, + ('interest_ids',): { + }, + ('brand_ids',): { + }, + ('price_range',): { + }, + } + + @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 { + 'country': (str, none_type,), # noqa: E501 + 'buying_power': ([str], none_type,), # noqa: E501 + 'gender': (NillableGenderV1,), # noqa: E501 + 'interest_ids': ([str], none_type,), # noqa: E501 + 'brand_ids': ([str], none_type,), # noqa: E501 + 'price_range': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'country': 'country', # noqa: E501 + 'buying_power': 'buyingPower', # noqa: E501 + 'gender': 'gender', # noqa: E501 + 'interest_ids': 'interestIds', # noqa: E501 + 'brand_ids': 'brandIds', # noqa: E501 + 'price_range': 'priceRange', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InMarketUpdateV1 - 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,) + country (str, none_type): Reach people of a specific country. [optional] # noqa: E501 + buying_power ([str], none_type): Reach people who frequently purchase high price range items to lower price range items. [optional] # noqa: E501 + gender (NillableGenderV1): [optional] # noqa: E501 + interest_ids ([str], none_type): Reach new people based on their interests. [optional] # noqa: E501 + brand_ids ([str], none_type): Choose the brands your segment might be interested in. [optional] # noqa: E501 + price_range ([str], none_type): Reach people who’ve shown interest in products within a specific price range. [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 + """InMarketUpdateV1 - 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,) + country (str, none_type): Reach people of a specific country. [optional] # noqa: E501 + buying_power ([str], none_type): Reach people who frequently purchase high price range items to lower price range items. [optional] # noqa: E501 + gender (NillableGenderV1): [optional] # noqa: E501 + interest_ids ([str], none_type): Reach new people based on their interests. [optional] # noqa: E501 + brand_ids ([str], none_type): Choose the brands your segment might be interested in. [optional] # noqa: E501 + price_range ([str], none_type): Reach people who’ve shown interest in products within a specific price range. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_v1.py new file mode 100644 index 00000000..d5a02037 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/in_market_v1.py @@ -0,0 +1,312 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class InMarketV1(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 = { + ('buying_power',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'LOW': "Low", + 'MEDIUM': "Medium", + 'HIGH': "High", + 'VERYHIGH': "VeryHigh", + }, + ('gender',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'MALE': "Male", + 'FEMALE': "Female", + }, + ('price_range',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'LOW': "Low", + 'MEDIUM': "Medium", + 'HIGH': "High", + }, + } + + validations = { + ('buying_power',): { + }, + ('interest_ids',): { + }, + ('brand_ids',): { + }, + ('price_range',): { + }, + } + + @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 { + 'country': (str, none_type,), # noqa: E501 + 'buying_power': ([str], none_type,), # noqa: E501 + 'gender': (str, none_type,), # noqa: E501 + 'interest_ids': ([str], none_type,), # noqa: E501 + 'brand_ids': ([str], none_type,), # noqa: E501 + 'price_range': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'country': 'country', # noqa: E501 + 'buying_power': 'buyingPower', # noqa: E501 + 'gender': 'gender', # noqa: E501 + 'interest_ids': 'interestIds', # noqa: E501 + 'brand_ids': 'brandIds', # noqa: E501 + 'price_range': 'priceRange', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InMarketV1 - 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,) + country (str, none_type): Reach people of a specific country. [optional] # noqa: E501 + buying_power ([str], none_type): Reach people who frequently purchase high price range items to lower price range items. [optional] # noqa: E501 + gender (str, none_type): Reach people who’ve shown interest in products made for a specific gender. [optional] # noqa: E501 + interest_ids ([str], none_type): Reach new people based on their interests. [optional] # noqa: E501 + brand_ids ([str], none_type): Choose the brands your segment might be interested in. [optional] # noqa: E501 + price_range ([str], none_type): Reach people who’ve shown interest in products within a specific price range. [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 + """InMarketV1 - 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,) + country (str, none_type): Reach people of a specific country. [optional] # noqa: E501 + buying_power ([str], none_type): Reach people who frequently purchase high price range items to lower price range items. [optional] # noqa: E501 + gender (str, none_type): Reach people who’ve shown interest in products made for a specific gender. [optional] # noqa: E501 + interest_ids ([str], none_type): Reach new people based on their interests. [optional] # noqa: E501 + brand_ids ([str], none_type): Choose the brands your segment might be interested in. [optional] # noqa: E501 + price_range ([str], none_type): Reach people who’ve shown interest in products within a specific price range. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_create_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_create_v1.py new file mode 100644 index 00000000..5beb6c94 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_create_v1.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.point_of_interest_v1 import PointOfInterestV1 + globals()['PointOfInterestV1'] = PointOfInterestV1 + + +class LocationCreateV1(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 { + 'points_of_interest': ([PointOfInterestV1],), # noqa: E501 + 'radius_in_km': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'points_of_interest': 'pointsOfInterest', # noqa: E501 + 'radius_in_km': 'radiusInKm', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, points_of_interest, radius_in_km, *args, **kwargs): # noqa: E501 + """LocationCreateV1 - a model defined in OpenAPI + + Args: + points_of_interest ([PointOfInterestV1]): Reach users which have been historically located in the given coordinates + radius_in_km (int): The expected maximum distance in kilometers between a user and a point of interest + + 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.points_of_interest = points_of_interest + self.radius_in_km = radius_in_km + 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, points_of_interest, radius_in_km, *args, **kwargs): # noqa: E501 + """LocationCreateV1 - a model defined in OpenAPI + + Args: + points_of_interest ([PointOfInterestV1]): Reach users which have been historically located in the given coordinates + radius_in_km (int): The expected maximum distance in kilometers between a user and a point of interest + + 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.points_of_interest = points_of_interest + self.radius_in_km = radius_in_km + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_size_estimation_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_size_estimation_v1.py new file mode 100644 index 00000000..a2829946 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_size_estimation_v1.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.point_of_interest_v1 import PointOfInterestV1 + globals()['PointOfInterestV1'] = PointOfInterestV1 + + +class LocationSizeEstimationV1(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 { + 'points_of_interest': ([PointOfInterestV1],), # noqa: E501 + 'radius_in_km': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'points_of_interest': 'pointsOfInterest', # noqa: E501 + 'radius_in_km': 'radiusInKm', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, points_of_interest, radius_in_km, *args, **kwargs): # noqa: E501 + """LocationSizeEstimationV1 - a model defined in OpenAPI + + Args: + points_of_interest ([PointOfInterestV1]): + radius_in_km (int): + + 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.points_of_interest = points_of_interest + self.radius_in_km = radius_in_km + 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, points_of_interest, radius_in_km, *args, **kwargs): # noqa: E501 + """LocationSizeEstimationV1 - a model defined in OpenAPI + + Args: + points_of_interest ([PointOfInterestV1]): + radius_in_km (int): + + 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.points_of_interest = points_of_interest + self.radius_in_km = radius_in_km + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_update_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_update_v1.py new file mode 100644 index 00000000..85650126 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_update_v1.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.point_of_interest_v1 import PointOfInterestV1 + globals()['PointOfInterestV1'] = PointOfInterestV1 + + +class LocationUpdateV1(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 = { + ('registry_type',): { + 'None': None, + 'POINTOFINTEREST': "PointOfInterest", + }, + } + + 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 { + 'points_of_interest': ([PointOfInterestV1], none_type,), # noqa: E501 + 'radius_in_km': (int, none_type,), # noqa: E501 + 'registry_type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'points_of_interest': 'pointsOfInterest', # noqa: E501 + 'radius_in_km': 'radiusInKm', # noqa: E501 + 'registry_type': 'registryType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LocationUpdateV1 - 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,) + points_of_interest ([PointOfInterestV1], none_type): Reach users which have been historically located in the given coordinates. [optional] # noqa: E501 + radius_in_km (int, none_type): Radius in kilometers. [optional] # noqa: E501 + registry_type (str, none_type): The kind of Location audience. [optional] if omitted the server will use the default value of "PointOfInterest" # 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 + """LocationUpdateV1 - 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,) + points_of_interest ([PointOfInterestV1], none_type): Reach users which have been historically located in the given coordinates. [optional] # noqa: E501 + radius_in_km (int, none_type): Radius in kilometers. [optional] # noqa: E501 + registry_type (str, none_type): The kind of Location audience. [optional] if omitted the server will use the default value of "PointOfInterest" # 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_v1.py new file mode 100644 index 00000000..83be9de4 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/location_v1.py @@ -0,0 +1,282 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.point_of_interest_v1 import PointOfInterestV1 + globals()['PointOfInterestV1'] = PointOfInterestV1 + + +class LocationV1(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 = { + ('registry_type',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'POINTOFINTEREST': "PointOfInterest", + }, + } + + 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 { + 'points_of_interest': ([PointOfInterestV1], none_type,), # noqa: E501 + 'radius_in_km': (int, none_type,), # noqa: E501 + 'registry_type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'points_of_interest': 'pointsOfInterest', # noqa: E501 + 'radius_in_km': 'radiusInKm', # noqa: E501 + 'registry_type': 'registryType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LocationV1 - 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,) + points_of_interest ([PointOfInterestV1], none_type): Reach users which have been historically located in the given coordinates. [optional] # noqa: E501 + radius_in_km (int, none_type): The expected maximum distance in kilometers between a user and a point of interest. [optional] # noqa: E501 + registry_type (str, none_type): The kind of Location audience. [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 + """LocationV1 - 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,) + points_of_interest ([PointOfInterestV1], none_type): Reach users which have been historically located in the given coordinates. [optional] # noqa: E501 + radius_in_km (int, none_type): The expected maximum distance in kilometers between a user and a point of interest. [optional] # noqa: E501 + registry_type (str, none_type): The kind of Location audience. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_create_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_create_v1.py new file mode 100644 index 00000000..d6f711a5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_create_v1.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class LookalikeCreateV1(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 { + 'seed_segment_id': (str,), # noqa: E501 + 'target_size': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'seed_segment_id': 'seedSegmentId', # noqa: E501 + 'target_size': 'targetSize', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, seed_segment_id, *args, **kwargs): # noqa: E501 + """LookalikeCreateV1 - a model defined in OpenAPI + + Args: + seed_segment_id (str): Segment from which the Lookalike segment will be generated + + 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,) + target_size (int, none_type): Desired size of the generated Lookalike segment. [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.seed_segment_id = seed_segment_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, seed_segment_id, *args, **kwargs): # noqa: E501 + """LookalikeCreateV1 - a model defined in OpenAPI + + Args: + seed_segment_id (str): Segment from which the Lookalike segment will be generated + + 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,) + target_size (int, none_type): Desired size of the generated Lookalike segment. [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.seed_segment_id = seed_segment_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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_update_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_update_v1.py new file mode 100644 index 00000000..9f484587 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_update_v1.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class LookalikeUpdateV1(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 { + 'target_size': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'target_size': 'targetSize', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LookalikeUpdateV1 - 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,) + target_size (int, none_type): Desired size of the generated Lookalike segment. [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 + """LookalikeUpdateV1 - 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,) + target_size (int, none_type): Desired size of the generated Lookalike segment. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_v1.py new file mode 100644 index 00000000..c812691b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/lookalike_v1.py @@ -0,0 +1,267 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class LookalikeV1(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 { + 'seed_segment_id': (str, none_type,), # noqa: E501 + 'target_size': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'seed_segment_id': 'seedSegmentId', # noqa: E501 + 'target_size': 'targetSize', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LookalikeV1 - 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,) + seed_segment_id (str, none_type): Segment from which the Lookalike segment will be generated. [optional] # noqa: E501 + target_size (int, none_type): Desired size of the generated Lookalike segment. [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 + """LookalikeV1 - 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,) + seed_segment_id (str, none_type): Segment from which the Lookalike segment will be generated. [optional] # noqa: E501 + target_size (int, none_type): Desired size of the generated Lookalike segment. [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/modify_audience_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/modify_audience_response.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/modify_audience_response.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/modify_audience_response.py index 43c4414b..9ffb34c5 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/modify_audience_response.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/modify_audience_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.audience_error import AudienceError - from criteo_api_marketingsolutions_v2023_01.model.audience_warning import AudienceWarning - from criteo_api_marketingsolutions_v2023_01.model.contactlist_operation import ContactlistOperation + from criteo_api_marketingsolutions_v2024_04.model.audience_error import AudienceError + from criteo_api_marketingsolutions_v2024_04.model.audience_warning import AudienceWarning + from criteo_api_marketingsolutions_v2024_04.model.contactlist_operation import ContactlistOperation globals()['AudienceError'] = AudienceError globals()['AudienceWarning'] = AudienceWarning globals()['ContactlistOperation'] = ContactlistOperation diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_ad_set_targeting_rule.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_ad_set_targeting_rule.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule.py index 8b0831d7..54979bcb 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_ad_set_targeting_rule.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_ad_set_targeting_rule_value import NillableAdSetTargetingRuleValue + from criteo_api_marketingsolutions_v2024_04.model.nillable_ad_set_targeting_rule_value import NillableAdSetTargetingRuleValue globals()['NillableAdSetTargetingRuleValue'] = NillableAdSetTargetingRuleValue diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_v23_q1.py new file mode 100644 index 00000000..8ab7fb76 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_v23_q1.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.nillable_ad_set_targeting_rule_v23_q1_value import NillableAdSetTargetingRuleV23Q1Value + globals()['NillableAdSetTargetingRuleV23Q1Value'] = NillableAdSetTargetingRuleV23Q1Value + + +class NillableAdSetTargetingRuleV23Q1(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 { + 'value': (NillableAdSetTargetingRuleV23Q1Value,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '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 + """NillableAdSetTargetingRuleV23Q1 - 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 (NillableAdSetTargetingRuleV23Q1Value): [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 + """NillableAdSetTargetingRuleV23Q1 - 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 (NillableAdSetTargetingRuleV23Q1Value): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_v23_q1_value.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_v23_q1_value.py new file mode 100644 index 00000000..a228947e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_v23_q1_value.py @@ -0,0 +1,329 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting_rule_v23_q1 import AdSetTargetingRuleV23Q1 + globals()['AdSetTargetingRuleV23Q1'] = AdSetTargetingRuleV23Q1 + + +class NillableAdSetTargetingRuleV23Q1Value(ModelComposed): + """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 = { + ('operand',): { + 'None': None, + 'UNDEFINED': "undefined", + 'IN': "in", + 'NOTIN': "notIn", + }, + } + + 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 = True + + @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 { + 'operand': (str, none_type,), # noqa: E501 + 'values': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'operand': 'operand', # noqa: E501 + 'values': 'values', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """NillableAdSetTargetingRuleV23Q1Value - 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,) + operand (str, none_type): [optional] # noqa: E501 + values ([str], 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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """NillableAdSetTargetingRuleV23Q1Value - 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,) + operand (str, none_type): [optional] # noqa: E501 + values ([str], 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + AdSetTargetingRuleV23Q1, + ], + 'oneOf': [ + ], + } diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_ad_set_targeting_rule_value.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_value.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_ad_set_targeting_rule_value.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_value.py index 3e310d89..fa6db914 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_ad_set_targeting_rule_value.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_ad_set_targeting_rule_value.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_targeting_rule import AdSetTargetingRule + from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting_rule import AdSetTargetingRule globals()['AdSetTargetingRule'] = AdSetTargetingRule diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_date_time.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_date_time.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_date_time.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_date_time.py index 20a01f69..9d1c8a3b 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_date_time.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_date_time.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_decimal.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_decimal.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_decimal.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_decimal.py index b96e9442..3dea745d 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/nillable_decimal.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_decimal.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_gender_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_gender_v1.py new file mode 100644 index 00000000..1658f59c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_gender_v1.py @@ -0,0 +1,268 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class NillableGenderV1(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 = { + ('value',): { + 'None': None, + 'MALE': "Male", + 'FEMALE': "Female", + }, + } + + 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': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '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 + """NillableGenderV1 - 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 (str, none_type): The value. If missing or null the value is set to \"null\". [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 + """NillableGenderV1 - 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 (str, none_type): The value. If missing or null the value is set to \"null\". [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_int32.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_int32.py new file mode 100644 index 00000000..a04dc7a2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_int32.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class NillableInt32(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': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '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 + """NillableInt32 - 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 (int, none_type): The value. If missing or null the value is set to \"null\". [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 + """NillableInt32 - 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 (int, none_type): The value. If missing or null the value is set to \"null\". [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_string.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_string.py new file mode 100644 index 00000000..d500eb3e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/nillable_string.py @@ -0,0 +1,263 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class NillableString(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': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '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 + """NillableString - 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 (str, none_type): The string's value. If missing or null the string's value is set to \"null\". [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 + """NillableString - 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 (str, none_type): The string's value. If missing or null the string's value is set to \"null\". [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set.py similarity index 96% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set.py index 5e597e5e..5d69efef 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,14 +26,14 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_targeting import AdSetTargeting - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_bidding import PatchAdSetBidding - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_budget import PatchAdSetBudget - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_scheduling import PatchAdSetScheduling + from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting import AdSetTargeting + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_bidding import PatchAdSetBidding + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_budget import PatchAdSetBudget + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_scheduling import PatchAdSetScheduling globals()['AdSetTargeting'] = AdSetTargeting globals()['PatchAdSetBidding'] = PatchAdSetBidding globals()['PatchAdSetBudget'] = PatchAdSetBudget diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_bidding.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_bidding.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_bidding.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_bidding.py index f76546c0..47780d61 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_bidding.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_bidding.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_decimal import NillableDecimal + from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal globals()['NillableDecimal'] = NillableDecimal diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_budget.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_budget.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_budget.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_budget.py index 58cbb489..72c32d0d 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_budget.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_budget.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_decimal import NillableDecimal + from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal globals()['NillableDecimal'] = NillableDecimal diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid.py index 521003f9..9cb6e83b 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_list_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_list_request.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_list_request.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_list_request.py index 0305ac25..90b2cc2c 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_list_request.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_list_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_resource import PatchAdSetCategoryBidResource + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_resource import PatchAdSetCategoryBidResource globals()['PatchAdSetCategoryBidResource'] = PatchAdSetCategoryBidResource diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_resource.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_resource.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_resource.py index f06dbd2c..bf6797a6 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_resource.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid import PatchAdSetCategoryBid + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid import PatchAdSetCategoryBid globals()['PatchAdSetCategoryBid'] = PatchAdSetCategoryBid diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_result_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_result_list_response.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_result_list_response.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_result_list_response.py index 4cc0c8f1..b5b19054 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_result_list_response.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_result_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_category_bid_result_resource import PatchAdSetCategoryBidResultResource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_result_resource import PatchAdSetCategoryBidResultResource globals()['CommonProblem'] = CommonProblem globals()['PatchAdSetCategoryBidResultResource'] = PatchAdSetCategoryBidResultResource diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_result_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_result_resource.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_result_resource.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_result_resource.py index 10fddd66..da3e6003 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_category_bid_result_resource.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_category_bid_result_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier.py index 5aa39ff2..04a1d9c3 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_list_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_list_request.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_list_request.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_list_request.py index 6e03d789..4b7363a5 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_list_request.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_list_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_resource import PatchAdSetDisplayMultiplierResource + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_resource import PatchAdSetDisplayMultiplierResource globals()['PatchAdSetDisplayMultiplierResource'] = PatchAdSetDisplayMultiplierResource diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_resource.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_resource.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_resource.py index fd1214e1..773a51ce 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_resource.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier import PatchAdSetDisplayMultiplier + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier import PatchAdSetDisplayMultiplier globals()['PatchAdSetDisplayMultiplier'] = PatchAdSetDisplayMultiplier diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_result_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_result_list_response.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_result_list_response.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_result_list_response.py index 4642f248..7b7374d6 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_result_list_response.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_result_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set_display_multiplier_result_resource import PatchAdSetDisplayMultiplierResultResource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_result_resource import PatchAdSetDisplayMultiplierResultResource globals()['CommonProblem'] = CommonProblem globals()['PatchAdSetDisplayMultiplierResultResource'] = PatchAdSetDisplayMultiplierResultResource diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_result_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_result_resource.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_result_resource.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_result_resource.py index b4e94b2c..534809a0 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_display_multiplier_result_resource.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_display_multiplier_result_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_scheduling.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_scheduling.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_scheduling.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_scheduling.py index 352796c2..5bced8b3 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_ad_set_scheduling.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_ad_set_scheduling.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_date_time import NillableDateTime + from criteo_api_marketingsolutions_v2024_04.model.nillable_date_time import NillableDateTime globals()['NillableDateTime'] = NillableDateTime diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign.py index 9d547775..75c63ebf 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.patch_campaign_spend_limit import PatchCampaignSpendLimit + from criteo_api_marketingsolutions_v2024_04.model.patch_campaign_spend_limit import PatchCampaignSpendLimit globals()['PatchCampaignSpendLimit'] = PatchCampaignSpendLimit diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_list_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_list_request.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_list_request.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_list_request.py index 275c255a..6381cbc7 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_list_request.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_list_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.patch_campaign_write_resource import PatchCampaignWriteResource + from criteo_api_marketingsolutions_v2024_04.model.patch_campaign_write_resource import PatchCampaignWriteResource globals()['PatchCampaignWriteResource'] = PatchCampaignWriteResource diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_spend_limit.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_spend_limit.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_spend_limit.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_spend_limit.py index 8d3b6590..4adbaaa4 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_spend_limit.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_spend_limit.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_decimal import NillableDecimal + from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal globals()['NillableDecimal'] = NillableDecimal diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_write_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_write_resource.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_write_resource.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_write_resource.py index 2ff63f60..849ff97f 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_campaign_write_resource.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_campaign_write_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.patch_campaign import PatchCampaign + from criteo_api_marketingsolutions_v2024_04.model.patch_campaign import PatchCampaign globals()['PatchCampaign'] = PatchCampaign diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_result_campaign_list_response.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_result_campaign_list_response.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_result_campaign_list_response.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_result_campaign_list_response.py index 05254c63..de503bde 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_result_campaign_list_response.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_result_campaign_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - from criteo_api_marketingsolutions_v2023_01.model.patch_result_campaign_read_resource import PatchResultCampaignReadResource + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.patch_result_campaign_read_resource import PatchResultCampaignReadResource globals()['CommonProblem'] = CommonProblem globals()['PatchResultCampaignReadResource'] = PatchResultCampaignReadResource diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_result_campaign_read_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_result_campaign_read_resource.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_result_campaign_read_resource.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_result_campaign_read_resource.py index 31a434ec..e757a54f 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/patch_result_campaign_read_resource.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/patch_result_campaign_read_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_data_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_data_message.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_data_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_data_message.py index cf2e912e..0678b2bf 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_data_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_data_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.placements_report_query_entity_message import PlacementsReportQueryEntityMessage + from criteo_api_marketingsolutions_v2024_04.model.placements_report_query_entity_message import PlacementsReportQueryEntityMessage globals()['PlacementsReportQueryEntityMessage'] = PlacementsReportQueryEntityMessage diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_entity_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_entity_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_entity_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_entity_message.py index 5aa14399..08830499 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_entity_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_entity_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.placements_report_query_message import PlacementsReportQueryMessage + from criteo_api_marketingsolutions_v2024_04.model.placements_report_query_message import PlacementsReportQueryMessage globals()['PlacementsReportQueryMessage'] = PlacementsReportQueryMessage diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_message.py index fac42cc1..675229c4 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/placements_report_query_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/placements_report_query_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/point_of_interest_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/point_of_interest_v1.py new file mode 100644 index 00000000..1b83f37c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/point_of_interest_v1.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class PointOfInterestV1(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 + 'latitude': (float, none_type,), # noqa: E501 + 'longitude': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'latitude': 'latitude', # noqa: E501 + 'longitude': 'longitude', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PointOfInterestV1 - 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 the point of interest. [optional] # noqa: E501 + latitude (float, none_type): ISO-6709 latitude (rounded at 5 decimals). [optional] # noqa: E501 + longitude (float, none_type): ISO-6709 longitude (rounded at 5 decimals). [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 + """PointOfInterestV1 - 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 the point of interest. [optional] # noqa: E501 + latitude (float, none_type): ISO-6709 latitude (rounded at 5 decimals). [optional] # noqa: E501 + longitude (float, none_type): ISO-6709 longitude (rounded at 5 decimals). [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/portfolio_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/portfolio_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/portfolio_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/portfolio_message.py index e85a7d75..51b22c7e 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/portfolio_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/portfolio_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/problem_details.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/problem_details.py new file mode 100644 index 00000000..d72a9f26 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/problem_details.py @@ -0,0 +1,306 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ProblemDetails(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'trace_identifier': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'trace_id': 'traceId', # noqa: E501 + 'trace_identifier': 'traceIdentifier', # noqa: E501 + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProblemDetails - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, 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 + """ProblemDetails - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/problems_details.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/problems_details.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/problems_details.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/problems_details.py index 0dd20caf..713dde42 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/problems_details.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/problems_details.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.problem_details import ProblemDetails + from criteo_api_marketingsolutions_v2024_04.model.problem_details import ProblemDetails globals()['ProblemDetails'] = ProblemDetails diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_create_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_create_v1.py new file mode 100644 index 00000000..962e31ab --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_create_v1.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ProspectingCreateV1(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 = { + ('users_type',): { + 'PROSPECTS': "Prospects", + 'PROSPECTSORNONBUYERS': "ProspectsOrNonBuyers", + }, + } + + 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 { + 'users_type': (str,), # noqa: E501 + 'days_since_last_visit_min': (int, none_type,), # noqa: E501 + 'days_since_last_visit_max': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'users_type': 'usersType', # noqa: E501 + 'days_since_last_visit_min': 'daysSinceLastVisitMin', # noqa: E501 + 'days_since_last_visit_max': 'daysSinceLastVisitMax', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, users_type, *args, **kwargs): # noqa: E501 + """ProspectingCreateV1 - a model defined in OpenAPI + + Args: + users_type (str): Type of users to target + + 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,) + days_since_last_visit_min (int, none_type): When non buyers are included, include users who visited your website before this number of days. [optional] # noqa: E501 + days_since_last_visit_max (int, none_type): When non buyers are included, include users who visited your website after this number of days. [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.users_type = users_type + 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, users_type, *args, **kwargs): # noqa: E501 + """ProspectingCreateV1 - a model defined in OpenAPI + + Args: + users_type (str): Type of users to target + + 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,) + days_since_last_visit_min (int, none_type): When non buyers are included, include users who visited your website before this number of days. [optional] # noqa: E501 + days_since_last_visit_max (int, none_type): When non buyers are included, include users who visited your website after this number of days. [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.users_type = users_type + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_update_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_update_v1.py new file mode 100644 index 00000000..6fe9eb28 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_update_v1.py @@ -0,0 +1,282 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.nillable_int32 import NillableInt32 + globals()['NillableInt32'] = NillableInt32 + + +class ProspectingUpdateV1(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 = { + ('users_type',): { + 'None': None, + 'PROSPECTS': "Prospects", + 'PROSPECTSORNONBUYERS': "ProspectsOrNonBuyers", + }, + } + + 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 { + 'days_since_last_visit_min': (NillableInt32,), # noqa: E501 + 'days_since_last_visit_max': (NillableInt32,), # noqa: E501 + 'users_type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'days_since_last_visit_min': 'daysSinceLastVisitMin', # noqa: E501 + 'days_since_last_visit_max': 'daysSinceLastVisitMax', # noqa: E501 + 'users_type': 'usersType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProspectingUpdateV1 - 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,) + days_since_last_visit_min (NillableInt32): [optional] # noqa: E501 + days_since_last_visit_max (NillableInt32): [optional] # noqa: E501 + users_type (str, none_type): Type of users to target. [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 + """ProspectingUpdateV1 - 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,) + days_since_last_visit_min (NillableInt32): [optional] # noqa: E501 + days_since_last_visit_max (NillableInt32): [optional] # noqa: E501 + users_type (str, none_type): Type of users to target. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_v1.py new file mode 100644 index 00000000..7f632382 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/prospecting_v1.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class ProspectingV1(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 = { + ('users_type',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'PROSPECTS': "Prospects", + 'PROSPECTSORNONBUYERS': "ProspectsOrNonBuyers", + }, + } + + 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 { + 'days_since_last_visit_min': (int, none_type,), # noqa: E501 + 'days_since_last_visit_max': (int, none_type,), # noqa: E501 + 'users_type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'days_since_last_visit_min': 'daysSinceLastVisitMin', # noqa: E501 + 'days_since_last_visit_max': 'daysSinceLastVisitMax', # noqa: E501 + 'users_type': 'usersType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProspectingV1 - 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,) + days_since_last_visit_min (int, none_type): When non buyers are included, include users who visited your website before this number of days. [optional] # noqa: E501 + days_since_last_visit_max (int, none_type): When non buyers are included, include users who visited your website after this number of days. [optional] # noqa: E501 + users_type (str, none_type): Type of users to target. [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 + """ProspectingV1 - 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,) + days_since_last_visit_min (int, none_type): When non buyers are included, include users who visited your website before this number of days. [optional] # noqa: E501 + days_since_last_visit_max (int, none_type): When non buyers are included, include users who visited your website after this number of days. [optional] # noqa: E501 + users_type (str, none_type): Type of users to target. [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set.py index ef82d474..256e29bf 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,14 +26,14 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.ad_set_targeting import AdSetTargeting - from criteo_api_marketingsolutions_v2023_01.model.read_ad_set_bidding import ReadAdSetBidding - from criteo_api_marketingsolutions_v2023_01.model.read_ad_set_budget import ReadAdSetBudget - from criteo_api_marketingsolutions_v2023_01.model.read_ad_set_schedule import ReadAdSetSchedule + from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting import AdSetTargeting + from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_bidding import ReadAdSetBidding + from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_budget import ReadAdSetBudget + from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_schedule import ReadAdSetSchedule globals()['AdSetTargeting'] = AdSetTargeting globals()['ReadAdSetBidding'] = ReadAdSetBidding globals()['ReadAdSetBudget'] = ReadAdSetBudget diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_bidding.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_bidding.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_bidding.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_bidding.py index a0ba1d25..c30288e1 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_bidding.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_bidding.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_decimal import NillableDecimal + from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal globals()['NillableDecimal'] = NillableDecimal diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_bidding_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_bidding_v23_q1.py new file mode 100644 index 00000000..e850cc05 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_bidding_v23_q1.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal + globals()['NillableDecimal'] = NillableDecimal + + +class ReadAdSetBiddingV23Q1(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 = { + ('cost_controller',): { + 'None': None, + 'COS': "COS", + 'CPC': "CPC", + 'CPI': "CPI", + 'CPM': "CPM", + 'CPO': "CPO", + 'CPSV': "CPSV", + 'CPV': "CPV", + 'DAILYBUDGET': "dailyBudget", + 'TARGETCPM': "targetCPM", + }, + } + + 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 { + 'bid_amount': (NillableDecimal,), # noqa: E501 + 'cost_controller': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'bid_amount': 'bidAmount', # noqa: E501 + 'cost_controller': 'costController', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ReadAdSetBiddingV23Q1 - 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,) + bid_amount (NillableDecimal): [optional] # noqa: E501 + cost_controller (str, none_type): How spend is controlled. [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 + """ReadAdSetBiddingV23Q1 - 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,) + bid_amount (NillableDecimal): [optional] # noqa: E501 + cost_controller (str, none_type): How spend is controlled. [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_budget.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_budget.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_budget.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_budget.py index 1d871109..61f57c4f 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_budget.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_budget.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_decimal import NillableDecimal + from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal globals()['NillableDecimal'] = NillableDecimal diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_budget_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_budget_v23_q1.py new file mode 100644 index 00000000..02a285a3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_budget_v23_q1.py @@ -0,0 +1,313 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal + globals()['NillableDecimal'] = NillableDecimal + + +class ReadAdSetBudgetV23Q1(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 = { + ('budget_strategy',): { + 'None': None, + 'CAPPED': "capped", + 'UNCAPPED': "uncapped", + }, + ('budget_renewal',): { + 'None': None, + 'UNDEFINED': "undefined", + 'DAILY': "daily", + 'MONTHLY': "monthly", + 'LIFETIME': "lifetime", + }, + ('budget_delivery_smoothing',): { + 'None': None, + 'ACCELERATED': "accelerated", + 'STANDARD': "standard", + }, + ('budget_delivery_week',): { + 'None': None, + 'UNDEFINED': "undefined", + 'MONDAYTOSUNDAY': "mondayToSunday", + 'TUESDAYTOMONDAY': "tuesdayToMonday", + 'WEDNESDAYTOTUESDAY': "wednesdayToTuesday", + 'THURSDAYTOWEDNESDAY': "thursdayToWednesday", + 'FRIDAYTOTHURSDAY': "fridayToThursday", + 'SATURDAYTOFRIDAY': "saturdayToFriday", + 'SUNDAYTOSATURDAY': "sundayToSaturday", + }, + } + + 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 { + '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 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'budget_strategy': 'budgetStrategy', # noqa: E501 + 'budget_renewal': 'budgetRenewal', # noqa: E501 + 'budget_delivery_smoothing': 'budgetDeliverySmoothing', # noqa: E501 + 'budget_delivery_week': 'budgetDeliveryWeek', # noqa: E501 + 'budget_amount': 'budgetAmount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ReadAdSetBudgetV23Q1 - 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,) + budget_strategy (str, none_type): [optional] # 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 + """ + + _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 + """ReadAdSetBudgetV23Q1 - 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,) + budget_strategy (str, none_type): [optional] # 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 + """ + + _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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_schedule.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_schedule.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_schedule.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_schedule.py index 303a90ae..97cf36fd 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_ad_set_schedule.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_schedule.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.nillable_date_time import NillableDateTime + from criteo_api_marketingsolutions_v2024_04.model.nillable_date_time import NillableDateTime globals()['NillableDateTime'] = NillableDateTime diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_schedule_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_schedule_v23_q1.py new file mode 100644 index 00000000..1440a70b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_schedule_v23_q1.py @@ -0,0 +1,299 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.nillable_date_time import NillableDateTime + globals()['NillableDateTime'] = NillableDateTime + + +class ReadAdSetScheduleV23Q1(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 = { + ('activation_status',): { + 'None': None, + 'ON': "on", + 'OFF': "off", + }, + ('delivery_status',): { + 'None': None, + 'DRAFT': "draft", + 'INACTIVE': "inactive", + 'LIVE': "live", + 'NOTLIVE': "notLive", + 'PAUSING': "pausing", + 'PAUSED': "paused", + 'SCHEDULED': "scheduled", + 'ENDED': "ended", + 'NOTDELIVERING': "notDelivering", + 'ARCHIVED': "archived", + }, + } + + 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 { + 'start_date': (NillableDateTime,), # noqa: E501 + 'end_date': (NillableDateTime,), # noqa: E501 + 'activation_status': (str, none_type,), # noqa: E501 + 'delivery_status': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'activation_status': 'activationStatus', # noqa: E501 + 'delivery_status': 'deliveryStatus', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ReadAdSetScheduleV23Q1 - 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,) + start_date (NillableDateTime): [optional] # noqa: E501 + end_date (NillableDateTime): [optional] # noqa: E501 + activation_status (str, none_type): [optional] # noqa: E501 + delivery_status (str, 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 + """ReadAdSetScheduleV23Q1 - 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,) + start_date (NillableDateTime): [optional] # noqa: E501 + end_date (NillableDateTime): [optional] # noqa: E501 + activation_status (str, none_type): [optional] # noqa: E501 + delivery_status (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_v23_q1.py new file mode 100644 index 00000000..819324fb --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_ad_set_v23_q1.py @@ -0,0 +1,349 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting_v23_q1 import AdSetTargetingV23Q1 + from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_bidding_v23_q1 import ReadAdSetBiddingV23Q1 + from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_budget_v23_q1 import ReadAdSetBudgetV23Q1 + from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_schedule_v23_q1 import ReadAdSetScheduleV23Q1 + globals()['AdSetTargetingV23Q1'] = AdSetTargetingV23Q1 + globals()['ReadAdSetBiddingV23Q1'] = ReadAdSetBiddingV23Q1 + globals()['ReadAdSetBudgetV23Q1'] = ReadAdSetBudgetV23Q1 + globals()['ReadAdSetScheduleV23Q1'] = ReadAdSetScheduleV23Q1 + + +class ReadAdSetV23Q1(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 = { + ('destination_environment',): { + 'None': None, + 'UNDEFINED': "undefined", + 'WEB': "web", + 'APP': "app", + }, + ('objective',): { + 'None': None, + 'CUSTOMACTION': "customAction", + 'CLICKS': "clicks", + 'CONVERSIONS': "conversions", + 'DISPLAYS': "displays", + 'APPPROMOTION': "appPromotion", + 'REVENUE': "revenue", + 'STORECONVERSIONS': "storeConversions", + 'VALUE': "value", + 'REACH': "reach", + 'VISITS': "visits", + 'VIDEOVIEWS': "videoViews", + }, + ('media_type',): { + 'None': None, + 'DISPLAY': "display", + 'VIDEO': "video", + }, + ('video_channel',): { + 'None': None, + 'OLV': "olv", + 'CTV': "ctv", + }, + } + + 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 { + 'name': (str, none_type,), # noqa: E501 + 'advertiser_id': (str, none_type,), # noqa: E501 + 'dataset_id': (str, none_type,), # noqa: E501 + 'campaign_id': (str, none_type,), # noqa: E501 + 'destination_environment': (str, none_type,), # noqa: E501 + 'objective': (str, none_type,), # noqa: E501 + 'schedule': (ReadAdSetScheduleV23Q1,), # noqa: E501 + 'bidding': (ReadAdSetBiddingV23Q1,), # noqa: E501 + 'targeting': (AdSetTargetingV23Q1,), # noqa: E501 + 'budget': (ReadAdSetBudgetV23Q1,), # noqa: E501 + 'media_type': (str, none_type,), # noqa: E501 + 'video_channel': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'advertiser_id': 'advertiserId', # noqa: E501 + 'dataset_id': 'datasetId', # noqa: E501 + 'campaign_id': 'campaignId', # noqa: E501 + 'destination_environment': 'destinationEnvironment', # noqa: E501 + 'objective': 'objective', # noqa: E501 + 'schedule': 'schedule', # noqa: E501 + 'bidding': 'bidding', # noqa: E501 + 'targeting': 'targeting', # noqa: E501 + 'budget': 'budget', # noqa: E501 + 'media_type': 'mediaType', # noqa: E501 + 'video_channel': 'videoChannel', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ReadAdSetV23Q1 - 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): [optional] # noqa: E501 + advertiser_id (str, none_type): [optional] # noqa: E501 + dataset_id (str, none_type): [optional] # noqa: E501 + campaign_id (str, none_type): [optional] # noqa: E501 + destination_environment (str, none_type): [optional] # noqa: E501 + objective (str, none_type): [optional] # noqa: E501 + schedule (ReadAdSetScheduleV23Q1): [optional] # noqa: E501 + bidding (ReadAdSetBiddingV23Q1): [optional] # noqa: E501 + targeting (AdSetTargetingV23Q1): [optional] # noqa: E501 + budget (ReadAdSetBudgetV23Q1): [optional] # noqa: E501 + media_type (str, none_type): [optional] # noqa: E501 + video_channel (str, 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 + """ReadAdSetV23Q1 - 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): [optional] # noqa: E501 + advertiser_id (str, none_type): [optional] # noqa: E501 + dataset_id (str, none_type): [optional] # noqa: E501 + campaign_id (str, none_type): [optional] # noqa: E501 + destination_environment (str, none_type): [optional] # noqa: E501 + objective (str, none_type): [optional] # noqa: E501 + schedule (ReadAdSetScheduleV23Q1): [optional] # noqa: E501 + bidding (ReadAdSetBiddingV23Q1): [optional] # noqa: E501 + targeting (AdSetTargetingV23Q1): [optional] # noqa: E501 + budget (ReadAdSetBudgetV23Q1): [optional] # noqa: E501 + media_type (str, none_type): [optional] # noqa: E501 + video_channel (str, 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_model_ad_set_id.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_ad_set_id.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_model_ad_set_id.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_ad_set_id.py index 54f9b1d8..6a7737a1 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_model_ad_set_id.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_ad_set_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_model_read_ad_set.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_read_ad_set.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_model_read_ad_set.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_read_ad_set.py index 6b958274..fdfde4f2 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/read_model_read_ad_set.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_read_ad_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.read_ad_set import ReadAdSet + from criteo_api_marketingsolutions_v2024_04.model.read_ad_set import ReadAdSet globals()['ReadAdSet'] = ReadAdSet diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_read_ad_set_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_read_ad_set_v23_q1.py new file mode 100644 index 00000000..3e30eba3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/read_model_read_ad_set_v23_q1.py @@ -0,0 +1,279 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_v23_q1 import ReadAdSetV23Q1 + globals()['ReadAdSetV23Q1'] = ReadAdSetV23Q1 + + +class ReadModelReadAdSetV23Q1(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (ReadAdSetV23Q1,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'type', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ReadModelReadAdSetV23Q1 - 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,) + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ReadAdSetV23Q1): [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 + """ReadModelReadAdSetV23Q1 - 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,) + id (str, none_type): Id of the entity. [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ReadAdSetV23Q1): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/requests_ad_set_id.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/requests_ad_set_id.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/requests_ad_set_id.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/requests_ad_set_id.py index c467f4e3..bddb4806 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/requests_ad_set_id.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/requests_ad_set_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.write_model_ad_set_id import WriteModelAdSetId + from criteo_api_marketingsolutions_v2024_04.model.write_model_ad_set_id import WriteModelAdSetId globals()['WriteModelAdSetId'] = WriteModelAdSetId diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/requests_patch_ad_set.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/requests_patch_ad_set.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/requests_patch_ad_set.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/requests_patch_ad_set.py index 60cb54f9..9f955190 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/requests_patch_ad_set.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/requests_patch_ad_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.write_model_patch_ad_set import WriteModelPatchAdSet + from criteo_api_marketingsolutions_v2024_04.model.write_model_patch_ad_set import WriteModelPatchAdSet globals()['WriteModelPatchAdSet'] = WriteModelPatchAdSet diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/response_read_ad_set.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/response_read_ad_set.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/response_read_ad_set.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/response_read_ad_set.py index 79870337..3debc3ed 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/response_read_ad_set.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/response_read_ad_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - from criteo_api_marketingsolutions_v2023_01.model.read_model_read_ad_set import ReadModelReadAdSet + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.read_model_read_ad_set import ReadModelReadAdSet globals()['CommonProblem'] = CommonProblem globals()['ReadModelReadAdSet'] = ReadModelReadAdSet diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/response_read_ad_set_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/response_read_ad_set_v23_q1.py new file mode 100644 index 00000000..62d3d1de --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/response_read_ad_set_v23_q1.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.read_model_read_ad_set_v23_q1 import ReadModelReadAdSetV23Q1 + globals()['CommonProblem'] = CommonProblem + globals()['ReadModelReadAdSetV23Q1'] = ReadModelReadAdSetV23Q1 + + +class ResponseReadAdSetV23Q1(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': (ReadModelReadAdSetV23Q1,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """ResponseReadAdSetV23Q1 - 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 (ReadModelReadAdSetV23Q1): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """ResponseReadAdSetV23Q1 - 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 (ReadModelReadAdSetV23Q1): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/responses_ad_set_id.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/responses_ad_set_id.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/responses_ad_set_id.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/responses_ad_set_id.py index cb13f1f7..475af500 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/responses_ad_set_id.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/responses_ad_set_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.common_problem import CommonProblem - from criteo_api_marketingsolutions_v2023_01.model.read_model_ad_set_id import ReadModelAdSetId + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.read_model_ad_set_id import ReadModelAdSetId globals()['CommonProblem'] = CommonProblem globals()['ReadModelAdSetId'] = ReadModelAdSetId diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/responses_read_ad_set_v23_q1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/responses_read_ad_set_v23_q1.py new file mode 100644 index 00000000..eaef5786 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/responses_read_ad_set_v23_q1.py @@ -0,0 +1,282 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem + from criteo_api_marketingsolutions_v2024_04.model.read_model_read_ad_set_v23_q1 import ReadModelReadAdSetV23Q1 + globals()['CommonProblem'] = CommonProblem + globals()['ReadModelReadAdSetV23Q1'] = ReadModelReadAdSetV23Q1 + + +class ResponsesReadAdSetV23Q1(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': ([ReadModelReadAdSetV23Q1], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 = { + 'data', # noqa: E501 + 'warnings', # noqa: E501 + 'errors', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResponsesReadAdSetV23Q1 - 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 ([ReadModelReadAdSetV23Q1], 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) + _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 + """ResponsesReadAdSetV23Q1 - 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 ([ReadModelReadAdSetV23Q1], 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) + _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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_create_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_create_v1.py new file mode 100644 index 00000000..a9c8ec54 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_create_v1.py @@ -0,0 +1,286 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class RetargetingCreateV1(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 = { + ('visitors_type',): { + 'ALL': "All", + 'BUYERS': "Buyers", + 'NONBUYERS': "NonBuyers", + }, + } + + 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 { + 'visitors_type': (str,), # noqa: E501 + 'days_since_last_visit_min': (int,), # noqa: E501 + 'days_since_last_visit_max': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'visitors_type': 'visitorsType', # noqa: E501 + 'days_since_last_visit_min': 'daysSinceLastVisitMin', # noqa: E501 + 'days_since_last_visit_max': 'daysSinceLastVisitMax', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, visitors_type, days_since_last_visit_min, days_since_last_visit_max, *args, **kwargs): # noqa: E501 + """RetargetingCreateV1 - a model defined in OpenAPI + + Args: + visitors_type (str): Types of visitors. + days_since_last_visit_min (int): Minimum number of days since last visit to partner. + days_since_last_visit_max (int): Maximum number of days since last visit to partner. + + 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.visitors_type = visitors_type + self.days_since_last_visit_min = days_since_last_visit_min + self.days_since_last_visit_max = days_since_last_visit_max + 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, visitors_type, days_since_last_visit_min, days_since_last_visit_max, *args, **kwargs): # noqa: E501 + """RetargetingCreateV1 - a model defined in OpenAPI + + Args: + visitors_type (str): Types of visitors. + days_since_last_visit_min (int): Minimum number of days since last visit to partner. + days_since_last_visit_max (int): Maximum number of days since last visit to partner. + + 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.visitors_type = visitors_type + self.days_since_last_visit_min = days_since_last_visit_min + self.days_since_last_visit_max = days_since_last_visit_max + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_update_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_update_v1.py new file mode 100644 index 00000000..2b24d8bf --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_update_v1.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class RetargetingUpdateV1(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 = { + ('visitors_type',): { + 'None': None, + 'ALL': "All", + 'BUYERS': "Buyers", + 'NONBUYERS': "NonBuyers", + }, + } + + 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 { + 'visitors_type': (str, none_type,), # noqa: E501 + 'days_since_last_visit_min': (int, none_type,), # noqa: E501 + 'days_since_last_visit_max': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'visitors_type': 'visitorsType', # noqa: E501 + 'days_since_last_visit_min': 'daysSinceLastVisitMin', # noqa: E501 + 'days_since_last_visit_max': 'daysSinceLastVisitMax', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RetargetingUpdateV1 - 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,) + visitors_type (str, none_type): Types of visitors.. [optional] # noqa: E501 + days_since_last_visit_min (int, none_type): Minimum number of days since last visit to partner.. [optional] # noqa: E501 + days_since_last_visit_max (int, none_type): Maximum number of days since last visit to partner.. [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 + """RetargetingUpdateV1 - 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,) + visitors_type (str, none_type): Types of visitors.. [optional] # noqa: E501 + days_since_last_visit_min (int, none_type): Minimum number of days since last visit to partner.. [optional] # noqa: E501 + days_since_last_visit_max (int, none_type): Maximum number of days since last visit to partner.. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_v1.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_v1.py new file mode 100644 index 00000000..9e954c73 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/retargeting_v1.py @@ -0,0 +1,278 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class RetargetingV1(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 = { + ('visitors_type',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'ALL': "All", + 'BUYERS': "Buyers", + 'NONBUYERS': "NonBuyers", + }, + } + + 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 { + 'visitors_type': (str, none_type,), # noqa: E501 + 'days_since_last_visit_min': (int, none_type,), # noqa: E501 + 'days_since_last_visit_max': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'visitors_type': 'visitorsType', # noqa: E501 + 'days_since_last_visit_min': 'daysSinceLastVisitMin', # noqa: E501 + 'days_since_last_visit_max': 'daysSinceLastVisitMax', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RetargetingV1 - 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,) + visitors_type (str, none_type): Types of visitors.. [optional] # noqa: E501 + days_since_last_visit_min (int, none_type): Minimum number of days since last visit to partner.. [optional] # noqa: E501 + days_since_last_visit_max (int, none_type): Maximum number of days since last visit to partner.. [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 + """RetargetingV1 - 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,) + visitors_type (str, none_type): Types of visitors.. [optional] # noqa: E501 + days_since_last_visit_min (int, none_type): Minimum number of days since last visit to partner.. [optional] # noqa: E501 + days_since_last_visit_max (int, none_type): Maximum number of days since last visit to partner.. [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/size.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/size.py new file mode 100644 index 00000000..82156c9e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/size.py @@ -0,0 +1,267 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class Size(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 { + 'width': (int, none_type,), # noqa: E501 + 'height': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'width': 'width', # noqa: E501 + 'height': 'height', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Size - 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,) + width (int, none_type): [optional] # noqa: E501 + height (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 + """Size - 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,) + width (int, none_type): [optional] # noqa: E501 + height (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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/statistics_report_query_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/statistics_report_query_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/statistics_report_query_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/statistics_report_query_message.py index b4a9c433..ded0ea1f 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/statistics_report_query_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/statistics_report_query_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/tag.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/tag.py new file mode 100644 index 00000000..c8e1fed7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/tag.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.size import Size + globals()['Size'] = Size + + +class Tag(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 { + 'html_tag': (str, none_type,), # noqa: E501 + 'size': (Size,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'html_tag': 'htmlTag', # noqa: E501 + 'size': 'size', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Tag - 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,) + html_tag (str, none_type): Html tag. [optional] # noqa: E501 + size (Size): [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 + """Tag - 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,) + html_tag (str, none_type): Html tag. [optional] # noqa: E501 + size (Size): [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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_data_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_data_message.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_data_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_data_message.py index 1aaa5bac..ba817e61 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_data_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_data_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.transactions_report_query_entity_message import TransactionsReportQueryEntityMessage + from criteo_api_marketingsolutions_v2024_04.model.transactions_report_query_entity_message import TransactionsReportQueryEntityMessage globals()['TransactionsReportQueryEntityMessage'] = TransactionsReportQueryEntityMessage diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_entity_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_entity_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_entity_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_entity_message.py index f4023643..269e55e0 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_entity_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_entity_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.transactions_report_query_message import TransactionsReportQueryMessage + from criteo_api_marketingsolutions_v2024_04.model.transactions_report_query_message import TransactionsReportQueryMessage globals()['TransactionsReportQueryMessage'] = TransactionsReportQueryMessage diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_message.py index f3ec3cb7..198a87f9 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transactions_report_query_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transactions_report_query_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_query_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_query_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_query_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_query_message.py index 3ce98204..375f3ff8 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_query_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_query_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_attributes.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_attributes.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_attributes.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_attributes.py index 320027bb..fb6c6c91 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_attributes.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.transparency_report_file import TransparencyReportFile + from criteo_api_marketingsolutions_v2024_04.model.transparency_report_file import TransparencyReportFile globals()['TransparencyReportFile'] = TransparencyReportFile diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_data_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_data_message.py similarity index 97% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_data_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_data_message.py index a7a358f7..3755af0f 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_data_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_data_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.transparency_report_entity_message import TransparencyReportEntityMessage + from criteo_api_marketingsolutions_v2024_04.model.transparency_report_entity_message import TransparencyReportEntityMessage globals()['TransparencyReportEntityMessage'] = TransparencyReportEntityMessage diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_entity_message.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_entity_message.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_entity_message.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_entity_message.py index 7577c7a1..dca2acfb 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_entity_message.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_entity_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.transparency_report_attributes import TransparencyReportAttributes + from criteo_api_marketingsolutions_v2024_04.model.transparency_report_attributes import TransparencyReportAttributes globals()['TransparencyReportAttributes'] = TransparencyReportAttributes diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_file.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_file.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_file.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_file.py index aef0d2c3..c0da11ed 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/transparency_report_file.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/transparency_report_file.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon.py new file mode 100644 index 00000000..9f107363 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class UpdateCoupon(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 { + 'start_date': (str,), # noqa: E501 + 'end_date': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, start_date, *args, **kwargs): # noqa: E501 + """UpdateCoupon - a model defined in OpenAPI + + Args: + start_date (str): The date when the Coupon will be launched String must be in ISO8601 format + + 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,) + end_date (str, none_type): The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format. [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.start_date = start_date + 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, start_date, *args, **kwargs): # noqa: E501 + """UpdateCoupon - a model defined in OpenAPI + + Args: + start_date (str): The date when the Coupon will be launched String must be in ISO8601 format + + 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,) + end_date (str, none_type): The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format. [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.start_date = start_date + 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon_request.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon_request.py new file mode 100644 index 00000000..7b0bf614 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.update_coupon_resource import UpdateCouponResource + globals()['UpdateCouponResource'] = UpdateCouponResource + + +class UpdateCouponRequest(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': (UpdateCouponResource,), # 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 + """UpdateCouponRequest - 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 (UpdateCouponResource): [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 + """UpdateCouponRequest - 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 (UpdateCouponResource): [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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon_resource.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon_resource.py new file mode 100644 index 00000000..f59afe08 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/update_coupon_resource.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_marketingsolutions_v2024_04.model.update_coupon import UpdateCoupon + globals()['UpdateCoupon'] = UpdateCoupon + + +class UpdateCouponResource(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 { + 'attributes': (UpdateCoupon,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UpdateCouponResource - 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,) + attributes (UpdateCoupon): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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 + """UpdateCouponResource - 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,) + attributes (UpdateCoupon): [optional] # noqa: E501 + id (str, none_type): [optional] # noqa: E501 + type (str, 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/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/video_detail.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/video_detail.py new file mode 100644 index 00000000..1a08fe6a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/video_detail.py @@ -0,0 +1,286 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.exceptions import ApiAttributeError + + + +class VideoDetail(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 = { + ('shape',): { + 'HORIZONTAL': "Horizontal", + 'VERTICAL': "Vertical", + 'SQUARE': "Square", + }, + } + + 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 { + 'duration': (float,), # noqa: E501 + 'shape': (str,), # noqa: E501 + 'url': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'duration': 'duration', # noqa: E501 + 'shape': 'shape', # noqa: E501 + 'url': 'url', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, duration, shape, url, *args, **kwargs): # noqa: E501 + """VideoDetail - a model defined in OpenAPI + + Args: + duration (float): The duration of the video in milliseconds, the video could be trimmed if it is longer than 30000 ms. + shape (str): Shape of the video + url (str): URL of the video uploaded on demostatic.criteo.com when deploying and then static.criteo.net + + 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.duration = duration + self.shape = shape + self.url = url + 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, duration, shape, url, *args, **kwargs): # noqa: E501 + """VideoDetail - a model defined in OpenAPI + + Args: + duration (float): The duration of the video in milliseconds, the video could be trimmed if it is longer than 30000 ms. + shape (str): Shape of the video + url (str): URL of the video uploaded on demostatic.criteo.com when deploying and then static.criteo.net + + 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.duration = duration + self.shape = shape + self.url = url + 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/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/write_model_ad_set_id.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/write_model_ad_set_id.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/write_model_ad_set_id.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/write_model_ad_set_id.py index 68825dfb..96cf2f9b 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/write_model_ad_set_id.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/write_model_ad_set_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/write_model_patch_ad_set.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/write_model_patch_ad_set.py similarity index 98% rename from sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/write_model_patch_ad_set.py rename to sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/write_model_patch_ad_set.py index f30fb478..96aa0b40 100644 --- a/sdks/marketingsolutions_2023-01/criteo_api_marketingsolutions_v2023_01/model/write_model_patch_ad_set.py +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model/write_model_patch_ad_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_marketingsolutions_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_marketingsolutions_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_marketingsolutions_v2023_01.exceptions import ApiAttributeError +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_marketingsolutions_v2023_01.model.patch_ad_set import PatchAdSet + from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set import PatchAdSet globals()['PatchAdSet'] = PatchAdSet diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model_utils.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model_utils.py new file mode 100644 index 00000000..ccdc4954 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/model_utils.py @@ -0,0 +1,2058 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +from datetime import date, datetime # noqa: F401 +from copy import deepcopy +import inspect +import io +import os +import pprint +import re +import tempfile +import uuid + +from dateutil.parser import parse + +from criteo_api_marketingsolutions_v2024_04.exceptions import ( + ApiKeyError, + ApiAttributeError, + ApiTypeError, + ApiValueError, +) + +none_type = type(None) +file_type = io.IOBase + + +def convert_js_args_to_python_args(fn): + from functools import wraps + @wraps(fn) + def wrapped_init(_self, *args, **kwargs): + """ + An attribute named `self` received from the api will conflicts with the reserved `self` + parameter of a class method. During generation, `self` attributes are mapped + to `_self` in models. Here, we name `_self` instead of `self` to avoid conflicts. + """ + spec_property_naming = kwargs.get('_spec_property_naming', False) + if spec_property_naming: + kwargs = change_keys_js_to_python( + kwargs, _self if isinstance( + _self, type) else _self.__class__) + return fn(_self, *args, **kwargs) + return wrapped_init + + +class cached_property(object): + # this caches the result of the function call for fn with no inputs + # use this as a decorator on function methods that you want converted + # into cached properties + result_key = '_results' + + def __init__(self, fn): + self._fn = fn + + def __get__(self, instance, cls=None): + if self.result_key in vars(self): + return vars(self)[self.result_key] + else: + result = self._fn() + setattr(self, self.result_key, result) + return result + + +PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) + + +def allows_single_value_input(cls): + """ + This function returns True if the input composed schema model or any + descendant model allows a value only input + This is true for cases where oneOf contains items like: + oneOf: + - float + - NumberWithValidation + - StringEnum + - ArrayModel + - null + TODO: lru_cache this + """ + if ( + issubclass(cls, ModelSimple) or + cls in PRIMITIVE_TYPES + ): + return True + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return False + return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) + return False + + +def composed_model_input_classes(cls): + """ + This function returns a list of the possible models that can be accepted as + inputs. + TODO: lru_cache this + """ + if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: + return [cls] + elif issubclass(cls, ModelNormal): + if cls.discriminator is None: + return [cls] + else: + return get_discriminated_classes(cls) + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return [] + if cls.discriminator is None: + input_classes = [] + for c in cls._composed_schemas['oneOf']: + input_classes.extend(composed_model_input_classes(c)) + return input_classes + else: + return get_discriminated_classes(cls) + return [] + + +class OpenApiModel(object): + """The base class for all OpenAPIModels""" + + def set_attribute(self, name, value): + # this is only used to set properties on self + + path_to_item = [] + if self._path_to_item: + path_to_item.extend(self._path_to_item) + path_to_item.append(name) + + if name in self.openapi_types: + required_types_mixed = self.openapi_types[name] + elif self.additional_properties_type is None: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + path_to_item + ) + elif self.additional_properties_type is not None: + required_types_mixed = self.additional_properties_type + + if get_simple_class(name) != str: + error_msg = type_error_message( + var_name=name, + var_value=name, + valid_classes=(str,), + key_type=True + ) + raise ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=(str,), + key_type=True + ) + + if self._check_type: + value = validate_and_convert_types( + value, required_types_mixed, path_to_item, self._spec_property_naming, + self._check_type, configuration=self._configuration) + if (name,) in self.allowed_values: + check_allowed_values( + self.allowed_values, + (name,), + value + ) + if (name,) in self.validations: + check_validations( + self.validations, + (name,), + value, + self._configuration + ) + self.__dict__['_data_store'][name] = value + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other + + def __setattr__(self, attr, value): + """set the value of an attribute using dot notation: `instance.attr = val`""" + self[attr] = value + + def __getattr__(self, attr): + """get the value of an attribute using dot notation: `instance.attr`""" + return self.__getitem__(attr) + + def __copy__(self): + cls = self.__class__ + if self.get("_spec_property_naming", False): + return cls._new_from_openapi_data(**self.__dict__) + else: + return cls.__new__(cls, **self.__dict__) + + def __deepcopy__(self, memo): + cls = self.__class__ + + if self.get("_spec_property_naming", False): + new_inst = cls._new_from_openapi_data() + else: + new_inst = cls.__new__(cls, **self.__dict__) + + for k, v in self.__dict__.items(): + setattr(new_inst, k, deepcopy(v, memo)) + return new_inst + + + def __new__(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: 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 the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return super(OpenApiModel, cls).__new__(cls) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return super(OpenApiModel, cls).__new__(cls) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = super(OpenApiModel, cls).__new__(cls) + self_inst.__init__(*args, **kwargs) + + if kwargs.get("_spec_property_naming", False): + # when true, implies new is from deserialization + new_inst = new_cls._new_from_openapi_data(*args, **kwargs) + else: + new_inst = new_cls.__new__(new_cls, *args, **kwargs) + new_inst.__init__(*args, **kwargs) + + return new_inst + + @classmethod + @convert_js_args_to_python_args + def _new_from_openapi_data(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: 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 the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return cls._from_openapi_data(*args, **kwargs) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return cls._from_openapi_data(*args, **kwargs) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = cls._from_openapi_data(*args, **kwargs) + + new_inst = new_cls._new_from_openapi_data(*args, **kwargs) + return new_inst + + +class ModelSimple(OpenApiModel): + """the parent class of models whose type != object in their + swagger/openapi""" + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] + + def to_str(self): + """Returns the string representation of the model""" + return str(self.value) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + this_val = self._data_store['value'] + that_val = other._data_store['value'] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + return vals_equal + + +class ModelNormal(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi""" + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] + + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True + + +class ModelComposed(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi and have oneOf/allOf/anyOf + + When one sets a property we use var_name_to_model_instances to store the value in + the correct class instances + run any type checking + validation code. + When one gets a property we use var_name_to_model_instances to get the value + from the correct class instances. + This allows multiple composed schemas to contain the same property with additive + constraints on the value. + + _composed_schemas (dict) stores the anyOf/allOf/oneOf classes + key (str): allOf/oneOf/anyOf + value (list): the classes in the XOf definition. + Note: none_type can be included when the openapi document version >= 3.1.0 + _composed_instances (list): stores a list of instances of the composed schemas + defined in _composed_schemas. When properties are accessed in the self instance, + they are returned from the self._data_store or the data stores in the instances + in self._composed_schemas + _var_name_to_model_instances (dict): maps between a variable name on self and + the composed instances (self included) which contain that data + key (str): property name + value (list): list of class instances, self or instances in _composed_instances + which contain the value that the key is referring to. + """ + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + """ + Use cases: + 1. additional_properties_type is None (additionalProperties == False in spec) + Check for property presence in self.openapi_types + if not present then throw an error + if present set in self, set attribute + always set on composed schemas + 2. additional_properties_type exists + set attribute on self + always set on composed schemas + """ + if self.additional_properties_type is None: + """ + For an attribute to exist on a composed schema it must: + - fulfill schema_requirements in the self composed schema not considering oneOf/anyOf/allOf schemas AND + - fulfill schema_requirements in each oneOf/anyOf/allOf schemas + + schema_requirements: + For an attribute to exist on a schema it must: + - be present in properties at the schema OR + - have additionalProperties unset (defaults additionalProperties = any type) OR + - have additionalProperties set + """ + if name not in self.openapi_types: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + # attribute must be set on self and composed instances + self.set_attribute(name, value) + for model_instance in self._composed_instances: + setattr(model_instance, name, value) + if name not in self._var_name_to_model_instances: + # we assigned an additional property + self.__dict__['_var_name_to_model_instances'][name] = self._composed_instances + [self] + return None + + __unset_attribute_value__ = object() + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + # get the attribute from the correct instance + model_instances = self._var_name_to_model_instances.get(name) + values = [] + # A composed model stores self and child (oneof/anyOf/allOf) models under + # self._var_name_to_model_instances. + # Any property must exist in self and all model instances + # The value stored in all model instances must be the same + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + v = model_instance._data_store[name] + if v not in values: + values.append(v) + len_values = len(values) + if len_values == 0: + return default + elif len_values == 1: + return values[0] + elif len_values > 1: + raise ApiValueError( + "Values stored for property {0} in {1} differ when looking " + "at self and self's composed instances. All values must be " + "the same".format(name, type(self).__name__), + [e for e in [self._path_to_item, name] if e] + ) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + value = self.get(name, self.__unset_attribute_value__) + if value is self.__unset_attribute_value__: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + return value + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + + if name in self.required_properties: + return name in self.__dict__ + + model_instances = self._var_name_to_model_instances.get( + name, self._additional_properties_model_instances) + + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + return True + + return False + + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True + + +COERCION_INDEX_BY_TYPE = { + ModelComposed: 0, + ModelNormal: 1, + ModelSimple: 2, + none_type: 3, # The type of 'None'. + list: 4, + dict: 5, + float: 6, + int: 7, + bool: 8, + datetime: 9, + date: 10, + str: 11, + file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. +} + +# these are used to limit what type conversions we try to do +# when we have a valid type already and we want to try converting +# to another type +UPCONVERSION_TYPE_PAIRS = ( + (str, datetime), + (str, date), + # A float may be serialized as an integer, e.g. '3' is a valid serialized float. + (int, float), + (list, ModelComposed), + (dict, ModelComposed), + (str, ModelComposed), + (int, ModelComposed), + (float, ModelComposed), + (list, ModelComposed), + (list, ModelNormal), + (dict, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), +) + +COERCIBLE_TYPE_PAIRS = { + False: ( # client instantiation of a model with client data + # (dict, ModelComposed), + # (list, ModelComposed), + # (dict, ModelNormal), + # (list, ModelNormal), + # (str, ModelSimple), + # (int, ModelSimple), + # (float, ModelSimple), + # (list, ModelSimple), + # (str, int), + # (str, float), + # (str, datetime), + # (str, date), + # (int, str), + # (float, str), + ), + True: ( # server -> client data + (dict, ModelComposed), + (list, ModelComposed), + (dict, ModelNormal), + (list, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), + # (str, int), + # (str, float), + (str, datetime), + (str, date), + # (int, str), + # (float, str), + (str, file_type) + ), +} + + +def get_simple_class(input_value): + """Returns an input_value's simple class that we will use for type checking + Python2: + float and int will return int, where int is the python3 int backport + str and unicode will return str, where str is the python3 str backport + Note: float and int ARE both instances of int backport + Note: str_py2 and unicode_py2 are NOT both instances of str backport + + Args: + input_value (class/class_instance): the item for which we will return + the simple class + """ + if isinstance(input_value, type): + # input_value is a class + return input_value + elif isinstance(input_value, tuple): + return tuple + elif isinstance(input_value, list): + return list + elif isinstance(input_value, dict): + return dict + elif isinstance(input_value, none_type): + return none_type + elif isinstance(input_value, file_type): + return file_type + elif isinstance(input_value, bool): + # this must be higher than the int check because + # isinstance(True, int) == True + return bool + elif isinstance(input_value, int): + return int + elif isinstance(input_value, datetime): + # this must be higher than the date check because + # isinstance(datetime_instance, date) == True + return datetime + elif isinstance(input_value, date): + return date + elif isinstance(input_value, str): + return str + return type(input_value) + + +def check_allowed_values(allowed_values, input_variable_path, input_values): + """Raises an exception if the input_values are not allowed + + Args: + allowed_values (dict): the allowed_values dict + input_variable_path (tuple): the path to the input variable + input_values (list/str/int/float/date/datetime): the values that we + are checking to see if they are in allowed_values + """ + these_allowed_values = list(allowed_values[input_variable_path].values()) + if (isinstance(input_values, list) + and not set(input_values).issubset( + set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values) - set(these_allowed_values))), + raise ApiValueError( + "Invalid values for `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (isinstance(input_values, dict) + and not set( + input_values.keys()).issubset(set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values.keys()) - set(these_allowed_values))) + raise ApiValueError( + "Invalid keys in `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (not isinstance(input_values, (list, dict)) + and input_values not in these_allowed_values): + raise ApiValueError( + "Invalid value for `%s` (%s), must be one of %s" % + ( + input_variable_path[0], + input_values, + these_allowed_values + ) + ) + + +def is_json_validation_enabled(schema_keyword, configuration=None): + """Returns true if JSON schema validation is enabled for the specified + validation keyword. This can be used to skip JSON schema structural validation + as requested in the configuration. + + Args: + schema_keyword (string): the name of a JSON schema validation keyword. + configuration (Configuration): the configuration class. + """ + + return (configuration is None or + not hasattr(configuration, '_disabled_client_side_validations') or + schema_keyword not in configuration._disabled_client_side_validations) + + +def check_validations( + validations, input_variable_path, input_values, + configuration=None): + """Raises an exception if the input_values are invalid + + Args: + validations (dict): the validation dictionary. + input_variable_path (tuple): the path to the input variable. + input_values (list/str/int/float/date/datetime): the values that we + are checking. + configuration (Configuration): the configuration class. + """ + + if input_values is None: + return + + current_validations = validations[input_variable_path] + if (is_json_validation_enabled('multipleOf', configuration) and + 'multiple_of' in current_validations and + isinstance(input_values, (int, float)) and + not (float(input_values) / current_validations['multiple_of']).is_integer()): + # Note 'multipleOf' will be as good as the floating point arithmetic. + raise ApiValueError( + "Invalid value for `%s`, value must be a multiple of " + "`%s`" % ( + input_variable_path[0], + current_validations['multiple_of'] + ) + ) + + if (is_json_validation_enabled('maxLength', configuration) and + 'max_length' in current_validations and + len(input_values) > current_validations['max_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['max_length'] + ) + ) + + if (is_json_validation_enabled('minLength', configuration) and + 'min_length' in current_validations and + len(input_values) < current_validations['min_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be greater than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['min_length'] + ) + ) + + if (is_json_validation_enabled('maxItems', configuration) and + 'max_items' in current_validations and + len(input_values) > current_validations['max_items']): + raise ApiValueError( + "Invalid value for `%s`, number of items must be less than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['max_items'] + ) + ) + + if (is_json_validation_enabled('minItems', configuration) and + 'min_items' in current_validations and + len(input_values) < current_validations['min_items']): + raise ValueError( + "Invalid value for `%s`, number of items must be greater than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['min_items'] + ) + ) + + items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', + 'inclusive_minimum') + if (any(item in current_validations for item in items)): + if isinstance(input_values, list): + max_val = max(input_values) + min_val = min(input_values) + elif isinstance(input_values, dict): + max_val = max(input_values.values()) + min_val = min(input_values.values()) + else: + max_val = input_values + min_val = input_values + + if (is_json_validation_enabled('exclusiveMaximum', configuration) and + 'exclusive_maximum' in current_validations and + max_val >= current_validations['exclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than `%s`" % ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('maximum', configuration) and + 'inclusive_maximum' in current_validations and + max_val > current_validations['inclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['inclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('exclusiveMinimum', configuration) and + 'exclusive_minimum' in current_validations and + min_val <= current_validations['exclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than `%s`" % + ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('minimum', configuration) and + 'inclusive_minimum' in current_validations and + min_val < current_validations['inclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than or equal " + "to `%s`" % ( + input_variable_path[0], + current_validations['inclusive_minimum'] + ) + ) + flags = current_validations.get('regex', {}).get('flags', 0) + if (is_json_validation_enabled('pattern', configuration) and + 'regex' in current_validations and + not re.search(current_validations['regex']['pattern'], + input_values, flags=flags)): + err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( + input_variable_path[0], + current_validations['regex']['pattern'] + ) + if flags != 0: + # Don't print the regex flags if the flags are not + # specified in the OAS document. + err_msg = r"%s with flags=`%s`" % (err_msg, flags) + raise ApiValueError(err_msg) + + +def order_response_types(required_types): + """Returns the required types sorted in coercion order + + Args: + required_types (list/tuple): collection of classes or instance of + list or dict with class information inside it. + + Returns: + (list): coercion order sorted collection of classes or instance + of list or dict with class information inside it. + """ + + def index_getter(class_or_instance): + if isinstance(class_or_instance, list): + return COERCION_INDEX_BY_TYPE[list] + elif isinstance(class_or_instance, dict): + return COERCION_INDEX_BY_TYPE[dict] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelComposed)): + return COERCION_INDEX_BY_TYPE[ModelComposed] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelNormal)): + return COERCION_INDEX_BY_TYPE[ModelNormal] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelSimple)): + return COERCION_INDEX_BY_TYPE[ModelSimple] + elif class_or_instance in COERCION_INDEX_BY_TYPE: + return COERCION_INDEX_BY_TYPE[class_or_instance] + raise ApiValueError("Unsupported type: %s" % class_or_instance) + + sorted_types = sorted( + required_types, + key=lambda class_or_instance: index_getter(class_or_instance) + ) + return sorted_types + + +def remove_uncoercible(required_types_classes, current_item, spec_property_naming, + must_convert=True): + """Only keeps the type conversions that are possible + + Args: + required_types_classes (tuple): tuple of classes that are required + these should be ordered by COERCION_INDEX_BY_TYPE + 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 variables names in the input data are python + variable names in PEP-8 snake case. + current_item (any): the current item (input data) to be converted + + Keyword Args: + must_convert (bool): if True the item to convert is of the wrong + type and we want a big list of coercibles + if False, we want a limited list of coercibles + + Returns: + (list): the remaining coercible required types, classes only + """ + current_type_simple = get_simple_class(current_item) + + results_classes = [] + for required_type_class in required_types_classes: + # convert our models to OpenApiModel + required_type_class_simplified = required_type_class + if isinstance(required_type_class_simplified, type): + if issubclass(required_type_class_simplified, ModelComposed): + required_type_class_simplified = ModelComposed + elif issubclass(required_type_class_simplified, ModelNormal): + required_type_class_simplified = ModelNormal + elif issubclass(required_type_class_simplified, ModelSimple): + required_type_class_simplified = ModelSimple + + if required_type_class_simplified == current_type_simple: + # don't consider converting to one's own class + continue + + class_pair = (current_type_simple, required_type_class_simplified) + if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: + results_classes.append(required_type_class) + elif class_pair in UPCONVERSION_TYPE_PAIRS: + results_classes.append(required_type_class) + return results_classes + + +def get_discriminated_classes(cls): + """ + Returns all the classes that a discriminator converts to + TODO: lru_cache this + """ + possible_classes = [] + key = list(cls.discriminator.keys())[0] + if is_type_nullable(cls): + possible_classes.append(cls) + for discr_cls in cls.discriminator[key].values(): + if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: + possible_classes.extend(get_discriminated_classes(discr_cls)) + else: + possible_classes.append(discr_cls) + return possible_classes + + +def get_possible_classes(cls, from_server_context): + # TODO: lru_cache this + possible_classes = [cls] + if from_server_context: + return possible_classes + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + possible_classes = [] + possible_classes.extend(get_discriminated_classes(cls)) + elif issubclass(cls, ModelComposed): + possible_classes.extend(composed_model_input_classes(cls)) + return possible_classes + + +def get_required_type_classes(required_types_mixed, spec_property_naming): + """Converts the tuple required_types into a tuple and a dict described + below + + Args: + required_types_mixed (tuple/list): will contain either classes or + instance of list or dict + spec_property_naming (bool): if True these values came from the + server, and we use the data types in our endpoints. + If False, we are client side and we need to include + oneOf and discriminator classes inside the data types in our endpoints + + Returns: + (valid_classes, dict_valid_class_to_child_types_mixed): + valid_classes (tuple): the valid classes that the current item + should be + dict_valid_class_to_child_types_mixed (dict): + valid_class (class): this is the key + child_types_mixed (list/dict/tuple): describes the valid child + types + """ + valid_classes = [] + child_req_types_by_current_type = {} + for required_type in required_types_mixed: + if isinstance(required_type, list): + valid_classes.append(list) + child_req_types_by_current_type[list] = required_type + elif isinstance(required_type, tuple): + valid_classes.append(tuple) + child_req_types_by_current_type[tuple] = required_type + elif isinstance(required_type, dict): + valid_classes.append(dict) + child_req_types_by_current_type[dict] = required_type[str] + else: + valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) + return tuple(valid_classes), child_req_types_by_current_type + + +def change_keys_js_to_python(input_dict, model_class): + """ + Converts from javascript_key keys in the input_dict to python_keys in + the output dict using the mapping in model_class. + If the input_dict contains a key which does not declared in the model_class, + the key is added to the output dict as is. The assumption is the model_class + may have undeclared properties (additionalProperties attribute in the OAS + document). + """ + + if getattr(model_class, 'attribute_map', None) is None: + return input_dict + output_dict = {} + reversed_attr_map = {value: key for key, value in + model_class.attribute_map.items()} + for javascript_key, value in input_dict.items(): + python_key = reversed_attr_map.get(javascript_key) + if python_key is None: + # if the key is unknown, it is in error or it is an + # additionalProperties variable + python_key = javascript_key + output_dict[python_key] = value + return output_dict + + +def get_type_error(var_value, path_to_item, valid_classes, key_type=False): + error_msg = type_error_message( + var_name=path_to_item[-1], + var_value=var_value, + valid_classes=valid_classes, + key_type=key_type + ) + return ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=valid_classes, + key_type=key_type + ) + + +def deserialize_primitive(data, klass, path_to_item): + """Deserializes string to primitive type. + + :param data: str/int/float + :param klass: str/class the class to convert to + + :return: int, float, str, bool, date, datetime + """ + additional_message = "" + try: + if klass in {datetime, date}: + additional_message = ( + "If you need your parameter to have a fallback " + "string value, please set its type as `type: {}` in your " + "spec. That allows the value to be any type. " + ) + if klass == datetime: + if len(data) < 8: + raise ValueError("This is not a datetime") + # The string should be in iso8601 datetime format. + parsed_datetime = parse(data) + date_only = ( + parsed_datetime.hour == 0 and + parsed_datetime.minute == 0 and + parsed_datetime.second == 0 and + parsed_datetime.tzinfo is None and + 8 <= len(data) <= 10 + ) + if date_only: + raise ValueError("This is a date, not a datetime") + return parsed_datetime + elif klass == date: + if len(data) < 8: + raise ValueError("This is not a date") + return parse(data).date() + else: + converted_value = klass(data) + if isinstance(data, str) and klass == float: + if str(converted_value) != data: + # '7' -> 7.0 -> '7.0' != '7' + raise ValueError('This is not a float') + return converted_value + except (OverflowError, ValueError) as ex: + # parse can raise OverflowError + raise ApiValueError( + "{0}Failed to parse {1} as {2}".format( + additional_message, repr(data), klass.__name__ + ), + path_to_item=path_to_item + ) from ex + + +def get_discriminator_class(model_class, + discr_name, + discr_value, cls_visited): + """Returns the child class specified by the discriminator. + + Args: + model_class (OpenApiModel): the model class. + discr_name (string): the name of the discriminator property. + discr_value (any): the discriminator value. + cls_visited (list): list of model classes that have been visited. + Used to determine the discriminator class without + visiting circular references indefinitely. + + Returns: + used_model_class (class/None): the chosen child class that will be used + to deserialize the data, for example dog.Dog. + If a class is not found, None is returned. + """ + + if model_class in cls_visited: + # The class has already been visited and no suitable class was found. + return None + cls_visited.append(model_class) + used_model_class = None + if discr_name in model_class.discriminator: + class_name_to_discr_class = model_class.discriminator[discr_name] + used_model_class = class_name_to_discr_class.get(discr_value) + if used_model_class is None: + # We didn't find a discriminated class in class_name_to_discr_class. + # So look in the ancestor or descendant discriminators + # The discriminator mapping may exist in a descendant (anyOf, oneOf) + # or ancestor (allOf). + # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat + # hierarchy, the discriminator mappings may be defined at any level + # in the hierarchy. + # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig + # if we try to make BasquePig from mammal, we need to travel through + # the oneOf descendant discriminators to find BasquePig + descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ + model_class._composed_schemas.get('anyOf', ()) + ancestor_classes = model_class._composed_schemas.get('allOf', ()) + possible_classes = descendant_classes + ancestor_classes + for cls in possible_classes: + # Check if the schema has inherited discriminators. + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + used_model_class = get_discriminator_class( + cls, discr_name, discr_value, cls_visited) + if used_model_class is not None: + return used_model_class + return used_model_class + + +def deserialize_model(model_data, model_class, path_to_item, check_type, + configuration, spec_property_naming): + """Deserializes model_data to model instance. + + Args: + model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model + model_class (OpenApiModel): the model class + path_to_item (list): path to the model in the received data + check_type (bool): whether to check the data tupe for the values in + the model + configuration (Configuration): the instance to use to convert files + 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 variables names in the input data are python + variable names in PEP-8 snake case. + + Returns: + model instance + + Raise: + ApiTypeError + ApiValueError + ApiKeyError + """ + + kw_args = dict(_check_type=check_type, + _path_to_item=path_to_item, + _configuration=configuration, + _spec_property_naming=spec_property_naming) + + if issubclass(model_class, ModelSimple): + return model_class._new_from_openapi_data(model_data, **kw_args) + elif isinstance(model_data, list): + return model_class._new_from_openapi_data(*model_data, **kw_args) + if isinstance(model_data, dict): + kw_args.update(model_data) + return model_class._new_from_openapi_data(**kw_args) + elif isinstance(model_data, PRIMITIVE_TYPES): + return model_class._new_from_openapi_data(model_data, **kw_args) + + +def deserialize_file(response_data, configuration, content_disposition=None): + """Deserializes body to file + + Saves response body into a file in a temporary folder, + using the filename from the `Content-Disposition` header if provided. + + Args: + param response_data (str): the file data to write + configuration (Configuration): the instance to use to convert files + + Keyword Args: + content_disposition (str): the value of the Content-Disposition + header + + Returns: + (file_type): the deserialized file which is open + The user is responsible for closing and reading the file + """ + fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) + os.close(fd) + os.remove(path) + + if content_disposition: + filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition, + flags=re.I) + if filename is not None: + filename = filename.group(1) + else: + filename = "default_" + str(uuid.uuid4()) + + path = os.path.join(os.path.dirname(path), filename) + + with open(path, "wb") as f: + if isinstance(response_data, str): + # change str to bytes so we can write it + response_data = response_data.encode('utf-8') + f.write(response_data) + + f = open(path, "rb") + return f + + +def attempt_convert_item(input_value, valid_classes, path_to_item, + configuration, spec_property_naming, key_type=False, + must_convert=False, check_type=True): + """ + Args: + input_value (any): the data to convert + valid_classes (any): the classes that are valid + path_to_item (list): the path to the item to convert + configuration (Configuration): the instance to use to convert files + 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 variables names in the input data are python + variable names in PEP-8 snake case. + key_type (bool): if True we need to convert a key type (not supported) + must_convert (bool): if True we must convert + check_type (bool): if True we check the type or the returned data in + ModelComposed/ModelNormal/ModelSimple instances + + Returns: + instance (any) the fixed item + + Raises: + ApiTypeError + ApiValueError + ApiKeyError + """ + valid_classes_ordered = order_response_types(valid_classes) + valid_classes_coercible = remove_uncoercible( + valid_classes_ordered, input_value, spec_property_naming) + if not valid_classes_coercible or key_type: + # we do not handle keytype errors, json will take care + # of this for us + if configuration is None or not configuration.discard_unknown_keys: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=key_type) + for valid_class in valid_classes_coercible: + try: + if issubclass(valid_class, OpenApiModel): + return deserialize_model(input_value, valid_class, + path_to_item, check_type, + configuration, spec_property_naming) + elif valid_class == file_type: + return deserialize_file(input_value, configuration) + return deserialize_primitive(input_value, valid_class, + path_to_item) + except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: + if must_convert: + raise conversion_exc + # if we have conversion errors when must_convert == False + # we ignore the exception and move on to the next class + continue + # we were unable to convert, must_convert == False + return input_value + + +def is_type_nullable(input_type): + """ + Returns true if None is an allowed value for the specified input_type. + + A type is nullable if at least one of the following conditions is true: + 1. The OAS 'nullable' attribute has been specified, + 1. The type is the 'null' type, + 1. The type is a anyOf/oneOf composed schema, and a child schema is + the 'null' type. + Args: + input_type (type): the class of the input_value that we are + checking + Returns: + bool + """ + if input_type is none_type: + return True + if issubclass(input_type, OpenApiModel) and input_type._nullable: + return True + if issubclass(input_type, ModelComposed): + # If oneOf/anyOf, check if the 'null' type is one of the allowed types. + for t in input_type._composed_schemas.get('oneOf', ()): + if is_type_nullable(t): + return True + for t in input_type._composed_schemas.get('anyOf', ()): + if is_type_nullable(t): + return True + return False + + +def is_valid_type(input_class_simple, valid_classes): + """ + Args: + input_class_simple (class): the class of the input_value that we are + checking + valid_classes (tuple): the valid classes that the current item + should be + Returns: + bool + """ + if issubclass(input_class_simple, OpenApiModel) and \ + valid_classes == (bool, date, datetime, dict, float, int, list, str, none_type,): + return True + valid_type = input_class_simple in valid_classes + if not valid_type and ( + issubclass(input_class_simple, OpenApiModel) or + input_class_simple is none_type): + for valid_class in valid_classes: + if input_class_simple is none_type and is_type_nullable(valid_class): + # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. + return True + if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): + continue + discr_propertyname_py = list(valid_class.discriminator.keys())[0] + discriminator_classes = ( + valid_class.discriminator[discr_propertyname_py].values() + ) + valid_type = is_valid_type(input_class_simple, discriminator_classes) + if valid_type: + return True + return valid_type + + +def validate_and_convert_types(input_value, required_types_mixed, path_to_item, + spec_property_naming, _check_type, configuration=None): + """Raises a TypeError is there is a problem, otherwise returns value + + Args: + input_value (any): the data to validate/convert + required_types_mixed (list/dict/tuple): A list of + valid classes, or a list tuples of valid classes, or a dict where + the value is a tuple of value classes + path_to_item: (list) the path to the data being validated + this stores a list of keys or indices to get to the data being + validated + 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 variables names in the input data are python + variable names in PEP-8 snake case. + _check_type: (boolean) if true, type will be checked and conversion + will be attempted. + configuration: (Configuration): the configuration class to use + when converting file_type items. + If passed, conversion will be attempted when possible + If not passed, no conversions will be attempted and + exceptions will be raised + + Returns: + the correctly typed value + + Raises: + ApiTypeError + """ + results = get_required_type_classes(required_types_mixed, spec_property_naming) + valid_classes, child_req_types_by_current_type = results + + input_class_simple = get_simple_class(input_value) + valid_type = is_valid_type(input_class_simple, valid_classes) + if not valid_type: + if (configuration + or (input_class_simple == dict + and dict not in valid_classes)): + # if input_value is not valid_type try to convert it + converted_instance = attempt_convert_item( + input_value, + valid_classes, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=True, + check_type=_check_type + ) + return converted_instance + else: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=False) + + # input_value's type is in valid_classes + if len(valid_classes) > 1 and configuration: + # there are valid classes which are not the current class + valid_classes_coercible = remove_uncoercible( + valid_classes, input_value, spec_property_naming, must_convert=False) + if valid_classes_coercible: + converted_instance = attempt_convert_item( + input_value, + valid_classes_coercible, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=False, + check_type=_check_type + ) + return converted_instance + + if child_req_types_by_current_type == {}: + # all types are of the required types and there are no more inner + # variables left to look at + return input_value + inner_required_types = child_req_types_by_current_type.get( + type(input_value) + ) + if inner_required_types is None: + # for this type, there are not more inner variables left to look at + return input_value + if isinstance(input_value, list): + if input_value == []: + # allow an empty list + return input_value + for index, inner_value in enumerate(input_value): + inner_path = list(path_to_item) + inner_path.append(index) + input_value[index] = validate_and_convert_types( + inner_value, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + elif isinstance(input_value, dict): + if input_value == {}: + # allow an empty dict + return input_value + for inner_key, inner_val in input_value.items(): + inner_path = list(path_to_item) + inner_path.append(inner_key) + if get_simple_class(inner_key) != str: + raise get_type_error(inner_key, inner_path, valid_classes, + key_type=True) + input_value[inner_key] = validate_and_convert_types( + inner_val, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + return input_value + + +def model_to_dict(model_instance, serialize=True): + """Returns the model properties as a dict + + Args: + model_instance (one of your model instances): the model instance that + will be converted to a dict. + + Keyword Args: + serialize (bool): if True, the keys in the dict will be values from + attribute_map + """ + result = {} + + def extract_item(item): return ( + item[0], model_to_dict( + item[1], serialize=serialize)) if hasattr( + item[1], '_data_store') else item + + model_instances = [model_instance] + if model_instance._composed_schemas: + model_instances.extend(model_instance._composed_instances) + seen_json_attribute_names = set() + used_fallback_python_attribute_names = set() + py_to_json_map = {} + for model_instance in model_instances: + for attr, value in model_instance._data_store.items(): + if serialize: + # we use get here because additional property key names do not + # exist in attribute_map + try: + attr = model_instance.attribute_map[attr] + py_to_json_map.update(model_instance.attribute_map) + seen_json_attribute_names.add(attr) + except KeyError: + used_fallback_python_attribute_names.add(attr) + if isinstance(value, list): + if not value: + # empty list or None + result[attr] = value + else: + res = [] + for v in value: + if isinstance(v, PRIMITIVE_TYPES) or v is None: + res.append(v) + elif isinstance(v, ModelSimple): + res.append(v.value) + elif isinstance(v, dict): + res.append(dict(map( + extract_item, + v.items() + ))) + else: + res.append(model_to_dict(v, serialize=serialize)) + result[attr] = res + elif isinstance(value, dict): + result[attr] = dict(map( + extract_item, + value.items() + )) + elif isinstance(value, ModelSimple): + result[attr] = value.value + elif hasattr(value, '_data_store'): + result[attr] = model_to_dict(value, serialize=serialize) + else: + result[attr] = value + if serialize: + for python_key in used_fallback_python_attribute_names: + json_key = py_to_json_map.get(python_key) + if json_key is None: + continue + if python_key == json_key: + continue + json_key_assigned_no_need_for_python_key = json_key in seen_json_attribute_names + if json_key_assigned_no_need_for_python_key: + del result[python_key] + + return result + + +def type_error_message(var_value=None, var_name=None, valid_classes=None, + key_type=None): + """ + Keyword Args: + var_value (any): the variable which has the type_error + var_name (str): the name of the variable which has the typ error + valid_classes (tuple): the accepted classes for current_item's + value + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + """ + key_or_value = 'value' + if key_type: + key_or_value = 'key' + valid_classes_phrase = get_valid_classes_phrase(valid_classes) + msg = ( + "Invalid type for variable '{0}'. Required {1} type {2} and " + "passed type was {3}".format( + var_name, + key_or_value, + valid_classes_phrase, + type(var_value).__name__, + ) + ) + return msg + + +def get_valid_classes_phrase(input_classes): + """Returns a string phrase describing what types are allowed + """ + all_classes = list(input_classes) + all_classes = sorted(all_classes, key=lambda cls: cls.__name__) + all_class_names = [cls.__name__ for cls in all_classes] + if len(all_class_names) == 1: + return 'is {0}'.format(all_class_names[0]) + return "is one of [{0}]".format(", ".join(all_class_names)) + + +def get_allof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + used to make instances + constant_args (dict): + metadata arguments: + _check_type + _path_to_item + _spec_property_naming + _configuration + _visited_composed_classes + + Returns + composed_instances (list) + """ + composed_instances = [] + for allof_class in self._composed_schemas['allOf']: + + try: + if constant_args.get('_spec_property_naming'): + allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) + else: + allof_instance = allof_class(**model_args, **constant_args) + composed_instances.append(allof_instance) + except Exception as ex: + raise ApiValueError( + "Invalid inputs given to generate an instance of '%s'. The " + "input data was invalid for the allOf schema '%s' in the composed " + "schema '%s'. Error=%s" % ( + allof_class.__name__, + allof_class.__name__, + self.__class__.__name__, + str(ex) + ) + ) from ex + return composed_instances + + +def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): + """ + Find the oneOf schema that matches the input data (e.g. payload). + If exactly one schema matches the input data, an instance of that schema + is returned. + If zero or more than one schema match the input data, an exception is raised. + In OAS 3.x, the payload MUST, by validation, match exactly one of the + schemas described by oneOf. + + Args: + cls: the class we are handling + model_kwargs (dict): var_name to var_value + The input data, e.g. the payload that must match a oneOf schema + in the OpenAPI document. + constant_kwargs (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Kwargs: + model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): + the value to assign to a primitive class or ModelSimple class + Notes: + - this is only passed in when oneOf includes types which are not object + - None is used to suppress handling of model_arg, nullable models are handled in __new__ + + Returns + oneof_instance (instance) + """ + if len(cls._composed_schemas['oneOf']) == 0: + return None + + oneof_instances = [] + # Iterate over each oneOf schema and determine if the input data + # matches the oneOf schemas. + for oneof_class in cls._composed_schemas['oneOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if oneof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + single_value_input = allows_single_value_input(oneof_class) + + try: + if not single_value_input: + if constant_kwargs.get('_spec_property_naming'): + oneof_instance = oneof_class._from_openapi_data( + **model_kwargs, **constant_kwargs) + else: + oneof_instance = oneof_class(**model_kwargs, **constant_kwargs) + else: + if issubclass(oneof_class, ModelSimple): + if constant_kwargs.get('_spec_property_naming'): + oneof_instance = oneof_class._from_openapi_data( + model_arg, **constant_kwargs) + else: + oneof_instance = oneof_class(model_arg, **constant_kwargs) + elif oneof_class in PRIMITIVE_TYPES: + oneof_instance = validate_and_convert_types( + model_arg, + (oneof_class,), + constant_kwargs['_path_to_item'], + constant_kwargs['_spec_property_naming'], + constant_kwargs['_check_type'], + configuration=constant_kwargs['_configuration'] + ) + oneof_instances.append(oneof_instance) + except Exception: + pass + if len(oneof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None " + "of the oneOf schemas matched the input data." % + cls.__name__ + ) + elif len(oneof_instances) > 1: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. Multiple " + "oneOf schemas matched the inputs, but a max of one is allowed." % + cls.__name__ + ) + return oneof_instances[0] + + +def get_anyof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + The input data, e.g. the payload that must match at least one + anyOf child schema in the OpenAPI document. + constant_args (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Returns + anyof_instances (list) + """ + anyof_instances = [] + if len(self._composed_schemas['anyOf']) == 0: + return anyof_instances + + for anyof_class in self._composed_schemas['anyOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if anyof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + try: + if constant_args.get('_spec_property_naming'): + anyof_instance = anyof_class._from_openapi_data(**model_args, **constant_args) + else: + anyof_instance = anyof_class(**model_args, **constant_args) + anyof_instances.append(anyof_instance) + except Exception: + pass + if len(anyof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None of the " + "anyOf schemas matched the inputs." % + self.__class__.__name__ + ) + return anyof_instances + + +def get_discarded_args(self, composed_instances, model_args): + """ + Gathers the args that were discarded by configuration.discard_unknown_keys + """ + model_arg_keys = model_args.keys() + discarded_args = set() + # arguments passed to self were already converted to python names + # before __init__ was called + for instance in composed_instances: + if instance.__class__ in self._composed_schemas['allOf']: + try: + keys = instance.to_dict().keys() + discarded_keys = model_args - keys + discarded_args.update(discarded_keys) + except Exception: + # allOf integer schema will throw exception + pass + else: + try: + all_keys = set(model_to_dict(instance, serialize=False).keys()) + js_keys = model_to_dict(instance, serialize=True).keys() + all_keys.update(js_keys) + discarded_keys = model_arg_keys - all_keys + discarded_args.update(discarded_keys) + except Exception: + # allOf integer schema will throw exception + pass + return discarded_args + + +def validate_get_composed_info(constant_args, model_args, self): + """ + For composed schemas, generate schema instances for + all schemas in the oneOf/anyOf/allOf definition. If additional + properties are allowed, also assign those properties on + all matched schemas that contain additionalProperties. + Openapi schemas are python classes. + + Exceptions are raised if: + - 0 or > 1 oneOf schema matches the model_args input data + - no anyOf schema matches the model_args input data + - any of the allOf schemas do not match the model_args input data + + Args: + constant_args (dict): these are the args that every model requires + model_args (dict): these are the required and optional spec args that + were passed in to make this model + self (class): the class that we are instantiating + This class contains self._composed_schemas + + Returns: + composed_info (list): length three + composed_instances (list): the composed instances which are not + self + var_name_to_model_instances (dict): a dict going from var_name + to the model_instance which holds that var_name + the model_instance may be self or an instance of one of the + classes in self.composed_instances() + additional_properties_model_instances (list): a list of the + model instances which have the property + additional_properties_type. This list can include self + """ + # create composed_instances + composed_instances = [] + allof_instances = get_allof_instances(self, model_args, constant_args) + composed_instances.extend(allof_instances) + oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) + if oneof_instance is not None: + composed_instances.append(oneof_instance) + anyof_instances = get_anyof_instances(self, model_args, constant_args) + composed_instances.extend(anyof_instances) + """ + set additional_properties_model_instances + additional properties must be evaluated at the schema level + so self's additional properties are most important + If self is a composed schema with: + - no properties defined in self + - additionalProperties: False + Then for object payloads every property is an additional property + and they are not allowed, so only empty dict is allowed + + Properties must be set on all matching schemas + so when a property is assigned toa composed instance, it must be set on all + composed instances regardless of additionalProperties presence + keeping it to prevent breaking changes in v5.0.1 + TODO remove cls._additional_properties_model_instances in 6.0.0 + """ + additional_properties_model_instances = [] + if self.additional_properties_type is not None: + additional_properties_model_instances = [self] + + """ + no need to set properties on self in here, they will be set in __init__ + By here all composed schema oneOf/anyOf/allOf instances have their properties set using + model_args + """ + discarded_args = get_discarded_args(self, composed_instances, model_args) + + # map variable names to composed_instances + var_name_to_model_instances = {} + for prop_name in model_args: + if prop_name not in discarded_args: + var_name_to_model_instances[prop_name] = [self] + list( + filter( + lambda x: prop_name in x.openapi_types, composed_instances)) + + return [ + composed_instances, + var_name_to_model_instances, + additional_properties_model_instances, + discarded_args + ] diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/models/__init__.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/models/__init__.py new file mode 100644 index 00000000..13b67224 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/models/__init__.py @@ -0,0 +1,267 @@ +# flake8: noqa + +# import all models into this package +# if you have many models here with many references from one model to another this may +# raise a RecursionError +# to avoid this, import only the models that you directly need like: +# from criteo_api_marketingsolutions_v2024_04.model.pet import Pet +# or import this package, but before doing it, use: +# import sys +# sys.setrecursionlimit(n) + +from criteo_api_marketingsolutions_v2024_04.model.ad import Ad +from criteo_api_marketingsolutions_v2024_04.model.ad_list_response import AdListResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_resource import AdResource +from criteo_api_marketingsolutions_v2024_04.model.ad_response import AdResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_entity_v1 import AdSetAudienceLinkEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_entity_v1_resource import AdSetAudienceLinkEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_entity_v1_response import AdSetAudienceLinkEntityV1Response +from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_input_entity_v1 import AdSetAudienceLinkInputEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_category_bid import AdSetCategoryBid +from criteo_api_marketingsolutions_v2024_04.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_set_category_bid_resource import AdSetCategoryBidResource +from criteo_api_marketingsolutions_v2024_04.model.ad_set_delivery_limitations import AdSetDeliveryLimitations +from criteo_api_marketingsolutions_v2024_04.model.ad_set_delivery_limitations_v23_q1 import AdSetDeliveryLimitationsV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_display_multiplier import AdSetDisplayMultiplier +from criteo_api_marketingsolutions_v2024_04.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_set_display_multiplier_resource import AdSetDisplayMultiplierResource +from criteo_api_marketingsolutions_v2024_04.model.ad_set_frequency_capping import AdSetFrequencyCapping +from criteo_api_marketingsolutions_v2024_04.model.ad_set_frequency_capping_v23_q1 import AdSetFrequencyCappingV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_geo_location import AdSetGeoLocation +from criteo_api_marketingsolutions_v2024_04.model.ad_set_geo_location_v23_q1 import AdSetGeoLocationV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_search_filter_v23_q1 import AdSetSearchFilterV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_search_request_v23_q1 import AdSetSearchRequestV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting import AdSetTargeting +from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting_rule import AdSetTargetingRule +from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting_rule_v23_q1 import AdSetTargetingRuleV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_targeting_v23_q1 import AdSetTargetingV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.ad_write import AdWrite +from criteo_api_marketingsolutions_v2024_04.model.ad_write_request import AdWriteRequest +from criteo_api_marketingsolutions_v2024_04.model.ad_write_resource import AdWriteResource +from criteo_api_marketingsolutions_v2024_04.model.adaptive_attributes import AdaptiveAttributes +from criteo_api_marketingsolutions_v2024_04.model.adaptive_colors import AdaptiveColors +from criteo_api_marketingsolutions_v2024_04.model.adaptive_write_attributes import AdaptiveWriteAttributes +from criteo_api_marketingsolutions_v2024_04.model.algebra_node_v1 import AlgebraNodeV1 +from criteo_api_marketingsolutions_v2024_04.model.application_summary_model import ApplicationSummaryModel +from criteo_api_marketingsolutions_v2024_04.model.application_summary_model_resource import ApplicationSummaryModelResource +from criteo_api_marketingsolutions_v2024_04.model.application_summary_model_response import ApplicationSummaryModelResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_create_input_v1 import AudienceBulkCreateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_delete_input_v1 import AudienceBulkDeleteInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_update_input_v1 import AudienceBulkUpdateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_compute_size_entity_v1_resource import AudienceComputeSizeEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_compute_sizes_input_v1 import AudienceComputeSizesInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_create_entity_v1 import AudienceCreateEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_create_entity_v1_resource import AudienceCreateEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_delete_entity_v1_resource import AudienceDeleteEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1 import AudienceEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_audience_search_metadata_v1_list_response import AudienceEntityV1AudienceSearchMetadataV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_list_response import AudienceEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_resource import AudienceEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_error import AudienceError +from criteo_api_marketingsolutions_v2024_04.model.audience_estimate_size_entity_v1 import AudienceEstimateSizeEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_estimate_size_entity_v1_resource import AudienceEstimateSizeEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_estimate_size_input_v1 import AudienceEstimateSizeInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_id_entity_v1_list_response import AudienceIdEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_id_entity_v1_resource import AudienceIdEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_name_description import AudienceNameDescription +from criteo_api_marketingsolutions_v2024_04.model.audience_search_entity_v1 import AudienceSearchEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_search_entity_v1_resource import AudienceSearchEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_search_input_v1 import AudienceSearchInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_search_metadata_v1 import AudienceSearchMetadataV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_create_input_v1 import AudienceSegmentBulkCreateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_delete_input_v1 import AudienceSegmentBulkDeleteInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_update_input_v1 import AudienceSegmentBulkUpdateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_compute_size_entity_v1_resource import AudienceSegmentComputeSizeEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_compute_sizes_input_v1 import AudienceSegmentComputeSizesInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_create_entity_v1 import AudienceSegmentCreateEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_create_entity_v1_resource import AudienceSegmentCreateEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_delete_entity_v1_resource import AudienceSegmentDeleteEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1 import AudienceSegmentEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response import AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_list_response import AudienceSegmentEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_resource import AudienceSegmentEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_estimate_size_input_v1 import AudienceSegmentEstimateSizeInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_id_entity_v1_list_response import AudienceSegmentIdEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_id_entity_v1_resource import AudienceSegmentIdEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_entity_v1 import AudienceSegmentSearchEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_entity_v1_resource import AudienceSegmentSearchEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_input_v1 import AudienceSegmentSearchInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_metadata_v1 import AudienceSegmentSearchMetadataV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_entity_v1 import AudienceSegmentSizeEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_entity_v1_list_response import AudienceSegmentSizeEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_entity_v1_resource import AudienceSegmentSizeEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_entity_v1 import AudienceSegmentSizeEstimationEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_entity_v1_resource import AudienceSegmentSizeEstimationEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_v1 import AudienceSegmentSizeEstimationV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_v1_resource import AudienceSegmentSizeEstimationV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_v1_response import AudienceSegmentSizeEstimationV1Response +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_update_entity_v1 import AudienceSegmentUpdateEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_update_entity_v1_resource import AudienceSegmentUpdateEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_size_entity_v1 import AudienceSizeEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_size_entity_v1_list_response import AudienceSizeEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_size_entity_v1_resource import AudienceSizeEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_size_estimation_v1 import AudienceSizeEstimationV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_size_estimation_v1_resource import AudienceSizeEstimationV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_size_estimation_v1_response import AudienceSizeEstimationV1Response +from criteo_api_marketingsolutions_v2024_04.model.audience_update_entity_v1 import AudienceUpdateEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_update_entity_v1_resource import AudienceUpdateEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.audience_warning import AudienceWarning +from criteo_api_marketingsolutions_v2024_04.model.basic_audience_definition import BasicAudienceDefinition +from criteo_api_marketingsolutions_v2024_04.model.behavioral_v1 import BehavioralV1 +from criteo_api_marketingsolutions_v2024_04.model.campaign_search_filters_v23_q1 import CampaignSearchFiltersV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.campaign_search_request_v23_q1 import CampaignSearchRequestV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.campaign_spend_limit_v23_q1 import CampaignSpendLimitV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1 import CampaignV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_list_response import CampaignV23Q1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_resource import CampaignV23Q1Resource +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_response import CampaignV23Q1Response +from criteo_api_marketingsolutions_v2024_04.model.common_problem import CommonProblem +from criteo_api_marketingsolutions_v2024_04.model.contact_list_statistics_entity_v1 import ContactListStatisticsEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.contact_list_statistics_entity_v1_resource import ContactListStatisticsEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.contact_list_statistics_entity_v1_response import ContactListStatisticsEntityV1Response +from criteo_api_marketingsolutions_v2024_04.model.contact_list_v1 import ContactListV1 +from criteo_api_marketingsolutions_v2024_04.model.contactlist_amendment import ContactlistAmendment +from criteo_api_marketingsolutions_v2024_04.model.contactlist_amendment_attributes import ContactlistAmendmentAttributes +from criteo_api_marketingsolutions_v2024_04.model.contactlist_amendment_request import ContactlistAmendmentRequest +from criteo_api_marketingsolutions_v2024_04.model.contactlist_operation import ContactlistOperation +from criteo_api_marketingsolutions_v2024_04.model.contactlist_operation_attributes import ContactlistOperationAttributes +from criteo_api_marketingsolutions_v2024_04.model.coupon import Coupon +from criteo_api_marketingsolutions_v2024_04.model.coupon_list_response import CouponListResponse +from criteo_api_marketingsolutions_v2024_04.model.coupon_resource import CouponResource +from criteo_api_marketingsolutions_v2024_04.model.coupon_response import CouponResponse +from criteo_api_marketingsolutions_v2024_04.model.coupon_supported_sizes import CouponSupportedSizes +from criteo_api_marketingsolutions_v2024_04.model.coupon_supported_sizes_resource import CouponSupportedSizesResource +from criteo_api_marketingsolutions_v2024_04.model.coupon_supported_sizes_response import CouponSupportedSizesResponse +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set import CreateAdSet +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_bidding import CreateAdSetBidding +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_budget import CreateAdSetBudget +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_geo_location import CreateAdSetGeoLocation +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_request import CreateAdSetRequest +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_resource import CreateAdSetResource +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_schedule import CreateAdSetSchedule +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_targeting import CreateAdSetTargeting +from criteo_api_marketingsolutions_v2024_04.model.create_campaign import CreateCampaign +from criteo_api_marketingsolutions_v2024_04.model.create_campaign_request import CreateCampaignRequest +from criteo_api_marketingsolutions_v2024_04.model.create_campaign_resource import CreateCampaignResource +from criteo_api_marketingsolutions_v2024_04.model.create_campaign_spend_limit import CreateCampaignSpendLimit +from criteo_api_marketingsolutions_v2024_04.model.create_coupon import CreateCoupon +from criteo_api_marketingsolutions_v2024_04.model.create_coupon_request import CreateCouponRequest +from criteo_api_marketingsolutions_v2024_04.model.create_coupon_resource import CreateCouponResource +from criteo_api_marketingsolutions_v2024_04.model.create_image_slide import CreateImageSlide +from criteo_api_marketingsolutions_v2024_04.model.creative import Creative +from criteo_api_marketingsolutions_v2024_04.model.creative_list_response import CreativeListResponse +from criteo_api_marketingsolutions_v2024_04.model.creative_resource import CreativeResource +from criteo_api_marketingsolutions_v2024_04.model.creative_response import CreativeResponse +from criteo_api_marketingsolutions_v2024_04.model.creative_write import CreativeWrite +from criteo_api_marketingsolutions_v2024_04.model.creative_write_request import CreativeWriteRequest +from criteo_api_marketingsolutions_v2024_04.model.creative_write_resource import CreativeWriteResource +from criteo_api_marketingsolutions_v2024_04.model.criteo_api_error import CriteoApiError +from criteo_api_marketingsolutions_v2024_04.model.criteo_api_warning import CriteoApiWarning +from criteo_api_marketingsolutions_v2024_04.model.delete_audience_contact_list_response import DeleteAudienceContactListResponse +from criteo_api_marketingsolutions_v2024_04.model.dynamic_attributes import DynamicAttributes +from criteo_api_marketingsolutions_v2024_04.model.dynamic_write_attributes import DynamicWriteAttributes +from criteo_api_marketingsolutions_v2024_04.model.entity_of_portfolio_message import EntityOfPortfolioMessage +from criteo_api_marketingsolutions_v2024_04.model.error_code_response import ErrorCodeResponse +from criteo_api_marketingsolutions_v2024_04.model.get_portfolio_response import GetPortfolioResponse +from criteo_api_marketingsolutions_v2024_04.model.html_tag_attributes import HtmlTagAttributes +from criteo_api_marketingsolutions_v2024_04.model.html_tag_write_attributes import HtmlTagWriteAttributes +from criteo_api_marketingsolutions_v2024_04.model.image_attributes import ImageAttributes +from criteo_api_marketingsolutions_v2024_04.model.image_set import ImageSet +from criteo_api_marketingsolutions_v2024_04.model.image_set_base64 import ImageSetBase64 +from criteo_api_marketingsolutions_v2024_04.model.image_shape import ImageShape +from criteo_api_marketingsolutions_v2024_04.model.image_slide import ImageSlide +from criteo_api_marketingsolutions_v2024_04.model.image_write_attributes import ImageWriteAttributes +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_brand_entity_v1 import InMarketAudienceSegmentBrandEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_brand_entity_v1_list_response import InMarketAudienceSegmentBrandEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_brand_entity_v1_resource import InMarketAudienceSegmentBrandEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_interest_entity_v1 import InMarketAudienceSegmentInterestEntityV1 +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_interest_entity_v1_list_response import InMarketAudienceSegmentInterestEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_interest_entity_v1_resource import InMarketAudienceSegmentInterestEntityV1Resource +from criteo_api_marketingsolutions_v2024_04.model.in_market_create_v1 import InMarketCreateV1 +from criteo_api_marketingsolutions_v2024_04.model.in_market_size_estimation_v1 import InMarketSizeEstimationV1 +from criteo_api_marketingsolutions_v2024_04.model.in_market_update_v1 import InMarketUpdateV1 +from criteo_api_marketingsolutions_v2024_04.model.in_market_v1 import InMarketV1 +from criteo_api_marketingsolutions_v2024_04.model.location_create_v1 import LocationCreateV1 +from criteo_api_marketingsolutions_v2024_04.model.location_size_estimation_v1 import LocationSizeEstimationV1 +from criteo_api_marketingsolutions_v2024_04.model.location_update_v1 import LocationUpdateV1 +from criteo_api_marketingsolutions_v2024_04.model.location_v1 import LocationV1 +from criteo_api_marketingsolutions_v2024_04.model.lookalike_create_v1 import LookalikeCreateV1 +from criteo_api_marketingsolutions_v2024_04.model.lookalike_update_v1 import LookalikeUpdateV1 +from criteo_api_marketingsolutions_v2024_04.model.lookalike_v1 import LookalikeV1 +from criteo_api_marketingsolutions_v2024_04.model.modify_audience_response import ModifyAudienceResponse +from criteo_api_marketingsolutions_v2024_04.model.nillable_ad_set_targeting_rule import NillableAdSetTargetingRule +from criteo_api_marketingsolutions_v2024_04.model.nillable_ad_set_targeting_rule_v23_q1 import NillableAdSetTargetingRuleV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.nillable_ad_set_targeting_rule_v23_q1_value import NillableAdSetTargetingRuleV23Q1Value +from criteo_api_marketingsolutions_v2024_04.model.nillable_ad_set_targeting_rule_value import NillableAdSetTargetingRuleValue +from criteo_api_marketingsolutions_v2024_04.model.nillable_date_time import NillableDateTime +from criteo_api_marketingsolutions_v2024_04.model.nillable_decimal import NillableDecimal +from criteo_api_marketingsolutions_v2024_04.model.nillable_gender_v1 import NillableGenderV1 +from criteo_api_marketingsolutions_v2024_04.model.nillable_int32 import NillableInt32 +from criteo_api_marketingsolutions_v2024_04.model.nillable_string import NillableString +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set import PatchAdSet +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_bidding import PatchAdSetBidding +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_budget import PatchAdSetBudget +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid import PatchAdSetCategoryBid +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_list_request import PatchAdSetCategoryBidListRequest +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_resource import PatchAdSetCategoryBidResource +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_result_list_response import PatchAdSetCategoryBidResultListResponse +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_result_resource import PatchAdSetCategoryBidResultResource +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier import PatchAdSetDisplayMultiplier +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_list_request import PatchAdSetDisplayMultiplierListRequest +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_resource import PatchAdSetDisplayMultiplierResource +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_result_list_response import PatchAdSetDisplayMultiplierResultListResponse +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_result_resource import PatchAdSetDisplayMultiplierResultResource +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_scheduling import PatchAdSetScheduling +from criteo_api_marketingsolutions_v2024_04.model.patch_campaign import PatchCampaign +from criteo_api_marketingsolutions_v2024_04.model.patch_campaign_list_request import PatchCampaignListRequest +from criteo_api_marketingsolutions_v2024_04.model.patch_campaign_spend_limit import PatchCampaignSpendLimit +from criteo_api_marketingsolutions_v2024_04.model.patch_campaign_write_resource import PatchCampaignWriteResource +from criteo_api_marketingsolutions_v2024_04.model.patch_result_campaign_list_response import PatchResultCampaignListResponse +from criteo_api_marketingsolutions_v2024_04.model.patch_result_campaign_read_resource import PatchResultCampaignReadResource +from criteo_api_marketingsolutions_v2024_04.model.placements_report_query_data_message import PlacementsReportQueryDataMessage +from criteo_api_marketingsolutions_v2024_04.model.placements_report_query_entity_message import PlacementsReportQueryEntityMessage +from criteo_api_marketingsolutions_v2024_04.model.placements_report_query_message import PlacementsReportQueryMessage +from criteo_api_marketingsolutions_v2024_04.model.point_of_interest_v1 import PointOfInterestV1 +from criteo_api_marketingsolutions_v2024_04.model.portfolio_message import PortfolioMessage +from criteo_api_marketingsolutions_v2024_04.model.problem_details import ProblemDetails +from criteo_api_marketingsolutions_v2024_04.model.problems_details import ProblemsDetails +from criteo_api_marketingsolutions_v2024_04.model.prospecting_create_v1 import ProspectingCreateV1 +from criteo_api_marketingsolutions_v2024_04.model.prospecting_update_v1 import ProspectingUpdateV1 +from criteo_api_marketingsolutions_v2024_04.model.prospecting_v1 import ProspectingV1 +from criteo_api_marketingsolutions_v2024_04.model.read_ad_set import ReadAdSet +from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_bidding import ReadAdSetBidding +from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_bidding_v23_q1 import ReadAdSetBiddingV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_budget import ReadAdSetBudget +from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_budget_v23_q1 import ReadAdSetBudgetV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_schedule import ReadAdSetSchedule +from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_schedule_v23_q1 import ReadAdSetScheduleV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.read_ad_set_v23_q1 import ReadAdSetV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.read_model_ad_set_id import ReadModelAdSetId +from criteo_api_marketingsolutions_v2024_04.model.read_model_read_ad_set import ReadModelReadAdSet +from criteo_api_marketingsolutions_v2024_04.model.read_model_read_ad_set_v23_q1 import ReadModelReadAdSetV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.requests_ad_set_id import RequestsAdSetId +from criteo_api_marketingsolutions_v2024_04.model.requests_patch_ad_set import RequestsPatchAdSet +from criteo_api_marketingsolutions_v2024_04.model.response_read_ad_set import ResponseReadAdSet +from criteo_api_marketingsolutions_v2024_04.model.response_read_ad_set_v23_q1 import ResponseReadAdSetV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.responses_ad_set_id import ResponsesAdSetId +from criteo_api_marketingsolutions_v2024_04.model.responses_read_ad_set_v23_q1 import ResponsesReadAdSetV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.retargeting_create_v1 import RetargetingCreateV1 +from criteo_api_marketingsolutions_v2024_04.model.retargeting_update_v1 import RetargetingUpdateV1 +from criteo_api_marketingsolutions_v2024_04.model.retargeting_v1 import RetargetingV1 +from criteo_api_marketingsolutions_v2024_04.model.size import Size +from criteo_api_marketingsolutions_v2024_04.model.statistics_report_query_message import StatisticsReportQueryMessage +from criteo_api_marketingsolutions_v2024_04.model.tag import Tag +from criteo_api_marketingsolutions_v2024_04.model.transactions_report_query_data_message import TransactionsReportQueryDataMessage +from criteo_api_marketingsolutions_v2024_04.model.transactions_report_query_entity_message import TransactionsReportQueryEntityMessage +from criteo_api_marketingsolutions_v2024_04.model.transactions_report_query_message import TransactionsReportQueryMessage +from criteo_api_marketingsolutions_v2024_04.model.transparency_query_message import TransparencyQueryMessage +from criteo_api_marketingsolutions_v2024_04.model.transparency_report_attributes import TransparencyReportAttributes +from criteo_api_marketingsolutions_v2024_04.model.transparency_report_data_message import TransparencyReportDataMessage +from criteo_api_marketingsolutions_v2024_04.model.transparency_report_entity_message import TransparencyReportEntityMessage +from criteo_api_marketingsolutions_v2024_04.model.transparency_report_file import TransparencyReportFile +from criteo_api_marketingsolutions_v2024_04.model.update_coupon import UpdateCoupon +from criteo_api_marketingsolutions_v2024_04.model.update_coupon_request import UpdateCouponRequest +from criteo_api_marketingsolutions_v2024_04.model.update_coupon_resource import UpdateCouponResource +from criteo_api_marketingsolutions_v2024_04.model.video_detail import VideoDetail +from criteo_api_marketingsolutions_v2024_04.model.write_model_ad_set_id import WriteModelAdSetId +from criteo_api_marketingsolutions_v2024_04.model.write_model_patch_ad_set import WriteModelPatchAdSet diff --git a/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/rest.py b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/rest.py new file mode 100644 index 00000000..8a9993ac --- /dev/null +++ b/sdks/marketingsolutions_2024-04/criteo_api_marketingsolutions_v2024_04/rest.py @@ -0,0 +1,352 @@ +""" + Criteo API + + Criteo API - MarketingSolutions # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import io +import json +import logging +import re +import ssl +from urllib.parse import urlencode +from urllib.parse import urlparse +from urllib.request import proxy_bypass_environment +import urllib3 +import ipaddress + +from criteo_api_marketingsolutions_v2024_04.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError + + +logger = logging.getLogger(__name__) + + +class RESTResponse(io.IOBase): + + def __init__(self, resp): + self.urllib3_response = resp + self.status = resp.status + self.reason = resp.reason + self.data = resp.data + + def getheaders(self): + """Returns a dictionary of the response headers.""" + return self.urllib3_response.getheaders() + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.urllib3_response.getheader(name, default) + + +class RESTClientObject(object): + + def __init__(self, configuration, pools_size=4, maxsize=None): + # urllib3.PoolManager will pass all kw parameters to connectionpool + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 + + # cert_reqs + if configuration.verify_ssl: + cert_reqs = ssl.CERT_REQUIRED + else: + cert_reqs = ssl.CERT_NONE + + addition_pool_args = {} + if configuration.assert_hostname is not None: + addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 + + if configuration.retries is not None: + addition_pool_args['retries'] = configuration.retries + + if configuration.socket_options is not None: + addition_pool_args['socket_options'] = configuration.socket_options + + if maxsize is None: + if configuration.connection_pool_maxsize is not None: + maxsize = configuration.connection_pool_maxsize + else: + maxsize = 4 + + # https pool manager + if configuration.proxy and not should_bypass_proxies( + configuration.host, no_proxy=configuration.no_proxy or ''): + self.pool_manager = urllib3.ProxyManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + proxy_url=configuration.proxy, + proxy_headers=configuration.proxy_headers, + **addition_pool_args + ) + else: + self.pool_manager = urllib3.PoolManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + **addition_pool_args + ) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + """Perform requests. + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: 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. + """ + method = method.upper() + assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', + 'PATCH', 'OPTIONS'] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + post_params = post_params or {} + headers = headers or {} + + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 + timeout = urllib3.Timeout(total=_request_timeout) + elif (isinstance(_request_timeout, tuple) and + len(_request_timeout) == 2): + timeout = urllib3.Timeout( + connect=_request_timeout[0], read=_request_timeout[1]) + + try: + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + # Only set a default Content-Type for POST, PUT, PATCH and OPTIONS requests + if (method != 'DELETE') and ('Content-Type' not in headers): + headers['Content-Type'] = 'application/json' + if query_params: + url += '?' + urlencode(query_params) + if ('Content-Type' not in headers) or (re.search('json', + headers['Content-Type'], re.IGNORECASE)): + request_body = None + if body is not None: + request_body = json.dumps(body) + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=False, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. + del headers['Content-Type'] + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=True, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + # Pass a `string` parameter directly in the body to support + # other content types than Json when `body` argument is + # provided in serialized form + elif isinstance(body, str) or isinstance(body, bytes): + request_body = body + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + # For `GET`, `HEAD` + else: + r = self.pool_manager.request(method, url, + fields=query_params, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + except urllib3.exceptions.SSLError as e: + msg = "{0}\n{1}".format(type(e).__name__, str(e)) + raise ApiException(status=0, reason=msg) + + if _preload_content: + r = RESTResponse(r) + + # log response body + logger.debug("response body: %s", r.data) + + if not 200 <= r.status <= 299: + if r.status == 401: + raise UnauthorizedException(http_resp=r) + + if r.status == 403: + raise ForbiddenException(http_resp=r) + + if r.status == 404: + raise NotFoundException(http_resp=r) + + if 500 <= r.status <= 599: + raise ServiceException(http_resp=r) + + raise ApiException(http_resp=r) + + return r + + def GET(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("GET", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def HEAD(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("HEAD", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def OPTIONS(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("OPTIONS", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def DELETE(self, url, headers=None, query_params=None, body=None, + _preload_content=True, _request_timeout=None): + return self.request("DELETE", url, + headers=headers, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def POST(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("POST", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PUT(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PUT", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PATCH(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PATCH", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + +# end of class RESTClientObject + + +def is_ipv4(target): + """ Test if IPv4 address or not + """ + try: + chk = ipaddress.IPv4Address(target) + return True + except ipaddress.AddressValueError: + return False + + +def in_ipv4net(target, net): + """ Test if target belongs to given IPv4 network + """ + try: + nw = ipaddress.IPv4Network(net) + ip = ipaddress.IPv4Address(target) + if ip in nw: + return True + return False + except ipaddress.AddressValueError: + return False + except ipaddress.NetmaskValueError: + return False + + +def should_bypass_proxies(url, no_proxy=None): + """ Yet another requests.should_bypass_proxies + Test if proxies should not be used for a particular url. + """ + + parsed = urlparse(url) + + # special cases + if parsed.hostname in [None, '']: + return True + + # special cases + if no_proxy in [None, '']: + return False + if no_proxy == '*': + return True + + no_proxy = no_proxy.lower().replace(' ', ''); + entries = ( + host for host in no_proxy.split(',') if host + ) + + if is_ipv4(parsed.hostname): + for item in entries: + if in_ipv4net(parsed.hostname, item): + return True + return proxy_bypass_environment(parsed.hostname, {'no': no_proxy}) diff --git a/sdks/marketingsolutions_2024-04/docs/Ad.md b/sdks/marketingsolutions_2024-04/docs/Ad.md new file mode 100644 index 00000000..8bb233e5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/Ad.md @@ -0,0 +1,19 @@ +# Ad + +An ad is the binding that connects a creative with an ad set + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | The name of the ad | [optional] +**description** | **str, none_type** | The description of the ad | [optional] +**creative_id** | **str, none_type** | The id of the Creative binded to this Ad | [optional] +**ad_set_id** | **str, none_type** | The id of the Ad Set binded to this Ad | [optional] +**inventory_type** | **str, none_type** | The inventory the Ad belongs to. Possible values are \"Display\" and \"Native\". This is optional since this doesn't make sense for every creative type but will throw an error if not set for a dynamic creative. | [optional] +**start_date** | **str, none_type** | The date when the ad will be launched String must be in ISO8601 format | [optional] +**end_date** | **str, none_type** | The date when when we will stop to show this ad. If the end date is not specified (i.e. null) then the ad will go on forever String must be in ISO8601 format | [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_2024-04/docs/AdListResponse.md b/sdks/marketingsolutions_2024-04/docs/AdListResponse.md new file mode 100644 index 00000000..be5c8ca6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdListResponse.md @@ -0,0 +1,15 @@ +# AdListResponse + +Data model for a list of response resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AdResource], none_type**](AdResource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AdResource.md b/sdks/marketingsolutions_2024-04/docs/AdResource.md new file mode 100644 index 00000000..0037a3fa --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdResource.md @@ -0,0 +1,15 @@ +# AdResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**Ad**](Ad.md) | | [optional] +**id** | **str, none_type** | | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AdResponse.md b/sdks/marketingsolutions_2024-04/docs/AdResponse.md new file mode 100644 index 00000000..c6867e90 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdResponse.md @@ -0,0 +1,15 @@ +# AdResponse + +Data model for response resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AdResource**](AdResource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1.md new file mode 100644 index 00000000..1e914dc8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1.md @@ -0,0 +1,13 @@ +# AdSetAudienceLinkEntityV1 + +Link Audience with an ad set + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**audience_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/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1Resource.md new file mode 100644 index 00000000..e36a8036 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1Resource.md @@ -0,0 +1,15 @@ +# AdSetAudienceLinkEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AdSetAudienceLinkEntityV1**](AdSetAudienceLinkEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1Response.md b/sdks/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1Response.md new file mode 100644 index 00000000..bbdfcd1b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetAudienceLinkEntityV1Response.md @@ -0,0 +1,15 @@ +# AdSetAudienceLinkEntityV1Response + +A top-level object that encapsulates a Criteo API response for a single entity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AdSetAudienceLinkEntityV1Resource**](AdSetAudienceLinkEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AdSetAudienceLinkInputEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AdSetAudienceLinkInputEntityV1.md new file mode 100644 index 00000000..c7d36dc7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetAudienceLinkInputEntityV1.md @@ -0,0 +1,13 @@ +# AdSetAudienceLinkInputEntityV1 + +Input to set audience ad set link. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AdSetAudienceLinkEntityV1Resource**](AdSetAudienceLinkEntityV1Resource.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/marketingsolutions_2023-01/docs/AdSetCategoryBid.md b/sdks/marketingsolutions_2024-04/docs/AdSetCategoryBid.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetCategoryBid.md rename to sdks/marketingsolutions_2024-04/docs/AdSetCategoryBid.md diff --git a/sdks/marketingsolutions_2023-01/docs/AdSetCategoryBidListResponse.md b/sdks/marketingsolutions_2024-04/docs/AdSetCategoryBidListResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetCategoryBidListResponse.md rename to sdks/marketingsolutions_2024-04/docs/AdSetCategoryBidListResponse.md diff --git a/sdks/marketingsolutions_2023-01/docs/AdSetCategoryBidResource.md b/sdks/marketingsolutions_2024-04/docs/AdSetCategoryBidResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetCategoryBidResource.md rename to sdks/marketingsolutions_2024-04/docs/AdSetCategoryBidResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/AdSetDeliveryLimitations.md b/sdks/marketingsolutions_2024-04/docs/AdSetDeliveryLimitations.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetDeliveryLimitations.md rename to sdks/marketingsolutions_2024-04/docs/AdSetDeliveryLimitations.md diff --git a/sdks/marketingsolutions_2024-04/docs/AdSetDeliveryLimitationsV23Q1.md b/sdks/marketingsolutions_2024-04/docs/AdSetDeliveryLimitationsV23Q1.md new file mode 100644 index 00000000..06fcb32c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetDeliveryLimitationsV23Q1.md @@ -0,0 +1,15 @@ +# AdSetDeliveryLimitationsV23Q1 + +ad set delivery limitations model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**environments** | **[str], none_type** | | [optional] +**devices** | **[str], none_type** | | [optional] +**operating_systems** | **[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/marketingsolutions_2023-01/docs/AdSetDisplayMultiplier.md b/sdks/marketingsolutions_2024-04/docs/AdSetDisplayMultiplier.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetDisplayMultiplier.md rename to sdks/marketingsolutions_2024-04/docs/AdSetDisplayMultiplier.md diff --git a/sdks/marketingsolutions_2023-01/docs/AdSetDisplayMultiplierListResponse.md b/sdks/marketingsolutions_2024-04/docs/AdSetDisplayMultiplierListResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetDisplayMultiplierListResponse.md rename to sdks/marketingsolutions_2024-04/docs/AdSetDisplayMultiplierListResponse.md diff --git a/sdks/marketingsolutions_2023-01/docs/AdSetDisplayMultiplierResource.md b/sdks/marketingsolutions_2024-04/docs/AdSetDisplayMultiplierResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetDisplayMultiplierResource.md rename to sdks/marketingsolutions_2024-04/docs/AdSetDisplayMultiplierResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/AdSetFrequencyCapping.md b/sdks/marketingsolutions_2024-04/docs/AdSetFrequencyCapping.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetFrequencyCapping.md rename to sdks/marketingsolutions_2024-04/docs/AdSetFrequencyCapping.md diff --git a/sdks/marketingsolutions_2024-04/docs/AdSetFrequencyCappingV23Q1.md b/sdks/marketingsolutions_2024-04/docs/AdSetFrequencyCappingV23Q1.md new file mode 100644 index 00000000..3699d1e2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetFrequencyCappingV23Q1.md @@ -0,0 +1,15 @@ +# AdSetFrequencyCappingV23Q1 + +ad set frequency capping model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**frequency** | **str, none_type** | | [optional] +**maximum_impressions** | **int, none_type** | | [optional] +**mode** | **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/marketingsolutions_2023-01/docs/AdSetGeoLocation.md b/sdks/marketingsolutions_2024-04/docs/AdSetGeoLocation.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetGeoLocation.md rename to sdks/marketingsolutions_2024-04/docs/AdSetGeoLocation.md diff --git a/sdks/marketingsolutions_2024-04/docs/AdSetGeoLocationV23Q1.md b/sdks/marketingsolutions_2024-04/docs/AdSetGeoLocationV23Q1.md new file mode 100644 index 00000000..fcfd363d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetGeoLocationV23Q1.md @@ -0,0 +1,15 @@ +# AdSetGeoLocationV23Q1 + +ad set geolocation model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**countries** | [**NillableAdSetTargetingRuleV23Q1**](NillableAdSetTargetingRuleV23Q1.md) | | [optional] +**subdivisions** | [**NillableAdSetTargetingRuleV23Q1**](NillableAdSetTargetingRuleV23Q1.md) | | [optional] +**zip_codes** | [**NillableAdSetTargetingRuleV23Q1**](NillableAdSetTargetingRuleV23Q1.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/marketingsolutions_2024-04/docs/AdSetSearchFilterV23Q1.md b/sdks/marketingsolutions_2024-04/docs/AdSetSearchFilterV23Q1.md new file mode 100644 index 00000000..a7794a82 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetSearchFilterV23Q1.md @@ -0,0 +1,15 @@ +# AdSetSearchFilterV23Q1 + +filter on ad set ids + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ad_set_ids** | **[str], none_type** | | [optional] +**advertiser_ids** | **[str], none_type** | | [optional] +**campaign_ids** | **[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/marketingsolutions_2024-04/docs/AdSetSearchRequestV23Q1.md b/sdks/marketingsolutions_2024-04/docs/AdSetSearchRequestV23Q1.md new file mode 100644 index 00000000..ccfd9cf7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetSearchRequestV23Q1.md @@ -0,0 +1,13 @@ +# AdSetSearchRequestV23Q1 + +request payload of the search endpoint + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filters** | [**AdSetSearchFilterV23Q1**](AdSetSearchFilterV23Q1.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/marketingsolutions_2023-01/docs/AdSetTargeting.md b/sdks/marketingsolutions_2024-04/docs/AdSetTargeting.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetTargeting.md rename to sdks/marketingsolutions_2024-04/docs/AdSetTargeting.md diff --git a/sdks/marketingsolutions_2023-01/docs/AdSetTargetingRule.md b/sdks/marketingsolutions_2024-04/docs/AdSetTargetingRule.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AdSetTargetingRule.md rename to sdks/marketingsolutions_2024-04/docs/AdSetTargetingRule.md diff --git a/sdks/marketingsolutions_2024-04/docs/AdSetTargetingRuleV23Q1.md b/sdks/marketingsolutions_2024-04/docs/AdSetTargetingRuleV23Q1.md new file mode 100644 index 00000000..1cbdab55 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetTargetingRuleV23Q1.md @@ -0,0 +1,14 @@ +# AdSetTargetingRuleV23Q1 + +ad set targeting rule model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operand** | **str, none_type** | | [optional] +**values** | **[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/marketingsolutions_2024-04/docs/AdSetTargetingV23Q1.md b/sdks/marketingsolutions_2024-04/docs/AdSetTargetingV23Q1.md new file mode 100644 index 00000000..ad1e20e2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdSetTargetingV23Q1.md @@ -0,0 +1,15 @@ +# AdSetTargetingV23Q1 + +ad set targeting model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**delivery_limitations** | [**AdSetDeliveryLimitationsV23Q1**](AdSetDeliveryLimitationsV23Q1.md) | | [optional] +**geo_location** | [**AdSetGeoLocationV23Q1**](AdSetGeoLocationV23Q1.md) | | [optional] +**frequency_capping** | [**AdSetFrequencyCappingV23Q1**](AdSetFrequencyCappingV23Q1.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/marketingsolutions_2024-04/docs/AdWrite.md b/sdks/marketingsolutions_2024-04/docs/AdWrite.md new file mode 100644 index 00000000..20476c06 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdWrite.md @@ -0,0 +1,19 @@ +# AdWrite + +Entity to create or update an ad + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the ad | +**creative_id** | **str** | The id of the Creative bound to this Ad | +**ad_set_id** | **str** | The id of the Ad Set bound to this Ad | +**start_date** | **str** | The date when the ad will be launched String must be in ISO8601 format | +**description** | **str, none_type** | The description of the ad | [optional] +**inventory_type** | **str, none_type** | The inventory the Ad to be created or updated belongs to. Possible values are \"Display\" and \"Native\". This is optional since this doesn't make sense for every creative type but will throw an error if not set for a dynamic creative. | [optional] +**end_date** | **str, none_type** | The date when when we will stop to show this ad. If the end date is not specified (i.e. null) then the ad will go on forever String must be in ISO8601 format | [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_2024-04/docs/AdWriteRequest.md b/sdks/marketingsolutions_2024-04/docs/AdWriteRequest.md new file mode 100644 index 00000000..d6ae0b45 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdWriteRequest.md @@ -0,0 +1,13 @@ +# AdWriteRequest + +Data model for input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AdWriteResource**](AdWriteResource.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/marketingsolutions_2024-04/docs/AdWriteResource.md b/sdks/marketingsolutions_2024-04/docs/AdWriteResource.md new file mode 100644 index 00000000..df8ba8c6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdWriteResource.md @@ -0,0 +1,15 @@ +# AdWriteResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AdWrite**](AdWrite.md) | | [optional] +**id** | **str, none_type** | | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AdaptiveAttributes.md b/sdks/marketingsolutions_2024-04/docs/AdaptiveAttributes.md new file mode 100644 index 00000000..17d5da16 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdaptiveAttributes.md @@ -0,0 +1,24 @@ +# AdaptiveAttributes + +The attributes specific to Adaptive creatives + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**layouts** | **[str]** | The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\". | +**logos** | [**[ImageShape]**](ImageShape.md) | Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net | +**headline_text** | **str** | The headline text of the banner | +**headline_font** | **str** | Font of the headline Valid supported font like \"Arial\" | +**description_text** | **str** | The description text of the banner | +**description_font** | **str** | Font of the description Valid supported font like \"Arial\" | +**calls_to_action** | **[str]** | A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. | +**colors** | [**AdaptiveColors**](AdaptiveColors.md) | | +**landing_page_url** | **str** | Web redirection of the landing page url | +**image_sets** | [**[ImageSet], none_type**](ImageSet.md) | Multiple image sets, each image set consists of multiple images and a headline text. | [optional] +**image_display** | **str, none_type** | Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping. | [optional] +**videos** | [**[VideoDetail], none_type**](VideoDetail.md) | Multiple videos potentially in different shapes. | [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_2024-04/docs/AdaptiveColors.md b/sdks/marketingsolutions_2024-04/docs/AdaptiveColors.md new file mode 100644 index 00000000..1d5d2f8e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdaptiveColors.md @@ -0,0 +1,18 @@ +# AdaptiveColors + +Entity consists of the color aliases of the creative's elements + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**logo_area_and_title_color** | **str** | Color of the creative's logo area. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). | +**background_color** | **str** | Color of the creative's background. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") | +**text1_color** | **str** | Color of the headline and the description texts. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") | +**text2_color** | **str** | Color of the image set's headline text. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\") | +**cta_background_color** | **str** | Color of the background of the CTA. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). | +**cta_text_color** | **str** | Color of the text of the CTA. A valid RGB24 color in hexadecimal (e.g. \"AB00FF\"). | +**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_2024-04/docs/AdaptiveWriteAttributes.md b/sdks/marketingsolutions_2024-04/docs/AdaptiveWriteAttributes.md new file mode 100644 index 00000000..04a98b9c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AdaptiveWriteAttributes.md @@ -0,0 +1,24 @@ +# AdaptiveWriteAttributes + +The attributes specific to create or update an Adaptive creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**layouts** | **[str]** | The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\". | +**logo_base64_string** | **str** | Logo image as a base-64 encoded string | +**headline_text** | **str** | The headline text of the banner | +**headline_font** | **str** | Font of the headline Valid supported font like \"Arial\" | +**description_text** | **str** | The description text of the banner | +**description_font** | **str** | Font of the description Valid supported font like \"Arial\" | +**calls_to_action** | **[str]** | A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. | +**colors** | [**AdaptiveColors**](AdaptiveColors.md) | | +**landing_page_url** | **str** | Web redirection of the landing page url. | +**image_sets_base64** | [**[ImageSetBase64], none_type**](ImageSetBase64.md) | Multiple image sets, each image set consists of multiple images as a base-64 encoded string and a headline text. | [optional] +**image_display** | **str, none_type** | Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping. | [optional] +**video_base64_strings** | **[str], none_type** | Multiple videos potentially in different shapes, each video is a base-64 encoded string. | [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_2023-01/docs/AdvertiserApi.md b/sdks/marketingsolutions_2024-04/docs/AdvertiserApi.md similarity index 80% rename from sdks/marketingsolutions_2023-01/docs/AdvertiserApi.md rename to sdks/marketingsolutions_2024-04/docs/AdvertiserApi.md index 5b00a84a..6cbe66f3 100644 --- a/sdks/marketingsolutions_2023-01/docs/AdvertiserApi.md +++ b/sdks/marketingsolutions_2024-04/docs/AdvertiserApi.md @@ -1,10 +1,10 @@ -# criteo_api_marketingsolutions_v2023_01.AdvertiserApi +# criteo_api_marketingsolutions_v2024_04.AdvertiserApi All URIs are relative to *https://api.criteo.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**api_portfolio_get**](AdvertiserApi.md#api_portfolio_get) | **GET** /2023-01/advertisers/me | +[**api_portfolio_get**](AdvertiserApi.md#api_portfolio_get) | **GET** /2024-04/advertisers/me | # **api_portfolio_get** @@ -21,13 +21,13 @@ Fetch the portfolio of Advertisers for this account ```python import time -import criteo_api_marketingsolutions_v2023_01 -from criteo_api_marketingsolutions_v2023_01.api import advertiser_api -from criteo_api_marketingsolutions_v2023_01.model.get_portfolio_response import GetPortfolioResponse +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import advertiser_api +from criteo_api_marketingsolutions_v2024_04.model.get_portfolio_response import GetPortfolioResponse 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_marketingsolutions_v2023_01.Configuration( +configuration = criteo_api_marketingsolutions_v2024_04.Configuration( host = "https://api.criteo.com" ) @@ -37,19 +37,19 @@ configuration = criteo_api_marketingsolutions_v2023_01.Configuration( # satisfies your auth use case. # Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.Configuration( +configuration = criteo_api_marketingsolutions_v2024_04.Configuration( host = "https://api.criteo.com" ) configuration.access_token = 'YOUR_ACCESS_TOKEN' # Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_marketingsolutions_v2023_01.Configuration( +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2023_01.ApiClient(configuration) as api_client: +with criteo_api_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = advertiser_api.AdvertiserApi(api_client) @@ -57,7 +57,7 @@ with criteo_api_marketingsolutions_v2023_01.ApiClient(configuration) as api_clie try: api_response = api_instance.api_portfolio_get() pprint(api_response) - except criteo_api_marketingsolutions_v2023_01.ApiException as e: + except criteo_api_marketingsolutions_v2024_04.ApiException as e: print("Exception when calling AdvertiserApi->api_portfolio_get: %s\n" % e) ``` diff --git a/sdks/marketingsolutions_2024-04/docs/AlgebraNodeV1.md b/sdks/marketingsolutions_2024-04/docs/AlgebraNodeV1.md new file mode 100644 index 00000000..3c3cd88c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AlgebraNodeV1.md @@ -0,0 +1,16 @@ +# AlgebraNodeV1 + +Node in the audience algebra definition. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_and** | [**[AlgebraNodeV1], none_type**](AlgebraNodeV1.md) | | [optional] +**_or** | [**[AlgebraNodeV1], none_type**](AlgebraNodeV1.md) | | [optional] +**_not** | [**AlgebraNodeV1**](AlgebraNodeV1.md) | | [optional] +**audience_segment_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/marketingsolutions_2024-04/docs/AnalyticsApi.md b/sdks/marketingsolutions_2024-04/docs/AnalyticsApi.md new file mode 100644 index 00000000..5eb49ad6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AnalyticsApi.md @@ -0,0 +1,440 @@ +# criteo_api_marketingsolutions_v2024_04.AnalyticsApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_adset_report**](AnalyticsApi.md#get_adset_report) | **POST** /2024-04/statistics/report | +[**get_placements_report**](AnalyticsApi.md#get_placements_report) | **POST** /2024-04/placements/report | +[**get_transactions_report**](AnalyticsApi.md#get_transactions_report) | **POST** /2024-04/transactions/report | +[**get_transparency_report**](AnalyticsApi.md#get_transparency_report) | **POST** /2024-04/log-level/advertisers/{advertiser-id}/report | + + +# **get_adset_report** +> file_type get_adset_report() + + + +This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import analytics_api +from criteo_api_marketingsolutions_v2024_04.model.problems_details import ProblemsDetails +from criteo_api_marketingsolutions_v2024_04.model.statistics_report_query_message import StatisticsReportQueryMessage +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + statistics_report_query_message = StatisticsReportQueryMessage( + advertiser_ids="advertiser_ids_example", + ad_set_ids=[ + "ad_set_ids_example", + ], + ad_set_names=[ + "ad_set_names_example", + ], + ad_set_status=[ + "ad_set_status_example", + ], + dimensions=[ + "AdsetId", + ], + metrics=[ + "metrics_example", + ], + currency="currency_example", + format="format_example", + timezone="UTC", + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + ) # StatisticsReportQueryMessage | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_adset_report(statistics_report_query_message=statistics_report_query_message) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->get_adset_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **statistics_report_query_message** | [**StatisticsReportQueryMessage**](StatisticsReportQueryMessage.md)| | [optional] + +### Return type + +**file_type** + +### 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, text/csv, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + + +### 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) + +# **get_placements_report** +> file_type get_placements_report() + + + +Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import analytics_api +from criteo_api_marketingsolutions_v2024_04.model.problems_details import ProblemsDetails +from criteo_api_marketingsolutions_v2024_04.model.placements_report_query_data_message import PlacementsReportQueryDataMessage +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + placements_report_query_data_message = PlacementsReportQueryDataMessage( + data=[ + PlacementsReportQueryEntityMessage( + type="type_example", + attributes=PlacementsReportQueryMessage( + advertiser_ids="advertiser_ids_example", + campaign_ids="campaign_ids_example", + adset_ids="adset_ids_example", + environment="environment_example", + placement="placement_example", + dimensions=[ + "AdsetId", + ], + metrics=[ + "metrics_example", + ], + currency="currency_example", + disclosed=True, + format="format_example", + timezone="UTC", + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + ), + ), + ], + ) # PlacementsReportQueryDataMessage | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_placements_report(placements_report_query_data_message=placements_report_query_data_message) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->get_placements_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **placements_report_query_data_message** | [**PlacementsReportQueryDataMessage**](PlacementsReportQueryDataMessage.md)| | [optional] + +### Return type + +**file_type** + +### 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, text/csv, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + + +### 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) + +# **get_transactions_report** +> file_type get_transactions_report() + + + +This Transactions endpoint provides transactions id related data. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import analytics_api +from criteo_api_marketingsolutions_v2024_04.model.problems_details import ProblemsDetails +from criteo_api_marketingsolutions_v2024_04.model.transactions_report_query_data_message import TransactionsReportQueryDataMessage +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + transactions_report_query_data_message = TransactionsReportQueryDataMessage( + data=[ + TransactionsReportQueryEntityMessage( + type="type_example", + attributes=TransactionsReportQueryMessage( + advertiser_ids="advertiser_ids_example", + event_type="event_type_example", + currency="currency_example", + format="format_example", + timezone="UTC", + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + ), + ), + ], + ) # TransactionsReportQueryDataMessage | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_transactions_report(transactions_report_query_data_message=transactions_report_query_data_message) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->get_transactions_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transactions_report_query_data_message** | [**TransactionsReportQueryDataMessage**](TransactionsReportQueryDataMessage.md)| | [optional] + +### Return type + +**file_type** + +### 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, text/csv, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + + +### 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) + +# **get_transparency_report** +> TransparencyReportDataMessage get_transparency_report(advertiser_id) + + + +This Statistics endpoint provides publisher data. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import analytics_api +from criteo_api_marketingsolutions_v2024_04.model.transparency_report_data_message import TransparencyReportDataMessage +from criteo_api_marketingsolutions_v2024_04.model.problems_details import ProblemsDetails +from criteo_api_marketingsolutions_v2024_04.model.transparency_query_message import TransparencyQueryMessage +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + advertiser_id = 1 # int | The advertiser id to fetch the transparency data. + transparency_query_message = TransparencyQueryMessage( + should_display_product_ids=False, + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + ) # TransparencyQueryMessage | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_transparency_report(advertiser_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->get_transparency_report: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_transparency_report(advertiser_id, transparency_query_message=transparency_query_message) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->get_transparency_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **int**| The advertiser id to fetch the transparency data. | + **transparency_query_message** | [**TransparencyQueryMessage**](TransparencyQueryMessage.md)| | [optional] + +### Return type + +[**TransparencyReportDataMessage**](TransparencyReportDataMessage.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, text/plain, 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) + diff --git a/sdks/marketingsolutions_2023-01/docs/ApplicationSummaryModel.md b/sdks/marketingsolutions_2024-04/docs/ApplicationSummaryModel.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ApplicationSummaryModel.md rename to sdks/marketingsolutions_2024-04/docs/ApplicationSummaryModel.md diff --git a/sdks/marketingsolutions_2023-01/docs/ApplicationSummaryModelResource.md b/sdks/marketingsolutions_2024-04/docs/ApplicationSummaryModelResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ApplicationSummaryModelResource.md rename to sdks/marketingsolutions_2024-04/docs/ApplicationSummaryModelResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/ApplicationSummaryModelResponse.md b/sdks/marketingsolutions_2024-04/docs/ApplicationSummaryModelResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ApplicationSummaryModelResponse.md rename to sdks/marketingsolutions_2024-04/docs/ApplicationSummaryModelResponse.md diff --git a/sdks/marketingsolutions_2024-04/docs/AudienceApi.md b/sdks/marketingsolutions_2024-04/docs/AudienceApi.md new file mode 100644 index 00000000..361170cd --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceApi.md @@ -0,0 +1,1826 @@ +# criteo_api_marketingsolutions_v2024_04.AudienceApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**bulk_create_audience_segments**](AudienceApi.md#bulk_create_audience_segments) | **POST** /2024-04/marketing-solutions/audience-segments/create | +[**bulk_create_audiences**](AudienceApi.md#bulk_create_audiences) | **POST** /2024-04/marketing-solutions/audiences/create | +[**bulk_delete_audience_segments**](AudienceApi.md#bulk_delete_audience_segments) | **POST** /2024-04/marketing-solutions/audience-segments/delete | +[**bulk_delete_audiences**](AudienceApi.md#bulk_delete_audiences) | **POST** /2024-04/marketing-solutions/audiences/delete | +[**bulk_update_audience_segments**](AudienceApi.md#bulk_update_audience_segments) | **PATCH** /2024-04/marketing-solutions/audience-segments | +[**bulk_update_audiences**](AudienceApi.md#bulk_update_audiences) | **PATCH** /2024-04/marketing-solutions/audiences | +[**compute_audience_segments_sizes**](AudienceApi.md#compute_audience_segments_sizes) | **POST** /2024-04/marketing-solutions/audience-segments/compute-sizes | +[**compute_audiences_sizes**](AudienceApi.md#compute_audiences_sizes) | **POST** /2024-04/marketing-solutions/audiences/compute-sizes | +[**delete_contact_list_identifiers**](AudienceApi.md#delete_contact_list_identifiers) | **DELETE** /2024-04/marketing-solutions/audience-segments/{audience-segment-id}/contact-list | +[**estimate_audience_segment_size**](AudienceApi.md#estimate_audience_segment_size) | **POST** /2024-04/marketing-solutions/audience-segments/estimate-size | +[**estimate_audience_size**](AudienceApi.md#estimate_audience_size) | **POST** /2024-04/marketing-solutions/audiences/estimate-size | +[**get_audience_segment_contact_list_statistics**](AudienceApi.md#get_audience_segment_contact_list_statistics) | **GET** /2024-04/marketing-solutions/audience-segments/{audience-segment-id}/contact-list/statistics | +[**get_audience_segments_in_market_brands**](AudienceApi.md#get_audience_segments_in_market_brands) | **GET** /2024-04/marketing-solutions/audience-segments/in-market-brands | +[**get_audience_segments_in_market_interests**](AudienceApi.md#get_audience_segments_in_market_interests) | **GET** /2024-04/marketing-solutions/audience-segments/in-market-interests | +[**search_audience_segments**](AudienceApi.md#search_audience_segments) | **POST** /2024-04/marketing-solutions/audience-segments/search | +[**search_audiences**](AudienceApi.md#search_audiences) | **POST** /2024-04/marketing-solutions/audiences/search | +[**update_contact_list_identifiers**](AudienceApi.md#update_contact_list_identifiers) | **PATCH** /2024-04/marketing-solutions/audience-segments/{audience-segment-id}/contact-list | + + +# **bulk_create_audience_segments** +> AudienceSegmentEntityV1ListResponse bulk_create_audience_segments(audience_segment_bulk_create_input_v1) + + + +Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_create_input_v1 import AudienceSegmentBulkCreateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_list_response import AudienceSegmentEntityV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_bulk_create_input_v1 = AudienceSegmentBulkCreateInputV1( + data=[ + AudienceSegmentCreateEntityV1Resource( + type="type_example", + attributes=AudienceSegmentCreateEntityV1( + name="name_example", + description="description_example", + advertiser_id="advertiser_id_example", + in_market=InMarketCreateV1( + country="country_example", + buying_power=[ + "Low", + ], + gender="Male", + interest_ids=[ + "interest_ids_example", + ], + brand_ids=[ + "brand_ids_example", + ], + price_range=[ + "Low", + ], + ), + prospecting=ProspectingCreateV1( + days_since_last_visit_min=1, + days_since_last_visit_max=1, + users_type="Prospects", + ), + contact_list={}, + location=LocationCreateV1( + points_of_interest=[ + PointOfInterestV1( + name="name_example", + latitude=3.14, + longitude=3.14, + ), + ], + radius_in_km=1, + ), + retargeting=RetargetingCreateV1( + visitors_type="All", + days_since_last_visit_min=1, + days_since_last_visit_max=1, + ), + lookalike=LookalikeCreateV1( + seed_segment_id="seed_segment_id_example", + target_size=1, + ), + ), + ), + ], + ) # AudienceSegmentBulkCreateInputV1 | Segment creation parameter + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.bulk_create_audience_segments(audience_segment_bulk_create_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->bulk_create_audience_segments: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_bulk_create_input_v1** | [**AudienceSegmentBulkCreateInputV1**](AudienceSegmentBulkCreateInputV1.md)| Segment creation parameter | + +### Return type + +[**AudienceSegmentEntityV1ListResponse**](AudienceSegmentEntityV1ListResponse.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 or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **bulk_create_audiences** +> AudienceEntityV1ListResponse bulk_create_audiences(audience_bulk_create_input_v1) + + + +Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_list_response import AudienceEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_create_input_v1 import AudienceBulkCreateInputV1 +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_bulk_create_input_v1 = AudienceBulkCreateInputV1( + data=[ + AudienceCreateEntityV1Resource( + type="type_example", + attributes=AudienceCreateEntityV1( + name="name_example", + description="description_example", + advertiser_id="advertiser_id_example", + algebra=AlgebraNodeV1( + _and=[ + AlgebraNodeV1(), + ], + _or=[ + AlgebraNodeV1(), + ], + _not=AlgebraNodeV1(), + audience_segment_id="audience_segment_id_example", + ), + ), + ), + ], + ) # AudienceBulkCreateInputV1 | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.bulk_create_audiences(audience_bulk_create_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->bulk_create_audiences: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_bulk_create_input_v1** | [**AudienceBulkCreateInputV1**](AudienceBulkCreateInputV1.md)| | + +### Return type + +[**AudienceEntityV1ListResponse**](AudienceEntityV1ListResponse.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 or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **bulk_delete_audience_segments** +> AudienceSegmentIdEntityV1ListResponse bulk_delete_audience_segments(audience_segment_bulk_delete_input_v1) + + + +Delete the segments associated to the given audience IDs. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_id_entity_v1_list_response import AudienceSegmentIdEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_delete_input_v1 import AudienceSegmentBulkDeleteInputV1 +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_bulk_delete_input_v1 = AudienceSegmentBulkDeleteInputV1( + data=[ + AudienceSegmentDeleteEntityV1Resource( + attributes={}, + id="id_example", + type="type_example", + ), + ], + ) # AudienceSegmentBulkDeleteInputV1 | Segment delete request. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.bulk_delete_audience_segments(audience_segment_bulk_delete_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->bulk_delete_audience_segments: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_bulk_delete_input_v1** | [**AudienceSegmentBulkDeleteInputV1**](AudienceSegmentBulkDeleteInputV1.md)| Segment delete request. | + +### Return type + +[**AudienceSegmentIdEntityV1ListResponse**](AudienceSegmentIdEntityV1ListResponse.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 or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **bulk_delete_audiences** +> AudienceIdEntityV1ListResponse bulk_delete_audiences(audience_bulk_delete_input_v1) + + + +Deletes the audiences associated to the given audience IDs. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_delete_input_v1 import AudienceBulkDeleteInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_id_entity_v1_list_response import AudienceIdEntityV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_bulk_delete_input_v1 = AudienceBulkDeleteInputV1( + data=[ + AudienceDeleteEntityV1Resource( + attributes={}, + id="id_example", + type="type_example", + ), + ], + ) # AudienceBulkDeleteInputV1 | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.bulk_delete_audiences(audience_bulk_delete_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->bulk_delete_audiences: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_bulk_delete_input_v1** | [**AudienceBulkDeleteInputV1**](AudienceBulkDeleteInputV1.md)| | + +### Return type + +[**AudienceIdEntityV1ListResponse**](AudienceIdEntityV1ListResponse.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 | - | +**204** | Success or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **bulk_update_audience_segments** +> AudienceSegmentEntityV1ListResponse bulk_update_audience_segments(audience_segment_bulk_update_input_v1) + + + +Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_bulk_update_input_v1 import AudienceSegmentBulkUpdateInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_list_response import AudienceSegmentEntityV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_bulk_update_input_v1 = AudienceSegmentBulkUpdateInputV1( + data=[ + AudienceSegmentUpdateEntityV1Resource( + attributes=AudienceSegmentUpdateEntityV1( + name="name_example", + description=NillableString( + value="value_example", + ), + in_market=InMarketUpdateV1( + country="country_example", + buying_power=[ + "Low", + ], + gender=NillableGenderV1( + value="Male", + ), + interest_ids=[ + "interest_ids_example", + ], + brand_ids=[ + "brand_ids_example", + ], + price_range=[ + "Low", + ], + ), + location=LocationUpdateV1( + points_of_interest=[ + PointOfInterestV1( + name="name_example", + latitude=3.14, + longitude=3.14, + ), + ], + radius_in_km=1, + registry_type="PointOfInterest", + ), + retargeting=RetargetingUpdateV1( + visitors_type="All", + days_since_last_visit_min=1, + days_since_last_visit_max=1, + ), + lookalike=LookalikeUpdateV1( + target_size=1, + ), + prospecting=ProspectingUpdateV1( + days_since_last_visit_min=NillableInt32( + value=1, + ), + days_since_last_visit_max=NillableInt32( + value=1, + ), + users_type="Prospects", + ), + ), + id="id_example", + type="type_example", + ), + ], + ) # AudienceSegmentBulkUpdateInputV1 | Segment Update request + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.bulk_update_audience_segments(audience_segment_bulk_update_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->bulk_update_audience_segments: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_bulk_update_input_v1** | [**AudienceSegmentBulkUpdateInputV1**](AudienceSegmentBulkUpdateInputV1.md)| Segment Update request | + +### Return type + +[**AudienceSegmentEntityV1ListResponse**](AudienceSegmentEntityV1ListResponse.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 or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **bulk_update_audiences** +> AudienceEntityV1ListResponse bulk_update_audiences(audience_bulk_update_input_v1) + + + +Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_list_response import AudienceEntityV1ListResponse +from criteo_api_marketingsolutions_v2024_04.model.audience_bulk_update_input_v1 import AudienceBulkUpdateInputV1 +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_bulk_update_input_v1 = AudienceBulkUpdateInputV1( + data=[ + AudienceUpdateEntityV1Resource( + attributes=AudienceUpdateEntityV1( + name="name_example", + description=NillableString( + value="value_example", + ), + algebra=AlgebraNodeV1( + _and=[ + AlgebraNodeV1(), + ], + _or=[ + AlgebraNodeV1(), + ], + _not=AlgebraNodeV1(), + audience_segment_id="audience_segment_id_example", + ), + ), + id="id_example", + type="type_example", + ), + ], + ) # AudienceBulkUpdateInputV1 | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.bulk_update_audiences(audience_bulk_update_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->bulk_update_audiences: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_bulk_update_input_v1** | [**AudienceBulkUpdateInputV1**](AudienceBulkUpdateInputV1.md)| | + +### Return type + +[**AudienceEntityV1ListResponse**](AudienceEntityV1ListResponse.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 or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **compute_audience_segments_sizes** +> AudienceSegmentSizeEntityV1ListResponse compute_audience_segments_sizes(audience_segment_compute_sizes_input_v1) + + + +Gets the size of all segments. An error is returned for those whose size calculation is not supported. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_compute_sizes_input_v1 import AudienceSegmentComputeSizesInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_entity_v1_list_response import AudienceSegmentSizeEntityV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_compute_sizes_input_v1 = AudienceSegmentComputeSizesInputV1( + data=[ + AudienceSegmentComputeSizeEntityV1Resource( + attributes={}, + id="id_example", + type="type_example", + ), + ], + ) # AudienceSegmentComputeSizesInputV1 | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.compute_audience_segments_sizes(audience_segment_compute_sizes_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->compute_audience_segments_sizes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_compute_sizes_input_v1** | [**AudienceSegmentComputeSizesInputV1**](AudienceSegmentComputeSizesInputV1.md)| | + +### Return type + +[**AudienceSegmentSizeEntityV1ListResponse**](AudienceSegmentSizeEntityV1ListResponse.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 or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **compute_audiences_sizes** +> AudienceSizeEntityV1ListResponse compute_audiences_sizes(audience_compute_sizes_input_v1) + + + +Gets the size of all audiences. An error is returned for those whose size calculation is not supported. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_compute_sizes_input_v1 import AudienceComputeSizesInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_size_entity_v1_list_response import AudienceSizeEntityV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_compute_sizes_input_v1 = AudienceComputeSizesInputV1( + data=[ + AudienceComputeSizeEntityV1Resource( + attributes={}, + id="id_example", + type="type_example", + ), + ], + ) # AudienceComputeSizesInputV1 | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.compute_audiences_sizes(audience_compute_sizes_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->compute_audiences_sizes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_compute_sizes_input_v1** | [**AudienceComputeSizesInputV1**](AudienceComputeSizesInputV1.md)| | + +### Return type + +[**AudienceSizeEntityV1ListResponse**](AudienceSizeEntityV1ListResponse.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 or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **delete_contact_list_identifiers** +> DeleteAudienceContactListResponse delete_contact_list_identifiers(audience_segment_id) + + + +Delete all identifiers from a contact list audience-segment. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.delete_audience_contact_list_response import DeleteAudienceContactListResponse +from criteo_api_marketingsolutions_v2024_04.model.error_code_response import ErrorCodeResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_id = "audience-segment-id_example" # str | The id of the contact list audience-segment to amend + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_contact_list_identifiers(audience_segment_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->delete_contact_list_identifiers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_id** | **str**| The id of the contact list audience-segment to amend | + +### Return type + +[**DeleteAudienceContactListResponse**](DeleteAudienceContactListResponse.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 Contact List was emptied | - | +**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) + +# **estimate_audience_segment_size** +> AudienceSegmentSizeEstimationV1Response estimate_audience_segment_size(audience_segment_estimate_size_input_v1) + + + +Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_estimate_size_input_v1 import AudienceSegmentEstimateSizeInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_size_estimation_v1_response import AudienceSegmentSizeEstimationV1Response +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_estimate_size_input_v1 = AudienceSegmentEstimateSizeInputV1( + data=AudienceSegmentSizeEstimationEntityV1Resource( + type="type_example", + attributes=AudienceSegmentSizeEstimationEntityV1( + advertiser_id="advertiser_id_example", + in_market=InMarketSizeEstimationV1( + country="country_example", + buying_power=[ + "Low", + ], + gender="Male", + interest_ids=[ + "interest_ids_example", + ], + brand_ids=[ + "brand_ids_example", + ], + price_range=[ + "Low", + ], + ), + location=LocationSizeEstimationV1( + points_of_interest=[ + PointOfInterestV1( + name="name_example", + latitude=3.14, + longitude=3.14, + ), + ], + radius_in_km=1, + ), + ), + ), + ) # AudienceSegmentEstimateSizeInputV1 | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.estimate_audience_segment_size(audience_segment_estimate_size_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->estimate_audience_segment_size: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_estimate_size_input_v1** | [**AudienceSegmentEstimateSizeInputV1**](AudienceSegmentEstimateSizeInputV1.md)| | + +### Return type + +[**AudienceSegmentSizeEstimationV1Response**](AudienceSegmentSizeEstimationV1Response.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 | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **estimate_audience_size** +> AudienceSizeEstimationV1Response estimate_audience_size(audience_estimate_size_input_v1) + + + +Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_estimate_size_input_v1 import AudienceEstimateSizeInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_size_estimation_v1_response import AudienceSizeEstimationV1Response +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_estimate_size_input_v1 = AudienceEstimateSizeInputV1( + data=AudienceEstimateSizeEntityV1Resource( + type="type_example", + attributes=AudienceEstimateSizeEntityV1( + advertiser_id="advertiser_id_example", + algebra=AlgebraNodeV1( + _and=[ + AlgebraNodeV1(), + ], + _or=[ + AlgebraNodeV1(), + ], + _not=AlgebraNodeV1(), + audience_segment_id="audience_segment_id_example", + ), + ), + ), + ) # AudienceEstimateSizeInputV1 | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.estimate_audience_size(audience_estimate_size_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->estimate_audience_size: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_estimate_size_input_v1** | [**AudienceEstimateSizeInputV1**](AudienceEstimateSizeInputV1.md)| | + +### Return type + +[**AudienceSizeEstimationV1Response**](AudienceSizeEstimationV1Response.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 or partial success | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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_audience_segment_contact_list_statistics** +> ContactListStatisticsEntityV1Response get_audience_segment_contact_list_statistics(audience_segment_id) + + + +Returns the statistics of a contact list segment. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.contact_list_statistics_entity_v1_response import ContactListStatisticsEntityV1Response +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_id = 1 # int | The segment ID. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_audience_segment_contact_list_statistics(audience_segment_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->get_audience_segment_contact_list_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_id** | **int**| The segment ID. | + +### Return type + +[**ContactListStatisticsEntityV1Response**](ContactListStatisticsEntityV1Response.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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_audience_segments_in_market_brands** +> InMarketAudienceSegmentBrandEntityV1ListResponse get_audience_segments_in_market_brands(advertiser_id, country) + + + +Returns a list with all available in-market brands that can be used to define an in-market segment. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_brand_entity_v1_list_response import InMarketAudienceSegmentBrandEntityV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser ID. + country = "country_example" # str | The ISO 3166-1 alpha-2 country code. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_audience_segments_in_market_brands(advertiser_id, country) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->get_audience_segments_in_market_brands: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser ID. | + **country** | **str**| The ISO 3166-1 alpha-2 country code. | + +### Return type + +[**InMarketAudienceSegmentBrandEntityV1ListResponse**](InMarketAudienceSegmentBrandEntityV1ListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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_audience_segments_in_market_interests** +> InMarketAudienceSegmentInterestEntityV1ListResponse get_audience_segments_in_market_interests(advertiser_id, country) + + + +Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.in_market_audience_segment_interest_entity_v1_list_response import InMarketAudienceSegmentInterestEntityV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser ID. + country = "country_example" # str | The ISO 3166-1 alpha-2 country code. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_audience_segments_in_market_interests(advertiser_id, country) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->get_audience_segments_in_market_interests: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser ID. | + **country** | **str**| The ISO 3166-1 alpha-2 country code. | + +### Return type + +[**InMarketAudienceSegmentInterestEntityV1ListResponse**](InMarketAudienceSegmentInterestEntityV1ListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **search_audience_segments** +> AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse search_audience_segments(audience_segment_search_input_v1) + + + +Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_search_input_v1 import AudienceSegmentSearchInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response import AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_search_input_v1 = AudienceSegmentSearchInputV1( + data=AudienceSegmentSearchEntityV1Resource( + type="type_example", + attributes=AudienceSegmentSearchEntityV1( + audience_segment_ids=[ + "audience_segment_ids_example", + ], + advertiser_ids=[ + "advertiser_ids_example", + ], + audience_segment_types=[ + "Unknown", + ], + ), + ), + ) # AudienceSegmentSearchInputV1 | Segment search filters. + limit = 50 # int | The number of elements to be returned. The default is 50 and the maximum is 100. (optional) if omitted the server will use the default value of 50 + offset = 0 # int | The (zero-based) offset into the collection. The default is 0. (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.search_audience_segments(audience_segment_search_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->search_audience_segments: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.search_audience_segments(audience_segment_search_input_v1, limit=limit, offset=offset) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->search_audience_segments: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_search_input_v1** | [**AudienceSegmentSearchInputV1**](AudienceSegmentSearchInputV1.md)| Segment search filters. | + **limit** | **int**| The number of elements to be returned. The default is 50 and the maximum is 100. | [optional] if omitted the server will use the default value of 50 + **offset** | **int**| The (zero-based) offset into the collection. The default is 0. | [optional] if omitted the server will use the default value of 0 + +### Return type + +[**AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse**](AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse.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 | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **search_audiences** +> AudienceEntityV1AudienceSearchMetadataV1ListResponse search_audiences(audience_search_input_v1) + + + +Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.audience_search_input_v1 import AudienceSearchInputV1 +from criteo_api_marketingsolutions_v2024_04.model.audience_entity_v1_audience_search_metadata_v1_list_response import AudienceEntityV1AudienceSearchMetadataV1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_search_input_v1 = AudienceSearchInputV1( + data=AudienceSearchEntityV1Resource( + type="type_example", + attributes=AudienceSearchEntityV1( + audience_ids=[ + "audience_ids_example", + ], + advertiser_ids=[ + "advertiser_ids_example", + ], + audience_segment_ids=[ + "audience_segment_ids_example", + ], + ad_set_ids=[ + "ad_set_ids_example", + ], + ), + ), + ) # AudienceSearchInputV1 | Audience search filters. + limit = 50 # int | The number of elements to be returned. The default is 50 and the maximum is 100. (optional) if omitted the server will use the default value of 50 + offset = 0 # int | The (zero-based) offset into the collection. The default is 0. (optional) if omitted the server will use the default value of 0 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.search_audiences(audience_search_input_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->search_audiences: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.search_audiences(audience_search_input_v1, limit=limit, offset=offset) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->search_audiences: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_search_input_v1** | [**AudienceSearchInputV1**](AudienceSearchInputV1.md)| Audience search filters. | + **limit** | **int**| The number of elements to be returned. The default is 50 and the maximum is 100. | [optional] if omitted the server will use the default value of 50 + **offset** | **int**| The (zero-based) offset into the collection. The default is 0. | [optional] if omitted the server will use the default value of 0 + +### Return type + +[**AudienceEntityV1AudienceSearchMetadataV1ListResponse**](AudienceEntityV1AudienceSearchMetadataV1ListResponse.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 | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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_contact_list_identifiers** +> ModifyAudienceResponse update_contact_list_identifiers(audience_segment_id, contactlist_amendment_request) + + + +Add/remove identifiers to or from a contact list audience-segment. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import audience_api +from criteo_api_marketingsolutions_v2024_04.model.contactlist_amendment_request import ContactlistAmendmentRequest +from criteo_api_marketingsolutions_v2024_04.model.error_code_response import ErrorCodeResponse +from criteo_api_marketingsolutions_v2024_04.model.modify_audience_response import ModifyAudienceResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + audience_segment_id = "audience-segment-id_example" # str | The id of the contact list audience-segment to amend + contactlist_amendment_request = ContactlistAmendmentRequest( + data=ContactlistAmendment( + type="ContactlistAmendment", + attributes=ContactlistAmendmentAttributes( + operation="add", + identifier_type="email", + identifiers=[ + "identifiers_example", + ], + gum_caller_id=1, + ), + ), + ) # ContactlistAmendmentRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_contact_list_identifiers(audience_segment_id, contactlist_amendment_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->update_contact_list_identifiers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_id** | **str**| The id of the contact list audience-segment to amend | + **contactlist_amendment_request** | [**ContactlistAmendmentRequest**](ContactlistAmendmentRequest.md)| | + +### Return type + +[**ModifyAudienceResponse**](ModifyAudienceResponse.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** | Summary of created request | - | +**403** | Forbidden | - | +**404** | Audience 123 not 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) + diff --git a/sdks/marketingsolutions_2024-04/docs/AudienceBulkCreateInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceBulkCreateInputV1.md new file mode 100644 index 00000000..c3989836 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceBulkCreateInputV1.md @@ -0,0 +1,13 @@ +# AudienceBulkCreateInputV1 + +Input to create one or more audiences. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceCreateEntityV1Resource], none_type**](AudienceCreateEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceBulkDeleteInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceBulkDeleteInputV1.md new file mode 100644 index 00000000..303732ba --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceBulkDeleteInputV1.md @@ -0,0 +1,13 @@ +# AudienceBulkDeleteInputV1 + +Input to delete one or more audiences. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceDeleteEntityV1Resource], none_type**](AudienceDeleteEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceBulkUpdateInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceBulkUpdateInputV1.md new file mode 100644 index 00000000..5074de91 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceBulkUpdateInputV1.md @@ -0,0 +1,13 @@ +# AudienceBulkUpdateInputV1 + +Input to update one or more audiences. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceUpdateEntityV1Resource], none_type**](AudienceUpdateEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceComputeSizeEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceComputeSizeEntityV1Resource.md new file mode 100644 index 00000000..a0521016 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceComputeSizeEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceComputeSizeEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Audience of people of interest for a marketer. | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceComputeSizesInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceComputeSizesInputV1.md new file mode 100644 index 00000000..40dc3f6e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceComputeSizesInputV1.md @@ -0,0 +1,13 @@ +# AudienceComputeSizesInputV1 + +Input to retrieve the size of one or more audiences. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceComputeSizeEntityV1Resource], none_type**](AudienceComputeSizeEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceCreateEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceCreateEntityV1.md new file mode 100644 index 00000000..3d8a5506 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceCreateEntityV1.md @@ -0,0 +1,16 @@ +# AudienceCreateEntityV1 + +Audience of people of interest for a marketer. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the audience | +**advertiser_id** | **str** | Advertiser associated to the audience | +**algebra** | [**AlgebraNodeV1**](AlgebraNodeV1.md) | | +**description** | **str, none_type** | Description of the audience | [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_2024-04/docs/AudienceCreateEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceCreateEntityV1Resource.md new file mode 100644 index 00000000..1cfab9d2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceCreateEntityV1Resource.md @@ -0,0 +1,14 @@ +# AudienceCreateEntityV1Resource + +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** | [**AudienceCreateEntityV1**](AudienceCreateEntityV1.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/marketingsolutions_2024-04/docs/AudienceDeleteEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceDeleteEntityV1Resource.md new file mode 100644 index 00000000..1cdd252d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceDeleteEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceDeleteEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Audience to delete | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceEntityV1.md new file mode 100644 index 00000000..f577cbc3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceEntityV1.md @@ -0,0 +1,19 @@ +# AudienceEntityV1 + +Audience of people of interest for a marketer. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of the audience | [optional] +**description** | **str, none_type** | Description of the audience | [optional] +**created_at** | **datetime, none_type** | ISO-8601 timestamp in UTC of audience creation (read-only) | [optional] +**updated_at** | **datetime, none_type** | ISO-8601 timestamp in UTC of audience update (read-only) | [optional] +**advertiser_id** | **str, none_type** | Advertiser associated to the audience | [optional] +**ad_set_ids** | **[str], none_type** | Ad sets associated to the audience | [optional] +**algebra** | [**AlgebraNodeV1**](AlgebraNodeV1.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/marketingsolutions_2024-04/docs/AudienceEntityV1AudienceSearchMetadataV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/AudienceEntityV1AudienceSearchMetadataV1ListResponse.md new file mode 100644 index 00000000..da7db24b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceEntityV1AudienceSearchMetadataV1ListResponse.md @@ -0,0 +1,16 @@ +# AudienceEntityV1AudienceSearchMetadataV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities and metadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**AudienceSearchMetadataV1**](AudienceSearchMetadataV1.md) | | [optional] +**data** | [**[AudienceEntityV1Resource], none_type**](AudienceEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceEntityV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/AudienceEntityV1ListResponse.md new file mode 100644 index 00000000..9667d386 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceEntityV1ListResponse.md @@ -0,0 +1,15 @@ +# AudienceEntityV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceEntityV1Resource], none_type**](AudienceEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceEntityV1Resource.md new file mode 100644 index 00000000..8c8c43c8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AudienceEntityV1**](AudienceEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2023-01/docs/AudienceError.md b/sdks/marketingsolutions_2024-04/docs/AudienceError.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AudienceError.md rename to sdks/marketingsolutions_2024-04/docs/AudienceError.md diff --git a/sdks/marketingsolutions_2024-04/docs/AudienceEstimateSizeEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceEstimateSizeEntityV1.md new file mode 100644 index 00000000..282016b3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceEstimateSizeEntityV1.md @@ -0,0 +1,14 @@ +# AudienceEstimateSizeEntityV1 + +Audience of people of interest for a marketer. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**advertiser_id** | **str** | Advertiser associated to the audience | +**algebra** | [**AlgebraNodeV1**](AlgebraNodeV1.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/marketingsolutions_2024-04/docs/AudienceEstimateSizeEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceEstimateSizeEntityV1Resource.md new file mode 100644 index 00000000..a182d917 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceEstimateSizeEntityV1Resource.md @@ -0,0 +1,14 @@ +# AudienceEstimateSizeEntityV1Resource + +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** | [**AudienceEstimateSizeEntityV1**](AudienceEstimateSizeEntityV1.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/marketingsolutions_2024-04/docs/AudienceEstimateSizeInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceEstimateSizeInputV1.md new file mode 100644 index 00000000..a9538f78 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceEstimateSizeInputV1.md @@ -0,0 +1,13 @@ +# AudienceEstimateSizeInputV1 + +Input to estimate the size of an audience. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AudienceEstimateSizeEntityV1Resource**](AudienceEstimateSizeEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceIdEntityV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/AudienceIdEntityV1ListResponse.md new file mode 100644 index 00000000..54a34e50 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceIdEntityV1ListResponse.md @@ -0,0 +1,15 @@ +# AudienceIdEntityV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceIdEntityV1Resource], none_type**](AudienceIdEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceIdEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceIdEntityV1Resource.md new file mode 100644 index 00000000..14a40e59 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceIdEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceIdEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Audience entity with only its ID | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2023-01/docs/AudienceNameDescription.md b/sdks/marketingsolutions_2024-04/docs/AudienceNameDescription.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AudienceNameDescription.md rename to sdks/marketingsolutions_2024-04/docs/AudienceNameDescription.md diff --git a/sdks/marketingsolutions_2024-04/docs/AudienceSearchEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSearchEntityV1.md new file mode 100644 index 00000000..8de17b10 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSearchEntityV1.md @@ -0,0 +1,16 @@ +# AudienceSearchEntityV1 + +Available filters to perform a search on segments. If present, the filters are AND'ed together when applied. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**audience_ids** | **[str], none_type** | List of audience ids | [optional] +**advertiser_ids** | **[str], none_type** | List of advertiser ids | [optional] +**audience_segment_ids** | **[str], none_type** | List of segment ids (linked to the result audiences) | [optional] +**ad_set_ids** | **[str], none_type** | List of AdSet ids | [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_2024-04/docs/AudienceSearchEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSearchEntityV1Resource.md new file mode 100644 index 00000000..c2d8cd3d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSearchEntityV1Resource.md @@ -0,0 +1,14 @@ +# AudienceSearchEntityV1Resource + +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** | [**AudienceSearchEntityV1**](AudienceSearchEntityV1.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/marketingsolutions_2024-04/docs/AudienceSearchInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSearchInputV1.md new file mode 100644 index 00000000..1efd5e65 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSearchInputV1.md @@ -0,0 +1,13 @@ +# AudienceSearchInputV1 + +Audience search parameter + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AudienceSearchEntityV1Resource**](AudienceSearchEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceSearchMetadataV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSearchMetadataV1.md new file mode 100644 index 00000000..605b30cc --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSearchMetadataV1.md @@ -0,0 +1,15 @@ +# AudienceSearchMetadataV1 + +Metadata for the audience search response. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_items** | **int, none_type** | Total number of items | [optional] +**limit** | **int, none_type** | Max item of the current page | [optional] +**offset** | **int, none_type** | Number of item to skip | [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_2024-04/docs/AudienceSegmentBulkCreateInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentBulkCreateInputV1.md new file mode 100644 index 00000000..986a70c2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentBulkCreateInputV1.md @@ -0,0 +1,13 @@ +# AudienceSegmentBulkCreateInputV1 + +Input to create one or more audience segments. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceSegmentCreateEntityV1Resource], none_type**](AudienceSegmentCreateEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceSegmentBulkDeleteInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentBulkDeleteInputV1.md new file mode 100644 index 00000000..3995c83c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentBulkDeleteInputV1.md @@ -0,0 +1,13 @@ +# AudienceSegmentBulkDeleteInputV1 + +Input to delete one or more segments. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceSegmentDeleteEntityV1Resource], none_type**](AudienceSegmentDeleteEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceSegmentBulkUpdateInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentBulkUpdateInputV1.md new file mode 100644 index 00000000..cc69dc10 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentBulkUpdateInputV1.md @@ -0,0 +1,13 @@ +# AudienceSegmentBulkUpdateInputV1 + +Input to update one or more segments. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceSegmentUpdateEntityV1Resource], none_type**](AudienceSegmentUpdateEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceSegmentComputeSizeEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentComputeSizeEntityV1Resource.md new file mode 100644 index 00000000..cd4019d2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentComputeSizeEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceSegmentComputeSizeEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Set of rules that defines specific people to target. | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceSegmentComputeSizesInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentComputeSizesInputV1.md new file mode 100644 index 00000000..1a5b1e1c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentComputeSizesInputV1.md @@ -0,0 +1,13 @@ +# AudienceSegmentComputeSizesInputV1 + +Input to retrieve the size of one or more segments. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceSegmentComputeSizeEntityV1Resource], none_type**](AudienceSegmentComputeSizeEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceSegmentCreateEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentCreateEntityV1.md new file mode 100644 index 00000000..7cfc05a2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentCreateEntityV1.md @@ -0,0 +1,21 @@ +# AudienceSegmentCreateEntityV1 + +Set of rules that defines specific people to target. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the segment | +**advertiser_id** | **str** | Advertiser associated to the segment | +**description** | **str, none_type** | Description of the segment | [optional] +**in_market** | [**InMarketCreateV1**](InMarketCreateV1.md) | | [optional] +**prospecting** | [**ProspectingCreateV1**](ProspectingCreateV1.md) | | [optional] +**contact_list** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Settings to target users with your contact lists. | [optional] +**location** | [**LocationCreateV1**](LocationCreateV1.md) | | [optional] +**retargeting** | [**RetargetingCreateV1**](RetargetingCreateV1.md) | | [optional] +**lookalike** | [**LookalikeCreateV1**](LookalikeCreateV1.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/marketingsolutions_2024-04/docs/AudienceSegmentCreateEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentCreateEntityV1Resource.md new file mode 100644 index 00000000..c0e92640 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentCreateEntityV1Resource.md @@ -0,0 +1,14 @@ +# AudienceSegmentCreateEntityV1Resource + +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** | [**AudienceSegmentCreateEntityV1**](AudienceSegmentCreateEntityV1.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/marketingsolutions_2024-04/docs/AudienceSegmentDeleteEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentDeleteEntityV1Resource.md new file mode 100644 index 00000000..8d43794c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentDeleteEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceSegmentDeleteEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Segment to delete | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1.md new file mode 100644 index 00000000..e0b95914 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1.md @@ -0,0 +1,25 @@ +# AudienceSegmentEntityV1 + +Set of rules that defines specific people to target. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of the segment | [optional] +**description** | **str, none_type** | Description of the segment | [optional] +**type** | **str, none_type** | Type of segment (read-only) | [optional] +**created_at** | **datetime, none_type** | ISO-8601 timestamp in UTC of segment creation (read-only) | [optional] +**updated_at** | **datetime, none_type** | ISO-8601 timestamp in UTC of segment update (read-only) | [optional] +**advertiser_id** | **str, none_type** | Advertiser associated to the segment | [optional] +**in_market** | [**InMarketV1**](InMarketV1.md) | | [optional] +**prospecting** | [**ProspectingV1**](ProspectingV1.md) | | [optional] +**contact_list** | [**ContactListV1**](ContactListV1.md) | | [optional] +**location** | [**LocationV1**](LocationV1.md) | | [optional] +**behavioral** | [**BehavioralV1**](BehavioralV1.md) | | [optional] +**retargeting** | [**RetargetingV1**](RetargetingV1.md) | | [optional] +**lookalike** | [**LookalikeV1**](LookalikeV1.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/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse.md new file mode 100644 index 00000000..31313ca1 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse.md @@ -0,0 +1,16 @@ +# AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities and metadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**AudienceSegmentSearchMetadataV1**](AudienceSegmentSearchMetadataV1.md) | | [optional] +**data** | [**[AudienceSegmentEntityV1Resource], none_type**](AudienceSegmentEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1ListResponse.md new file mode 100644 index 00000000..bd3081d1 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1ListResponse.md @@ -0,0 +1,15 @@ +# AudienceSegmentEntityV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceSegmentEntityV1Resource], none_type**](AudienceSegmentEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1Resource.md new file mode 100644 index 00000000..33944af5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceSegmentEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AudienceSegmentEntityV1**](AudienceSegmentEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceSegmentEstimateSizeInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEstimateSizeInputV1.md new file mode 100644 index 00000000..8ed365ca --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentEstimateSizeInputV1.md @@ -0,0 +1,13 @@ +# AudienceSegmentEstimateSizeInputV1 + +Input to estimate the size of an audience segment.. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AudienceSegmentSizeEstimationEntityV1Resource**](AudienceSegmentSizeEstimationEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceSegmentIdEntityV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentIdEntityV1ListResponse.md new file mode 100644 index 00000000..70c0d7f3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentIdEntityV1ListResponse.md @@ -0,0 +1,15 @@ +# AudienceSegmentIdEntityV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceSegmentIdEntityV1Resource], none_type**](AudienceSegmentIdEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceSegmentIdEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentIdEntityV1Resource.md new file mode 100644 index 00000000..1d040e2b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentIdEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceSegmentIdEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Audience Segment entity only with its ID | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceSegmentSearchEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSearchEntityV1.md new file mode 100644 index 00000000..ccde7c1c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSearchEntityV1.md @@ -0,0 +1,15 @@ +# AudienceSegmentSearchEntityV1 + +Available filters to perform a search on audience segments. If present, the filters are AND'ed together when applied. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**audience_segment_ids** | **[str], none_type** | List of segment ids | [optional] +**advertiser_ids** | **[str], none_type** | List of advertiser ids | [optional] +**audience_segment_types** | **[str], none_type** | List of segment types | [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_2024-04/docs/AudienceSegmentSearchEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSearchEntityV1Resource.md new file mode 100644 index 00000000..4f2a089c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSearchEntityV1Resource.md @@ -0,0 +1,14 @@ +# AudienceSegmentSearchEntityV1Resource + +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** | [**AudienceSegmentSearchEntityV1**](AudienceSegmentSearchEntityV1.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/marketingsolutions_2024-04/docs/AudienceSegmentSearchInputV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSearchInputV1.md new file mode 100644 index 00000000..7a12b4c0 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSearchInputV1.md @@ -0,0 +1,13 @@ +# AudienceSegmentSearchInputV1 + +Audience segment search parameter + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AudienceSegmentSearchEntityV1Resource**](AudienceSegmentSearchEntityV1Resource.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/marketingsolutions_2024-04/docs/AudienceSegmentSearchMetadataV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSearchMetadataV1.md new file mode 100644 index 00000000..fc9517e9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSearchMetadataV1.md @@ -0,0 +1,15 @@ +# AudienceSegmentSearchMetadataV1 + +Metadata for the audience segment search response. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_items** | **int, none_type** | Total number of items | [optional] +**limit** | **int, none_type** | Max item of the current page | [optional] +**offset** | **int, none_type** | Number of item to skip | [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_2024-04/docs/AudienceSegmentSizeEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEntityV1.md new file mode 100644 index 00000000..44ba6951 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEntityV1.md @@ -0,0 +1,13 @@ +# AudienceSegmentSizeEntityV1 + +Set of rules that defines specific people to target. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**size** | **int, 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_2024-04/docs/AudienceSegmentSizeEntityV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEntityV1ListResponse.md new file mode 100644 index 00000000..67e85a32 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEntityV1ListResponse.md @@ -0,0 +1,15 @@ +# AudienceSegmentSizeEntityV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceSegmentSizeEntityV1Resource], none_type**](AudienceSegmentSizeEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceSegmentSizeEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEntityV1Resource.md new file mode 100644 index 00000000..06074cdf --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceSegmentSizeEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AudienceSegmentSizeEntityV1**](AudienceSegmentSizeEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationEntityV1.md new file mode 100644 index 00000000..ee1208fd --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationEntityV1.md @@ -0,0 +1,15 @@ +# AudienceSegmentSizeEstimationEntityV1 + +Set of rules that defines specific people to target. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**advertiser_id** | **str** | Advertiser associated to the segment | +**in_market** | [**InMarketSizeEstimationV1**](InMarketSizeEstimationV1.md) | | [optional] +**location** | [**LocationSizeEstimationV1**](LocationSizeEstimationV1.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/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationEntityV1Resource.md new file mode 100644 index 00000000..2f9ddce1 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationEntityV1Resource.md @@ -0,0 +1,14 @@ +# AudienceSegmentSizeEstimationEntityV1Resource + +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** | [**AudienceSegmentSizeEstimationEntityV1**](AudienceSegmentSizeEstimationEntityV1.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/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationV1.md new file mode 100644 index 00000000..323f6f84 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationV1.md @@ -0,0 +1,13 @@ +# AudienceSegmentSizeEstimationV1 + +Segment size estimation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**size** | **int, 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_2024-04/docs/AudienceSegmentSizeEstimationV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationV1Resource.md new file mode 100644 index 00000000..156261e5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationV1Resource.md @@ -0,0 +1,14 @@ +# AudienceSegmentSizeEstimationV1Resource + +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** | [**AudienceSegmentSizeEstimationV1**](AudienceSegmentSizeEstimationV1.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/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationV1Response.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationV1Response.md new file mode 100644 index 00000000..660e5c61 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentSizeEstimationV1Response.md @@ -0,0 +1,15 @@ +# AudienceSegmentSizeEstimationV1Response + +A top-level object that encapsulates a Criteo API response for a single value + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AudienceSegmentSizeEstimationV1Resource**](AudienceSegmentSizeEstimationV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceSegmentUpdateEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentUpdateEntityV1.md new file mode 100644 index 00000000..aa33ad71 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentUpdateEntityV1.md @@ -0,0 +1,19 @@ +# AudienceSegmentUpdateEntityV1 + +Set of rules that defines specific people to target. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of the segment | [optional] +**description** | [**NillableString**](NillableString.md) | | [optional] +**in_market** | [**InMarketUpdateV1**](InMarketUpdateV1.md) | | [optional] +**location** | [**LocationUpdateV1**](LocationUpdateV1.md) | | [optional] +**retargeting** | [**RetargetingUpdateV1**](RetargetingUpdateV1.md) | | [optional] +**lookalike** | [**LookalikeUpdateV1**](LookalikeUpdateV1.md) | | [optional] +**prospecting** | [**ProspectingUpdateV1**](ProspectingUpdateV1.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/marketingsolutions_2024-04/docs/AudienceSegmentUpdateEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentUpdateEntityV1Resource.md new file mode 100644 index 00000000..59c6489e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSegmentUpdateEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceSegmentUpdateEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AudienceSegmentUpdateEntityV1**](AudienceSegmentUpdateEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceSizeEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEntityV1.md new file mode 100644 index 00000000..8f860143 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEntityV1.md @@ -0,0 +1,13 @@ +# AudienceSizeEntityV1 + +Audience entity only with its size + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**size** | **int, 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_2024-04/docs/AudienceSizeEntityV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEntityV1ListResponse.md new file mode 100644 index 00000000..cd7b5474 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEntityV1ListResponse.md @@ -0,0 +1,15 @@ +# AudienceSizeEntityV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[AudienceSizeEntityV1Resource], none_type**](AudienceSizeEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceSizeEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEntityV1Resource.md new file mode 100644 index 00000000..336db2bc --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceSizeEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AudienceSizeEntityV1**](AudienceSizeEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/AudienceSizeEstimationV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEstimationV1.md new file mode 100644 index 00000000..9e847b4f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEstimationV1.md @@ -0,0 +1,13 @@ +# AudienceSizeEstimationV1 + +Audience size estimation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**size** | **int, 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_2024-04/docs/AudienceSizeEstimationV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEstimationV1Resource.md new file mode 100644 index 00000000..6e19d9a8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEstimationV1Resource.md @@ -0,0 +1,14 @@ +# AudienceSizeEstimationV1Resource + +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** | [**AudienceSizeEstimationV1**](AudienceSizeEstimationV1.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/marketingsolutions_2024-04/docs/AudienceSizeEstimationV1Response.md b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEstimationV1Response.md new file mode 100644 index 00000000..370918d7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceSizeEstimationV1Response.md @@ -0,0 +1,15 @@ +# AudienceSizeEstimationV1Response + +A top-level object that encapsulates a Criteo API response for a single value + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AudienceSizeEstimationV1Resource**](AudienceSizeEstimationV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/AudienceUpdateEntityV1.md b/sdks/marketingsolutions_2024-04/docs/AudienceUpdateEntityV1.md new file mode 100644 index 00000000..f542b4f7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceUpdateEntityV1.md @@ -0,0 +1,15 @@ +# AudienceUpdateEntityV1 + +Audience of people of interest for a marketer. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of the audience | [optional] +**description** | [**NillableString**](NillableString.md) | | [optional] +**algebra** | [**AlgebraNodeV1**](AlgebraNodeV1.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/marketingsolutions_2024-04/docs/AudienceUpdateEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/AudienceUpdateEntityV1Resource.md new file mode 100644 index 00000000..8e2dde99 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/AudienceUpdateEntityV1Resource.md @@ -0,0 +1,15 @@ +# AudienceUpdateEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AudienceUpdateEntityV1**](AudienceUpdateEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2023-01/docs/AudienceWarning.md b/sdks/marketingsolutions_2024-04/docs/AudienceWarning.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/AudienceWarning.md rename to sdks/marketingsolutions_2024-04/docs/AudienceWarning.md diff --git a/sdks/marketingsolutions_2023-01/docs/BasicAudienceDefinition.md b/sdks/marketingsolutions_2024-04/docs/BasicAudienceDefinition.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/BasicAudienceDefinition.md rename to sdks/marketingsolutions_2024-04/docs/BasicAudienceDefinition.md diff --git a/sdks/marketingsolutions_2024-04/docs/BehavioralV1.md b/sdks/marketingsolutions_2024-04/docs/BehavioralV1.md new file mode 100644 index 00000000..c87ed819 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/BehavioralV1.md @@ -0,0 +1,16 @@ +# BehavioralV1 + +Settings of a behavioral set of users provided by Criteo. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category** | **str** | The type of behavioral | +**country** | **str, none_type** | The users' country | [optional] +**start_date** | **datetime, none_type** | Desired date when the behavioral will start | [optional] +**end_date** | **datetime, none_type** | Desired date when the behavioral will end | [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_2024-04/docs/CampaignApi.md b/sdks/marketingsolutions_2024-04/docs/CampaignApi.md new file mode 100644 index 00000000..63724264 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CampaignApi.md @@ -0,0 +1,1576 @@ +# criteo_api_marketingsolutions_v2024_04.CampaignApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_ad_set**](CampaignApi.md#create_ad_set) | **POST** /2024-04/marketing-solutions/ad-sets | +[**create_campaign**](CampaignApi.md#create_campaign) | **POST** /2024-04/marketing-solutions/campaigns | +[**get_ad_set_v23_q1**](CampaignApi.md#get_ad_set_v23_q1) | **GET** /2024-04/marketing-solutions/ad-sets/{ad-set-id} | +[**get_campaign_v23_q1**](CampaignApi.md#get_campaign_v23_q1) | **GET** /2024-04/marketing-solutions/campaigns/{campaign-id} | +[**get_category_bid_list**](CampaignApi.md#get_category_bid_list) | **GET** /2024-04/marketing-solutions/ad-sets/{ad-set-id}/category-bids | +[**get_display_multipliers**](CampaignApi.md#get_display_multipliers) | **GET** /2024-04/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers | +[**patch_ad_sets**](CampaignApi.md#patch_ad_sets) | **PATCH** /2024-04/marketing-solutions/ad-sets | +[**patch_campaigns**](CampaignApi.md#patch_campaigns) | **PATCH** /2024-04/marketing-solutions/campaigns | +[**patch_category_bid_list**](CampaignApi.md#patch_category_bid_list) | **PATCH** /2024-04/marketing-solutions/ad-sets/{ad-set-id}/category-bids | +[**patch_display_multipliers**](CampaignApi.md#patch_display_multipliers) | **PATCH** /2024-04/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers | +[**search_ad_sets_v23_q1**](CampaignApi.md#search_ad_sets_v23_q1) | **POST** /2024-04/marketing-solutions/ad-sets/search | +[**search_campaigns_v23_q1**](CampaignApi.md#search_campaigns_v23_q1) | **POST** /2024-04/marketing-solutions/campaigns/search | +[**start_ad_sets**](CampaignApi.md#start_ad_sets) | **POST** /2024-04/marketing-solutions/ad-sets/start | +[**stop_ad_sets**](CampaignApi.md#stop_ad_sets) | **POST** /2024-04/marketing-solutions/ad-sets/stop | +[**update_ad_set_audience**](CampaignApi.md#update_ad_set_audience) | **PUT** /2024-04/marketing-solutions/ad-sets/{ad-set-id}/audience | + + +# **create_ad_set** +> ResponseReadAdSet create_ad_set(create_ad_set_request) + + + +Create the specified ad set + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.create_ad_set_request import CreateAdSetRequest +from criteo_api_marketingsolutions_v2024_04.model.response_read_ad_set import ResponseReadAdSet +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + create_ad_set_request = CreateAdSetRequest( + data=CreateAdSetResource( + attributes=CreateAdSet( + name="name_example", + dataset_id="dataset_id_example", + campaign_id="campaign_id_example", + objective="customAction", + schedule=CreateAdSetSchedule( + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + ), + bidding=CreateAdSetBidding( + bid_amount=3.14, + cost_controller="COS", + ), + targeting=CreateAdSetTargeting( + delivery_limitations=AdSetDeliveryLimitations( + environments=[ + "web", + ], + devices=[ + "other", + ], + operating_systems=[ + "android", + ], + ), + geo_location=CreateAdSetGeoLocation( + countries=AdSetTargetingRule( + operand="undefined", + values=[ + "values_example", + ], + ), + subdivisions=AdSetTargetingRule( + operand="undefined", + values=[ + "values_example", + ], + ), + zip_codes=AdSetTargetingRule( + operand="undefined", + values=[ + "values_example", + ], + ), + ), + frequency_capping=AdSetFrequencyCapping( + frequency="hourly", + maximum_impressions=1, + ), + ), + budget=CreateAdSetBudget( + budget_strategy="capped", + budget_renewal="undefined", + budget_delivery_smoothing="accelerated", + budget_delivery_week="undefined", + budget_amount=3.14, + ), + tracking_code="tracking_code_example", + media_type="display", + ), + type="AdSet", + ), + ) # CreateAdSetRequest | the ad sets to create + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_ad_set(create_ad_set_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->create_ad_set: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_ad_set_request** | [**CreateAdSetRequest**](CreateAdSetRequest.md)| the ad sets to create | + +### Return type + +[**ResponseReadAdSet**](ResponseReadAdSet.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 | +|-------------|-------------|------------------| +**201** | The ad set that has been created and errors / warnings | - | +**400** | Bad Request | - | +**401** | The API client is not properly authenticated. | - | + +[[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_campaign** +> CampaignV23Q1Response create_campaign(create_campaign_request) + + + +Create the specified campaign + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.create_campaign_request import CreateCampaignRequest +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_response import CampaignV23Q1Response +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + create_campaign_request = CreateCampaignRequest( + data=CreateCampaignResource( + attributes=CreateCampaign( + name="name_example", + advertiser_id="advertiser_id_example", + goal="Unspecified", + spend_limit=CreateCampaignSpendLimit( + spend_limit_type="capped", + spend_limit_renewal="undefined", + spend_limit_amount=3.14, + ), + ), + type="Campaign", + ), + ) # CreateCampaignRequest | the campaigns to create + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_campaign(create_campaign_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->create_campaign: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_campaign_request** | [**CreateCampaignRequest**](CreateCampaignRequest.md)| the campaigns to create | + +### Return type + +[**CampaignV23Q1Response**](CampaignV23Q1Response.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 | +|-------------|-------------|------------------| +**201** | The campaign that has been created and errors / warnings | - | +**400** | Bad Request | - | +**401** | The API client is not properly authenticated. | - | + +[[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_ad_set_v23_q1** +> ResponseReadAdSetV23Q1 get_ad_set_v23_q1(ad_set_id) + + + +Get the data for the specified ad set + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.response_read_ad_set_v23_q1 import ResponseReadAdSetV23Q1 +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + ad_set_id = "ad-set-id_example" # str | Id of the ad set + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ad_set_v23_q1(ad_set_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_ad_set_v23_q1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ad_set_id** | **str**| Id of the ad set | + +### Return type + +[**ResponseReadAdSetV23Q1**](ResponseReadAdSetV23Q1.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | data for the ad set | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | + +[[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_v23_q1** +> CampaignV23Q1Response get_campaign_v23_q1(campaign_id) + + + +Get the data for the specified campaign + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_response import CampaignV23Q1Response +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + campaign_id = "campaign-id_example" # str | Id of the campaign + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_campaign_v23_q1(campaign_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_campaign_v23_q1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_id** | **str**| Id of the campaign | + +### Return type + +[**CampaignV23Q1Response**](CampaignV23Q1Response.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | data for the campaign | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | + +[[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_category_bid_list** +> AdSetCategoryBidListResponse get_category_bid_list(ad_set_id) + + + +Get the Category Bids for all valid Categories associated to an Ad Set + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + ad_set_id = "ad-set-id_example" # str | Id of the Ad Set + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_category_bid_list(ad_set_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_category_bid_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ad_set_id** | **str**| Id of the Ad Set | + +### Return type + +[**AdSetCategoryBidListResponse**](AdSetCategoryBidListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | List of Category Bids for all valid Categories associated to an Ad Set. | - | +**401** | The API client is not properly authenticated. | - | +**400** | Bad Request | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | + +[[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_display_multipliers** +> AdSetDisplayMultiplierListResponse get_display_multipliers(ad_set_id) + + + +Get the Display Multipliers for all valid Categories associated to an Ad Set + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + ad_set_id = "ad-set-id_example" # str | Id of the Ad Set + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_display_multipliers(ad_set_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_display_multipliers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ad_set_id** | **str**| Id of the Ad Set | + +### Return type + +[**AdSetDisplayMultiplierListResponse**](AdSetDisplayMultiplierListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | List of Display Multipliers for all valid Categories associated to an Ad Set. | - | +**401** | The API client is not properly authenticated. | - | +**400** | Bad Request | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | + +[[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) + +# **patch_ad_sets** +> ResponsesAdSetId patch_ad_sets() + + + +Patch a list of AdSets. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.responses_ad_set_id import ResponsesAdSetId +from criteo_api_marketingsolutions_v2024_04.model.requests_patch_ad_set import RequestsPatchAdSet +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + requests_patch_ad_set = RequestsPatchAdSet( + data=[ + WriteModelPatchAdSet( + id="id_example", + type="PatchAdSet", + attributes=PatchAdSet( + name="name_example", + scheduling=PatchAdSetScheduling( + start_date=NillableDateTime( + value=dateutil_parser('1970-01-01T00:00:00.00Z'), + ), + end_date=NillableDateTime( + value=dateutil_parser('1970-01-01T00:00:00.00Z'), + ), + ), + bidding=PatchAdSetBidding( + bid_amount=NillableDecimal( + value=3.14, + ), + ), + targeting=AdSetTargeting( + delivery_limitations=AdSetDeliveryLimitations( + environments=[ + "web", + ], + devices=[ + "other", + ], + operating_systems=[ + "android", + ], + ), + geo_location=AdSetGeoLocation( + countries=NillableAdSetTargetingRule( + value=NillableAdSetTargetingRuleValue(), + ), + subdivisions=NillableAdSetTargetingRule( + value=NillableAdSetTargetingRuleValue(), + ), + zip_codes=NillableAdSetTargetingRule( + value=NillableAdSetTargetingRuleValue(), + ), + ), + frequency_capping=AdSetFrequencyCapping( + frequency="hourly", + maximum_impressions=1, + ), + ), + budget=PatchAdSetBudget( + budget_strategy="capped", + budget_renewal="undefined", + budget_delivery_smoothing="accelerated", + budget_delivery_week="undefined", + budget_amount=NillableDecimal( + value=3.14, + ), + ), + ), + ), + ], + ) # RequestsPatchAdSet | List of adsets to patch. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.patch_ad_sets(requests_patch_ad_set=requests_patch_ad_set) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->patch_ad_sets: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requests_patch_ad_set** | [**RequestsPatchAdSet**](RequestsPatchAdSet.md)| List of adsets to patch. | [optional] + +### Return type + +[**ResponsesAdSetId**](ResponsesAdSetId.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** | List of patched adSets. | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | + +[[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) + +# **patch_campaigns** +> PatchResultCampaignListResponse patch_campaigns() + + + +Patch a list of Campaigns. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.patch_result_campaign_list_response import PatchResultCampaignListResponse +from criteo_api_marketingsolutions_v2024_04.model.patch_campaign_list_request import PatchCampaignListRequest +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + patch_campaign_list_request = PatchCampaignListRequest( + data=[ + PatchCampaignWriteResource( + id="id_example", + type="Campaign", + attributes=PatchCampaign( + spend_limit=PatchCampaignSpendLimit( + spend_limit_type="capped", + spend_limit_renewal="undefined", + spend_limit_amount=NillableDecimal( + value=3.14, + ), + ), + ), + ), + ], + ) # PatchCampaignListRequest | List of campaigns to patch. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.patch_campaigns(patch_campaign_list_request=patch_campaign_list_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->patch_campaigns: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **patch_campaign_list_request** | [**PatchCampaignListRequest**](PatchCampaignListRequest.md)| List of campaigns to patch. | [optional] + +### Return type + +[**PatchResultCampaignListResponse**](PatchResultCampaignListResponse.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** | List of patched campaigns. | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | + +[[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) + +# **patch_category_bid_list** +> PatchAdSetCategoryBidResultListResponse patch_category_bid_list(ad_set_id) + + + +Patch Category Bids for one or more Categories in a single request. Partial success policy is followed. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_list_request import PatchAdSetCategoryBidListRequest +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_category_bid_result_list_response import PatchAdSetCategoryBidResultListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + ad_set_id = "ad-set-id_example" # str | Id of the Ad Set + patch_ad_set_category_bid_list_request = PatchAdSetCategoryBidListRequest( + data=[ + PatchAdSetCategoryBidResource( + attributes=PatchAdSetCategoryBid( + bid_amount=3.14, + ), + id="id_example", + type="AdSetCategoryBid", + ), + ], + ) # PatchAdSetCategoryBidListRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.patch_category_bid_list(ad_set_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->patch_category_bid_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.patch_category_bid_list(ad_set_id, patch_ad_set_category_bid_list_request=patch_ad_set_category_bid_list_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->patch_category_bid_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ad_set_id** | **str**| Id of the Ad Set | + **patch_ad_set_category_bid_list_request** | [**PatchAdSetCategoryBidListRequest**](PatchAdSetCategoryBidListRequest.md)| | [optional] + +### Return type + +[**PatchAdSetCategoryBidResultListResponse**](PatchAdSetCategoryBidResultListResponse.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** | List of updated Category Bids for given Categories associated to an Ad Set. | - | +**401** | The API client is not properly authenticated. | - | +**400** | Bad Request | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | + +[[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) + +# **patch_display_multipliers** +> PatchAdSetDisplayMultiplierResultListResponse patch_display_multipliers(ad_set_id) + + + +Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_result_list_response import PatchAdSetDisplayMultiplierResultListResponse +from criteo_api_marketingsolutions_v2024_04.model.patch_ad_set_display_multiplier_list_request import PatchAdSetDisplayMultiplierListRequest +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + ad_set_id = "ad-set-id_example" # str | Id of the Ad Set + patch_ad_set_display_multiplier_list_request = PatchAdSetDisplayMultiplierListRequest( + data=[ + PatchAdSetDisplayMultiplierResource( + attributes=PatchAdSetDisplayMultiplier( + display_multiplier=3.14, + ), + id="id_example", + type="AdSetDisplayMultiplier", + ), + ], + ) # PatchAdSetDisplayMultiplierListRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.patch_display_multipliers(ad_set_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->patch_display_multipliers: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.patch_display_multipliers(ad_set_id, patch_ad_set_display_multiplier_list_request=patch_ad_set_display_multiplier_list_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->patch_display_multipliers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ad_set_id** | **str**| Id of the Ad Set | + **patch_ad_set_display_multiplier_list_request** | [**PatchAdSetDisplayMultiplierListRequest**](PatchAdSetDisplayMultiplierListRequest.md)| | [optional] + +### Return type + +[**PatchAdSetDisplayMultiplierResultListResponse**](PatchAdSetDisplayMultiplierResultListResponse.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** | List of updated Display Multipliers for given Categories associated to an Ad Set. | - | +**401** | The API client is not properly authenticated. | - | +**400** | Bad Request | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | + +[[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) + +# **search_ad_sets_v23_q1** +> ResponsesReadAdSetV23Q1 search_ad_sets_v23_q1() + + + +Search for ad sets + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.responses_read_ad_set_v23_q1 import ResponsesReadAdSetV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.ad_set_search_request_v23_q1 import AdSetSearchRequestV23Q1 +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + ad_set_search_request_v23_q1 = AdSetSearchRequestV23Q1( + filters=AdSetSearchFilterV23Q1( + ad_set_ids=[ + "ad_set_ids_example", + ], + advertiser_ids=[ + "advertiser_ids_example", + ], + campaign_ids=[ + "campaign_ids_example", + ], + ), + ) # AdSetSearchRequestV23Q1 | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.search_ad_sets_v23_q1(ad_set_search_request_v23_q1=ad_set_search_request_v23_q1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->search_ad_sets_v23_q1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ad_set_search_request_v23_q1** | [**AdSetSearchRequestV23Q1**](AdSetSearchRequestV23Q1.md)| | [optional] + +### Return type + +[**ResponsesReadAdSetV23Q1**](ResponsesReadAdSetV23Q1.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** | data for the ad sets | - | +**400** | Bad Request | - | +**403** | The API client is not authorized to access this resource or the resource does not exist. | - | +**401** | The API client is not properly authenticated. | - | + +[[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) + +# **search_campaigns_v23_q1** +> CampaignV23Q1ListResponse search_campaigns_v23_q1() + + + +Search for campaigns + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.campaign_search_request_v23_q1 import CampaignSearchRequestV23Q1 +from criteo_api_marketingsolutions_v2024_04.model.campaign_v23_q1_list_response import CampaignV23Q1ListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + campaign_search_request_v23_q1 = CampaignSearchRequestV23Q1( + filters=CampaignSearchFiltersV23Q1( + campaign_ids=[ + "campaign_ids_example", + ], + advertiser_ids=[ + "advertiser_ids_example", + ], + ), + ) # CampaignSearchRequestV23Q1 | filters on campaigns (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.search_campaigns_v23_q1(campaign_search_request_v23_q1=campaign_search_request_v23_q1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->search_campaigns_v23_q1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_search_request_v23_q1** | [**CampaignSearchRequestV23Q1**](CampaignSearchRequestV23Q1.md)| filters on campaigns | [optional] + +### Return type + +[**CampaignV23Q1ListResponse**](CampaignV23Q1ListResponse.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** | data for the campaigns | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**401** | The API client is not properly authenticated. | - | + +[[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) + +# **start_ad_sets** +> ResponsesAdSetId start_ad_sets() + + + +Start the specified list of ad sets + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.responses_ad_set_id import ResponsesAdSetId +from criteo_api_marketingsolutions_v2024_04.model.requests_ad_set_id import RequestsAdSetId +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + requests_ad_set_id = RequestsAdSetId( + data=[ + WriteModelAdSetId( + id="id_example", + type="AdSetId", + ), + ], + ) # RequestsAdSetId | All the ad sets to start (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.start_ad_sets(requests_ad_set_id=requests_ad_set_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->start_ad_sets: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requests_ad_set_id** | [**RequestsAdSetId**](RequestsAdSetId.md)| All the ad sets to start | [optional] + +### Return type + +[**ResponsesAdSetId**](ResponsesAdSetId.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** | List of ad sets that have been started and errors / warnings by ad set | - | +**400** | Bad Request | - | +**401** | The API client is not properly authenticated. | - | + +[[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) + +# **stop_ad_sets** +> ResponsesAdSetId stop_ad_sets() + + + +Stop the specified list of ad sets + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.responses_ad_set_id import ResponsesAdSetId +from criteo_api_marketingsolutions_v2024_04.model.requests_ad_set_id import RequestsAdSetId +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + requests_ad_set_id = RequestsAdSetId( + data=[ + WriteModelAdSetId( + id="id_example", + type="AdSetId", + ), + ], + ) # RequestsAdSetId | All the ad sets to stop (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.stop_ad_sets(requests_ad_set_id=requests_ad_set_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->stop_ad_sets: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requests_ad_set_id** | [**RequestsAdSetId**](RequestsAdSetId.md)| All the ad sets to stop | [optional] + +### Return type + +[**ResponsesAdSetId**](ResponsesAdSetId.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** | List of ad sets that have been stopped and errors / warnings by ad set | - | +**400** | Bad Request | - | +**401** | The API client is not properly authenticated. | - | + +[[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_ad_set_audience** +> AdSetAudienceLinkEntityV1Response update_ad_set_audience(ad_set_id, ad_set_audience_link_input_entity_v1) + + + +Link or unlink an audience with an ad set + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import campaign_api +from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_entity_v1_response import AdSetAudienceLinkEntityV1Response +from criteo_api_marketingsolutions_v2024_04.model.ad_set_audience_link_input_entity_v1 import AdSetAudienceLinkInputEntityV1 +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + ad_set_id = "ad-set-id_example" # str | The ad set ID. + ad_set_audience_link_input_entity_v1 = AdSetAudienceLinkInputEntityV1( + data=AdSetAudienceLinkEntityV1Resource( + attributes=AdSetAudienceLinkEntityV1( + audience_id="audience_id_example", + ), + id="id_example", + type="type_example", + ), + ) # AdSetAudienceLinkInputEntityV1 | Ad set-Audience update request. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_ad_set_audience(ad_set_id, ad_set_audience_link_input_entity_v1) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->update_ad_set_audience: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ad_set_id** | **str**| The ad set ID. | + **ad_set_audience_link_input_entity_v1** | [**AdSetAudienceLinkInputEntityV1**](AdSetAudienceLinkInputEntityV1.md)| Ad set-Audience update request. | + +### Return type + +[**AdSetAudienceLinkEntityV1Response**](AdSetAudienceLinkEntityV1Response.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 | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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/marketingsolutions_2024-04/docs/CampaignSearchFiltersV23Q1.md b/sdks/marketingsolutions_2024-04/docs/CampaignSearchFiltersV23Q1.md new file mode 100644 index 00000000..88d37bdc --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CampaignSearchFiltersV23Q1.md @@ -0,0 +1,14 @@ +# CampaignSearchFiltersV23Q1 + +filters on campaign + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign_ids** | **[str], none_type** | | [optional] +**advertiser_ids** | **[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/marketingsolutions_2024-04/docs/CampaignSearchRequestV23Q1.md b/sdks/marketingsolutions_2024-04/docs/CampaignSearchRequestV23Q1.md new file mode 100644 index 00000000..30f6a0a5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CampaignSearchRequestV23Q1.md @@ -0,0 +1,13 @@ +# CampaignSearchRequestV23Q1 + +request payload of the search endpoint + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filters** | [**CampaignSearchFiltersV23Q1**](CampaignSearchFiltersV23Q1.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/marketingsolutions_2024-04/docs/CampaignSpendLimitV23Q1.md b/sdks/marketingsolutions_2024-04/docs/CampaignSpendLimitV23Q1.md new file mode 100644 index 00000000..33480b21 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CampaignSpendLimitV23Q1.md @@ -0,0 +1,15 @@ +# CampaignSpendLimitV23Q1 + +campaign spend limit model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**spend_limit_type** | **str, none_type** | | [optional] +**spend_limit_renewal** | **str, none_type** | | [optional] +**spend_limit_amount** | [**NillableDecimal**](NillableDecimal.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/marketingsolutions_2024-04/docs/CampaignV23Q1.md b/sdks/marketingsolutions_2024-04/docs/CampaignV23Q1.md new file mode 100644 index 00000000..3f53ed6e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CampaignV23Q1.md @@ -0,0 +1,16 @@ +# CampaignV23Q1 + +campaign read model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | | [optional] +**advertiser_id** | **str, none_type** | | [optional] +**spend_limit** | [**CampaignSpendLimitV23Q1**](CampaignSpendLimitV23Q1.md) | | [optional] +**goal** | **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/marketingsolutions_2024-04/docs/CampaignV23Q1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/CampaignV23Q1ListResponse.md new file mode 100644 index 00000000..525b9f4c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CampaignV23Q1ListResponse.md @@ -0,0 +1,15 @@ +# CampaignV23Q1ListResponse + +Data model for a list of response resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[CampaignV23Q1Resource], none_type**](CampaignV23Q1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/CampaignV23Q1Resource.md b/sdks/marketingsolutions_2024-04/docs/CampaignV23Q1Resource.md new file mode 100644 index 00000000..e359503f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CampaignV23Q1Resource.md @@ -0,0 +1,15 @@ +# CampaignV23Q1Resource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**CampaignV23Q1**](CampaignV23Q1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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_2024-04/docs/CampaignV23Q1Response.md b/sdks/marketingsolutions_2024-04/docs/CampaignV23Q1Response.md new file mode 100644 index 00000000..bf515b60 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CampaignV23Q1Response.md @@ -0,0 +1,15 @@ +# CampaignV23Q1Response + +Data model for response resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**CampaignV23Q1Resource**](CampaignV23Q1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2023-01/docs/CommonProblem.md b/sdks/marketingsolutions_2024-04/docs/CommonProblem.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/CommonProblem.md rename to sdks/marketingsolutions_2024-04/docs/CommonProblem.md diff --git a/sdks/marketingsolutions_2024-04/docs/ContactListStatisticsEntityV1.md b/sdks/marketingsolutions_2024-04/docs/ContactListStatisticsEntityV1.md new file mode 100644 index 00000000..ce5217a7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ContactListStatisticsEntityV1.md @@ -0,0 +1,15 @@ +# ContactListStatisticsEntityV1 + +Contact list statistics. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number_of_identifiers** | **int, none_type** | Number of identifiers in the contact list. | [optional] +**number_of_matches** | **int, none_type** | Number of matched identifiers in the contact list. | [optional] +**match_rate** | **float, none_type** | Percentage of matched identifiers in the contact list. Can differ from matches/identifiers depending on the contact list 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_2024-04/docs/ContactListStatisticsEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/ContactListStatisticsEntityV1Resource.md new file mode 100644 index 00000000..4f888887 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ContactListStatisticsEntityV1Resource.md @@ -0,0 +1,15 @@ +# ContactListStatisticsEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**ContactListStatisticsEntityV1**](ContactListStatisticsEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/ContactListStatisticsEntityV1Response.md b/sdks/marketingsolutions_2024-04/docs/ContactListStatisticsEntityV1Response.md new file mode 100644 index 00000000..839c9d02 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ContactListStatisticsEntityV1Response.md @@ -0,0 +1,15 @@ +# ContactListStatisticsEntityV1Response + +A top-level object that encapsulates a Criteo API response for a single entity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ContactListStatisticsEntityV1Resource**](ContactListStatisticsEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/ContactListV1.md b/sdks/marketingsolutions_2024-04/docs/ContactListV1.md new file mode 100644 index 00000000..2b17e8ac --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ContactListV1.md @@ -0,0 +1,13 @@ +# ContactListV1 + +Settings to target users with your contact lists. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**is_read_only** | **bool, none_type** | Is the segment read-only | [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_2023-01/docs/ContactlistAmendment.md b/sdks/marketingsolutions_2024-04/docs/ContactlistAmendment.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ContactlistAmendment.md rename to sdks/marketingsolutions_2024-04/docs/ContactlistAmendment.md diff --git a/sdks/marketingsolutions_2023-01/docs/ContactlistAmendmentAttributes.md b/sdks/marketingsolutions_2024-04/docs/ContactlistAmendmentAttributes.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ContactlistAmendmentAttributes.md rename to sdks/marketingsolutions_2024-04/docs/ContactlistAmendmentAttributes.md diff --git a/sdks/marketingsolutions_2023-01/docs/ContactlistAmendmentRequest.md b/sdks/marketingsolutions_2024-04/docs/ContactlistAmendmentRequest.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ContactlistAmendmentRequest.md rename to sdks/marketingsolutions_2024-04/docs/ContactlistAmendmentRequest.md diff --git a/sdks/marketingsolutions_2023-01/docs/ContactlistOperation.md b/sdks/marketingsolutions_2024-04/docs/ContactlistOperation.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ContactlistOperation.md rename to sdks/marketingsolutions_2024-04/docs/ContactlistOperation.md diff --git a/sdks/marketingsolutions_2023-01/docs/ContactlistOperationAttributes.md b/sdks/marketingsolutions_2024-04/docs/ContactlistOperationAttributes.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ContactlistOperationAttributes.md rename to sdks/marketingsolutions_2024-04/docs/ContactlistOperationAttributes.md diff --git a/sdks/marketingsolutions_2024-04/docs/Coupon.md b/sdks/marketingsolutions_2024-04/docs/Coupon.md new file mode 100644 index 00000000..e0ba2bee --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/Coupon.md @@ -0,0 +1,26 @@ +# Coupon + +Coupons are static images applied on ad set which can be displayed within an ad and link to a landing page. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | The name of the Coupon | [optional] +**description** | **str, none_type** | The description of the Coupon | [optional] +**author** | **str, none_type** | The login of the person who created this Coupon | [optional] +**advertiser_id** | **str, none_type** | Advertiser linked to the Coupon | [optional] +**ad_set_id** | **str, none_type** | The id of the Ad Set on which the Coupon is applied to | [optional] +**landing_page_url** | **str, none_type** | Web redirection of the landing page url | [optional] +**start_date** | **str, none_type** | The date when the Coupon will be launched String must be in ISO8601 format | [optional] +**end_date** | **str, none_type** | The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format | [optional] +**format** | **str, none_type** | Format of the Coupon, it can have two values: \"FullFrame\" or \"LogoZone\" | [optional] +**status** | **str, none_type** | The status of the Coupon | [optional] +**images** | [**[ImageSlide], none_type**](ImageSlide.md) | List of slides containing the image URLs | [optional] +**show_every** | **int, none_type** | Show the Coupon every N seconds (between 1 and 10) | [optional] +**show_duration** | **int, none_type** | Show Coupon for a duration of N seconds (between 1 and 5) | [optional] +**rotations_number** | **int, none_type** | Number of rotations for the Coupons (from 1 to 10 times) | [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_2024-04/docs/CouponListResponse.md b/sdks/marketingsolutions_2024-04/docs/CouponListResponse.md new file mode 100644 index 00000000..33636917 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CouponListResponse.md @@ -0,0 +1,15 @@ +# CouponListResponse + +Data model for a list of response resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[CouponResource], none_type**](CouponResource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/CouponResource.md b/sdks/marketingsolutions_2024-04/docs/CouponResource.md new file mode 100644 index 00000000..bd0e592d --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CouponResource.md @@ -0,0 +1,15 @@ +# CouponResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**Coupon**](Coupon.md) | | [optional] +**id** | **str, none_type** | | [optional] +**type** | **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/marketingsolutions_2024-04/docs/CouponResponse.md b/sdks/marketingsolutions_2024-04/docs/CouponResponse.md new file mode 100644 index 00000000..cf82954e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CouponResponse.md @@ -0,0 +1,15 @@ +# CouponResponse + +Data model for response resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**CouponResource**](CouponResource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/CouponSupportedSizes.md b/sdks/marketingsolutions_2024-04/docs/CouponSupportedSizes.md new file mode 100644 index 00000000..52ae04d5 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CouponSupportedSizes.md @@ -0,0 +1,14 @@ +# CouponSupportedSizes + +Entity containing the list of Coupon supported sizes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**logo_zone** | **[str], none_type** | Array of LogoZone sizes as string in width x height format | [optional] +**full_frame** | **[str], none_type** | Array of FullFrame sizes as string in width x height format | [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_2024-04/docs/CouponSupportedSizesResource.md b/sdks/marketingsolutions_2024-04/docs/CouponSupportedSizesResource.md new file mode 100644 index 00000000..24e26c2f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CouponSupportedSizesResource.md @@ -0,0 +1,15 @@ +# CouponSupportedSizesResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**CouponSupportedSizes**](CouponSupportedSizes.md) | | [optional] +**id** | **str, none_type** | | [optional] +**type** | **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/marketingsolutions_2024-04/docs/CouponSupportedSizesResponse.md b/sdks/marketingsolutions_2024-04/docs/CouponSupportedSizesResponse.md new file mode 100644 index 00000000..dbc5e0c8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CouponSupportedSizesResponse.md @@ -0,0 +1,15 @@ +# CouponSupportedSizesResponse + +Data model for response resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**CouponSupportedSizesResource**](CouponSupportedSizesResource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/CreateAdSet.md b/sdks/marketingsolutions_2024-04/docs/CreateAdSet.md new file mode 100644 index 00000000..a13ef417 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateAdSet.md @@ -0,0 +1,22 @@ +# CreateAdSet + +ad set create model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of the ad set | +**dataset_id** | **str, none_type** | Dataset id of this ad set | +**campaign_id** | **str, none_type** | Campaign id this ad set belongs to | +**objective** | **str** | Objective of the ad set | +**schedule** | [**CreateAdSetSchedule**](CreateAdSetSchedule.md) | | +**bidding** | [**CreateAdSetBidding**](CreateAdSetBidding.md) | | +**targeting** | [**CreateAdSetTargeting**](CreateAdSetTargeting.md) | | +**budget** | [**CreateAdSetBudget**](CreateAdSetBudget.md) | | +**tracking_code** | **str, none_type** | The click tracking code associated to this Ad Set. | +**media_type** | **str** | Media type for the ad set | +**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_2024-04/docs/CreateAdSetBidding.md b/sdks/marketingsolutions_2024-04/docs/CreateAdSetBidding.md new file mode 100644 index 00000000..3594ba2e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateAdSetBidding.md @@ -0,0 +1,14 @@ +# CreateAdSetBidding + +ad set bidding create model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cost_controller** | **str** | How spend is controlled | +**bid_amount** | **float, none_type** | Decimal value target relating to the `bidStrategy` specified. May be `null` for strategies that do not require a target value. At most 4 decimals are supported. Additional decimals are rounded. | [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_2024-04/docs/CreateAdSetBudget.md b/sdks/marketingsolutions_2024-04/docs/CreateAdSetBudget.md new file mode 100644 index 00000000..cf5fd312 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateAdSetBudget.md @@ -0,0 +1,17 @@ +# CreateAdSetBudget + +ad set budget create model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**budget_strategy** | **str** | | +**budget_renewal** | **str, none_type** | | [optional] +**budget_delivery_smoothing** | **str, none_type** | | [optional] +**budget_delivery_week** | **str, none_type** | | [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_2024-04/docs/CreateAdSetGeoLocation.md b/sdks/marketingsolutions_2024-04/docs/CreateAdSetGeoLocation.md new file mode 100644 index 00000000..c2fde1f0 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateAdSetGeoLocation.md @@ -0,0 +1,15 @@ +# CreateAdSetGeoLocation + +Geolocation configuration of the ad set + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**countries** | [**AdSetTargetingRule**](AdSetTargetingRule.md) | | [optional] +**subdivisions** | [**AdSetTargetingRule**](AdSetTargetingRule.md) | | [optional] +**zip_codes** | [**AdSetTargetingRule**](AdSetTargetingRule.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/marketingsolutions_2024-04/docs/CreateAdSetRequest.md b/sdks/marketingsolutions_2024-04/docs/CreateAdSetRequest.md new file mode 100644 index 00000000..13bee9cc --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateAdSetRequest.md @@ -0,0 +1,13 @@ +# CreateAdSetRequest + +Data model for an input resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**CreateAdSetResource**](CreateAdSetResource.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/marketingsolutions_2024-04/docs/CreateAdSetResource.md b/sdks/marketingsolutions_2024-04/docs/CreateAdSetResource.md new file mode 100644 index 00000000..a09e6d9b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateAdSetResource.md @@ -0,0 +1,14 @@ +# CreateAdSetResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**CreateAdSet**](CreateAdSet.md) | | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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_2024-04/docs/CreateAdSetSchedule.md b/sdks/marketingsolutions_2024-04/docs/CreateAdSetSchedule.md new file mode 100644 index 00000000..c4e8be2a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateAdSetSchedule.md @@ -0,0 +1,14 @@ +# CreateAdSetSchedule + +ad set schedule create model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **datetime** | | +**end_date** | **datetime, 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_2024-04/docs/CreateAdSetTargeting.md b/sdks/marketingsolutions_2024-04/docs/CreateAdSetTargeting.md new file mode 100644 index 00000000..835a9743 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateAdSetTargeting.md @@ -0,0 +1,15 @@ +# CreateAdSetTargeting + +Targeting configuration of the ad set + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**frequency_capping** | [**AdSetFrequencyCapping**](AdSetFrequencyCapping.md) | | +**delivery_limitations** | [**AdSetDeliveryLimitations**](AdSetDeliveryLimitations.md) | | [optional] +**geo_location** | [**CreateAdSetGeoLocation**](CreateAdSetGeoLocation.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/marketingsolutions_2024-04/docs/CreateCampaign.md b/sdks/marketingsolutions_2024-04/docs/CreateCampaign.md new file mode 100644 index 00000000..ff60d516 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateCampaign.md @@ -0,0 +1,16 @@ +# CreateCampaign + +Campaign create model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of the campaign | +**advertiser_id** | **str, none_type** | Advertiser id this campaign belongs to | +**goal** | **str** | Goal for the marketing campaign | +**spend_limit** | [**CreateCampaignSpendLimit**](CreateCampaignSpendLimit.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/marketingsolutions_2024-04/docs/CreateCampaignRequest.md b/sdks/marketingsolutions_2024-04/docs/CreateCampaignRequest.md new file mode 100644 index 00000000..06d9d1e9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateCampaignRequest.md @@ -0,0 +1,13 @@ +# CreateCampaignRequest + +Data model for an input resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**CreateCampaignResource**](CreateCampaignResource.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/marketingsolutions_2024-04/docs/CreateCampaignResource.md b/sdks/marketingsolutions_2024-04/docs/CreateCampaignResource.md new file mode 100644 index 00000000..2bedb65a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateCampaignResource.md @@ -0,0 +1,14 @@ +# CreateCampaignResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**CreateCampaign**](CreateCampaign.md) | | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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_2024-04/docs/CreateCampaignSpendLimit.md b/sdks/marketingsolutions_2024-04/docs/CreateCampaignSpendLimit.md new file mode 100644 index 00000000..d5e80d11 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateCampaignSpendLimit.md @@ -0,0 +1,15 @@ +# CreateCampaignSpendLimit + +campaign spend limit create model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**spend_limit_type** | **str** | Whether your spend limit is capped or not | +**spend_limit_renewal** | **str, none_type** | The pace of the spend limit renewal | [optional] +**spend_limit_amount** | **float, none_type** | The amount of the spend limit. null if spendLimitType is uncapped. | [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_2024-04/docs/CreateCoupon.md b/sdks/marketingsolutions_2024-04/docs/CreateCoupon.md new file mode 100644 index 00000000..f36eabd4 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateCoupon.md @@ -0,0 +1,23 @@ +# CreateCoupon + +Entity to create a Coupon + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the Coupon | +**ad_set_id** | **str** | The id of the Ad Set on which the Coupon is applied to | +**landing_page_url** | **str** | Web redirection of the landing page url | +**start_date** | **str** | The date when the coupon will be launched String must be in ISO8601 format | +**format** | **str** | Format of the Coupon, it can have two values: \"FullFrame\" or \"LogoZone\" | +**images** | [**[CreateImageSlide]**](CreateImageSlide.md) | List of slides containing the images as a base-64 encoded string | +**show_every** | **int** | Show the Coupon every N seconds (between 1 and 10) | +**show_duration** | **int** | Show Coupon for a duration of N seconds (between 1 and 5) | +**rotations_number** | **int** | Number of rotations for the Coupons (from 1 to 10 times) | +**description** | **str, none_type** | The description of the Coupon | [optional] +**end_date** | **str, none_type** | The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format | [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_2024-04/docs/CreateCouponRequest.md b/sdks/marketingsolutions_2024-04/docs/CreateCouponRequest.md new file mode 100644 index 00000000..612272cc --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateCouponRequest.md @@ -0,0 +1,13 @@ +# CreateCouponRequest + +Data model for input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**CreateCouponResource**](CreateCouponResource.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/marketingsolutions_2024-04/docs/CreateCouponResource.md b/sdks/marketingsolutions_2024-04/docs/CreateCouponResource.md new file mode 100644 index 00000000..ff19b759 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateCouponResource.md @@ -0,0 +1,15 @@ +# CreateCouponResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**CreateCoupon**](CreateCoupon.md) | | [optional] +**id** | **str, none_type** | | [optional] +**type** | **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/marketingsolutions_2024-04/docs/CreateImageSlide.md b/sdks/marketingsolutions_2024-04/docs/CreateImageSlide.md new file mode 100644 index 00000000..a7cd3839 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreateImageSlide.md @@ -0,0 +1,15 @@ +# CreateImageSlide + +Slide containing the images of the same size as a base-64 encoded string + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**width** | **int, none_type** | Width of the Coupon slide | [optional] +**height** | **int, none_type** | Height of the Coupon slide | [optional] +**slide_base64_strings** | **[str], none_type** | Array of images of the same size as a base-64 encoded string | [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_2024-04/docs/Creative.md b/sdks/marketingsolutions_2024-04/docs/Creative.md new file mode 100644 index 00000000..670e1fd9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/Creative.md @@ -0,0 +1,23 @@ +# Creative + +A creative is a project with the necessary information to display a creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the creative | +**author** | **str** | The login of the person who created this creative ( | +**status** | **str** | The status of the creative | +**advertiser_id** | **str** | Advertiser linked to the Creative | +**description** | **str, none_type** | The description of the creative | [optional] +**format** | **str, none_type** | The format of the creative | [optional] +**dataset_id** | **str, none_type** | Data set id linked to the Creative | [optional] +**image_attributes** | [**ImageAttributes**](ImageAttributes.md) | | [optional] +**html_tag_attributes** | [**HtmlTagAttributes**](HtmlTagAttributes.md) | | [optional] +**dynamic_attributes** | [**DynamicAttributes**](DynamicAttributes.md) | | [optional] +**adaptive_attributes** | [**AdaptiveAttributes**](AdaptiveAttributes.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/marketingsolutions_2024-04/docs/CreativeApi.md b/sdks/marketingsolutions_2024-04/docs/CreativeApi.md new file mode 100644 index 00000000..059cc242 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreativeApi.md @@ -0,0 +1,1775 @@ +# criteo_api_marketingsolutions_v2024_04.CreativeApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_advertiser_ad**](CreativeApi.md#create_advertiser_ad) | **POST** /2024-04/marketing-solutions/advertisers/{advertiser-id}/ads | +[**create_advertiser_coupon**](CreativeApi.md#create_advertiser_coupon) | **POST** /2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons | +[**create_advertiser_creative**](CreativeApi.md#create_advertiser_creative) | **POST** /2024-04/marketing-solutions/advertisers/{advertiser-id}/creatives | +[**delete_ad**](CreativeApi.md#delete_ad) | **DELETE** /2024-04/marketing-solutions/ads/{id} | +[**delete_advertiser_coupon**](CreativeApi.md#delete_advertiser_coupon) | **DELETE** /2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons/{id} | +[**delete_creative**](CreativeApi.md#delete_creative) | **DELETE** /2024-04/marketing-solutions/creatives/{id} | +[**edit_advertiser_coupon**](CreativeApi.md#edit_advertiser_coupon) | **PUT** /2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons/{id} | +[**edit_creative**](CreativeApi.md#edit_creative) | **PUT** /2024-04/marketing-solutions/creatives/{id} | +[**generate_creative_preview**](CreativeApi.md#generate_creative_preview) | **POST** /2024-04/marketing-solutions/creatives/{id}/preview | +[**get_ad**](CreativeApi.md#get_ad) | **GET** /2024-04/marketing-solutions/ads/{id} | +[**get_advertiser_ads**](CreativeApi.md#get_advertiser_ads) | **GET** /2024-04/marketing-solutions/advertisers/{advertiser-id}/ads | +[**get_advertiser_coupon**](CreativeApi.md#get_advertiser_coupon) | **GET** /2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons/{id} | +[**get_advertiser_coupon_preview**](CreativeApi.md#get_advertiser_coupon_preview) | **GET** /2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}/preview | +[**get_advertiser_coupon_supported_sizes**](CreativeApi.md#get_advertiser_coupon_supported_sizes) | **GET** /2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons-supported-sizes | +[**get_advertiser_coupons**](CreativeApi.md#get_advertiser_coupons) | **GET** /2024-04/marketing-solutions/advertisers/{advertiser-id}/coupons | +[**get_advertiser_creatives**](CreativeApi.md#get_advertiser_creatives) | **GET** /2024-04/marketing-solutions/advertisers/{advertiser-id}/creatives | +[**get_creative**](CreativeApi.md#get_creative) | **GET** /2024-04/marketing-solutions/creatives/{id} | + + +# **create_advertiser_ad** +> AdResponse create_advertiser_ad(advertiser_id, ad_write_request) + + + +Create an Ad + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.ad_response import AdResponse +from criteo_api_marketingsolutions_v2024_04.model.ad_write_request import AdWriteRequest +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + ad_write_request = AdWriteRequest( + data=AdWriteResource( + attributes=AdWrite( + name="name_example", + description="description_example", + creative_id="creative_id_example", + ad_set_id="ad_set_id_example", + inventory_type="Display", + start_date="start_date_example", + end_date="end_date_example", + ), + id="id_example", + type="type_example", + ), + ) # AdWriteRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_advertiser_ad(advertiser_id, ad_write_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->create_advertiser_ad: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **ad_write_request** | [**AdWriteRequest**](AdWriteRequest.md)| | + +### Return type + +[**AdResponse**](AdResponse.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 | +|-------------|-------------|------------------| +**201** | The created Ad is returned. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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_advertiser_coupon** +> CouponResponse create_advertiser_coupon(advertiser_id, create_coupon_request) + + + +Create a Coupon + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.coupon_response import CouponResponse +from criteo_api_marketingsolutions_v2024_04.model.create_coupon_request import CreateCouponRequest +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + create_coupon_request = CreateCouponRequest( + data=CreateCouponResource( + attributes=CreateCoupon( + name="name_example", + description="description_example", + ad_set_id="ad_set_id_example", + landing_page_url="landing_page_url_example", + start_date="start_date_example", + end_date="end_date_example", + format="FullFrame", + images=[ + CreateImageSlide( + width=1, + height=1, + slide_base64_strings=[ + "slide_base64_strings_example", + ], + ), + ], + show_every=1, + show_duration=1, + rotations_number=1, + ), + id="id_example", + type="type_example", + ), + ) # CreateCouponRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_advertiser_coupon(advertiser_id, create_coupon_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->create_advertiser_coupon: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **create_coupon_request** | [**CreateCouponRequest**](CreateCouponRequest.md)| | + +### Return type + +[**CouponResponse**](CouponResponse.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 | +|-------------|-------------|------------------| +**201** | The created Coupon is returned. | - | +**400** | The request contained invalid parameters. | - | +**403** | The request was not properly authorized. | - | + +[[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_advertiser_creative** +> CreativeResponse create_advertiser_creative(advertiser_id, creative_write_request) + + + +Create a Creative + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.creative_response import CreativeResponse +from criteo_api_marketingsolutions_v2024_04.model.creative_write_request import CreativeWriteRequest +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + creative_write_request = CreativeWriteRequest( + data=CreativeWriteResource( + attributes=CreativeWrite( + name="name_example", + description="description_example", + format="Image", + dataset_id="dataset_id_example", + image_write_attributes=ImageWriteAttributes( + base64_strings=[ + "base64_strings_example", + ], + landing_page_url="landing_page_url_example", + ), + html_tag_write_attributes=HtmlTagWriteAttributes( + tags=[ + Tag( + html_tag="html_tag_example", + size=Size( + width=1, + height=1, + ), + ), + ], + ), + dynamic_write_attributes=DynamicWriteAttributes( + logo_base64_string="logo_base64_string_example", + creative_background_color="creative_background_color_example", + body_text_color="body_text_color_example", + prices_color="prices_color_example", + primary_font="primary_font_example", + calls_to_action=[ + "calls_to_action_example", + ], + product_image_display="ShowFullImage", + ), + adaptive_write_attributes=AdaptiveWriteAttributes( + layouts=[ + "Editorial", + ], + logo_base64_string="logo_base64_string_example", + headline_text="headline_text_example", + headline_font="headline_font_example", + description_text="description_text_example", + description_font="description_font_example", + calls_to_action=[ + "calls_to_action_example", + ], + colors=AdaptiveColors( + logo_area_and_title_color="logo_area_and_title_color_example", + background_color="background_color_example", + text1_color="text1_color_example", + text2_color="text2_color_example", + cta_background_color="cta_background_color_example", + cta_text_color="cta_text_color_example", + ), + image_sets_base64=[ + ImageSetBase64( + image_base64_strings=[ + "image_base64_strings_example", + ], + headline_text="headline_text_example", + ), + ], + image_display="ShowFullImage", + video_base64_strings=[ + "video_base64_strings_example", + ], + landing_page_url="landing_page_url_example", + ), + ), + id="id_example", + type="type_example", + ), + ) # CreativeWriteRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_advertiser_creative(advertiser_id, creative_write_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->create_advertiser_creative: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **creative_write_request** | [**CreativeWriteRequest**](CreativeWriteRequest.md)| | + +### Return type + +[**CreativeResponse**](CreativeResponse.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 | +|-------------|-------------|------------------| +**201** | The created creative is returned. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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) + +# **delete_ad** +> delete_ad(id) + + + +Delete an Ad + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + id = 1 # int | The ad identifier to delete. + + # example passing only required values which don't have defaults set + try: + api_instance.delete_ad(id) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->delete_ad: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **int**| The ad identifier to delete. | + +### Return type + +void (empty response body) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | The ad was deleted. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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) + +# **delete_advertiser_coupon** +> delete_advertiser_coupon(advertiser_id, id) + + + +Delete a Coupon + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + id = "id_example" # str | The Coupon identifier to delete. + + # example passing only required values which don't have defaults set + try: + api_instance.delete_advertiser_coupon(advertiser_id, id) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->delete_advertiser_coupon: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **id** | **str**| The Coupon identifier to delete. | + +### Return type + +void (empty response body) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | The Coupon was deleted. | - | +**400** | The request contained invalid parameters. | - | +**403** | The request was not properly authorized. | - | + +[[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) + +# **delete_creative** +> delete_creative(id) + + + +Delete a Creative if there are no ads binded to it + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + id = "id_example" # str | The creative identifier to delete. + + # example passing only required values which don't have defaults set + try: + api_instance.delete_creative(id) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->delete_creative: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The creative identifier to delete. | + +### Return type + +void (empty response body) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | The creative was deleted. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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) + +# **edit_advertiser_coupon** +> CouponResponse edit_advertiser_coupon(advertiser_id, id, update_coupon_request) + + + +Edit a specific Coupon + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.coupon_response import CouponResponse +from criteo_api_marketingsolutions_v2024_04.model.update_coupon_request import UpdateCouponRequest +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + id = "id_example" # str | The Coupon identifier to edit. + update_coupon_request = UpdateCouponRequest( + data=UpdateCouponResource( + attributes=UpdateCoupon( + start_date="start_date_example", + end_date="end_date_example", + ), + id="id_example", + type="type_example", + ), + ) # UpdateCouponRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_advertiser_coupon(advertiser_id, id, update_coupon_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->edit_advertiser_coupon: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **id** | **str**| The Coupon identifier to edit. | + **update_coupon_request** | [**UpdateCouponRequest**](UpdateCouponRequest.md)| | + +### Return type + +[**CouponResponse**](CouponResponse.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** | The edited Coupon is returned. | - | +**400** | The request contained invalid parameters. | - | + +[[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) + +# **edit_creative** +> CreativeResponse edit_creative(id, creative_write_request) + + + +Edit a specific Creative + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.creative_response import CreativeResponse +from criteo_api_marketingsolutions_v2024_04.model.creative_write_request import CreativeWriteRequest +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + id = "id_example" # str | The creative identifier to edit. + creative_write_request = CreativeWriteRequest( + data=CreativeWriteResource( + attributes=CreativeWrite( + name="name_example", + description="description_example", + format="Image", + dataset_id="dataset_id_example", + image_write_attributes=ImageWriteAttributes( + base64_strings=[ + "base64_strings_example", + ], + landing_page_url="landing_page_url_example", + ), + html_tag_write_attributes=HtmlTagWriteAttributes( + tags=[ + Tag( + html_tag="html_tag_example", + size=Size( + width=1, + height=1, + ), + ), + ], + ), + dynamic_write_attributes=DynamicWriteAttributes( + logo_base64_string="logo_base64_string_example", + creative_background_color="creative_background_color_example", + body_text_color="body_text_color_example", + prices_color="prices_color_example", + primary_font="primary_font_example", + calls_to_action=[ + "calls_to_action_example", + ], + product_image_display="ShowFullImage", + ), + adaptive_write_attributes=AdaptiveWriteAttributes( + layouts=[ + "Editorial", + ], + logo_base64_string="logo_base64_string_example", + headline_text="headline_text_example", + headline_font="headline_font_example", + description_text="description_text_example", + description_font="description_font_example", + calls_to_action=[ + "calls_to_action_example", + ], + colors=AdaptiveColors( + logo_area_and_title_color="logo_area_and_title_color_example", + background_color="background_color_example", + text1_color="text1_color_example", + text2_color="text2_color_example", + cta_background_color="cta_background_color_example", + cta_text_color="cta_text_color_example", + ), + image_sets_base64=[ + ImageSetBase64( + image_base64_strings=[ + "image_base64_strings_example", + ], + headline_text="headline_text_example", + ), + ], + image_display="ShowFullImage", + video_base64_strings=[ + "video_base64_strings_example", + ], + landing_page_url="landing_page_url_example", + ), + ), + id="id_example", + type="type_example", + ), + ) # CreativeWriteRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.edit_creative(id, creative_write_request) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->edit_creative: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The creative identifier to edit. | + **creative_write_request** | [**CreativeWriteRequest**](CreativeWriteRequest.md)| | + +### Return type + +[**CreativeResponse**](CreativeResponse.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** | The edited creative is returned. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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_creative_preview** +> str generate_creative_preview(id) + + + +Generate a preview of a specific Creative + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + id = "id_example" # str | The Creative identifier to preview. + width = 1 # int | The width of the Creative to preview. (optional) + height = 1 # int | The height of the Creative to preview. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_creative_preview(id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->generate_creative_preview: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.generate_creative_preview(id, width=width, height=height) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->generate_creative_preview: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The Creative identifier to preview. | + **width** | **int**| The width of the Creative to preview. | [optional] + **height** | **int**| The height of the Creative to preview. | [optional] + +### Return type + +**str** + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/html, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The preview HTML of a specific Creative is returned. | - | +**400** | The request contained invalid parameters. | - | +**403** | The request was not properly authorized. | - | + +[[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_ad** +> AdResponse get_ad(id) + + + +Get an Ad from its id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.ad_response import AdResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + id = 1 # int | The ad identifier to retrieve. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_ad(id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_ad: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **int**| The ad identifier to retrieve. | + +### Return type + +[**AdResponse**](AdResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The found ad is returned. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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_advertiser_ads** +> AdListResponse get_advertiser_ads(advertiser_id) + + + +Get the list of self-services Ads for a given advertiser + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.ad_list_response import AdListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + limit = 1 # int | The number of ads to be returned. The default is 50. (optional) + offset = 1 # int | The (zero-based) offset into the collection of ads. The default is 0. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_advertiser_ads(advertiser_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_ads: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_advertiser_ads(advertiser_id, limit=limit, offset=offset) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_ads: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **limit** | **int**| The number of ads to be returned. The default is 50. | [optional] + **offset** | **int**| The (zero-based) offset into the collection of ads. The default is 0. | [optional] + +### Return type + +[**AdListResponse**](AdListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The list of self-services Ads is returned. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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_advertiser_coupon** +> CouponResponse get_advertiser_coupon(advertiser_id, id) + + + +Get a Coupon from its id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.coupon_response import CouponResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + id = "id_example" # str | The Coupon identifier to retrieve. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_advertiser_coupon(advertiser_id, id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_coupon: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **id** | **str**| The Coupon identifier to retrieve. | + +### Return type + +[**CouponResponse**](CouponResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The found Coupon is returned. | - | +**400** | The request contained invalid parameters. | - | +**403** | The request was not properly authorized. | - | + +[[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_advertiser_coupon_preview** +> str get_advertiser_coupon_preview(advertiser_id, id) + + + +Get the preview of a specific Coupon + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + id = "id_example" # str | The Coupon identifier to preview. + width = 1 # int | The width of the coupon to preview. (optional) + height = 1 # int | The height of the coupon to preview. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_advertiser_coupon_preview(advertiser_id, id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_coupon_preview: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_advertiser_coupon_preview(advertiser_id, id, width=width, height=height) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_coupon_preview: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **id** | **str**| The Coupon identifier to preview. | + **width** | **int**| The width of the coupon to preview. | [optional] + **height** | **int**| The height of the coupon to preview. | [optional] + +### Return type + +**str** + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/html, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The preview HTML of a specific Coupon is returned. | - | +**400** | The request contained invalid parameters. | - | +**403** | The request was not properly authorized. | - | + +[[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_advertiser_coupon_supported_sizes** +> CouponSupportedSizesResponse get_advertiser_coupon_supported_sizes(advertiser_id) + + + +Get the list of Coupon supported sizes + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.coupon_supported_sizes_response import CouponSupportedSizesResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + ad_set_id = "ad-set-id_example" # str | The ad set id on which you want to check the Coupon supported sizes. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_advertiser_coupon_supported_sizes(advertiser_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_coupon_supported_sizes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_advertiser_coupon_supported_sizes(advertiser_id, ad_set_id=ad_set_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_coupon_supported_sizes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **ad_set_id** | **str**| The ad set id on which you want to check the Coupon supported sizes. | [optional] + +### Return type + +[**CouponSupportedSizesResponse**](CouponSupportedSizesResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The list of Coupon supported sizes is returned. | - | +**400** | The request contained invalid parameters. | - | +**403** | The request was not properly authorized. | - | + +[[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_advertiser_coupons** +> CouponListResponse get_advertiser_coupons(advertiser_id) + + + +Get the list of self-services Coupons for a given advertiser + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.coupon_list_response import CouponListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + limit = 1 # int | The number of coupons to be returned. The default is 50. (optional) + offset = 1 # int | The (zero-based) offset into the collection of coupons. The default is 0. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_advertiser_coupons(advertiser_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_coupons: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_advertiser_coupons(advertiser_id, limit=limit, offset=offset) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_coupons: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **limit** | **int**| The number of coupons to be returned. The default is 50. | [optional] + **offset** | **int**| The (zero-based) offset into the collection of coupons. The default is 0. | [optional] + +### Return type + +[**CouponListResponse**](CouponListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The list of self-services Coupons is returned. | - | +**400** | The request contained invalid parameters. | - | +**403** | The request was not properly authorized. | - | + +[[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_advertiser_creatives** +> CreativeListResponse get_advertiser_creatives(advertiser_id) + + + +Get the list of self-services Creatives for a given advertiser + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.creative_list_response import CreativeListResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + advertiser_id = "advertiser-id_example" # str | The advertiser identifier. + limit = 1 # int | The number of creatives to be returned. The default is 50. (optional) + offset = 1 # int | The (zero-based) offset into the collection of creatives. The default is 0. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_advertiser_creatives(advertiser_id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_creatives: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_advertiser_creatives(advertiser_id, limit=limit, offset=offset) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_advertiser_creatives: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **advertiser_id** | **str**| The advertiser identifier. | + **limit** | **int**| The number of creatives to be returned. The default is 50. | [optional] + **offset** | **int**| The (zero-based) offset into the collection of creatives. The default is 0. | [optional] + +### Return type + +[**CreativeListResponse**](CreativeListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The list of self-services Creatives is returned. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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_creative** +> CreativeResponse get_creative(id) + + + +Get a Creative from its id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import creative_api +from criteo_api_marketingsolutions_v2024_04.model.creative_response import CreativeResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = creative_api.CreativeApi(api_client) + id = "id_example" # str | The creative identifier to retrieve. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_creative(id) + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling CreativeApi->get_creative: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The creative identifier to retrieve. | + +### Return type + +[**CreativeResponse**](CreativeResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The found creative is returned. | - | +**400** | The request contained invalid parameters. | - | +**401** | The request was not properly authorized. | - | +**500** | A non-request based error occurred on the server. | - | + +[[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/marketingsolutions_2024-04/docs/CreativeListResponse.md b/sdks/marketingsolutions_2024-04/docs/CreativeListResponse.md new file mode 100644 index 00000000..0a139287 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreativeListResponse.md @@ -0,0 +1,15 @@ +# CreativeListResponse + +Data model for a list of response resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[CreativeResource], none_type**](CreativeResource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/CreativeResource.md b/sdks/marketingsolutions_2024-04/docs/CreativeResource.md new file mode 100644 index 00000000..e624bce0 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreativeResource.md @@ -0,0 +1,15 @@ +# CreativeResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**Creative**](Creative.md) | | [optional] +**id** | **str, none_type** | | [optional] +**type** | **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/marketingsolutions_2024-04/docs/CreativeResponse.md b/sdks/marketingsolutions_2024-04/docs/CreativeResponse.md new file mode 100644 index 00000000..ba07bb3a --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreativeResponse.md @@ -0,0 +1,15 @@ +# CreativeResponse + +Data model for response resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**CreativeResource**](CreativeResource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/CreativeWrite.md b/sdks/marketingsolutions_2024-04/docs/CreativeWrite.md new file mode 100644 index 00000000..63531757 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreativeWrite.md @@ -0,0 +1,20 @@ +# CreativeWrite + +Entity to create or update a creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the creative | +**format** | **str** | The format of the creative You can use \"Image\", \" HtmlTag\", \"Dynamic\" or \"Adaptive\" | +**dataset_id** | **str** | Dataset linked to the Creative | +**description** | **str, none_type** | The description of the creative | [optional] +**image_write_attributes** | [**ImageWriteAttributes**](ImageWriteAttributes.md) | | [optional] +**html_tag_write_attributes** | [**HtmlTagWriteAttributes**](HtmlTagWriteAttributes.md) | | [optional] +**dynamic_write_attributes** | [**DynamicWriteAttributes**](DynamicWriteAttributes.md) | | [optional] +**adaptive_write_attributes** | [**AdaptiveWriteAttributes**](AdaptiveWriteAttributes.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/marketingsolutions_2024-04/docs/CreativeWriteRequest.md b/sdks/marketingsolutions_2024-04/docs/CreativeWriteRequest.md new file mode 100644 index 00000000..953806a2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreativeWriteRequest.md @@ -0,0 +1,13 @@ +# CreativeWriteRequest + +Data model for input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**CreativeWriteResource**](CreativeWriteResource.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/marketingsolutions_2024-04/docs/CreativeWriteResource.md b/sdks/marketingsolutions_2024-04/docs/CreativeWriteResource.md new file mode 100644 index 00000000..5b3ac01b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/CreativeWriteResource.md @@ -0,0 +1,15 @@ +# CreativeWriteResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**CreativeWrite**](CreativeWrite.md) | | [optional] +**id** | **str, none_type** | | [optional] +**type** | **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/marketingsolutions_2023-01/docs/CriteoApiError.md b/sdks/marketingsolutions_2024-04/docs/CriteoApiError.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/CriteoApiError.md rename to sdks/marketingsolutions_2024-04/docs/CriteoApiError.md diff --git a/sdks/marketingsolutions_2023-01/docs/CriteoApiWarning.md b/sdks/marketingsolutions_2024-04/docs/CriteoApiWarning.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/CriteoApiWarning.md rename to sdks/marketingsolutions_2024-04/docs/CriteoApiWarning.md diff --git a/sdks/marketingsolutions_2023-01/docs/DeleteAudienceContactListResponse.md b/sdks/marketingsolutions_2024-04/docs/DeleteAudienceContactListResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/DeleteAudienceContactListResponse.md rename to sdks/marketingsolutions_2024-04/docs/DeleteAudienceContactListResponse.md diff --git a/sdks/marketingsolutions_2024-04/docs/DynamicAttributes.md b/sdks/marketingsolutions_2024-04/docs/DynamicAttributes.md new file mode 100644 index 00000000..c6181983 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/DynamicAttributes.md @@ -0,0 +1,19 @@ +# DynamicAttributes + +The attributes specific to Dynamic creatives + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**logos** | [**[ImageShape], none_type**](ImageShape.md) | Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net | [optional] +**creative_background_color** | **str, none_type** | Color of the creative's background Valid hexadecimal color (e.g. \"AB00FF\") | [optional] +**body_text_color** | **str, none_type** | Color of the creative's body text Valid hexadecimal color (e.g. \"AB00FF\") | [optional] +**prices_color** | **str, none_type** | Color of the creative's prices Valid hexadecimal color (e.g. \"AB00FF\") | [optional] +**primary_font** | **str, none_type** | Font of the primary font Valid supported font like \"Arial\" | [optional] +**calls_to_action** | **[str], none_type** | A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. | [optional] +**product_image_display** | **str, none_type** | Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your product catalog images should fit inside the allocated space (\"ShowFullImage\") or whether they should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping. | [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_2024-04/docs/DynamicWriteAttributes.md b/sdks/marketingsolutions_2024-04/docs/DynamicWriteAttributes.md new file mode 100644 index 00000000..662ee44c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/DynamicWriteAttributes.md @@ -0,0 +1,19 @@ +# DynamicWriteAttributes + +The attributes specific to create or update a Dynamic creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**logo_base64_string** | **str** | Logo image as a base-64 encoded string | +**body_text_color** | **str** | Color of the creative's body text Valid hexadecimal RGB color (e.g. \"AB00FF\") | +**prices_color** | **str** | Color of the creative's prices Valid hexadecimal RGB color (e.g. \"AB00FF\") | +**calls_to_action** | **[str]** | A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”. | +**product_image_display** | **str** | Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your product catalog images should fit inside the allocated space (\"ShowFullImage\") or whether they should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping. | +**creative_background_color** | **str, none_type** | Color of the creative's background Valid hexadecimal RGB color (e.g. \"AB00FF\") | [optional] +**primary_font** | **str, none_type** | Font of the primary font Valid supported font like \"Arial\" | [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_2023-01/docs/EntityOfPortfolioMessage.md b/sdks/marketingsolutions_2024-04/docs/EntityOfPortfolioMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/EntityOfPortfolioMessage.md rename to sdks/marketingsolutions_2024-04/docs/EntityOfPortfolioMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/ErrorCodeResponse.md b/sdks/marketingsolutions_2024-04/docs/ErrorCodeResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ErrorCodeResponse.md rename to sdks/marketingsolutions_2024-04/docs/ErrorCodeResponse.md diff --git a/sdks/marketingsolutions_2024-04/docs/GatewayApi.md b/sdks/marketingsolutions_2024-04/docs/GatewayApi.md new file mode 100644 index 00000000..0a765374 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/GatewayApi.md @@ -0,0 +1,90 @@ +# criteo_api_marketingsolutions_v2024_04.GatewayApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_current_application**](GatewayApi.md#get_current_application) | **GET** /2024-04/marketing-solutions/me | + + +# **get_current_application** +> ApplicationSummaryModelResponse get_current_application() + + + +Get information about the currently logged application + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_marketingsolutions_v2024_04 +from criteo_api_marketingsolutions_v2024_04.api import gateway_api +from criteo_api_marketingsolutions_v2024_04.model.application_summary_model_response import ApplicationSummaryModelResponse +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_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_marketingsolutions_v2024_04.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_marketingsolutions_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = gateway_api.GatewayApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_current_application() + pprint(api_response) + except criteo_api_marketingsolutions_v2024_04.ApiException as e: + print("Exception when calling GatewayApi->get_current_application: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ApplicationSummaryModelResponse**](ApplicationSummaryModelResponse.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** | Success | - | +**404** | Not 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) + diff --git a/sdks/marketingsolutions_2023-01/docs/GetPortfolioResponse.md b/sdks/marketingsolutions_2024-04/docs/GetPortfolioResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/GetPortfolioResponse.md rename to sdks/marketingsolutions_2024-04/docs/GetPortfolioResponse.md diff --git a/sdks/marketingsolutions_2024-04/docs/HtmlTagAttributes.md b/sdks/marketingsolutions_2024-04/docs/HtmlTagAttributes.md new file mode 100644 index 00000000..f1c7844f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/HtmlTagAttributes.md @@ -0,0 +1,13 @@ +# HtmlTagAttributes + +The attributes specific to HtmlTag creatives + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tags** | [**[Tag], none_type**](Tag.md) | An array containing the html tags | [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_2024-04/docs/HtmlTagWriteAttributes.md b/sdks/marketingsolutions_2024-04/docs/HtmlTagWriteAttributes.md new file mode 100644 index 00000000..10662ff4 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/HtmlTagWriteAttributes.md @@ -0,0 +1,13 @@ +# HtmlTagWriteAttributes + +The attributes specific to create or update a HtmlTag creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tags** | [**[Tag]**](Tag.md) | An array containing the html tags | +**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_2024-04/docs/ImageAttributes.md b/sdks/marketingsolutions_2024-04/docs/ImageAttributes.md new file mode 100644 index 00000000..9789cdf2 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ImageAttributes.md @@ -0,0 +1,14 @@ +# ImageAttributes + +The attributes specific to Image creatives + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**urls** | **[str], none_type** | Array of images uploaded on demostatic.criteo.com when deploying and then static.criteo.net | [optional] +**landing_page_url** | **str, none_type** | Web redirection of the landing page url | [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_2024-04/docs/ImageSet.md b/sdks/marketingsolutions_2024-04/docs/ImageSet.md new file mode 100644 index 00000000..6b74f74e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ImageSet.md @@ -0,0 +1,14 @@ +# ImageSet + +Entity consists of multiple images in different ratios and a headline text. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**images** | [**[ImageShape]**](ImageShape.md) | The images' urls with their shapes. | +**headline_text** | **str, none_type** | The headline of the image set | [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_2024-04/docs/ImageSetBase64.md b/sdks/marketingsolutions_2024-04/docs/ImageSetBase64.md new file mode 100644 index 00000000..f9e887d8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ImageSetBase64.md @@ -0,0 +1,14 @@ +# ImageSetBase64 + +Entity consists of multiple images in different ratios as a base-64 encoded and a headline text. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**image_base64_strings** | **[str]** | Multiple images potentially in different shapes, each image is a base-64 encoded string. | +**headline_text** | **str, none_type** | The headline of the image set | [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_2024-04/docs/ImageShape.md b/sdks/marketingsolutions_2024-04/docs/ImageShape.md new file mode 100644 index 00000000..364b34e4 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ImageShape.md @@ -0,0 +1,14 @@ +# ImageShape + +Entity containing the shape and url of the image + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shape** | **str** | Ratio of the image | +**url** | **str** | URL of the image uploaded on demostatic.criteo.com when deploying and then static.criteo.net | +**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_2024-04/docs/ImageSlide.md b/sdks/marketingsolutions_2024-04/docs/ImageSlide.md new file mode 100644 index 00000000..30e53186 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ImageSlide.md @@ -0,0 +1,15 @@ +# ImageSlide + +Slide containing the image URLs + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**width** | **int, none_type** | Width of the Coupon slide | [optional] +**height** | **int, none_type** | Height of the Coupon slide | [optional] +**slide_urls** | **[str], none_type** | Array of images of the same size uploaded on demostatic.criteo.com when deploying and then static.criteo.net | [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_2024-04/docs/ImageWriteAttributes.md b/sdks/marketingsolutions_2024-04/docs/ImageWriteAttributes.md new file mode 100644 index 00000000..9d73bfe1 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ImageWriteAttributes.md @@ -0,0 +1,14 @@ +# ImageWriteAttributes + +The attributes specific to create or update an Image creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**base64_strings** | **[str]** | Array of images as a base-64 encoded string | +**landing_page_url** | **str** | Web redirection of the landing page url | +**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_2024-04/docs/InMarketAudienceSegmentBrandEntityV1.md b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentBrandEntityV1.md new file mode 100644 index 00000000..12cc002b --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentBrandEntityV1.md @@ -0,0 +1,14 @@ +# InMarketAudienceSegmentBrandEntityV1 + +In-market segment brand entity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of the in-market segment brand | [optional] +**size** | **int, none_type** | Size of the in-market segment brand | [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_2024-04/docs/InMarketAudienceSegmentBrandEntityV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentBrandEntityV1ListResponse.md new file mode 100644 index 00000000..b11192ad --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentBrandEntityV1ListResponse.md @@ -0,0 +1,15 @@ +# InMarketAudienceSegmentBrandEntityV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[InMarketAudienceSegmentBrandEntityV1Resource], none_type**](InMarketAudienceSegmentBrandEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/InMarketAudienceSegmentBrandEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentBrandEntityV1Resource.md new file mode 100644 index 00000000..0df820cd --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentBrandEntityV1Resource.md @@ -0,0 +1,15 @@ +# InMarketAudienceSegmentBrandEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**InMarketAudienceSegmentBrandEntityV1**](InMarketAudienceSegmentBrandEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/InMarketAudienceSegmentInterestEntityV1.md b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentInterestEntityV1.md new file mode 100644 index 00000000..b9bfac80 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentInterestEntityV1.md @@ -0,0 +1,13 @@ +# InMarketAudienceSegmentInterestEntityV1 + +In-market segment interest entity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parent_id** | **str, none_type** | Id of the parent in-market segment interest | [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_2024-04/docs/InMarketAudienceSegmentInterestEntityV1ListResponse.md b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentInterestEntityV1ListResponse.md new file mode 100644 index 00000000..7703756f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentInterestEntityV1ListResponse.md @@ -0,0 +1,15 @@ +# InMarketAudienceSegmentInterestEntityV1ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[InMarketAudienceSegmentInterestEntityV1Resource], none_type**](InMarketAudienceSegmentInterestEntityV1Resource.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/InMarketAudienceSegmentInterestEntityV1Resource.md b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentInterestEntityV1Resource.md new file mode 100644 index 00000000..6d3d8d0c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketAudienceSegmentInterestEntityV1Resource.md @@ -0,0 +1,15 @@ +# InMarketAudienceSegmentInterestEntityV1Resource + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**InMarketAudienceSegmentInterestEntityV1**](InMarketAudienceSegmentInterestEntityV1.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **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/marketingsolutions_2024-04/docs/InMarketCreateV1.md b/sdks/marketingsolutions_2024-04/docs/InMarketCreateV1.md new file mode 100644 index 00000000..a0fedaec --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketCreateV1.md @@ -0,0 +1,18 @@ +# InMarketCreateV1 + +Settings to target users based on high shopping intents and demographics. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country** | **str** | Reach people of a specific country | +**buying_power** | **[str], none_type** | Reach people who frequently purchase high price range items to lower price range items | [optional] +**gender** | **str, none_type** | Reach people who’ve shown interest in products made for a specific gender | [optional] +**interest_ids** | **[str], none_type** | Reach new people based on their interests | [optional] +**brand_ids** | **[str], none_type** | Choose the brands your segment might be interested in | [optional] +**price_range** | **[str], none_type** | Reach people who’ve shown interest in products within a specific price range | [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_2024-04/docs/InMarketSizeEstimationV1.md b/sdks/marketingsolutions_2024-04/docs/InMarketSizeEstimationV1.md new file mode 100644 index 00000000..a71b3dc3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketSizeEstimationV1.md @@ -0,0 +1,18 @@ +# InMarketSizeEstimationV1 + +Settings to target users based on high shopping intents and demographics. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country** | **str** | | +**buying_power** | **[str], none_type** | | [optional] +**gender** | **str, none_type** | | [optional] +**interest_ids** | **[str], none_type** | | [optional] +**brand_ids** | **[str], none_type** | | [optional] +**price_range** | **[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/marketingsolutions_2024-04/docs/InMarketUpdateV1.md b/sdks/marketingsolutions_2024-04/docs/InMarketUpdateV1.md new file mode 100644 index 00000000..2cc3ccd8 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketUpdateV1.md @@ -0,0 +1,18 @@ +# InMarketUpdateV1 + +Settings to target users based on high shopping intents and demographics. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country** | **str, none_type** | Reach people of a specific country | [optional] +**buying_power** | **[str], none_type** | Reach people who frequently purchase high price range items to lower price range items | [optional] +**gender** | [**NillableGenderV1**](NillableGenderV1.md) | | [optional] +**interest_ids** | **[str], none_type** | Reach new people based on their interests | [optional] +**brand_ids** | **[str], none_type** | Choose the brands your segment might be interested in | [optional] +**price_range** | **[str], none_type** | Reach people who’ve shown interest in products within a specific price range | [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_2024-04/docs/InMarketV1.md b/sdks/marketingsolutions_2024-04/docs/InMarketV1.md new file mode 100644 index 00000000..b4c03bc1 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/InMarketV1.md @@ -0,0 +1,18 @@ +# InMarketV1 + +Settings to target users based on high shopping intents and demographics. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country** | **str, none_type** | Reach people of a specific country | [optional] +**buying_power** | **[str], none_type** | Reach people who frequently purchase high price range items to lower price range items | [optional] +**gender** | **str, none_type** | Reach people who’ve shown interest in products made for a specific gender | [optional] +**interest_ids** | **[str], none_type** | Reach new people based on their interests | [optional] +**brand_ids** | **[str], none_type** | Choose the brands your segment might be interested in | [optional] +**price_range** | **[str], none_type** | Reach people who’ve shown interest in products within a specific price range | [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_2024-04/docs/LocationCreateV1.md b/sdks/marketingsolutions_2024-04/docs/LocationCreateV1.md new file mode 100644 index 00000000..eb6d9ac9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/LocationCreateV1.md @@ -0,0 +1,14 @@ +# LocationCreateV1 + +Settings to target users based on their location. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**points_of_interest** | [**[PointOfInterestV1]**](PointOfInterestV1.md) | Reach users which have been historically located in the given coordinates | +**radius_in_km** | **int** | The expected maximum distance in kilometers between a user and a point of interest | +**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_2024-04/docs/LocationSizeEstimationV1.md b/sdks/marketingsolutions_2024-04/docs/LocationSizeEstimationV1.md new file mode 100644 index 00000000..c9fe8594 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/LocationSizeEstimationV1.md @@ -0,0 +1,14 @@ +# LocationSizeEstimationV1 + +Settings to define your audience based on their location. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**points_of_interest** | [**[PointOfInterestV1]**](PointOfInterestV1.md) | | +**radius_in_km** | **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/marketingsolutions_2024-04/docs/LocationUpdateV1.md b/sdks/marketingsolutions_2024-04/docs/LocationUpdateV1.md new file mode 100644 index 00000000..e305609f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/LocationUpdateV1.md @@ -0,0 +1,15 @@ +# LocationUpdateV1 + +Settings to target users based on their location. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**points_of_interest** | [**[PointOfInterestV1], none_type**](PointOfInterestV1.md) | Reach users which have been historically located in the given coordinates | [optional] +**radius_in_km** | **int, none_type** | Radius in kilometers | [optional] +**registry_type** | **str, none_type** | The kind of Location audience | [optional] if omitted the server will use the default value of "PointOfInterest" +**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_2024-04/docs/LocationV1.md b/sdks/marketingsolutions_2024-04/docs/LocationV1.md new file mode 100644 index 00000000..f39a70b3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/LocationV1.md @@ -0,0 +1,15 @@ +# LocationV1 + +Settings to target users based on their location. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**points_of_interest** | [**[PointOfInterestV1], none_type**](PointOfInterestV1.md) | Reach users which have been historically located in the given coordinates | [optional] +**radius_in_km** | **int, none_type** | The expected maximum distance in kilometers between a user and a point of interest | [optional] +**registry_type** | **str, none_type** | The kind of Location audience | [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_2024-04/docs/LookalikeCreateV1.md b/sdks/marketingsolutions_2024-04/docs/LookalikeCreateV1.md new file mode 100644 index 00000000..14bafe1c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/LookalikeCreateV1.md @@ -0,0 +1,14 @@ +# LookalikeCreateV1 + +Settings to target users close to a given seed segment. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**seed_segment_id** | **str** | Segment from which the Lookalike segment will be generated | +**target_size** | **int, none_type** | Desired size of the generated Lookalike segment | [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_2024-04/docs/LookalikeUpdateV1.md b/sdks/marketingsolutions_2024-04/docs/LookalikeUpdateV1.md new file mode 100644 index 00000000..a7fa6d61 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/LookalikeUpdateV1.md @@ -0,0 +1,13 @@ +# LookalikeUpdateV1 + +Settings to target users that behave like a given seed segment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target_size** | **int, none_type** | Desired size of the generated Lookalike segment | [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_2024-04/docs/LookalikeV1.md b/sdks/marketingsolutions_2024-04/docs/LookalikeV1.md new file mode 100644 index 00000000..0f93adba --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/LookalikeV1.md @@ -0,0 +1,14 @@ +# LookalikeV1 + +Settings to target users that behave like a given seed segment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**seed_segment_id** | **str, none_type** | Segment from which the Lookalike segment will be generated | [optional] +**target_size** | **int, none_type** | Desired size of the generated Lookalike segment | [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_2023-01/docs/ModifyAudienceResponse.md b/sdks/marketingsolutions_2024-04/docs/ModifyAudienceResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ModifyAudienceResponse.md rename to sdks/marketingsolutions_2024-04/docs/ModifyAudienceResponse.md diff --git a/sdks/marketingsolutions_2023-01/docs/NillableAdSetTargetingRule.md b/sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRule.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/NillableAdSetTargetingRule.md rename to sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRule.md diff --git a/sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRuleV23Q1.md b/sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRuleV23Q1.md new file mode 100644 index 00000000..0c81b19e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRuleV23Q1.md @@ -0,0 +1,13 @@ +# NillableAdSetTargetingRuleV23Q1 + +structure that encapsulates an object that have valid business null values. If the structure is provided (i.e. not null), then the value in it, even null, is provided. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**NillableAdSetTargetingRuleV23Q1Value**](NillableAdSetTargetingRuleV23Q1Value.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/marketingsolutions_2024-04/docs/NillableAdSetTargetingRuleV23Q1Value.md b/sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRuleV23Q1Value.md new file mode 100644 index 00000000..da134d32 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRuleV23Q1Value.md @@ -0,0 +1,13 @@ +# NillableAdSetTargetingRuleV23Q1Value + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operand** | **str, none_type** | | [optional] +**values** | **[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/marketingsolutions_2023-01/docs/NillableAdSetTargetingRuleValue.md b/sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRuleValue.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/NillableAdSetTargetingRuleValue.md rename to sdks/marketingsolutions_2024-04/docs/NillableAdSetTargetingRuleValue.md diff --git a/sdks/marketingsolutions_2023-01/docs/NillableDateTime.md b/sdks/marketingsolutions_2024-04/docs/NillableDateTime.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/NillableDateTime.md rename to sdks/marketingsolutions_2024-04/docs/NillableDateTime.md diff --git a/sdks/marketingsolutions_2023-01/docs/NillableDecimal.md b/sdks/marketingsolutions_2024-04/docs/NillableDecimal.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/NillableDecimal.md rename to sdks/marketingsolutions_2024-04/docs/NillableDecimal.md diff --git a/sdks/marketingsolutions_2024-04/docs/NillableGenderV1.md b/sdks/marketingsolutions_2024-04/docs/NillableGenderV1.md new file mode 100644 index 00000000..e57256fa --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/NillableGenderV1.md @@ -0,0 +1,13 @@ +# NillableGenderV1 + +Placeholder object for value for which \"null\" is a valid business value + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str, none_type** | The value. If missing or null the value is set to \"null\" | [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_2024-04/docs/NillableInt32.md b/sdks/marketingsolutions_2024-04/docs/NillableInt32.md new file mode 100644 index 00000000..5cde3505 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/NillableInt32.md @@ -0,0 +1,13 @@ +# NillableInt32 + +Placeholder object for value for which \"null\" is a valid business value + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **int, none_type** | The value. If missing or null the value is set to \"null\" | [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_2024-04/docs/NillableString.md b/sdks/marketingsolutions_2024-04/docs/NillableString.md new file mode 100644 index 00000000..d43aca99 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/NillableString.md @@ -0,0 +1,13 @@ +# NillableString + +Placeholder object for string value for which \"null\" is a valid business value + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str, none_type** | The string's value. If missing or null the string's value is set to \"null\" | [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_2023-01/docs/PatchAdSet.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSet.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSet.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSet.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetBidding.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetBidding.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetBidding.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetBidding.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetBudget.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetBudget.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetBudget.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetBudget.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBid.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBid.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBid.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBid.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBidListRequest.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBidListRequest.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBidListRequest.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBidListRequest.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBidResource.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBidResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBidResource.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBidResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBidResultListResponse.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBidResultListResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBidResultListResponse.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBidResultListResponse.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBidResultResource.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBidResultResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetCategoryBidResultResource.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetCategoryBidResultResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplier.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplier.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplier.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplier.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplierListRequest.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplierListRequest.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplierListRequest.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplierListRequest.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplierResource.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplierResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplierResource.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplierResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplierResultListResponse.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplierResultListResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplierResultListResponse.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplierResultListResponse.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplierResultResource.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplierResultResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetDisplayMultiplierResultResource.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetDisplayMultiplierResultResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchAdSetScheduling.md b/sdks/marketingsolutions_2024-04/docs/PatchAdSetScheduling.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchAdSetScheduling.md rename to sdks/marketingsolutions_2024-04/docs/PatchAdSetScheduling.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchCampaign.md b/sdks/marketingsolutions_2024-04/docs/PatchCampaign.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchCampaign.md rename to sdks/marketingsolutions_2024-04/docs/PatchCampaign.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchCampaignListRequest.md b/sdks/marketingsolutions_2024-04/docs/PatchCampaignListRequest.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchCampaignListRequest.md rename to sdks/marketingsolutions_2024-04/docs/PatchCampaignListRequest.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchCampaignSpendLimit.md b/sdks/marketingsolutions_2024-04/docs/PatchCampaignSpendLimit.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchCampaignSpendLimit.md rename to sdks/marketingsolutions_2024-04/docs/PatchCampaignSpendLimit.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchCampaignWriteResource.md b/sdks/marketingsolutions_2024-04/docs/PatchCampaignWriteResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchCampaignWriteResource.md rename to sdks/marketingsolutions_2024-04/docs/PatchCampaignWriteResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchResultCampaignListResponse.md b/sdks/marketingsolutions_2024-04/docs/PatchResultCampaignListResponse.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchResultCampaignListResponse.md rename to sdks/marketingsolutions_2024-04/docs/PatchResultCampaignListResponse.md diff --git a/sdks/marketingsolutions_2023-01/docs/PatchResultCampaignReadResource.md b/sdks/marketingsolutions_2024-04/docs/PatchResultCampaignReadResource.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PatchResultCampaignReadResource.md rename to sdks/marketingsolutions_2024-04/docs/PatchResultCampaignReadResource.md diff --git a/sdks/marketingsolutions_2023-01/docs/PlacementsReportQueryDataMessage.md b/sdks/marketingsolutions_2024-04/docs/PlacementsReportQueryDataMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PlacementsReportQueryDataMessage.md rename to sdks/marketingsolutions_2024-04/docs/PlacementsReportQueryDataMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/PlacementsReportQueryEntityMessage.md b/sdks/marketingsolutions_2024-04/docs/PlacementsReportQueryEntityMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PlacementsReportQueryEntityMessage.md rename to sdks/marketingsolutions_2024-04/docs/PlacementsReportQueryEntityMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/PlacementsReportQueryMessage.md b/sdks/marketingsolutions_2024-04/docs/PlacementsReportQueryMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PlacementsReportQueryMessage.md rename to sdks/marketingsolutions_2024-04/docs/PlacementsReportQueryMessage.md diff --git a/sdks/marketingsolutions_2024-04/docs/PointOfInterestV1.md b/sdks/marketingsolutions_2024-04/docs/PointOfInterestV1.md new file mode 100644 index 00000000..dfaf21ca --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/PointOfInterestV1.md @@ -0,0 +1,15 @@ +# PointOfInterestV1 + +Named coordinate defined by its latitude and longitude. Latitude and Longitude are rounded at 5 decimals. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | Name of the point of interest | [optional] +**latitude** | **float, none_type** | ISO-6709 latitude (rounded at 5 decimals) | [optional] +**longitude** | **float, none_type** | ISO-6709 longitude (rounded at 5 decimals) | [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_2023-01/docs/PortfolioMessage.md b/sdks/marketingsolutions_2024-04/docs/PortfolioMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/PortfolioMessage.md rename to sdks/marketingsolutions_2024-04/docs/PortfolioMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/ProblemDetails.md b/sdks/marketingsolutions_2024-04/docs/ProblemDetails.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ProblemDetails.md rename to sdks/marketingsolutions_2024-04/docs/ProblemDetails.md diff --git a/sdks/marketingsolutions_2023-01/docs/ProblemsDetails.md b/sdks/marketingsolutions_2024-04/docs/ProblemsDetails.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ProblemsDetails.md rename to sdks/marketingsolutions_2024-04/docs/ProblemsDetails.md diff --git a/sdks/marketingsolutions_2024-04/docs/ProspectingCreateV1.md b/sdks/marketingsolutions_2024-04/docs/ProspectingCreateV1.md new file mode 100644 index 00000000..1e799cd7 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ProspectingCreateV1.md @@ -0,0 +1,15 @@ +# ProspectingCreateV1 + +Settings to target prospecting users to website visitors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**users_type** | **str** | Type of users to target | +**days_since_last_visit_min** | **int, none_type** | When non buyers are included, include users who visited your website before this number of days | [optional] +**days_since_last_visit_max** | **int, none_type** | When non buyers are included, include users who visited your website after this number of days | [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_2024-04/docs/ProspectingUpdateV1.md b/sdks/marketingsolutions_2024-04/docs/ProspectingUpdateV1.md new file mode 100644 index 00000000..d9919276 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ProspectingUpdateV1.md @@ -0,0 +1,15 @@ +# ProspectingUpdateV1 + +Settings to target prospecting users to website visitors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**days_since_last_visit_min** | [**NillableInt32**](NillableInt32.md) | | [optional] +**days_since_last_visit_max** | [**NillableInt32**](NillableInt32.md) | | [optional] +**users_type** | **str, none_type** | Type of users to target | [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_2024-04/docs/ProspectingV1.md b/sdks/marketingsolutions_2024-04/docs/ProspectingV1.md new file mode 100644 index 00000000..157c249f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ProspectingV1.md @@ -0,0 +1,15 @@ +# ProspectingV1 + +Settings to target prospecting users to website visitors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**days_since_last_visit_min** | **int, none_type** | When non buyers are included, include users who visited your website before this number of days | [optional] +**days_since_last_visit_max** | **int, none_type** | When non buyers are included, include users who visited your website after this number of days | [optional] +**users_type** | **str, none_type** | Type of users to target | [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_2023-01/docs/ReadAdSet.md b/sdks/marketingsolutions_2024-04/docs/ReadAdSet.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ReadAdSet.md rename to sdks/marketingsolutions_2024-04/docs/ReadAdSet.md diff --git a/sdks/marketingsolutions_2023-01/docs/ReadAdSetBidding.md b/sdks/marketingsolutions_2024-04/docs/ReadAdSetBidding.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ReadAdSetBidding.md rename to sdks/marketingsolutions_2024-04/docs/ReadAdSetBidding.md diff --git a/sdks/marketingsolutions_2024-04/docs/ReadAdSetBiddingV23Q1.md b/sdks/marketingsolutions_2024-04/docs/ReadAdSetBiddingV23Q1.md new file mode 100644 index 00000000..6639aa80 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ReadAdSetBiddingV23Q1.md @@ -0,0 +1,14 @@ +# ReadAdSetBiddingV23Q1 + +ad set bidding read model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bid_amount** | [**NillableDecimal**](NillableDecimal.md) | | [optional] +**cost_controller** | **str, none_type** | How spend is controlled | [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_2023-01/docs/ReadAdSetBudget.md b/sdks/marketingsolutions_2024-04/docs/ReadAdSetBudget.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ReadAdSetBudget.md rename to sdks/marketingsolutions_2024-04/docs/ReadAdSetBudget.md diff --git a/sdks/marketingsolutions_2024-04/docs/ReadAdSetBudgetV23Q1.md b/sdks/marketingsolutions_2024-04/docs/ReadAdSetBudgetV23Q1.md new file mode 100644 index 00000000..def25d06 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ReadAdSetBudgetV23Q1.md @@ -0,0 +1,17 @@ +# ReadAdSetBudgetV23Q1 + +ad set budget read model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**budget_strategy** | **str, none_type** | | [optional] +**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] +**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_2023-01/docs/ReadAdSetSchedule.md b/sdks/marketingsolutions_2024-04/docs/ReadAdSetSchedule.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ReadAdSetSchedule.md rename to sdks/marketingsolutions_2024-04/docs/ReadAdSetSchedule.md diff --git a/sdks/marketingsolutions_2024-04/docs/ReadAdSetScheduleV23Q1.md b/sdks/marketingsolutions_2024-04/docs/ReadAdSetScheduleV23Q1.md new file mode 100644 index 00000000..f238187f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ReadAdSetScheduleV23Q1.md @@ -0,0 +1,16 @@ +# ReadAdSetScheduleV23Q1 + +ad set schedule read model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | [**NillableDateTime**](NillableDateTime.md) | | [optional] +**end_date** | [**NillableDateTime**](NillableDateTime.md) | | [optional] +**activation_status** | **str, none_type** | | [optional] +**delivery_status** | **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/marketingsolutions_2024-04/docs/ReadAdSetV23Q1.md b/sdks/marketingsolutions_2024-04/docs/ReadAdSetV23Q1.md new file mode 100644 index 00000000..152af7c3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ReadAdSetV23Q1.md @@ -0,0 +1,24 @@ +# ReadAdSetV23Q1 + +ad set read model + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | | [optional] +**advertiser_id** | **str, none_type** | | [optional] +**dataset_id** | **str, none_type** | | [optional] +**campaign_id** | **str, none_type** | | [optional] +**destination_environment** | **str, none_type** | | [optional] +**objective** | **str, none_type** | | [optional] +**schedule** | [**ReadAdSetScheduleV23Q1**](ReadAdSetScheduleV23Q1.md) | | [optional] +**bidding** | [**ReadAdSetBiddingV23Q1**](ReadAdSetBiddingV23Q1.md) | | [optional] +**targeting** | [**AdSetTargetingV23Q1**](AdSetTargetingV23Q1.md) | | [optional] +**budget** | [**ReadAdSetBudgetV23Q1**](ReadAdSetBudgetV23Q1.md) | | [optional] +**media_type** | **str, none_type** | | [optional] +**video_channel** | **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/marketingsolutions_2023-01/docs/ReadModelAdSetId.md b/sdks/marketingsolutions_2024-04/docs/ReadModelAdSetId.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ReadModelAdSetId.md rename to sdks/marketingsolutions_2024-04/docs/ReadModelAdSetId.md diff --git a/sdks/marketingsolutions_2023-01/docs/ReadModelReadAdSet.md b/sdks/marketingsolutions_2024-04/docs/ReadModelReadAdSet.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ReadModelReadAdSet.md rename to sdks/marketingsolutions_2024-04/docs/ReadModelReadAdSet.md diff --git a/sdks/marketingsolutions_2024-04/docs/ReadModelReadAdSetV23Q1.md b/sdks/marketingsolutions_2024-04/docs/ReadModelReadAdSetV23Q1.md new file mode 100644 index 00000000..563b1462 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ReadModelReadAdSetV23Q1.md @@ -0,0 +1,15 @@ +# ReadModelReadAdSetV23Q1 + +read model data for resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | Id of the entity | [optional] [readonly] +**type** | **str, none_type** | | [optional] [readonly] +**attributes** | [**ReadAdSetV23Q1**](ReadAdSetV23Q1.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/marketingsolutions_2023-01/docs/RequestsAdSetId.md b/sdks/marketingsolutions_2024-04/docs/RequestsAdSetId.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/RequestsAdSetId.md rename to sdks/marketingsolutions_2024-04/docs/RequestsAdSetId.md diff --git a/sdks/marketingsolutions_2023-01/docs/RequestsPatchAdSet.md b/sdks/marketingsolutions_2024-04/docs/RequestsPatchAdSet.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/RequestsPatchAdSet.md rename to sdks/marketingsolutions_2024-04/docs/RequestsPatchAdSet.md diff --git a/sdks/marketingsolutions_2023-01/docs/ResponseReadAdSet.md b/sdks/marketingsolutions_2024-04/docs/ResponseReadAdSet.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ResponseReadAdSet.md rename to sdks/marketingsolutions_2024-04/docs/ResponseReadAdSet.md diff --git a/sdks/marketingsolutions_2024-04/docs/ResponseReadAdSetV23Q1.md b/sdks/marketingsolutions_2024-04/docs/ResponseReadAdSetV23Q1.md new file mode 100644 index 00000000..b86ca4cc --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ResponseReadAdSetV23Q1.md @@ -0,0 +1,15 @@ +# ResponseReadAdSetV23Q1 + +output resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ReadModelReadAdSetV23Q1**](ReadModelReadAdSetV23Q1.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2023-01/docs/ResponsesAdSetId.md b/sdks/marketingsolutions_2024-04/docs/ResponsesAdSetId.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/ResponsesAdSetId.md rename to sdks/marketingsolutions_2024-04/docs/ResponsesAdSetId.md diff --git a/sdks/marketingsolutions_2024-04/docs/ResponsesReadAdSetV23Q1.md b/sdks/marketingsolutions_2024-04/docs/ResponsesReadAdSetV23Q1.md new file mode 100644 index 00000000..abd41d3c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/ResponsesReadAdSetV23Q1.md @@ -0,0 +1,15 @@ +# ResponsesReadAdSetV23Q1 + +List of output resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[ReadModelReadAdSetV23Q1], none_type**](ReadModelReadAdSetV23Q1.md) | | [optional] [readonly] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/marketingsolutions_2024-04/docs/RetargetingCreateV1.md b/sdks/marketingsolutions_2024-04/docs/RetargetingCreateV1.md new file mode 100644 index 00000000..ea88876c --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/RetargetingCreateV1.md @@ -0,0 +1,15 @@ +# RetargetingCreateV1 + +Settings to target users based on its type and days since last visit. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visitors_type** | **str** | Types of visitors. | +**days_since_last_visit_min** | **int** | Minimum number of days since last visit to partner. | +**days_since_last_visit_max** | **int** | Maximum number of days since last visit to partner. | +**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_2024-04/docs/RetargetingUpdateV1.md b/sdks/marketingsolutions_2024-04/docs/RetargetingUpdateV1.md new file mode 100644 index 00000000..86ef6056 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/RetargetingUpdateV1.md @@ -0,0 +1,15 @@ +# RetargetingUpdateV1 + +Settings to target users based on its type and days since last visit. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visitors_type** | **str, none_type** | Types of visitors. | [optional] +**days_since_last_visit_min** | **int, none_type** | Minimum number of days since last visit to partner. | [optional] +**days_since_last_visit_max** | **int, none_type** | Maximum number of days since last visit to partner. | [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_2024-04/docs/RetargetingV1.md b/sdks/marketingsolutions_2024-04/docs/RetargetingV1.md new file mode 100644 index 00000000..b8dae8aa --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/RetargetingV1.md @@ -0,0 +1,15 @@ +# RetargetingV1 + +Settings to target users based on its type and days since last visit. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visitors_type** | **str, none_type** | Types of visitors. | [optional] +**days_since_last_visit_min** | **int, none_type** | Minimum number of days since last visit to partner. | [optional] +**days_since_last_visit_max** | **int, none_type** | Maximum number of days since last visit to partner. | [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_2024-04/docs/Size.md b/sdks/marketingsolutions_2024-04/docs/Size.md new file mode 100644 index 00000000..1ce2da81 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/Size.md @@ -0,0 +1,14 @@ +# Size + +Size entity containing width and height of the creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**width** | **int, none_type** | | [optional] +**height** | **int, 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_2023-01/docs/StatisticsReportQueryMessage.md b/sdks/marketingsolutions_2024-04/docs/StatisticsReportQueryMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/StatisticsReportQueryMessage.md rename to sdks/marketingsolutions_2024-04/docs/StatisticsReportQueryMessage.md diff --git a/sdks/marketingsolutions_2024-04/docs/Tag.md b/sdks/marketingsolutions_2024-04/docs/Tag.md new file mode 100644 index 00000000..0b607ce3 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/Tag.md @@ -0,0 +1,14 @@ +# Tag + +Entity specifying the html of the tag and its size + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**html_tag** | **str, none_type** | Html tag | [optional] +**size** | [**Size**](Size.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/marketingsolutions_2023-01/docs/TransactionsReportQueryDataMessage.md b/sdks/marketingsolutions_2024-04/docs/TransactionsReportQueryDataMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/TransactionsReportQueryDataMessage.md rename to sdks/marketingsolutions_2024-04/docs/TransactionsReportQueryDataMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/TransactionsReportQueryEntityMessage.md b/sdks/marketingsolutions_2024-04/docs/TransactionsReportQueryEntityMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/TransactionsReportQueryEntityMessage.md rename to sdks/marketingsolutions_2024-04/docs/TransactionsReportQueryEntityMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/TransactionsReportQueryMessage.md b/sdks/marketingsolutions_2024-04/docs/TransactionsReportQueryMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/TransactionsReportQueryMessage.md rename to sdks/marketingsolutions_2024-04/docs/TransactionsReportQueryMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/TransparencyQueryMessage.md b/sdks/marketingsolutions_2024-04/docs/TransparencyQueryMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/TransparencyQueryMessage.md rename to sdks/marketingsolutions_2024-04/docs/TransparencyQueryMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/TransparencyReportAttributes.md b/sdks/marketingsolutions_2024-04/docs/TransparencyReportAttributes.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/TransparencyReportAttributes.md rename to sdks/marketingsolutions_2024-04/docs/TransparencyReportAttributes.md diff --git a/sdks/marketingsolutions_2023-01/docs/TransparencyReportDataMessage.md b/sdks/marketingsolutions_2024-04/docs/TransparencyReportDataMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/TransparencyReportDataMessage.md rename to sdks/marketingsolutions_2024-04/docs/TransparencyReportDataMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/TransparencyReportEntityMessage.md b/sdks/marketingsolutions_2024-04/docs/TransparencyReportEntityMessage.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/TransparencyReportEntityMessage.md rename to sdks/marketingsolutions_2024-04/docs/TransparencyReportEntityMessage.md diff --git a/sdks/marketingsolutions_2023-01/docs/TransparencyReportFile.md b/sdks/marketingsolutions_2024-04/docs/TransparencyReportFile.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/TransparencyReportFile.md rename to sdks/marketingsolutions_2024-04/docs/TransparencyReportFile.md diff --git a/sdks/marketingsolutions_2024-04/docs/UpdateCoupon.md b/sdks/marketingsolutions_2024-04/docs/UpdateCoupon.md new file mode 100644 index 00000000..e43b9b73 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/UpdateCoupon.md @@ -0,0 +1,14 @@ +# UpdateCoupon + +Entity to edit a Coupon + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **str** | The date when the Coupon will be launched String must be in ISO8601 format | +**end_date** | **str, none_type** | The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever String must be in ISO8601 format | [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_2024-04/docs/UpdateCouponRequest.md b/sdks/marketingsolutions_2024-04/docs/UpdateCouponRequest.md new file mode 100644 index 00000000..cba2bc6e --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/UpdateCouponRequest.md @@ -0,0 +1,13 @@ +# UpdateCouponRequest + +Data model for input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UpdateCouponResource**](UpdateCouponResource.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/marketingsolutions_2024-04/docs/UpdateCouponResource.md b/sdks/marketingsolutions_2024-04/docs/UpdateCouponResource.md new file mode 100644 index 00000000..e9d339b6 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/UpdateCouponResource.md @@ -0,0 +1,15 @@ +# UpdateCouponResource + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**UpdateCoupon**](UpdateCoupon.md) | | [optional] +**id** | **str, none_type** | | [optional] +**type** | **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/marketingsolutions_2024-04/docs/VideoDetail.md b/sdks/marketingsolutions_2024-04/docs/VideoDetail.md new file mode 100644 index 00000000..3ac2d4b0 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/docs/VideoDetail.md @@ -0,0 +1,15 @@ +# VideoDetail + +Entity consists of the url of the video, its duration and its shape. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration** | **float** | The duration of the video in milliseconds, the video could be trimmed if it is longer than 30000 ms. | +**shape** | **str** | Shape of the video | +**url** | **str** | URL of the video uploaded on demostatic.criteo.com when deploying and then static.criteo.net | +**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_2023-01/docs/WriteModelAdSetId.md b/sdks/marketingsolutions_2024-04/docs/WriteModelAdSetId.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/WriteModelAdSetId.md rename to sdks/marketingsolutions_2024-04/docs/WriteModelAdSetId.md diff --git a/sdks/marketingsolutions_2023-01/docs/WriteModelPatchAdSet.md b/sdks/marketingsolutions_2024-04/docs/WriteModelPatchAdSet.md similarity index 100% rename from sdks/marketingsolutions_2023-01/docs/WriteModelPatchAdSet.md rename to sdks/marketingsolutions_2024-04/docs/WriteModelPatchAdSet.md diff --git a/sdks/marketingsolutions_2023-01/requirements.txt b/sdks/marketingsolutions_2024-04/requirements.txt similarity index 100% rename from sdks/marketingsolutions_2023-01/requirements.txt rename to sdks/marketingsolutions_2024-04/requirements.txt diff --git a/sdks/marketingsolutions_2023-01/setup.cfg b/sdks/marketingsolutions_2024-04/setup.cfg similarity index 100% rename from sdks/marketingsolutions_2023-01/setup.cfg rename to sdks/marketingsolutions_2024-04/setup.cfg diff --git a/sdks/marketingsolutions_2024-04/setup.py b/sdks/marketingsolutions_2024-04/setup.py new file mode 100644 index 00000000..4d76e5fb --- /dev/null +++ b/sdks/marketingsolutions_2024-04/setup.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +from setuptools import setup, find_packages # noqa: H301 + +NAME = "criteo-api-marketingsolutions-sdk" +VERSION = "2024.04.0.240515" +# To install the library, run the following +# +# python setup.py install +# +# prerequisite: setuptools +# http://pypi.python.org/pypi/setuptools + +REQUIRES = ["urllib3 >= 1.25.3", "python-dateutil"] + +AUTHOR='Criteo' +README_CONTENT_TYPE='text/markdown' +PACKAGE_LONG_DESCRIPTION = """# Criteo API SDK for Python + +IMPORTANT: This Python package links to Criteo production environment. Any test applied here will thus impact real data. + +## Installation & Usage +### pip install + + +```sh +pip install criteo-api-marketingsolutions-sdk==2024.04.0.240515 +``` +(you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==2024.04.0.240515`) + +Then import the package: +```python +import criteo_api_marketingsolutions_v2024_04 +``` + +Full documentation on [Github](https://github.com/criteo/criteo-api-python-sdk). + +## Disclaimer + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +""" + +setup( + name=NAME, + version=VERSION, + description="Criteo API SDK", + author_email="", + author=AUTHOR, + url="https://github.com/criteo/criteo-api-python-sdk", + keywords=[AUTHOR, "OpenAPI-Generator", "Criteo API SDK"], + install_requires=REQUIRES, + packages=find_packages(), + include_package_data=True, + long_description_content_type=README_CONTENT_TYPE, + long_description=PACKAGE_LONG_DESCRIPTION, + classifiers=[ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Natural Language :: English", + "Operating System :: OS Independent", + "Topic :: Software Development :: Libraries", + ], + python_requires=">=3.6", +) diff --git a/sdks/marketingsolutions_2023-01/test-requirements.txt b/sdks/marketingsolutions_2024-04/test-requirements.txt similarity index 100% rename from sdks/marketingsolutions_2023-01/test-requirements.txt rename to sdks/marketingsolutions_2024-04/test-requirements.txt diff --git a/sdks/marketingsolutions_2024-04/test/example_application_with_auth_code.py b/sdks/marketingsolutions_2024-04/test/example_application_with_auth_code.py new file mode 100644 index 00000000..43332e50 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/test/example_application_with_auth_code.py @@ -0,0 +1,27 @@ +from criteo_api_marketingsolutions_v2024_04.api.gateway_api import GatewayApi +from criteo_api_marketingsolutions_v2024_04 import ApiClientBuilder + +class ExampleApplication: + + def call_then_application_endpoint(self, clientId, clientSecret, authorization_code, redirect_uri): + # Create a client using your choosen OAuth flow, Authorization Code in this case. The client will handle the token generation/renewal for you + client = ApiClientBuilder.WithAuthorizationCode(clientId, clientSecret, authorization_code, redirect_uri) + + # The Gateway API regroups common technical endpoints that exists for all versions + # You can find the other endpoints in the other *Api + # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials + api = GatewayApi(client) + + # Perform the call to the application introspection endpoint + response = api.get_current_application() + + # Most of Criteo's API response follow the same structure: + # The response consists of a Data, Errors and Warnings fields + # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object + myApplication = response.data.attributes + print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') + + # You will need to save the refresh_token to use it in the refresh_token flow + # You can fetch the refresh token like this: + refreshToken = client.get_refresh_token() + print('The refresh token to be saved is ', refreshToken) \ No newline at end of file diff --git a/sdks/marketingsolutions_2024-04/test/example_application_with_client_credentials.py b/sdks/marketingsolutions_2024-04/test/example_application_with_client_credentials.py new file mode 100644 index 00000000..6158a12f --- /dev/null +++ b/sdks/marketingsolutions_2024-04/test/example_application_with_client_credentials.py @@ -0,0 +1,22 @@ +from criteo_api_marketingsolutions_v2024_04.api.gateway_api import GatewayApi +from criteo_api_marketingsolutions_v2024_04 import ApiClientBuilder + +class ExampleApplication: + + def call_then_application_endpoint(self, clientId, clientSecret): + # Create a client using your choosen OAuth flow, Client Credentials in this case. The client will handle the token generation/renewal for you + client = ApiClientBuilder.WithClientCredentials(clientId=clientId, clientSecret=clientSecret) + + # The Gateway API regroups common technical endpoints that exists for all versions + # You can find the other endpoints in the other *Api + # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials + api = GatewayApi(client) + + # Perform the call to the application introspection endpoint + response = api.get_current_application() + + # Most of Criteo's API response follow the same structure: + # The response consists of a Data, Errors and Warnings fields + # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object + myApplication = response.data.attributes + print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') \ No newline at end of file diff --git a/sdks/marketingsolutions_2024-04/test/example_application_with_refresh_token.py b/sdks/marketingsolutions_2024-04/test/example_application_with_refresh_token.py new file mode 100644 index 00000000..ffb67e88 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/test/example_application_with_refresh_token.py @@ -0,0 +1,27 @@ +from criteo_api_marketingsolutions_v2024_04.api.gateway_api import GatewayApi +from criteo_api_marketingsolutions_v2024_04 import ApiClientBuilder + +class ExampleApplication: + + def call_then_application_endpoint(self, clientId, clientSecret, refresh_token): + # Create a client using your choosen OAuth flow, Refresh Token in this case. The client will handle the token generation/renewal for you + client = ApiClientBuilder.WithRefreshToken(clientId, clientSecret, refresh_token) + + # The Gateway API regroups common technical endpoints that exists for all versions + # You can find the other endpoints in the other *Api + # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials + api = GatewayApi(client) + + # Perform the call to the application introspection endpoint + response = api.get_current_application() + + # Most of Criteo's API response follow the same structure: + # The response consists of a Data, Errors and Warnings fields + # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object + myApplication = response.data.attributes + print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') + + # You will need to save the new refresh_token to use it again in the future + # You can fetch the refresh token like this: + refreshToken = client.get_refresh_token() + print('The refresh token to be saved is ', refreshToken) \ No newline at end of file diff --git a/sdks/marketingsolutions_2024-04/test/test_gateway_api.py b/sdks/marketingsolutions_2024-04/test/test_gateway_api.py new file mode 100644 index 00000000..51ff0018 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/test/test_gateway_api.py @@ -0,0 +1,62 @@ +import pytest +import os + +from criteo_api_marketingsolutions_v2024_04.api.gateway_api import GatewayApi +from criteo_api_marketingsolutions_v2024_04.api_client_builder import ApiClientBuilder +from criteo_api_marketingsolutions_v2024_04.rest import ApiException +from example_application_with_client_credentials import ExampleApplication + +class TestGatewayApi: + @pytest.fixture(autouse=True) + def before_each(self): + self.client_id = os.environ.get("TEST_CLIENT_ID") + self.client_secret = os.environ.get("TEST_CLIENT_SECRET") + self.application_id = int(os.environ.get("TEST_APPLICATION_ID")) + + self.client = ApiClientBuilder.WithClientCredentials(clientId=self.client_id, clientSecret=self.client_secret) + + def test_environment_variables(self): + assert len(self.client_id) > 0, "Environment variable \"TEST_CLIENT_ID\" not found." + assert len(self.client_secret) > 0, "Environment variable \"TEST_CLIENT_SECRET\" not found." + assert self.application_id > 0, "Environment variable \"TEST_APPLICATION_ID\" not found." + + def test_example_works(self): + # Arrange + exampleApplication = ExampleApplication() + exampleApplication.call_then_application_endpoint(self.client_id, self.client_secret) + + def test_get_current_application_should_succeed_with_valid_token(self): + # Arrange + api = GatewayApi(self.client) + + # Act + http_response = api.get_current_application() + + # Assert + assert self.application_id == http_response.data.attributes.application_id + + + def test_get_current_application_should_succeed_with_renewed_invalid_token(self): + # Arrange + invalid_token = "invalid.access.token" + self.client.configuration.access_token = invalid_token + api = GatewayApi(self.client) + + # Act + http_response = api.get_current_application() + + # Assert + assert self.application_id == http_response.data.attributes.application_id + + + def test_get_current_application_should_fail_without_token(self): + # Arrange + api = GatewayApi(ApiClientBuilder.WithNoAuthorization()) + + # Act + try: + api.get_current_application() + + # Assert + except ApiException as exception: + assert exception.status == 401 diff --git a/sdks/marketingsolutions_2024-04/tox.ini b/sdks/marketingsolutions_2024-04/tox.ini new file mode 100644 index 00000000..40742fb9 --- /dev/null +++ b/sdks/marketingsolutions_2024-04/tox.ini @@ -0,0 +1,9 @@ +[tox] +envlist = py3 + +[testenv] +deps=-r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +commands= + pytest --cov=criteo_api_marketingsolutions_v2024_04 diff --git a/sdks/marketingsolutions_preview/README.md b/sdks/marketingsolutions_preview/README.md index f0c1b3f2..77ac0681 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.240404 +- Package version: 0.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-marketingsolutions-sdk==0.0.240404 +pip install criteo-api-marketingsolutions-sdk==0.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) 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 067cb293..7502e256 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/__init__.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/__init__.py @@ -3,12 +3,12 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ -__version__ = "0.0.240404" +__version__ = "0.0.240515" # import ApiClient from criteo_api_marketingsolutions_preview.api_client import ApiClient diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/advertiser_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/advertiser_api.py index d4708852..d072ee07 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/advertiser_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/advertiser_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/analytics_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/analytics_api.py index be327fd8..c87f6057 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/analytics_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/analytics_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/audience_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/audience_api.py index 68477545..d4a9fcef 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/audience_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/audience_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/campaign_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/campaign_api.py index 7b87dfc5..2ac2165a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/campaign_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/campaign_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/catalog_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/catalog_api.py index 04c7c7a8..348a1405 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/catalog_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/catalog_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/creative_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/creative_api.py index 8a62e4aa..3d65b6d0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/creative_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/creative_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/gateway_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/gateway_api.py index ae0a181d..193bc280 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/gateway_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/gateway_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/on_site_recommendation_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/on_site_recommendation_api.py index e106dcef..b8d51965 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/on_site_recommendation_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/on_site_recommendation_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/reco_api.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/reco_api.py index d8261e0a..3b49bfcb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/reco_api.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api/reco_api.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ 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 2ccdbe8e..f96d7680 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api_client.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/api_client.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ @@ -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.240404/python' + self.user_agent = 'OpenAPI-Generator/0.0.240515/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 0cda66de..b18faec1 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/configuration.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/configuration.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ @@ -394,8 +394,8 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: preview\n"\ - "SDK Package Version: 0.0.240404".\ + "Version of the API: Preview\n"\ + "SDK Package Version: 0.0.240515".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/exceptions.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/exceptions.py index acd36438..c8399aec 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/exceptions.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/exceptions.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad.py index 5c903956..e8f5ce3b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_list_response.py index 4b8151bb..19adecdf 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_resource.py index 6f4468f7..d0f81411 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_response.py index 2776da74..3be8471f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1.py index 98dec977..d10e6364 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1_resource.py index ea70c43e..4745a1af 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1_response.py index 94497146..661e968c 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_input_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_input_entity_v1.py index a1b347e9..a6458369 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_input_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_audience_link_input_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid.py index b1617acb..918662b6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid_list_response.py index 7fafbf29..66af2518 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid_resource.py index 0062b1ad..a761dbbf 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_category_bid_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_delivery_limitations_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_delivery_limitations_v24_q1.py index 5a8348f0..773a9b07 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_delivery_limitations_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_delivery_limitations_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier.py index 969e4992..f6741979 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier_list_response.py index 5829b0a7..2c160321 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier_resource.py index 24c09882..bcfcca31 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_display_multiplier_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_frequency_capping_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_frequency_capping_v24_q1.py index 86b8dbf5..f9a3e222 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_frequency_capping_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_frequency_capping_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_geo_location_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_geo_location_v24_q1.py index 4bdf5384..86a28892 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_geo_location_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_geo_location_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_search_filter_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_search_filter_v24_q1.py index e240de81..d719106d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_search_filter_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_search_filter_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_search_request_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_search_request_v24_q1.py index c6c7bc34..d9ff9b05 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_search_request_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_search_request_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids.py index 1001b6c3..0bc0971c 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_disable_result_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_disable_result_resource.py index cc49faf2..cedff9f6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_disable_result_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_disable_result_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_disable_result_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_disable_result_response.py index 49ba64bb..f2dafbb1 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_disable_result_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_disable_result_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_resource.py index 7bd08607..31d36076 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_response.py index de031e7f..f0e8f67f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_set_result_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_set_result_resource.py index 962b06ca..e10860c4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_set_result_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_set_result_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_set_result_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_set_result_response.py index 0bbe82e2..0cf13d1d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_set_result_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_deal_ids_set_result_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_rule_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_rule_v24_q1.py index 8451c1a8..06dee5d1 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_rule_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_rule_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_v24_q1.py index f732de40..180e1348 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning.py index ef026c08..04b35ade 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_disable_result_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_disable_result_resource.py index 4929762a..34082915 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_disable_result_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_disable_result_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_disable_result_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_disable_result_response.py index f3edfefd..e094adb5 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_disable_result_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_disable_result_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_resource.py index 8658cf6e..675c2110 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_response.py index 0e5a38af..85d5e3e3 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_set_result_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_set_result_resource.py index 3c085618..e806401b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_set_result_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_set_result_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_set_result_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_set_result_response.py index 23d7f55e..bf1ce66c 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_set_result_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_set_targeting_video_positioning_set_result_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write.py index d1c01572..629a665f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write_request.py index cadb64f7..5d967220 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write_resource.py index 02d1f35a..84f4d02b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/ad_write_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_attributes.py index bd522d00..5ef7b3da 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_colors.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_colors.py index 7f52f5e8..fc3bb9a6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_colors.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_colors.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_write_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_write_attributes.py index f9b7596d..58b4c2be 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_write_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/adaptive_write_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_input.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_input.py index aeffacc6..8da6aea9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_input.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_input.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_request.py index f960387b..4e62d42f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_response.py index 33578026..e598dff8 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_creation_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_dataset_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_dataset_list_response.py index 0601f5c6..7510b81f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_dataset_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/advertiser_dataset_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/algebra_node_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/algebra_node_v1.py index 1ce6caea..707e2227 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/algebra_node_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/algebra_node_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_error_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_error_response.py index ca05e1a3..3124d05a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_error_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_error_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_request_of_targeting_entity.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_request_of_targeting_entity.py index 19a56d94..ef9df6f2 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_request_of_targeting_entity.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_request_of_targeting_entity.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_response_of_targeting_entity.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_response_of_targeting_entity.py index bc8ea7f4..885c9c97 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_response_of_targeting_entity.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/api_response_of_targeting_entity.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model.py index 677b2346..4daaf232 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model_resource.py index 70bbbf71..561e5846 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model_response.py index 23288481..1879fa16 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/application_summary_model_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/attribute.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/attribute.py index 6c37ec21..2fba0415 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/attribute.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/attribute.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_create_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_create_input_v1.py index 18eafa06..cd1f2219 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_create_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_create_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_delete_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_delete_input_v1.py index 916e6aae..3128d53f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_delete_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_delete_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_update_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_update_input_v1.py index 0dbdf7cf..ee003489 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_update_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_bulk_update_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_compute_size_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_compute_size_entity_v1_resource.py index 5489d85f..9c22d0f6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_compute_size_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_compute_size_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_compute_sizes_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_compute_sizes_input_v1.py index a8dcbf7c..3f626769 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_compute_sizes_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_compute_sizes_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_create_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_create_entity_v1.py index 1d9b95fb..ea46c0f7 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_create_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_create_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_create_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_create_entity_v1_resource.py index ebf34cfb..9e1a5fe4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_create_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_create_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_delete_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_delete_entity_v1_resource.py index 8e4ddceb..5fb4d6fb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_delete_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_delete_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1.py index 92dcf818..076ad7dd 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_audience_search_metadata_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_audience_search_metadata_v1_list_response.py index 20e55381..8668e18c 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_audience_search_metadata_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_audience_search_metadata_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_list_response.py index c4eafbd4..4a361c39 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_resource.py index 61398392..62249fc8 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_error.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_error.py index 542e9011..3fe17c0b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_error.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_error.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_entity_v1.py index 0ee9a84b..5a8b2474 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_entity_v1_resource.py index 7e1fe136..f2c5595a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_input_v1.py index 6cbfb0c9..5cf737ec 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_estimate_size_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_id_entity_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_id_entity_v1_list_response.py index 73764743..f14dfd0d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_id_entity_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_id_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_id_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_id_entity_v1_resource.py index d5d599f2..1c5202df 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_id_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_id_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_name_description.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_name_description.py index 370d9927..c10cacef 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_name_description.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_name_description.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_entity_v1.py index a5597408..a5072fe8 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_entity_v1_resource.py index a0651d39..92a3e714 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_input_v1.py index e962d723..4727fead 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_metadata_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_metadata_v1.py index 2ce45eee..ab93dc62 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_metadata_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_search_metadata_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_create_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_create_input_v1.py index 1f6685e4..7b852d0b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_create_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_create_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_delete_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_delete_input_v1.py index 972e5c6d..7ae3ba5d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_delete_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_delete_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_update_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_update_input_v1.py index 1ad46924..afd6379d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_update_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_bulk_update_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_compute_size_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_compute_size_entity_v1_resource.py index d6c0f8ca..5ae49f9f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_compute_size_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_compute_size_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_compute_sizes_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_compute_sizes_input_v1.py index 480e8521..c0e6c863 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_compute_sizes_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_compute_sizes_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_create_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_create_entity_v1.py index 77116727..4b573520 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_create_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_create_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_create_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_create_entity_v1_resource.py index 4acd6489..a354902e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_create_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_create_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_delete_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_delete_entity_v1_resource.py index 01675553..112a0045 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_delete_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_delete_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1.py index 7343c80e..3d02faf5 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response.py index eb920bb5..fe59c41a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_audience_segment_search_metadata_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_list_response.py index 53b3af77..655d67a0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_resource.py index 7c80dc4b..6d458bb8 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_estimate_size_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_estimate_size_input_v1.py index 4427008a..4f12eb77 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_estimate_size_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_estimate_size_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_id_entity_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_id_entity_v1_list_response.py index 438d19ad..f6673926 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_id_entity_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_id_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_id_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_id_entity_v1_resource.py index 853ea36e..311976cf 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_id_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_id_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_entity_v1.py index 1d6d9a63..0429675d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_entity_v1_resource.py index 86de79c0..2dce5473 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_input_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_input_v1.py index 3ff1fe95..f6ec2b74 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_input_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_input_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_metadata_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_metadata_v1.py index 116b0b74..5fd12999 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_metadata_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_search_metadata_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1.py index 10b7758e..fd817228 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1_list_response.py index e7108b6d..47f203ab 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1_resource.py index da6fbcf2..e09b74b5 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_entity_v1.py index db757eba..31b62402 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_entity_v1_resource.py index f7b24a25..6d94806e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1.py index 639a4447..760c0452 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1_resource.py index 322a81f5..e4387239 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1_response.py index baf91aac..e1e56dee 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_size_estimation_v1_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_update_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_update_entity_v1.py index f350a8fd..f8467b52 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_update_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_update_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_update_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_update_entity_v1_resource.py index e588a3da..e8fcbc36 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_update_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_segment_update_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1.py index eecaa7db..3b234276 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1_list_response.py index 59dcf3ea..104c5138 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1_resource.py index 9298afb2..5a22c016 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1.py index f032b86c..ed2a9ce4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1_resource.py index 56e2f2a6..f219adbe 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1_response.py index 5bf8b230..7fbde014 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_size_estimation_v1_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_update_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_update_entity_v1.py index 165ec98b..6e3e28b0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_update_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_update_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_update_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_update_entity_v1_resource.py index 60ea8df6..bbf59bcc 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_update_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_update_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_warning.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_warning.py index 0c10b2bd..1b25d510 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_warning.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/audience_warning.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/basic_audience_definition.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/basic_audience_definition.py index 12b29edb..2f0d257a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/basic_audience_definition.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/basic_audience_definition.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/batch_accepted_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/batch_accepted_response.py index 582fd73e..dd2ecb6a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/batch_accepted_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/batch_accepted_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/behavioral_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/behavioral_v1.py index 5c1473bb..c404581f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/behavioral_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/behavioral_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_search_filters_v23_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_search_filters_v23_q1.py index 189317d6..f724908b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_search_filters_v23_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_search_filters_v23_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_search_request_v23_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_search_request_v23_q1.py index d9f15457..797a6e83 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_search_request_v23_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_search_request_v23_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_spend_limit_v23_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_spend_limit_v23_q1.py index 65e33f5c..f50f40dd 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_spend_limit_v23_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_spend_limit_v23_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1.py index 77fc0eda..783201a7 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_list_response.py index 992a744e..0e9b3595 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_resource.py index 60c66723..f7ac325f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_response.py index fc6279ae..3bf91a64 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/campaign_v23_q1_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/common_problem.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/common_problem.py index c5df8017..89b79996 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/common_problem.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/common_problem.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1.py index 165c5c69..b5266c5a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1_resource.py index 06d4b54a..5a9e75e6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1_response.py index 6dccf996..a65401d9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_statistics_entity_v1_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_v1.py index 130eb0ea..4b42b824 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contact_list_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment.py index 0dc9781a..8d1f3dd4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment_attributes.py index 5ed52723..fa913384 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment_request.py index 89897ad4..e50cb780 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_amendment_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_operation.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_operation.py index bfed9489..a3e012b8 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_operation.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_operation.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_operation_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_operation_attributes.py index cb00bcce..507477fa 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_operation_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_operation_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment.py index 45d1c74c..5ba3ec97 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment_attributes.py index 275d38b8..3b869fb9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment_request.py index 33cae05c..cc55eb9a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/contactlist_with_attributes_amendment_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon.py index 2df86fd2..642e928a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_list_response.py index 47dcb3fa..8b16178e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_resource.py index b88f9ae4..9dee5c89 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_response.py index 5586890b..001cebef 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes.py index ff6420dc..1cbe2acd 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes_resource.py index 3249a84e..dcf569e6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes_response.py index 14eae57c..7fe13822 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/coupon_supported_sizes_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_bidding_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_bidding_v24_q1.py index 33e33a49..c19936de 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_bidding_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_bidding_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_budget_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_budget_v24_q1.py index a66e72df..42f2265d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_budget_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_budget_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_geo_location_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_geo_location_v24_q1.py index d2bab84a..24155005 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_geo_location_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_geo_location_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_schedule_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_schedule_v24_q1.py index 1e639d7a..ce1c4026 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_schedule_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_schedule_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_targeting_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_targeting_v24_q1.py index e3af2770..345dc861 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_targeting_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_targeting_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1.py index 9da1eaed..557496cc 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1_request.py index 4b4a083c..4e1361cb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1_resource.py index 2577b86c..8c726915 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_ad_set_v24_q1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign.py index 90849ffa..1abcbaae 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_request.py index 521ea2d3..92a09214 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_resource.py index 2517f57b..1687d8e6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_spend_limit.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_spend_limit.py index f0f3a726..1432ded9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_spend_limit.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_campaign_spend_limit.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon.py index 7d2c4679..1d5f3f13 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon_request.py index 84c07108..997d969e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon_resource.py index cad4727b..952b5f98 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_coupon_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_image_slide.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_image_slide.py index 487139ae..94af52a4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_image_slide.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_image_slide.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_product_set_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_product_set_request.py index 4bc216b6..5f901684 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_product_set_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/create_product_set_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative.py index 5181252c..1c5c641c 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_list_response.py index a1d16ce3..fda090f6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_resource.py index de1b185e..34c0f2f1 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_response.py index 73485cfd..2c288c65 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write.py index 0a2603bb..5baebb4f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write_request.py index b6346b2f..9dba0b47 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write_resource.py index 8a90166b..9b242a35 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/creative_write_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_error.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_error.py index f925cf4a..7a1c1287 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_error.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_error.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_warning.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_warning.py index e3fd32a0..d8f3ccc9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_warning.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_warning.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_warning_v2.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_warning_v2.py index ee7a25f1..0b222e27 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_warning_v2.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/criteo_api_warning_v2.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/custom_attribute.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/custom_attribute.py index 979ce530..464dd377 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/custom_attribute.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/custom_attribute.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dataset.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dataset.py index a892f770..9e538bf4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dataset.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dataset.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/deal_id.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/deal_id.py index f98f56af..fa8df3de 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/deal_id.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/deal_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_audience_contact_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_audience_contact_list_response.py index 913c419e..e235ccbb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_audience_contact_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_audience_contact_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model.py index 68975c2c..242fb747 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model_list_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model_list_request.py index c1457974..a5259711 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model_list_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model_list_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model_resource.py index f55c6355..282c12ab 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/delete_user_profile_model_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dynamic_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dynamic_attributes.py index 81669bf2..61c2c383 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dynamic_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dynamic_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dynamic_write_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dynamic_write_attributes.py index 30cfd28d..a6228df3 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dynamic_write_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/dynamic_write_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_filter.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_filter.py index c1993937..8a95e597 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_filter.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_filter.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_of_portfolio_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_of_portfolio_message.py index 0247bffa..9e372007 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_of_portfolio_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_of_portfolio_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_v2_of_dataset.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_v2_of_dataset.py index 08512970..ab8a2910 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_v2_of_dataset.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_v2_of_dataset.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_v2_of_object.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_v2_of_object.py index b7bd87f5..f484c552 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_v2_of_object.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_v2_of_object.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_wrapper_of_targeting_entity.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_wrapper_of_targeting_entity.py index ae1cc004..2c06bfca 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_wrapper_of_targeting_entity.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/entity_wrapper_of_targeting_entity.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/error_code_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/error_code_response.py index f48375ca..19ead9b4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/error_code_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/error_code_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/error_description.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/error_description.py index a02aa4e1..504e6fef 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/error_description.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/error_description.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_column.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_column.py index a5d87f78..e3a101fb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_column.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_column.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_meta_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_meta_data.py index d421ef5d..23bf34e0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_meta_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_meta_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_result.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_result.py index 6c7321da..c52cca4a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_result.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_result.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_result_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_result_data.py index 6d2c24d5..56dcaf4a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_result_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/export_result_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/fail_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/fail_response.py index 61b46e96..5a2f0f2e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/fail_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/fail_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request.py index 14497585..d1fe1051 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request_attributes.py index 7326f236..6bdad4dc 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request_data.py index 18a0330b..34bf6fb0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_audience_performance_report_request_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request.py index 9294a086..b43a0df2 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request_attributes.py index 05fe8f7d..357329de 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request_data.py index 877482b6..2f301138 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_categories_report_request_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request.py index 2d9dca5d..7ffe96ae 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request_attributes.py index 2857f209..93fc0d47 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request_data.py index 78bcb0c3..e940e212 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_creatives_report_request_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request.py index 22b67208..c6471307 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request_attributes.py index a310a4c9..ac75b62a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request_data.py index 15799872..16b3426b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_statistics_report_request_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request.py index 8dc521fb..b73d6abc 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request_attributes.py index a8e547d8..6da0fd00 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request_data.py index 96bb40e6..a3dd3cf4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/generate_top_products_report_request_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/get_portfolio_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/get_portfolio_response.py index d412710c..4d062376 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/get_portfolio_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/get_portfolio_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/html_tag_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/html_tag_attributes.py index e694211b..2e00d246 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/html_tag_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/html_tag_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/html_tag_write_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/html_tag_write_attributes.py index a17ded8f..c56c40bf 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/html_tag_write_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/html_tag_write_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_attributes.py index d35dde18..1f5ec815 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_set.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_set.py index e29a6033..1693b382 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_set.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_set_base64.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_set_base64.py index 3cfd66f5..c58b6192 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_set_base64.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_set_base64.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_shape.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_shape.py index db89df8c..09e2d167 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_shape.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_shape.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_slide.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_slide.py index 9578b0db..10e9ccab 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_slide.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_slide.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_write_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_write_attributes.py index 074b7d4b..bece1344 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_write_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/image_write_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1.py index 41e8e2fd..ce9d6f20 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1_list_response.py index 6cd4518c..3066cb0e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1_resource.py index 3cde3f7a..c00b3d9f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_brand_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1.py index 9f69c7be..4d887b18 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1_list_response.py index df09f0a6..391975b0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1_resource.py index 2ab65c0f..987aa795 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_audience_segment_interest_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_create_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_create_v1.py index 1a8fb12d..4752a4ec 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_create_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_create_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_size_estimation_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_size_estimation_v1.py index 6b7a5e67..7a9e09be 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_size_estimation_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_size_estimation_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_update_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_update_v1.py index 12e205fc..0ef770b7 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_update_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_update_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_v1.py index bd01c814..eda62521 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/in_market_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/installment.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/installment.py index 539739fb..47742a82 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/installment.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/installment.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/json_report_rows.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/json_report_rows.py index af556bb6..1d7485a7 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/json_report_rows.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/json_report_rows.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/list_available_industries_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/list_available_industries_response.py index f025d821..a2038df3 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/list_available_industries_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/list_available_industries_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_create_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_create_v1.py index 3b6c7e82..9c7e4664 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_create_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_create_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_size_estimation_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_size_estimation_v1.py index ad86b15c..855a46e5 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_size_estimation_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_size_estimation_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_update_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_update_v1.py index 223d3618..781c4e00 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_update_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_update_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_v1.py index 63fc4a8c..589a0d91 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/location_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_create_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_create_v1.py index 198fd9c6..8f9f9bac 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_create_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_create_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_update_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_update_v1.py index b4374f17..65d5d799 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_update_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_update_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_v1.py index ea2f5730..9e9bb0bb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/lookalike_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/loyalty_points.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/loyalty_points.py index ed95c254..569724d3 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/loyalty_points.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/loyalty_points.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status.py index 3a0855ac..9f01d0ba 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status_resource.py index 342834b1..5b35b7fe 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status_response.py index 9b3365b0..74bede0b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/marketing_solutions_report_status_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/modify_audience_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/modify_audience_response.py index 312771f5..1c9350e2 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/modify_audience_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/modify_audience_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_ad_set_targeting_rule_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_ad_set_targeting_rule_v24_q1.py index ec54a66d..3da21c29 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_ad_set_targeting_rule_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_ad_set_targeting_rule_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_ad_set_targeting_rule_v24_q1_value.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_ad_set_targeting_rule_v24_q1_value.py index 42464030..dcf3ce21 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_ad_set_targeting_rule_v24_q1_value.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_ad_set_targeting_rule_v24_q1_value.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_date_time.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_date_time.py index d543f5e3..1f1606a0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_date_time.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_date_time.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_decimal.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_decimal.py index 34aeef39..b9b1e0c6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_decimal.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_decimal.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_gender_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_gender_v1.py index c6ef557c..e8c21eeb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_gender_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_gender_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_int32.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_int32.py index 33638e72..b5b55eb9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_int32.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_int32.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_string.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_string.py index 6c2b2c4a..defb7c4f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_string.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/nillable_string.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_response.py index 1b1b8962..ac0465cc 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_response_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_response_data.py index b0b35a97..dd5fad76 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_response_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_response_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_rule.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_rule.py index 68921716..ded47255 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_rule.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_rule.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_segment.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_segment.py index 099d9154..31e7bafd 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_segment.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_brand_safety_segment.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_node.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_node.py index 5647cdb8..cc9f7fa4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_node.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_node.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_response.py index b03b4d26..bd62f493 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_response_data.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_response_data.py index 8024e6b4..940fc4b9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_response_data.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_response_data.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_rule.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_rule.py index 7be06909..413715e1 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_rule.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/oci_targeting_rule.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/on_site_reco_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/on_site_reco_request.py index 923915ea..cd414394 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/on_site_reco_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/on_site_reco_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/on_site_reco_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/on_site_reco_response.py index 189b6436..e17c28fb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/on_site_reco_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/on_site_reco_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/outcome.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/outcome.py index f89e8228..58fe3989 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/outcome.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/outcome.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_bidding_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_bidding_v24_q1.py index 3f7c32f3..7c8cdeb5 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_bidding_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_bidding_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_budget_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_budget_v24_q1.py index 6b7df40f..2cb842ac 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_budget_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_budget_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid.py index 81ceba1c..a425264e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_list_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_list_request.py index 283a9745..aed11fc2 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_list_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_list_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_resource.py index 7052d8b8..38bd9b16 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_result_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_result_list_response.py index 5453c50a..bc437728 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_result_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_result_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_result_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_result_resource.py index 11cecf7d..d12ec592 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_result_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_category_bid_result_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier.py index 46accdbd..d46dda57 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_list_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_list_request.py index 9bd2c68c..5e5bd14a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_list_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_list_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_resource.py index 6c19019d..e1f1b4d5 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_result_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_result_list_response.py index 57ac33df..2949d4fb 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_result_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_result_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_result_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_result_resource.py index 9a533d6a..98bc35d1 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_result_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_display_multiplier_result_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_scheduling_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_scheduling_v24_q1.py index 43bf4aa3..4f934e2e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_scheduling_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_scheduling_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_v24_q1.py index 945038f0..abe3cb3c 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_ad_set_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign.py index 38aa87f6..b2ad2cd8 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_list_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_list_request.py index 31703ba6..004960ee 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_list_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_list_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_spend_limit.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_spend_limit.py index fca7e265..9cdfd03b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_spend_limit.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_spend_limit.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_write_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_write_resource.py index 2078364d..cf54cdb0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_write_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_campaign_write_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_result_campaign_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_result_campaign_list_response.py index db3019c4..b0fcc434 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_result_campaign_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_result_campaign_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_result_campaign_read_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_result_campaign_read_resource.py index 9e30728b..dac6627b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_result_campaign_read_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/patch_result_campaign_read_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_data_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_data_message.py index 05309950..636ad2c5 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_data_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_data_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_entity_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_entity_message.py index 45f57d82..93120a67 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_entity_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_entity_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_message.py index 51d33cf5..bf919e21 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/placements_report_query_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/point_of_interest_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/point_of_interest_v1.py index 215faa21..e84c7af5 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/point_of_interest_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/point_of_interest_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/portfolio_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/portfolio_message.py index 73424da2..669a88fc 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/portfolio_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/portfolio_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/price.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/price.py index ae28bd18..18c2f8fd 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/price.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/price.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/problem_details.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/problem_details.py index 9c523dfa..d95b32c6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/problem_details.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/problem_details.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/problems_details.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/problems_details.py index 590137dd..4ed79b4e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/problems_details.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/problems_details.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ 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 1e3a032a..0728d908 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_importer_error.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_importer_error.py index fc21b6a8..32a7d6a7 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_importer_error.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_importer_error.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_importer_warning.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_importer_warning.py index d869bc29..5d8bc4dd 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_importer_warning.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_importer_warning.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_set.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_set.py index 97930331..3b79d59d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_set.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_set_rule.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_set_rule.py index a21f2ca9..12beeb46 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_set_rule.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_set_rule.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping.py index a04402ae..93532835 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping_dimension.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping_dimension.py index 6201390e..be5c5dd6 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping_dimension.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping_dimension.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping_weight.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping_weight.py index 193b9363..efeba197 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping_weight.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_shipping_weight.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_tax.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_tax.py index 40de4c28..98d83af0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_tax.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_tax.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_unit_pricing_base_measure.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_unit_pricing_base_measure.py index 3faf21f8..5b63e83d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_unit_pricing_base_measure.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_unit_pricing_base_measure.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_unit_pricing_measure.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_unit_pricing_measure.py index 1d81eb10..d911d3f9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_unit_pricing_measure.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/product_unit_pricing_measure.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/products_custom_batch_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/products_custom_batch_request.py index 3c5934b9..ccd03b22 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/products_custom_batch_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/products_custom_batch_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ 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 7386dd98..7a2ae5c7 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 @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_create_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_create_v1.py index 7a246b7b..008c5a68 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_create_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_create_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_update_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_update_v1.py index aa0f4eb9..cd7a9881 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_update_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_update_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_v1.py index 9fa70439..4a11c77b 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/prospecting_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_bidding_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_bidding_v24_q1.py index 73e22a2f..4edf12a8 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_bidding_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_bidding_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ 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 54449762..f5fe9188 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 @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_schedule_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_schedule_v24_q1.py index 6a187735..3a72cd28 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_schedule_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_schedule_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_v24_q1.py index cbdde441..72c20858 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_ad_set_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_ad_set_id.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_ad_set_id.py index 602291f8..47d7d5cd 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_ad_set_id.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_ad_set_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_ad_set_id_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_ad_set_id_v24_q1.py index e12736e6..81d4eb63 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_ad_set_id_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_ad_set_id_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_read_ad_set_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_read_ad_set_v24_q1.py index b2dd3039..96e912b2 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_read_ad_set_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/read_model_read_ad_set_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ 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 d6d38603..4ccd4ede 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 @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_data_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_data_message.py index e0fa1a3e..d698aedc 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_data_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_data_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_detail_error.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_detail_error.py index 0f84da2c..d4c88b18 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_detail_error.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_detail_error.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_detail_errors.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_detail_errors.py index ba911d1c..7ba8ec2f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_detail_errors.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_detail_errors.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_entity_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_entity_message.py index 1335fec3..d3ead33e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_entity_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_entity_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_ok_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_ok_response.py index 6827a2b0..7162f463 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_ok_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/report_ok_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/requests_ad_set_id.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/requests_ad_set_id.py index 065e142e..b01e1a0a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/requests_ad_set_id.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/requests_ad_set_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/requests_patch_ad_set_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/requests_patch_ad_set_v24_q1.py index 69f2c5f0..15c0fd68 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/requests_patch_ad_set_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/requests_patch_ad_set_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_collection_outcome_of_product_set.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_collection_outcome_of_product_set.py index dea888bb..bc3a6860 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_collection_outcome_of_product_set.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_collection_outcome_of_product_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_of_product_set.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_of_product_set.py index 1258aac0..58b60896 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_of_product_set.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_of_product_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_outcome_of_product_set.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_outcome_of_product_set.py index 5d2fe288..ea9227f0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_outcome_of_product_set.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/resource_outcome_of_product_set.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/response_read_ad_set_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/response_read_ad_set_v24_q1.py index 352be8b2..b67471a8 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/response_read_ad_set_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/response_read_ad_set_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_ad_set_id.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_ad_set_id.py index fdb7f4e8..7817bff3 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_ad_set_id.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_ad_set_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_ad_set_id_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_ad_set_id_v24_q1.py index 6a49897d..c6f5f490 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_ad_set_id_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_ad_set_id_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_read_ad_set_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_read_ad_set_v24_q1.py index 1f52411c..e99e61d3 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_read_ad_set_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/responses_read_ad_set_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_create_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_create_v1.py index 800c9e2e..2810869c 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_create_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_create_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_update_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_update_v1.py index 3e2f58cf..9f8b51a1 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_update_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_update_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_v1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_v1.py index 9b1fffb2..ad740070 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_v1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/retargeting_v1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids.py index d051d5a4..3f4f30e0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids_request.py index f70c8e09..41a7f0a4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids_resource.py index 638819fb..51bab273 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_deal_ids_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning.py index 13ab66ac..96cfc649 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning_request.py index fa5b8523..49a8c67d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning_resource.py index 2e02f484..f089df44 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_ad_set_targeting_video_positioning_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model.py index 25a2433d..0026cde1 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model_list_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model_list_request.py index d6b917df..84f531c4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model_list_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model_list_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model_resource.py index 808cd5c8..40dea271 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/set_user_profile_model_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/size.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/size.py index 9d44dcf0..e44433b9 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/size.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/size.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_ok_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_ok_response.py index 9e591211..f526ae3f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_ok_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_ok_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_record.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_record.py index 48ea8571..823d66a0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_record.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_record.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_record_list.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_record_list.py index 265d4712..29318db0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_record_list.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_record_list.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_report_query_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_report_query_message.py index e4168cb6..4ce98c20 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_report_query_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/statistics_report_query_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor.py index b669108a..43922ac4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor_list_response.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor_list_response.py index 4e6e0308..140afedf 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor_list_response.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor_list_response.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor_resource.py index cbb78343..a0a6817a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/supply_vendor_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/tag.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/tag.py index 08ffb57f..7b40c658 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/tag.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/tag.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/target.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/target.py index 3ce07e28..347a0199 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/target.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/target.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/target_type.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/target_type.py index 0226ccfa..7190e49e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/target_type.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/target_type.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_entity.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_entity.py index 558c0a50..fa058936 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_entity.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_entity.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_error_model.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_error_model.py index 09e4d295..5ea653ac 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_error_model.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_error_model.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_operator.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_operator.py index 34907618..affef0db 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_operator.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/targeting_operator.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_data_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_data_message.py index bc2fabfc..d135e13e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_data_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_data_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_entity_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_entity_message.py index ddea412c..d3f31e35 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_entity_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_entity_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_message.py index 57176776..c440461f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transactions_report_query_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_query_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_query_message.py index 3f41662b..9d653a2d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_query_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_query_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_attributes.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_attributes.py index e8a1e043..ebc3b39a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_attributes.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_attributes.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_data_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_data_message.py index 1ae12b9e..79b24b9d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_data_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_data_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_entity_message.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_entity_message.py index e7f28211..3b8f6ac3 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_entity_message.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_entity_message.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_file.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_file.py index 2646beb1..e301a933 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_file.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/transparency_report_file.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/unauthorized_response_v2.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/unauthorized_response_v2.py index 97285094..6222cff2 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/unauthorized_response_v2.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/unauthorized_response_v2.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon.py index 1753e70a..04a2972d 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon_request.py index cc7ecf57..3909aa11 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon_resource.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon_resource.py index f30579eb..3b2e2a9f 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon_resource.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/update_coupon_resource.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_def.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_def.py index bc36520a..1af2c373 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_def.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_def.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_profile_attribute_model.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_profile_attribute_model.py index dad2fea2..f0d1df18 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_profile_attribute_model.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_profile_attribute_model.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_profile_identifier_model.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_profile_identifier_model.py index 27658fe1..a21eeeb0 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_profile_identifier_model.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/user_profile_identifier_model.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_input_of_create_product_set_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_input_of_create_product_set_request.py index cccb4818..6c87a266 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_input_of_create_product_set_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_input_of_create_product_set_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_of_advertiser_creation_input.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_of_advertiser_creation_input.py index e3a39a41..064a6dae 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_of_advertiser_creation_input.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_of_advertiser_creation_input.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_of_create_product_set_request.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_of_create_product_set_request.py index ab72be3f..5b557c94 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_of_create_product_set_request.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/value_resource_of_create_product_set_request.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/video_detail.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/video_detail.py index 648a63f5..782a2b8a 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/video_detail.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/video_detail.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/write_model_ad_set_id.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/write_model_ad_set_id.py index 6ed30c39..23ad3390 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/write_model_ad_set_id.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/write_model_ad_set_id.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/write_model_patch_ad_set_v24_q1.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/write_model_patch_ad_set_v24_q1.py index 09801592..8cb467b2 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/write_model_patch_ad_set_v24_q1.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model/write_model_patch_ad_set_v24_q1.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model_utils.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model_utils.py index ba622e51..05c0a81e 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model_utils.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/model_utils.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/rest.py b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/rest.py index 93b3b025..6b86bdf4 100644 --- a/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/rest.py +++ b/sdks/marketingsolutions_preview/criteo_api_marketingsolutions_preview/rest.py @@ -3,7 +3,7 @@ Criteo API - MarketingSolutions # noqa: E501 - The version of the OpenAPI document: preview + The version of the OpenAPI document: Preview Generated by: https://openapi-generator.tech """ diff --git a/sdks/marketingsolutions_preview/setup.py b/sdks/marketingsolutions_preview/setup.py index 77fb54ed..afbdeb07 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.240404" +VERSION = "0.0.240515" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-marketingsolutions-sdk==0.0.240404 +pip install criteo-api-marketingsolutions-sdk==0.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-01/.gitlab-ci.yml b/sdks/retailmedia_2023-01/.gitlab-ci.yml deleted file mode 100644 index 11a5aec1..00000000 --- a/sdks/retailmedia_2023-01/.gitlab-ci.yml +++ /dev/null @@ -1,24 +0,0 @@ -# ref: https://docs.gitlab.com/ee/ci/README.html - -stages: - - test - -.tests: - stage: test - script: - - pip install -r requirements.txt - - pip install -r test-requirements.txt - - pytest --cov=criteo_api_retailmedia_v2023_01 - -test-3.6: - extends: .tests - image: python:3.6-alpine -test-3.7: - extends: .tests - image: python:3.7-alpine -test-3.8: - extends: .tests - image: python:3.8-alpine -test-3.9: - extends: .tests - image: python:3.9-alpine diff --git a/sdks/retailmedia_2023-01/.openapi-generator/FILES b/sdks/retailmedia_2023-01/.openapi-generator/FILES deleted file mode 100644 index 1265f52f..00000000 --- a/sdks/retailmedia_2023-01/.openapi-generator/FILES +++ /dev/null @@ -1,340 +0,0 @@ -.gitignore -.gitlab-ci.yml -.openapi-generator-ignore -.travis.yml -README.md -criteo_api_retailmedia_v2023_01/__init__.py -criteo_api_retailmedia_v2023_01/api/__init__.py -criteo_api_retailmedia_v2023_01/api/analytics_api.py -criteo_api_retailmedia_v2023_01/api/audience_api.py -criteo_api_retailmedia_v2023_01/api/campaign_api.py -criteo_api_retailmedia_v2023_01/api/gateway_api.py -criteo_api_retailmedia_v2023_01/api_client.py -criteo_api_retailmedia_v2023_01/api_client_builder.py -criteo_api_retailmedia_v2023_01/apis/__init__.py -criteo_api_retailmedia_v2023_01/configuration.py -criteo_api_retailmedia_v2023_01/criteo_api_client.py -criteo_api_retailmedia_v2023_01/criteo_auth.py -criteo_api_retailmedia_v2023_01/criteo_rest.py -criteo_api_retailmedia_v2023_01/exceptions.py -criteo_api_retailmedia_v2023_01/flow_constants.py -criteo_api_retailmedia_v2023_01/model/__init__.py -criteo_api_retailmedia_v2023_01/model/add_to_basket_ids_update_model202110_request.py -criteo_api_retailmedia_v2023_01/model/add_to_basket_target202110_request.py -criteo_api_retailmedia_v2023_01/model/add_to_basket_target202110_response.py -criteo_api_retailmedia_v2023_01/model/application_summary_model.py -criteo_api_retailmedia_v2023_01/model/application_summary_model_resource.py -criteo_api_retailmedia_v2023_01/model/application_summary_model_response.py -criteo_api_retailmedia_v2023_01/model/asset.py -criteo_api_retailmedia_v2023_01/model/asset_resource.py -criteo_api_retailmedia_v2023_01/model/asset_response.py -criteo_api_retailmedia_v2023_01/model/async_campaigns_report.py -criteo_api_retailmedia_v2023_01/model/async_campaigns_report_request.py -criteo_api_retailmedia_v2023_01/model/async_campaigns_report_resource.py -criteo_api_retailmedia_v2023_01/model/async_line_items_report.py -criteo_api_retailmedia_v2023_01/model/async_line_items_report_request.py -criteo_api_retailmedia_v2023_01/model/async_line_items_report_resource.py -criteo_api_retailmedia_v2023_01/model/async_report_response.py -criteo_api_retailmedia_v2023_01/model/auction_line_item_create_model_request.py -criteo_api_retailmedia_v2023_01/model/auction_line_item_paged_list_response.py -criteo_api_retailmedia_v2023_01/model/auction_line_item_response.py -criteo_api_retailmedia_v2023_01/model/auction_line_item_update_model_request.py -criteo_api_retailmedia_v2023_01/model/audience_ids_update_model202110_request.py -criteo_api_retailmedia_v2023_01/model/audience_target202110_request.py -criteo_api_retailmedia_v2023_01/model/audience_target202110_response.py -criteo_api_retailmedia_v2023_01/model/balance202110_paged_list_response.py -criteo_api_retailmedia_v2023_01/model/balance_campaign202110_list_request.py -criteo_api_retailmedia_v2023_01/model/balance_campaign202110_paged_list_response.py -criteo_api_retailmedia_v2023_01/model/campaign_attributes_v202301.py -criteo_api_retailmedia_v2023_01/model/campaign_v202301.py -criteo_api_retailmedia_v2023_01/model/category202204.py -criteo_api_retailmedia_v2023_01/model/category202204_list_response.py -criteo_api_retailmedia_v2023_01/model/choice_option.py -criteo_api_retailmedia_v2023_01/model/choice_variable_specification.py -criteo_api_retailmedia_v2023_01/model/common_error.py -criteo_api_retailmedia_v2023_01/model/common_line_item_paged_list_response.py -criteo_api_retailmedia_v2023_01/model/common_line_item_response.py -criteo_api_retailmedia_v2023_01/model/common_problem.py -criteo_api_retailmedia_v2023_01/model/common_warning.py -criteo_api_retailmedia_v2023_01/model/creative202110.py -criteo_api_retailmedia_v2023_01/model/creative202110_list_response.py -criteo_api_retailmedia_v2023_01/model/editable_campaign_attributes_v202301.py -criteo_api_retailmedia_v2023_01/model/external_account.py -criteo_api_retailmedia_v2023_01/model/external_add_to_basket_ids_update_model202110.py -criteo_api_retailmedia_v2023_01/model/external_add_to_basket_target202110.py -criteo_api_retailmedia_v2023_01/model/external_auction_line_item.py -criteo_api_retailmedia_v2023_01/model/external_auction_line_item_create_model.py -criteo_api_retailmedia_v2023_01/model/external_auction_line_item_update_model.py -criteo_api_retailmedia_v2023_01/model/external_audience_ids_update_model202110.py -criteo_api_retailmedia_v2023_01/model/external_audience_target202110.py -criteo_api_retailmedia_v2023_01/model/external_balance202110.py -criteo_api_retailmedia_v2023_01/model/external_brand.py -criteo_api_retailmedia_v2023_01/model/external_catalog_request.py -criteo_api_retailmedia_v2023_01/model/external_catalog_status.py -criteo_api_retailmedia_v2023_01/model/external_common_line_item.py -criteo_api_retailmedia_v2023_01/model/external_keyword_target202110.py -criteo_api_retailmedia_v2023_01/model/external_line_item_capping202110.py -criteo_api_retailmedia_v2023_01/model/external_line_item_page202110.py -criteo_api_retailmedia_v2023_01/model/external_line_item_page_category202110.py -criteo_api_retailmedia_v2023_01/model/external_preferred_line_item202110.py -criteo_api_retailmedia_v2023_01/model/external_preferred_line_item_create_model202110.py -criteo_api_retailmedia_v2023_01/model/external_preferred_line_item_update_model202110.py -criteo_api_retailmedia_v2023_01/model/external_promoted_product202110.py -criteo_api_retailmedia_v2023_01/model/external_retailer.py -criteo_api_retailmedia_v2023_01/model/external_retailer_pages202110.py -criteo_api_retailmedia_v2023_01/model/external_store_ids_update_model202110.py -criteo_api_retailmedia_v2023_01/model/external_store_target202110.py -criteo_api_retailmedia_v2023_01/model/files_variables_specification.py -criteo_api_retailmedia_v2023_01/model/input_resource_of_auction_line_item_create_model.py -criteo_api_retailmedia_v2023_01/model/input_resource_of_preferred_line_item_create_model202110.py -criteo_api_retailmedia_v2023_01/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py -criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_account_and_account.py -criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_brand_and_brand.py -criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py -criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py -criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py -criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py -criteo_api_retailmedia_v2023_01/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py -criteo_api_retailmedia_v2023_01/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py -criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_account.py -criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_brand.py -criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_campaign_v202301.py -criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_retailer.py -criteo_api_retailmedia_v2023_01/model/json_api_request_of_catalog_request.py -criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_campaign_v202301.py -criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_catalog_status.py -criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_line_item_bid_multipliers.py -criteo_api_retailmedia_v2023_01/model/keyword_target202110_request.py -criteo_api_retailmedia_v2023_01/model/keyword_target202110_response.py -criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers.py -criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers_request.py -criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers_response.py -criteo_api_retailmedia_v2023_01/model/page_metadata.py -criteo_api_retailmedia_v2023_01/model/post_campaign_v202301.py -criteo_api_retailmedia_v2023_01/model/preferred_line_item202110_paged_list_response.py -criteo_api_retailmedia_v2023_01/model/preferred_line_item202110_response.py -criteo_api_retailmedia_v2023_01/model/preferred_line_item_create_model202110_request.py -criteo_api_retailmedia_v2023_01/model/preferred_line_item_update_model202110_request.py -criteo_api_retailmedia_v2023_01/model/problem_details.py -criteo_api_retailmedia_v2023_01/model/promoted_product202110_list_request.py -criteo_api_retailmedia_v2023_01/model/promoted_product202110_paged_list_response.py -criteo_api_retailmedia_v2023_01/model/put_campaign_v202301.py -criteo_api_retailmedia_v2023_01/model/report_outcome.py -criteo_api_retailmedia_v2023_01/model/resource_of_auction_line_item.py -criteo_api_retailmedia_v2023_01/model/resource_of_auction_line_item_update_model.py -criteo_api_retailmedia_v2023_01/model/resource_of_balance202110.py -criteo_api_retailmedia_v2023_01/model/resource_of_balance_campaign202110.py -criteo_api_retailmedia_v2023_01/model/resource_of_category202204.py -criteo_api_retailmedia_v2023_01/model/resource_of_common_line_item.py -criteo_api_retailmedia_v2023_01/model/resource_of_creative202110.py -criteo_api_retailmedia_v2023_01/model/resource_of_line_item_bid_multipliers.py -criteo_api_retailmedia_v2023_01/model/resource_of_preferred_line_item202110.py -criteo_api_retailmedia_v2023_01/model/resource_of_preferred_line_item_update_model202110.py -criteo_api_retailmedia_v2023_01/model/resource_of_promoted_product202110.py -criteo_api_retailmedia_v2023_01/model/resource_of_template.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1_resource.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1_response.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2_resource.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2_response.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_input_entity_v1.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_input_entity_v2.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1_list_response.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1_resource.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2_list_response.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2_resource.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_user_behavior_create_v2.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_user_behavior_details_v2.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_customer_list.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_create_v2.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_v1.py -criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_v2.py -criteo_api_retailmedia_v2023_01/model/section.py -criteo_api_retailmedia_v2023_01/model/status_response.py -criteo_api_retailmedia_v2023_01/model/status_response_resource.py -criteo_api_retailmedia_v2023_01/model/store_ids_update_model202110_request.py -criteo_api_retailmedia_v2023_01/model/store_target202110_request.py -criteo_api_retailmedia_v2023_01/model/store_target202110_response.py -criteo_api_retailmedia_v2023_01/model/template.py -criteo_api_retailmedia_v2023_01/model/template_list_response.py -criteo_api_retailmedia_v2023_01/model/template_response.py -criteo_api_retailmedia_v2023_01/model/template_variable.py -criteo_api_retailmedia_v2023_01/model/text_variable_specification.py -criteo_api_retailmedia_v2023_01/model/value_type_resource_of_add_to_basket_ids_update_model202110.py -criteo_api_retailmedia_v2023_01/model/value_type_resource_of_add_to_basket_target202110.py -criteo_api_retailmedia_v2023_01/model/value_type_resource_of_audience_ids_update_model202110.py -criteo_api_retailmedia_v2023_01/model/value_type_resource_of_audience_target202110.py -criteo_api_retailmedia_v2023_01/model/value_type_resource_of_keyword_target202110.py -criteo_api_retailmedia_v2023_01/model/value_type_resource_of_store_ids_update_model202110.py -criteo_api_retailmedia_v2023_01/model/value_type_resource_of_store_target202110.py -criteo_api_retailmedia_v2023_01/model_utils.py -criteo_api_retailmedia_v2023_01/models/__init__.py -criteo_api_retailmedia_v2023_01/rest.py -docs/AddToBasketIdsUpdateModel202110Request.md -docs/AddToBasketTarget202110Request.md -docs/AddToBasketTarget202110Response.md -docs/AnalyticsApi.md -docs/ApplicationSummaryModel.md -docs/ApplicationSummaryModelResource.md -docs/ApplicationSummaryModelResponse.md -docs/Asset.md -docs/AssetResource.md -docs/AssetResponse.md -docs/AsyncCampaignsReport.md -docs/AsyncCampaignsReportRequest.md -docs/AsyncCampaignsReportResource.md -docs/AsyncLineItemsReport.md -docs/AsyncLineItemsReportRequest.md -docs/AsyncLineItemsReportResource.md -docs/AsyncReportResponse.md -docs/AuctionLineItemCreateModelRequest.md -docs/AuctionLineItemPagedListResponse.md -docs/AuctionLineItemResponse.md -docs/AuctionLineItemUpdateModelRequest.md -docs/AudienceApi.md -docs/AudienceIdsUpdateModel202110Request.md -docs/AudienceTarget202110Request.md -docs/AudienceTarget202110Response.md -docs/Balance202110PagedListResponse.md -docs/BalanceCampaign202110ListRequest.md -docs/BalanceCampaign202110PagedListResponse.md -docs/CampaignApi.md -docs/CampaignAttributesV202301.md -docs/CampaignV202301.md -docs/Category202204.md -docs/Category202204ListResponse.md -docs/ChoiceOption.md -docs/ChoiceVariableSpecification.md -docs/CommonError.md -docs/CommonLineItemPagedListResponse.md -docs/CommonLineItemResponse.md -docs/CommonProblem.md -docs/CommonWarning.md -docs/Creative202110.md -docs/Creative202110ListResponse.md -docs/EditableCampaignAttributesV202301.md -docs/ExternalAccount.md -docs/ExternalAddToBasketIdsUpdateModel202110.md -docs/ExternalAddToBasketTarget202110.md -docs/ExternalAuctionLineItem.md -docs/ExternalAuctionLineItemCreateModel.md -docs/ExternalAuctionLineItemUpdateModel.md -docs/ExternalAudienceIdsUpdateModel202110.md -docs/ExternalAudienceTarget202110.md -docs/ExternalBalance202110.md -docs/ExternalBrand.md -docs/ExternalCatalogRequest.md -docs/ExternalCatalogStatus.md -docs/ExternalCommonLineItem.md -docs/ExternalKeywordTarget202110.md -docs/ExternalLineItemCapping202110.md -docs/ExternalLineItemPage202110.md -docs/ExternalLineItemPageCategory202110.md -docs/ExternalPreferredLineItem202110.md -docs/ExternalPreferredLineItemCreateModel202110.md -docs/ExternalPreferredLineItemUpdateModel202110.md -docs/ExternalPromotedProduct202110.md -docs/ExternalRetailer.md -docs/ExternalRetailerPages202110.md -docs/ExternalStoreIdsUpdateModel202110.md -docs/ExternalStoreTarget202110.md -docs/FilesVariablesSpecification.md -docs/GatewayApi.md -docs/InputResourceOfAuctionLineItemCreateModel.md -docs/InputResourceOfPreferredLineItemCreateModel202110.md -docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md -docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md -docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md -docs/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301.md -docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md -docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md -docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md -docs/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301.md -docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest.md -docs/JsonApiPageResponseOfAccount.md -docs/JsonApiPageResponseOfBrand.md -docs/JsonApiPageResponseOfCampaignV202301.md -docs/JsonApiPageResponseOfRetailer.md -docs/JsonApiRequestOfCatalogRequest.md -docs/JsonApiSingleResponseOfCampaignV202301.md -docs/JsonApiSingleResponseOfCatalogStatus.md -docs/JsonApiSingleResponseOfLineItemBidMultipliers.md -docs/KeywordTarget202110Request.md -docs/KeywordTarget202110Response.md -docs/LineItemBidMultipliers.md -docs/LineItemBidMultipliersRequest.md -docs/LineItemBidMultipliersResponse.md -docs/PageMetadata.md -docs/PostCampaignV202301.md -docs/PreferredLineItem202110PagedListResponse.md -docs/PreferredLineItem202110Response.md -docs/PreferredLineItemCreateModel202110Request.md -docs/PreferredLineItemUpdateModel202110Request.md -docs/ProblemDetails.md -docs/PromotedProduct202110ListRequest.md -docs/PromotedProduct202110PagedListResponse.md -docs/PutCampaignV202301.md -docs/ReportOutcome.md -docs/ResourceOfAuctionLineItem.md -docs/ResourceOfAuctionLineItemUpdateModel.md -docs/ResourceOfBalance202110.md -docs/ResourceOfBalanceCampaign202110.md -docs/ResourceOfCategory202204.md -docs/ResourceOfCommonLineItem.md -docs/ResourceOfCreative202110.md -docs/ResourceOfLineItemBidMultipliers.md -docs/ResourceOfPreferredLineItem202110.md -docs/ResourceOfPreferredLineItemUpdateModel202110.md -docs/ResourceOfPromotedProduct202110.md -docs/ResourceOfTemplate.md -docs/RmLegacyAudienceCreateEntityV1.md -docs/RmLegacyAudienceCreateEntityV1Resource.md -docs/RmLegacyAudienceCreateEntityV1Response.md -docs/RmLegacyAudienceCreateEntityV2.md -docs/RmLegacyAudienceCreateEntityV2Resource.md -docs/RmLegacyAudienceCreateEntityV2Response.md -docs/RmLegacyAudienceCreateInputEntityV1.md -docs/RmLegacyAudienceCreateInputEntityV2.md -docs/RmLegacyAudienceGetEntityV1.md -docs/RmLegacyAudienceGetEntityV1ListResponse.md -docs/RmLegacyAudienceGetEntityV1Resource.md -docs/RmLegacyAudienceGetEntityV2.md -docs/RmLegacyAudienceGetEntityV2ListResponse.md -docs/RmLegacyAudienceGetEntityV2Resource.md -docs/RmLegacyAudienceUserBehaviorCreateV2.md -docs/RmLegacyAudienceUserBehaviorDetailsV2.md -docs/RmLegacySegmentCustomerList.md -docs/RmLegacySegmentUserBehaviorCreateV2.md -docs/RmLegacySegmentUserBehaviorV1.md -docs/RmLegacySegmentUserBehaviorV2.md -docs/Section.md -docs/StatusResponse.md -docs/StatusResponseResource.md -docs/StoreIdsUpdateModel202110Request.md -docs/StoreTarget202110Request.md -docs/StoreTarget202110Response.md -docs/Template.md -docs/TemplateListResponse.md -docs/TemplateResponse.md -docs/TemplateVariable.md -docs/TextVariableSpecification.md -docs/ValueTypeResourceOfAddToBasketIdsUpdateModel202110.md -docs/ValueTypeResourceOfAddToBasketTarget202110.md -docs/ValueTypeResourceOfAudienceIdsUpdateModel202110.md -docs/ValueTypeResourceOfAudienceTarget202110.md -docs/ValueTypeResourceOfKeywordTarget202110.md -docs/ValueTypeResourceOfStoreIdsUpdateModel202110.md -docs/ValueTypeResourceOfStoreTarget202110.md -git_push.sh -requirements.txt -setup.cfg -setup.py -test-requirements.txt -test/example_application_with_auth_code.py -test/example_application_with_client_credentials.py -test/example_application_with_refresh_token.py -test/test_gateway_api.py -tox.ini diff --git a/sdks/retailmedia_2023-01/README.md b/sdks/retailmedia_2023-01/README.md deleted file mode 100644 index 8f765edf..00000000 --- a/sdks/retailmedia_2023-01/README.md +++ /dev/null @@ -1,218 +0,0 @@ -# Criteo API SDK for Python - -## Introduction -API Client Libraries can facilitate your use of the Criteo API allowing you to build unique and customized solutions to serve your businesses and clients. -These libraries can reduce the amount of code you need to write in order to start accessing Criteo programmatically. They also can help expedite troubleshooting, should you encounter any issues. - -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.240404 - -## Requirements - -Python 2.7 and 3.5+ - -## Installation & Usage -### pip install - -```sh -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.240404`) - -Then import the package: -```python -import criteo_api_retailmedia_v2023_01 -``` - -### Manual Installation using [Setuptools](http://pypi.python.org/pypi/setuptools) - -Download the code or clone the repository locally, then execute the following command: - -```sh -python setup.py install --user -``` -(or `sudo python setup.py install` to install the package for all users) - -Then import the package: -```python -import criteo_api_retailmedia_v2023_01 -``` - -## Example -There are multiple examples for the different OAuth flows that the SDK supports. -- See [test/example_application_with_client_credentials.py](test/example_application_with_client_credentials.py) for an example with Client Credentials. -- See [test/example_application_with_auth_code.py](test/example_application_with_auth_code.py) for an example with Authorization Code. -Once you follow the authorization code flow, you will have a refresh token that has to be used to regenerate access token for future usage. - - See [test/example_application_with_refresh_token.py](test/example_application_with_refresh_token.py) for an example with Refresh Token . - -## Documentation for API Endpoints - -The developers documentation is available at: *https://developers.criteo.com*. - -All URIs are relative to *https://api.criteo.com*. - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- - - -## Documentation For Models - - - [AddToBasketIdsUpdateModel202110Request](docs/AddToBasketIdsUpdateModel202110Request.md) - - [AddToBasketTarget202110Request](docs/AddToBasketTarget202110Request.md) - - [AddToBasketTarget202110Response](docs/AddToBasketTarget202110Response.md) - - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) - - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) - - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) - - [Asset](docs/Asset.md) - - [AssetResource](docs/AssetResource.md) - - [AssetResponse](docs/AssetResponse.md) - - [AsyncCampaignsReport](docs/AsyncCampaignsReport.md) - - [AsyncCampaignsReportRequest](docs/AsyncCampaignsReportRequest.md) - - [AsyncCampaignsReportResource](docs/AsyncCampaignsReportResource.md) - - [AsyncLineItemsReport](docs/AsyncLineItemsReport.md) - - [AsyncLineItemsReportRequest](docs/AsyncLineItemsReportRequest.md) - - [AsyncLineItemsReportResource](docs/AsyncLineItemsReportResource.md) - - [AsyncReportResponse](docs/AsyncReportResponse.md) - - [AuctionLineItemCreateModelRequest](docs/AuctionLineItemCreateModelRequest.md) - - [AuctionLineItemPagedListResponse](docs/AuctionLineItemPagedListResponse.md) - - [AuctionLineItemResponse](docs/AuctionLineItemResponse.md) - - [AuctionLineItemUpdateModelRequest](docs/AuctionLineItemUpdateModelRequest.md) - - [AudienceIdsUpdateModel202110Request](docs/AudienceIdsUpdateModel202110Request.md) - - [AudienceTarget202110Request](docs/AudienceTarget202110Request.md) - - [AudienceTarget202110Response](docs/AudienceTarget202110Response.md) - - [Balance202110PagedListResponse](docs/Balance202110PagedListResponse.md) - - [BalanceCampaign202110ListRequest](docs/BalanceCampaign202110ListRequest.md) - - [BalanceCampaign202110PagedListResponse](docs/BalanceCampaign202110PagedListResponse.md) - - [CampaignAttributesV202301](docs/CampaignAttributesV202301.md) - - [CampaignV202301](docs/CampaignV202301.md) - - [Category202204](docs/Category202204.md) - - [Category202204ListResponse](docs/Category202204ListResponse.md) - - [ChoiceOption](docs/ChoiceOption.md) - - [ChoiceVariableSpecification](docs/ChoiceVariableSpecification.md) - - [CommonError](docs/CommonError.md) - - [CommonLineItemPagedListResponse](docs/CommonLineItemPagedListResponse.md) - - [CommonLineItemResponse](docs/CommonLineItemResponse.md) - - [CommonProblem](docs/CommonProblem.md) - - [CommonWarning](docs/CommonWarning.md) - - [Creative202110](docs/Creative202110.md) - - [Creative202110ListResponse](docs/Creative202110ListResponse.md) - - [EditableCampaignAttributesV202301](docs/EditableCampaignAttributesV202301.md) - - [ExternalAccount](docs/ExternalAccount.md) - - [ExternalAddToBasketIdsUpdateModel202110](docs/ExternalAddToBasketIdsUpdateModel202110.md) - - [ExternalAddToBasketTarget202110](docs/ExternalAddToBasketTarget202110.md) - - [ExternalAuctionLineItem](docs/ExternalAuctionLineItem.md) - - [ExternalAuctionLineItemCreateModel](docs/ExternalAuctionLineItemCreateModel.md) - - [ExternalAuctionLineItemUpdateModel](docs/ExternalAuctionLineItemUpdateModel.md) - - [ExternalAudienceIdsUpdateModel202110](docs/ExternalAudienceIdsUpdateModel202110.md) - - [ExternalAudienceTarget202110](docs/ExternalAudienceTarget202110.md) - - [ExternalBalance202110](docs/ExternalBalance202110.md) - - [ExternalBrand](docs/ExternalBrand.md) - - [ExternalCatalogRequest](docs/ExternalCatalogRequest.md) - - [ExternalCatalogStatus](docs/ExternalCatalogStatus.md) - - [ExternalCommonLineItem](docs/ExternalCommonLineItem.md) - - [ExternalKeywordTarget202110](docs/ExternalKeywordTarget202110.md) - - [ExternalLineItemCapping202110](docs/ExternalLineItemCapping202110.md) - - [ExternalLineItemPage202110](docs/ExternalLineItemPage202110.md) - - [ExternalLineItemPageCategory202110](docs/ExternalLineItemPageCategory202110.md) - - [ExternalPreferredLineItem202110](docs/ExternalPreferredLineItem202110.md) - - [ExternalPreferredLineItemCreateModel202110](docs/ExternalPreferredLineItemCreateModel202110.md) - - [ExternalPreferredLineItemUpdateModel202110](docs/ExternalPreferredLineItemUpdateModel202110.md) - - [ExternalPromotedProduct202110](docs/ExternalPromotedProduct202110.md) - - [ExternalRetailer](docs/ExternalRetailer.md) - - [ExternalRetailerPages202110](docs/ExternalRetailerPages202110.md) - - [ExternalStoreIdsUpdateModel202110](docs/ExternalStoreIdsUpdateModel202110.md) - - [ExternalStoreTarget202110](docs/ExternalStoreTarget202110.md) - - [FilesVariablesSpecification](docs/FilesVariablesSpecification.md) - - [InputResourceOfAuctionLineItemCreateModel](docs/InputResourceOfAuctionLineItemCreateModel.md) - - [InputResourceOfPreferredLineItemCreateModel202110](docs/InputResourceOfPreferredLineItemCreateModel202110.md) - - [JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301](docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md) - - [JsonApiBodyWithIdOfInt64AndAccountAndAccount](docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md) - - [JsonApiBodyWithIdOfInt64AndBrandAndBrand](docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md) - - [JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301](docs/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301.md) - - [JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus](docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md) - - [JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers](docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md) - - [JsonApiBodyWithIdOfInt64AndRetailerAndRetailer](docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md) - - [JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301](docs/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301.md) - - [JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest](docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest.md) - - [JsonApiPageResponseOfAccount](docs/JsonApiPageResponseOfAccount.md) - - [JsonApiPageResponseOfBrand](docs/JsonApiPageResponseOfBrand.md) - - [JsonApiPageResponseOfCampaignV202301](docs/JsonApiPageResponseOfCampaignV202301.md) - - [JsonApiPageResponseOfRetailer](docs/JsonApiPageResponseOfRetailer.md) - - [JsonApiRequestOfCatalogRequest](docs/JsonApiRequestOfCatalogRequest.md) - - [JsonApiSingleResponseOfCampaignV202301](docs/JsonApiSingleResponseOfCampaignV202301.md) - - [JsonApiSingleResponseOfCatalogStatus](docs/JsonApiSingleResponseOfCatalogStatus.md) - - [JsonApiSingleResponseOfLineItemBidMultipliers](docs/JsonApiSingleResponseOfLineItemBidMultipliers.md) - - [KeywordTarget202110Request](docs/KeywordTarget202110Request.md) - - [KeywordTarget202110Response](docs/KeywordTarget202110Response.md) - - [LineItemBidMultipliers](docs/LineItemBidMultipliers.md) - - [LineItemBidMultipliersRequest](docs/LineItemBidMultipliersRequest.md) - - [LineItemBidMultipliersResponse](docs/LineItemBidMultipliersResponse.md) - - [PageMetadata](docs/PageMetadata.md) - - [PostCampaignV202301](docs/PostCampaignV202301.md) - - [PreferredLineItem202110PagedListResponse](docs/PreferredLineItem202110PagedListResponse.md) - - [PreferredLineItem202110Response](docs/PreferredLineItem202110Response.md) - - [PreferredLineItemCreateModel202110Request](docs/PreferredLineItemCreateModel202110Request.md) - - [PreferredLineItemUpdateModel202110Request](docs/PreferredLineItemUpdateModel202110Request.md) - - [ProblemDetails](docs/ProblemDetails.md) - - [PromotedProduct202110ListRequest](docs/PromotedProduct202110ListRequest.md) - - [PromotedProduct202110PagedListResponse](docs/PromotedProduct202110PagedListResponse.md) - - [PutCampaignV202301](docs/PutCampaignV202301.md) - - [ReportOutcome](docs/ReportOutcome.md) - - [ResourceOfAuctionLineItem](docs/ResourceOfAuctionLineItem.md) - - [ResourceOfAuctionLineItemUpdateModel](docs/ResourceOfAuctionLineItemUpdateModel.md) - - [ResourceOfBalance202110](docs/ResourceOfBalance202110.md) - - [ResourceOfBalanceCampaign202110](docs/ResourceOfBalanceCampaign202110.md) - - [ResourceOfCategory202204](docs/ResourceOfCategory202204.md) - - [ResourceOfCommonLineItem](docs/ResourceOfCommonLineItem.md) - - [ResourceOfCreative202110](docs/ResourceOfCreative202110.md) - - [ResourceOfLineItemBidMultipliers](docs/ResourceOfLineItemBidMultipliers.md) - - [ResourceOfPreferredLineItem202110](docs/ResourceOfPreferredLineItem202110.md) - - [ResourceOfPreferredLineItemUpdateModel202110](docs/ResourceOfPreferredLineItemUpdateModel202110.md) - - [ResourceOfPromotedProduct202110](docs/ResourceOfPromotedProduct202110.md) - - [ResourceOfTemplate](docs/ResourceOfTemplate.md) - - [RmLegacyAudienceCreateEntityV1](docs/RmLegacyAudienceCreateEntityV1.md) - - [RmLegacyAudienceCreateEntityV1Resource](docs/RmLegacyAudienceCreateEntityV1Resource.md) - - [RmLegacyAudienceCreateEntityV1Response](docs/RmLegacyAudienceCreateEntityV1Response.md) - - [RmLegacyAudienceCreateEntityV2](docs/RmLegacyAudienceCreateEntityV2.md) - - [RmLegacyAudienceCreateEntityV2Resource](docs/RmLegacyAudienceCreateEntityV2Resource.md) - - [RmLegacyAudienceCreateEntityV2Response](docs/RmLegacyAudienceCreateEntityV2Response.md) - - [RmLegacyAudienceCreateInputEntityV1](docs/RmLegacyAudienceCreateInputEntityV1.md) - - [RmLegacyAudienceCreateInputEntityV2](docs/RmLegacyAudienceCreateInputEntityV2.md) - - [RmLegacyAudienceGetEntityV1](docs/RmLegacyAudienceGetEntityV1.md) - - [RmLegacyAudienceGetEntityV1ListResponse](docs/RmLegacyAudienceGetEntityV1ListResponse.md) - - [RmLegacyAudienceGetEntityV1Resource](docs/RmLegacyAudienceGetEntityV1Resource.md) - - [RmLegacyAudienceGetEntityV2](docs/RmLegacyAudienceGetEntityV2.md) - - [RmLegacyAudienceGetEntityV2ListResponse](docs/RmLegacyAudienceGetEntityV2ListResponse.md) - - [RmLegacyAudienceGetEntityV2Resource](docs/RmLegacyAudienceGetEntityV2Resource.md) - - [RmLegacyAudienceUserBehaviorCreateV2](docs/RmLegacyAudienceUserBehaviorCreateV2.md) - - [RmLegacyAudienceUserBehaviorDetailsV2](docs/RmLegacyAudienceUserBehaviorDetailsV2.md) - - [RmLegacySegmentCustomerList](docs/RmLegacySegmentCustomerList.md) - - [RmLegacySegmentUserBehaviorCreateV2](docs/RmLegacySegmentUserBehaviorCreateV2.md) - - [RmLegacySegmentUserBehaviorV1](docs/RmLegacySegmentUserBehaviorV1.md) - - [RmLegacySegmentUserBehaviorV2](docs/RmLegacySegmentUserBehaviorV2.md) - - [Section](docs/Section.md) - - [StatusResponse](docs/StatusResponse.md) - - [StatusResponseResource](docs/StatusResponseResource.md) - - [StoreIdsUpdateModel202110Request](docs/StoreIdsUpdateModel202110Request.md) - - [StoreTarget202110Request](docs/StoreTarget202110Request.md) - - [StoreTarget202110Response](docs/StoreTarget202110Response.md) - - [Template](docs/Template.md) - - [TemplateListResponse](docs/TemplateListResponse.md) - - [TemplateResponse](docs/TemplateResponse.md) - - [TemplateVariable](docs/TemplateVariable.md) - - [TextVariableSpecification](docs/TextVariableSpecification.md) - - [ValueTypeResourceOfAddToBasketIdsUpdateModel202110](docs/ValueTypeResourceOfAddToBasketIdsUpdateModel202110.md) - - [ValueTypeResourceOfAddToBasketTarget202110](docs/ValueTypeResourceOfAddToBasketTarget202110.md) - - [ValueTypeResourceOfAudienceIdsUpdateModel202110](docs/ValueTypeResourceOfAudienceIdsUpdateModel202110.md) - - [ValueTypeResourceOfAudienceTarget202110](docs/ValueTypeResourceOfAudienceTarget202110.md) - - [ValueTypeResourceOfKeywordTarget202110](docs/ValueTypeResourceOfKeywordTarget202110.md) - - [ValueTypeResourceOfStoreIdsUpdateModel202110](docs/ValueTypeResourceOfStoreIdsUpdateModel202110.md) - - [ValueTypeResourceOfStoreTarget202110](docs/ValueTypeResourceOfStoreTarget202110.md) - - -## Disclaimer - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file 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 deleted file mode 100644 index b352a5dc..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/__init__.py +++ /dev/null @@ -1,31 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -__version__ = "2023.01.0.240404" - -# import ApiClient -from criteo_api_retailmedia_v2023_01.api_client import ApiClient -from criteo_api_retailmedia_v2023_01.criteo_api_client import CriteoApiClient -from criteo_api_retailmedia_v2023_01.api_client_builder import ApiClientBuilder -from criteo_api_retailmedia_v2023_01 import flow_constants - -# import Configuration -from criteo_api_retailmedia_v2023_01.configuration import Configuration - -# import exceptions -from criteo_api_retailmedia_v2023_01.exceptions import OpenApiException -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError -from criteo_api_retailmedia_v2023_01.exceptions import ApiTypeError -from criteo_api_retailmedia_v2023_01.exceptions import ApiValueError -from criteo_api_retailmedia_v2023_01.exceptions import ApiKeyError -from criteo_api_retailmedia_v2023_01.exceptions import ApiException - - - diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/__init__.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/__init__.py deleted file mode 100644 index a8488283..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -# do not import all apis into this module because that uses a lot of memory and stack frames -# if you need the ability to import all apis from one package, import them with -# from criteo_api_retailmedia_v2023_01.apis import AnalyticsApi diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/analytics_api.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/analytics_api.py deleted file mode 100644 index 2102aefa..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/analytics_api.py +++ /dev/null @@ -1,597 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from criteo_api_retailmedia_v2023_01.model.async_campaigns_report_request import AsyncCampaignsReportRequest -from criteo_api_retailmedia_v2023_01.model.async_line_items_report_request import AsyncLineItemsReportRequest -from criteo_api_retailmedia_v2023_01.model.async_report_response import AsyncReportResponse -from criteo_api_retailmedia_v2023_01.model.report_outcome import ReportOutcome - - -class AnalyticsApi(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.generate_async_campaigns_report_endpoint = _Endpoint( - settings={ - 'response_type': (AsyncReportResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/reports/campaigns', - 'operation_id': 'generate_async_campaigns_report', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'async_campaigns_report_request', - ], - 'required': [ - 'async_campaigns_report_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'async_campaigns_report_request': - (AsyncCampaignsReportRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'async_campaigns_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_line_items_report_endpoint = _Endpoint( - settings={ - 'response_type': (AsyncReportResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/reports/line-items', - 'operation_id': 'generate_async_line_items_report', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'async_line_items_report_request', - ], - 'required': [ - 'async_line_items_report_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'async_line_items_report_request': - (AsyncLineItemsReportRequest,), - }, - 'attribute_map': { - }, - 'location_map': { - 'async_line_items_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.get_async_export_output_endpoint = _Endpoint( - settings={ - 'response_type': (str,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/reports/{reportId}/output', - 'operation_id': 'get_async_export_output', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'report_id', - ], - 'required': [ - 'report_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'report_id': - (str,), - }, - 'attribute_map': { - 'report_id': 'reportId', - }, - 'location_map': { - 'report_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_async_export_status_endpoint = _Endpoint( - settings={ - 'response_type': (AsyncReportResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/reports/{reportId}/status', - 'operation_id': 'get_async_export_status', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'report_id', - ], - 'required': [ - 'report_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'report_id': - (str,), - }, - 'attribute_map': { - 'report_id': 'reportId', - }, - 'location_map': { - 'report_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - - def generate_async_campaigns_report( - self, - async_campaigns_report_request, - **kwargs - ): - """generate_async_campaigns_report # noqa: E501 - - Return an asynchronous Campaigns 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_campaigns_report(async_campaigns_report_request, async_req=True) - >>> result = thread.get() - - Args: - async_campaigns_report_request (AsyncCampaignsReportRequest): - - 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_campaigns_report_request'] = \ - async_campaigns_report_request - return self.generate_async_campaigns_report_endpoint.call_with_http_info(**kwargs) - - def generate_async_line_items_report( - self, - async_line_items_report_request, - **kwargs - ): - """generate_async_line_items_report # noqa: E501 - - Returns an asynchronous Line Items 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_line_items_report(async_line_items_report_request, async_req=True) - >>> result = thread.get() - - Args: - async_line_items_report_request (AsyncLineItemsReportRequest): - - 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_line_items_report_request'] = \ - async_line_items_report_request - return self.generate_async_line_items_report_endpoint.call_with_http_info(**kwargs) - - def get_async_export_output( - self, - report_id, - **kwargs - ): - """get_async_export_output # noqa: E501 - - Returns the output of an async 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.get_async_export_output(report_id, async_req=True) - >>> result = thread.get() - - Args: - report_id (str): The ID of the report to retrieve - - 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: - str - 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['report_id'] = \ - report_id - return self.get_async_export_output_endpoint.call_with_http_info(**kwargs) - - def get_async_export_status( - self, - report_id, - **kwargs - ): - """get_async_export_status # noqa: E501 - - Returns the status of an async 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.get_async_export_status(report_id, async_req=True) - >>> result = thread.get() - - Args: - report_id (str): The ID of the report to retrieve - - 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['report_id'] = \ - report_id - return self.get_async_export_status_endpoint.call_with_http_info(**kwargs) - diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/audience_api.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/audience_api.py deleted file mode 100644 index 3940b234..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/audience_api.py +++ /dev/null @@ -1,657 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v2_response import RmLegacyAudienceCreateEntityV2Response -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_input_entity_v1 import RmLegacyAudienceCreateInputEntityV1 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_input_entity_v2 import RmLegacyAudienceCreateInputEntityV2 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse - - -class AudienceApi(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.legacy_create_audience_v1_endpoint = _Endpoint( - settings={ - 'response_type': (RmLegacyAudienceCreateEntityV1Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{accountId}/audiences', - 'operation_id': 'legacy_create_audience_v1', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'rm_legacy_audience_create_input_entity_v1', - ], - 'required': [ - 'account_id', - 'rm_legacy_audience_create_input_entity_v1', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (int,), - 'rm_legacy_audience_create_input_entity_v1': - (RmLegacyAudienceCreateInputEntityV1,), - }, - 'attribute_map': { - 'account_id': 'accountId', - }, - 'location_map': { - 'account_id': 'path', - 'rm_legacy_audience_create_input_entity_v1': '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.legacy_get_audience_v1_endpoint = _Endpoint( - settings={ - 'response_type': (RmLegacyAudienceGetEntityV1ListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{accountId}/audiences', - 'operation_id': 'legacy_get_audience_v1', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'limit_to_id', - 'page_size', - 'page_index', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (int,), - 'limit_to_id': - ([int],), - 'page_size': - (int,), - 'page_index': - (int,), - }, - 'attribute_map': { - 'account_id': 'accountId', - 'limit_to_id': 'limitToId', - 'page_size': 'pageSize', - 'page_index': 'pageIndex', - }, - 'location_map': { - 'account_id': 'path', - 'limit_to_id': 'query', - 'page_size': 'query', - 'page_index': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.legacy_get_audience_v2_endpoint = _Endpoint( - settings={ - 'response_type': (RmLegacyAudienceGetEntityV2ListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/v2/accounts/{accountId}/audiences', - 'operation_id': 'legacy_get_audience_v2', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'limit_to_id', - 'page_size', - 'page_index', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (int,), - 'limit_to_id': - ([int],), - 'page_size': - (int,), - 'page_index': - (int,), - }, - 'attribute_map': { - 'account_id': 'accountId', - 'limit_to_id': 'limitToId', - 'page_size': 'pageSize', - 'page_index': 'pageIndex', - }, - 'location_map': { - 'account_id': 'path', - 'limit_to_id': 'query', - 'page_size': 'query', - 'page_index': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.legacy_update_audience_v2_endpoint = _Endpoint( - settings={ - 'response_type': (RmLegacyAudienceCreateEntityV2Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/v2/accounts/{accountId}/audiences', - 'operation_id': 'legacy_update_audience_v2', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'rm_legacy_audience_create_input_entity_v2', - ], - 'required': [ - 'account_id', - 'rm_legacy_audience_create_input_entity_v2', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (int,), - 'rm_legacy_audience_create_input_entity_v2': - (RmLegacyAudienceCreateInputEntityV2,), - }, - 'attribute_map': { - 'account_id': 'accountId', - }, - 'location_map': { - 'account_id': 'path', - 'rm_legacy_audience_create_input_entity_v2': '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 - ) - - def legacy_create_audience_v1( - self, - account_id, - rm_legacy_audience_create_input_entity_v1, - **kwargs - ): - """legacy_create_audience_v1 # noqa: E501 - - Create an Audience (deprecated Public API) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.legacy_create_audience_v1(account_id, rm_legacy_audience_create_input_entity_v1, async_req=True) - >>> result = thread.get() - - Args: - account_id (int): ID of the account to which this audience belongs. - rm_legacy_audience_create_input_entity_v1 (RmLegacyAudienceCreateInputEntityV1): Audience creation request. - - 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: - RmLegacyAudienceCreateEntityV1Response - 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['rm_legacy_audience_create_input_entity_v1'] = \ - rm_legacy_audience_create_input_entity_v1 - return self.legacy_create_audience_v1_endpoint.call_with_http_info(**kwargs) - - def legacy_get_audience_v1( - self, - account_id, - **kwargs - ): - """legacy_get_audience_v1 # noqa: E501 - - Get a page of Audiences. (deprecated Public API) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.legacy_get_audience_v1(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (int): ID of the account to which this audience belongs. - - Keyword Args: - limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional] - page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional] - page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [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: - RmLegacyAudienceGetEntityV1ListResponse - 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.legacy_get_audience_v1_endpoint.call_with_http_info(**kwargs) - - def legacy_get_audience_v2( - self, - account_id, - **kwargs - ): - """legacy_get_audience_v2 # noqa: E501 - - Get a page of Audiences. (deprecated Public API) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.legacy_get_audience_v2(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (int): ID of the account to which this audience belongs. - - Keyword Args: - limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional] - page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional] - page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [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: - RmLegacyAudienceGetEntityV2ListResponse - 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.legacy_get_audience_v2_endpoint.call_with_http_info(**kwargs) - - def legacy_update_audience_v2( - self, - account_id, - rm_legacy_audience_create_input_entity_v2, - **kwargs - ): - """legacy_update_audience_v2 # noqa: E501 - - Create an Audience (deprecated Public API) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.legacy_update_audience_v2(account_id, rm_legacy_audience_create_input_entity_v2, async_req=True) - >>> result = thread.get() - - Args: - account_id (int): ID of the account to which this audience belongs. - rm_legacy_audience_create_input_entity_v2 (RmLegacyAudienceCreateInputEntityV2): Audience creation request. - - 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: - RmLegacyAudienceCreateEntityV2Response - 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['rm_legacy_audience_create_input_entity_v2'] = \ - rm_legacy_audience_create_input_entity_v2 - return self.legacy_update_audience_v2_endpoint.call_with_http_info(**kwargs) - diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/campaign_api.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/campaign_api.py deleted file mode 100644 index 07bd03a2..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/campaign_api.py +++ /dev/null @@ -1,7649 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from criteo_api_retailmedia_v2023_01.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_request import AddToBasketTarget202110Request -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_response import AddToBasketTarget202110Response -from criteo_api_retailmedia_v2023_01.model.asset_response import AssetResponse -from criteo_api_retailmedia_v2023_01.model.auction_line_item_create_model_request import AuctionLineItemCreateModelRequest -from criteo_api_retailmedia_v2023_01.model.auction_line_item_paged_list_response import AuctionLineItemPagedListResponse -from criteo_api_retailmedia_v2023_01.model.auction_line_item_response import AuctionLineItemResponse -from criteo_api_retailmedia_v2023_01.model.auction_line_item_update_model_request import AuctionLineItemUpdateModelRequest -from criteo_api_retailmedia_v2023_01.model.audience_ids_update_model202110_request import AudienceIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.audience_target202110_request import AudienceTarget202110Request -from criteo_api_retailmedia_v2023_01.model.audience_target202110_response import AudienceTarget202110Response -from criteo_api_retailmedia_v2023_01.model.balance202110_paged_list_response import Balance202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_list_request import BalanceCampaign202110ListRequest -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.category202204 import Category202204 -from criteo_api_retailmedia_v2023_01.model.category202204_list_response import Category202204ListResponse -from criteo_api_retailmedia_v2023_01.model.common_line_item_paged_list_response import CommonLineItemPagedListResponse -from criteo_api_retailmedia_v2023_01.model.common_line_item_response import CommonLineItemResponse -from criteo_api_retailmedia_v2023_01.model.creative202110_list_response import Creative202110ListResponse -from criteo_api_retailmedia_v2023_01.model.external_retailer_pages202110 import ExternalRetailerPages202110 -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_campaign_v202301 import JsonApiPageResponseOfCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer -from criteo_api_retailmedia_v2023_01.model.json_api_request_of_catalog_request import JsonApiRequestOfCatalogRequest -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_request import KeywordTarget202110Request -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_response import KeywordTarget202110Response -from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest -from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse -from criteo_api_retailmedia_v2023_01.model.post_campaign_v202301 import PostCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.preferred_line_item202110_paged_list_response import PreferredLineItem202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.preferred_line_item202110_response import PreferredLineItem202110Response -from criteo_api_retailmedia_v2023_01.model.preferred_line_item_create_model202110_request import PreferredLineItemCreateModel202110Request -from criteo_api_retailmedia_v2023_01.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.put_campaign_v202301 import PutCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.store_target202110_request import StoreTarget202110Request -from criteo_api_retailmedia_v2023_01.model.store_target202110_response import StoreTarget202110Response -from criteo_api_retailmedia_v2023_01.model.template_list_response import TemplateListResponse -from criteo_api_retailmedia_v2023_01.model.template_response import TemplateResponse - - -class CampaignApi(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.create_asset_endpoint = _Endpoint( - settings={ - 'response_type': (AssetResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/assets', - 'operation_id': 'create_asset', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'asset_file', - ], - 'required': [ - 'asset_file', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'asset_file': - (file_type,), - }, - 'attribute_map': { - 'asset_file': 'AssetFile', - }, - 'location_map': { - 'asset_file': 'form', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [ - 'multipart/form-data' - ] - }, - api_client=api_client - ) - self.get_api202110_external_account_balances_by_account_id_endpoint = _Endpoint( - settings={ - 'response_type': (Balance202110PagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{account-id}/balances', - 'operation_id': 'get_api202110_external_account_balances_by_account_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'limit_to_id', - 'page_index', - 'page_size', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'account_id': 'account-id', - 'limit_to_id': 'limitToId', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'account_id': 'path', - 'limit_to_id': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_account_creatives_by_account_id_endpoint = _Endpoint( - settings={ - 'response_type': (Creative202110ListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{account-id}/creatives', - 'operation_id': 'get_api202110_external_account_creatives_by_account_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (str,), - }, - 'attribute_map': { - 'account_id': 'account-id', - }, - 'location_map': { - 'account_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (KeywordTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/auction-line-items/{line-item-id}/targeting/keywords', - 'operation_id': 'get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_balance_campaigns_by_balance_id_endpoint = _Endpoint( - settings={ - 'response_type': (BalanceCampaign202110PagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/balances/{balance-id}/campaigns', - 'operation_id': 'get_api202110_external_balance_campaigns_by_balance_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'balance_id', - 'limit_to_id', - 'page_index', - 'page_size', - ], - 'required': [ - 'balance_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'balance_id': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'balance_id': 'balance-id', - 'limit_to_id': 'limitToId', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'balance_id': 'path', - 'limit_to_id': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint( - settings={ - 'response_type': (PreferredLineItem202110PagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/campaigns/{campaign-id}/preferred-line-items', - 'operation_id': 'get_api202110_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', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'campaign_id': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - '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={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_line_item_products_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (PromotedProduct202110PagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/line-items/{line-item-id}/products', - 'operation_id': 'get_api202110_external_line_item_products_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'limit_to_id', - 'page_index', - 'page_size', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - 'limit_to_id': 'limitToId', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'line_item_id': 'path', - 'limit_to_id': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (PreferredLineItem202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}', - 'operation_id': 'get_api202110_external_preferred_line_item_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AddToBasketTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket', - 'operation_id': 'get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AudienceTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences', - 'operation_id': 'get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (StoreTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores', - 'operation_id': 'get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202110_external_retailer_pages_by_retailer_id_endpoint = _Endpoint( - settings={ - 'response_type': (ExternalRetailerPages202110,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/retailers/{retailerId}/pages', - 'operation_id': 'get_api202110_external_retailer_pages_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': 'retailerId', - }, - 'location_map': { - 'retailer_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202204_external_categorie_by_category_id_endpoint = _Endpoint( - settings={ - 'response_type': (Category202204,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/categories/{categoryId}', - 'operation_id': 'get_api202204_external_categorie_by_category_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'category_id', - ], - 'required': [ - 'category_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'category_id': - (int,), - }, - 'attribute_map': { - 'category_id': 'categoryId', - }, - 'location_map': { - 'category_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202204_external_categories_endpoint = _Endpoint( - settings={ - 'response_type': (Category202204ListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/categories', - 'operation_id': 'get_api202204_external_categories', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'retailer_id', - 'text_substring', - 'page_index', - 'page_size', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'page_index', - 'page_size', - ] - }, - root_map={ - 'validations': { - ('page_index',): { - - 'inclusive_maximum': 500, - 'inclusive_minimum': 0, - }, - ('page_size',): { - - 'inclusive_maximum': 100, - 'inclusive_minimum': 1, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'retailer_id': - (int,), - 'text_substring': - (str,), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'retailer_id': 'retailerId', - 'text_substring': 'textSubstring', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'retailer_id': 'query', - 'text_substring': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - 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': '/2023-01/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': '/2023-01/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_api202301_external_account_campaigns_by_account_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiPageResponseOfCampaignV202301,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{account-id}/campaigns', - 'operation_id': 'get_api202301_external_account_campaigns_by_account_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'limit_to_id', - 'page_index', - 'page_size', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'account_id': 'account-id', - 'limit_to_id': 'limitToId', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'account_id': 'path', - 'limit_to_id': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202301_external_campaign_by_campaign_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiSingleResponseOfCampaignV202301,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/campaigns/{campaignId}', - 'operation_id': 'get_api202301_external_campaign_by_campaign_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'campaign_id', - ], - 'required': [ - 'campaign_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'campaign_id': - (str,), - }, - 'attribute_map': { - 'campaign_id': 'campaignId', - }, - 'location_map': { - 'campaign_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiSingleResponseOfLineItemBidMultipliers,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/line-items/{line-item-id}/bid-multipliers', - 'operation_id': 'get_api202301_external_line_item_bid_multipliers_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api_v1_external_account_brands_by_account_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiPageResponseOfBrand,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{accountId}/brands', - 'operation_id': 'get_api_v1_external_account_brands_by_account_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'limit_to_id', - 'page_index', - 'page_size', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'account_id': 'accountId', - 'limit_to_id': 'limitToId', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'account_id': 'path', - 'limit_to_id': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api_v1_external_account_retailers_by_account_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiPageResponseOfRetailer,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{accountId}/retailers', - 'operation_id': 'get_api_v1_external_account_retailers_by_account_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'limit_to_id', - 'page_index', - 'page_size', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'account_id': 'accountId', - 'limit_to_id': 'limitToId', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'account_id': 'path', - 'limit_to_id': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api_v1_external_accounts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiPageResponseOfAccount,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts', - 'operation_id': 'get_api_v1_external_accounts', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'limit_to_id', - 'page_index', - 'page_size', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'limit_to_id': 'limitToId', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'limit_to_id': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api_v1_external_catalog_output_by_catalog_id_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/catalogs/{catalogId}/output', - 'operation_id': 'get_api_v1_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_v1_external_catalog_status_by_catalog_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiSingleResponseOfCatalogStatus,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/catalogs/{catalogId}/status', - 'operation_id': 'get_api_v1_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_v2_external_account_line_items_by_account_id_endpoint = _Endpoint( - settings={ - 'response_type': (CommonLineItemPagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{account-id}/line-items', - 'operation_id': 'get_api_v2_external_account_line_items_by_account_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'limit_to_campaign_id', - 'limit_to_type', - 'limit_to_id', - 'page_index', - 'page_size', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - 'limit_to_type', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('limit_to_type',): { - - "UNKNOWN": "Unknown", - "AUCTION": "Auction", - "PREFERRED": "Preferred" - }, - }, - 'openapi_types': { - 'account_id': - (str,), - 'limit_to_campaign_id': - ([str],), - 'limit_to_type': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - 'account_id': 'account-id', - 'limit_to_campaign_id': 'limitToCampaignId', - 'limit_to_type': 'limitToType', - 'limit_to_id': 'limitToId', - 'page_index': 'pageIndex', - 'page_size': 'pageSize', - }, - 'location_map': { - 'account_id': 'path', - 'limit_to_campaign_id': 'query', - 'limit_to_type': 'query', - 'limit_to_id': 'query', - 'page_index': 'query', - 'page_size': 'query', - }, - 'collection_format_map': { - 'limit_to_campaign_id': 'multi', - 'limit_to_id': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api_v2_external_auction_line_item_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AuctionLineItemResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/auction-line-items/{line-item-id}', - 'operation_id': 'get_api_v2_external_auction_line_item_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api_v2_external_campaign_auction_line_items_by_campaign_id_endpoint = _Endpoint( - settings={ - 'response_type': (AuctionLineItemPagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/campaigns/{campaign-id}/auction-line-items', - 'operation_id': 'get_api_v2_external_campaign_auction_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', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'campaign_id': - (str,), - 'limit_to_id': - ([str],), - 'page_index': - (int,), - 'page_size': - (int,), - }, - 'attribute_map': { - '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={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_api_v2_external_line_item_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (CommonLineItemResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/line-items/{line-item-id}', - 'operation_id': 'get_api_v2_external_line_item_by_line_item_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (KeywordTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/auction-line-items/{line-item-id}/targeting/keywords/append', - 'operation_id': 'post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'keyword_target202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'keyword_target202110_request': - (KeywordTarget202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'keyword_target202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (KeywordTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/auction-line-items/{line-item-id}/targeting/keywords/delete', - 'operation_id': 'post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'keyword_target202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'keyword_target202110_request': - (KeywordTarget202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'keyword_target202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_balance_campaigns_append_by_balance_id_endpoint = _Endpoint( - settings={ - 'response_type': (BalanceCampaign202110PagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/balances/{balance-id}/campaigns/append', - 'operation_id': 'post_api202110_external_balance_campaigns_append_by_balance_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'balance_id', - 'balance_campaign202110_list_request', - ], - 'required': [ - 'balance_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'balance_id': - (str,), - 'balance_campaign202110_list_request': - (BalanceCampaign202110ListRequest,), - }, - 'attribute_map': { - 'balance_id': 'balance-id', - }, - 'location_map': { - 'balance_id': 'path', - 'balance_campaign202110_list_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_balance_campaigns_delete_by_balance_id_endpoint = _Endpoint( - settings={ - 'response_type': (BalanceCampaign202110PagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/balances/{balance-id}/campaigns/delete', - 'operation_id': 'post_api202110_external_balance_campaigns_delete_by_balance_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'balance_id', - 'balance_campaign202110_list_request', - ], - 'required': [ - 'balance_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'balance_id': - (str,), - 'balance_campaign202110_list_request': - (BalanceCampaign202110ListRequest,), - }, - 'attribute_map': { - 'balance_id': 'balance-id', - }, - 'location_map': { - 'balance_id': 'path', - 'balance_campaign202110_list_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint( - settings={ - 'response_type': (PreferredLineItem202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/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': [ - 'campaign_id', - 'preferred_line_item_create_model202110_request', - ], - 'required': [ - 'campaign_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'campaign_id': - (str,), - 'preferred_line_item_create_model202110_request': - (PreferredLineItemCreateModel202110Request,), - }, - 'attribute_map': { - 'campaign_id': 'campaign-id', - }, - 'location_map': { - 'campaign_id': 'path', - 'preferred_line_item_create_model202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_line_item_products_append_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (PromotedProduct202110PagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/line-items/{line-item-id}/products/append', - 'operation_id': 'post_api202110_external_line_item_products_append_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'promoted_product202110_list_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'promoted_product202110_list_request': - (PromotedProduct202110ListRequest,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'promoted_product202110_list_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_line_item_products_delete_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (PromotedProduct202110PagedListResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/line-items/{line-item-id}/products/delete', - 'operation_id': 'post_api202110_external_line_item_products_delete_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'promoted_product202110_list_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'promoted_product202110_list_request': - (PromotedProduct202110ListRequest,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'promoted_product202110_list_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_line_item_products_pause_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/line-items/{line-item-id}/products/pause', - 'operation_id': 'post_api202110_external_line_item_products_pause_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'promoted_product202110_list_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'promoted_product202110_list_request': - (PromotedProduct202110ListRequest,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'promoted_product202110_list_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_line_item_products_unpause_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/line-items/{line-item-id}/products/unpause', - 'operation_id': 'post_api202110_external_line_item_products_unpause_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'promoted_product202110_list_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'promoted_product202110_list_request': - (PromotedProduct202110ListRequest,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'promoted_product202110_list_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AddToBasketTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append', - 'operation_id': 'post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'add_to_basket_ids_update_model202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'add_to_basket_ids_update_model202110_request': - (AddToBasketIdsUpdateModel202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'add_to_basket_ids_update_model202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AddToBasketTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete', - 'operation_id': 'post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'add_to_basket_ids_update_model202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'add_to_basket_ids_update_model202110_request': - (AddToBasketIdsUpdateModel202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'add_to_basket_ids_update_model202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AudienceTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append', - 'operation_id': 'post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'audience_ids_update_model202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'audience_ids_update_model202110_request': - (AudienceIdsUpdateModel202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'audience_ids_update_model202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AudienceTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete', - 'operation_id': 'post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'audience_ids_update_model202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'audience_ids_update_model202110_request': - (AudienceIdsUpdateModel202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'audience_ids_update_model202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (StoreTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append', - 'operation_id': 'post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'store_ids_update_model202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'store_ids_update_model202110_request': - (StoreIdsUpdateModel202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'store_ids_update_model202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (StoreTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete', - 'operation_id': 'post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'store_ids_update_model202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'store_ids_update_model202110_request': - (StoreIdsUpdateModel202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'store_ids_update_model202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api202301_external_account_campaigns_by_account_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiSingleResponseOfCampaignV202301,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{account-id}/campaigns', - 'operation_id': 'post_api202301_external_account_campaigns_by_account_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'post_campaign_v202301', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (str,), - 'post_campaign_v202301': - (PostCampaignV202301,), - }, - 'attribute_map': { - 'account_id': 'account-id', - }, - 'location_map': { - 'account_id': 'path', - 'post_campaign_v202301': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api_v1_external_account_catalogs_by_account_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiSingleResponseOfCatalogStatus,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/accounts/{accountId}/catalogs', - 'operation_id': 'post_api_v1_external_account_catalogs_by_account_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'account_id', - 'json_api_request_of_catalog_request', - ], - 'required': [ - 'account_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'account_id': - (str,), - 'json_api_request_of_catalog_request': - (JsonApiRequestOfCatalogRequest,), - }, - 'attribute_map': { - 'account_id': 'accountId', - }, - 'location_map': { - 'account_id': 'path', - 'json_api_request_of_catalog_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.post_api_v2_external_campaign_auction_line_items_by_campaign_id_endpoint = _Endpoint( - settings={ - 'response_type': (AuctionLineItemResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/campaigns/{campaign-id}/auction-line-items', - 'operation_id': 'post_api_v2_external_campaign_auction_line_items_by_campaign_id', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'campaign_id', - 'auction_line_item_create_model_request', - ], - 'required': [ - 'campaign_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'campaign_id': - (str,), - 'auction_line_item_create_model_request': - (AuctionLineItemCreateModelRequest,), - }, - 'attribute_map': { - 'campaign_id': 'campaign-id', - }, - 'location_map': { - 'campaign_id': 'path', - 'auction_line_item_create_model_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (PreferredLineItem202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/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': [ - 'line_item_id', - 'preferred_line_item_update_model202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'preferred_line_item_update_model202110_request': - (PreferredLineItemUpdateModel202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'preferred_line_item_update_model202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AddToBasketTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket', - 'operation_id': 'put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'add_to_basket_target202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'add_to_basket_target202110_request': - (AddToBasketTarget202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'add_to_basket_target202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AudienceTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences', - 'operation_id': 'put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'audience_target202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'audience_target202110_request': - (AudienceTarget202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'audience_target202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (StoreTarget202110Response,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores', - 'operation_id': 'put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'store_target202110_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'store_target202110_request': - (StoreTarget202110Request,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'store_target202110_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_api202301_external_campaign_by_campaign_id_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiSingleResponseOfCampaignV202301,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/campaigns/{campaignId}', - 'operation_id': 'put_api202301_external_campaign_by_campaign_id', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'campaign_id', - 'put_campaign_v202301', - ], - 'required': [ - 'campaign_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'campaign_id': - (str,), - 'put_campaign_v202301': - (PutCampaignV202301,), - }, - 'attribute_map': { - 'campaign_id': 'campaignId', - }, - 'location_map': { - 'campaign_id': 'path', - 'put_campaign_v202301': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (LineItemBidMultipliersResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/line-items/{line-item-id}/bid-multipliers', - 'operation_id': 'put_api202301_external_line_item_bid_multipliers_by_line_item_id', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'line_item_bid_multipliers_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'line_item_bid_multipliers_request': - (LineItemBidMultipliersRequest,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'line_item_bid_multipliers_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.put_api_v2_external_auction_line_item_by_line_item_id_endpoint = _Endpoint( - settings={ - 'response_type': (AuctionLineItemResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/auction-line-items/{line-item-id}', - 'operation_id': 'put_api_v2_external_auction_line_item_by_line_item_id', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'line_item_id', - 'auction_line_item_update_model_request', - ], - 'required': [ - 'line_item_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'line_item_id': - (str,), - 'auction_line_item_update_model_request': - (AuctionLineItemUpdateModelRequest,), - }, - 'attribute_map': { - 'line_item_id': 'line-item-id', - }, - 'location_map': { - 'line_item_id': 'path', - 'auction_line_item_update_model_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - - def create_asset( - self, - asset_file, - **kwargs - ): - """create_asset # noqa: E501 - - Creates an asset # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_asset(asset_file, async_req=True) - >>> result = thread.get() - - Args: - asset_file (file_type): The asset binary content - - 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: - AssetResponse - 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['asset_file'] = \ - asset_file - return self.create_asset_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_account_balances_by_account_id( - self, - account_id, - **kwargs - ): - """get_api202110_external_account_balances_by_account_id # noqa: E501 - - Gets page of balance objects for the given account 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_api202110_external_account_balances_by_account_id(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): The account to get balances for - - 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 - 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: - Balance202110PagedListResponse - 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.get_api202110_external_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_account_creatives_by_account_id( - self, - account_id, - **kwargs - ): - """get_api202110_external_account_creatives_by_account_id # noqa: E501 - - Get account creatives # 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_api202110_external_account_creatives_by_account_id(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): External account id to retrieve creatives 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: - Creative202110ListResponse - 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.get_api202110_external_account_creatives_by_account_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id # noqa: E501 - - This endpoint gets the keyword target on the specified 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_api202110_external_auction_line_item_targeting_keywords_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - 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: - KeywordTarget202110Response - 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_api202110_external_auction_line_item_targeting_keywords_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_balance_campaigns_by_balance_id( - self, - balance_id, - **kwargs - ): - """get_api202110_external_balance_campaigns_by_balance_id # noqa: E501 - - Gets page of campaigns for the given balanceId # 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_api202110_external_balance_campaigns_by_balance_id(balance_id, async_req=True) - >>> result = thread.get() - - Args: - balance_id (str): The balance to get campaigns from - - 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 - 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: - BalanceCampaign202110PagedListResponse - 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['balance_id'] = \ - balance_id - return self.get_api202110_external_balance_campaigns_by_balance_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_campaign_preferred_line_items_by_campaign_id( - self, - campaign_id, - **kwargs - ): - """get_api202110_external_campaign_preferred_line_items_by_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_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, async_req=True) - >>> result = thread.get() - - Args: - 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 - 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: - PreferredLineItem202110PagedListResponse - 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['campaign_id'] = \ - campaign_id - return self.get_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_line_item_products_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api202110_external_line_item_products_by_line_item_id # noqa: E501 - - This endpoint gets the promoted products on the specified 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_api202110_external_line_item_products_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - 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 - 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: - PromotedProduct202110PagedListResponse - 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_api202110_external_line_item_products_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_preferred_line_item_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api202110_external_preferred_line_item_by_line_item_id # 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_api202110_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The given line item 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: - PreferredLineItem202110Response - 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_api202110_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id # noqa: E501 - - This endpoint gets the add to basket target on the specified 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_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - 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: - AddToBasketTarget202110Response - 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_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id # noqa: E501 - - This endpoint gets the audience target on the specified 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_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - 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: - AudienceTarget202110Response - 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_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id # noqa: E501 - - This endpoint gets the store target on the specified 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_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - 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: - StoreTarget202110Response - 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_api202110_external_preferred_line_item_targeting_stores_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def get_api202110_external_retailer_pages_by_retailer_id( - self, - retailer_id, - **kwargs - ): - """get_api202110_external_retailer_pages_by_retailer_id # noqa: E501 - - Get the page types available for the given retailer # 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_api202110_external_retailer_pages_by_retailer_id(retailer_id, async_req=True) - >>> result = thread.get() - - Args: - retailer_id (int): The retailers to fetch pages 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: - ExternalRetailerPages202110 - 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_api202110_external_retailer_pages_by_retailer_id_endpoint.call_with_http_info(**kwargs) - - def get_api202204_external_categorie_by_category_id( - self, - category_id, - **kwargs - ): - """get_api202204_external_categorie_by_category_id # noqa: E501 - - Endpoint to search for a specific category by categoryId. # 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_api202204_external_categorie_by_category_id(category_id, async_req=True) - >>> result = thread.get() - - Args: - category_id (int): ID of the desired category - - 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: - Category202204 - 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['category_id'] = \ - category_id - return self.get_api202204_external_categorie_by_category_id_endpoint.call_with_http_info(**kwargs) - - def get_api202204_external_categories( - self, - **kwargs - ): - """get_api202204_external_categories # noqa: E501 - - Endpoint to search categories by text and retailer. # 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_api202204_external_categories(async_req=True) - >>> result = thread.get() - - - Keyword Args: - retailer_id (int): The retailer id for which Categories fetched. [optional] - text_substring (str): Query string to search across Categories. [optional] - page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 - page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100 - _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: - Category202204ListResponse - 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) - return self.get_api202204_external_categories_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_api202301_external_account_campaigns_by_account_id( - self, - account_id, - **kwargs - ): - """get_api202301_external_account_campaigns_by_account_id # noqa: E501 - - Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign 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.get_api202301_external_account_campaigns_by_account_id(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): The account to request the campaign for. - - 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] if omitted the server will use the default value of 0 - page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25 - _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: - JsonApiPageResponseOfCampaignV202301 - 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.get_api202301_external_account_campaigns_by_account_id_endpoint.call_with_http_info(**kwargs) - - def get_api202301_external_campaign_by_campaign_id( - self, - campaign_id, - **kwargs - ): - """get_api202301_external_campaign_by_campaign_id # noqa: E501 - - Get all the editable and creatable campaign attributes including all types of budgets given the 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_api202301_external_campaign_by_campaign_id(campaign_id, async_req=True) - >>> result = thread.get() - - Args: - campaign_id (str): Campaign Id of the campaign detail - - 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: - JsonApiSingleResponseOfCampaignV202301 - 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['campaign_id'] = \ - campaign_id - return self.get_api202301_external_campaign_by_campaign_id_endpoint.call_with_http_info(**kwargs) - - def get_api202301_external_line_item_bid_multipliers_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api202301_external_line_item_bid_multipliers_by_line_item_id # 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_api202301_external_line_item_bid_multipliers_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: - JsonApiSingleResponseOfLineItemBidMultipliers - 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_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, - account_id, - **kwargs - ): - """get_api_v1_external_account_brands_by_account_id # noqa: E501 - - Gets page of retailer objects that are associated with the given 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.get_api_v1_external_account_brands_by_account_id(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): The given account 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 - 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: - JsonApiPageResponseOfBrand - 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.get_api_v1_external_account_brands_by_account_id_endpoint.call_with_http_info(**kwargs) - - def get_api_v1_external_account_retailers_by_account_id( - self, - account_id, - **kwargs - ): - """get_api_v1_external_account_retailers_by_account_id # noqa: E501 - - Gets page of retailer objects that are associated with the given 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.get_api_v1_external_account_retailers_by_account_id(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): The given account 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 - 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: - JsonApiPageResponseOfRetailer - 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.get_api_v1_external_account_retailers_by_account_id_endpoint.call_with_http_info(**kwargs) - - def get_api_v1_external_accounts( - self, - **kwargs - ): - """get_api_v1_external_accounts # noqa: E501 - - Gets page of account objects that the current user can access # 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_v1_external_accounts(async_req=True) - >>> result = thread.get() - - - 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 - 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: - JsonApiPageResponseOfAccount - 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) - return self.get_api_v1_external_accounts_endpoint.call_with_http_info(**kwargs) - - def get_api_v1_external_catalog_output_by_catalog_id( - self, - catalog_id, - **kwargs - ): - """get_api_v1_external_catalog_output_by_catalog_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 v2021_07 CatalogProduct json objects. # 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_v1_external_catalog_output_by_catalog_id(catalog_id, async_req=True) - >>> result = thread.get() - - Args: - catalog_id (str): A catalog ID returned from an account catalog request. - - 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: - None - 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['catalog_id'] = \ - catalog_id - return self.get_api_v1_external_catalog_output_by_catalog_id_endpoint.call_with_http_info(**kwargs) - - def get_api_v1_external_catalog_status_by_catalog_id( - self, - catalog_id, - **kwargs - ): - """get_api_v1_external_catalog_status_by_catalog_id # noqa: E501 - - Check the status of a catalog request. # 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_v1_external_catalog_status_by_catalog_id(catalog_id, async_req=True) - >>> result = thread.get() - - Args: - catalog_id (str): A catalog ID returned from an account catalog request. - - 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: - JsonApiSingleResponseOfCatalogStatus - 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['catalog_id'] = \ - catalog_id - return self.get_api_v1_external_catalog_status_by_catalog_id_endpoint.call_with_http_info(**kwargs) - - def get_api_v2_external_account_line_items_by_account_id( - self, - account_id, - **kwargs - ): - """get_api_v2_external_account_line_items_by_account_id # noqa: E501 - - Gets page of line item objects for the given account 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_api_v2_external_account_line_items_by_account_id(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): The given account id - - Keyword Args: - limit_to_campaign_id ([str]): The campaign ids that you would like to limit your result set to. [optional] - limit_to_type (str): The campaign types that you would like to limit your result set to. [optional] - 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 - 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: - CommonLineItemPagedListResponse - 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.get_api_v2_external_account_line_items_by_account_id_endpoint.call_with_http_info(**kwargs) - - def get_api_v2_external_auction_line_item_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api_v2_external_auction_line_item_by_line_item_id # noqa: E501 - - Gets the auction 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_api_v2_external_auction_line_item_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The given line item 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: - AuctionLineItemResponse - 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_api_v2_external_auction_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def get_api_v2_external_campaign_auction_line_items_by_campaign_id( - self, - campaign_id, - **kwargs - ): - """get_api_v2_external_campaign_auction_line_items_by_campaign_id # noqa: E501 - - Gets page of auction 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_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id, async_req=True) - >>> result = thread.get() - - Args: - 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 - 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: - AuctionLineItemPagedListResponse - 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['campaign_id'] = \ - campaign_id - return self.get_api_v2_external_campaign_auction_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) - - def get_api_v2_external_line_item_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """get_api_v2_external_line_item_by_line_item_id # noqa: E501 - - Gets the 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_api_v2_external_line_item_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The given line item 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: - CommonLineItemResponse - 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_api_v2_external_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id # noqa: E501 - - This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned. # 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_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - keyword_target202110_request (KeywordTarget202110Request): . [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: - KeywordTarget202110Response - 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.post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id # noqa: E501 - - This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned. # 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_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - keyword_target202110_request (KeywordTarget202110Request): . [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: - KeywordTarget202110Response - 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.post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_balance_campaigns_append_by_balance_id( - self, - balance_id, - **kwargs - ): - """post_api202110_external_balance_campaigns_append_by_balance_id # noqa: E501 - - appends one or more campaigns to the specified balance # 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_api202110_external_balance_campaigns_append_by_balance_id(balance_id, async_req=True) - >>> result = thread.get() - - Args: - balance_id (str): The balance to add campaigns from - - Keyword Args: - balance_campaign202110_list_request (BalanceCampaign202110ListRequest): The campaigns to append. [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: - BalanceCampaign202110PagedListResponse - 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['balance_id'] = \ - balance_id - return self.post_api202110_external_balance_campaigns_append_by_balance_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_balance_campaigns_delete_by_balance_id( - self, - balance_id, - **kwargs - ): - """post_api202110_external_balance_campaigns_delete_by_balance_id # noqa: E501 - - Removes one or more campaigns on the specified balance # 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_api202110_external_balance_campaigns_delete_by_balance_id(balance_id, async_req=True) - >>> result = thread.get() - - Args: - balance_id (str): The balance to remove campaigns from - - Keyword Args: - balance_campaign202110_list_request (BalanceCampaign202110ListRequest): The campaigns to append. [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: - BalanceCampaign202110PagedListResponse - 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['balance_id'] = \ - balance_id - return self.post_api202110_external_balance_campaigns_delete_by_balance_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_campaign_preferred_line_items_by_campaign_id( - self, - campaign_id, - **kwargs - ): - """post_api202110_external_campaign_preferred_line_items_by_campaign_id # 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_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, async_req=True) - >>> result = thread.get() - - Args: - campaign_id (str): The given campaign id - - Keyword Args: - preferred_line_item_create_model202110_request (PreferredLineItemCreateModel202110Request): The line item settings to create a line item with. [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: - PreferredLineItem202110Response - 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['campaign_id'] = \ - campaign_id - return self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_line_item_products_append_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_line_item_products_append_by_line_item_id # noqa: E501 - - This endpoint appends one or more products to promote on the specified line item. The resulting state of the line item is returned. # 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_api202110_external_line_item_products_append_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - promoted_product202110_list_request (PromotedProduct202110ListRequest): the products to append to this 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 - 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: - PromotedProduct202110PagedListResponse - 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.post_api202110_external_line_item_products_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_line_item_products_delete_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_line_item_products_delete_by_line_item_id # noqa: E501 - - This endpoint removes one or more products from promotion on the specified line item. The resulting state of the line item is returned. # 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_api202110_external_line_item_products_delete_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - promoted_product202110_list_request (PromotedProduct202110ListRequest): . [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: - PromotedProduct202110PagedListResponse - 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.post_api202110_external_line_item_products_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_line_item_products_pause_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_line_item_products_pause_by_line_item_id # noqa: E501 - - This endpoint pauses one or more promoted products on a specified 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_api202110_external_line_item_products_pause_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with. - - Keyword Args: - promoted_product202110_list_request (PromotedProduct202110ListRequest): The products from which their IDs will be used to pause.. [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: - None - 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.post_api202110_external_line_item_products_pause_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_line_item_products_unpause_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_line_item_products_unpause_by_line_item_id # noqa: E501 - - This endpoint unpauses one or more promoted products on a specified 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_api202110_external_line_item_products_unpause_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with. - - Keyword Args: - promoted_product202110_list_request (PromotedProduct202110ListRequest): The products from which their IDs will be used to unpause.. [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: - None - 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.post_api202110_external_line_item_products_unpause_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id # noqa: E501 - - This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned. # 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_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - add_to_basket_ids_update_model202110_request (AddToBasketIdsUpdateModel202110Request): Ids to append to the target. [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: - AddToBasketTarget202110Response - 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.post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id # noqa: E501 - - This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned. # 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_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - add_to_basket_ids_update_model202110_request (AddToBasketIdsUpdateModel202110Request): Ids to remove from the target. [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: - AddToBasketTarget202110Response - 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.post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id # noqa: E501 - - This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned. # 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_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - audience_ids_update_model202110_request (AudienceIdsUpdateModel202110Request): Audience ids to append to the target. [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: - AudienceTarget202110Response - 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.post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id # noqa: E501 - - This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned. # 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_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - audience_ids_update_model202110_request (AudienceIdsUpdateModel202110Request): Audience ids to remove from the target. [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: - AudienceTarget202110Response - 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.post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id # noqa: E501 - - This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned. # 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_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - store_ids_update_model202110_request (StoreIdsUpdateModel202110Request): Store ids to append to the target. [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: - StoreTarget202110Response - 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.post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id # noqa: E501 - - This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned. # 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_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - store_ids_update_model202110_request (StoreIdsUpdateModel202110Request): Store ids to remove from the target. [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: - StoreTarget202110Response - 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.post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def post_api202301_external_account_campaigns_by_account_id( - self, - account_id, - **kwargs - ): - """post_api202301_external_account_campaigns_by_account_id # noqa: E501 - - Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled. # 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_api202301_external_account_campaigns_by_account_id(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): The account to request the campaign for. - - Keyword Args: - post_campaign_v202301 (PostCampaignV202301): Creatable campaign attributes. [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: - JsonApiSingleResponseOfCampaignV202301 - 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.post_api202301_external_account_campaigns_by_account_id_endpoint.call_with_http_info(**kwargs) - - def post_api_v1_external_account_catalogs_by_account_id( - self, - account_id, - **kwargs - ): - """post_api_v1_external_account_catalogs_by_account_id # noqa: E501 - - Create a request for a Catalog available to the indicated 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.post_api_v1_external_account_catalogs_by_account_id(account_id, async_req=True) - >>> result = thread.get() - - Args: - account_id (str): The account to request the catalog for. - - Keyword Args: - json_api_request_of_catalog_request (JsonApiRequestOfCatalogRequest): [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: - JsonApiSingleResponseOfCatalogStatus - 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.post_api_v1_external_account_catalogs_by_account_id_endpoint.call_with_http_info(**kwargs) - - def post_api_v2_external_campaign_auction_line_items_by_campaign_id( - self, - campaign_id, - **kwargs - ): - """post_api_v2_external_campaign_auction_line_items_by_campaign_id # noqa: E501 - - Creates new auction 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_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id, async_req=True) - >>> result = thread.get() - - Args: - campaign_id (str): The given campaign id - - Keyword Args: - auction_line_item_create_model_request (AuctionLineItemCreateModelRequest): The line item settings to create a line item with. [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: - AuctionLineItemResponse - 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['campaign_id'] = \ - campaign_id - return self.post_api_v2_external_campaign_auction_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) - - def put_api202110_external_preferred_line_item_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """put_api202110_external_preferred_line_item_by_line_item_id # 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_api202110_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The given line item id - - Keyword Args: - preferred_line_item_update_model202110_request (PreferredLineItemUpdateModel202110Request): The line item settings to create a line item with. [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: - PreferredLineItem202110Response - 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.put_api202110_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id # noqa: E501 - - This endpoint sets the scope of the add to basket target on the specified 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.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - add_to_basket_target202110_request (AddToBasketTarget202110Request): The add to basket target to set the scope for. [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: - AddToBasketTarget202110Response - 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.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id # noqa: E501 - - This endpoint sets the scope of the audience target on the specified 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.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - audience_target202110_request (AudienceTarget202110Request): The audience target to set the scope for. [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: - AudienceTarget202110Response - 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.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id # noqa: E501 - - This endpoint sets the scope of the store target on the specified 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.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The line item to interact with - - Keyword Args: - store_target202110_request (StoreTarget202110Request): The store target to set the scope for. [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: - StoreTarget202110Response - 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.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def put_api202301_external_campaign_by_campaign_id( - self, - campaign_id, - **kwargs - ): - """put_api202301_external_campaign_by_campaign_id # noqa: E501 - - Edit a campaign for the given campaign id with a given editable attributes. This will return updated creatable and editable attributes of the campaign as the result of the operation. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled. # 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_api202301_external_campaign_by_campaign_id(campaign_id, async_req=True) - >>> result = thread.get() - - Args: - campaign_id (str): Campaign Id of the updating campaign - - Keyword Args: - put_campaign_v202301 (PutCampaignV202301): Editable campaign attributes. [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: - JsonApiSingleResponseOfCampaignV202301 - 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['campaign_id'] = \ - campaign_id - return self.put_api202301_external_campaign_by_campaign_id_endpoint.call_with_http_info(**kwargs) - - def put_api202301_external_line_item_bid_multipliers_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """put_api202301_external_line_item_bid_multipliers_by_line_item_id # noqa: E501 - - Replace bid multipliers on 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.put_api202301_external_line_item_bid_multipliers_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: - line_item_bid_multipliers_request (LineItemBidMultipliersRequest): [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: - LineItemBidMultipliersResponse - 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.put_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) - - def put_api_v2_external_auction_line_item_by_line_item_id( - self, - line_item_id, - **kwargs - ): - """put_api_v2_external_auction_line_item_by_line_item_id # noqa: E501 - - Updates the auction 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_api_v2_external_auction_line_item_by_line_item_id(line_item_id, async_req=True) - >>> result = thread.get() - - Args: - line_item_id (str): The given line item id - - Keyword Args: - auction_line_item_update_model_request (AuctionLineItemUpdateModelRequest): The line item settings to create a line item with. [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: - AuctionLineItemResponse - 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.put_api_v2_external_auction_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) - diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/gateway_api.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/gateway_api.py deleted file mode 100644 index 31f2c37d..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api/gateway_api.py +++ /dev/null @@ -1,161 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.api_client import ApiClient, Endpoint as _Endpoint -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from criteo_api_retailmedia_v2023_01.model.application_summary_model_response import ApplicationSummaryModelResponse - - -class GatewayApi(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.get_current_application_endpoint = _Endpoint( - settings={ - 'response_type': (ApplicationSummaryModelResponse,), - 'auth': [ - 'oauth', - 'oauth' - ], - 'endpoint_path': '/2023-01/retail-media/me', - 'operation_id': 'get_current_application', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) - - def get_current_application( - self, - **kwargs - ): - """get_current_application # noqa: E501 - - Get information about the currently logged application # 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_current_application(async_req=True) - >>> result = thread.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: - ApplicationSummaryModelResponse - 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) - return self.get_current_application_endpoint.call_with_http_info(**kwargs) - 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 deleted file mode 100644 index ebbc381e..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api_client.py +++ /dev/null @@ -1,898 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import json -import atexit -import mimetypes -from multiprocessing.pool import ThreadPool -import io -import os -import re -import typing -from urllib.parse import quote -from urllib3.fields import RequestField - - -from criteo_api_retailmedia_v2023_01 import rest -from criteo_api_retailmedia_v2023_01.configuration import Configuration -from criteo_api_retailmedia_v2023_01.exceptions import ApiTypeError, ApiValueError, ApiException -from criteo_api_retailmedia_v2023_01.model_utils import ( - ModelNormal, - ModelSimple, - ModelComposed, - check_allowed_values, - check_validations, - date, - datetime, - deserialize_file, - file_type, - model_to_dict, - none_type, - validate_and_convert_types -) - - -class ApiClient(object): - """Generic API client for OpenAPI client library builds. - - OpenAPI generic API client. This client handles the client- - server communication, and is invariant across implementations. Specifics of - the methods and models for each application are generated from the OpenAPI - templates. - - NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - Do not edit the class manually. - - :param configuration: .Configuration object for this client - :param header_name: a header to pass when making calls to the API. - :param header_value: a header value to pass when making calls to - the API. - :param cookie: a cookie to include in the header when making calls - to the API - :param pool_threads: The number of threads to use for async requests - to the API. More threads means more concurrent API requests. - """ - - _pool = None - - def __init__(self, configuration=None, header_name=None, header_value=None, - cookie=None, pool_threads=1): - if configuration is None: - configuration = Configuration.get_default_copy() - self.configuration = configuration - self.pool_threads = pool_threads - - self.rest_client = rest.RESTClientObject(configuration) - self.default_headers = {} - if header_name is not None: - self.default_headers[header_name] = header_value - self.cookie = cookie - # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2023.01.0.240404/python' - - def __enter__(self): - return self - - def __exit__(self, exc_type, exc_value, traceback): - self.close() - - def close(self): - if self._pool: - self._pool.close() - self._pool.join() - self._pool = None - if hasattr(atexit, 'unregister'): - atexit.unregister(self.close) - - @property - def pool(self): - """Create thread pool on first request - avoids instantiating unused threadpool for blocking clients. - """ - if self._pool is None: - atexit.register(self.close) - self._pool = ThreadPool(self.pool_threads) - return self._pool - - @property - def user_agent(self): - """User agent for this API client""" - return self.default_headers['User-Agent'] - - @user_agent.setter - def user_agent(self, value): - self.default_headers['User-Agent'] = value - - def set_default_header(self, header_name, header_value): - self.default_headers[header_name] = header_value - - def __call_api( - self, - resource_path: str, - method: str, - path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - body: typing.Optional[typing.Any] = None, - post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, - response_type: typing.Optional[typing.Tuple[typing.Any]] = None, - auth_settings: typing.Optional[typing.List[str]] = None, - _return_http_data_only: typing.Optional[bool] = None, - collection_formats: typing.Optional[typing.Dict[str, str]] = None, - _preload_content: bool = True, - _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, - _host: typing.Optional[str] = None, - _check_type: typing.Optional[bool] = None, - _content_type: typing.Optional[str] = None, - _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None - ): - - config = self.configuration - - # header parameters - header_params = header_params or {} - header_params.update(self.default_headers) - if self.cookie: - header_params['Cookie'] = self.cookie - if header_params: - header_params = self.sanitize_for_serialization(header_params) - header_params = dict(self.parameters_to_tuples(header_params, - collection_formats)) - - # path parameters - if path_params: - path_params = self.sanitize_for_serialization(path_params) - path_params = self.parameters_to_tuples(path_params, - collection_formats) - for k, v in path_params: - # specified safe chars, encode everything - resource_path = resource_path.replace( - '{%s}' % k, - quote(str(v), safe=config.safe_chars_for_path_param) - ) - - # query parameters - if query_params: - query_params = self.sanitize_for_serialization(query_params) - query_params = self.parameters_to_tuples(query_params, - collection_formats) - - # post parameters - if post_params or files: - post_params = post_params if post_params else [] - post_params = self.sanitize_for_serialization(post_params) - post_params = self.parameters_to_tuples(post_params, - collection_formats) - post_params.extend(self.files_parameters(files)) - if header_params['Content-Type'].startswith("multipart"): - post_params = self.parameters_to_multipart(post_params, - (dict)) - - # body - if body: - body = self.sanitize_for_serialization(body) - - # auth setting - self.update_params_for_auth(header_params, query_params, - auth_settings, resource_path, method, body, - request_auths=_request_auths) - - # request url - if _host is None: - url = self.configuration.host + resource_path - else: - # use server/host defined in path or operation instead - url = _host + resource_path - - try: - # perform request and return response - response_data = self.request( - method, url, query_params=query_params, headers=header_params, - post_params=post_params, body=body, - _preload_content=_preload_content, - _request_timeout=_request_timeout) - except ApiException as e: - e.body = e.body.decode('utf-8') - raise e - - self.last_response = response_data - - return_data = response_data - - if not _preload_content: - return (return_data) - return return_data - - # deserialize response data - if response_type: - if response_type != (file_type,): - encoding = "utf-8" - content_type = response_data.getheader('content-type') - if content_type is not None: - match = re.search(r"charset=([a-zA-Z\-\d]+)[\s\;]?", content_type) - if match: - encoding = match.group(1) - response_data.data = response_data.data.decode(encoding) - - return_data = self.deserialize( - response_data, - response_type, - _check_type - ) - else: - return_data = None - - if _return_http_data_only: - return (return_data) - else: - return (return_data, response_data.status, - response_data.getheaders()) - - def parameters_to_multipart(self, params, collection_types): - """Get parameters as list of tuples, formatting as json if value is collection_types - - :param params: Parameters as list of two-tuples - :param dict collection_types: Parameter collection types - :return: Parameters as list of tuple or urllib3.fields.RequestField - """ - new_params = [] - if collection_types is None: - collection_types = (dict) - for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 - if isinstance( - v, collection_types): # v is instance of collection_type, formatting as application/json - v = json.dumps(v, ensure_ascii=False).encode("utf-8") - field = RequestField(k, v) - field.make_multipart(content_type="application/json; charset=utf-8") - new_params.append(field) - else: - new_params.append((k, v)) - return new_params - - @classmethod - def sanitize_for_serialization(cls, obj): - """Prepares data for transmission before it is sent with the rest client - If obj is None, return None. - If obj is str, int, long, float, bool, return directly. - If obj is datetime.datetime, datetime.date - convert to string in iso8601 format. - If obj is list, sanitize each element in the list. - If obj is dict, return the dict. - If obj is OpenAPI model, return the properties dict. - If obj is io.IOBase, return the bytes - :param obj: The data to serialize. - :return: The serialized form of data. - """ - if isinstance(obj, (ModelNormal, ModelComposed)): - return { - key: cls.sanitize_for_serialization(val) for key, - val in model_to_dict( - obj, - serialize=True).items()} - elif isinstance(obj, io.IOBase): - return cls.get_file_data_and_close_file(obj) - elif isinstance(obj, (str, int, float, none_type, bool)): - return obj - elif isinstance(obj, (datetime, date)): - return obj.isoformat() - elif isinstance(obj, ModelSimple): - return cls.sanitize_for_serialization(obj.value) - elif isinstance(obj, list): - return [cls.sanitize_for_serialization(item) for item in obj] - elif isinstance(obj, tuple): - return tuple(cls.sanitize_for_serialization(item) for item in obj) - if isinstance(obj, dict): - return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} - raise ApiValueError( - 'Unable to prepare type {} for serialization'.format( - obj.__class__.__name__)) - - def deserialize(self, response, response_type, _check_type): - """Deserializes response into an object. - - :param response: RESTResponse object to be deserialized. - :param response_type: For the response, a tuple containing: - valid classes - a list containing valid classes (for list schemas) - a dict containing a tuple of valid classes as the value - Example values: - (str,) - (Pet,) - (float, none_type) - ([int, none_type],) - ({str: (bool, str, int, float, date, datetime, str, none_type)},) - :param _check_type: boolean, whether to check the types of the data - received from the server - :type _check_type: bool - - :return: deserialized object. - """ - # handle file downloading - # save response body into a tmp file and return the instance - if response_type == (file_type,): - content_disposition = response.getheader("Content-Disposition") - return deserialize_file(response.data, self.configuration, - content_disposition=content_disposition) - - # fetch data from response object - try: - received_data = json.loads(response.data) - except ValueError: - received_data = response.data - - # store our data under the key of 'received_data' so users have some - # context if they are deserializing a string and the data type is wrong - deserialized_data = validate_and_convert_types( - received_data, - response_type, - ['received_data'], - True, - _check_type, - configuration=self.configuration - ) - return deserialized_data - - def call_api( - self, - resource_path: str, - method: str, - path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, - body: typing.Optional[typing.Any] = None, - post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, - files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, - response_type: typing.Optional[typing.Tuple[typing.Any]] = None, - auth_settings: typing.Optional[typing.List[str]] = None, - async_req: typing.Optional[bool] = None, - _return_http_data_only: typing.Optional[bool] = None, - collection_formats: typing.Optional[typing.Dict[str, str]] = None, - _preload_content: bool = True, - _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, - _host: typing.Optional[str] = None, - _check_type: typing.Optional[bool] = None, - _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None - ): - """Makes the HTTP request (synchronous) and returns deserialized data. - - To make an async_req request, set the async_req parameter. - - :param resource_path: Path to method endpoint. - :param method: Method to call. - :param path_params: Path parameters in the url. - :param query_params: Query parameters in the url. - :param header_params: Header parameters to be - placed in the request header. - :param body: Request body. - :param post_params dict: Request post form parameters, - for `application/x-www-form-urlencoded`, `multipart/form-data`. - :param auth_settings list: Auth Settings names for the request. - :param response_type: For the response, a tuple containing: - valid classes - a list containing valid classes (for list schemas) - a dict containing a tuple of valid classes as the value - Example values: - (str,) - (Pet,) - (float, none_type) - ([int, none_type],) - ({str: (bool, str, int, float, date, datetime, str, none_type)},) - :param files: key -> field name, value -> a list of open file - objects for `multipart/form-data`. - :type files: dict - :param async_req bool: execute request asynchronously - :type async_req: bool, optional - :param _return_http_data_only: response data without head status code - and headers - :type _return_http_data_only: bool, optional - :param collection_formats: dict of collection formats for path, query, - header, and post parameters. - :type collection_formats: dict, optional - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :type _preload_content: bool, optional - :param _request_timeout: 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. - :param _check_type: boolean describing if the data back from the server - should have its type checked. - :type _check_type: bool, optional - :param _request_auths: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auths: list, optional - :return: - If async_req parameter is True, - the request will be called asynchronously. - The method will return the request thread. - If parameter async_req is False or missing, - then the method will return the response directly. - """ - if not async_req: - return self.__call_api(resource_path, method, - path_params, query_params, header_params, - body, post_params, files, - response_type, auth_settings, - _return_http_data_only, collection_formats, - _preload_content, _request_timeout, _host, - _check_type, _request_auths=_request_auths) - - return self.pool.apply_async(self.__call_api, (resource_path, - method, path_params, - query_params, - header_params, body, - post_params, files, - response_type, - auth_settings, - _return_http_data_only, - collection_formats, - _preload_content, - _request_timeout, - _host, _check_type, None, _request_auths)) - - def request(self, method, url, query_params=None, headers=None, - post_params=None, body=None, _preload_content=True, - _request_timeout=None): - """Makes the HTTP request using RESTClient.""" - if method == "GET": - return self.rest_client.GET(url, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - headers=headers) - elif method == "HEAD": - return self.rest_client.HEAD(url, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - headers=headers) - elif method == "OPTIONS": - return self.rest_client.OPTIONS(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "POST": - return self.rest_client.POST(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "PUT": - return self.rest_client.PUT(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "PATCH": - return self.rest_client.PATCH(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "DELETE": - return self.rest_client.DELETE(url, - query_params=query_params, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - else: - raise ApiValueError( - "http method must be `GET`, `HEAD`, `OPTIONS`," - " `POST`, `PATCH`, `PUT` or `DELETE`." - ) - - def parameters_to_tuples(self, params, collection_formats): - """Get parameters as list of tuples, formatting collections. - - :param params: Parameters as dict or list of two-tuples - :param dict collection_formats: Parameter collection formats - :return: Parameters as list of tuples, collections formatted - """ - new_params = [] - if collection_formats is None: - collection_formats = {} - for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 - if k in collection_formats: - collection_format = collection_formats[k] - if collection_format == 'multi': - new_params.extend((k, value) for value in v) - else: - if collection_format == 'ssv': - delimiter = ' ' - elif collection_format == 'tsv': - delimiter = '\t' - elif collection_format == 'pipes': - delimiter = '|' - else: # csv is the default - delimiter = ',' - new_params.append( - (k, delimiter.join(str(value) for value in v))) - else: - new_params.append((k, v)) - return new_params - - @staticmethod - def get_file_data_and_close_file(file_instance: io.IOBase) -> bytes: - file_data = file_instance.read() - file_instance.close() - return file_data - - def files_parameters(self, - files: typing.Optional[typing.Dict[str, - typing.List[io.IOBase]]] = None): - """Builds form parameters. - - :param files: None or a dict with key=param_name and - value is a list of open file objects - :return: List of tuples of form parameters with file data - """ - if files is None: - return [] - - params = [] - for param_name, file_instances in files.items(): - if file_instances is None: - # if the file field is nullable, skip None values - continue - for file_instance in file_instances: - if file_instance is None: - # if the file field is nullable, skip None values - continue - if file_instance.closed is True: - raise ApiValueError( - "Cannot read a closed file. The passed in file_type " - "for %s must be open." % param_name - ) - filename = os.path.basename(file_instance.name) - filedata = self.get_file_data_and_close_file(file_instance) - mimetype = (mimetypes.guess_type(filename)[0] or - 'application/octet-stream') - params.append( - tuple([param_name, tuple([filename, filedata, mimetype])])) - - return params - - def select_header_accept(self, accepts): - """Returns `Accept` based on an array of accepts provided. - - :param accepts: List of headers. - :return: Accept (e.g. application/json). - """ - if not accepts: - return - - accepts = [x.lower() for x in accepts] - - if 'application/json' in accepts: - return 'application/json' - else: - return ', '.join(accepts) - - def select_header_content_type(self, content_types, method=None, body=None): - """Returns `Content-Type` based on an array of content_types provided. - - :param content_types: List of content-types. - :param method: http method (e.g. POST, PATCH). - :param body: http body to send. - :return: Content-Type (e.g. application/json). - """ - if not content_types: - return None - - content_types = [x.lower() for x in content_types] - - if (method == 'PATCH' and - 'application/json-patch+json' in content_types and - isinstance(body, list)): - return 'application/json-patch+json' - - if 'application/json' in content_types or '*/*' in content_types: - return 'application/json' - else: - return content_types[0] - - def update_params_for_auth(self, headers, queries, auth_settings, - resource_path, method, body, request_auths=None): - """Updates header and query params based on authentication setting. - - :param headers: Header parameters dict to be updated. - :param queries: Query parameters tuple list to be updated. - :param auth_settings: Authentication setting identifiers list. - :param resource_path: A string representation of the HTTP request resource path. - :param method: A string representation of the HTTP request method. - :param body: A object representing the body of the HTTP request. - The object type is the return value of _encoder.default(). - :param request_auths: if set, the provided settings will - override the token in the configuration. - """ - if not auth_settings: - return - - if request_auths: - for auth_setting in request_auths: - self._apply_auth_params( - headers, queries, resource_path, method, body, auth_setting) - return - - for auth in auth_settings: - auth_setting = self.configuration.auth_settings().get(auth) - if auth_setting: - self._apply_auth_params( - headers, queries, resource_path, method, body, auth_setting) - - def _apply_auth_params(self, headers, queries, resource_path, method, body, auth_setting): - if auth_setting['in'] == 'cookie': - headers['Cookie'] = auth_setting['key'] + "=" + auth_setting['value'] - elif auth_setting['in'] == 'header': - if auth_setting['type'] != 'http-signature': - headers[auth_setting['key']] = auth_setting['value'] - elif auth_setting['in'] == 'query': - queries.append((auth_setting['key'], auth_setting['value'])) - else: - raise ApiValueError( - 'Authentication token must be in `query` or `header`' - ) - - -class Endpoint(object): - def __init__(self, settings=None, params_map=None, root_map=None, - headers_map=None, api_client=None, callable=None): - """Creates an endpoint - - Args: - settings (dict): see below key value pairs - 'response_type' (tuple/None): response type - 'auth' (list): a list of auth type keys - 'endpoint_path' (str): the endpoint path - 'operation_id' (str): endpoint string identifier - 'http_method' (str): POST/PUT/PATCH/GET etc - 'servers' (list): list of str servers that this endpoint is at - params_map (dict): see below key value pairs - 'all' (list): list of str endpoint parameter names - 'required' (list): list of required parameter names - 'nullable' (list): list of nullable parameter names - 'enum' (list): list of parameters with enum values - 'validation' (list): list of parameters with validations - root_map - 'validations' (dict): the dict mapping endpoint parameter tuple - paths to their validation dictionaries - 'allowed_values' (dict): the dict mapping endpoint parameter - tuple paths to their allowed_values (enum) dictionaries - 'openapi_types' (dict): param_name to openapi type - 'attribute_map' (dict): param_name to camelCase name - 'location_map' (dict): param_name to 'body', 'file', 'form', - 'header', 'path', 'query' - collection_format_map (dict): param_name to `csv` etc. - headers_map (dict): see below key value pairs - 'accept' (list): list of Accept header strings - 'content_type' (list): list of Content-Type header strings - api_client (ApiClient) api client instance - callable (function): the function which is invoked when the - Endpoint is called - """ - self.settings = settings - self.params_map = params_map - self.params_map['all'].extend([ - 'async_req', - '_host_index', - '_preload_content', - '_request_timeout', - '_return_http_data_only', - '_check_input_type', - '_check_return_type', - '_content_type', - '_spec_property_naming', - '_request_auths' - ]) - self.params_map['nullable'].extend(['_request_timeout']) - self.validations = root_map['validations'] - self.allowed_values = root_map['allowed_values'] - self.openapi_types = root_map['openapi_types'] - extra_types = { - 'async_req': (bool,), - '_host_index': (none_type, int), - '_preload_content': (bool,), - '_request_timeout': (none_type, float, (float,), [float], int, (int,), [int]), - '_return_http_data_only': (bool,), - '_check_input_type': (bool,), - '_check_return_type': (bool,), - '_spec_property_naming': (bool,), - '_content_type': (none_type, str), - '_request_auths': (none_type, list) - } - self.openapi_types.update(extra_types) - self.attribute_map = root_map['attribute_map'] - self.location_map = root_map['location_map'] - self.collection_format_map = root_map['collection_format_map'] - self.headers_map = headers_map - self.api_client = api_client - self.callable = callable - - def __validate_inputs(self, kwargs): - for param in self.params_map['enum']: - if param in kwargs: - check_allowed_values( - self.allowed_values, - (param,), - kwargs[param] - ) - - for param in self.params_map['validation']: - if param in kwargs: - check_validations( - self.validations, - (param,), - kwargs[param], - configuration=self.api_client.configuration - ) - - if kwargs['_check_input_type'] is False: - return - - for key, value in kwargs.items(): - fixed_val = validate_and_convert_types( - value, - self.openapi_types[key], - [key], - kwargs['_spec_property_naming'], - kwargs['_check_input_type'], - configuration=self.api_client.configuration - ) - kwargs[key] = fixed_val - - def __gather_params(self, kwargs): - params = { - 'body': None, - 'collection_format': {}, - 'file': {}, - 'form': [], - 'header': {}, - 'path': {}, - 'query': [] - } - - for param_name, param_value in kwargs.items(): - param_location = self.location_map.get(param_name) - if param_location is None: - continue - if param_location: - if param_location == 'body': - params['body'] = param_value - continue - base_name = self.attribute_map[param_name] - if (param_location == 'form' and - self.openapi_types[param_name] == (file_type,)): - params['file'][base_name] = [param_value] - elif (param_location == 'form' and - self.openapi_types[param_name] == ([file_type],)): - # param_value is already a list - params['file'][base_name] = param_value - elif param_location in {'form', 'query'}: - param_value_full = (base_name, param_value) - params[param_location].append(param_value_full) - if param_location not in {'form', 'query'}: - params[param_location][base_name] = param_value - collection_format = self.collection_format_map.get(param_name) - if collection_format: - params['collection_format'][base_name] = collection_format - - return params - - def __call__(self, *args, **kwargs): - """ This method is invoked when endpoints are called - Example: - - api_instance = AnalyticsApi() - api_instance.generate_async_campaigns_report # this is an instance of the class Endpoint - api_instance.generate_async_campaigns_report() # this invokes api_instance.generate_async_campaigns_report.__call__() - which then invokes the callable functions stored in that endpoint at - api_instance.generate_async_campaigns_report.callable or self.callable in this class - - """ - return self.callable(self, *args, **kwargs) - - def call_with_http_info(self, **kwargs): - - try: - index = self.api_client.configuration.server_operation_index.get( - self.settings['operation_id'], self.api_client.configuration.server_index - ) if kwargs['_host_index'] is None else kwargs['_host_index'] - server_variables = self.api_client.configuration.server_operation_variables.get( - self.settings['operation_id'], self.api_client.configuration.server_variables - ) - _host = self.api_client.configuration.get_host_from_settings( - index, variables=server_variables, servers=self.settings['servers'] - ) - except IndexError: - if self.settings['servers']: - raise ApiValueError( - "Invalid host index. Must be 0 <= index < %s" % - len(self.settings['servers']) - ) - _host = None - - for key, value in kwargs.items(): - if key not in self.params_map['all']: - raise ApiTypeError( - "Got an unexpected parameter '%s'" - " to method `%s`" % - (key, self.settings['operation_id']) - ) - # only throw this nullable ApiValueError if _check_input_type - # is False, if _check_input_type==True we catch this case - # in self.__validate_inputs - if (key not in self.params_map['nullable'] and value is None - and kwargs['_check_input_type'] is False): - raise ApiValueError( - "Value may not be None for non-nullable parameter `%s`" - " when calling `%s`" % - (key, self.settings['operation_id']) - ) - - for key in self.params_map['required']: - if key not in kwargs.keys(): - raise ApiValueError( - "Missing the required parameter `%s` when calling " - "`%s`" % (key, self.settings['operation_id']) - ) - - self.__validate_inputs(kwargs) - - params = self.__gather_params(kwargs) - - accept_headers_list = self.headers_map['accept'] - if accept_headers_list: - params['header']['Accept'] = self.api_client.select_header_accept( - accept_headers_list) - - if kwargs.get('_content_type'): - params['header']['Content-Type'] = kwargs['_content_type'] - else: - content_type_headers_list = self.headers_map['content_type'] - if content_type_headers_list: - if params['body'] != "": - content_types_list = self.api_client.select_header_content_type( - content_type_headers_list, self.settings['http_method'], - params['body']) - if content_types_list: - params['header']['Content-Type'] = content_types_list - - return self.api_client.call_api( - self.settings['endpoint_path'], self.settings['http_method'], - params['path'], - params['query'], - params['header'], - body=params['body'], - post_params=params['form'], - files=params['file'], - response_type=self.settings['response_type'], - auth_settings=self.settings['auth'], - async_req=kwargs['async_req'], - _check_type=kwargs['_check_return_type'], - _return_http_data_only=kwargs['_return_http_data_only'], - _preload_content=kwargs['_preload_content'], - _request_timeout=kwargs['_request_timeout'], - _host=_host, - _request_auths=kwargs['_request_auths'], - collection_formats=params['collection_format']) diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api_client_builder.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api_client_builder.py deleted file mode 100644 index d7dde0b5..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/api_client_builder.py +++ /dev/null @@ -1,37 +0,0 @@ -from criteo_api_retailmedia_v2023_01.configuration import Configuration -from criteo_api_retailmedia_v2023_01.criteo_api_client import CriteoApiClient -from criteo_api_retailmedia_v2023_01 import flow_constants - -class ApiClientBuilder : - - @staticmethod - def WithClientCredentials(clientId, clientSecret, host=None): - configuration = Configuration(username=clientId, password=clientSecret, host=host) - - return CriteoApiClient(configuration) - - @staticmethod - def WithNoAuthorization(): - - return CriteoApiClient() - - @staticmethod - def WithAuthorizationCode(clientId, clientSecret, authorization_code, redirect_uri, host=None): - configuration = Configuration(username=clientId, password=clientSecret, host=host) - additional_parameters = { - 'flow' : flow_constants.AUTHORIZATION_CODE_FLOW, - 'authorization_code': authorization_code, - 'redirect_uri': redirect_uri - } - - return CriteoApiClient(configuration = configuration, additional_parameters = additional_parameters) - - @staticmethod - def WithRefreshToken(clientId, clientSecret, refreshToken, host=None): - configuration = Configuration(username=clientId, password=clientSecret, host=host) - additional_parameters = { - 'flow' : flow_constants.REFRESH_TOKEN_FLOW, - 'refresh_token': refreshToken - } - - return CriteoApiClient(configuration = configuration, additional_parameters = additional_parameters) \ No newline at end of file diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/apis/__init__.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/apis/__init__.py deleted file mode 100644 index 9fef11f2..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/apis/__init__.py +++ /dev/null @@ -1,20 +0,0 @@ - -# flake8: noqa - -# Import all APIs into this package. -# If you have many APIs here with many many models used in each API this may -# raise a `RecursionError`. -# In order to avoid this, import only the API that you directly need like: -# -# from criteo_api_retailmedia_v2023_01.api.analytics_api import AnalyticsApi -# -# or import this package, but before doing it, use: -# -# import sys -# sys.setrecursionlimit(n) - -# Import APIs into API package: -from criteo_api_retailmedia_v2023_01.api.analytics_api import AnalyticsApi -from criteo_api_retailmedia_v2023_01.api.audience_api import AudienceApi -from criteo_api_retailmedia_v2023_01.api.campaign_api import CampaignApi -from criteo_api_retailmedia_v2023_01.api.gateway_api import GatewayApi 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 deleted file mode 100644 index fcf0cc75..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/configuration.py +++ /dev/null @@ -1,461 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import copy -import logging -import multiprocessing -import sys -import urllib3 - -from http import client as http_client -from criteo_api_retailmedia_v2023_01.exceptions import ApiValueError - - -JSON_SCHEMA_VALIDATION_KEYWORDS = { - 'multipleOf', 'maximum', 'exclusiveMaximum', - 'minimum', 'exclusiveMinimum', 'maxLength', - 'minLength', 'pattern', 'maxItems', 'minItems' -} - -class Configuration(object): - """NOTE: This class is auto generated by OpenAPI Generator - - Ref: https://openapi-generator.tech - Do not edit the class manually. - - :param host: Base url - :param api_key: Dict to store API key(s). - Each entry in the dict specifies an API key. - The dict key is the name of the security scheme in the OAS specification. - The dict value is the API key secret. - :param api_key_prefix: Dict to store API prefix (e.g. Bearer) - The dict key is the name of the security scheme in the OAS specification. - The dict value is an API key prefix when generating the auth data. - :param username: Username for HTTP basic authentication - :param password: Password for HTTP basic authentication - :param discard_unknown_keys: Boolean value indicating whether to discard - unknown properties. A server may send a response that includes additional - properties that are not known by the client in the following scenarios: - 1. The OpenAPI document is incomplete, i.e. it does not match the server - implementation. - 2. The client was generated using an older version of the OpenAPI document - and the server has been upgraded since then. - If a schema in the OpenAPI document defines the additionalProperties attribute, - then all undeclared properties received by the server are injected into the - additional properties map. In that case, there are undeclared properties, and - nothing to discard. - :param disabled_client_side_validations (string): Comma-separated list of - JSON schema validation keywords to disable JSON schema structural validation - rules. The following keywords may be specified: multipleOf, maximum, - exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, - maxItems, minItems. - By default, the validation is performed for data generated locally by the client - and data received from the server, independent of any validation performed by - the server side. If the input data does not satisfy the JSON schema validation - rules specified in the OpenAPI document, an exception is raised. - If disabled_client_side_validations is set, structural validation is - disabled. This can be useful to troubleshoot data validation problem, such as - when the OpenAPI document validation rules do not match the actual API data - received by the server. - :param server_index: Index to servers configuration. - :param server_variables: Mapping with string values to replace variables in - templated server configuration. The validation of enums is performed for - variables with defined enum values before. - :param server_operation_index: Mapping from operation ID to an index to server - configuration. - :param server_operation_variables: Mapping from operation ID to a mapping with - string values to replace variables in templated server configuration. - The validation of enums is performed for variables with defined enum values before. - :param ssl_ca_cert: str - the path to a file of concatenated CA certificates - in PEM format - - :Example: - """ - - _default = None - - def __init__(self, host=None, - api_key=None, api_key_prefix=None, - access_token=None, - username=None, password=None, - discard_unknown_keys=False, - disabled_client_side_validations="", - server_index=None, server_variables=None, - server_operation_index=None, server_operation_variables=None, - ssl_ca_cert=None, - ): - """Constructor - """ - self._base_path = "https://api.criteo.com" if host is None else host - """Default Base url - """ - self.server_index = 0 if server_index is None and host is None else server_index - self.server_operation_index = server_operation_index or {} - """Default server index - """ - self.server_variables = server_variables or {} - self.server_operation_variables = server_operation_variables or {} - """Default server variables - """ - self.temp_folder_path = None - """Temp file folder for downloading files - """ - # Authentication Settings - self.access_token = access_token - self.api_key = {} - if api_key: - self.api_key = api_key - """dict to store API key(s) - """ - self.api_key_prefix = {} - if api_key_prefix: - self.api_key_prefix = api_key_prefix - """dict to store API prefix (e.g. Bearer) - """ - self.refresh_api_key_hook = None - """function hook to refresh API key if expired - """ - self.username = username - """Username for HTTP basic authentication - """ - self.password = password - """Password for HTTP basic authentication - """ - self.discard_unknown_keys = discard_unknown_keys - self.disabled_client_side_validations = disabled_client_side_validations - self.logger = {} - """Logging Settings - """ - self.logger["package_logger"] = logging.getLogger("criteo_api_retailmedia_v2023_01") - self.logger["urllib3_logger"] = logging.getLogger("urllib3") - self.logger_format = '%(asctime)s %(levelname)s %(message)s' - """Log format - """ - self.logger_stream_handler = None - """Log stream handler - """ - self.logger_file_handler = None - """Log file handler - """ - self.logger_file = None - """Debug file location - """ - self.debug = False - """Debug switch - """ - - self.verify_ssl = True - """SSL/TLS verification - Set this to false to skip verifying SSL certificate when calling API - from https server. - """ - self.ssl_ca_cert = ssl_ca_cert - """Set this to customize the certificate file to verify the peer. - """ - self.cert_file = None - """client certificate file - """ - self.key_file = None - """client key file - """ - self.assert_hostname = None - """Set this to True/False to enable/disable SSL hostname verification. - """ - - self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 - """urllib3 connection pool's maximum number of connections saved - per pool. urllib3 uses 1 connection as default value, but this is - not the best value when you are making a lot of possibly parallel - requests to the same host, which is often the case here. - cpu_count * 5 is used as default value to increase performance. - """ - - self.proxy = None - """Proxy URL - """ - self.no_proxy = None - """bypass proxy for host in the no_proxy list. - """ - self.proxy_headers = None - """Proxy headers - """ - self.safe_chars_for_path_param = '' - """Safe chars for path_param - """ - self.retries = None - """Adding retries to override urllib3 default value 3 - """ - # Enable client side validation - self.client_side_validation = True - - # Options to pass down to the underlying urllib3 socket - self.socket_options = None - - def __deepcopy__(self, memo): - cls = self.__class__ - result = cls.__new__(cls) - memo[id(self)] = result - for k, v in self.__dict__.items(): - if k not in ('logger', 'logger_file_handler'): - setattr(result, k, copy.deepcopy(v, memo)) - # shallow copy of loggers - result.logger = copy.copy(self.logger) - # use setters to configure loggers - result.logger_file = self.logger_file - result.debug = self.debug - return result - - def __setattr__(self, name, value): - object.__setattr__(self, name, value) - if name == 'disabled_client_side_validations': - s = set(filter(None, value.split(','))) - for v in s: - if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: - raise ApiValueError( - "Invalid keyword: '{0}''".format(v)) - self._disabled_client_side_validations = s - - @classmethod - def set_default(cls, default): - """Set default instance of configuration. - - It stores default configuration, which can be - returned by get_default_copy method. - - :param default: object of Configuration - """ - cls._default = copy.deepcopy(default) - - @classmethod - def get_default_copy(cls): - """Return new instance of configuration. - - This method returns newly created, based on default constructor, - object of Configuration class or returns a copy of default - configuration passed by the set_default method. - - :return: The configuration object. - """ - if cls._default is not None: - return copy.deepcopy(cls._default) - return Configuration() - - @property - def logger_file(self): - """The logger file. - - If the logger_file is None, then add stream handler and remove file - handler. Otherwise, add file handler and remove stream handler. - - :param value: The logger_file path. - :type: str - """ - return self.__logger_file - - @logger_file.setter - def logger_file(self, value): - """The logger file. - - If the logger_file is None, then add stream handler and remove file - handler. Otherwise, add file handler and remove stream handler. - - :param value: The logger_file path. - :type: str - """ - self.__logger_file = value - if self.__logger_file: - # If set logging file, - # then add file handler and remove stream handler. - self.logger_file_handler = logging.FileHandler(self.__logger_file) - self.logger_file_handler.setFormatter(self.logger_formatter) - for _, logger in self.logger.items(): - logger.addHandler(self.logger_file_handler) - - @property - def debug(self): - """Debug status - - :param value: The debug status, True or False. - :type: bool - """ - return self.__debug - - @debug.setter - def debug(self, value): - """Debug status - - :param value: The debug status, True or False. - :type: bool - """ - self.__debug = value - if self.__debug: - # if debug status is True, turn on debug logging - for _, logger in self.logger.items(): - logger.setLevel(logging.DEBUG) - # turn on http_client debug - http_client.HTTPConnection.debuglevel = 1 - else: - # if debug status is False, turn off debug logging, - # setting log level to default `logging.WARNING` - for _, logger in self.logger.items(): - logger.setLevel(logging.WARNING) - # turn off http_client debug - http_client.HTTPConnection.debuglevel = 0 - - @property - def logger_format(self): - """The logger format. - - The logger_formatter will be updated when sets logger_format. - - :param value: The format string. - :type: str - """ - return self.__logger_format - - @logger_format.setter - def logger_format(self, value): - """The logger format. - - The logger_formatter will be updated when sets logger_format. - - :param value: The format string. - :type: str - """ - self.__logger_format = value - self.logger_formatter = logging.Formatter(self.__logger_format) - - def get_api_key_with_prefix(self, identifier, alias=None): - """Gets API key (with prefix if set). - - :param identifier: The identifier of apiKey. - :param alias: The alternative identifier of apiKey. - :return: The token for api key authentication. - """ - if self.refresh_api_key_hook is not None: - self.refresh_api_key_hook(self) - key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) - if key: - prefix = self.api_key_prefix.get(identifier) - if prefix: - return "%s %s" % (prefix, key) - else: - return key - - def get_basic_auth_token(self): - """Gets HTTP basic authentication header (string). - - :return: The token for basic HTTP authentication. - """ - username = "" - if self.username is not None: - username = self.username - password = "" - if self.password is not None: - password = self.password - return urllib3.util.make_headers( - basic_auth=username + ':' + password - ).get('authorization') - - def auth_settings(self): - """Gets Auth Settings dict for api client. - - :return: The Auth Settings information dict. - """ - auth = {} - if self.access_token is not None: - auth['oauth'] = { - 'type': 'oauth2', - 'in': 'header', - 'key': 'Authorization', - 'value': 'Bearer ' + self.access_token - } - if self.access_token is not None: - auth['oauth'] = { - 'type': 'oauth2', - 'in': 'header', - 'key': 'Authorization', - 'value': 'Bearer ' + self.access_token - } - return auth - - def to_debug_report(self): - """Gets the essential information for debugging. - - :return: The report for debugging. - """ - return "Python SDK Debug Report:\n"\ - "OS: {env}\n"\ - "Python Version: {pyversion}\n"\ - "Version of the API: 2023-01\n"\ - "SDK Package Version: 2023.01.0.240404".\ - format(env=sys.platform, pyversion=sys.version) - - def get_host_settings(self): - """Gets an array of host settings - - :return: An array of host settings - """ - return [ - { - 'url': "https://api.criteo.com", - 'description': "No description provided", - } - ] - - def get_host_from_settings(self, index, variables=None, servers=None): - """Gets host URL based on the index and variables - :param index: array index of the host settings - :param variables: hash of variable and the corresponding value - :param servers: an array of host settings or None - :return: URL based on host settings - """ - if index is None: - return self._base_path - - variables = {} if variables is None else variables - servers = self.get_host_settings() if servers is None else servers - - try: - server = servers[index] - except IndexError: - raise ValueError( - "Invalid index {0} when selecting the host settings. " - "Must be less than {1}".format(index, len(servers))) - - url = server['url'] - - # go through variables and replace placeholders - for variable_name, variable in server.get('variables', {}).items(): - used_value = variables.get( - variable_name, variable['default_value']) - - if 'enum_values' in variable \ - and used_value not in variable['enum_values']: - raise ValueError( - "The variable `{0}` in the host URL has invalid value " - "{1}. Must be {2}.".format( - variable_name, variables[variable_name], - variable['enum_values'])) - - url = url.replace("{" + variable_name + "}", used_value) - - return url - - @property - def host(self): - """Return generated host.""" - return self.get_host_from_settings(self.server_index, variables=self.server_variables) - - @host.setter - def host(self, value): - """Fix base path.""" - self._base_path = value - self.server_index = None diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_api_client.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_api_client.py deleted file mode 100644 index d46185cd..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_api_client.py +++ /dev/null @@ -1,11 +0,0 @@ -from criteo_api_retailmedia_v2023_01.api_client import ApiClient -from criteo_api_retailmedia_v2023_01.criteo_rest import CriteoRESTClientObject - -class CriteoApiClient(ApiClient): - def __init__(self, configuration=None, header_name=None, header_value=None, - cookie=None, pool_threads=1, additional_parameters= {}): - super().__init__(configuration=configuration,header_name=header_name, header_value=header_value, cookie=cookie, pool_threads=pool_threads) - self.rest_client = CriteoRESTClientObject(self.configuration, additional_parameters) - - def get_refresh_token(self): - return self.rest_client.get_refresh_token() \ No newline at end of file diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_auth.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_auth.py deleted file mode 100644 index 482ac02c..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_auth.py +++ /dev/null @@ -1,121 +0,0 @@ -import json -from datetime import datetime, timedelta -from criteo_api_retailmedia_v2023_01.exceptions import ApiException -from criteo_api_retailmedia_v2023_01.api_client import ApiClient -from criteo_api_retailmedia_v2023_01 import flow_constants - -class Token(object): - - def __init__(self, token_string , expiration_date = None): - self.expiration_date = expiration_date - self.token_string = token_string - - def has_expired(self): - if not self.expiration_date: - return False - return self.expiration_date > datetime.utcnow() - -class BasicAuth(object): - - def __init__(self, token_string): - self.token = Token(token_string) - - def get_token(self, client : ApiClient, headers) -> str: - return self.token - -class RetryingOAuth(object): - - def __init__(self, grant_type, client_id, client_secret): - self.grant_type = grant_type - self.client_id = client_id - self.client_secret = client_secret - self.token = None - self.refreshToken = None - - def get_token(self, client : ApiClient, headers) -> str: - if self.token and not self.token.has_expired(): - self.token = None - if self.grant_type == flow_constants.AUTHORIZATION_CODE_FLOW: - self.grant_type = flow_constants.REFRESH_TOKEN_FLOW - - if self.token is None: - self.refresh_token(client, headers) - - return self.token - - def refresh_token(self, client : ApiClient, headers, parameters_dict= {}): - oauth_url = client.host + '/oauth2/token' - new_headers = {'Accept': 'application/json', - 'Content-Type': 'application/x-www-form-urlencoded', - 'User-Agent': headers['User-Agent']} - params = dict(parameters_dict, **{ - 'client_id': self.client_id, - 'client_secret': self.client_secret, - 'grant_type' : self.grant_type - }) - try: - if self.grant_type == flow_constants.REFRESH_TOKEN_FLOW: - params['refresh_token'] = self.refreshToken - - response = client.request('POST', oauth_url, - headers=new_headers, - query_params=[], - post_params=list(params.items()), - _preload_content=True, - _request_timeout=None, - body=None, - no_auth=True) - data = json.loads(response.data) - self.token = Token('Bearer '+ (data['access_token'] or ''), - RetryingOAuth.compute_expiration_date(data['expires_in'])) - self.refreshToken = data['refresh_token'] - - return self.token - except ApiException as e: - raise self._enrich_exception_message(e, oauth_url) - - def get_refresh_token(self): - return self.refreshToken - - def _enrich_exception_message(self, e, url): - try: - data = json.loads(e.body or {}) - except ValueError: - data = {} - data['token_error'] = "Cannot refresh token by calling '" + url + "'" - e.body = json.dumps(data).encode() - return e - - @staticmethod - def compute_expiration_date(expires_in): - return datetime.utcnow() + timedelta(seconds=int(expires_in) + 15) - -class RetryingClientCredentials(RetryingOAuth): - - def __init__(self, client_id, client_secret): - super().__init__(flow_constants.CLIENT_CREDENTIALS_FLOW, client_id, client_secret) - -class RetryingAuthorizationCode(RetryingOAuth): - def __init__(self, client_id, client_secret, code, redirect_uri): - super().__init__(flow_constants.AUTHORIZATION_CODE_FLOW, client_id, client_secret) - self.authorization_code = code - self.redirect_uri = redirect_uri - - def refresh_token(self, client : ApiClient, headers, parameters_dict= {}): - params = dict(parameters_dict, **{ - 'code' : self.authorization_code, - 'redirect_uri' : self.redirect_uri - }) - return super().refresh_token(client, headers, params) - -class RetryingRefreshToken(RetryingOAuth): - - def __init__(self, client_id, client_secret, refresh_token): - super().__init__(flow_constants.REFRESH_TOKEN_FLOW, client_id, client_secret) - self.refreshToken = refresh_token - - def refresh_token(self, client: ApiClient, headers, parameters_dict = {}): - params = dict(parameters_dict, **{ - 'refresh_token' : self.refreshToken - }) - return super().refresh_token(client, headers,params) diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_rest.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_rest.py deleted file mode 100644 index 651afe7d..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/criteo_rest.py +++ /dev/null @@ -1,75 +0,0 @@ -from criteo_api_retailmedia_v2023_01.rest import RESTClientObject -from criteo_api_retailmedia_v2023_01.criteo_auth import * -from criteo_api_retailmedia_v2023_01 import flow_constants - - -class CriteoRESTClientObject(RESTClientObject): - - def __init__(self, configuration, additional_parameters = {}, pools_size=4, maxsize=None): - super().__init__(configuration, pools_size, maxsize) - - self.host = configuration.host - client_id = configuration.username - client_secret = configuration.password - - grant_type = additional_parameters.get('flow', 'client_credentials') - if grant_type == flow_constants.AUTHORIZATION_CODE_FLOW : - self.authorization = RetryingAuthorizationCode( - client_id, - client_secret, - additional_parameters.get('authorization_code',''), - additional_parameters.get('redirect_uri','') - ) - elif grant_type == flow_constants.REFRESH_TOKEN_FLOW : - self.authorization = RetryingRefreshToken( - client_id, - client_secret, - additional_parameters.get('refresh_token', '') - ) - else: - self.authorization = RetryingClientCredentials( - client_id, - client_secret - ) - - def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None, _preload_content=True, - _request_timeout=None): - return self.request(method, url, query_params, headers, body,post_params, _preload_content, _request_timeout, no_auth=False) - - def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None, _preload_content=True, - _request_timeout=None, no_auth=False): - """Perform requests. - - :param method: http request method - :param url: http request url - :param query_params: query parameters in the url - :param headers: http request headers - :param body: request json body, for `application/json` - :param post_params: request post parameters, - `application/x-www-form-urlencoded` - and `multipart/form-data` - :param no_auth: if True, token is not refreshed - and authorization header is not set - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: 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. - """ - - headers = headers or {} - if not no_auth: - token = self.authorization.get_token(self, headers) - headers['Authorization'] = token.token_string - - if 'Content-Type' not in headers: - headers['Content-Type'] = 'application/json' - - return super().request(method, url, query_params, headers, body, post_params, _preload_content, _request_timeout) - - def get_refresh_token(self): - return self.authorization.get_refresh_token() \ No newline at end of file diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/exceptions.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/exceptions.py deleted file mode 100644 index 4fe7842b..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/exceptions.py +++ /dev/null @@ -1,158 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -class OpenApiException(Exception): - """The base exception class for all OpenAPIExceptions""" - - -class ApiTypeError(OpenApiException, TypeError): - def __init__(self, msg, path_to_item=None, valid_classes=None, - key_type=None): - """ Raises an exception for TypeErrors - - Args: - msg (str): the exception message - - Keyword Args: - path_to_item (list): a list of keys an indices to get to the - current_item - None if unset - valid_classes (tuple): the primitive classes that current item - should be an instance of - None if unset - key_type (bool): False if our value is a value in a dict - True if it is a key in a dict - False if our item is an item in a list - None if unset - """ - self.path_to_item = path_to_item - self.valid_classes = valid_classes - self.key_type = key_type - full_msg = msg - if path_to_item: - full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) - super(ApiTypeError, self).__init__(full_msg) - - -class ApiValueError(OpenApiException, ValueError): - def __init__(self, msg, path_to_item=None): - """ - Args: - msg (str): the exception message - - Keyword Args: - path_to_item (list) the path to the exception in the - received_data dict. None if unset - """ - - self.path_to_item = path_to_item - full_msg = msg - if path_to_item: - full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) - super(ApiValueError, self).__init__(full_msg) - - -class ApiAttributeError(OpenApiException, AttributeError): - def __init__(self, msg, path_to_item=None): - """ - Raised when an attribute reference or assignment fails. - - Args: - msg (str): the exception message - - Keyword Args: - path_to_item (None/list) the path to the exception in the - received_data dict - """ - self.path_to_item = path_to_item - full_msg = msg - if path_to_item: - full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) - super(ApiAttributeError, self).__init__(full_msg) - - -class ApiKeyError(OpenApiException, KeyError): - def __init__(self, msg, path_to_item=None): - """ - Args: - msg (str): the exception message - - Keyword Args: - path_to_item (None/list) the path to the exception in the - received_data dict - """ - self.path_to_item = path_to_item - full_msg = msg - if path_to_item: - full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) - super(ApiKeyError, self).__init__(full_msg) - - -class ApiException(OpenApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - if http_resp: - self.status = http_resp.status - self.reason = http_resp.reason - self.body = http_resp.data - self.headers = http_resp.getheaders() - else: - self.status = status - self.reason = reason - self.body = None - self.headers = None - - def __str__(self): - """Custom error messages for exception""" - error_message = "Status Code: {0}\n"\ - "Reason: {1}\n".format(self.status, self.reason) - if self.headers: - error_message += "HTTP response headers: {0}\n".format( - self.headers) - - if self.body: - error_message += "HTTP response body: {0}\n".format(self.body) - - return error_message - - -class NotFoundException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(NotFoundException, self).__init__(status, reason, http_resp) - - -class UnauthorizedException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(UnauthorizedException, self).__init__(status, reason, http_resp) - - -class ForbiddenException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(ForbiddenException, self).__init__(status, reason, http_resp) - - -class ServiceException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None): - super(ServiceException, self).__init__(status, reason, http_resp) - - -def render_path(path_to_item): - """Returns a string representation of a path""" - result = "" - for pth in path_to_item: - if isinstance(pth, int): - result += "[{0}]".format(pth) - else: - result += "['{0}']".format(pth) - return result diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/__init__.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/__init__.py deleted file mode 100644 index 0addc592..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -# we can not import model classes here because that would create a circular -# reference which would not work in python2 -# do not import all models into this module because that uses a lot of memory and stack frames -# if you need the ability to import all models from one package, import them with -# from criteo_api_retailmedia_v2023_01.models import ModelA, ModelB diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model.py deleted file mode 100644 index 636d3c1d..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - - -class ApplicationSummaryModel(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 { - 'application_id': (int, none_type,), # noqa: E501 - 'name': (str, none_type,), # noqa: E501 - 'organization_id': (int, none_type,), # noqa: E501 - 'description': (str, none_type,), # noqa: E501 - 'criteo_service': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'application_id': 'applicationId', # noqa: E501 - 'name': 'name', # noqa: E501 - 'organization_id': 'organizationId', # noqa: E501 - 'description': 'description', # noqa: E501 - 'criteo_service': 'criteoService', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ApplicationSummaryModel - 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,) - application_id (int, none_type): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - organization_id (int, none_type): [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - criteo_service (str, 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 - """ApplicationSummaryModel - 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,) - application_id (int, none_type): [optional] # noqa: E501 - name (str, none_type): [optional] # noqa: E501 - organization_id (int, none_type): [optional] # noqa: E501 - description (str, none_type): [optional] # noqa: E501 - criteo_service (str, 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_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model_resource.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model_resource.py deleted file mode 100644 index 91b3039f..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model_resource.py +++ /dev/null @@ -1,273 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.application_summary_model import ApplicationSummaryModel - globals()['ApplicationSummaryModel'] = ApplicationSummaryModel - - -class ApplicationSummaryModelResource(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': (ApplicationSummaryModel,), # 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 - """ApplicationSummaryModelResource - 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 (ApplicationSummaryModel): [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 - """ApplicationSummaryModelResource - 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 (ApplicationSummaryModel): [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_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model_response.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model_response.py deleted file mode 100644 index 1a63959c..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/application_summary_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.application_summary_model_resource import ApplicationSummaryModelResource - from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem - globals()['ApplicationSummaryModelResource'] = ApplicationSummaryModelResource - globals()['CommonProblem'] = CommonProblem - - -class ApplicationSummaryModelResponse(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 = { - ('warnings',): { - }, - ('errors',): { - }, - } - - @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': (ApplicationSummaryModelResource,), # noqa: E501 - 'warnings': ([CommonProblem], none_type,), # noqa: E501 - 'errors': ([CommonProblem], none_type,), # 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 - """ApplicationSummaryModelResponse - 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 (ApplicationSummaryModelResource): [optional] # noqa: E501 - warnings ([CommonProblem], none_type): [optional] # noqa: E501 - errors ([CommonProblem], 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 - """ApplicationSummaryModelResponse - 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 (ApplicationSummaryModelResource): [optional] # noqa: E501 - warnings ([CommonProblem], none_type): [optional] # noqa: E501 - errors ([CommonProblem], 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_2023-01/criteo_api_retailmedia_v2023_01/model/balance202110_paged_list_response.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/balance202110_paged_list_response.py deleted file mode 100644 index 911c730c..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/balance202110_paged_list_response.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_balance202110 import ResourceOfBalance202110 - globals()['PageMetadata'] = PageMetadata - globals()['ProblemDetails'] = ProblemDetails - globals()['ResourceOfBalance202110'] = ResourceOfBalance202110 - - -class Balance202110PagedListResponse(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 { - 'metadata': (PageMetadata,), # noqa: E501 - 'data': ([ResourceOfBalance202110],), # noqa: E501 - 'warnings': ([ProblemDetails],), # noqa: E501 - 'errors': ([ProblemDetails],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'metadata': 'metadata', # noqa: E501 - '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 - """Balance202110PagedListResponse - 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,) - metadata (PageMetadata): [optional] # noqa: E501 - data ([ResourceOfBalance202110]): [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 - """Balance202110PagedListResponse - 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,) - metadata (PageMetadata): [optional] # noqa: E501 - data ([ResourceOfBalance202110]): [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_2023-01/criteo_api_retailmedia_v2023_01/model/common_problem.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_problem.py deleted file mode 100644 index 1e630462..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_problem.py +++ /dev/null @@ -1,306 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - - -class CommonProblem(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 = { - ('type',): { - 'None': None, - 'UNKNOWN': "unknown", - 'ACCESS-CONTROL': "access-control", - 'AUTHENTICATION': "authentication", - 'AUTHORIZATION': "authorization", - 'AVAILABILITY': "availability", - 'DEPRECATION': "deprecation", - 'QUOTA': "quota", - 'VALIDATION': "validation", - }, - } - - 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, none_type,), # noqa: E501 - 'trace_identifier': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'code': (str, none_type,), # noqa: E501 - 'instance': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'source': ({str: (str,)}, none_type,), # noqa: E501 - 'stack_trace': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_id': 'traceId', # noqa: E501 - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'type': 'type', # noqa: E501 - 'code': 'code', # noqa: E501 - 'instance': 'instance', # noqa: E501 - 'title': 'title', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CommonProblem - 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,) - trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 - trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 - type (str, none_type): The problem's category.. [optional] # noqa: E501 - code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 - instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 - detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace (str, 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 - """CommonProblem - 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,) - trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 - trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 - type (str, none_type): The problem's category.. [optional] # noqa: E501 - code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 - instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 - title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 - detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace (str, 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_2023-01/criteo_api_retailmedia_v2023_01/model/external_balance202110.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_balance202110.py deleted file mode 100644 index 434f4579..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_balance202110.py +++ /dev/null @@ -1,333 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - - -class ExternalBalance202110(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 = { - ('status',): { - 'UNKNOWN': "unknown", - 'SCHEDULED': "scheduled", - 'ACTIVE': "active", - 'ENDED': "ended", - }, - } - - 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,), # noqa: E501 - 'po_number': (str,), # noqa: E501 - 'memo': (str,), # noqa: E501 - 'deposited': (float, none_type,), # noqa: E501 - 'spent': (float, none_type,), # noqa: E501 - 'remaining': (float, none_type,), # noqa: E501 - 'start_date': (date,), # noqa: E501 - 'status': (str,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 - 'updated_at': (datetime,), # noqa: E501 - 'end_date': (date, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'po_number': 'poNumber', # noqa: E501 - 'memo': 'memo', # noqa: E501 - 'deposited': 'deposited', # noqa: E501 - 'spent': 'spent', # noqa: E501 - 'remaining': 'remaining', # noqa: E501 - 'start_date': 'startDate', # noqa: E501 - 'status': 'status', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - 'end_date': 'endDate', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, name, po_number, memo, deposited, spent, remaining, start_date, status, created_at, updated_at, *args, **kwargs): # noqa: E501 - """ExternalBalance202110 - a model defined in OpenAPI - - Args: - name (str): - po_number (str): - memo (str): - deposited (float, none_type): - spent (float, none_type): - remaining (float, none_type): - start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD - status (str): - created_at (datetime): - updated_at (datetime): - - 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,) - end_date (date, none_type): Represents the Date as a year, month, and day in the format YYYY-MM-DD. [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.name = name - self.po_number = po_number - self.memo = memo - self.deposited = deposited - self.spent = spent - self.remaining = remaining - self.start_date = start_date - self.status = status - self.created_at = created_at - self.updated_at = updated_at - 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, name, po_number, memo, deposited, spent, remaining, start_date, status, created_at, updated_at, *args, **kwargs): # noqa: E501 - """ExternalBalance202110 - a model defined in OpenAPI - - Args: - name (str): - po_number (str): - memo (str): - deposited (float, none_type): - spent (float, none_type): - remaining (float, none_type): - start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD - status (str): - created_at (datetime): - updated_at (datetime): - - 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,) - end_date (date, none_type): Represents the Date as a year, month, and day in the format YYYY-MM-DD. [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.name = name - self.po_number = po_number - self.memo = memo - self.deposited = deposited - self.spent = spent - self.remaining = remaining - self.start_date = start_date - self.status = status - self.created_at = created_at - self.updated_at = updated_at - 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_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py deleted file mode 100644 index 7b8d939c..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers import LineItemBidMultipliers - globals()['LineItemBidMultipliers'] = LineItemBidMultipliers - - -class JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers(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 { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (LineItemBidMultipliers,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - '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, id, type, *args, **kwargs): # noqa: E501 - """JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - a model defined in OpenAPI - - Args: - id (str): - type (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,) - attributes (LineItemBidMultipliers): [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.id = id - 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 \ - 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, type, *args, **kwargs): # noqa: E501 - """JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - a model defined in OpenAPI - - Args: - id (str): - type (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,) - attributes (LineItemBidMultipliers): [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.id = id - 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 \ - 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_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_line_item_bid_multipliers.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_line_item_bid_multipliers.py deleted file mode 100644 index fd0d2812..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_line_item_bid_multipliers.py +++ /dev/null @@ -1,287 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_error import CommonError - from criteo_api_retailmedia_v2023_01.model.common_warning import CommonWarning - from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers import JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - globals()['CommonError'] = CommonError - globals()['CommonWarning'] = CommonWarning - globals()['JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers'] = JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - - -class JsonApiSingleResponseOfLineItemBidMultipliers(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': (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers,), # 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 - """JsonApiSingleResponseOfLineItemBidMultipliers - a model defined in OpenAPI - - Args: - data (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers): - - 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 - """JsonApiSingleResponseOfLineItemBidMultipliers - a model defined in OpenAPI - - Args: - data (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers): - - 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_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers.py deleted file mode 100644 index 8ca022bf..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers.py +++ /dev/null @@ -1,291 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - - -class LineItemBidMultipliers(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 { - 'search': (float,), # noqa: E501 - 'homepage': (float,), # noqa: E501 - 'categories': (float,), # noqa: E501 - 'product_detail': (float,), # noqa: E501 - 'confirmation': (float,), # noqa: E501 - 'merchandising': (float,), # noqa: E501 - 'deals': (float,), # noqa: E501 - 'checkout': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'search': 'search', # noqa: E501 - 'homepage': 'homepage', # noqa: E501 - 'categories': 'categories', # noqa: E501 - 'product_detail': 'productDetail', # noqa: E501 - 'confirmation': 'confirmation', # noqa: E501 - 'merchandising': 'merchandising', # noqa: E501 - 'deals': 'deals', # noqa: E501 - 'checkout': 'checkout', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """LineItemBidMultipliers - 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,) - search (float): [optional] # noqa: E501 - homepage (float): [optional] # noqa: E501 - categories (float): [optional] # noqa: E501 - product_detail (float): [optional] # noqa: E501 - confirmation (float): [optional] # noqa: E501 - merchandising (float): [optional] # noqa: E501 - deals (float): [optional] # noqa: E501 - checkout (float): [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 - """LineItemBidMultipliers - 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,) - search (float): [optional] # noqa: E501 - homepage (float): [optional] # noqa: E501 - categories (float): [optional] # noqa: E501 - product_detail (float): [optional] # noqa: E501 - confirmation (float): [optional] # noqa: E501 - merchandising (float): [optional] # noqa: E501 - deals (float): [optional] # noqa: E501 - checkout (float): [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_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers_request.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers_request.py deleted file mode 100644 index d1651e80..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.resource_of_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers - globals()['ResourceOfLineItemBidMultipliers'] = ResourceOfLineItemBidMultipliers - - -class LineItemBidMultipliersRequest(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': (ResourceOfLineItemBidMultipliers,), # 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 - """LineItemBidMultipliersRequest - 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 (ResourceOfLineItemBidMultipliers): [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 - """LineItemBidMultipliersRequest - 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 (ResourceOfLineItemBidMultipliers): [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_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers_response.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers_response.py deleted file mode 100644 index ac9034d6..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/line_item_bid_multipliers_response.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers - globals()['ProblemDetails'] = ProblemDetails - globals()['ResourceOfLineItemBidMultipliers'] = ResourceOfLineItemBidMultipliers - - -class LineItemBidMultipliersResponse(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': (ResourceOfLineItemBidMultipliers,), # 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 - """LineItemBidMultipliersResponse - 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 (ResourceOfLineItemBidMultipliers): [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 - """LineItemBidMultipliersResponse - 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 (ResourceOfLineItemBidMultipliers): [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_2023-01/criteo_api_retailmedia_v2023_01/model/problem_details.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/problem_details.py deleted file mode 100644 index a69c39a4..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/problem_details.py +++ /dev/null @@ -1,305 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - - -class ProblemDetails(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 = { - ('type',): { - 'UNKNOWN': "unknown", - 'ACCESS-CONTROL': "access-control", - 'AUTHENTICATION': "authentication", - 'AUTHORIZATION': "authorization", - 'AVAILABILITY': "availability", - 'DEPRECATION': "deprecation", - 'QUOTA': "quota", - 'VALIDATION': "validation", - }, - } - - 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, none_type,), # noqa: E501 - 'trace_identifier': (str, none_type,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'code': (str,), # noqa: E501 - 'instance': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'detail': (str,), # noqa: E501 - 'source': ({str: (str,)},), # noqa: E501 - 'stack_trace': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_id': 'traceId', # noqa: E501 - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'type': 'type', # noqa: E501 - 'code': 'code', # noqa: E501 - 'instance': 'instance', # noqa: E501 - 'title': 'title', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ProblemDetails - 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,) - trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 - trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 - type (str): The problem's category.. [optional] # noqa: E501 - code (str): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 - instance (str): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 - title (str): A short human-readable description of the problem type. [optional] # noqa: E501 - detail (str): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (str,)}): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace (str): Technical information, only used in non-prod environments. [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 - """ProblemDetails - 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,) - trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 - trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 - type (str): The problem's category.. [optional] # noqa: E501 - code (str): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 - instance (str): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 - title (str): A short human-readable description of the problem type. [optional] # noqa: E501 - detail (str): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 - source ({str: (str,)}): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 - stack_trace (str): Technical information, only used in non-prod environments. [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_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_balance202110.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_balance202110.py deleted file mode 100644 index ee1ba61a..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_balance202110.py +++ /dev/null @@ -1,277 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_balance202110 import ExternalBalance202110 - globals()['ExternalBalance202110'] = ExternalBalance202110 - - -class ResourceOfBalance202110(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 { - 'id': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'attributes': (ExternalBalance202110,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - '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 - """ResourceOfBalance202110 - 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,) - 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 (ExternalBalance202110): [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 - """ResourceOfBalance202110 - 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,) - 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 (ExternalBalance202110): [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_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_line_item_bid_multipliers.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_line_item_bid_multipliers.py deleted file mode 100644 index d4a41bff..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_line_item_bid_multipliers.py +++ /dev/null @@ -1,277 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_01.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_v2023_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers import LineItemBidMultipliers - globals()['LineItemBidMultipliers'] = LineItemBidMultipliers - - -class ResourceOfLineItemBidMultipliers(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 { - 'attributes': (LineItemBidMultipliers,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResourceOfLineItemBidMultipliers - 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,) - attributes (LineItemBidMultipliers): [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 - """ - - _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 - """ResourceOfLineItemBidMultipliers - 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,) - attributes (LineItemBidMultipliers): [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 - """ - - _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_2023-01/criteo_api_retailmedia_v2023_01/model_utils.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model_utils.py deleted file mode 100644 index f4949ed5..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model_utils.py +++ /dev/null @@ -1,2058 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -from datetime import date, datetime # noqa: F401 -from copy import deepcopy -import inspect -import io -import os -import pprint -import re -import tempfile -import uuid - -from dateutil.parser import parse - -from criteo_api_retailmedia_v2023_01.exceptions import ( - ApiKeyError, - ApiAttributeError, - ApiTypeError, - ApiValueError, -) - -none_type = type(None) -file_type = io.IOBase - - -def convert_js_args_to_python_args(fn): - from functools import wraps - @wraps(fn) - def wrapped_init(_self, *args, **kwargs): - """ - An attribute named `self` received from the api will conflicts with the reserved `self` - parameter of a class method. During generation, `self` attributes are mapped - to `_self` in models. Here, we name `_self` instead of `self` to avoid conflicts. - """ - spec_property_naming = kwargs.get('_spec_property_naming', False) - if spec_property_naming: - kwargs = change_keys_js_to_python( - kwargs, _self if isinstance( - _self, type) else _self.__class__) - return fn(_self, *args, **kwargs) - return wrapped_init - - -class cached_property(object): - # this caches the result of the function call for fn with no inputs - # use this as a decorator on function methods that you want converted - # into cached properties - result_key = '_results' - - def __init__(self, fn): - self._fn = fn - - def __get__(self, instance, cls=None): - if self.result_key in vars(self): - return vars(self)[self.result_key] - else: - result = self._fn() - setattr(self, self.result_key, result) - return result - - -PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) - - -def allows_single_value_input(cls): - """ - This function returns True if the input composed schema model or any - descendant model allows a value only input - This is true for cases where oneOf contains items like: - oneOf: - - float - - NumberWithValidation - - StringEnum - - ArrayModel - - null - TODO: lru_cache this - """ - if ( - issubclass(cls, ModelSimple) or - cls in PRIMITIVE_TYPES - ): - return True - elif issubclass(cls, ModelComposed): - if not cls._composed_schemas['oneOf']: - return False - return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) - return False - - -def composed_model_input_classes(cls): - """ - This function returns a list of the possible models that can be accepted as - inputs. - TODO: lru_cache this - """ - if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: - return [cls] - elif issubclass(cls, ModelNormal): - if cls.discriminator is None: - return [cls] - else: - return get_discriminated_classes(cls) - elif issubclass(cls, ModelComposed): - if not cls._composed_schemas['oneOf']: - return [] - if cls.discriminator is None: - input_classes = [] - for c in cls._composed_schemas['oneOf']: - input_classes.extend(composed_model_input_classes(c)) - return input_classes - else: - return get_discriminated_classes(cls) - return [] - - -class OpenApiModel(object): - """The base class for all OpenAPIModels""" - - def set_attribute(self, name, value): - # this is only used to set properties on self - - path_to_item = [] - if self._path_to_item: - path_to_item.extend(self._path_to_item) - path_to_item.append(name) - - if name in self.openapi_types: - required_types_mixed = self.openapi_types[name] - elif self.additional_properties_type is None: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - path_to_item - ) - elif self.additional_properties_type is not None: - required_types_mixed = self.additional_properties_type - - if get_simple_class(name) != str: - error_msg = type_error_message( - var_name=name, - var_value=name, - valid_classes=(str,), - key_type=True - ) - raise ApiTypeError( - error_msg, - path_to_item=path_to_item, - valid_classes=(str,), - key_type=True - ) - - if self._check_type: - value = validate_and_convert_types( - value, required_types_mixed, path_to_item, self._spec_property_naming, - self._check_type, configuration=self._configuration) - if (name,) in self.allowed_values: - check_allowed_values( - self.allowed_values, - (name,), - value - ) - if (name,) in self.validations: - check_validations( - self.validations, - (name,), - value, - self._configuration - ) - self.__dict__['_data_store'][name] = value - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other - - def __setattr__(self, attr, value): - """set the value of an attribute using dot notation: `instance.attr = val`""" - self[attr] = value - - def __getattr__(self, attr): - """get the value of an attribute using dot notation: `instance.attr`""" - return self.__getitem__(attr) - - def __copy__(self): - cls = self.__class__ - if self.get("_spec_property_naming", False): - return cls._new_from_openapi_data(**self.__dict__) - else: - return cls.__new__(cls, **self.__dict__) - - def __deepcopy__(self, memo): - cls = self.__class__ - - if self.get("_spec_property_naming", False): - new_inst = cls._new_from_openapi_data() - else: - new_inst = cls.__new__(cls, **self.__dict__) - - for k, v in self.__dict__.items(): - setattr(new_inst, k, deepcopy(v, memo)) - return new_inst - - - def __new__(cls, *args, **kwargs): - # this function uses the discriminator to - # pick a new schema/class to instantiate because a discriminator - # propertyName value was passed in - - if len(args) == 1: - arg = args[0] - if arg is None and is_type_nullable(cls): - # The input data is the 'null' value and the type is nullable. - return None - - if issubclass(cls, ModelComposed) and allows_single_value_input(cls): - model_kwargs = {} - oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) - return oneof_instance - - visited_composed_classes = kwargs.get('_visited_composed_classes', ()) - if ( - cls.discriminator is None or - cls in visited_composed_classes - ): - # Use case 1: this openapi schema (cls) does not have a discriminator - # Use case 2: we have already visited this class before and are sure that we - # want to instantiate it this time. We have visited this class deserializing - # a payload with a discriminator. During that process we traveled through - # this class but did not make an instance of it. Now we are making an - # instance of a composed class which contains cls in it, so this time make an instance of cls. - # - # Here's an example of use case 2: 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 the composed schema dog Dog, we will make an instance of the - # Animal class (because Dal has allOf: Animal) but this time we won't travel - # through Animal's discriminator because we passed in - # _visited_composed_classes = (Animal,) - - return super(OpenApiModel, cls).__new__(cls) - - # Get the name and value of the discriminator property. - # The discriminator name is obtained from the discriminator meta-data - # and the discriminator value is obtained from the input data. - discr_propertyname_py = list(cls.discriminator.keys())[0] - discr_propertyname_js = cls.attribute_map[discr_propertyname_py] - if discr_propertyname_js in kwargs: - discr_value = kwargs[discr_propertyname_js] - elif discr_propertyname_py in kwargs: - discr_value = kwargs[discr_propertyname_py] - else: - # The input data does not contain the discriminator property. - path_to_item = kwargs.get('_path_to_item', ()) - raise ApiValueError( - "Cannot deserialize input data due to missing discriminator. " - "The discriminator property '%s' is missing at path: %s" % - (discr_propertyname_js, path_to_item) - ) - - # Implementation note: the last argument to get_discriminator_class - # is a list of visited classes. get_discriminator_class may recursively - # call itself and update the list of visited classes, and the initial - # value must be an empty list. Hence not using 'visited_composed_classes' - new_cls = get_discriminator_class( - cls, discr_propertyname_py, discr_value, []) - if new_cls is None: - path_to_item = kwargs.get('_path_to_item', ()) - disc_prop_value = kwargs.get( - discr_propertyname_js, kwargs.get(discr_propertyname_py)) - raise ApiValueError( - "Cannot deserialize input data due to invalid discriminator " - "value. The OpenAPI document has no mapping for discriminator " - "property '%s'='%s' at path: %s" % - (discr_propertyname_js, disc_prop_value, path_to_item) - ) - - if new_cls in visited_composed_classes: - # if we are making an instance of a composed schema Descendent - # which allOf includes Ancestor, then Ancestor contains - # a discriminator that includes Descendent. - # So if we make an instance of Descendent, we have to make an - # instance of Ancestor to hold the allOf properties. - # This code detects that use case and makes the instance of Ancestor - # For example: - # When making an instance of Dog, _visited_composed_classes = (Dog,) - # then we make an instance of Animal to include in dog._composed_instances - # so when we are here, cls is Animal - # cls.discriminator != None - # cls not in _visited_composed_classes - # new_cls = Dog - # but we know we know that we already have Dog - # because it is in visited_composed_classes - # so make Animal here - return super(OpenApiModel, cls).__new__(cls) - - # Build a list containing all oneOf and anyOf descendants. - oneof_anyof_classes = None - if cls._composed_schemas is not None: - oneof_anyof_classes = ( - cls._composed_schemas.get('oneOf', ()) + - cls._composed_schemas.get('anyOf', ())) - oneof_anyof_child = new_cls in oneof_anyof_classes - kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) - - if cls._composed_schemas.get('allOf') and oneof_anyof_child: - # Validate that we can make self because when we make the - # new_cls it will not include the allOf validations in self - self_inst = super(OpenApiModel, cls).__new__(cls) - self_inst.__init__(*args, **kwargs) - - if kwargs.get("_spec_property_naming", False): - # when true, implies new is from deserialization - new_inst = new_cls._new_from_openapi_data(*args, **kwargs) - else: - new_inst = new_cls.__new__(new_cls, *args, **kwargs) - new_inst.__init__(*args, **kwargs) - - return new_inst - - @classmethod - @convert_js_args_to_python_args - def _new_from_openapi_data(cls, *args, **kwargs): - # this function uses the discriminator to - # pick a new schema/class to instantiate because a discriminator - # propertyName value was passed in - - if len(args) == 1: - arg = args[0] - if arg is None and is_type_nullable(cls): - # The input data is the 'null' value and the type is nullable. - return None - - if issubclass(cls, ModelComposed) and allows_single_value_input(cls): - model_kwargs = {} - oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) - return oneof_instance - - visited_composed_classes = kwargs.get('_visited_composed_classes', ()) - if ( - cls.discriminator is None or - cls in visited_composed_classes - ): - # Use case 1: this openapi schema (cls) does not have a discriminator - # Use case 2: we have already visited this class before and are sure that we - # want to instantiate it this time. We have visited this class deserializing - # a payload with a discriminator. During that process we traveled through - # this class but did not make an instance of it. Now we are making an - # instance of a composed class which contains cls in it, so this time make an instance of cls. - # - # Here's an example of use case 2: 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 the composed schema dog Dog, we will make an instance of the - # Animal class (because Dal has allOf: Animal) but this time we won't travel - # through Animal's discriminator because we passed in - # _visited_composed_classes = (Animal,) - - return cls._from_openapi_data(*args, **kwargs) - - # Get the name and value of the discriminator property. - # The discriminator name is obtained from the discriminator meta-data - # and the discriminator value is obtained from the input data. - discr_propertyname_py = list(cls.discriminator.keys())[0] - discr_propertyname_js = cls.attribute_map[discr_propertyname_py] - if discr_propertyname_js in kwargs: - discr_value = kwargs[discr_propertyname_js] - elif discr_propertyname_py in kwargs: - discr_value = kwargs[discr_propertyname_py] - else: - # The input data does not contain the discriminator property. - path_to_item = kwargs.get('_path_to_item', ()) - raise ApiValueError( - "Cannot deserialize input data due to missing discriminator. " - "The discriminator property '%s' is missing at path: %s" % - (discr_propertyname_js, path_to_item) - ) - - # Implementation note: the last argument to get_discriminator_class - # is a list of visited classes. get_discriminator_class may recursively - # call itself and update the list of visited classes, and the initial - # value must be an empty list. Hence not using 'visited_composed_classes' - new_cls = get_discriminator_class( - cls, discr_propertyname_py, discr_value, []) - if new_cls is None: - path_to_item = kwargs.get('_path_to_item', ()) - disc_prop_value = kwargs.get( - discr_propertyname_js, kwargs.get(discr_propertyname_py)) - raise ApiValueError( - "Cannot deserialize input data due to invalid discriminator " - "value. The OpenAPI document has no mapping for discriminator " - "property '%s'='%s' at path: %s" % - (discr_propertyname_js, disc_prop_value, path_to_item) - ) - - if new_cls in visited_composed_classes: - # if we are making an instance of a composed schema Descendent - # which allOf includes Ancestor, then Ancestor contains - # a discriminator that includes Descendent. - # So if we make an instance of Descendent, we have to make an - # instance of Ancestor to hold the allOf properties. - # This code detects that use case and makes the instance of Ancestor - # For example: - # When making an instance of Dog, _visited_composed_classes = (Dog,) - # then we make an instance of Animal to include in dog._composed_instances - # so when we are here, cls is Animal - # cls.discriminator != None - # cls not in _visited_composed_classes - # new_cls = Dog - # but we know we know that we already have Dog - # because it is in visited_composed_classes - # so make Animal here - return cls._from_openapi_data(*args, **kwargs) - - # Build a list containing all oneOf and anyOf descendants. - oneof_anyof_classes = None - if cls._composed_schemas is not None: - oneof_anyof_classes = ( - cls._composed_schemas.get('oneOf', ()) + - cls._composed_schemas.get('anyOf', ())) - oneof_anyof_child = new_cls in oneof_anyof_classes - kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) - - if cls._composed_schemas.get('allOf') and oneof_anyof_child: - # Validate that we can make self because when we make the - # new_cls it will not include the allOf validations in self - self_inst = cls._from_openapi_data(*args, **kwargs) - - new_inst = new_cls._new_from_openapi_data(*args, **kwargs) - return new_inst - - -class ModelSimple(OpenApiModel): - """the parent class of models whose type != object in their - swagger/openapi""" - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - self.set_attribute(name, value) - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - return self.__dict__['_data_store'].get(name, default) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - if name in self: - return self.get(name) - - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - if name in self.required_properties: - return name in self.__dict__ - - return name in self.__dict__['_data_store'] - - def to_str(self): - """Returns the string representation of the model""" - return str(self.value) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - this_val = self._data_store['value'] - that_val = other._data_store['value'] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - return vals_equal - - -class ModelNormal(OpenApiModel): - """the parent class of models whose type == object in their - swagger/openapi""" - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - self.set_attribute(name, value) - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - return self.__dict__['_data_store'].get(name, default) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - if name in self: - return self.get(name) - - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - if name in self.required_properties: - return name in self.__dict__ - - return name in self.__dict__['_data_store'] - - def to_dict(self): - """Returns the model properties as a dict""" - return model_to_dict(self, serialize=False) - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - if not set(self._data_store.keys()) == set(other._data_store.keys()): - return False - for _var_name, this_val in self._data_store.items(): - that_val = other._data_store[_var_name] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - if not vals_equal: - return False - return True - - -class ModelComposed(OpenApiModel): - """the parent class of models whose type == object in their - swagger/openapi and have oneOf/allOf/anyOf - - When one sets a property we use var_name_to_model_instances to store the value in - the correct class instances + run any type checking + validation code. - When one gets a property we use var_name_to_model_instances to get the value - from the correct class instances. - This allows multiple composed schemas to contain the same property with additive - constraints on the value. - - _composed_schemas (dict) stores the anyOf/allOf/oneOf classes - key (str): allOf/oneOf/anyOf - value (list): the classes in the XOf definition. - Note: none_type can be included when the openapi document version >= 3.1.0 - _composed_instances (list): stores a list of instances of the composed schemas - defined in _composed_schemas. When properties are accessed in the self instance, - they are returned from the self._data_store or the data stores in the instances - in self._composed_schemas - _var_name_to_model_instances (dict): maps between a variable name on self and - the composed instances (self included) which contain that data - key (str): property name - value (list): list of class instances, self or instances in _composed_instances - which contain the value that the key is referring to. - """ - - def __setitem__(self, name, value): - """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" - if name in self.required_properties: - self.__dict__[name] = value - return - - """ - Use cases: - 1. additional_properties_type is None (additionalProperties == False in spec) - Check for property presence in self.openapi_types - if not present then throw an error - if present set in self, set attribute - always set on composed schemas - 2. additional_properties_type exists - set attribute on self - always set on composed schemas - """ - if self.additional_properties_type is None: - """ - For an attribute to exist on a composed schema it must: - - fulfill schema_requirements in the self composed schema not considering oneOf/anyOf/allOf schemas AND - - fulfill schema_requirements in each oneOf/anyOf/allOf schemas - - schema_requirements: - For an attribute to exist on a schema it must: - - be present in properties at the schema OR - - have additionalProperties unset (defaults additionalProperties = any type) OR - - have additionalProperties set - """ - if name not in self.openapi_types: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - # attribute must be set on self and composed instances - self.set_attribute(name, value) - for model_instance in self._composed_instances: - setattr(model_instance, name, value) - if name not in self._var_name_to_model_instances: - # we assigned an additional property - self.__dict__['_var_name_to_model_instances'][name] = self._composed_instances + [self] - return None - - __unset_attribute_value__ = object() - - def get(self, name, default=None): - """returns the value of an attribute or some default value if the attribute was not set""" - if name in self.required_properties: - return self.__dict__[name] - - # get the attribute from the correct instance - model_instances = self._var_name_to_model_instances.get(name) - values = [] - # A composed model stores self and child (oneof/anyOf/allOf) models under - # self._var_name_to_model_instances. - # Any property must exist in self and all model instances - # The value stored in all model instances must be the same - if model_instances: - for model_instance in model_instances: - if name in model_instance._data_store: - v = model_instance._data_store[name] - if v not in values: - values.append(v) - len_values = len(values) - if len_values == 0: - return default - elif len_values == 1: - return values[0] - elif len_values > 1: - raise ApiValueError( - "Values stored for property {0} in {1} differ when looking " - "at self and self's composed instances. All values must be " - "the same".format(name, type(self).__name__), - [e for e in [self._path_to_item, name] if e] - ) - - def __getitem__(self, name): - """get the value of an attribute using square-bracket notation: `instance[attr]`""" - value = self.get(name, self.__unset_attribute_value__) - if value is self.__unset_attribute_value__: - raise ApiAttributeError( - "{0} has no attribute '{1}'".format( - type(self).__name__, name), - [e for e in [self._path_to_item, name] if e] - ) - return value - - def __contains__(self, name): - """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" - - if name in self.required_properties: - return name in self.__dict__ - - model_instances = self._var_name_to_model_instances.get( - name, self._additional_properties_model_instances) - - if model_instances: - for model_instance in model_instances: - if name in model_instance._data_store: - return True - - return False - - def to_dict(self): - """Returns the model properties as a dict""" - return model_to_dict(self, serialize=False) - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, self.__class__): - return False - - if not set(self._data_store.keys()) == set(other._data_store.keys()): - return False - for _var_name, this_val in self._data_store.items(): - that_val = other._data_store[_var_name] - types = set() - types.add(this_val.__class__) - types.add(that_val.__class__) - vals_equal = this_val == that_val - if not vals_equal: - return False - return True - - -COERCION_INDEX_BY_TYPE = { - ModelComposed: 0, - ModelNormal: 1, - ModelSimple: 2, - none_type: 3, # The type of 'None'. - list: 4, - dict: 5, - float: 6, - int: 7, - bool: 8, - datetime: 9, - date: 10, - str: 11, - file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. -} - -# these are used to limit what type conversions we try to do -# when we have a valid type already and we want to try converting -# to another type -UPCONVERSION_TYPE_PAIRS = ( - (str, datetime), - (str, date), - # A float may be serialized as an integer, e.g. '3' is a valid serialized float. - (int, float), - (list, ModelComposed), - (dict, ModelComposed), - (str, ModelComposed), - (int, ModelComposed), - (float, ModelComposed), - (list, ModelComposed), - (list, ModelNormal), - (dict, ModelNormal), - (str, ModelSimple), - (int, ModelSimple), - (float, ModelSimple), - (list, ModelSimple), -) - -COERCIBLE_TYPE_PAIRS = { - False: ( # client instantiation of a model with client data - # (dict, ModelComposed), - # (list, ModelComposed), - # (dict, ModelNormal), - # (list, ModelNormal), - # (str, ModelSimple), - # (int, ModelSimple), - # (float, ModelSimple), - # (list, ModelSimple), - # (str, int), - # (str, float), - # (str, datetime), - # (str, date), - # (int, str), - # (float, str), - ), - True: ( # server -> client data - (dict, ModelComposed), - (list, ModelComposed), - (dict, ModelNormal), - (list, ModelNormal), - (str, ModelSimple), - (int, ModelSimple), - (float, ModelSimple), - (list, ModelSimple), - # (str, int), - # (str, float), - (str, datetime), - (str, date), - # (int, str), - # (float, str), - (str, file_type) - ), -} - - -def get_simple_class(input_value): - """Returns an input_value's simple class that we will use for type checking - Python2: - float and int will return int, where int is the python3 int backport - str and unicode will return str, where str is the python3 str backport - Note: float and int ARE both instances of int backport - Note: str_py2 and unicode_py2 are NOT both instances of str backport - - Args: - input_value (class/class_instance): the item for which we will return - the simple class - """ - if isinstance(input_value, type): - # input_value is a class - return input_value - elif isinstance(input_value, tuple): - return tuple - elif isinstance(input_value, list): - return list - elif isinstance(input_value, dict): - return dict - elif isinstance(input_value, none_type): - return none_type - elif isinstance(input_value, file_type): - return file_type - elif isinstance(input_value, bool): - # this must be higher than the int check because - # isinstance(True, int) == True - return bool - elif isinstance(input_value, int): - return int - elif isinstance(input_value, datetime): - # this must be higher than the date check because - # isinstance(datetime_instance, date) == True - return datetime - elif isinstance(input_value, date): - return date - elif isinstance(input_value, str): - return str - return type(input_value) - - -def check_allowed_values(allowed_values, input_variable_path, input_values): - """Raises an exception if the input_values are not allowed - - Args: - allowed_values (dict): the allowed_values dict - input_variable_path (tuple): the path to the input variable - input_values (list/str/int/float/date/datetime): the values that we - are checking to see if they are in allowed_values - """ - these_allowed_values = list(allowed_values[input_variable_path].values()) - if (isinstance(input_values, list) - and not set(input_values).issubset( - set(these_allowed_values))): - invalid_values = ", ".join( - map(str, set(input_values) - set(these_allowed_values))), - raise ApiValueError( - "Invalid values for `%s` [%s], must be a subset of [%s]" % - ( - input_variable_path[0], - invalid_values, - ", ".join(map(str, these_allowed_values)) - ) - ) - elif (isinstance(input_values, dict) - and not set( - input_values.keys()).issubset(set(these_allowed_values))): - invalid_values = ", ".join( - map(str, set(input_values.keys()) - set(these_allowed_values))) - raise ApiValueError( - "Invalid keys in `%s` [%s], must be a subset of [%s]" % - ( - input_variable_path[0], - invalid_values, - ", ".join(map(str, these_allowed_values)) - ) - ) - elif (not isinstance(input_values, (list, dict)) - and input_values not in these_allowed_values): - raise ApiValueError( - "Invalid value for `%s` (%s), must be one of %s" % - ( - input_variable_path[0], - input_values, - these_allowed_values - ) - ) - - -def is_json_validation_enabled(schema_keyword, configuration=None): - """Returns true if JSON schema validation is enabled for the specified - validation keyword. This can be used to skip JSON schema structural validation - as requested in the configuration. - - Args: - schema_keyword (string): the name of a JSON schema validation keyword. - configuration (Configuration): the configuration class. - """ - - return (configuration is None or - not hasattr(configuration, '_disabled_client_side_validations') or - schema_keyword not in configuration._disabled_client_side_validations) - - -def check_validations( - validations, input_variable_path, input_values, - configuration=None): - """Raises an exception if the input_values are invalid - - Args: - validations (dict): the validation dictionary. - input_variable_path (tuple): the path to the input variable. - input_values (list/str/int/float/date/datetime): the values that we - are checking. - configuration (Configuration): the configuration class. - """ - - if input_values is None: - return - - current_validations = validations[input_variable_path] - if (is_json_validation_enabled('multipleOf', configuration) and - 'multiple_of' in current_validations and - isinstance(input_values, (int, float)) and - not (float(input_values) / current_validations['multiple_of']).is_integer()): - # Note 'multipleOf' will be as good as the floating point arithmetic. - raise ApiValueError( - "Invalid value for `%s`, value must be a multiple of " - "`%s`" % ( - input_variable_path[0], - current_validations['multiple_of'] - ) - ) - - if (is_json_validation_enabled('maxLength', configuration) and - 'max_length' in current_validations and - len(input_values) > current_validations['max_length']): - raise ApiValueError( - "Invalid value for `%s`, length must be less than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['max_length'] - ) - ) - - if (is_json_validation_enabled('minLength', configuration) and - 'min_length' in current_validations and - len(input_values) < current_validations['min_length']): - raise ApiValueError( - "Invalid value for `%s`, length must be greater than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['min_length'] - ) - ) - - if (is_json_validation_enabled('maxItems', configuration) and - 'max_items' in current_validations and - len(input_values) > current_validations['max_items']): - raise ApiValueError( - "Invalid value for `%s`, number of items must be less than or " - "equal to `%s`" % ( - input_variable_path[0], - current_validations['max_items'] - ) - ) - - if (is_json_validation_enabled('minItems', configuration) and - 'min_items' in current_validations and - len(input_values) < current_validations['min_items']): - raise ValueError( - "Invalid value for `%s`, number of items must be greater than or " - "equal to `%s`" % ( - input_variable_path[0], - current_validations['min_items'] - ) - ) - - items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', - 'inclusive_minimum') - if (any(item in current_validations for item in items)): - if isinstance(input_values, list): - max_val = max(input_values) - min_val = min(input_values) - elif isinstance(input_values, dict): - max_val = max(input_values.values()) - min_val = min(input_values.values()) - else: - max_val = input_values - min_val = input_values - - if (is_json_validation_enabled('exclusiveMaximum', configuration) and - 'exclusive_maximum' in current_validations and - max_val >= current_validations['exclusive_maximum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value less than `%s`" % ( - input_variable_path[0], - current_validations['exclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('maximum', configuration) and - 'inclusive_maximum' in current_validations and - max_val > current_validations['inclusive_maximum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value less than or equal to " - "`%s`" % ( - input_variable_path[0], - current_validations['inclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('exclusiveMinimum', configuration) and - 'exclusive_minimum' in current_validations and - min_val <= current_validations['exclusive_minimum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value greater than `%s`" % - ( - input_variable_path[0], - current_validations['exclusive_maximum'] - ) - ) - - if (is_json_validation_enabled('minimum', configuration) and - 'inclusive_minimum' in current_validations and - min_val < current_validations['inclusive_minimum']): - raise ApiValueError( - "Invalid value for `%s`, must be a value greater than or equal " - "to `%s`" % ( - input_variable_path[0], - current_validations['inclusive_minimum'] - ) - ) - flags = current_validations.get('regex', {}).get('flags', 0) - if (is_json_validation_enabled('pattern', configuration) and - 'regex' in current_validations and - not re.search(current_validations['regex']['pattern'], - input_values, flags=flags)): - err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( - input_variable_path[0], - current_validations['regex']['pattern'] - ) - if flags != 0: - # Don't print the regex flags if the flags are not - # specified in the OAS document. - err_msg = r"%s with flags=`%s`" % (err_msg, flags) - raise ApiValueError(err_msg) - - -def order_response_types(required_types): - """Returns the required types sorted in coercion order - - Args: - required_types (list/tuple): collection of classes or instance of - list or dict with class information inside it. - - Returns: - (list): coercion order sorted collection of classes or instance - of list or dict with class information inside it. - """ - - def index_getter(class_or_instance): - if isinstance(class_or_instance, list): - return COERCION_INDEX_BY_TYPE[list] - elif isinstance(class_or_instance, dict): - return COERCION_INDEX_BY_TYPE[dict] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelComposed)): - return COERCION_INDEX_BY_TYPE[ModelComposed] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelNormal)): - return COERCION_INDEX_BY_TYPE[ModelNormal] - elif (inspect.isclass(class_or_instance) - and issubclass(class_or_instance, ModelSimple)): - return COERCION_INDEX_BY_TYPE[ModelSimple] - elif class_or_instance in COERCION_INDEX_BY_TYPE: - return COERCION_INDEX_BY_TYPE[class_or_instance] - raise ApiValueError("Unsupported type: %s" % class_or_instance) - - sorted_types = sorted( - required_types, - key=lambda class_or_instance: index_getter(class_or_instance) - ) - return sorted_types - - -def remove_uncoercible(required_types_classes, current_item, spec_property_naming, - must_convert=True): - """Only keeps the type conversions that are possible - - Args: - required_types_classes (tuple): tuple of classes that are required - these should be ordered by COERCION_INDEX_BY_TYPE - 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 variables names in the input data are python - variable names in PEP-8 snake case. - current_item (any): the current item (input data) to be converted - - Keyword Args: - must_convert (bool): if True the item to convert is of the wrong - type and we want a big list of coercibles - if False, we want a limited list of coercibles - - Returns: - (list): the remaining coercible required types, classes only - """ - current_type_simple = get_simple_class(current_item) - - results_classes = [] - for required_type_class in required_types_classes: - # convert our models to OpenApiModel - required_type_class_simplified = required_type_class - if isinstance(required_type_class_simplified, type): - if issubclass(required_type_class_simplified, ModelComposed): - required_type_class_simplified = ModelComposed - elif issubclass(required_type_class_simplified, ModelNormal): - required_type_class_simplified = ModelNormal - elif issubclass(required_type_class_simplified, ModelSimple): - required_type_class_simplified = ModelSimple - - if required_type_class_simplified == current_type_simple: - # don't consider converting to one's own class - continue - - class_pair = (current_type_simple, required_type_class_simplified) - if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: - results_classes.append(required_type_class) - elif class_pair in UPCONVERSION_TYPE_PAIRS: - results_classes.append(required_type_class) - return results_classes - - -def get_discriminated_classes(cls): - """ - Returns all the classes that a discriminator converts to - TODO: lru_cache this - """ - possible_classes = [] - key = list(cls.discriminator.keys())[0] - if is_type_nullable(cls): - possible_classes.append(cls) - for discr_cls in cls.discriminator[key].values(): - if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: - possible_classes.extend(get_discriminated_classes(discr_cls)) - else: - possible_classes.append(discr_cls) - return possible_classes - - -def get_possible_classes(cls, from_server_context): - # TODO: lru_cache this - possible_classes = [cls] - if from_server_context: - return possible_classes - if hasattr(cls, 'discriminator') and cls.discriminator is not None: - possible_classes = [] - possible_classes.extend(get_discriminated_classes(cls)) - elif issubclass(cls, ModelComposed): - possible_classes.extend(composed_model_input_classes(cls)) - return possible_classes - - -def get_required_type_classes(required_types_mixed, spec_property_naming): - """Converts the tuple required_types into a tuple and a dict described - below - - Args: - required_types_mixed (tuple/list): will contain either classes or - instance of list or dict - spec_property_naming (bool): if True these values came from the - server, and we use the data types in our endpoints. - If False, we are client side and we need to include - oneOf and discriminator classes inside the data types in our endpoints - - Returns: - (valid_classes, dict_valid_class_to_child_types_mixed): - valid_classes (tuple): the valid classes that the current item - should be - dict_valid_class_to_child_types_mixed (dict): - valid_class (class): this is the key - child_types_mixed (list/dict/tuple): describes the valid child - types - """ - valid_classes = [] - child_req_types_by_current_type = {} - for required_type in required_types_mixed: - if isinstance(required_type, list): - valid_classes.append(list) - child_req_types_by_current_type[list] = required_type - elif isinstance(required_type, tuple): - valid_classes.append(tuple) - child_req_types_by_current_type[tuple] = required_type - elif isinstance(required_type, dict): - valid_classes.append(dict) - child_req_types_by_current_type[dict] = required_type[str] - else: - valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) - return tuple(valid_classes), child_req_types_by_current_type - - -def change_keys_js_to_python(input_dict, model_class): - """ - Converts from javascript_key keys in the input_dict to python_keys in - the output dict using the mapping in model_class. - If the input_dict contains a key which does not declared in the model_class, - the key is added to the output dict as is. The assumption is the model_class - may have undeclared properties (additionalProperties attribute in the OAS - document). - """ - - if getattr(model_class, 'attribute_map', None) is None: - return input_dict - output_dict = {} - reversed_attr_map = {value: key for key, value in - model_class.attribute_map.items()} - for javascript_key, value in input_dict.items(): - python_key = reversed_attr_map.get(javascript_key) - if python_key is None: - # if the key is unknown, it is in error or it is an - # additionalProperties variable - python_key = javascript_key - output_dict[python_key] = value - return output_dict - - -def get_type_error(var_value, path_to_item, valid_classes, key_type=False): - error_msg = type_error_message( - var_name=path_to_item[-1], - var_value=var_value, - valid_classes=valid_classes, - key_type=key_type - ) - return ApiTypeError( - error_msg, - path_to_item=path_to_item, - valid_classes=valid_classes, - key_type=key_type - ) - - -def deserialize_primitive(data, klass, path_to_item): - """Deserializes string to primitive type. - - :param data: str/int/float - :param klass: str/class the class to convert to - - :return: int, float, str, bool, date, datetime - """ - additional_message = "" - try: - if klass in {datetime, date}: - additional_message = ( - "If you need your parameter to have a fallback " - "string value, please set its type as `type: {}` in your " - "spec. That allows the value to be any type. " - ) - if klass == datetime: - if len(data) < 8: - raise ValueError("This is not a datetime") - # The string should be in iso8601 datetime format. - parsed_datetime = parse(data) - date_only = ( - parsed_datetime.hour == 0 and - parsed_datetime.minute == 0 and - parsed_datetime.second == 0 and - parsed_datetime.tzinfo is None and - 8 <= len(data) <= 10 - ) - if date_only: - raise ValueError("This is a date, not a datetime") - return parsed_datetime - elif klass == date: - if len(data) < 8: - raise ValueError("This is not a date") - return parse(data).date() - else: - converted_value = klass(data) - if isinstance(data, str) and klass == float: - if str(converted_value) != data: - # '7' -> 7.0 -> '7.0' != '7' - raise ValueError('This is not a float') - return converted_value - except (OverflowError, ValueError) as ex: - # parse can raise OverflowError - raise ApiValueError( - "{0}Failed to parse {1} as {2}".format( - additional_message, repr(data), klass.__name__ - ), - path_to_item=path_to_item - ) from ex - - -def get_discriminator_class(model_class, - discr_name, - discr_value, cls_visited): - """Returns the child class specified by the discriminator. - - Args: - model_class (OpenApiModel): the model class. - discr_name (string): the name of the discriminator property. - discr_value (any): the discriminator value. - cls_visited (list): list of model classes that have been visited. - Used to determine the discriminator class without - visiting circular references indefinitely. - - Returns: - used_model_class (class/None): the chosen child class that will be used - to deserialize the data, for example dog.Dog. - If a class is not found, None is returned. - """ - - if model_class in cls_visited: - # The class has already been visited and no suitable class was found. - return None - cls_visited.append(model_class) - used_model_class = None - if discr_name in model_class.discriminator: - class_name_to_discr_class = model_class.discriminator[discr_name] - used_model_class = class_name_to_discr_class.get(discr_value) - if used_model_class is None: - # We didn't find a discriminated class in class_name_to_discr_class. - # So look in the ancestor or descendant discriminators - # The discriminator mapping may exist in a descendant (anyOf, oneOf) - # or ancestor (allOf). - # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat - # hierarchy, the discriminator mappings may be defined at any level - # in the hierarchy. - # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig - # if we try to make BasquePig from mammal, we need to travel through - # the oneOf descendant discriminators to find BasquePig - descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ - model_class._composed_schemas.get('anyOf', ()) - ancestor_classes = model_class._composed_schemas.get('allOf', ()) - possible_classes = descendant_classes + ancestor_classes - for cls in possible_classes: - # Check if the schema has inherited discriminators. - if hasattr(cls, 'discriminator') and cls.discriminator is not None: - used_model_class = get_discriminator_class( - cls, discr_name, discr_value, cls_visited) - if used_model_class is not None: - return used_model_class - return used_model_class - - -def deserialize_model(model_data, model_class, path_to_item, check_type, - configuration, spec_property_naming): - """Deserializes model_data to model instance. - - Args: - model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model - model_class (OpenApiModel): the model class - path_to_item (list): path to the model in the received data - check_type (bool): whether to check the data tupe for the values in - the model - configuration (Configuration): the instance to use to convert files - 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 variables names in the input data are python - variable names in PEP-8 snake case. - - Returns: - model instance - - Raise: - ApiTypeError - ApiValueError - ApiKeyError - """ - - kw_args = dict(_check_type=check_type, - _path_to_item=path_to_item, - _configuration=configuration, - _spec_property_naming=spec_property_naming) - - if issubclass(model_class, ModelSimple): - return model_class._new_from_openapi_data(model_data, **kw_args) - elif isinstance(model_data, list): - return model_class._new_from_openapi_data(*model_data, **kw_args) - if isinstance(model_data, dict): - kw_args.update(model_data) - return model_class._new_from_openapi_data(**kw_args) - elif isinstance(model_data, PRIMITIVE_TYPES): - return model_class._new_from_openapi_data(model_data, **kw_args) - - -def deserialize_file(response_data, configuration, content_disposition=None): - """Deserializes body to file - - Saves response body into a file in a temporary folder, - using the filename from the `Content-Disposition` header if provided. - - Args: - param response_data (str): the file data to write - configuration (Configuration): the instance to use to convert files - - Keyword Args: - content_disposition (str): the value of the Content-Disposition - header - - Returns: - (file_type): the deserialized file which is open - The user is responsible for closing and reading the file - """ - fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) - os.close(fd) - os.remove(path) - - if content_disposition: - filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', - content_disposition, - flags=re.I) - if filename is not None: - filename = filename.group(1) - else: - filename = "default_" + str(uuid.uuid4()) - - path = os.path.join(os.path.dirname(path), filename) - - with open(path, "wb") as f: - if isinstance(response_data, str): - # change str to bytes so we can write it - response_data = response_data.encode('utf-8') - f.write(response_data) - - f = open(path, "rb") - return f - - -def attempt_convert_item(input_value, valid_classes, path_to_item, - configuration, spec_property_naming, key_type=False, - must_convert=False, check_type=True): - """ - Args: - input_value (any): the data to convert - valid_classes (any): the classes that are valid - path_to_item (list): the path to the item to convert - configuration (Configuration): the instance to use to convert files - 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 variables names in the input data are python - variable names in PEP-8 snake case. - key_type (bool): if True we need to convert a key type (not supported) - must_convert (bool): if True we must convert - check_type (bool): if True we check the type or the returned data in - ModelComposed/ModelNormal/ModelSimple instances - - Returns: - instance (any) the fixed item - - Raises: - ApiTypeError - ApiValueError - ApiKeyError - """ - valid_classes_ordered = order_response_types(valid_classes) - valid_classes_coercible = remove_uncoercible( - valid_classes_ordered, input_value, spec_property_naming) - if not valid_classes_coercible or key_type: - # we do not handle keytype errors, json will take care - # of this for us - if configuration is None or not configuration.discard_unknown_keys: - raise get_type_error(input_value, path_to_item, valid_classes, - key_type=key_type) - for valid_class in valid_classes_coercible: - try: - if issubclass(valid_class, OpenApiModel): - return deserialize_model(input_value, valid_class, - path_to_item, check_type, - configuration, spec_property_naming) - elif valid_class == file_type: - return deserialize_file(input_value, configuration) - return deserialize_primitive(input_value, valid_class, - path_to_item) - except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: - if must_convert: - raise conversion_exc - # if we have conversion errors when must_convert == False - # we ignore the exception and move on to the next class - continue - # we were unable to convert, must_convert == False - return input_value - - -def is_type_nullable(input_type): - """ - Returns true if None is an allowed value for the specified input_type. - - A type is nullable if at least one of the following conditions is true: - 1. The OAS 'nullable' attribute has been specified, - 1. The type is the 'null' type, - 1. The type is a anyOf/oneOf composed schema, and a child schema is - the 'null' type. - Args: - input_type (type): the class of the input_value that we are - checking - Returns: - bool - """ - if input_type is none_type: - return True - if issubclass(input_type, OpenApiModel) and input_type._nullable: - return True - if issubclass(input_type, ModelComposed): - # If oneOf/anyOf, check if the 'null' type is one of the allowed types. - for t in input_type._composed_schemas.get('oneOf', ()): - if is_type_nullable(t): - return True - for t in input_type._composed_schemas.get('anyOf', ()): - if is_type_nullable(t): - return True - return False - - -def is_valid_type(input_class_simple, valid_classes): - """ - Args: - input_class_simple (class): the class of the input_value that we are - checking - valid_classes (tuple): the valid classes that the current item - should be - Returns: - bool - """ - if issubclass(input_class_simple, OpenApiModel) and \ - valid_classes == (bool, date, datetime, dict, float, int, list, str, none_type,): - return True - valid_type = input_class_simple in valid_classes - if not valid_type and ( - issubclass(input_class_simple, OpenApiModel) or - input_class_simple is none_type): - for valid_class in valid_classes: - if input_class_simple is none_type and is_type_nullable(valid_class): - # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. - return True - if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): - continue - discr_propertyname_py = list(valid_class.discriminator.keys())[0] - discriminator_classes = ( - valid_class.discriminator[discr_propertyname_py].values() - ) - valid_type = is_valid_type(input_class_simple, discriminator_classes) - if valid_type: - return True - return valid_type - - -def validate_and_convert_types(input_value, required_types_mixed, path_to_item, - spec_property_naming, _check_type, configuration=None): - """Raises a TypeError is there is a problem, otherwise returns value - - Args: - input_value (any): the data to validate/convert - required_types_mixed (list/dict/tuple): A list of - valid classes, or a list tuples of valid classes, or a dict where - the value is a tuple of value classes - path_to_item: (list) the path to the data being validated - this stores a list of keys or indices to get to the data being - validated - 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 variables names in the input data are python - variable names in PEP-8 snake case. - _check_type: (boolean) if true, type will be checked and conversion - will be attempted. - configuration: (Configuration): the configuration class to use - when converting file_type items. - If passed, conversion will be attempted when possible - If not passed, no conversions will be attempted and - exceptions will be raised - - Returns: - the correctly typed value - - Raises: - ApiTypeError - """ - results = get_required_type_classes(required_types_mixed, spec_property_naming) - valid_classes, child_req_types_by_current_type = results - - input_class_simple = get_simple_class(input_value) - valid_type = is_valid_type(input_class_simple, valid_classes) - if not valid_type: - if (configuration - or (input_class_simple == dict - and dict not in valid_classes)): - # if input_value is not valid_type try to convert it - converted_instance = attempt_convert_item( - input_value, - valid_classes, - path_to_item, - configuration, - spec_property_naming, - key_type=False, - must_convert=True, - check_type=_check_type - ) - return converted_instance - else: - raise get_type_error(input_value, path_to_item, valid_classes, - key_type=False) - - # input_value's type is in valid_classes - if len(valid_classes) > 1 and configuration: - # there are valid classes which are not the current class - valid_classes_coercible = remove_uncoercible( - valid_classes, input_value, spec_property_naming, must_convert=False) - if valid_classes_coercible: - converted_instance = attempt_convert_item( - input_value, - valid_classes_coercible, - path_to_item, - configuration, - spec_property_naming, - key_type=False, - must_convert=False, - check_type=_check_type - ) - return converted_instance - - if child_req_types_by_current_type == {}: - # all types are of the required types and there are no more inner - # variables left to look at - return input_value - inner_required_types = child_req_types_by_current_type.get( - type(input_value) - ) - if inner_required_types is None: - # for this type, there are not more inner variables left to look at - return input_value - if isinstance(input_value, list): - if input_value == []: - # allow an empty list - return input_value - for index, inner_value in enumerate(input_value): - inner_path = list(path_to_item) - inner_path.append(index) - input_value[index] = validate_and_convert_types( - inner_value, - inner_required_types, - inner_path, - spec_property_naming, - _check_type, - configuration=configuration - ) - elif isinstance(input_value, dict): - if input_value == {}: - # allow an empty dict - return input_value - for inner_key, inner_val in input_value.items(): - inner_path = list(path_to_item) - inner_path.append(inner_key) - if get_simple_class(inner_key) != str: - raise get_type_error(inner_key, inner_path, valid_classes, - key_type=True) - input_value[inner_key] = validate_and_convert_types( - inner_val, - inner_required_types, - inner_path, - spec_property_naming, - _check_type, - configuration=configuration - ) - return input_value - - -def model_to_dict(model_instance, serialize=True): - """Returns the model properties as a dict - - Args: - model_instance (one of your model instances): the model instance that - will be converted to a dict. - - Keyword Args: - serialize (bool): if True, the keys in the dict will be values from - attribute_map - """ - result = {} - - def extract_item(item): return ( - item[0], model_to_dict( - item[1], serialize=serialize)) if hasattr( - item[1], '_data_store') else item - - model_instances = [model_instance] - if model_instance._composed_schemas: - model_instances.extend(model_instance._composed_instances) - seen_json_attribute_names = set() - used_fallback_python_attribute_names = set() - py_to_json_map = {} - for model_instance in model_instances: - for attr, value in model_instance._data_store.items(): - if serialize: - # we use get here because additional property key names do not - # exist in attribute_map - try: - attr = model_instance.attribute_map[attr] - py_to_json_map.update(model_instance.attribute_map) - seen_json_attribute_names.add(attr) - except KeyError: - used_fallback_python_attribute_names.add(attr) - if isinstance(value, list): - if not value: - # empty list or None - result[attr] = value - else: - res = [] - for v in value: - if isinstance(v, PRIMITIVE_TYPES) or v is None: - res.append(v) - elif isinstance(v, ModelSimple): - res.append(v.value) - elif isinstance(v, dict): - res.append(dict(map( - extract_item, - v.items() - ))) - else: - res.append(model_to_dict(v, serialize=serialize)) - result[attr] = res - elif isinstance(value, dict): - result[attr] = dict(map( - extract_item, - value.items() - )) - elif isinstance(value, ModelSimple): - result[attr] = value.value - elif hasattr(value, '_data_store'): - result[attr] = model_to_dict(value, serialize=serialize) - else: - result[attr] = value - if serialize: - for python_key in used_fallback_python_attribute_names: - json_key = py_to_json_map.get(python_key) - if json_key is None: - continue - if python_key == json_key: - continue - json_key_assigned_no_need_for_python_key = json_key in seen_json_attribute_names - if json_key_assigned_no_need_for_python_key: - del result[python_key] - - return result - - -def type_error_message(var_value=None, var_name=None, valid_classes=None, - key_type=None): - """ - Keyword Args: - var_value (any): the variable which has the type_error - var_name (str): the name of the variable which has the typ error - valid_classes (tuple): the accepted classes for current_item's - value - key_type (bool): False if our value is a value in a dict - True if it is a key in a dict - False if our item is an item in a list - """ - key_or_value = 'value' - if key_type: - key_or_value = 'key' - valid_classes_phrase = get_valid_classes_phrase(valid_classes) - msg = ( - "Invalid type for variable '{0}'. Required {1} type {2} and " - "passed type was {3}".format( - var_name, - key_or_value, - valid_classes_phrase, - type(var_value).__name__, - ) - ) - return msg - - -def get_valid_classes_phrase(input_classes): - """Returns a string phrase describing what types are allowed - """ - all_classes = list(input_classes) - all_classes = sorted(all_classes, key=lambda cls: cls.__name__) - all_class_names = [cls.__name__ for cls in all_classes] - if len(all_class_names) == 1: - return 'is {0}'.format(all_class_names[0]) - return "is one of [{0}]".format(", ".join(all_class_names)) - - -def get_allof_instances(self, model_args, constant_args): - """ - Args: - self: the class we are handling - model_args (dict): var_name to var_value - used to make instances - constant_args (dict): - metadata arguments: - _check_type - _path_to_item - _spec_property_naming - _configuration - _visited_composed_classes - - Returns - composed_instances (list) - """ - composed_instances = [] - for allof_class in self._composed_schemas['allOf']: - - try: - if constant_args.get('_spec_property_naming'): - allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) - else: - allof_instance = allof_class(**model_args, **constant_args) - composed_instances.append(allof_instance) - except Exception as ex: - raise ApiValueError( - "Invalid inputs given to generate an instance of '%s'. The " - "input data was invalid for the allOf schema '%s' in the composed " - "schema '%s'. Error=%s" % ( - allof_class.__name__, - allof_class.__name__, - self.__class__.__name__, - str(ex) - ) - ) from ex - return composed_instances - - -def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): - """ - Find the oneOf schema that matches the input data (e.g. payload). - If exactly one schema matches the input data, an instance of that schema - is returned. - If zero or more than one schema match the input data, an exception is raised. - In OAS 3.x, the payload MUST, by validation, match exactly one of the - schemas described by oneOf. - - Args: - cls: the class we are handling - model_kwargs (dict): var_name to var_value - The input data, e.g. the payload that must match a oneOf schema - in the OpenAPI document. - constant_kwargs (dict): var_name to var_value - args that every model requires, including configuration, server - and path to item. - - Kwargs: - model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): - the value to assign to a primitive class or ModelSimple class - Notes: - - this is only passed in when oneOf includes types which are not object - - None is used to suppress handling of model_arg, nullable models are handled in __new__ - - Returns - oneof_instance (instance) - """ - if len(cls._composed_schemas['oneOf']) == 0: - return None - - oneof_instances = [] - # Iterate over each oneOf schema and determine if the input data - # matches the oneOf schemas. - for oneof_class in cls._composed_schemas['oneOf']: - # The composed oneOf schema allows the 'null' type and the input data - # is the null value. This is a OAS >= 3.1 feature. - if oneof_class is none_type: - # skip none_types because we are deserializing dict data. - # none_type deserialization is handled in the __new__ method - continue - - single_value_input = allows_single_value_input(oneof_class) - - try: - if not single_value_input: - if constant_kwargs.get('_spec_property_naming'): - oneof_instance = oneof_class._from_openapi_data( - **model_kwargs, **constant_kwargs) - else: - oneof_instance = oneof_class(**model_kwargs, **constant_kwargs) - else: - if issubclass(oneof_class, ModelSimple): - if constant_kwargs.get('_spec_property_naming'): - oneof_instance = oneof_class._from_openapi_data( - model_arg, **constant_kwargs) - else: - oneof_instance = oneof_class(model_arg, **constant_kwargs) - elif oneof_class in PRIMITIVE_TYPES: - oneof_instance = validate_and_convert_types( - model_arg, - (oneof_class,), - constant_kwargs['_path_to_item'], - constant_kwargs['_spec_property_naming'], - constant_kwargs['_check_type'], - configuration=constant_kwargs['_configuration'] - ) - oneof_instances.append(oneof_instance) - except Exception: - pass - if len(oneof_instances) == 0: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. None " - "of the oneOf schemas matched the input data." % - cls.__name__ - ) - elif len(oneof_instances) > 1: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. Multiple " - "oneOf schemas matched the inputs, but a max of one is allowed." % - cls.__name__ - ) - return oneof_instances[0] - - -def get_anyof_instances(self, model_args, constant_args): - """ - Args: - self: the class we are handling - model_args (dict): var_name to var_value - The input data, e.g. the payload that must match at least one - anyOf child schema in the OpenAPI document. - constant_args (dict): var_name to var_value - args that every model requires, including configuration, server - and path to item. - - Returns - anyof_instances (list) - """ - anyof_instances = [] - if len(self._composed_schemas['anyOf']) == 0: - return anyof_instances - - for anyof_class in self._composed_schemas['anyOf']: - # The composed oneOf schema allows the 'null' type and the input data - # is the null value. This is a OAS >= 3.1 feature. - if anyof_class is none_type: - # skip none_types because we are deserializing dict data. - # none_type deserialization is handled in the __new__ method - continue - - try: - if constant_args.get('_spec_property_naming'): - anyof_instance = anyof_class._from_openapi_data(**model_args, **constant_args) - else: - anyof_instance = anyof_class(**model_args, **constant_args) - anyof_instances.append(anyof_instance) - except Exception: - pass - if len(anyof_instances) == 0: - raise ApiValueError( - "Invalid inputs given to generate an instance of %s. None of the " - "anyOf schemas matched the inputs." % - self.__class__.__name__ - ) - return anyof_instances - - -def get_discarded_args(self, composed_instances, model_args): - """ - Gathers the args that were discarded by configuration.discard_unknown_keys - """ - model_arg_keys = model_args.keys() - discarded_args = set() - # arguments passed to self were already converted to python names - # before __init__ was called - for instance in composed_instances: - if instance.__class__ in self._composed_schemas['allOf']: - try: - keys = instance.to_dict().keys() - discarded_keys = model_args - keys - discarded_args.update(discarded_keys) - except Exception: - # allOf integer schema will throw exception - pass - else: - try: - all_keys = set(model_to_dict(instance, serialize=False).keys()) - js_keys = model_to_dict(instance, serialize=True).keys() - all_keys.update(js_keys) - discarded_keys = model_arg_keys - all_keys - discarded_args.update(discarded_keys) - except Exception: - # allOf integer schema will throw exception - pass - return discarded_args - - -def validate_get_composed_info(constant_args, model_args, self): - """ - For composed schemas, generate schema instances for - all schemas in the oneOf/anyOf/allOf definition. If additional - properties are allowed, also assign those properties on - all matched schemas that contain additionalProperties. - Openapi schemas are python classes. - - Exceptions are raised if: - - 0 or > 1 oneOf schema matches the model_args input data - - no anyOf schema matches the model_args input data - - any of the allOf schemas do not match the model_args input data - - Args: - constant_args (dict): these are the args that every model requires - model_args (dict): these are the required and optional spec args that - were passed in to make this model - self (class): the class that we are instantiating - This class contains self._composed_schemas - - Returns: - composed_info (list): length three - composed_instances (list): the composed instances which are not - self - var_name_to_model_instances (dict): a dict going from var_name - to the model_instance which holds that var_name - the model_instance may be self or an instance of one of the - classes in self.composed_instances() - additional_properties_model_instances (list): a list of the - model instances which have the property - additional_properties_type. This list can include self - """ - # create composed_instances - composed_instances = [] - allof_instances = get_allof_instances(self, model_args, constant_args) - composed_instances.extend(allof_instances) - oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) - if oneof_instance is not None: - composed_instances.append(oneof_instance) - anyof_instances = get_anyof_instances(self, model_args, constant_args) - composed_instances.extend(anyof_instances) - """ - set additional_properties_model_instances - additional properties must be evaluated at the schema level - so self's additional properties are most important - If self is a composed schema with: - - no properties defined in self - - additionalProperties: False - Then for object payloads every property is an additional property - and they are not allowed, so only empty dict is allowed - - Properties must be set on all matching schemas - so when a property is assigned toa composed instance, it must be set on all - composed instances regardless of additionalProperties presence - keeping it to prevent breaking changes in v5.0.1 - TODO remove cls._additional_properties_model_instances in 6.0.0 - """ - additional_properties_model_instances = [] - if self.additional_properties_type is not None: - additional_properties_model_instances = [self] - - """ - no need to set properties on self in here, they will be set in __init__ - By here all composed schema oneOf/anyOf/allOf instances have their properties set using - model_args - """ - discarded_args = get_discarded_args(self, composed_instances, model_args) - - # map variable names to composed_instances - var_name_to_model_instances = {} - for prop_name in model_args: - if prop_name not in discarded_args: - var_name_to_model_instances[prop_name] = [self] + list( - filter( - lambda x: prop_name in x.openapi_types, composed_instances)) - - return [ - composed_instances, - var_name_to_model_instances, - additional_properties_model_instances, - discarded_args - ] diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/models/__init__.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/models/__init__.py deleted file mode 100644 index dc716671..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/models/__init__.py +++ /dev/null @@ -1,162 +0,0 @@ -# flake8: noqa - -# import all models into this package -# if you have many models here with many references from one model to another this may -# raise a RecursionError -# to avoid this, import only the models that you directly need like: -# from criteo_api_retailmedia_v2023_01.model.pet import Pet -# or import this package, but before doing it, use: -# import sys -# sys.setrecursionlimit(n) - -from criteo_api_retailmedia_v2023_01.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_request import AddToBasketTarget202110Request -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_response import AddToBasketTarget202110Response -from criteo_api_retailmedia_v2023_01.model.application_summary_model import ApplicationSummaryModel -from criteo_api_retailmedia_v2023_01.model.application_summary_model_resource import ApplicationSummaryModelResource -from criteo_api_retailmedia_v2023_01.model.application_summary_model_response import ApplicationSummaryModelResponse -from criteo_api_retailmedia_v2023_01.model.asset import Asset -from criteo_api_retailmedia_v2023_01.model.asset_resource import AssetResource -from criteo_api_retailmedia_v2023_01.model.asset_response import AssetResponse -from criteo_api_retailmedia_v2023_01.model.async_campaigns_report import AsyncCampaignsReport -from criteo_api_retailmedia_v2023_01.model.async_campaigns_report_request import AsyncCampaignsReportRequest -from criteo_api_retailmedia_v2023_01.model.async_campaigns_report_resource import AsyncCampaignsReportResource -from criteo_api_retailmedia_v2023_01.model.async_line_items_report import AsyncLineItemsReport -from criteo_api_retailmedia_v2023_01.model.async_line_items_report_request import AsyncLineItemsReportRequest -from criteo_api_retailmedia_v2023_01.model.async_line_items_report_resource import AsyncLineItemsReportResource -from criteo_api_retailmedia_v2023_01.model.async_report_response import AsyncReportResponse -from criteo_api_retailmedia_v2023_01.model.auction_line_item_create_model_request import AuctionLineItemCreateModelRequest -from criteo_api_retailmedia_v2023_01.model.auction_line_item_paged_list_response import AuctionLineItemPagedListResponse -from criteo_api_retailmedia_v2023_01.model.auction_line_item_response import AuctionLineItemResponse -from criteo_api_retailmedia_v2023_01.model.auction_line_item_update_model_request import AuctionLineItemUpdateModelRequest -from criteo_api_retailmedia_v2023_01.model.audience_ids_update_model202110_request import AudienceIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.audience_target202110_request import AudienceTarget202110Request -from criteo_api_retailmedia_v2023_01.model.audience_target202110_response import AudienceTarget202110Response -from criteo_api_retailmedia_v2023_01.model.balance202110_paged_list_response import Balance202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_list_request import BalanceCampaign202110ListRequest -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.campaign_attributes_v202301 import CampaignAttributesV202301 -from criteo_api_retailmedia_v2023_01.model.campaign_v202301 import CampaignV202301 -from criteo_api_retailmedia_v2023_01.model.category202204 import Category202204 -from criteo_api_retailmedia_v2023_01.model.category202204_list_response import Category202204ListResponse -from criteo_api_retailmedia_v2023_01.model.choice_option import ChoiceOption -from criteo_api_retailmedia_v2023_01.model.choice_variable_specification import ChoiceVariableSpecification -from criteo_api_retailmedia_v2023_01.model.common_error import CommonError -from criteo_api_retailmedia_v2023_01.model.common_line_item_paged_list_response import CommonLineItemPagedListResponse -from criteo_api_retailmedia_v2023_01.model.common_line_item_response import CommonLineItemResponse -from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem -from criteo_api_retailmedia_v2023_01.model.common_warning import CommonWarning -from criteo_api_retailmedia_v2023_01.model.creative202110 import Creative202110 -from criteo_api_retailmedia_v2023_01.model.creative202110_list_response import Creative202110ListResponse -from criteo_api_retailmedia_v2023_01.model.editable_campaign_attributes_v202301 import EditableCampaignAttributesV202301 -from criteo_api_retailmedia_v2023_01.model.external_account import ExternalAccount -from criteo_api_retailmedia_v2023_01.model.external_add_to_basket_ids_update_model202110 import ExternalAddToBasketIdsUpdateModel202110 -from criteo_api_retailmedia_v2023_01.model.external_add_to_basket_target202110 import ExternalAddToBasketTarget202110 -from criteo_api_retailmedia_v2023_01.model.external_auction_line_item import ExternalAuctionLineItem -from criteo_api_retailmedia_v2023_01.model.external_auction_line_item_create_model import ExternalAuctionLineItemCreateModel -from criteo_api_retailmedia_v2023_01.model.external_auction_line_item_update_model import ExternalAuctionLineItemUpdateModel -from criteo_api_retailmedia_v2023_01.model.external_audience_ids_update_model202110 import ExternalAudienceIdsUpdateModel202110 -from criteo_api_retailmedia_v2023_01.model.external_audience_target202110 import ExternalAudienceTarget202110 -from criteo_api_retailmedia_v2023_01.model.external_balance202110 import ExternalBalance202110 -from criteo_api_retailmedia_v2023_01.model.external_brand import ExternalBrand -from criteo_api_retailmedia_v2023_01.model.external_catalog_request import ExternalCatalogRequest -from criteo_api_retailmedia_v2023_01.model.external_catalog_status import ExternalCatalogStatus -from criteo_api_retailmedia_v2023_01.model.external_common_line_item import ExternalCommonLineItem -from criteo_api_retailmedia_v2023_01.model.external_keyword_target202110 import ExternalKeywordTarget202110 -from criteo_api_retailmedia_v2023_01.model.external_line_item_capping202110 import ExternalLineItemCapping202110 -from criteo_api_retailmedia_v2023_01.model.external_line_item_page202110 import ExternalLineItemPage202110 -from criteo_api_retailmedia_v2023_01.model.external_line_item_page_category202110 import ExternalLineItemPageCategory202110 -from criteo_api_retailmedia_v2023_01.model.external_preferred_line_item202110 import ExternalPreferredLineItem202110 -from criteo_api_retailmedia_v2023_01.model.external_preferred_line_item_create_model202110 import ExternalPreferredLineItemCreateModel202110 -from criteo_api_retailmedia_v2023_01.model.external_preferred_line_item_update_model202110 import ExternalPreferredLineItemUpdateModel202110 -from criteo_api_retailmedia_v2023_01.model.external_promoted_product202110 import ExternalPromotedProduct202110 -from criteo_api_retailmedia_v2023_01.model.external_retailer import ExternalRetailer -from criteo_api_retailmedia_v2023_01.model.external_retailer_pages202110 import ExternalRetailerPages202110 -from criteo_api_retailmedia_v2023_01.model.external_store_ids_update_model202110 import ExternalStoreIdsUpdateModel202110 -from criteo_api_retailmedia_v2023_01.model.external_store_target202110 import ExternalStoreTarget202110 -from criteo_api_retailmedia_v2023_01.model.files_variables_specification import FilesVariablesSpecification -from criteo_api_retailmedia_v2023_01.model.input_resource_of_auction_line_item_create_model import InputResourceOfAuctionLineItemCreateModel -from criteo_api_retailmedia_v2023_01.model.input_resource_of_preferred_line_item_create_model202110 import InputResourceOfPreferredLineItemCreateModel202110 -from criteo_api_retailmedia_v2023_01.model.json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_account_and_account import JsonApiBodyWithIdOfInt64AndAccountAndAccount -from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_brand_and_brand import JsonApiBodyWithIdOfInt64AndBrandAndBrand -from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301 import JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status import JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus -from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers import JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers -from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_retailer_and_retailer import JsonApiBodyWithIdOfInt64AndRetailerAndRetailer -from criteo_api_retailmedia_v2023_01.model.json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_body_without_id_of_catalog_request_and_catalog_request import JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_campaign_v202301 import JsonApiPageResponseOfCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer -from criteo_api_retailmedia_v2023_01.model.json_api_request_of_catalog_request import JsonApiRequestOfCatalogRequest -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_request import KeywordTarget202110Request -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_response import KeywordTarget202110Response -from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers import LineItemBidMultipliers -from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest -from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse -from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata -from criteo_api_retailmedia_v2023_01.model.post_campaign_v202301 import PostCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.preferred_line_item202110_paged_list_response import PreferredLineItem202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.preferred_line_item202110_response import PreferredLineItem202110Response -from criteo_api_retailmedia_v2023_01.model.preferred_line_item_create_model202110_request import PreferredLineItemCreateModel202110Request -from criteo_api_retailmedia_v2023_01.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.put_campaign_v202301 import PutCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.report_outcome import ReportOutcome -from criteo_api_retailmedia_v2023_01.model.resource_of_auction_line_item import ResourceOfAuctionLineItem -from criteo_api_retailmedia_v2023_01.model.resource_of_auction_line_item_update_model import ResourceOfAuctionLineItemUpdateModel -from criteo_api_retailmedia_v2023_01.model.resource_of_balance202110 import ResourceOfBalance202110 -from criteo_api_retailmedia_v2023_01.model.resource_of_balance_campaign202110 import ResourceOfBalanceCampaign202110 -from criteo_api_retailmedia_v2023_01.model.resource_of_category202204 import ResourceOfCategory202204 -from criteo_api_retailmedia_v2023_01.model.resource_of_common_line_item import ResourceOfCommonLineItem -from criteo_api_retailmedia_v2023_01.model.resource_of_creative202110 import ResourceOfCreative202110 -from criteo_api_retailmedia_v2023_01.model.resource_of_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers -from criteo_api_retailmedia_v2023_01.model.resource_of_preferred_line_item202110 import ResourceOfPreferredLineItem202110 -from criteo_api_retailmedia_v2023_01.model.resource_of_preferred_line_item_update_model202110 import ResourceOfPreferredLineItemUpdateModel202110 -from criteo_api_retailmedia_v2023_01.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 -from criteo_api_retailmedia_v2023_01.model.resource_of_template import ResourceOfTemplate -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v2 import RmLegacyAudienceCreateEntityV2 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v2_resource import RmLegacyAudienceCreateEntityV2Resource -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v2_response import RmLegacyAudienceCreateEntityV2Response -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_input_entity_v1 import RmLegacyAudienceCreateInputEntityV1 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_input_entity_v2 import RmLegacyAudienceCreateInputEntityV2 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v1 import RmLegacyAudienceGetEntityV1 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v1_resource import RmLegacyAudienceGetEntityV1Resource -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v2 import RmLegacyAudienceGetEntityV2 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v2_resource import RmLegacyAudienceGetEntityV2Resource -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_user_behavior_create_v2 import RmLegacyAudienceUserBehaviorCreateV2 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_user_behavior_details_v2 import RmLegacyAudienceUserBehaviorDetailsV2 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList -from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 -from criteo_api_retailmedia_v2023_01.model.section import Section -from criteo_api_retailmedia_v2023_01.model.status_response import StatusResponse -from criteo_api_retailmedia_v2023_01.model.status_response_resource import StatusResponseResource -from criteo_api_retailmedia_v2023_01.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.store_target202110_request import StoreTarget202110Request -from criteo_api_retailmedia_v2023_01.model.store_target202110_response import StoreTarget202110Response -from criteo_api_retailmedia_v2023_01.model.template import Template -from criteo_api_retailmedia_v2023_01.model.template_list_response import TemplateListResponse -from criteo_api_retailmedia_v2023_01.model.template_response import TemplateResponse -from criteo_api_retailmedia_v2023_01.model.template_variable import TemplateVariable -from criteo_api_retailmedia_v2023_01.model.text_variable_specification import TextVariableSpecification -from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_add_to_basket_ids_update_model202110 import ValueTypeResourceOfAddToBasketIdsUpdateModel202110 -from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_add_to_basket_target202110 import ValueTypeResourceOfAddToBasketTarget202110 -from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_audience_ids_update_model202110 import ValueTypeResourceOfAudienceIdsUpdateModel202110 -from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_audience_target202110 import ValueTypeResourceOfAudienceTarget202110 -from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_keyword_target202110 import ValueTypeResourceOfKeywordTarget202110 -from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_store_ids_update_model202110 import ValueTypeResourceOfStoreIdsUpdateModel202110 -from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_store_target202110 import ValueTypeResourceOfStoreTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/rest.py b/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/rest.py deleted file mode 100644 index 086bd95e..00000000 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/rest.py +++ /dev/null @@ -1,352 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-01 - Generated by: https://openapi-generator.tech -""" - - -import io -import json -import logging -import re -import ssl -from urllib.parse import urlencode -from urllib.parse import urlparse -from urllib.request import proxy_bypass_environment -import urllib3 -import ipaddress - -from criteo_api_retailmedia_v2023_01.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError - - -logger = logging.getLogger(__name__) - - -class RESTResponse(io.IOBase): - - def __init__(self, resp): - self.urllib3_response = resp - self.status = resp.status - self.reason = resp.reason - self.data = resp.data - - def getheaders(self): - """Returns a dictionary of the response headers.""" - return self.urllib3_response.getheaders() - - def getheader(self, name, default=None): - """Returns a given response header.""" - return self.urllib3_response.getheader(name, default) - - -class RESTClientObject(object): - - def __init__(self, configuration, pools_size=4, maxsize=None): - # urllib3.PoolManager will pass all kw parameters to connectionpool - # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 - # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 - # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 - # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 - - # cert_reqs - if configuration.verify_ssl: - cert_reqs = ssl.CERT_REQUIRED - else: - cert_reqs = ssl.CERT_NONE - - addition_pool_args = {} - if configuration.assert_hostname is not None: - addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 - - if configuration.retries is not None: - addition_pool_args['retries'] = configuration.retries - - if configuration.socket_options is not None: - addition_pool_args['socket_options'] = configuration.socket_options - - if maxsize is None: - if configuration.connection_pool_maxsize is not None: - maxsize = configuration.connection_pool_maxsize - else: - maxsize = 4 - - # https pool manager - if configuration.proxy and not should_bypass_proxies( - configuration.host, no_proxy=configuration.no_proxy or ''): - self.pool_manager = urllib3.ProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=configuration.ssl_ca_cert, - cert_file=configuration.cert_file, - key_file=configuration.key_file, - proxy_url=configuration.proxy, - proxy_headers=configuration.proxy_headers, - **addition_pool_args - ) - else: - self.pool_manager = urllib3.PoolManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=configuration.ssl_ca_cert, - cert_file=configuration.cert_file, - key_file=configuration.key_file, - **addition_pool_args - ) - - def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None, _preload_content=True, - _request_timeout=None): - """Perform requests. - - :param method: http request method - :param url: http request url - :param query_params: query parameters in the url - :param headers: http request headers - :param body: request json body, for `application/json` - :param post_params: request post parameters, - `application/x-www-form-urlencoded` - and `multipart/form-data` - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: 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. - """ - method = method.upper() - assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', - 'PATCH', 'OPTIONS'] - - if post_params and body: - raise ApiValueError( - "body parameter cannot be used with post_params parameter." - ) - - post_params = post_params or {} - headers = headers or {} - - timeout = None - if _request_timeout: - if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 - timeout = urllib3.Timeout(total=_request_timeout) - elif (isinstance(_request_timeout, tuple) and - len(_request_timeout) == 2): - timeout = urllib3.Timeout( - connect=_request_timeout[0], read=_request_timeout[1]) - - try: - # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` - if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: - # Only set a default Content-Type for POST, PUT, PATCH and OPTIONS requests - if (method != 'DELETE') and ('Content-Type' not in headers): - headers['Content-Type'] = 'application/json' - if query_params: - url += '?' + urlencode(query_params) - if ('Content-Type' not in headers) or (re.search('json', - headers['Content-Type'], re.IGNORECASE)): - request_body = None - if body is not None: - request_body = json.dumps(body) - r = self.pool_manager.request( - method, url, - body=request_body, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 - r = self.pool_manager.request( - method, url, - fields=post_params, - encode_multipart=False, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - elif headers['Content-Type'] == 'multipart/form-data': - # must del headers['Content-Type'], or the correct - # Content-Type which generated by urllib3 will be - # overwritten. - del headers['Content-Type'] - r = self.pool_manager.request( - method, url, - fields=post_params, - encode_multipart=True, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - # Pass a `string` parameter directly in the body to support - # other content types than Json when `body` argument is - # provided in serialized form - elif isinstance(body, str) or isinstance(body, bytes): - request_body = body - r = self.pool_manager.request( - method, url, - body=request_body, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - else: - # Cannot generate the request from given parameters - msg = """Cannot prepare a request message for provided - arguments. Please check that your arguments match - declared content type.""" - raise ApiException(status=0, reason=msg) - # For `GET`, `HEAD` - else: - r = self.pool_manager.request(method, url, - fields=query_params, - preload_content=_preload_content, - timeout=timeout, - headers=headers) - except urllib3.exceptions.SSLError as e: - msg = "{0}\n{1}".format(type(e).__name__, str(e)) - raise ApiException(status=0, reason=msg) - - if _preload_content: - r = RESTResponse(r) - - # log response body - logger.debug("response body: %s", r.data) - - if not 200 <= r.status <= 299: - if r.status == 401: - raise UnauthorizedException(http_resp=r) - - if r.status == 403: - raise ForbiddenException(http_resp=r) - - if r.status == 404: - raise NotFoundException(http_resp=r) - - if 500 <= r.status <= 599: - raise ServiceException(http_resp=r) - - raise ApiException(http_resp=r) - - return r - - def GET(self, url, headers=None, query_params=None, _preload_content=True, - _request_timeout=None): - return self.request("GET", url, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - query_params=query_params) - - def HEAD(self, url, headers=None, query_params=None, _preload_content=True, - _request_timeout=None): - return self.request("HEAD", url, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - query_params=query_params) - - def OPTIONS(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("OPTIONS", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def DELETE(self, url, headers=None, query_params=None, body=None, - _preload_content=True, _request_timeout=None): - return self.request("DELETE", url, - headers=headers, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def POST(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("POST", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def PUT(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("PUT", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def PATCH(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("PATCH", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - -# end of class RESTClientObject - - -def is_ipv4(target): - """ Test if IPv4 address or not - """ - try: - chk = ipaddress.IPv4Address(target) - return True - except ipaddress.AddressValueError: - return False - - -def in_ipv4net(target, net): - """ Test if target belongs to given IPv4 network - """ - try: - nw = ipaddress.IPv4Network(net) - ip = ipaddress.IPv4Address(target) - if ip in nw: - return True - return False - except ipaddress.AddressValueError: - return False - except ipaddress.NetmaskValueError: - return False - - -def should_bypass_proxies(url, no_proxy=None): - """ Yet another requests.should_bypass_proxies - Test if proxies should not be used for a particular url. - """ - - parsed = urlparse(url) - - # special cases - if parsed.hostname in [None, '']: - return True - - # special cases - if no_proxy in [None, '']: - return False - if no_proxy == '*': - return True - - no_proxy = no_proxy.lower().replace(' ', ''); - entries = ( - host for host in no_proxy.split(',') if host - ) - - if is_ipv4(parsed.hostname): - for item in entries: - if in_ipv4net(parsed.hostname, item): - return True - return proxy_bypass_environment(parsed.hostname, {'no': no_proxy}) diff --git a/sdks/retailmedia_2023-01/docs/AnalyticsApi.md b/sdks/retailmedia_2023-01/docs/AnalyticsApi.md deleted file mode 100644 index 49b2c1ac..00000000 --- a/sdks/retailmedia_2023-01/docs/AnalyticsApi.md +++ /dev/null @@ -1,411 +0,0 @@ -# criteo_api_retailmedia_v2023_01.AnalyticsApi - -All URIs are relative to *https://api.criteo.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**generate_async_campaigns_report**](AnalyticsApi.md#generate_async_campaigns_report) | **POST** /2023-01/retail-media/reports/campaigns | -[**generate_async_line_items_report**](AnalyticsApi.md#generate_async_line_items_report) | **POST** /2023-01/retail-media/reports/line-items | -[**get_async_export_output**](AnalyticsApi.md#get_async_export_output) | **GET** /2023-01/retail-media/reports/{reportId}/output | -[**get_async_export_status**](AnalyticsApi.md#get_async_export_status) | **GET** /2023-01/retail-media/reports/{reportId}/status | - - -# **generate_async_campaigns_report** -> AsyncReportResponse generate_async_campaigns_report(async_campaigns_report_request) - - - -Return an asynchronous Campaigns Report - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import analytics_api -from criteo_api_retailmedia_v2023_01.model.async_report_response import AsyncReportResponse -from criteo_api_retailmedia_v2023_01.model.async_campaigns_report_request import AsyncCampaignsReportRequest -from criteo_api_retailmedia_v2023_01.model.report_outcome import ReportOutcome -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = analytics_api.AnalyticsApi(api_client) - async_campaigns_report_request = AsyncCampaignsReportRequest( - data=AsyncCampaignsReportResource( - type="type_example", - attributes=AsyncCampaignsReport( - 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", - 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", - ), - ), - ) # AsyncCampaignsReportRequest | - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.generate_async_campaigns_report(async_campaigns_report_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->generate_async_campaigns_report: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **async_campaigns_report_request** | [**AsyncCampaignsReportRequest**](AsyncCampaignsReportRequest.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_line_items_report** -> AsyncReportResponse generate_async_line_items_report(async_line_items_report_request) - - - -Returns an asynchronous Line Items Report - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import analytics_api -from criteo_api_retailmedia_v2023_01.model.async_report_response import AsyncReportResponse -from criteo_api_retailmedia_v2023_01.model.async_line_items_report_request import AsyncLineItemsReportRequest -from criteo_api_retailmedia_v2023_01.model.report_outcome import ReportOutcome -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = analytics_api.AnalyticsApi(api_client) - async_line_items_report_request = AsyncLineItemsReportRequest( - data=AsyncLineItemsReportResource( - type="type_example", - attributes=AsyncLineItemsReport( - 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", - 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", - ), - ), - ) # AsyncLineItemsReportRequest | - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.generate_async_line_items_report(async_line_items_report_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->generate_async_line_items_report: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **async_line_items_report_request** | [**AsyncLineItemsReportRequest**](AsyncLineItemsReportRequest.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) - -# **get_async_export_output** -> str get_async_export_output(report_id) - - - -Returns the output of an async report - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import analytics_api -from criteo_api_retailmedia_v2023_01.model.report_outcome import ReportOutcome -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = analytics_api.AnalyticsApi(api_client) - report_id = "reportId_example" # str | The ID of the report to retrieve - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_async_export_output(report_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->get_async_export_output: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_id** | **str**| The ID of the report to retrieve | - -### Return type - -**str** - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **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) - -# **get_async_export_status** -> AsyncReportResponse get_async_export_status(report_id) - - - -Returns the status of an async report - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import analytics_api -from criteo_api_retailmedia_v2023_01.model.async_report_response import AsyncReportResponse -from criteo_api_retailmedia_v2023_01.model.report_outcome import ReportOutcome -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = analytics_api.AnalyticsApi(api_client) - report_id = "reportId_example" # str | The ID of the report to retrieve - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_async_export_status(report_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AnalyticsApi->get_async_export_status: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_id** | **str**| The ID of the report to retrieve | - -### Return type - -[**AsyncReportResponse**](AsyncReportResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **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) - diff --git a/sdks/retailmedia_2023-01/docs/AudienceApi.md b/sdks/retailmedia_2023-01/docs/AudienceApi.md deleted file mode 100644 index cddd57b5..00000000 --- a/sdks/retailmedia_2023-01/docs/AudienceApi.md +++ /dev/null @@ -1,448 +0,0 @@ -# criteo_api_retailmedia_v2023_01.AudienceApi - -All URIs are relative to *https://api.criteo.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**legacy_create_audience_v1**](AudienceApi.md#legacy_create_audience_v1) | **POST** /2023-01/retail-media/accounts/{accountId}/audiences | -[**legacy_get_audience_v1**](AudienceApi.md#legacy_get_audience_v1) | **GET** /2023-01/retail-media/accounts/{accountId}/audiences | -[**legacy_get_audience_v2**](AudienceApi.md#legacy_get_audience_v2) | **GET** /2023-01/retail-media/v2/accounts/{accountId}/audiences | -[**legacy_update_audience_v2**](AudienceApi.md#legacy_update_audience_v2) | **POST** /2023-01/retail-media/v2/accounts/{accountId}/audiences | - - -# **legacy_create_audience_v1** -> RmLegacyAudienceCreateEntityV1Response legacy_create_audience_v1(account_id, rm_legacy_audience_create_input_entity_v1) - - - -Create an Audience (deprecated Public API) - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import audience_api -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_input_entity_v1 import RmLegacyAudienceCreateInputEntityV1 -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - account_id = 1 # int | ID of the account to which this audience belongs. - rm_legacy_audience_create_input_entity_v1 = RmLegacyAudienceCreateInputEntityV1( - data=RmLegacyAudienceCreateEntityV1Resource( - attributes=RmLegacyAudienceCreateEntityV1( - user_type="viewer", - lookback_window="P7D", - brand_ids=[ - 1, - ], - category_ids=[ - 1, - ], - retailer_id=1, - name="name_example", - ), - id="id_example", - type="type_example", - ), - ) # RmLegacyAudienceCreateInputEntityV1 | Audience creation request. - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.legacy_create_audience_v1(account_id, rm_legacy_audience_create_input_entity_v1) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->legacy_create_audience_v1: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **int**| ID of the account to which this audience belongs. | - **rm_legacy_audience_create_input_entity_v1** | [**RmLegacyAudienceCreateInputEntityV1**](RmLegacyAudienceCreateInputEntityV1.md)| Audience creation request. | - -### Return type - -[**RmLegacyAudienceCreateEntityV1Response**](RmLegacyAudienceCreateEntityV1Response.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 | - | -**201** | The audience that was just created. | - | -**400** | Bad request | - | -**401** | The API client is not properly authenticated. | - | -**403** | The API client is not authorized to access this resource. | - | - -[[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) - -# **legacy_get_audience_v1** -> RmLegacyAudienceGetEntityV1ListResponse legacy_get_audience_v1(account_id) - - - -Get a page of Audiences. (deprecated Public API) - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import audience_api -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - account_id = 1 # int | ID of the account to which this audience belongs. - limit_to_id = [ - 1, - ] # [int] | Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 (optional) - page_size = 1 # int | Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. (optional) - page_index = 1 # int | Returns the specified page of results given a pageSize; pages are 0-indexed. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.legacy_get_audience_v1(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->legacy_get_audience_v1: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.legacy_get_audience_v1(account_id, limit_to_id=limit_to_id, page_size=page_size, page_index=page_index) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->legacy_get_audience_v1: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **int**| ID of the account to which this audience belongs. | - **limit_to_id** | **[int]**| Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 | [optional] - **page_size** | **int**| Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. | [optional] - **page_index** | **int**| Returns the specified page of results given a pageSize; pages are 0-indexed. | [optional] - -### Return type - -[**RmLegacyAudienceGetEntityV1ListResponse**](RmLegacyAudienceGetEntityV1ListResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A page of audiences for the supplied account or shared by related retailers. | - | -**400** | Bad request | - | -**401** | The API client is not properly authenticated. | - | -**403** | The API client is not authorized to access this resource. | - | - -[[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) - -# **legacy_get_audience_v2** -> RmLegacyAudienceGetEntityV2ListResponse legacy_get_audience_v2(account_id) - - - -Get a page of Audiences. (deprecated Public API) - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import audience_api -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - account_id = 1 # int | ID of the account to which this audience belongs. - limit_to_id = [ - 1, - ] # [int] | Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 (optional) - page_size = 1 # int | Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. (optional) - page_index = 1 # int | Returns the specified page of results given a pageSize; pages are 0-indexed. (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.legacy_get_audience_v2(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->legacy_get_audience_v2: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.legacy_get_audience_v2(account_id, limit_to_id=limit_to_id, page_size=page_size, page_index=page_index) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->legacy_get_audience_v2: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **int**| ID of the account to which this audience belongs. | - **limit_to_id** | **[int]**| Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 | [optional] - **page_size** | **int**| Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. | [optional] - **page_index** | **int**| Returns the specified page of results given a pageSize; pages are 0-indexed. | [optional] - -### Return type - -[**RmLegacyAudienceGetEntityV2ListResponse**](RmLegacyAudienceGetEntityV2ListResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A page of audiences for the supplied account or shared by related retailers. | - | -**400** | Bad request | - | -**401** | The API client is not properly authenticated. | - | -**403** | The API client is not authorized to access this resource. | - | - -[[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) - -# **legacy_update_audience_v2** -> RmLegacyAudienceCreateEntityV2Response legacy_update_audience_v2(account_id, rm_legacy_audience_create_input_entity_v2) - - - -Create an Audience (deprecated Public API) - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import audience_api -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_input_entity_v2 import RmLegacyAudienceCreateInputEntityV2 -from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v2_response import RmLegacyAudienceCreateEntityV2Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = audience_api.AudienceApi(api_client) - account_id = 1 # int | ID of the account to which this audience belongs. - rm_legacy_audience_create_input_entity_v2 = RmLegacyAudienceCreateInputEntityV2( - data=RmLegacyAudienceCreateEntityV2Resource( - attributes=RmLegacyAudienceCreateEntityV2( - retailer_id=1, - user_behavior_details=RmLegacyAudienceUserBehaviorCreateV2( - inclusive_segment=RmLegacySegmentUserBehaviorCreateV2( - user_action="buy", - lookback_window="P7D", - category_ids=[ - 1, - ], - brand_ids=[ - 1, - ], - ), - exclusive_segment=RmLegacySegmentUserBehaviorCreateV2( - user_action="buy", - lookback_window="P7D", - category_ids=[ - 1, - ], - brand_ids=[ - 1, - ], - ), - ), - name="name_example", - ), - id="id_example", - type="type_example", - ), - ) # RmLegacyAudienceCreateInputEntityV2 | Audience creation request. - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.legacy_update_audience_v2(account_id, rm_legacy_audience_create_input_entity_v2) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling AudienceApi->legacy_update_audience_v2: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **int**| ID of the account to which this audience belongs. | - **rm_legacy_audience_create_input_entity_v2** | [**RmLegacyAudienceCreateInputEntityV2**](RmLegacyAudienceCreateInputEntityV2.md)| Audience creation request. | - -### Return type - -[**RmLegacyAudienceCreateEntityV2Response**](RmLegacyAudienceCreateEntityV2Response.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 | - | -**201** | The audience that was just created. | - | -**400** | Bad request | - | -**401** | The API client is not properly authenticated. | - | -**403** | The API client is not authorized to access this resource. | - | - -[[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_2023-01/docs/Balance202110PagedListResponse.md b/sdks/retailmedia_2023-01/docs/Balance202110PagedListResponse.md deleted file mode 100644 index 880c26b5..00000000 --- a/sdks/retailmedia_2023-01/docs/Balance202110PagedListResponse.md +++ /dev/null @@ -1,16 +0,0 @@ -# Balance202110PagedListResponse - -Data model for a paged list of response resources - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**metadata** | [**PageMetadata**](PageMetadata.md) | | [optional] -**data** | [**[ResourceOfBalance202110]**](ResourceOfBalance202110.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_2023-01/docs/CampaignApi.md b/sdks/retailmedia_2023-01/docs/CampaignApi.md deleted file mode 100644 index 218852b5..00000000 --- a/sdks/retailmedia_2023-01/docs/CampaignApi.md +++ /dev/null @@ -1,5301 +0,0 @@ -# criteo_api_retailmedia_v2023_01.CampaignApi - -All URIs are relative to *https://api.criteo.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_asset**](CampaignApi.md#create_asset) | **POST** /2023-01/retail-media/assets | -[**get_api202110_external_account_balances_by_account_id**](CampaignApi.md#get_api202110_external_account_balances_by_account_id) | **GET** /2023-01/retail-media/accounts/{account-id}/balances | -[**get_api202110_external_account_creatives_by_account_id**](CampaignApi.md#get_api202110_external_account_creatives_by_account_id) | **GET** /2023-01/retail-media/accounts/{account-id}/creatives | -[**get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id**](CampaignApi.md#get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id) | **GET** /2023-01/retail-media/auction-line-items/{line-item-id}/targeting/keywords | -[**get_api202110_external_balance_campaigns_by_balance_id**](CampaignApi.md#get_api202110_external_balance_campaigns_by_balance_id) | **GET** /2023-01/retail-media/balances/{balance-id}/campaigns | -[**get_api202110_external_campaign_preferred_line_items_by_campaign_id**](CampaignApi.md#get_api202110_external_campaign_preferred_line_items_by_campaign_id) | **GET** /2023-01/retail-media/campaigns/{campaign-id}/preferred-line-items | -[**get_api202110_external_line_item_products_by_line_item_id**](CampaignApi.md#get_api202110_external_line_item_products_by_line_item_id) | **GET** /2023-01/retail-media/line-items/{line-item-id}/products | -[**get_api202110_external_preferred_line_item_by_line_item_id**](CampaignApi.md#get_api202110_external_preferred_line_item_by_line_item_id) | **GET** /2023-01/retail-media/preferred-line-items/{line-item-id} | -[**get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id**](CampaignApi.md#get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id) | **GET** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket | -[**get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id**](CampaignApi.md#get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id) | **GET** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences | -[**get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id**](CampaignApi.md#get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id) | **GET** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores | -[**get_api202110_external_retailer_pages_by_retailer_id**](CampaignApi.md#get_api202110_external_retailer_pages_by_retailer_id) | **GET** /2023-01/retail-media/retailers/{retailerId}/pages | -[**get_api202204_external_categorie_by_category_id**](CampaignApi.md#get_api202204_external_categorie_by_category_id) | **GET** /2023-01/retail-media/categories/{categoryId} | -[**get_api202204_external_categories**](CampaignApi.md#get_api202204_external_categories) | **GET** /2023-01/retail-media/categories | -[**get_api202207_external_retailer_by_retailer_id_templatestemplate_id**](CampaignApi.md#get_api202207_external_retailer_by_retailer_id_templatestemplate_id) | **GET** /2023-01/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** /2023-01/retail-media/retailers/{retailer-id}/templates | -[**get_api202301_external_account_campaigns_by_account_id**](CampaignApi.md#get_api202301_external_account_campaigns_by_account_id) | **GET** /2023-01/retail-media/accounts/{account-id}/campaigns | -[**get_api202301_external_campaign_by_campaign_id**](CampaignApi.md#get_api202301_external_campaign_by_campaign_id) | **GET** /2023-01/retail-media/campaigns/{campaignId} | -[**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** /2023-01/retail-media/line-items/{line-item-id}/bid-multipliers | -[**get_api_v1_external_account_brands_by_account_id**](CampaignApi.md#get_api_v1_external_account_brands_by_account_id) | **GET** /2023-01/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** /2023-01/retail-media/accounts/{accountId}/retailers | -[**get_api_v1_external_accounts**](CampaignApi.md#get_api_v1_external_accounts) | **GET** /2023-01/retail-media/accounts | -[**get_api_v1_external_catalog_output_by_catalog_id**](CampaignApi.md#get_api_v1_external_catalog_output_by_catalog_id) | **GET** /2023-01/retail-media/catalogs/{catalogId}/output | -[**get_api_v1_external_catalog_status_by_catalog_id**](CampaignApi.md#get_api_v1_external_catalog_status_by_catalog_id) | **GET** /2023-01/retail-media/catalogs/{catalogId}/status | -[**get_api_v2_external_account_line_items_by_account_id**](CampaignApi.md#get_api_v2_external_account_line_items_by_account_id) | **GET** /2023-01/retail-media/accounts/{account-id}/line-items | -[**get_api_v2_external_auction_line_item_by_line_item_id**](CampaignApi.md#get_api_v2_external_auction_line_item_by_line_item_id) | **GET** /2023-01/retail-media/auction-line-items/{line-item-id} | -[**get_api_v2_external_campaign_auction_line_items_by_campaign_id**](CampaignApi.md#get_api_v2_external_campaign_auction_line_items_by_campaign_id) | **GET** /2023-01/retail-media/campaigns/{campaign-id}/auction-line-items | -[**get_api_v2_external_line_item_by_line_item_id**](CampaignApi.md#get_api_v2_external_line_item_by_line_item_id) | **GET** /2023-01/retail-media/line-items/{line-item-id} | -[**post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id**](CampaignApi.md#post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id) | **POST** /2023-01/retail-media/auction-line-items/{line-item-id}/targeting/keywords/append | -[**post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id) | **POST** /2023-01/retail-media/auction-line-items/{line-item-id}/targeting/keywords/delete | -[**post_api202110_external_balance_campaigns_append_by_balance_id**](CampaignApi.md#post_api202110_external_balance_campaigns_append_by_balance_id) | **POST** /2023-01/retail-media/balances/{balance-id}/campaigns/append | -[**post_api202110_external_balance_campaigns_delete_by_balance_id**](CampaignApi.md#post_api202110_external_balance_campaigns_delete_by_balance_id) | **POST** /2023-01/retail-media/balances/{balance-id}/campaigns/delete | -[**post_api202110_external_campaign_preferred_line_items_by_campaign_id**](CampaignApi.md#post_api202110_external_campaign_preferred_line_items_by_campaign_id) | **POST** /2023-01/retail-media/campaigns/{campaign-id}/preferred-line-items | -[**post_api202110_external_line_item_products_append_by_line_item_id**](CampaignApi.md#post_api202110_external_line_item_products_append_by_line_item_id) | **POST** /2023-01/retail-media/line-items/{line-item-id}/products/append | -[**post_api202110_external_line_item_products_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_line_item_products_delete_by_line_item_id) | **POST** /2023-01/retail-media/line-items/{line-item-id}/products/delete | -[**post_api202110_external_line_item_products_pause_by_line_item_id**](CampaignApi.md#post_api202110_external_line_item_products_pause_by_line_item_id) | **POST** /2023-01/retail-media/line-items/{line-item-id}/products/pause | -[**post_api202110_external_line_item_products_unpause_by_line_item_id**](CampaignApi.md#post_api202110_external_line_item_products_unpause_by_line_item_id) | **POST** /2023-01/retail-media/line-items/{line-item-id}/products/unpause | -[**post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id) | **POST** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append | -[**post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id) | **POST** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete | -[**post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id) | **POST** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append | -[**post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id) | **POST** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete | -[**post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id) | **POST** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append | -[**post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id) | **POST** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete | -[**post_api202301_external_account_campaigns_by_account_id**](CampaignApi.md#post_api202301_external_account_campaigns_by_account_id) | **POST** /2023-01/retail-media/accounts/{account-id}/campaigns | -[**post_api_v1_external_account_catalogs_by_account_id**](CampaignApi.md#post_api_v1_external_account_catalogs_by_account_id) | **POST** /2023-01/retail-media/accounts/{accountId}/catalogs | -[**post_api_v2_external_campaign_auction_line_items_by_campaign_id**](CampaignApi.md#post_api_v2_external_campaign_auction_line_items_by_campaign_id) | **POST** /2023-01/retail-media/campaigns/{campaign-id}/auction-line-items | -[**put_api202110_external_preferred_line_item_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_by_line_item_id) | **PUT** /2023-01/retail-media/preferred-line-items/{line-item-id} | -[**put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id) | **PUT** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket | -[**put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id) | **PUT** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences | -[**put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id) | **PUT** /2023-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores | -[**put_api202301_external_campaign_by_campaign_id**](CampaignApi.md#put_api202301_external_campaign_by_campaign_id) | **PUT** /2023-01/retail-media/campaigns/{campaignId} | -[**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** /2023-01/retail-media/line-items/{line-item-id}/bid-multipliers | -[**put_api_v2_external_auction_line_item_by_line_item_id**](CampaignApi.md#put_api_v2_external_auction_line_item_by_line_item_id) | **PUT** /2023-01/retail-media/auction-line-items/{line-item-id} | - - -# **create_asset** -> AssetResponse create_asset(asset_file) - - - -Creates an asset - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.asset_response import AssetResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - asset_file = open('/path/to/file', 'rb') # file_type | The asset binary content - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.create_asset(asset_file) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->create_asset: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_file** | **file_type**| The asset binary content | - -### Return type - -[**AssetResponse**](AssetResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | 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_api202110_external_account_balances_by_account_id** -> Balance202110PagedListResponse get_api202110_external_account_balances_by_account_id(account_id) - - - -Gets page of balance objects for the given account id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.balance202110_paged_list_response import Balance202110PagedListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The account to get balances for - 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_api202110_external_account_balances_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_account_balances_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_api202110_external_account_balances_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_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_account_balances_by_account_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The account to get balances for | - **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 - -[**Balance202110PagedListResponse**](Balance202110PagedListResponse.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** | 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_api202110_external_account_creatives_by_account_id** -> Creative202110ListResponse get_api202110_external_account_creatives_by_account_id(account_id) - - - -Get account creatives - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.creative202110_list_response import Creative202110ListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202110_external_account_creatives_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_account_creatives_by_account_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| External account id to retrieve creatives for | - -### Return type - -[**Creative202110ListResponse**](Creative202110ListResponse.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 | - | - -[[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_api202110_external_auction_line_item_targeting_keywords_by_line_item_id** -> KeywordTarget202110Response get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id(line_item_id) - - - -This endpoint gets the keyword target on the specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_response import KeywordTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - -### Return type - -[**KeywordTarget202110Response**](KeywordTarget202110Response.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** | 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_api202110_external_balance_campaigns_by_balance_id** -> BalanceCampaign202110PagedListResponse get_api202110_external_balance_campaigns_by_balance_id(balance_id) - - - -Gets page of campaigns for the given balanceId - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - balance_id = "balance-id_example" # str | The balance to get campaigns from - 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_api202110_external_balance_campaigns_by_balance_id(balance_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_balance_campaigns_by_balance_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_api202110_external_balance_campaigns_by_balance_id(balance_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_balance_campaigns_by_balance_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **balance_id** | **str**| The balance to get campaigns from | - **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 - -[**BalanceCampaign202110PagedListResponse**](BalanceCampaign202110PagedListResponse.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** | 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_api202110_external_campaign_preferred_line_items_by_campaign_id** -> PreferredLineItem202110PagedListResponse get_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id) - - - -Gets page of preferred line item objects for the given campaign id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.preferred_line_item202110_paged_list_response import PreferredLineItem202110PagedListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - 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_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_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_api202110_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_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **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 - -[**PreferredLineItem202110PagedListResponse**](PreferredLineItem202110PagedListResponse.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** | 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_api202110_external_line_item_products_by_line_item_id** -> PromotedProduct202110PagedListResponse get_api202110_external_line_item_products_by_line_item_id(line_item_id) - - - -This endpoint gets the promoted products on the specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - 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_api202110_external_line_item_products_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_line_item_products_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_api202110_external_line_item_products_by_line_item_id(line_item_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_line_item_products_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **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 - -[**PromotedProduct202110PagedListResponse**](PromotedProduct202110PagedListResponse.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** | 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_api202110_external_preferred_line_item_by_line_item_id** -> PreferredLineItem202110Response get_api202110_external_preferred_line_item_by_line_item_id(line_item_id) - - - -Gets the preferred line item for the given line item id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.preferred_line_item202110_response import PreferredLineItem202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The given line item id - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202110_external_preferred_line_item_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_preferred_line_item_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The given line item id | - -### Return type - -[**PreferredLineItem202110Response**](PreferredLineItem202110Response.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** | 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_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id** -> AddToBasketTarget202110Response get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id) - - - -This endpoint gets the add to basket target on the specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_response import AddToBasketTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - -### Return type - -[**AddToBasketTarget202110Response**](AddToBasketTarget202110Response.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** | 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_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id** -> AudienceTarget202110Response get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id) - - - -This endpoint gets the audience target on the specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.audience_target202110_response import AudienceTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - -### Return type - -[**AudienceTarget202110Response**](AudienceTarget202110Response.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** | 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_api202110_external_preferred_line_item_targeting_stores_by_line_item_id** -> StoreTarget202110Response get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id) - - - -This endpoint gets the store target on the specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.store_target202110_response import StoreTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - -### Return type - -[**StoreTarget202110Response**](StoreTarget202110Response.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** | 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_api202110_external_retailer_pages_by_retailer_id** -> ExternalRetailerPages202110 get_api202110_external_retailer_pages_by_retailer_id(retailer_id) - - - -Get the page types available for the given retailer - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.external_retailer_pages202110 import ExternalRetailerPages202110 -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - retailer_id = 1 # int | The retailers to fetch pages for - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202110_external_retailer_pages_by_retailer_id(retailer_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202110_external_retailer_pages_by_retailer_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **retailer_id** | **int**| The retailers to fetch pages for | - -### Return type - -[**ExternalRetailerPages202110**](ExternalRetailerPages202110.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** | Pages fetched successfully | - | - -[[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_api202204_external_categorie_by_category_id** -> Category202204 get_api202204_external_categorie_by_category_id(category_id) - - - -Endpoint to search for a specific category by categoryId. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.category202204 import Category202204 -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - category_id = 1 # int | ID of the desired category - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202204_external_categorie_by_category_id(category_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202204_external_categorie_by_category_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **category_id** | **int**| ID of the desired category | - -### Return type - -[**Category202204**](Category202204.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** | Retrieval completed and category is returned. | - | -**400** | No IDs were passed in. | - | -**500** | A non-request input based error occurred in the server. | - | - -[[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_api202204_external_categories** -> Category202204ListResponse get_api202204_external_categories() - - - -Endpoint to search categories by text and retailer. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.category202204_list_response import Category202204ListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 Categories fetched (optional) - text_substring = "textSubstring_example" # str | Query string to search across Categories (optional) - page_index = 0 # int | The start position in the overall list of matches. Must be zero or greater. (optional) if omitted the server will use the default value of 0 - page_size = 100 # int | The maximum number of results to return with each call. Must be greater than zero. (optional) if omitted the server will use the default value of 100 - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.get_api202204_external_categories(retailer_id=retailer_id, text_substring=text_substring, page_index=page_index, page_size=page_size) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202204_external_categories: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **retailer_id** | **int**| The retailer id for which Categories fetched | [optional] - **text_substring** | **str**| Query string to search across Categories | [optional] - **page_index** | **int**| The start position in the overall list of matches. Must be zero or greater. | [optional] if omitted the server will use the default value of 0 - **page_size** | **int**| The maximum number of results to return with each call. Must be greater than zero. | [optional] if omitted the server will use the default value of 100 - -### Return type - -[**Category202204ListResponse**](Category202204ListResponse.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** | Categories 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_api202207_external_retailer_by_retailer_id_templatestemplate_id** -> TemplateResponse get_api202207_external_retailer_by_retailer_id_templatestemplate_id(retailer_id, template_id) - - - -Gets the template for the specified retailer id and template id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.template_response import TemplateResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 - - # 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) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202207_external_retailer_by_retailer_id_templatestemplate_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **retailer_id** | **int**| Retailer Id | - **template_id** | **int**| Template Id | - -### Return type - -[**TemplateResponse**](TemplateResponse.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** | Template found for the retailer | - | - -[[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 retailer creative templates - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.template_list_response import TemplateListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 - - # 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) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202207_external_retailer_templates_by_retailer_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **retailer_id** | **int**| External retailer id to retrieve creative templates for | - -### Return type - -[**TemplateListResponse**](TemplateListResponse.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** | Templates 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_api202301_external_account_campaigns_by_account_id** -> JsonApiPageResponseOfCampaignV202301 get_api202301_external_account_campaigns_by_account_id(account_id) - - - -Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign ids. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.json_api_page_response_of_campaign_v202301 import JsonApiPageResponseOfCampaignV202301 -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The account to request the campaign for. - limit_to_id = [ - "limitToId_example", - ] # [str] | The ids that you would like to limit your result set to (optional) - page_index = 0 # int | The 0 indexed page index you would like to receive given the page size (optional) if omitted the server will use the default value of 0 - page_size = 25 # int | The maximum number of items you would like to receive in this request (optional) if omitted the server will use the default value of 25 - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202301_external_account_campaigns_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202301_external_account_campaigns_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_api202301_external_account_campaigns_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_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202301_external_account_campaigns_by_account_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The account to request the campaign for. | - **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] if omitted the server will use the default value of 0 - **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] if omitted the server will use the default value of 25 - -### Return type - -[**JsonApiPageResponseOfCampaignV202301**](JsonApiPageResponseOfCampaignV202301.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** | 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_api202301_external_campaign_by_campaign_id** -> JsonApiSingleResponseOfCampaignV202301 get_api202301_external_campaign_by_campaign_id(campaign_id) - - - -Get all the editable and creatable campaign attributes including all types of budgets given the campaign id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - campaign_id = "campaignId_example" # str | Campaign Id of the campaign detail - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api202301_external_campaign_by_campaign_id(campaign_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202301_external_campaign_by_campaign_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **campaign_id** | **str**| Campaign Id of the campaign detail | - -### Return type - -[**JsonApiSingleResponseOfCampaignV202301**](JsonApiSingleResponseOfCampaignV202301.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** | 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_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 bid multipliers by line item - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.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. -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 - - # example passing only required values which don't have defaults set - try: - 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_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| Long external id of the associated line item | - -### Return type - -[**JsonApiSingleResponseOfLineItemBidMultipliers**](JsonApiSingleResponseOfLineItemBidMultipliers.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/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) - -# **get_api_v1_external_account_brands_by_account_id** -> JsonApiPageResponseOfBrand get_api_v1_external_account_brands_by_account_id(account_id) - - - -Gets page of retailer objects that are associated with the given account - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.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. -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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_v2023_01.ApiException as 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_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_account_brands_by_account_id: %s\n" % e) -``` - - -### Parameters - -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] - -### Return type - -[**JsonApiPageResponseOfBrand**](JsonApiPageResponseOfBrand.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** | 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_api_v1_external_account_retailers_by_account_id** -> JsonApiPageResponseOfRetailer get_api_v1_external_account_retailers_by_account_id(account_id) - - - -Gets page of retailer objects that are associated with the given account - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.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. -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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_retailers_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as 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_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_account_retailers_by_account_id: %s\n" % e) -``` - - -### Parameters - -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] - -### Return type - -[**JsonApiPageResponseOfRetailer**](JsonApiPageResponseOfRetailer.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** | 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_api_v1_external_accounts** -> JsonApiPageResponseOfAccount get_api_v1_external_accounts() - - - -Gets page of account objects that the current user can access - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.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. -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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) - - # 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) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_accounts: %s\n" % e) -``` - - -### Parameters - -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] - -### Return type - -[**JsonApiPageResponseOfAccount**](JsonApiPageResponseOfAccount.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** | 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_api_v1_external_catalog_output_by_catalog_id** -> get_api_v1_external_catalog_output_by_catalog_id(catalog_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 v2021_07 CatalogProduct json objects. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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. - - # example passing only required values which don't have defaults set - try: - api_instance.get_api_v1_external_catalog_output_by_catalog_id(catalog_id) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_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_v1_external_catalog_status_by_catalog_id** -> JsonApiSingleResponseOfCatalogStatus get_api_v1_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_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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. - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api_v1_external_catalog_status_by_catalog_id(catalog_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v1_external_catalog_status_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 - -[**JsonApiSingleResponseOfCatalogStatus**](JsonApiSingleResponseOfCatalogStatus.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** | Catalog request 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_v2_external_account_line_items_by_account_id** -> CommonLineItemPagedListResponse get_api_v2_external_account_line_items_by_account_id(account_id) - - - -Gets page of line item objects for the given account id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.common_line_item_paged_list_response import CommonLineItemPagedListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The given account id - limit_to_campaign_id = [ - "limitToCampaignId_example", - ] # [str] | The campaign ids that you would like to limit your result set to (optional) - limit_to_type = "Unknown" # str | The campaign types that you would like to limit your result set to (optional) - 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_v2_external_account_line_items_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v2_external_account_line_items_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_v2_external_account_line_items_by_account_id(account_id, limit_to_campaign_id=limit_to_campaign_id, limit_to_type=limit_to_type, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v2_external_account_line_items_by_account_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The given account id | - **limit_to_campaign_id** | **[str]**| The campaign ids that you would like to limit your result set to | [optional] - **limit_to_type** | **str**| The campaign types that you would like to limit your result set to | [optional] - **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 - -[**CommonLineItemPagedListResponse**](CommonLineItemPagedListResponse.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** | 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_api_v2_external_auction_line_item_by_line_item_id** -> AuctionLineItemResponse get_api_v2_external_auction_line_item_by_line_item_id(line_item_id) - - - -Gets the auction line item for the given line item id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.auction_line_item_response import AuctionLineItemResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The given line item id - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api_v2_external_auction_line_item_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v2_external_auction_line_item_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The given line item id | - -### Return type - -[**AuctionLineItemResponse**](AuctionLineItemResponse.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** | 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_v2_external_campaign_auction_line_items_by_campaign_id** -> AuctionLineItemPagedListResponse get_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id) - - - -Gets page of auction line item objects for the given campaign id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.auction_line_item_paged_list_response import AuctionLineItemPagedListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - 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_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v2_external_campaign_auction_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_v2_external_campaign_auction_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_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v2_external_campaign_auction_line_items_by_campaign_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **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 - -[**AuctionLineItemPagedListResponse**](AuctionLineItemPagedListResponse.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** | 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_v2_external_line_item_by_line_item_id** -> CommonLineItemResponse get_api_v2_external_line_item_by_line_item_id(line_item_id) - - - -Gets the line item for the given line item id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.common_line_item_response import CommonLineItemResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The given line item id - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.get_api_v2_external_line_item_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->get_api_v2_external_line_item_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The given line item id | - -### Return type - -[**CommonLineItemResponse**](CommonLineItemResponse.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** | 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) - -# **post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id** -> KeywordTarget202110Response post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id(line_item_id) - - - -This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_request import KeywordTarget202110Request -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_response import KeywordTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - keyword_target202110_request = KeywordTarget202110Request( - data=ValueTypeResourceOfKeywordTarget202110( - type="type_example", - attributes=ExternalKeywordTarget202110( - keywords={ - "unknown": "unknown", - }, - ), - ), - ) # KeywordTarget202110Request | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id(line_item_id, keyword_target202110_request=keyword_target202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **keyword_target202110_request** | [**KeywordTarget202110Request**](KeywordTarget202110Request.md)| | [optional] - -### Return type - -[**KeywordTarget202110Response**](KeywordTarget202110Response.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** | 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) - -# **post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id** -> KeywordTarget202110Response post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id(line_item_id) - - - -This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_request import KeywordTarget202110Request -from criteo_api_retailmedia_v2023_01.model.keyword_target202110_response import KeywordTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - keyword_target202110_request = KeywordTarget202110Request( - data=ValueTypeResourceOfKeywordTarget202110( - type="type_example", - attributes=ExternalKeywordTarget202110( - keywords={ - "unknown": "unknown", - }, - ), - ), - ) # KeywordTarget202110Request | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id(line_item_id, keyword_target202110_request=keyword_target202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **keyword_target202110_request** | [**KeywordTarget202110Request**](KeywordTarget202110Request.md)| | [optional] - -### Return type - -[**KeywordTarget202110Response**](KeywordTarget202110Response.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** | 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) - -# **post_api202110_external_balance_campaigns_append_by_balance_id** -> BalanceCampaign202110PagedListResponse post_api202110_external_balance_campaigns_append_by_balance_id(balance_id) - - - -appends one or more campaigns to the specified balance - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_list_request import BalanceCampaign202110ListRequest -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - balance_id = "balance-id_example" # str | The balance to add campaigns from - balance_campaign202110_list_request = BalanceCampaign202110ListRequest( - data=[ - ResourceOfBalanceCampaign202110( - id="id_example", - type="type_example", - attributes={}, - ), - ], - ) # BalanceCampaign202110ListRequest | The campaigns to append (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_balance_campaigns_append_by_balance_id(balance_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_balance_campaigns_append_by_balance_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_balance_campaigns_append_by_balance_id(balance_id, balance_campaign202110_list_request=balance_campaign202110_list_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_balance_campaigns_append_by_balance_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **balance_id** | **str**| The balance to add campaigns from | - **balance_campaign202110_list_request** | [**BalanceCampaign202110ListRequest**](BalanceCampaign202110ListRequest.md)| The campaigns to append | [optional] - -### Return type - -[**BalanceCampaign202110PagedListResponse**](BalanceCampaign202110PagedListResponse.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** | 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) - -# **post_api202110_external_balance_campaigns_delete_by_balance_id** -> BalanceCampaign202110PagedListResponse post_api202110_external_balance_campaigns_delete_by_balance_id(balance_id) - - - -Removes one or more campaigns on the specified balance - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse -from criteo_api_retailmedia_v2023_01.model.balance_campaign202110_list_request import BalanceCampaign202110ListRequest -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - balance_id = "balance-id_example" # str | The balance to remove campaigns from - balance_campaign202110_list_request = BalanceCampaign202110ListRequest( - data=[ - ResourceOfBalanceCampaign202110( - id="id_example", - type="type_example", - attributes={}, - ), - ], - ) # BalanceCampaign202110ListRequest | The campaigns to append (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_balance_campaigns_delete_by_balance_id(balance_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_balance_campaigns_delete_by_balance_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_balance_campaigns_delete_by_balance_id(balance_id, balance_campaign202110_list_request=balance_campaign202110_list_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_balance_campaigns_delete_by_balance_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **balance_id** | **str**| The balance to remove campaigns from | - **balance_campaign202110_list_request** | [**BalanceCampaign202110ListRequest**](BalanceCampaign202110ListRequest.md)| The campaigns to append | [optional] - -### Return type - -[**BalanceCampaign202110PagedListResponse**](BalanceCampaign202110PagedListResponse.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** | 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) - -# **post_api202110_external_campaign_preferred_line_items_by_campaign_id** -> PreferredLineItem202110Response post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id) - - - -Creates a new preferred line item with the specified settings - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.preferred_line_item_create_model202110_request import PreferredLineItemCreateModel202110Request -from criteo_api_retailmedia_v2023_01.model.preferred_line_item202110_response import PreferredLineItem202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - campaign_id = "campaign-id_example" # str | The given campaign id - preferred_line_item_create_model202110_request = PreferredLineItemCreateModel202110Request( - data=InputResourceOfPreferredLineItemCreateModel202110( - type="type_example", - attributes=ExternalPreferredLineItemCreateModel202110( - name="name_example", - start_date=dateutil_parser('1970-01-01').date(), - end_date=dateutil_parser('1970-01-01').date(), - status="unknown", - pacing="unknown", - capping=ExternalLineItemCapping202110( - type="unknown", - count=1, - ), - page=ExternalLineItemPage202110( - page_type="search", - categories=[ - ExternalLineItemPageCategory202110( - category_id="category_id_example", - include_children=True, - ), - ], - search_keywords=[ - "search_keywords_example", - ], - ), - target_retailer_id="target_retailer_id_example", - budget=3.14, - creative_id="creative_id_example", - ), - ), - ) # PreferredLineItemCreateModel202110Request | The line item settings to create a line item with (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_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.post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, preferred_line_item_create_model202110_request=preferred_line_item_create_model202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **campaign_id** | **str**| The given campaign id | - **preferred_line_item_create_model202110_request** | [**PreferredLineItemCreateModel202110Request**](PreferredLineItemCreateModel202110Request.md)| The line item settings to create a line item with | [optional] - -### Return type - -[**PreferredLineItem202110Response**](PreferredLineItem202110Response.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 | -|-------------|-------------|------------------| -**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) - -# **post_api202110_external_line_item_products_append_by_line_item_id** -> PromotedProduct202110PagedListResponse post_api202110_external_line_item_products_append_by_line_item_id(line_item_id) - - - -This endpoint appends one or more products to promote on the specified line item. The resulting state of the line item is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - promoted_product202110_list_request = PromotedProduct202110ListRequest( - data=[ - ResourceOfPromotedProduct202110( - id="id_example", - type="type_example", - attributes=ExternalPromotedProduct202110( - bid_override=3.14, - ), - ), - ], - ) # PromotedProduct202110ListRequest | the products to append to this line item (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_line_item_products_append_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_line_item_products_append_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_line_item_products_append_by_line_item_id(line_item_id, promoted_product202110_list_request=promoted_product202110_list_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_line_item_products_append_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **promoted_product202110_list_request** | [**PromotedProduct202110ListRequest**](PromotedProduct202110ListRequest.md)| the products to append to this line item | [optional] - -### Return type - -[**PromotedProduct202110PagedListResponse**](PromotedProduct202110PagedListResponse.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** | 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) - -# **post_api202110_external_line_item_products_delete_by_line_item_id** -> PromotedProduct202110PagedListResponse post_api202110_external_line_item_products_delete_by_line_item_id(line_item_id) - - - -This endpoint removes one or more products from promotion on the specified line item. The resulting state of the line item is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - promoted_product202110_list_request = PromotedProduct202110ListRequest( - data=[ - ResourceOfPromotedProduct202110( - id="id_example", - type="type_example", - attributes=ExternalPromotedProduct202110( - bid_override=3.14, - ), - ), - ], - ) # PromotedProduct202110ListRequest | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_line_item_products_delete_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_line_item_products_delete_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_line_item_products_delete_by_line_item_id(line_item_id, promoted_product202110_list_request=promoted_product202110_list_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_line_item_products_delete_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **promoted_product202110_list_request** | [**PromotedProduct202110ListRequest**](PromotedProduct202110ListRequest.md)| | [optional] - -### Return type - -[**PromotedProduct202110PagedListResponse**](PromotedProduct202110PagedListResponse.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** | 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) - -# **post_api202110_external_line_item_products_pause_by_line_item_id** -> post_api202110_external_line_item_products_pause_by_line_item_id(line_item_id) - - - -This endpoint pauses one or more promoted products on a specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with. - promoted_product202110_list_request = PromotedProduct202110ListRequest( - data=[ - ResourceOfPromotedProduct202110( - id="id_example", - type="type_example", - attributes=ExternalPromotedProduct202110( - bid_override=3.14, - ), - ), - ], - ) # PromotedProduct202110ListRequest | The products from which their IDs will be used to pause. (optional) - - # example passing only required values which don't have defaults set - try: - api_instance.post_api202110_external_line_item_products_pause_by_line_item_id(line_item_id) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_line_item_products_pause_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_instance.post_api202110_external_line_item_products_pause_by_line_item_id(line_item_id, promoted_product202110_list_request=promoted_product202110_list_request) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_line_item_products_pause_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with. | - **promoted_product202110_list_request** | [**PromotedProduct202110ListRequest**](PromotedProduct202110ListRequest.md)| The products from which their IDs will be used to pause. | [optional] - -### Return type - -void (empty response body) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - - -### 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) - -# **post_api202110_external_line_item_products_unpause_by_line_item_id** -> post_api202110_external_line_item_products_unpause_by_line_item_id(line_item_id) - - - -This endpoint unpauses one or more promoted products on a specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with. - promoted_product202110_list_request = PromotedProduct202110ListRequest( - data=[ - ResourceOfPromotedProduct202110( - id="id_example", - type="type_example", - attributes=ExternalPromotedProduct202110( - bid_override=3.14, - ), - ), - ], - ) # PromotedProduct202110ListRequest | The products from which their IDs will be used to unpause. (optional) - - # example passing only required values which don't have defaults set - try: - api_instance.post_api202110_external_line_item_products_unpause_by_line_item_id(line_item_id) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_line_item_products_unpause_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_instance.post_api202110_external_line_item_products_unpause_by_line_item_id(line_item_id, promoted_product202110_list_request=promoted_product202110_list_request) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_line_item_products_unpause_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with. | - **promoted_product202110_list_request** | [**PromotedProduct202110ListRequest**](PromotedProduct202110ListRequest.md)| The products from which their IDs will be used to unpause. | [optional] - -### Return type - -void (empty response body) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - - -### 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) - -# **post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id** -> AddToBasketTarget202110Response post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id(line_item_id) - - - -This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_response import AddToBasketTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - add_to_basket_ids_update_model202110_request = AddToBasketIdsUpdateModel202110Request( - data=ValueTypeResourceOfAddToBasketIdsUpdateModel202110( - type="type_example", - attributes=ExternalAddToBasketIdsUpdateModel202110( - product_ids=[ - "product_ids_example", - ], - category_ids=[ - "category_ids_example", - ], - ), - ), - ) # AddToBasketIdsUpdateModel202110Request | Ids to append to the target (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id(line_item_id, add_to_basket_ids_update_model202110_request=add_to_basket_ids_update_model202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **add_to_basket_ids_update_model202110_request** | [**AddToBasketIdsUpdateModel202110Request**](AddToBasketIdsUpdateModel202110Request.md)| Ids to append to the target | [optional] - -### Return type - -[**AddToBasketTarget202110Response**](AddToBasketTarget202110Response.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** | 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) - -# **post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id** -> AddToBasketTarget202110Response post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id(line_item_id) - - - -This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_response import AddToBasketTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - add_to_basket_ids_update_model202110_request = AddToBasketIdsUpdateModel202110Request( - data=ValueTypeResourceOfAddToBasketIdsUpdateModel202110( - type="type_example", - attributes=ExternalAddToBasketIdsUpdateModel202110( - product_ids=[ - "product_ids_example", - ], - category_ids=[ - "category_ids_example", - ], - ), - ), - ) # AddToBasketIdsUpdateModel202110Request | Ids to remove from the target (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id(line_item_id, add_to_basket_ids_update_model202110_request=add_to_basket_ids_update_model202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **add_to_basket_ids_update_model202110_request** | [**AddToBasketIdsUpdateModel202110Request**](AddToBasketIdsUpdateModel202110Request.md)| Ids to remove from the target | [optional] - -### Return type - -[**AddToBasketTarget202110Response**](AddToBasketTarget202110Response.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** | 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) - -# **post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id** -> AudienceTarget202110Response post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id(line_item_id) - - - -This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.audience_ids_update_model202110_request import AudienceIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.audience_target202110_response import AudienceTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - audience_ids_update_model202110_request = AudienceIdsUpdateModel202110Request( - data=ValueTypeResourceOfAudienceIdsUpdateModel202110( - type="type_example", - attributes=ExternalAudienceIdsUpdateModel202110( - audience_ids=[ - "audience_ids_example", - ], - ), - ), - ) # AudienceIdsUpdateModel202110Request | Audience ids to append to the target (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id(line_item_id, audience_ids_update_model202110_request=audience_ids_update_model202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **audience_ids_update_model202110_request** | [**AudienceIdsUpdateModel202110Request**](AudienceIdsUpdateModel202110Request.md)| Audience ids to append to the target | [optional] - -### Return type - -[**AudienceTarget202110Response**](AudienceTarget202110Response.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** | 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) - -# **post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id** -> AudienceTarget202110Response post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id(line_item_id) - - - -This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.audience_ids_update_model202110_request import AudienceIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.audience_target202110_response import AudienceTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - audience_ids_update_model202110_request = AudienceIdsUpdateModel202110Request( - data=ValueTypeResourceOfAudienceIdsUpdateModel202110( - type="type_example", - attributes=ExternalAudienceIdsUpdateModel202110( - audience_ids=[ - "audience_ids_example", - ], - ), - ), - ) # AudienceIdsUpdateModel202110Request | Audience ids to remove from the target (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id(line_item_id, audience_ids_update_model202110_request=audience_ids_update_model202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **audience_ids_update_model202110_request** | [**AudienceIdsUpdateModel202110Request**](AudienceIdsUpdateModel202110Request.md)| Audience ids to remove from the target | [optional] - -### Return type - -[**AudienceTarget202110Response**](AudienceTarget202110Response.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** | 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) - -# **post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id** -> StoreTarget202110Response post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id(line_item_id) - - - -This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.store_target202110_response import StoreTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - store_ids_update_model202110_request = StoreIdsUpdateModel202110Request( - data=ValueTypeResourceOfStoreIdsUpdateModel202110( - type="type_example", - attributes=ExternalStoreIdsUpdateModel202110( - store_ids=[ - "store_ids_example", - ], - ), - ), - ) # StoreIdsUpdateModel202110Request | Store ids to append to the target (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id(line_item_id, store_ids_update_model202110_request=store_ids_update_model202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **store_ids_update_model202110_request** | [**StoreIdsUpdateModel202110Request**](StoreIdsUpdateModel202110Request.md)| Store ids to append to the target | [optional] - -### Return type - -[**StoreTarget202110Response**](StoreTarget202110Response.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** | 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) - -# **post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id** -> StoreTarget202110Response post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id(line_item_id) - - - -This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.store_target202110_response import StoreTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - store_ids_update_model202110_request = StoreIdsUpdateModel202110Request( - data=ValueTypeResourceOfStoreIdsUpdateModel202110( - type="type_example", - attributes=ExternalStoreIdsUpdateModel202110( - store_ids=[ - "store_ids_example", - ], - ), - ), - ) # StoreIdsUpdateModel202110Request | Store ids to remove from the target (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id(line_item_id, store_ids_update_model202110_request=store_ids_update_model202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **store_ids_update_model202110_request** | [**StoreIdsUpdateModel202110Request**](StoreIdsUpdateModel202110Request.md)| Store ids to remove from the target | [optional] - -### Return type - -[**StoreTarget202110Response**](StoreTarget202110Response.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** | 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) - -# **post_api202301_external_account_campaigns_by_account_id** -> JsonApiSingleResponseOfCampaignV202301 post_api202301_external_account_campaigns_by_account_id(account_id) - - - -Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.post_campaign_v202301 import PostCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The account to request the campaign for. - post_campaign_v202301 = PostCampaignV202301( - data=JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301( - type="type_example", - attributes=CampaignAttributesV202301( - type="auction", - drawable_balance_ids=[ - "drawable_balance_ids_example", - ], - click_attribution_window="30D", - view_attribution_window="None", - name="name_example", - budget=3.14, - monthly_pacing=3.14, - daily_pacing=3.14, - is_auto_daily_pacing=True, - start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - click_attribution_scope="unknown", - view_attribution_scope="unknown", - company_name="company_name_example", - ), - ), - ) # PostCampaignV202301 | Creatable campaign attributes (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api202301_external_account_campaigns_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202301_external_account_campaigns_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_api202301_external_account_campaigns_by_account_id(account_id, post_campaign_v202301=post_campaign_v202301) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api202301_external_account_campaigns_by_account_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The account to request the campaign for. | - **post_campaign_v202301** | [**PostCampaignV202301**](PostCampaignV202301.md)| Creatable campaign attributes | [optional] - -### Return type - -[**JsonApiSingleResponseOfCampaignV202301**](JsonApiSingleResponseOfCampaignV202301.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 | -|-------------|-------------|------------------| -**201** | 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) - -# **post_api_v1_external_account_catalogs_by_account_id** -> JsonApiSingleResponseOfCatalogStatus post_api_v1_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_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus -from criteo_api_retailmedia_v2023_01.model.json_api_request_of_catalog_request import JsonApiRequestOfCatalogRequest -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 = JsonApiRequestOfCatalogRequest( - data=JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest( - type="type_example", - attributes=ExternalCatalogRequest( - format="json-newline", - brand_id_filter=[ - "brand_id_filter_example", - ], - ), - ), - ) # JsonApiRequestOfCatalogRequest | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api_v1_external_account_catalogs_by_account_id(account_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api_v1_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_v1_external_account_catalogs_by_account_id(account_id, json_api_request_of_catalog_request=json_api_request_of_catalog_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api_v1_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** | [**JsonApiRequestOfCatalogRequest**](JsonApiRequestOfCatalogRequest.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_v2_external_campaign_auction_line_items_by_campaign_id** -> AuctionLineItemResponse post_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id) - - - -Creates new auction line item with the specified settings - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.auction_line_item_create_model_request import AuctionLineItemCreateModelRequest -from criteo_api_retailmedia_v2023_01.model.auction_line_item_response import AuctionLineItemResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - campaign_id = "campaign-id_example" # str | The given campaign id - auction_line_item_create_model_request = AuctionLineItemCreateModelRequest( - data=InputResourceOfAuctionLineItemCreateModel( - type="type_example", - attributes=ExternalAuctionLineItemCreateModel( - name="name_example", - start_date=dateutil_parser('1970-01-01').date(), - end_date=dateutil_parser('1970-01-01').date(), - status="unknown", - target_retailer_id="target_retailer_id_example", - budget=3.14, - target_bid=3.14, - max_bid=3.14, - monthly_pacing=3.14, - daily_pacing=3.14, - is_auto_daily_pacing=False, - bid_strategy="conversion", - ), - ), - ) # AuctionLineItemCreateModelRequest | The line item settings to create a line item with (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.post_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api_v2_external_campaign_auction_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.post_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id, auction_line_item_create_model_request=auction_line_item_create_model_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->post_api_v2_external_campaign_auction_line_items_by_campaign_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **campaign_id** | **str**| The given campaign id | - **auction_line_item_create_model_request** | [**AuctionLineItemCreateModelRequest**](AuctionLineItemCreateModelRequest.md)| The line item settings to create a line item with | [optional] - -### Return type - -[**AuctionLineItemResponse**](AuctionLineItemResponse.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 | -|-------------|-------------|------------------| -**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) - -# **put_api202110_external_preferred_line_item_by_line_item_id** -> PreferredLineItem202110Response put_api202110_external_preferred_line_item_by_line_item_id(line_item_id) - - - -Updates the preferred line item for the given line item id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request -from criteo_api_retailmedia_v2023_01.model.preferred_line_item202110_response import PreferredLineItem202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The given line item id - preferred_line_item_update_model202110_request = PreferredLineItemUpdateModel202110Request( - data=ResourceOfPreferredLineItemUpdateModel202110( - id="id_example", - type="type_example", - attributes=ExternalPreferredLineItemUpdateModel202110( - name="name_example", - start_date=dateutil_parser('1970-01-01').date(), - end_date=dateutil_parser('1970-01-01').date(), - status="unknown", - pacing="accelerated", - capping=ExternalLineItemCapping202110( - type="unknown", - count=1, - ), - page=ExternalLineItemPage202110( - page_type="search", - categories=[ - ExternalLineItemPageCategory202110( - category_id="category_id_example", - include_children=True, - ), - ], - search_keywords=[ - "search_keywords_example", - ], - ), - budget=3.14, - creative_id="creative_id_example", - ), - ), - ) # PreferredLineItemUpdateModel202110Request | The line item settings to create a line item with (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.put_api202110_external_preferred_line_item_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.put_api202110_external_preferred_line_item_by_line_item_id(line_item_id, preferred_line_item_update_model202110_request=preferred_line_item_update_model202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The given line item id | - **preferred_line_item_update_model202110_request** | [**PreferredLineItemUpdateModel202110Request**](PreferredLineItemUpdateModel202110Request.md)| The line item settings to create a line item with | [optional] - -### Return type - -[**PreferredLineItem202110Response**](PreferredLineItem202110Response.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** | 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) - -# **put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id** -> AddToBasketTarget202110Response put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id) - - - -This endpoint sets the scope of the add to basket target on the specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_request import AddToBasketTarget202110Request -from criteo_api_retailmedia_v2023_01.model.add_to_basket_target202110_response import AddToBasketTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - add_to_basket_target202110_request = AddToBasketTarget202110Request( - data=ValueTypeResourceOfAddToBasketTarget202110( - type="type_example", - attributes=ExternalAddToBasketTarget202110( - scope="unknown", - product_ids=[ - "product_ids_example", - ], - category_ids=[ - "category_ids_example", - ], - ), - ), - ) # AddToBasketTarget202110Request | The add to basket target to set the scope for (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id, add_to_basket_target202110_request=add_to_basket_target202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **add_to_basket_target202110_request** | [**AddToBasketTarget202110Request**](AddToBasketTarget202110Request.md)| The add to basket target to set the scope for | [optional] - -### Return type - -[**AddToBasketTarget202110Response**](AddToBasketTarget202110Response.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** | 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) - -# **put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id** -> AudienceTarget202110Response put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id) - - - -This endpoint sets the scope of the audience target on the specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.audience_target202110_response import AudienceTarget202110Response -from criteo_api_retailmedia_v2023_01.model.audience_target202110_request import AudienceTarget202110Request -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - audience_target202110_request = AudienceTarget202110Request( - data=ValueTypeResourceOfAudienceTarget202110( - type="type_example", - attributes=ExternalAudienceTarget202110( - scope="unknown", - audience_ids=[ - "audience_ids_example", - ], - ), - ), - ) # AudienceTarget202110Request | The audience target to set the scope for (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id, audience_target202110_request=audience_target202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **audience_target202110_request** | [**AudienceTarget202110Request**](AudienceTarget202110Request.md)| The audience target to set the scope for | [optional] - -### Return type - -[**AudienceTarget202110Response**](AudienceTarget202110Response.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** | 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) - -# **put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id** -> StoreTarget202110Response put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id) - - - -This endpoint sets the scope of the store target on the specified line item. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.store_target202110_request import StoreTarget202110Request -from criteo_api_retailmedia_v2023_01.model.store_target202110_response import StoreTarget202110Response -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The line item to interact with - store_target202110_request = StoreTarget202110Request( - data=ValueTypeResourceOfStoreTarget202110( - type="type_example", - attributes=ExternalStoreTarget202110( - scope="unknown", - store_ids=[ - "store_ids_example", - ], - ), - ), - ) # StoreTarget202110Request | The store target to set the scope for (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id, store_target202110_request=store_target202110_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The line item to interact with | - **store_target202110_request** | [**StoreTarget202110Request**](StoreTarget202110Request.md)| The store target to set the scope for | [optional] - -### Return type - -[**StoreTarget202110Response**](StoreTarget202110Response.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** | 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) - -# **put_api202301_external_campaign_by_campaign_id** -> JsonApiSingleResponseOfCampaignV202301 put_api202301_external_campaign_by_campaign_id(campaign_id) - - - -Edit a campaign for the given campaign id with a given editable attributes. This will return updated creatable and editable attributes of the campaign as the result of the operation. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled. - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.put_campaign_v202301 import PutCampaignV202301 -from criteo_api_retailmedia_v2023_01.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = campaign_api.CampaignApi(api_client) - campaign_id = "campaignId_example" # str | Campaign Id of the updating campaign - put_campaign_v202301 = PutCampaignV202301( - data=JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301( - id="id_example", - type="type_example", - attributes=EditableCampaignAttributesV202301( - name="name_example", - budget=3.14, - monthly_pacing=3.14, - daily_pacing=3.14, - is_auto_daily_pacing=True, - start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), - click_attribution_window="7D", - view_attribution_window="None", - click_attribution_scope="unknown", - view_attribution_scope="unknown", - company_name="company_name_example", - ), - ), - ) # PutCampaignV202301 | Editable campaign attributes (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.put_api202301_external_campaign_by_campaign_id(campaign_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202301_external_campaign_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.put_api202301_external_campaign_by_campaign_id(campaign_id, put_campaign_v202301=put_campaign_v202301) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202301_external_campaign_by_campaign_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **campaign_id** | **str**| Campaign Id of the updating campaign | - **put_campaign_v202301** | [**PutCampaignV202301**](PutCampaignV202301.md)| Editable campaign attributes | [optional] - -### Return type - -[**JsonApiSingleResponseOfCampaignV202301**](JsonApiSingleResponseOfCampaignV202301.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** | 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) - -# **put_api202301_external_line_item_bid_multipliers_by_line_item_id** -> LineItemBidMultipliersResponse put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) - - - -Replace bid multipliers on a line item - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse -from criteo_api_retailmedia_v2023_01.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 - line_item_bid_multipliers_request = LineItemBidMultipliersRequest( - data=ResourceOfLineItemBidMultipliers( - attributes=LineItemBidMultipliers( - search=3.14, - homepage=3.14, - categories=3.14, - product_detail=3.14, - confirmation=3.14, - merchandising=3.14, - deals=3.14, - checkout=3.14, - ), - id="id_example", - type="type_example", - ), - ) # LineItemBidMultipliersRequest | (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id, line_item_bid_multipliers_request=line_item_bid_multipliers_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| Long external id of the associated line item | - **line_item_bid_multipliers_request** | [**LineItemBidMultipliersRequest**](LineItemBidMultipliersRequest.md)| | [optional] - -### Return type - -[**LineItemBidMultipliersResponse**](LineItemBidMultipliersResponse.md) - -### Authorization - -[oauth](../README.md#oauth), [oauth](../README.md#oauth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/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) - -# **put_api_v2_external_auction_line_item_by_line_item_id** -> AuctionLineItemResponse put_api_v2_external_auction_line_item_by_line_item_id(line_item_id) - - - -Updates the auction line item for the given line item id - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import campaign_api -from criteo_api_retailmedia_v2023_01.model.auction_line_item_update_model_request import AuctionLineItemUpdateModelRequest -from criteo_api_retailmedia_v2023_01.model.auction_line_item_response import AuctionLineItemResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.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 | The given line item id - auction_line_item_update_model_request = AuctionLineItemUpdateModelRequest( - data=ResourceOfAuctionLineItemUpdateModel( - id="id_example", - type="type_example", - attributes=ExternalAuctionLineItemUpdateModel( - name="name_example", - start_date=dateutil_parser('1970-01-01').date(), - end_date=dateutil_parser('1970-01-01').date(), - status="unknown", - budget=3.14, - target_bid=3.14, - max_bid=3.14, - monthly_pacing=3.14, - daily_pacing=3.14, - is_auto_daily_pacing=True, - bid_strategy="conversion", - ), - ), - ) # AuctionLineItemUpdateModelRequest | The line item settings to create a line item with (optional) - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.put_api_v2_external_auction_line_item_by_line_item_id(line_item_id) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api_v2_external_auction_line_item_by_line_item_id: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - api_response = api_instance.put_api_v2_external_auction_line_item_by_line_item_id(line_item_id, auction_line_item_update_model_request=auction_line_item_update_model_request) - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling CampaignApi->put_api_v2_external_auction_line_item_by_line_item_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **line_item_id** | **str**| The given line item id | - **auction_line_item_update_model_request** | [**AuctionLineItemUpdateModelRequest**](AuctionLineItemUpdateModelRequest.md)| The line item settings to create a line item with | [optional] - -### Return type - -[**AuctionLineItemResponse**](AuctionLineItemResponse.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** | 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) - diff --git a/sdks/retailmedia_2023-01/docs/ExternalBalance202110.md b/sdks/retailmedia_2023-01/docs/ExternalBalance202110.md deleted file mode 100644 index e293b348..00000000 --- a/sdks/retailmedia_2023-01/docs/ExternalBalance202110.md +++ /dev/null @@ -1,23 +0,0 @@ -# ExternalBalance202110 - -A Retail Media Balance used to determine the funds available for any or all campaigns in an account - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**po_number** | **str** | | -**memo** | **str** | | -**deposited** | **float, none_type** | | -**spent** | **float, none_type** | | -**remaining** | **float, none_type** | | -**start_date** | **date** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | -**status** | **str** | | -**created_at** | **datetime** | | -**updated_at** | **datetime** | | -**end_date** | **date, none_type** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | [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_2023-01/docs/GatewayApi.md b/sdks/retailmedia_2023-01/docs/GatewayApi.md deleted file mode 100644 index 041076c4..00000000 --- a/sdks/retailmedia_2023-01/docs/GatewayApi.md +++ /dev/null @@ -1,90 +0,0 @@ -# criteo_api_retailmedia_v2023_01.GatewayApi - -All URIs are relative to *https://api.criteo.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_current_application**](GatewayApi.md#get_current_application) | **GET** /2023-01/retail-media/me | - - -# **get_current_application** -> ApplicationSummaryModelResponse get_current_application() - - - -Get information about the currently logged application - -### Example - -* OAuth Authentication (oauth): -* OAuth Authentication (oauth): - -```python -import time -import criteo_api_retailmedia_v2023_01 -from criteo_api_retailmedia_v2023_01.api import gateway_api -from criteo_api_retailmedia_v2023_01.model.application_summary_model_response import ApplicationSummaryModelResponse -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_v2023_01.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_v2023_01.Configuration( - host = "https://api.criteo.com" -) -configuration.access_token = 'YOUR_ACCESS_TOKEN' - -# Configure OAuth2 access token for authorization: oauth -configuration = criteo_api_retailmedia_v2023_01.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_v2023_01.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = gateway_api.GatewayApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.get_current_application() - pprint(api_response) - except criteo_api_retailmedia_v2023_01.ApiException as e: - print("Exception when calling GatewayApi->get_current_application: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**ApplicationSummaryModelResponse**](ApplicationSummaryModelResponse.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** | Success | - | -**404** | Not 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) - diff --git a/sdks/retailmedia_2023-01/docs/ResourceOfBalance202110.md b/sdks/retailmedia_2023-01/docs/ResourceOfBalance202110.md deleted file mode 100644 index 247f0f68..00000000 --- a/sdks/retailmedia_2023-01/docs/ResourceOfBalance202110.md +++ /dev/null @@ -1,15 +0,0 @@ -# ResourceOfBalance202110 - -A class that represents an entity in a guild compliant way - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str, none_type** | Id of the entity | [optional] -**type** | **str, none_type** | Canonical type name of the entity | [optional] -**attributes** | [**ExternalBalance202110**](ExternalBalance202110.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_2023-01/setup.py b/sdks/retailmedia_2023-01/setup.py deleted file mode 100644 index 06c88795..00000000 --- a/sdks/retailmedia_2023-01/setup.py +++ /dev/null @@ -1,68 +0,0 @@ -# coding: utf-8 - -from setuptools import setup, find_packages # noqa: H301 - -NAME = "criteo-api-retailmedia-sdk" -VERSION = "2023.01.0.240404" -# To install the library, run the following -# -# python setup.py install -# -# prerequisite: setuptools -# http://pypi.python.org/pypi/setuptools - -REQUIRES = ["urllib3 >= 1.25.3", "python-dateutil"] - -AUTHOR='Criteo' -README_CONTENT_TYPE='text/markdown' -PACKAGE_LONG_DESCRIPTION = """# Criteo API SDK for Python - -IMPORTANT: This Python package links to Criteo production environment. Any test applied here will thus impact real data. - -## Installation & Usage -### pip install - - -```sh -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.240404`) - -Then import the package: -```python -import criteo_api_retailmedia_v2023_01 -``` - -Full documentation on [Github](https://github.com/criteo/criteo-api-python-sdk). - -## Disclaimer - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE -WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -""" - -setup( - name=NAME, - version=VERSION, - description="Criteo API SDK", - author_email="", - author=AUTHOR, - url="https://github.com/criteo/criteo-api-python-sdk", - keywords=[AUTHOR, "OpenAPI-Generator", "Criteo API SDK"], - install_requires=REQUIRES, - packages=find_packages(), - include_package_data=True, - long_description_content_type=README_CONTENT_TYPE, - long_description=PACKAGE_LONG_DESCRIPTION, - classifiers=[ - "Development Status :: 4 - Beta", - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Natural Language :: English", - "Operating System :: OS Independent", - "Topic :: Software Development :: Libraries", - ], - python_requires=">=3.6", -) diff --git a/sdks/retailmedia_2023-01/test/example_application_with_auth_code.py b/sdks/retailmedia_2023-01/test/example_application_with_auth_code.py deleted file mode 100644 index abe79a3e..00000000 --- a/sdks/retailmedia_2023-01/test/example_application_with_auth_code.py +++ /dev/null @@ -1,27 +0,0 @@ -from criteo_api_retailmedia_v2023_01.api.gateway_api import GatewayApi -from criteo_api_retailmedia_v2023_01 import ApiClientBuilder - -class ExampleApplication: - - def call_then_application_endpoint(self, clientId, clientSecret, authorization_code, redirect_uri): - # Create a client using your choosen OAuth flow, Authorization Code in this case. The client will handle the token generation/renewal for you - client = ApiClientBuilder.WithAuthorizationCode(clientId, clientSecret, authorization_code, redirect_uri) - - # The Gateway API regroups common technical endpoints that exists for all versions - # You can find the other endpoints in the other *Api - # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials - api = GatewayApi(client) - - # Perform the call to the application introspection endpoint - response = api.get_current_application() - - # Most of Criteo's API response follow the same structure: - # The response consists of a Data, Errors and Warnings fields - # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object - myApplication = response.data.attributes - print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') - - # You will need to save the refresh_token to use it in the refresh_token flow - # You can fetch the refresh token like this: - refreshToken = client.get_refresh_token() - print('The refresh token to be saved is ', refreshToken) \ No newline at end of file diff --git a/sdks/retailmedia_2023-01/test/example_application_with_client_credentials.py b/sdks/retailmedia_2023-01/test/example_application_with_client_credentials.py deleted file mode 100644 index 0141ca83..00000000 --- a/sdks/retailmedia_2023-01/test/example_application_with_client_credentials.py +++ /dev/null @@ -1,22 +0,0 @@ -from criteo_api_retailmedia_v2023_01.api.gateway_api import GatewayApi -from criteo_api_retailmedia_v2023_01 import ApiClientBuilder - -class ExampleApplication: - - def call_then_application_endpoint(self, clientId, clientSecret): - # Create a client using your choosen OAuth flow, Client Credentials in this case. The client will handle the token generation/renewal for you - client = ApiClientBuilder.WithClientCredentials(clientId=clientId, clientSecret=clientSecret) - - # The Gateway API regroups common technical endpoints that exists for all versions - # You can find the other endpoints in the other *Api - # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials - api = GatewayApi(client) - - # Perform the call to the application introspection endpoint - response = api.get_current_application() - - # Most of Criteo's API response follow the same structure: - # The response consists of a Data, Errors and Warnings fields - # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object - myApplication = response.data.attributes - print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') \ No newline at end of file diff --git a/sdks/retailmedia_2023-01/test/example_application_with_refresh_token.py b/sdks/retailmedia_2023-01/test/example_application_with_refresh_token.py deleted file mode 100644 index 1d8ad994..00000000 --- a/sdks/retailmedia_2023-01/test/example_application_with_refresh_token.py +++ /dev/null @@ -1,27 +0,0 @@ -from criteo_api_retailmedia_v2023_01.api.gateway_api import GatewayApi -from criteo_api_retailmedia_v2023_01 import ApiClientBuilder - -class ExampleApplication: - - def call_then_application_endpoint(self, clientId, clientSecret, refresh_token): - # Create a client using your choosen OAuth flow, Refresh Token in this case. The client will handle the token generation/renewal for you - client = ApiClientBuilder.WithRefreshToken(clientId, clientSecret, refresh_token) - - # The Gateway API regroups common technical endpoints that exists for all versions - # You can find the other endpoints in the other *Api - # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials - api = GatewayApi(client) - - # Perform the call to the application introspection endpoint - response = api.get_current_application() - - # Most of Criteo's API response follow the same structure: - # The response consists of a Data, Errors and Warnings fields - # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object - myApplication = response.data.attributes - print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') - - # You will need to save the new refresh_token to use it again in the future - # You can fetch the refresh token like this: - refreshToken = client.get_refresh_token() - print('The refresh token to be saved is ', refreshToken) \ No newline at end of file diff --git a/sdks/retailmedia_2023-01/test/test_gateway_api.py b/sdks/retailmedia_2023-01/test/test_gateway_api.py deleted file mode 100644 index db6019bd..00000000 --- a/sdks/retailmedia_2023-01/test/test_gateway_api.py +++ /dev/null @@ -1,62 +0,0 @@ -import pytest -import os - -from criteo_api_retailmedia_v2023_01.api.gateway_api import GatewayApi -from criteo_api_retailmedia_v2023_01.api_client_builder import ApiClientBuilder -from criteo_api_retailmedia_v2023_01.rest import ApiException -from example_application_with_client_credentials import ExampleApplication - -class TestGatewayApi: - @pytest.fixture(autouse=True) - def before_each(self): - self.client_id = os.environ.get("TEST_CLIENT_ID") - self.client_secret = os.environ.get("TEST_CLIENT_SECRET") - self.application_id = int(os.environ.get("TEST_APPLICATION_ID")) - - self.client = ApiClientBuilder.WithClientCredentials(clientId=self.client_id, clientSecret=self.client_secret) - - def test_environment_variables(self): - assert len(self.client_id) > 0, "Environment variable \"TEST_CLIENT_ID\" not found." - assert len(self.client_secret) > 0, "Environment variable \"TEST_CLIENT_SECRET\" not found." - assert self.application_id > 0, "Environment variable \"TEST_APPLICATION_ID\" not found." - - def test_example_works(self): - # Arrange - exampleApplication = ExampleApplication() - exampleApplication.call_then_application_endpoint(self.client_id, self.client_secret) - - def test_get_current_application_should_succeed_with_valid_token(self): - # Arrange - api = GatewayApi(self.client) - - # Act - http_response = api.get_current_application() - - # Assert - assert self.application_id == http_response.data.attributes.application_id - - - def test_get_current_application_should_succeed_with_renewed_invalid_token(self): - # Arrange - invalid_token = "invalid.access.token" - self.client.configuration.access_token = invalid_token - api = GatewayApi(self.client) - - # Act - http_response = api.get_current_application() - - # Assert - assert self.application_id == http_response.data.attributes.application_id - - - def test_get_current_application_should_fail_without_token(self): - # Arrange - api = GatewayApi(ApiClientBuilder.WithNoAuthorization()) - - # Act - try: - api.get_current_application() - - # Assert - except ApiException as exception: - assert exception.status == 401 diff --git a/sdks/retailmedia_2023-01/tox.ini b/sdks/retailmedia_2023-01/tox.ini deleted file mode 100644 index c448a4e6..00000000 --- a/sdks/retailmedia_2023-01/tox.ini +++ /dev/null @@ -1,9 +0,0 @@ -[tox] -envlist = py3 - -[testenv] -deps=-r{toxinidir}/requirements.txt - -r{toxinidir}/test-requirements.txt - -commands= - pytest --cov=criteo_api_retailmedia_v2023_01 diff --git a/sdks/retailmedia_2023-04/.openapi-generator/FILES b/sdks/retailmedia_2023-04/.openapi-generator/FILES index 1a472bbf..007763b9 100644 --- a/sdks/retailmedia_2023-04/.openapi-generator/FILES +++ b/sdks/retailmedia_2023-04/.openapi-generator/FILES @@ -19,12 +19,17 @@ criteo_api_retailmedia_v2023_04/criteo_rest.py criteo_api_retailmedia_v2023_04/exceptions.py criteo_api_retailmedia_v2023_04/flow_constants.py criteo_api_retailmedia_v2023_04/model/__init__.py +criteo_api_retailmedia_v2023_04/model/add_remove_keyword_model.py +criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model.py +criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model_request.py +criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model_resource.py criteo_api_retailmedia_v2023_04/model/add_to_basket_ids_update_model202110_request.py criteo_api_retailmedia_v2023_04/model/add_to_basket_target202110_request.py criteo_api_retailmedia_v2023_04/model/add_to_basket_target202110_response.py criteo_api_retailmedia_v2023_04/model/application_summary_model.py criteo_api_retailmedia_v2023_04/model/application_summary_model_resource.py criteo_api_retailmedia_v2023_04/model/application_summary_model_response.py +criteo_api_retailmedia_v2023_04/model/approval_status_model.py criteo_api_retailmedia_v2023_04/model/asset.py criteo_api_retailmedia_v2023_04/model/asset_resource.py criteo_api_retailmedia_v2023_04/model/asset_response.py @@ -94,6 +99,7 @@ criteo_api_retailmedia_v2023_04/model/external_store_target202110.py criteo_api_retailmedia_v2023_04/model/files_variable_value.py criteo_api_retailmedia_v2023_04/model/files_variables_specification.py criteo_api_retailmedia_v2023_04/model/hyperlink_variable_value.py +criteo_api_retailmedia_v2023_04/model/input_keywords_model.py criteo_api_retailmedia_v2023_04/model/input_resource_of_auction_line_item_create_model.py criteo_api_retailmedia_v2023_04/model/input_resource_of_preferred_line_item_create_model202110.py criteo_api_retailmedia_v2023_04/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py @@ -113,11 +119,17 @@ criteo_api_retailmedia_v2023_04/model/json_api_request_of_catalog_request.py criteo_api_retailmedia_v2023_04/model/json_api_single_response_of_campaign_v202301.py criteo_api_retailmedia_v2023_04/model/json_api_single_response_of_catalog_status.py criteo_api_retailmedia_v2023_04/model/json_api_single_response_of_line_item_bid_multipliers.py +criteo_api_retailmedia_v2023_04/model/keyword_data_model.py criteo_api_retailmedia_v2023_04/model/keyword_target202110_request.py criteo_api_retailmedia_v2023_04/model/keyword_target202110_response.py +criteo_api_retailmedia_v2023_04/model/keywords_model.py +criteo_api_retailmedia_v2023_04/model/keywords_model_resource.py +criteo_api_retailmedia_v2023_04/model/keywords_model_response.py criteo_api_retailmedia_v2023_04/model/line_item_bid_multipliers.py criteo_api_retailmedia_v2023_04/model/line_item_bid_multipliers_request.py criteo_api_retailmedia_v2023_04/model/line_item_bid_multipliers_response.py +criteo_api_retailmedia_v2023_04/model/match_type_model.py +criteo_api_retailmedia_v2023_04/model/negotiation_state_model.py criteo_api_retailmedia_v2023_04/model/page_metadata.py criteo_api_retailmedia_v2023_04/model/page_type_environment.py criteo_api_retailmedia_v2023_04/model/post_campaign_v202301.py @@ -128,6 +140,9 @@ criteo_api_retailmedia_v2023_04/model/preferred_line_item_update_model202110_req criteo_api_retailmedia_v2023_04/model/problem_details.py criteo_api_retailmedia_v2023_04/model/promoted_product202110_list_request.py criteo_api_retailmedia_v2023_04/model/promoted_product202110_paged_list_response.py +criteo_api_retailmedia_v2023_04/model/proposal_status_model.py +criteo_api_retailmedia_v2023_04/model/proposal_status_model_resource.py +criteo_api_retailmedia_v2023_04/model/proposal_status_model_response.py criteo_api_retailmedia_v2023_04/model/put_campaign_v202301.py criteo_api_retailmedia_v2023_04/model/report_outcome.py criteo_api_retailmedia_v2023_04/model/resource_of_auction_line_item.py @@ -143,24 +158,8 @@ criteo_api_retailmedia_v2023_04/model/resource_of_preferred_line_item202110.py criteo_api_retailmedia_v2023_04/model/resource_of_preferred_line_item_update_model202110.py criteo_api_retailmedia_v2023_04/model/resource_of_promoted_product202110.py criteo_api_retailmedia_v2023_04/model/resource_of_template.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keyword_model.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model_request.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model_resource.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_input_keywords_model.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keyword_data_model.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model_resource.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model_response.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_problem_details.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model_resource.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model_response.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_resource_outcome.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bid_model.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model_request.py -criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model_resource.py +criteo_api_retailmedia_v2023_04/model/resource_outcome.py +criteo_api_retailmedia_v2023_04/model/review_state_model.py criteo_api_retailmedia_v2023_04/model/rm_legacy_audience_create_entity_v1.py criteo_api_retailmedia_v2023_04/model/rm_legacy_audience_create_entity_v1_resource.py criteo_api_retailmedia_v2023_04/model/rm_legacy_audience_create_entity_v1_response.py @@ -181,7 +180,12 @@ criteo_api_retailmedia_v2023_04/model/rm_legacy_segment_customer_list.py criteo_api_retailmedia_v2023_04/model/rm_legacy_segment_user_behavior_create_v2.py criteo_api_retailmedia_v2023_04/model/rm_legacy_segment_user_behavior_v1.py criteo_api_retailmedia_v2023_04/model/rm_legacy_segment_user_behavior_v2.py +criteo_api_retailmedia_v2023_04/model/rmca_common_problem.py criteo_api_retailmedia_v2023_04/model/section.py +criteo_api_retailmedia_v2023_04/model/set_bid_model.py +criteo_api_retailmedia_v2023_04/model/set_bids_model.py +criteo_api_retailmedia_v2023_04/model/set_bids_model_request.py +criteo_api_retailmedia_v2023_04/model/set_bids_model_resource.py criteo_api_retailmedia_v2023_04/model/status_response.py criteo_api_retailmedia_v2023_04/model/status_response_resource.py criteo_api_retailmedia_v2023_04/model/store_ids_update_model202110_request.py @@ -204,6 +208,10 @@ criteo_api_retailmedia_v2023_04/model/value_type_resource_of_store_target202110. criteo_api_retailmedia_v2023_04/model_utils.py criteo_api_retailmedia_v2023_04/models/__init__.py criteo_api_retailmedia_v2023_04/rest.py +docs/AddRemoveKeywordModel.md +docs/AddRemoveKeywordsModel.md +docs/AddRemoveKeywordsModelRequest.md +docs/AddRemoveKeywordsModelResource.md docs/AddToBasketIdsUpdateModel202110Request.md docs/AddToBasketTarget202110Request.md docs/AddToBasketTarget202110Response.md @@ -211,6 +219,7 @@ docs/AnalyticsApi.md docs/ApplicationSummaryModel.md docs/ApplicationSummaryModelResource.md docs/ApplicationSummaryModelResponse.md +docs/ApprovalStatusModel.md docs/Asset.md docs/AssetResource.md docs/AssetResponse.md @@ -283,6 +292,7 @@ docs/FilesVariableValue.md docs/FilesVariablesSpecification.md docs/GatewayApi.md docs/HyperlinkVariableValue.md +docs/InputKeywordsModel.md docs/InputResourceOfAuctionLineItemCreateModel.md docs/InputResourceOfPreferredLineItemCreateModel202110.md docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md @@ -302,11 +312,17 @@ docs/JsonApiRequestOfCatalogRequest.md docs/JsonApiSingleResponseOfCampaignV202301.md docs/JsonApiSingleResponseOfCatalogStatus.md docs/JsonApiSingleResponseOfLineItemBidMultipliers.md +docs/KeywordDataModel.md docs/KeywordTarget202110Request.md docs/KeywordTarget202110Response.md +docs/KeywordsModel.md +docs/KeywordsModelResource.md +docs/KeywordsModelResponse.md docs/LineItemBidMultipliers.md docs/LineItemBidMultipliersRequest.md docs/LineItemBidMultipliersResponse.md +docs/MatchTypeModel.md +docs/NegotiationStateModel.md docs/PageMetadata.md docs/PageTypeEnvironment.md docs/PostCampaignV202301.md @@ -317,6 +333,9 @@ docs/PreferredLineItemUpdateModel202110Request.md docs/ProblemDetails.md docs/PromotedProduct202110ListRequest.md docs/PromotedProduct202110PagedListResponse.md +docs/ProposalStatusModel.md +docs/ProposalStatusModelResource.md +docs/ProposalStatusModelResponse.md docs/PutCampaignV202301.md docs/ReportOutcome.md docs/ResourceOfAuctionLineItem.md @@ -332,24 +351,8 @@ docs/ResourceOfPreferredLineItem202110.md docs/ResourceOfPreferredLineItemUpdateModel202110.md docs/ResourceOfPromotedProduct202110.md docs/ResourceOfTemplate.md -docs/RetailMediaExternalv1AddRemoveKeywordModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md -docs/RetailMediaExternalv1InputKeywordsModel.md -docs/RetailMediaExternalv1KeywordDataModel.md -docs/RetailMediaExternalv1KeywordsModel.md -docs/RetailMediaExternalv1KeywordsModelResource.md -docs/RetailMediaExternalv1KeywordsModelResponse.md -docs/RetailMediaExternalv1ProblemDetails.md -docs/RetailMediaExternalv1ProposalStatusModel.md -docs/RetailMediaExternalv1ProposalStatusModelResource.md -docs/RetailMediaExternalv1ProposalStatusModelResponse.md -docs/RetailMediaExternalv1ResourceOutcome.md -docs/RetailMediaExternalv1SetBidModel.md -docs/RetailMediaExternalv1SetBidsModel.md -docs/RetailMediaExternalv1SetBidsModelRequest.md -docs/RetailMediaExternalv1SetBidsModelResource.md +docs/ResourceOutcome.md +docs/ReviewStateModel.md docs/RmLegacyAudienceCreateEntityV1.md docs/RmLegacyAudienceCreateEntityV1Resource.md docs/RmLegacyAudienceCreateEntityV1Response.md @@ -370,7 +373,12 @@ docs/RmLegacySegmentCustomerList.md docs/RmLegacySegmentUserBehaviorCreateV2.md docs/RmLegacySegmentUserBehaviorV1.md docs/RmLegacySegmentUserBehaviorV2.md +docs/RmcaCommonProblem.md docs/Section.md +docs/SetBidModel.md +docs/SetBidsModel.md +docs/SetBidsModelRequest.md +docs/SetBidsModelResource.md docs/StatusResponse.md docs/StatusResponseResource.md docs/StoreIdsUpdateModel202110Request.md diff --git a/sdks/retailmedia_2023-04/README.md b/sdks/retailmedia_2023-04/README.md index 87ef1921..7f063511 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.240404 +- Package version: 2023.04.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2023.04.0.240404 +pip install criteo-api-retailmedia-sdk==2023.04.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python @@ -60,12 +60,17 @@ Class | Method | HTTP request | Description ## Documentation For Models + - [AddRemoveKeywordModel](docs/AddRemoveKeywordModel.md) + - [AddRemoveKeywordsModel](docs/AddRemoveKeywordsModel.md) + - [AddRemoveKeywordsModelRequest](docs/AddRemoveKeywordsModelRequest.md) + - [AddRemoveKeywordsModelResource](docs/AddRemoveKeywordsModelResource.md) - [AddToBasketIdsUpdateModel202110Request](docs/AddToBasketIdsUpdateModel202110Request.md) - [AddToBasketTarget202110Request](docs/AddToBasketTarget202110Request.md) - [AddToBasketTarget202110Response](docs/AddToBasketTarget202110Response.md) - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) + - [ApprovalStatusModel](docs/ApprovalStatusModel.md) - [Asset](docs/Asset.md) - [AssetResource](docs/AssetResource.md) - [AssetResponse](docs/AssetResponse.md) @@ -135,6 +140,7 @@ Class | Method | HTTP request | Description - [FilesVariableValue](docs/FilesVariableValue.md) - [FilesVariablesSpecification](docs/FilesVariablesSpecification.md) - [HyperlinkVariableValue](docs/HyperlinkVariableValue.md) + - [InputKeywordsModel](docs/InputKeywordsModel.md) - [InputResourceOfAuctionLineItemCreateModel](docs/InputResourceOfAuctionLineItemCreateModel.md) - [InputResourceOfPreferredLineItemCreateModel202110](docs/InputResourceOfPreferredLineItemCreateModel202110.md) - [JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301](docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md) @@ -154,11 +160,17 @@ Class | Method | HTTP request | Description - [JsonApiSingleResponseOfCampaignV202301](docs/JsonApiSingleResponseOfCampaignV202301.md) - [JsonApiSingleResponseOfCatalogStatus](docs/JsonApiSingleResponseOfCatalogStatus.md) - [JsonApiSingleResponseOfLineItemBidMultipliers](docs/JsonApiSingleResponseOfLineItemBidMultipliers.md) + - [KeywordDataModel](docs/KeywordDataModel.md) - [KeywordTarget202110Request](docs/KeywordTarget202110Request.md) - [KeywordTarget202110Response](docs/KeywordTarget202110Response.md) + - [KeywordsModel](docs/KeywordsModel.md) + - [KeywordsModelResource](docs/KeywordsModelResource.md) + - [KeywordsModelResponse](docs/KeywordsModelResponse.md) - [LineItemBidMultipliers](docs/LineItemBidMultipliers.md) - [LineItemBidMultipliersRequest](docs/LineItemBidMultipliersRequest.md) - [LineItemBidMultipliersResponse](docs/LineItemBidMultipliersResponse.md) + - [MatchTypeModel](docs/MatchTypeModel.md) + - [NegotiationStateModel](docs/NegotiationStateModel.md) - [PageMetadata](docs/PageMetadata.md) - [PageTypeEnvironment](docs/PageTypeEnvironment.md) - [PostCampaignV202301](docs/PostCampaignV202301.md) @@ -169,6 +181,9 @@ Class | Method | HTTP request | Description - [ProblemDetails](docs/ProblemDetails.md) - [PromotedProduct202110ListRequest](docs/PromotedProduct202110ListRequest.md) - [PromotedProduct202110PagedListResponse](docs/PromotedProduct202110PagedListResponse.md) + - [ProposalStatusModel](docs/ProposalStatusModel.md) + - [ProposalStatusModelResource](docs/ProposalStatusModelResource.md) + - [ProposalStatusModelResponse](docs/ProposalStatusModelResponse.md) - [PutCampaignV202301](docs/PutCampaignV202301.md) - [ReportOutcome](docs/ReportOutcome.md) - [ResourceOfAuctionLineItem](docs/ResourceOfAuctionLineItem.md) @@ -184,24 +199,8 @@ Class | Method | HTTP request | Description - [ResourceOfPreferredLineItemUpdateModel202110](docs/ResourceOfPreferredLineItemUpdateModel202110.md) - [ResourceOfPromotedProduct202110](docs/ResourceOfPromotedProduct202110.md) - [ResourceOfTemplate](docs/ResourceOfTemplate.md) - - [RetailMediaExternalv1AddRemoveKeywordModel](docs/RetailMediaExternalv1AddRemoveKeywordModel.md) - - [RetailMediaExternalv1AddRemoveKeywordsModel](docs/RetailMediaExternalv1AddRemoveKeywordsModel.md) - - [RetailMediaExternalv1AddRemoveKeywordsModelRequest](docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md) - - [RetailMediaExternalv1AddRemoveKeywordsModelResource](docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md) - - [RetailMediaExternalv1InputKeywordsModel](docs/RetailMediaExternalv1InputKeywordsModel.md) - - [RetailMediaExternalv1KeywordDataModel](docs/RetailMediaExternalv1KeywordDataModel.md) - - [RetailMediaExternalv1KeywordsModel](docs/RetailMediaExternalv1KeywordsModel.md) - - [RetailMediaExternalv1KeywordsModelResource](docs/RetailMediaExternalv1KeywordsModelResource.md) - - [RetailMediaExternalv1KeywordsModelResponse](docs/RetailMediaExternalv1KeywordsModelResponse.md) - - [RetailMediaExternalv1ProblemDetails](docs/RetailMediaExternalv1ProblemDetails.md) - - [RetailMediaExternalv1ProposalStatusModel](docs/RetailMediaExternalv1ProposalStatusModel.md) - - [RetailMediaExternalv1ProposalStatusModelResource](docs/RetailMediaExternalv1ProposalStatusModelResource.md) - - [RetailMediaExternalv1ProposalStatusModelResponse](docs/RetailMediaExternalv1ProposalStatusModelResponse.md) - - [RetailMediaExternalv1ResourceOutcome](docs/RetailMediaExternalv1ResourceOutcome.md) - - [RetailMediaExternalv1SetBidModel](docs/RetailMediaExternalv1SetBidModel.md) - - [RetailMediaExternalv1SetBidsModel](docs/RetailMediaExternalv1SetBidsModel.md) - - [RetailMediaExternalv1SetBidsModelRequest](docs/RetailMediaExternalv1SetBidsModelRequest.md) - - [RetailMediaExternalv1SetBidsModelResource](docs/RetailMediaExternalv1SetBidsModelResource.md) + - [ResourceOutcome](docs/ResourceOutcome.md) + - [ReviewStateModel](docs/ReviewStateModel.md) - [RmLegacyAudienceCreateEntityV1](docs/RmLegacyAudienceCreateEntityV1.md) - [RmLegacyAudienceCreateEntityV1Resource](docs/RmLegacyAudienceCreateEntityV1Resource.md) - [RmLegacyAudienceCreateEntityV1Response](docs/RmLegacyAudienceCreateEntityV1Response.md) @@ -222,7 +221,12 @@ Class | Method | HTTP request | Description - [RmLegacySegmentUserBehaviorCreateV2](docs/RmLegacySegmentUserBehaviorCreateV2.md) - [RmLegacySegmentUserBehaviorV1](docs/RmLegacySegmentUserBehaviorV1.md) - [RmLegacySegmentUserBehaviorV2](docs/RmLegacySegmentUserBehaviorV2.md) + - [RmcaCommonProblem](docs/RmcaCommonProblem.md) - [Section](docs/Section.md) + - [SetBidModel](docs/SetBidModel.md) + - [SetBidsModel](docs/SetBidsModel.md) + - [SetBidsModelRequest](docs/SetBidsModelRequest.md) + - [SetBidsModelResource](docs/SetBidsModelResource.md) - [StatusResponse](docs/StatusResponse.md) - [StatusResponseResource](docs/StatusResponseResource.md) - [StoreIdsUpdateModel202110Request](docs/StoreIdsUpdateModel202110Request.md) 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 05b7a0b1..1b21306c 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.240404" +__version__ = "2023.04.0.240515" # 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/campaign_api.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/api/campaign_api.py index 09acbf70..2e866124 100644 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/api/campaign_api.py +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/api/campaign_api.py @@ -21,6 +21,7 @@ none_type, validate_and_convert_types ) +from criteo_api_retailmedia_v2023_04.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest from criteo_api_retailmedia_v2023_04.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_04.model.add_to_basket_target202110_request import AddToBasketTarget202110Request from criteo_api_retailmedia_v2023_04.model.add_to_basket_target202110_response import AddToBasketTarget202110Response @@ -55,6 +56,7 @@ from criteo_api_retailmedia_v2023_04.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers from criteo_api_retailmedia_v2023_04.model.keyword_target202110_request import KeywordTarget202110Request from criteo_api_retailmedia_v2023_04.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2023_04.model.keywords_model_response import KeywordsModelResponse from criteo_api_retailmedia_v2023_04.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_v2023_04.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse from criteo_api_retailmedia_v2023_04.model.post_campaign_v202301 import PostCampaignV202301 @@ -64,12 +66,10 @@ from criteo_api_retailmedia_v2023_04.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request from criteo_api_retailmedia_v2023_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest from criteo_api_retailmedia_v2023_04.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2023_04.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_v2023_04.model.put_campaign_v202301 import PutCampaignV202301 -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_v2023_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_04.model.set_bids_model_request import SetBidsModelRequest from criteo_api_retailmedia_v2023_04.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_04.model.store_target202110_request import StoreTarget202110Request from criteo_api_retailmedia_v2023_04.model.store_target202110_response import StoreTarget202110Response @@ -90,7 +90,7 @@ def __init__(self, api_client=None): self.api_client = api_client self.add_remove_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -103,7 +103,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_add_remove_keywords_model_request', + 'add_remove_keywords_model_request', ], 'required': [ 'id', @@ -123,24 +123,22 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_add_remove_keywords_model_request': - (RetailMediaExternalv1AddRemoveKeywordsModelRequest,), + 'add_remove_keywords_model_request': + (AddRemoveKeywordsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_add_remove_keywords_model_request': 'body', + 'add_remove_keywords_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [ 'application/json' @@ -206,7 +204,7 @@ def __init__(self, api_client=None): ) self.fetch_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1KeywordsModelResponse,), + 'response_type': (KeywordsModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -250,9 +248,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -260,7 +256,7 @@ def __init__(self, api_client=None): ) self.fetch_proposal_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -304,9 +300,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -3609,7 +3603,7 @@ def __init__(self, api_client=None): ) self.set_keyword_bids_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -3622,7 +3616,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_set_bids_model_request', + 'set_bids_model_request', ], 'required': [ 'id', @@ -3642,24 +3636,22 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_set_bids_model_request': - (RetailMediaExternalv1SetBidsModelRequest,), + 'set_bids_model_request': + (SetBidsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_set_bids_model_request': 'body', + 'set_bids_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [ 'application/json' @@ -3669,7 +3661,7 @@ def __init__(self, api_client=None): ) self.submit_proposal_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -3713,9 +3705,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -3729,7 +3719,7 @@ def add_remove_keywords( ): """add_remove_keywords # noqa: E501 - Add or Remove keywords from the associated line item in bulk # noqa: E501 + Add or Remove keywords from the line item in bulk # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3737,10 +3727,10 @@ def add_remove_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_add_remove_keywords_model_request (RetailMediaExternalv1AddRemoveKeywordsModelRequest): Object containing keywords to be added or removed. [optional] + add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [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 @@ -3773,7 +3763,7 @@ def add_remove_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -3904,7 +3894,7 @@ def fetch_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -3939,7 +3929,7 @@ def fetch_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1KeywordsModelResponse + KeywordsModelResponse If the method is called asynchronously, returns the request thread. """ @@ -3979,7 +3969,7 @@ def fetch_proposal( ): """fetch_proposal # noqa: E501 - Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501 + Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3987,7 +3977,7 @@ def fetch_proposal( >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -4022,7 +4012,7 @@ def fetch_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ @@ -8784,10 +8774,10 @@ def set_keyword_bids( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_set_bids_model_request (RetailMediaExternalv1SetBidsModelRequest): Object containing a list of bid overrides for associated keywords. [optional] + set_bids_model_request (SetBidsModelRequest): [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 @@ -8820,7 +8810,7 @@ def set_keyword_bids( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -8860,7 +8850,7 @@ def submit_proposal( ): """submit_proposal # noqa: E501 - Submit a proposal to modify a Preferred Deal Line Item for review. # noqa: E501 + Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -8868,7 +8858,7 @@ def submit_proposal( >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -8903,7 +8893,7 @@ def submit_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ 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 6113065e..0ba7c0bd 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.240404/python' + self.user_agent = 'OpenAPI-Generator/2023.04.0.240515/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 be198717..33f8e6f2 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.240404".\ + "SDK Package Version: 2023.04.0.240515".\ 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/add_remove_keyword_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keyword_model.py new file mode 100644 index 00000000..42febe01 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keyword_model.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.match_type_model import MatchTypeModel + globals()['MatchTypeModel'] = MatchTypeModel + + +class AddRemoveKeywordModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'is_deleted': (bool, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'is_deleted': 'isDeleted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model.py new file mode 100644 index 00000000..01eae11f --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.add_remove_keyword_model import AddRemoveKeywordModel + globals()['AddRemoveKeywordModel'] = AddRemoveKeywordModel + + +class AddRemoveKeywordsModel(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 { + 'keywords': ([AddRemoveKeywordModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model_request.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model_request.py new file mode 100644 index 00000000..8c7404f7 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource + globals()['AddRemoveKeywordsModelResource'] = AddRemoveKeywordsModelResource + + +class AddRemoveKeywordsModelRequest(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': (AddRemoveKeywordsModelResource,), # 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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model_resource.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model_resource.py new file mode 100644 index 00000000..18ad3897 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/add_remove_keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.add_remove_keywords_model import AddRemoveKeywordsModel + globals()['AddRemoveKeywordsModel'] = AddRemoveKeywordsModel + + +class AddRemoveKeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (AddRemoveKeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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_2023-04/criteo_api_retailmedia_v2023_04/model/approval_status_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/approval_status_model.py new file mode 100644 index 00000000..682bf485 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/approval_status_model.py @@ -0,0 +1,292 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + + +class ApprovalStatusModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'NOTSUBMITTED': "NotSubmitted", + 'SUBMITTED': "Submitted", + 'REJECTED': "Rejected", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return 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 3d190113..da11b8ad 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 @@ -57,11 +57,13 @@ class AsyncCampaignsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncCampaignsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncCampaignsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncCampaignsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 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 62138df9..e0b493c2 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 @@ -57,11 +57,13 @@ class AsyncLineItemsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncLineItemsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncLineItemsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncLineItemsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/input_keywords_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/input_keywords_model.py new file mode 100644 index 00000000..eb78db2f --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/input_keywords_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + + +class InputKeywordsModel(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 { + 'negative_broad': ([str], none_type,), # noqa: E501 + 'negative_exact': ([str], none_type,), # noqa: E501 + 'positive_exact': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negative_broad': 'negativeBroad', # noqa: E501 + 'negative_exact': 'negativeExact', # noqa: E501 + 'positive_exact': 'positiveExact', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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_2023-04/criteo_api_retailmedia_v2023_04/model/keyword_data_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/keyword_data_model.py new file mode 100644 index 00000000..7d239409 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/keyword_data_model.py @@ -0,0 +1,286 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.input_keywords_model import InputKeywordsModel + from criteo_api_retailmedia_v2023_04.model.match_type_model import MatchTypeModel + from criteo_api_retailmedia_v2023_04.model.review_state_model import ReviewStateModel + globals()['InputKeywordsModel'] = InputKeywordsModel + globals()['MatchTypeModel'] = MatchTypeModel + globals()['ReviewStateModel'] = ReviewStateModel + + +class KeywordDataModel(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 { + 'review_state': (ReviewStateModel,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + 'input_keywords': (InputKeywordsModel,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'review_state': 'reviewState', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'bid': 'bid', # noqa: E501 + 'input_keywords': 'inputKeywords', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model.py new file mode 100644 index 00000000..95642ded --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.keyword_data_model import KeywordDataModel + globals()['KeywordDataModel'] = KeywordDataModel + + +class KeywordsModel(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 { + 'keywords': ({str: (KeywordDataModel,)}, none_type,), # noqa: E501 + 'rank': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + 'rank': 'rank', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model_resource.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model_resource.py new file mode 100644 index 00000000..2aefb42c --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.keywords_model import KeywordsModel + globals()['KeywordsModel'] = KeywordsModel + + +class KeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (KeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model_response.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model_response.py new file mode 100644 index 00000000..79428d80 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/keywords_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.keywords_model_resource import KeywordsModelResource + from criteo_api_retailmedia_v2023_04.model.rmca_common_problem import RmcaCommonProblem + globals()['KeywordsModelResource'] = KeywordsModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class KeywordsModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (KeywordsModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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_2023-04/criteo_api_retailmedia_v2023_04/model/match_type_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/match_type_model.py new file mode 100644 index 00000000..af99a2e5 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/match_type_model.py @@ -0,0 +1,291 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + + +class MatchTypeModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'POSITIVEEXACTMATCH': "PositiveExactMatch", + 'NEGATIVEEXACTMATCH': "NegativeExactMatch", + 'NEGATIVEBROADMATCH': "NegativeBroadMatch", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/negotiation_state_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/negotiation_state_model.py new file mode 100644 index 00000000..addba889 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/negotiation_state_model.py @@ -0,0 +1,293 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + + +class NegotiationStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INVALID': "Invalid", + 'MODIFIED': "Modified", + 'SUBMITTED': "Submitted", + 'REVIEWED': "Reviewed", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model.py new file mode 100644 index 00000000..c39dae1e --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model.py @@ -0,0 +1,284 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.approval_status_model import ApprovalStatusModel + from criteo_api_retailmedia_v2023_04.model.negotiation_state_model import NegotiationStateModel + globals()['ApprovalStatusModel'] = ApprovalStatusModel + globals()['NegotiationStateModel'] = NegotiationStateModel + + +class ProposalStatusModel(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 { + 'negotiation_state': (NegotiationStateModel,), # noqa: E501 + 'booking_status': (ApprovalStatusModel,), # noqa: E501 + 'runnable_status': (ApprovalStatusModel,), # noqa: E501 + 'comment': (str, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negotiation_state': 'negotiationState', # noqa: E501 + 'booking_status': 'bookingStatus', # noqa: E501 + 'runnable_status': 'runnableStatus', # noqa: E501 + 'comment': 'comment', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model_resource.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model_resource.py new file mode 100644 index 00000000..28422eea --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.proposal_status_model import ProposalStatusModel + globals()['ProposalStatusModel'] = ProposalStatusModel + + +class ProposalStatusModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (ProposalStatusModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model_response.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model_response.py new file mode 100644 index 00000000..bbfcdc2d --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/proposal_status_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.proposal_status_model_resource import ProposalStatusModelResource + from criteo_api_retailmedia_v2023_04.model.rmca_common_problem import RmcaCommonProblem + globals()['ProposalStatusModelResource'] = ProposalStatusModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ProposalStatusModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (ProposalStatusModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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_2023-04/criteo_api_retailmedia_v2023_04/model/resource_outcome.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/resource_outcome.py new file mode 100644 index 00000000..d1dd0e46 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/resource_outcome.py @@ -0,0 +1,268 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.rmca_common_problem import RmcaCommonProblem + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ResourceOutcome(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keyword_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keyword_model.py deleted file mode 100644 index 0658adf6..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keyword_model.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1AddRemoveKeywordModel(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 = { - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - validations = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'is_deleted': (bool, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'is_deleted': 'isDeleted', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model.py deleted file mode 100644 index ddd42448..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel - globals()['RetailMediaExternalv1AddRemoveKeywordModel'] = RetailMediaExternalv1AddRemoveKeywordModel - - -class RetailMediaExternalv1AddRemoveKeywordsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1AddRemoveKeywordModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model_request.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model_request.py deleted file mode 100644 index 606f4c08..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource - globals()['RetailMediaExternalv1AddRemoveKeywordsModelResource'] = RetailMediaExternalv1AddRemoveKeywordsModelResource - - -class RetailMediaExternalv1AddRemoveKeywordsModelRequest(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': (RetailMediaExternalv1AddRemoveKeywordsModelResource,), # 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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model_resource.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model_resource.py deleted file mode 100644 index 97ac1aa6..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_add_remove_keywords_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel - globals()['RetailMediaExternalv1AddRemoveKeywordsModel'] = RetailMediaExternalv1AddRemoveKeywordsModel - - -class RetailMediaExternalv1AddRemoveKeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1AddRemoveKeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_input_keywords_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_input_keywords_model.py deleted file mode 100644 index 8b16e6eb..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_input_keywords_model.py +++ /dev/null @@ -1,277 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1InputKeywordsModel(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 = { - ('negative_broad',): { - }, - ('negative_exact',): { - }, - ('positive_exact',): { - }, - } - - @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 { - 'negative_broad': ([str], none_type,), # noqa: E501 - 'negative_exact': ([str], none_type,), # noqa: E501 - 'positive_exact': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negative_broad': 'negativeBroad', # noqa: E501 - 'negative_exact': 'negativeExact', # noqa: E501 - 'positive_exact': 'positiveExact', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keyword_data_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keyword_data_model.py deleted file mode 100644 index 2a099433..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keyword_data_model.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel - globals()['RetailMediaExternalv1InputKeywordsModel'] = RetailMediaExternalv1InputKeywordsModel - - -class RetailMediaExternalv1KeywordDataModel(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 = { - ('review_state',): { - 'None': None, - 'INREVIEW': "InReview", - 'RECOMMENDED': "Recommended", - 'APPROVED': "Approved", - 'AUTOAPPROVED': "AutoApproved", - 'REJECTED': "Rejected", - 'AUTOREJECTED': "AutoRejected", - }, - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - 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 { - 'review_state': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - 'input_keywords': (RetailMediaExternalv1InputKeywordsModel,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'review_state': 'reviewState', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'bid': 'bid', # noqa: E501 - 'input_keywords': 'inputKeywords', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model.py deleted file mode 100644 index f8c6738a..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel - globals()['RetailMediaExternalv1KeywordDataModel'] = RetailMediaExternalv1KeywordDataModel - - -class RetailMediaExternalv1KeywordsModel(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 = { - ('rank',): { - }, - } - - @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 { - 'keywords': (RetailMediaExternalv1KeywordDataModel,), # noqa: E501 - 'rank': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - 'rank': 'rank', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model_resource.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model_resource.py deleted file mode 100644 index b9b13f63..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel - globals()['RetailMediaExternalv1KeywordsModel'] = RetailMediaExternalv1KeywordsModel - - -class RetailMediaExternalv1KeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1KeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model_response.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model_response.py deleted file mode 100644 index 0284ed40..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_keywords_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1KeywordsModelResource'] = RetailMediaExternalv1KeywordsModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1KeywordsModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1KeywordsModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_problem_details.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_problem_details.py deleted file mode 100644 index c19df3e3..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_problem_details.py +++ /dev/null @@ -1,295 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1ProblemDetails(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 ({str: (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_identifier': (str, none_type,), # noqa: E501 - 'code': (str, none_type,), # noqa: E501 - 'source': ({str: (str,)}, none_type,), # noqa: E501 - 'stack_trace': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'status': (int, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'instance': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'code': 'code', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - 'type': 'type', # noqa: E501 - 'title': 'title', # noqa: E501 - 'status': 'status', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'instance': 'instance', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model.py deleted file mode 100644 index 1c5998e0..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1ProposalStatusModel(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 = { - ('negotiation_state',): { - 'INVALID': "Invalid", - 'MODIFIED': "Modified", - 'SUBMITTED': "Submitted", - 'REVIEWED': "Reviewed", - 'APPROVED': "Approved", - }, - ('booking_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - ('runnable_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - } - - 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 { - 'negotiation_state': (str,), # noqa: E501 - 'booking_status': (str,), # noqa: E501 - 'runnable_status': (str,), # noqa: E501 - 'comment': (str, none_type,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negotiation_state': 'negotiationState', # noqa: E501 - 'booking_status': 'bookingStatus', # noqa: E501 - 'runnable_status': 'runnableStatus', # noqa: E501 - 'comment': 'comment', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model_resource.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model_resource.py deleted file mode 100644 index 2f3bb22d..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel - globals()['RetailMediaExternalv1ProposalStatusModel'] = RetailMediaExternalv1ProposalStatusModel - - -class RetailMediaExternalv1ProposalStatusModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1ProposalStatusModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model_response.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model_response.py deleted file mode 100644 index 53591602..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_proposal_status_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProposalStatusModelResource'] = RetailMediaExternalv1ProposalStatusModelResource - - -class RetailMediaExternalv1ProposalStatusModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1ProposalStatusModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_resource_outcome.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_resource_outcome.py deleted file mode 100644 index 61754a6b..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_resource_outcome.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1ResourceOutcome(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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 { - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'errors': 'errors', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - } - - read_only_vars = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bid_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bid_model.py deleted file mode 100644 index bea233ca..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bid_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1SetBidModel(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 = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'bid': 'bid', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model.py deleted file mode 100644 index 80a2b94e..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel - globals()['RetailMediaExternalv1SetBidModel'] = RetailMediaExternalv1SetBidModel - - -class RetailMediaExternalv1SetBidsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1SetBidModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model_request.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model_request.py deleted file mode 100644 index 44f97e9e..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource - globals()['RetailMediaExternalv1SetBidsModelResource'] = RetailMediaExternalv1SetBidsModelResource - - -class RetailMediaExternalv1SetBidsModelRequest(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': (RetailMediaExternalv1SetBidsModelResource,), # 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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model_resource.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model_resource.py deleted file mode 100644 index e751796e..00000000 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/retail_media_externalv1_set_bids_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-04 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel - globals()['RetailMediaExternalv1SetBidsModel'] = RetailMediaExternalv1SetBidsModel - - -class RetailMediaExternalv1SetBidsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1SetBidsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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_2023-04/criteo_api_retailmedia_v2023_04/model/review_state_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/review_state_model.py new file mode 100644 index 00000000..d7cd6a2f --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/review_state_model.py @@ -0,0 +1,294 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + + +class ReviewStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INREVIEW': "InReview", + 'RECOMMENDED': "Recommended", + 'APPROVED': "Approved", + 'AUTOAPPROVED': "AutoApproved", + 'REJECTED': "Rejected", + 'AUTOREJECTED': "AutoRejected", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/rmca_common_problem.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/rmca_common_problem.py new file mode 100644 index 00000000..60d66f57 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/rmca_common_problem.py @@ -0,0 +1,306 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + + +class RmcaCommonProblem(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + 'status': (int, none_type,), # 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 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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_2023-04/criteo_api_retailmedia_v2023_04/model/set_bid_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/set_bid_model.py new file mode 100644 index 00000000..236176d2 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/set_bid_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + + +class SetBidModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'bid': 'bid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model.py new file mode 100644 index 00000000..54d8a873 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.set_bid_model import SetBidModel + globals()['SetBidModel'] = SetBidModel + + +class SetBidsModel(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 { + 'keywords': ([SetBidModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model_request.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model_request.py new file mode 100644 index 00000000..a6e0aaec --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.set_bids_model_resource import SetBidsModelResource + globals()['SetBidsModelResource'] = SetBidsModelResource + + +class SetBidsModelRequest(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': (SetBidsModelResource,), # 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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model_resource.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model_resource.py new file mode 100644 index 00000000..659c0b88 --- /dev/null +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/model/set_bids_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_04.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_v2023_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_04.model.set_bids_model import SetBidsModel + globals()['SetBidsModel'] = SetBidsModel + + +class SetBidsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (SetBidsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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_2023-04/criteo_api_retailmedia_v2023_04/models/__init__.py b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/models/__init__.py index 98de3d8b..014a0b4a 100644 --- a/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/models/__init__.py +++ b/sdks/retailmedia_2023-04/criteo_api_retailmedia_v2023_04/models/__init__.py @@ -9,12 +9,17 @@ # import sys # sys.setrecursionlimit(n) +from criteo_api_retailmedia_v2023_04.model.add_remove_keyword_model import AddRemoveKeywordModel +from criteo_api_retailmedia_v2023_04.model.add_remove_keywords_model import AddRemoveKeywordsModel +from criteo_api_retailmedia_v2023_04.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2023_04.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource from criteo_api_retailmedia_v2023_04.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_04.model.add_to_basket_target202110_request import AddToBasketTarget202110Request from criteo_api_retailmedia_v2023_04.model.add_to_basket_target202110_response import AddToBasketTarget202110Response from criteo_api_retailmedia_v2023_04.model.application_summary_model import ApplicationSummaryModel from criteo_api_retailmedia_v2023_04.model.application_summary_model_resource import ApplicationSummaryModelResource from criteo_api_retailmedia_v2023_04.model.application_summary_model_response import ApplicationSummaryModelResponse +from criteo_api_retailmedia_v2023_04.model.approval_status_model import ApprovalStatusModel from criteo_api_retailmedia_v2023_04.model.asset import Asset from criteo_api_retailmedia_v2023_04.model.asset_resource import AssetResource from criteo_api_retailmedia_v2023_04.model.asset_response import AssetResponse @@ -84,6 +89,7 @@ from criteo_api_retailmedia_v2023_04.model.files_variable_value import FilesVariableValue from criteo_api_retailmedia_v2023_04.model.files_variables_specification import FilesVariablesSpecification from criteo_api_retailmedia_v2023_04.model.hyperlink_variable_value import HyperlinkVariableValue +from criteo_api_retailmedia_v2023_04.model.input_keywords_model import InputKeywordsModel from criteo_api_retailmedia_v2023_04.model.input_resource_of_auction_line_item_create_model import InputResourceOfAuctionLineItemCreateModel from criteo_api_retailmedia_v2023_04.model.input_resource_of_preferred_line_item_create_model202110 import InputResourceOfPreferredLineItemCreateModel202110 from criteo_api_retailmedia_v2023_04.model.json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 @@ -103,11 +109,17 @@ from criteo_api_retailmedia_v2023_04.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 from criteo_api_retailmedia_v2023_04.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus from criteo_api_retailmedia_v2023_04.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers +from criteo_api_retailmedia_v2023_04.model.keyword_data_model import KeywordDataModel from criteo_api_retailmedia_v2023_04.model.keyword_target202110_request import KeywordTarget202110Request from criteo_api_retailmedia_v2023_04.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2023_04.model.keywords_model import KeywordsModel +from criteo_api_retailmedia_v2023_04.model.keywords_model_resource import KeywordsModelResource +from criteo_api_retailmedia_v2023_04.model.keywords_model_response import KeywordsModelResponse from criteo_api_retailmedia_v2023_04.model.line_item_bid_multipliers import LineItemBidMultipliers from criteo_api_retailmedia_v2023_04.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_v2023_04.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse +from criteo_api_retailmedia_v2023_04.model.match_type_model import MatchTypeModel +from criteo_api_retailmedia_v2023_04.model.negotiation_state_model import NegotiationStateModel from criteo_api_retailmedia_v2023_04.model.page_metadata import PageMetadata from criteo_api_retailmedia_v2023_04.model.page_type_environment import PageTypeEnvironment from criteo_api_retailmedia_v2023_04.model.post_campaign_v202301 import PostCampaignV202301 @@ -118,6 +130,9 @@ from criteo_api_retailmedia_v2023_04.model.problem_details import ProblemDetails from criteo_api_retailmedia_v2023_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest from criteo_api_retailmedia_v2023_04.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2023_04.model.proposal_status_model import ProposalStatusModel +from criteo_api_retailmedia_v2023_04.model.proposal_status_model_resource import ProposalStatusModelResource +from criteo_api_retailmedia_v2023_04.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_v2023_04.model.put_campaign_v202301 import PutCampaignV202301 from criteo_api_retailmedia_v2023_04.model.report_outcome import ReportOutcome from criteo_api_retailmedia_v2023_04.model.resource_of_auction_line_item import ResourceOfAuctionLineItem @@ -133,24 +148,8 @@ from criteo_api_retailmedia_v2023_04.model.resource_of_preferred_line_item_update_model202110 import ResourceOfPreferredLineItemUpdateModel202110 from criteo_api_retailmedia_v2023_04.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 from criteo_api_retailmedia_v2023_04.model.resource_of_template import ResourceOfTemplate -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource +from criteo_api_retailmedia_v2023_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_04.model.review_state_model import ReviewStateModel from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1 from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response @@ -171,7 +170,12 @@ from criteo_api_retailmedia_v2023_04.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2 from criteo_api_retailmedia_v2023_04.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 from criteo_api_retailmedia_v2023_04.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 +from criteo_api_retailmedia_v2023_04.model.rmca_common_problem import RmcaCommonProblem from criteo_api_retailmedia_v2023_04.model.section import Section +from criteo_api_retailmedia_v2023_04.model.set_bid_model import SetBidModel +from criteo_api_retailmedia_v2023_04.model.set_bids_model import SetBidsModel +from criteo_api_retailmedia_v2023_04.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2023_04.model.set_bids_model_resource import SetBidsModelResource from criteo_api_retailmedia_v2023_04.model.status_response import StatusResponse from criteo_api_retailmedia_v2023_04.model.status_response_resource import StatusResponseResource from criteo_api_retailmedia_v2023_04.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request diff --git a/sdks/retailmedia_2023-04/docs/AddRemoveKeywordModel.md b/sdks/retailmedia_2023-04/docs/AddRemoveKeywordModel.md new file mode 100644 index 00000000..8546f1f2 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/AddRemoveKeywordModel.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordModel + +A single keyword to be added or removed + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**is_deleted** | **bool, 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_2023-04/docs/AddRemoveKeywordsModel.md b/sdks/retailmedia_2023-04/docs/AddRemoveKeywordsModel.md new file mode 100644 index 00000000..27980d2b --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/AddRemoveKeywordsModel.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModel + +Data model containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[AddRemoveKeywordModel], none_type**](AddRemoveKeywordModel.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_2023-04/docs/AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2023-04/docs/AddRemoveKeywordsModelRequest.md new file mode 100644 index 00000000..577c720e --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/AddRemoveKeywordsModelRequest.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModelRequest + +Request object to add or remove keywords from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AddRemoveKeywordsModelResource**](AddRemoveKeywordsModelResource.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_2023-04/docs/AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2023-04/docs/AddRemoveKeywordsModelResource.md new file mode 100644 index 00000000..ad36e151 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/AddRemoveKeywordsModelResource.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordsModelResource + +Resource object containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**AddRemoveKeywordsModel**](AddRemoveKeywordsModel.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_2023-04/docs/AnalyticsApi.md b/sdks/retailmedia_2023-04/docs/AnalyticsApi.md index 939584cb..9c9e4c97 100644 --- a/sdks/retailmedia_2023-04/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2023-04/docs/AnalyticsApi.md @@ -65,8 +65,8 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", @@ -178,8 +178,8 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", diff --git a/sdks/retailmedia_2023-04/docs/ApprovalStatusModel.md b/sdks/retailmedia_2023-04/docs/ApprovalStatusModel.md new file mode 100644 index 00000000..52ab7863 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/ApprovalStatusModel.md @@ -0,0 +1,12 @@ +# ApprovalStatusModel + +The status of a booking or runnable in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of a booking or runnable in the context of a line item. | must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] + +[[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_2023-04/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2023-04/docs/AsyncCampaignsReport.md index 21dd57bd..f4385127 100644 --- a/sdks/retailmedia_2023-04/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2023-04/docs/AsyncCampaignsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **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] -**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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-04/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2023-04/docs/AsyncLineItemsReport.md index ccb01090..eece64e3 100644 --- a/sdks/retailmedia_2023-04/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2023-04/docs/AsyncLineItemsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **end_date** | **datetime** | End date | **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-04/docs/CampaignApi.md b/sdks/retailmedia_2023-04/docs/CampaignApi.md index 87b1f235..b4e85234 100644 --- a/sdks/retailmedia_2023-04/docs/CampaignApi.md +++ b/sdks/retailmedia_2023-04/docs/CampaignApi.md @@ -69,11 +69,11 @@ Method | HTTP request | Description # **add_remove_keywords** -> RetailMediaExternalv1ResourceOutcome add_remove_keywords(id) +> ResourceOutcome add_remove_keywords(id) -Add or Remove keywords from the associated line item in bulk +Add or Remove keywords from the line item in bulk ### Example @@ -84,8 +84,8 @@ Add or Remove keywords from the associated line item in bulk import time import criteo_api_retailmedia_v2023_04 from criteo_api_retailmedia_v2023_04.api import campaign_api -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome +from criteo_api_retailmedia_v2023_04.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2023_04.model.resource_outcome import ResourceOutcome 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. @@ -114,22 +114,22 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_add_remove_keywords_model_request = RetailMediaExternalv1AddRemoveKeywordsModelRequest( - data=RetailMediaExternalv1AddRemoveKeywordsModelResource( + id = "id_example" # str | ID of the line item + add_remove_keywords_model_request = AddRemoveKeywordsModelRequest( + data=AddRemoveKeywordsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1AddRemoveKeywordsModel( + attributes=AddRemoveKeywordsModel( keywords=[ - RetailMediaExternalv1AddRemoveKeywordModel( + AddRemoveKeywordModel( phrase="phrase_example", - match_type="PositiveExactMatch", + match_type=MatchTypeModel("PositiveExactMatch"), is_deleted=True, ), ], ), ), - ) # RetailMediaExternalv1AddRemoveKeywordsModelRequest | Object containing keywords to be added or removed (optional) + ) # AddRemoveKeywordsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -141,7 +141,7 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.add_remove_keywords(id, retail_media_externalv1_add_remove_keywords_model_request=retail_media_externalv1_add_remove_keywords_model_request) + api_response = api_instance.add_remove_keywords(id, add_remove_keywords_model_request=add_remove_keywords_model_request) pprint(api_response) except criteo_api_retailmedia_v2023_04.ApiException as e: print("Exception when calling CampaignApi->add_remove_keywords: %s\n" % e) @@ -152,12 +152,12 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_add_remove_keywords_model_request** | [**RetailMediaExternalv1AddRemoveKeywordsModelRequest**](RetailMediaExternalv1AddRemoveKeywordsModelRequest.md)| Object containing keywords to be added or removed | [optional] + **id** | **str**| ID of the line item | + **add_remove_keywords_model_request** | [**AddRemoveKeywordsModelRequest**](AddRemoveKeywordsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -166,7 +166,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -263,7 +263,7 @@ 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) # **fetch_keywords** -> RetailMediaExternalv1KeywordsModelResponse fetch_keywords(id) +> KeywordsModelResponse fetch_keywords(id) @@ -278,7 +278,8 @@ Fetch keywords associated with the specified line item import time import criteo_api_retailmedia_v2023_04 from criteo_api_retailmedia_v2023_04.api import campaign_api -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse +from criteo_api_retailmedia_v2023_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_04.model.keywords_model_response import KeywordsModelResponse 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. @@ -307,7 +308,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -322,11 +323,11 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1KeywordsModelResponse**](RetailMediaExternalv1KeywordsModelResponse.md) +[**KeywordsModelResponse**](KeywordsModelResponse.md) ### Authorization @@ -335,7 +336,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 @@ -348,11 +349,11 @@ 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) # **fetch_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse fetch_proposal(id) +> ProposalStatusModelResponse fetch_proposal(id) -Fetch the status of a proposal to modify a Preferred Deal Line Item. +Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. ### Example @@ -363,7 +364,8 @@ Fetch the status of a proposal to modify a Preferred Deal Line Item. import time import criteo_api_retailmedia_v2023_04 from criteo_api_retailmedia_v2023_04.api import campaign_api -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_v2023_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_04.model.proposal_status_model_response import ProposalStatusModelResponse 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. @@ -392,7 +394,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -407,11 +409,11 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -420,7 +422,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 @@ -429,7 +431,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) @@ -6024,7 +6025,7 @@ 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) # **set_keyword_bids** -> RetailMediaExternalv1ResourceOutcome set_keyword_bids(id) +> ResourceOutcome set_keyword_bids(id) @@ -6039,8 +6040,8 @@ Set bid overrides for associated keywords to the given line item in bulk import time import criteo_api_retailmedia_v2023_04 from criteo_api_retailmedia_v2023_04.api import campaign_api -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_v2023_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_04.model.set_bids_model_request import SetBidsModelRequest 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. @@ -6069,21 +6070,21 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_set_bids_model_request = RetailMediaExternalv1SetBidsModelRequest( - data=RetailMediaExternalv1SetBidsModelResource( + id = "id_example" # str | ID of the line item + set_bids_model_request = SetBidsModelRequest( + data=SetBidsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1SetBidsModel( + attributes=SetBidsModel( keywords=[ - RetailMediaExternalv1SetBidModel( + SetBidModel( phrase="phrase_example", bid=3.14, ), ], ), ), - ) # RetailMediaExternalv1SetBidsModelRequest | Object containing a list of bid overrides for associated keywords (optional) + ) # SetBidsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -6095,7 +6096,7 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.set_keyword_bids(id, retail_media_externalv1_set_bids_model_request=retail_media_externalv1_set_bids_model_request) + api_response = api_instance.set_keyword_bids(id, set_bids_model_request=set_bids_model_request) pprint(api_response) except criteo_api_retailmedia_v2023_04.ApiException as e: print("Exception when calling CampaignApi->set_keyword_bids: %s\n" % e) @@ -6106,12 +6107,12 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_set_bids_model_request** | [**RetailMediaExternalv1SetBidsModelRequest**](RetailMediaExternalv1SetBidsModelRequest.md)| Object containing a list of bid overrides for associated keywords | [optional] + **id** | **str**| ID of the line item | + **set_bids_model_request** | [**SetBidsModelRequest**](SetBidsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -6120,7 +6121,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -6133,11 +6134,11 @@ 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) # **submit_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse submit_proposal(id) +> ProposalStatusModelResponse submit_proposal(id) -Submit a proposal to modify a Preferred Deal Line Item for review. +Only the components of the Line Item that are in a valid state will be reviewed. ### Example @@ -6148,7 +6149,8 @@ Submit a proposal to modify a Preferred Deal Line Item for review. import time import criteo_api_retailmedia_v2023_04 from criteo_api_retailmedia_v2023_04.api import campaign_api -from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_v2023_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_04.model.proposal_status_model_response import ProposalStatusModelResponse 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. @@ -6177,7 +6179,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -6192,11 +6194,11 @@ with criteo_api_retailmedia_v2023_04.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -6205,7 +6207,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 @@ -6214,7 +6216,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) diff --git a/sdks/retailmedia_2023-04/docs/InputKeywordsModel.md b/sdks/retailmedia_2023-04/docs/InputKeywordsModel.md new file mode 100644 index 00000000..9a080793 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/InputKeywordsModel.md @@ -0,0 +1,14 @@ +# InputKeywordsModel + +The keywords to be added or removed from a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negative_broad** | **[str], none_type** | | [optional] +**negative_exact** | **[str], none_type** | | [optional] +**positive_exact** | **[str], 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_2023-04/docs/KeywordDataModel.md b/sdks/retailmedia_2023-04/docs/KeywordDataModel.md new file mode 100644 index 00000000..fca58d73 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/KeywordDataModel.md @@ -0,0 +1,17 @@ +# KeywordDataModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**review_state** | [**ReviewStateModel**](ReviewStateModel.md) | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**bid** | **float, none_type** | | [optional] +**input_keywords** | [**InputKeywordsModel**](InputKeywordsModel.md) | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2023-04/docs/KeywordsModel.md b/sdks/retailmedia_2023-04/docs/KeywordsModel.md new file mode 100644 index 00000000..d31dabad --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/KeywordsModel.md @@ -0,0 +1,13 @@ +# KeywordsModel + +The keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**{str: (KeywordDataModel,)}, none_type**](KeywordDataModel.md) | | [optional] +**rank** | **[str], 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_2023-04/docs/KeywordsModelResource.md b/sdks/retailmedia_2023-04/docs/KeywordsModelResource.md new file mode 100644 index 00000000..9a26bd3a --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/KeywordsModelResource.md @@ -0,0 +1,14 @@ +# KeywordsModelResource + +Resource object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**KeywordsModel**](KeywordsModel.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_2023-04/docs/KeywordsModelResponse.md b/sdks/retailmedia_2023-04/docs/KeywordsModelResponse.md new file mode 100644 index 00000000..2d24cc4e --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/KeywordsModelResponse.md @@ -0,0 +1,14 @@ +# KeywordsModelResponse + +Response object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**KeywordsModelResource**](KeywordsModelResource.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_2023-04/docs/MatchTypeModel.md b/sdks/retailmedia_2023-04/docs/MatchTypeModel.md new file mode 100644 index 00000000..9406306f --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/MatchTypeModel.md @@ -0,0 +1,12 @@ +# MatchTypeModel + +The match type of a keyword. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The match type of a keyword. | must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] + +[[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_2023-04/docs/NegotiationStateModel.md b/sdks/retailmedia_2023-04/docs/NegotiationStateModel.md new file mode 100644 index 00000000..e34ddbf4 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/NegotiationStateModel.md @@ -0,0 +1,12 @@ +# NegotiationStateModel + +The state of a negotiation in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a negotiation in the context of a line item. | must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] + +[[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_2023-04/docs/ProposalStatusModel.md b/sdks/retailmedia_2023-04/docs/ProposalStatusModel.md new file mode 100644 index 00000000..49d39c19 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/ProposalStatusModel.md @@ -0,0 +1,17 @@ +# ProposalStatusModel + +The state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negotiation_state** | [**NegotiationStateModel**](NegotiationStateModel.md) | | [optional] +**booking_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**runnable_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**comment** | **str, none_type** | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2023-04/docs/ProposalStatusModelResource.md b/sdks/retailmedia_2023-04/docs/ProposalStatusModelResource.md new file mode 100644 index 00000000..f89ca4eb --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/ProposalStatusModelResource.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResource + +Resource object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**ProposalStatusModel**](ProposalStatusModel.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_2023-04/docs/ProposalStatusModelResponse.md b/sdks/retailmedia_2023-04/docs/ProposalStatusModelResponse.md new file mode 100644 index 00000000..2e87ff0d --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/ProposalStatusModelResponse.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResponse + +Response object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**ProposalStatusModelResource**](ProposalStatusModelResource.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_2023-04/docs/ResourceOutcome.md b/sdks/retailmedia_2023-04/docs/ResourceOutcome.md new file mode 100644 index 00000000..3bf8a5e5 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/ResourceOutcome.md @@ -0,0 +1,13 @@ +# ResourceOutcome + +Outcome object containing errors and warnings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.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_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordModel.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordModel.md deleted file mode 100644 index 98c859cd..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordModel - -A single keyword to be added or removed - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**is_deleted** | **bool, 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_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md deleted file mode 100644 index 2d39bd84..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModel - -Data model containing keywords to be added or removed from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1AddRemoveKeywordModel], none_type**](RetailMediaExternalv1AddRemoveKeywordModel.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_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md deleted file mode 100644 index d623d5f5..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelRequest - -Request object to add or remove keywords from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1AddRemoveKeywordsModelResource**](RetailMediaExternalv1AddRemoveKeywordsModelResource.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_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md deleted file mode 100644 index 1abf3809..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelResource - -Resource wrapper the keyword add and remove datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1AddRemoveKeywordsModel**](RetailMediaExternalv1AddRemoveKeywordsModel.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_2023-04/docs/RetailMediaExternalv1InputKeywordsModel.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1InputKeywordsModel.md deleted file mode 100644 index 19807cea..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1InputKeywordsModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1InputKeywordsModel - -Input values associated with a keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negative_broad** | **[str], none_type** | | [optional] -**negative_exact** | **[str], none_type** | | [optional] -**positive_exact** | **[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_2023-04/docs/RetailMediaExternalv1KeywordDataModel.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1KeywordDataModel.md deleted file mode 100644 index d7326d7a..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1KeywordDataModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1KeywordDataModel - -Details for a specific keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**review_state** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**bid** | **float, none_type** | | [optional] -**input_keywords** | [**RetailMediaExternalv1InputKeywordsModel**](RetailMediaExternalv1InputKeywordsModel.md) | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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_2023-04/docs/RetailMediaExternalv1KeywordsModel.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1KeywordsModel.md deleted file mode 100644 index 105b25b5..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1KeywordsModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1KeywordsModel - -Datamodel representing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**RetailMediaExternalv1KeywordDataModel**](RetailMediaExternalv1KeywordDataModel.md) | | [optional] -**rank** | **[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_2023-04/docs/RetailMediaExternalv1KeywordsModelResource.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1KeywordsModelResource.md deleted file mode 100644 index 8aabe795..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1KeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResource - -Resource wrapper of associated keywords with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1KeywordsModel**](RetailMediaExternalv1KeywordsModel.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_2023-04/docs/RetailMediaExternalv1KeywordsModelResponse.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1KeywordsModelResponse.md deleted file mode 100644 index eb84587c..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1KeywordsModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResponse - -Response object containing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1KeywordsModelResource**](RetailMediaExternalv1KeywordsModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-04/docs/RetailMediaExternalv1ProblemDetails.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ProblemDetails.md deleted file mode 100644 index 32758436..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ProblemDetails.md +++ /dev/null @@ -1,21 +0,0 @@ -# RetailMediaExternalv1ProblemDetails - -Datamodel for common errors and warnings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**trace_identifier** | **str, none_type** | | [optional] -**code** | **str, none_type** | | [optional] -**source** | **{str: (str,)}, none_type** | | [optional] -**stack_trace** | **str, none_type** | | [optional] -**type** | **str, none_type** | | [optional] -**title** | **str, none_type** | | [optional] -**status** | **int, none_type** | | [optional] -**detail** | **str, none_type** | | [optional] -**instance** | **str, none_type** | | [optional] -**any string name** | **{str: (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_2023-04/docs/RetailMediaExternalv1ProposalStatusModel.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ProposalStatusModel.md deleted file mode 100644 index 93cf4401..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ProposalStatusModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModel - -The proposal status includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negotiation_state** | **str** | | -**booking_status** | **str** | | -**runnable_status** | **str** | | -**comment** | **str, none_type** | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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_2023-04/docs/RetailMediaExternalv1ProposalStatusModelResource.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ProposalStatusModelResource.md deleted file mode 100644 index 4c5ebc52..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ProposalStatusModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResource - -Wrapper for the proposal status - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1ProposalStatusModel**](RetailMediaExternalv1ProposalStatusModel.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_2023-04/docs/RetailMediaExternalv1ProposalStatusModelResponse.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ProposalStatusModelResponse.md deleted file mode 100644 index 2550a175..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ProposalStatusModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResponse - -Wrapper for the proposal status resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1ProposalStatusModelResource**](RetailMediaExternalv1ProposalStatusModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-04/docs/RetailMediaExternalv1ResourceOutcome.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ResourceOutcome.md deleted file mode 100644 index 7b1c09f1..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1ResourceOutcome.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1ResourceOutcome - -A response object containing errors or warnings if required - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-04/docs/RetailMediaExternalv1SetBidModel.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidModel.md deleted file mode 100644 index 978f8b12..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1SetBidModel - -A single keyword and associated bid override - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**bid** | **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/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidsModel.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidsModel.md deleted file mode 100644 index 2b1359ff..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModel - -Data model containing keywords and bid overrides to associate to them - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1SetBidModel], none_type**](RetailMediaExternalv1SetBidModel.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_2023-04/docs/RetailMediaExternalv1SetBidsModelRequest.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidsModelRequest.md deleted file mode 100644 index e40b943e..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModelRequest - -Request to set bid overrides for specified keywords on a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1SetBidsModelResource**](RetailMediaExternalv1SetBidsModelResource.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_2023-04/docs/RetailMediaExternalv1SetBidsModelResource.md b/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidsModelResource.md deleted file mode 100644 index 4a4e3082..00000000 --- a/sdks/retailmedia_2023-04/docs/RetailMediaExternalv1SetBidsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1SetBidsModelResource - -Wrapper of the Set Bids datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1SetBidsModel**](RetailMediaExternalv1SetBidsModel.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_2023-04/docs/ReviewStateModel.md b/sdks/retailmedia_2023-04/docs/ReviewStateModel.md new file mode 100644 index 00000000..e905d467 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/ReviewStateModel.md @@ -0,0 +1,12 @@ +# ReviewStateModel + +The state of a keyword in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a keyword in the context of a line item. | must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] + +[[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_2023-04/docs/RmLegacyAudienceGetEntityV1ListResponse.md b/sdks/retailmedia_2023-04/docs/RmLegacyAudienceGetEntityV1ListResponse.md index a086fc52..177bd87b 100644 --- a/sdks/retailmedia_2023-04/docs/RmLegacyAudienceGetEntityV1ListResponse.md +++ b/sdks/retailmedia_2023-04/docs/RmLegacyAudienceGetEntityV1ListResponse.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1ListResponse -List of responses +A top-level object that encapsulates a Criteo API response for several entities and metadata ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2023-04/docs/RmLegacyAudienceGetEntityV1Resource.md b/sdks/retailmedia_2023-04/docs/RmLegacyAudienceGetEntityV1Resource.md index 7d4b9798..dad0c799 100644 --- a/sdks/retailmedia_2023-04/docs/RmLegacyAudienceGetEntityV1Resource.md +++ b/sdks/retailmedia_2023-04/docs/RmLegacyAudienceGetEntityV1Resource.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1Resource -Legacy resource +A class that represents a domain entity exposed by an API ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2023-04/docs/RmcaCommonProblem.md b/sdks/retailmedia_2023-04/docs/RmcaCommonProblem.md new file mode 100644 index 00000000..fba2c66b --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/RmcaCommonProblem.md @@ -0,0 +1,21 @@ +# RmcaCommonProblem + +Common problem object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trace_id** | **str, none_type** | The request correlation ID this problem comes from. | [optional] +**type** | **str, none_type** | The problem's category. | [optional] +**code** | **str, none_type** | A machine-readable error code, expressed as a string value. | [optional] +**instance** | **str, none_type** | A URI that identifies the specific occurrence of the problem. | [optional] +**title** | **str, none_type** | A short human-readable description of the problem type | [optional] +**detail** | **str, none_type** | A human-readable explanation specific to this occurrence of the problem | [optional] +**source** | **{str: (str,)}, none_type** | A machine-readable structure to reference to the exact location(s) causing the error(s) | [optional] +**stack_trace** | **str, none_type** | | [optional] +**status** | **int, none_type** | The problem's HTTP Status code. | [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_2023-04/docs/SetBidModel.md b/sdks/retailmedia_2023-04/docs/SetBidModel.md new file mode 100644 index 00000000..979e91d0 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/SetBidModel.md @@ -0,0 +1,13 @@ +# SetBidModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**bid** | **float, 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_2023-04/docs/SetBidsModel.md b/sdks/retailmedia_2023-04/docs/SetBidsModel.md new file mode 100644 index 00000000..e5e1b0c8 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/SetBidsModel.md @@ -0,0 +1,12 @@ +# SetBidsModel + +Data model containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[SetBidModel], none_type**](SetBidModel.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_2023-04/docs/SetBidsModelRequest.md b/sdks/retailmedia_2023-04/docs/SetBidsModelRequest.md new file mode 100644 index 00000000..9c19c9c2 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/SetBidsModelRequest.md @@ -0,0 +1,12 @@ +# SetBidsModelRequest + +Request object to set bid overrides for keywords associated with a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SetBidsModelResource**](SetBidsModelResource.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_2023-04/docs/SetBidsModelResource.md b/sdks/retailmedia_2023-04/docs/SetBidsModelResource.md new file mode 100644 index 00000000..6e436263 --- /dev/null +++ b/sdks/retailmedia_2023-04/docs/SetBidsModelResource.md @@ -0,0 +1,14 @@ +# SetBidsModelResource + +Resource object containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**SetBidsModel**](SetBidsModel.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_2023-04/setup.py b/sdks/retailmedia_2023-04/setup.py index 9fe48064..07f31aae 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.240404" +VERSION = "2023.04.0.240515" # 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.240404 +pip install criteo-api-retailmedia-sdk==2023.04.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-07/.openapi-generator/FILES b/sdks/retailmedia_2023-07/.openapi-generator/FILES index 1ba8fcac..4531d47d 100644 --- a/sdks/retailmedia_2023-07/.openapi-generator/FILES +++ b/sdks/retailmedia_2023-07/.openapi-generator/FILES @@ -19,12 +19,17 @@ criteo_api_retailmedia_v2023_07/criteo_rest.py criteo_api_retailmedia_v2023_07/exceptions.py criteo_api_retailmedia_v2023_07/flow_constants.py criteo_api_retailmedia_v2023_07/model/__init__.py +criteo_api_retailmedia_v2023_07/model/add_remove_keyword_model.py +criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model.py +criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_request.py +criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_resource.py criteo_api_retailmedia_v2023_07/model/add_to_basket_ids_update_model202110_request.py criteo_api_retailmedia_v2023_07/model/add_to_basket_target202110_request.py criteo_api_retailmedia_v2023_07/model/add_to_basket_target202110_response.py criteo_api_retailmedia_v2023_07/model/application_summary_model.py criteo_api_retailmedia_v2023_07/model/application_summary_model_resource.py criteo_api_retailmedia_v2023_07/model/application_summary_model_response.py +criteo_api_retailmedia_v2023_07/model/approval_status_model.py criteo_api_retailmedia_v2023_07/model/asset.py criteo_api_retailmedia_v2023_07/model/asset_resource.py criteo_api_retailmedia_v2023_07/model/asset_response.py @@ -94,6 +99,7 @@ criteo_api_retailmedia_v2023_07/model/external_store_target202110.py criteo_api_retailmedia_v2023_07/model/files_variable_value.py criteo_api_retailmedia_v2023_07/model/files_variables_specification.py criteo_api_retailmedia_v2023_07/model/hyperlink_variable_value.py +criteo_api_retailmedia_v2023_07/model/input_keywords_model.py criteo_api_retailmedia_v2023_07/model/input_resource_of_auction_line_item_create_model.py criteo_api_retailmedia_v2023_07/model/input_resource_of_preferred_line_item_create_model202110.py criteo_api_retailmedia_v2023_07/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py @@ -113,11 +119,17 @@ criteo_api_retailmedia_v2023_07/model/json_api_request_of_catalog_request.py criteo_api_retailmedia_v2023_07/model/json_api_single_response_of_campaign_v202301.py criteo_api_retailmedia_v2023_07/model/json_api_single_response_of_catalog_status.py criteo_api_retailmedia_v2023_07/model/json_api_single_response_of_line_item_bid_multipliers.py +criteo_api_retailmedia_v2023_07/model/keyword_data_model.py criteo_api_retailmedia_v2023_07/model/keyword_target202110_request.py criteo_api_retailmedia_v2023_07/model/keyword_target202110_response.py +criteo_api_retailmedia_v2023_07/model/keywords_model.py +criteo_api_retailmedia_v2023_07/model/keywords_model_resource.py +criteo_api_retailmedia_v2023_07/model/keywords_model_response.py criteo_api_retailmedia_v2023_07/model/line_item_bid_multipliers.py criteo_api_retailmedia_v2023_07/model/line_item_bid_multipliers_request.py criteo_api_retailmedia_v2023_07/model/line_item_bid_multipliers_response.py +criteo_api_retailmedia_v2023_07/model/match_type_model.py +criteo_api_retailmedia_v2023_07/model/negotiation_state_model.py criteo_api_retailmedia_v2023_07/model/page_metadata.py criteo_api_retailmedia_v2023_07/model/page_type_environment.py criteo_api_retailmedia_v2023_07/model/post_campaign_v202301.py @@ -128,6 +140,9 @@ criteo_api_retailmedia_v2023_07/model/preferred_line_item_update_model202110_req criteo_api_retailmedia_v2023_07/model/problem_details.py criteo_api_retailmedia_v2023_07/model/promoted_product202110_list_request.py criteo_api_retailmedia_v2023_07/model/promoted_product202110_paged_list_response.py +criteo_api_retailmedia_v2023_07/model/proposal_status_model.py +criteo_api_retailmedia_v2023_07/model/proposal_status_model_resource.py +criteo_api_retailmedia_v2023_07/model/proposal_status_model_response.py criteo_api_retailmedia_v2023_07/model/put_campaign_v202301.py criteo_api_retailmedia_v2023_07/model/report_outcome.py criteo_api_retailmedia_v2023_07/model/resource_of_auction_line_item.py @@ -143,24 +158,8 @@ criteo_api_retailmedia_v2023_07/model/resource_of_preferred_line_item202110.py criteo_api_retailmedia_v2023_07/model/resource_of_preferred_line_item_update_model202110.py criteo_api_retailmedia_v2023_07/model/resource_of_promoted_product202110.py criteo_api_retailmedia_v2023_07/model/resource_of_template.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keyword_model.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model_request.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model_resource.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_input_keywords_model.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keyword_data_model.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_resource.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_response.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_problem_details.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_resource.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_response.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_resource_outcome.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bid_model.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model_request.py -criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model_resource.py +criteo_api_retailmedia_v2023_07/model/resource_outcome.py +criteo_api_retailmedia_v2023_07/model/review_state_model.py criteo_api_retailmedia_v2023_07/model/rm_legacy_audience_create_entity_v1.py criteo_api_retailmedia_v2023_07/model/rm_legacy_audience_create_entity_v1_resource.py criteo_api_retailmedia_v2023_07/model/rm_legacy_audience_create_entity_v1_response.py @@ -181,7 +180,12 @@ criteo_api_retailmedia_v2023_07/model/rm_legacy_segment_customer_list.py criteo_api_retailmedia_v2023_07/model/rm_legacy_segment_user_behavior_create_v2.py criteo_api_retailmedia_v2023_07/model/rm_legacy_segment_user_behavior_v1.py criteo_api_retailmedia_v2023_07/model/rm_legacy_segment_user_behavior_v2.py +criteo_api_retailmedia_v2023_07/model/rmca_common_problem.py criteo_api_retailmedia_v2023_07/model/section.py +criteo_api_retailmedia_v2023_07/model/set_bid_model.py +criteo_api_retailmedia_v2023_07/model/set_bids_model.py +criteo_api_retailmedia_v2023_07/model/set_bids_model_request.py +criteo_api_retailmedia_v2023_07/model/set_bids_model_resource.py criteo_api_retailmedia_v2023_07/model/status_response.py criteo_api_retailmedia_v2023_07/model/status_response_resource.py criteo_api_retailmedia_v2023_07/model/store_ids_update_model202110_request.py @@ -204,6 +208,10 @@ criteo_api_retailmedia_v2023_07/model/value_type_resource_of_store_target202110. criteo_api_retailmedia_v2023_07/model_utils.py criteo_api_retailmedia_v2023_07/models/__init__.py criteo_api_retailmedia_v2023_07/rest.py +docs/AddRemoveKeywordModel.md +docs/AddRemoveKeywordsModel.md +docs/AddRemoveKeywordsModelRequest.md +docs/AddRemoveKeywordsModelResource.md docs/AddToBasketIdsUpdateModel202110Request.md docs/AddToBasketTarget202110Request.md docs/AddToBasketTarget202110Response.md @@ -211,6 +219,7 @@ docs/AnalyticsApi.md docs/ApplicationSummaryModel.md docs/ApplicationSummaryModelResource.md docs/ApplicationSummaryModelResponse.md +docs/ApprovalStatusModel.md docs/Asset.md docs/AssetResource.md docs/AssetResponse.md @@ -283,6 +292,7 @@ docs/FilesVariableValue.md docs/FilesVariablesSpecification.md docs/GatewayApi.md docs/HyperlinkVariableValue.md +docs/InputKeywordsModel.md docs/InputResourceOfAuctionLineItemCreateModel.md docs/InputResourceOfPreferredLineItemCreateModel202110.md docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md @@ -302,11 +312,17 @@ docs/JsonApiRequestOfCatalogRequest.md docs/JsonApiSingleResponseOfCampaignV202301.md docs/JsonApiSingleResponseOfCatalogStatus.md docs/JsonApiSingleResponseOfLineItemBidMultipliers.md +docs/KeywordDataModel.md docs/KeywordTarget202110Request.md docs/KeywordTarget202110Response.md +docs/KeywordsModel.md +docs/KeywordsModelResource.md +docs/KeywordsModelResponse.md docs/LineItemBidMultipliers.md docs/LineItemBidMultipliersRequest.md docs/LineItemBidMultipliersResponse.md +docs/MatchTypeModel.md +docs/NegotiationStateModel.md docs/PageMetadata.md docs/PageTypeEnvironment.md docs/PostCampaignV202301.md @@ -317,6 +333,9 @@ docs/PreferredLineItemUpdateModel202110Request.md docs/ProblemDetails.md docs/PromotedProduct202110ListRequest.md docs/PromotedProduct202110PagedListResponse.md +docs/ProposalStatusModel.md +docs/ProposalStatusModelResource.md +docs/ProposalStatusModelResponse.md docs/PutCampaignV202301.md docs/ReportOutcome.md docs/ResourceOfAuctionLineItem.md @@ -332,24 +351,8 @@ docs/ResourceOfPreferredLineItem202110.md docs/ResourceOfPreferredLineItemUpdateModel202110.md docs/ResourceOfPromotedProduct202110.md docs/ResourceOfTemplate.md -docs/RetailMediaExternalv1AddRemoveKeywordModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md -docs/RetailMediaExternalv1InputKeywordsModel.md -docs/RetailMediaExternalv1KeywordDataModel.md -docs/RetailMediaExternalv1KeywordsModel.md -docs/RetailMediaExternalv1KeywordsModelResource.md -docs/RetailMediaExternalv1KeywordsModelResponse.md -docs/RetailMediaExternalv1ProblemDetails.md -docs/RetailMediaExternalv1ProposalStatusModel.md -docs/RetailMediaExternalv1ProposalStatusModelResource.md -docs/RetailMediaExternalv1ProposalStatusModelResponse.md -docs/RetailMediaExternalv1ResourceOutcome.md -docs/RetailMediaExternalv1SetBidModel.md -docs/RetailMediaExternalv1SetBidsModel.md -docs/RetailMediaExternalv1SetBidsModelRequest.md -docs/RetailMediaExternalv1SetBidsModelResource.md +docs/ResourceOutcome.md +docs/ReviewStateModel.md docs/RmLegacyAudienceCreateEntityV1.md docs/RmLegacyAudienceCreateEntityV1Resource.md docs/RmLegacyAudienceCreateEntityV1Response.md @@ -370,7 +373,12 @@ docs/RmLegacySegmentCustomerList.md docs/RmLegacySegmentUserBehaviorCreateV2.md docs/RmLegacySegmentUserBehaviorV1.md docs/RmLegacySegmentUserBehaviorV2.md +docs/RmcaCommonProblem.md docs/Section.md +docs/SetBidModel.md +docs/SetBidsModel.md +docs/SetBidsModelRequest.md +docs/SetBidsModelResource.md docs/StatusResponse.md docs/StatusResponseResource.md docs/StoreIdsUpdateModel202110Request.md diff --git a/sdks/retailmedia_2023-07/README.md b/sdks/retailmedia_2023-07/README.md index fba8eab5..3a1d84ab 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.240404 +- Package version: 2023.07.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2023.07.0.240404 +pip install criteo-api-retailmedia-sdk==2023.07.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python @@ -60,12 +60,17 @@ Class | Method | HTTP request | Description ## Documentation For Models + - [AddRemoveKeywordModel](docs/AddRemoveKeywordModel.md) + - [AddRemoveKeywordsModel](docs/AddRemoveKeywordsModel.md) + - [AddRemoveKeywordsModelRequest](docs/AddRemoveKeywordsModelRequest.md) + - [AddRemoveKeywordsModelResource](docs/AddRemoveKeywordsModelResource.md) - [AddToBasketIdsUpdateModel202110Request](docs/AddToBasketIdsUpdateModel202110Request.md) - [AddToBasketTarget202110Request](docs/AddToBasketTarget202110Request.md) - [AddToBasketTarget202110Response](docs/AddToBasketTarget202110Response.md) - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) + - [ApprovalStatusModel](docs/ApprovalStatusModel.md) - [Asset](docs/Asset.md) - [AssetResource](docs/AssetResource.md) - [AssetResponse](docs/AssetResponse.md) @@ -135,6 +140,7 @@ Class | Method | HTTP request | Description - [FilesVariableValue](docs/FilesVariableValue.md) - [FilesVariablesSpecification](docs/FilesVariablesSpecification.md) - [HyperlinkVariableValue](docs/HyperlinkVariableValue.md) + - [InputKeywordsModel](docs/InputKeywordsModel.md) - [InputResourceOfAuctionLineItemCreateModel](docs/InputResourceOfAuctionLineItemCreateModel.md) - [InputResourceOfPreferredLineItemCreateModel202110](docs/InputResourceOfPreferredLineItemCreateModel202110.md) - [JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301](docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md) @@ -154,11 +160,17 @@ Class | Method | HTTP request | Description - [JsonApiSingleResponseOfCampaignV202301](docs/JsonApiSingleResponseOfCampaignV202301.md) - [JsonApiSingleResponseOfCatalogStatus](docs/JsonApiSingleResponseOfCatalogStatus.md) - [JsonApiSingleResponseOfLineItemBidMultipliers](docs/JsonApiSingleResponseOfLineItemBidMultipliers.md) + - [KeywordDataModel](docs/KeywordDataModel.md) - [KeywordTarget202110Request](docs/KeywordTarget202110Request.md) - [KeywordTarget202110Response](docs/KeywordTarget202110Response.md) + - [KeywordsModel](docs/KeywordsModel.md) + - [KeywordsModelResource](docs/KeywordsModelResource.md) + - [KeywordsModelResponse](docs/KeywordsModelResponse.md) - [LineItemBidMultipliers](docs/LineItemBidMultipliers.md) - [LineItemBidMultipliersRequest](docs/LineItemBidMultipliersRequest.md) - [LineItemBidMultipliersResponse](docs/LineItemBidMultipliersResponse.md) + - [MatchTypeModel](docs/MatchTypeModel.md) + - [NegotiationStateModel](docs/NegotiationStateModel.md) - [PageMetadata](docs/PageMetadata.md) - [PageTypeEnvironment](docs/PageTypeEnvironment.md) - [PostCampaignV202301](docs/PostCampaignV202301.md) @@ -169,6 +181,9 @@ Class | Method | HTTP request | Description - [ProblemDetails](docs/ProblemDetails.md) - [PromotedProduct202110ListRequest](docs/PromotedProduct202110ListRequest.md) - [PromotedProduct202110PagedListResponse](docs/PromotedProduct202110PagedListResponse.md) + - [ProposalStatusModel](docs/ProposalStatusModel.md) + - [ProposalStatusModelResource](docs/ProposalStatusModelResource.md) + - [ProposalStatusModelResponse](docs/ProposalStatusModelResponse.md) - [PutCampaignV202301](docs/PutCampaignV202301.md) - [ReportOutcome](docs/ReportOutcome.md) - [ResourceOfAuctionLineItem](docs/ResourceOfAuctionLineItem.md) @@ -184,24 +199,8 @@ Class | Method | HTTP request | Description - [ResourceOfPreferredLineItemUpdateModel202110](docs/ResourceOfPreferredLineItemUpdateModel202110.md) - [ResourceOfPromotedProduct202110](docs/ResourceOfPromotedProduct202110.md) - [ResourceOfTemplate](docs/ResourceOfTemplate.md) - - [RetailMediaExternalv1AddRemoveKeywordModel](docs/RetailMediaExternalv1AddRemoveKeywordModel.md) - - [RetailMediaExternalv1AddRemoveKeywordsModel](docs/RetailMediaExternalv1AddRemoveKeywordsModel.md) - - [RetailMediaExternalv1AddRemoveKeywordsModelRequest](docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md) - - [RetailMediaExternalv1AddRemoveKeywordsModelResource](docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md) - - [RetailMediaExternalv1InputKeywordsModel](docs/RetailMediaExternalv1InputKeywordsModel.md) - - [RetailMediaExternalv1KeywordDataModel](docs/RetailMediaExternalv1KeywordDataModel.md) - - [RetailMediaExternalv1KeywordsModel](docs/RetailMediaExternalv1KeywordsModel.md) - - [RetailMediaExternalv1KeywordsModelResource](docs/RetailMediaExternalv1KeywordsModelResource.md) - - [RetailMediaExternalv1KeywordsModelResponse](docs/RetailMediaExternalv1KeywordsModelResponse.md) - - [RetailMediaExternalv1ProblemDetails](docs/RetailMediaExternalv1ProblemDetails.md) - - [RetailMediaExternalv1ProposalStatusModel](docs/RetailMediaExternalv1ProposalStatusModel.md) - - [RetailMediaExternalv1ProposalStatusModelResource](docs/RetailMediaExternalv1ProposalStatusModelResource.md) - - [RetailMediaExternalv1ProposalStatusModelResponse](docs/RetailMediaExternalv1ProposalStatusModelResponse.md) - - [RetailMediaExternalv1ResourceOutcome](docs/RetailMediaExternalv1ResourceOutcome.md) - - [RetailMediaExternalv1SetBidModel](docs/RetailMediaExternalv1SetBidModel.md) - - [RetailMediaExternalv1SetBidsModel](docs/RetailMediaExternalv1SetBidsModel.md) - - [RetailMediaExternalv1SetBidsModelRequest](docs/RetailMediaExternalv1SetBidsModelRequest.md) - - [RetailMediaExternalv1SetBidsModelResource](docs/RetailMediaExternalv1SetBidsModelResource.md) + - [ResourceOutcome](docs/ResourceOutcome.md) + - [ReviewStateModel](docs/ReviewStateModel.md) - [RmLegacyAudienceCreateEntityV1](docs/RmLegacyAudienceCreateEntityV1.md) - [RmLegacyAudienceCreateEntityV1Resource](docs/RmLegacyAudienceCreateEntityV1Resource.md) - [RmLegacyAudienceCreateEntityV1Response](docs/RmLegacyAudienceCreateEntityV1Response.md) @@ -222,7 +221,12 @@ Class | Method | HTTP request | Description - [RmLegacySegmentUserBehaviorCreateV2](docs/RmLegacySegmentUserBehaviorCreateV2.md) - [RmLegacySegmentUserBehaviorV1](docs/RmLegacySegmentUserBehaviorV1.md) - [RmLegacySegmentUserBehaviorV2](docs/RmLegacySegmentUserBehaviorV2.md) + - [RmcaCommonProblem](docs/RmcaCommonProblem.md) - [Section](docs/Section.md) + - [SetBidModel](docs/SetBidModel.md) + - [SetBidsModel](docs/SetBidsModel.md) + - [SetBidsModelRequest](docs/SetBidsModelRequest.md) + - [SetBidsModelResource](docs/SetBidsModelResource.md) - [StatusResponse](docs/StatusResponse.md) - [StatusResponseResource](docs/StatusResponseResource.md) - [StoreIdsUpdateModel202110Request](docs/StoreIdsUpdateModel202110Request.md) 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 f3f2afe1..1f83e629 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.240404" +__version__ = "2023.07.0.240515" # 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/campaign_api.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/api/campaign_api.py index fd2bd227..40a49f39 100644 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/api/campaign_api.py +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/api/campaign_api.py @@ -21,6 +21,7 @@ none_type, validate_and_convert_types ) +from criteo_api_retailmedia_v2023_07.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest from criteo_api_retailmedia_v2023_07.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_07.model.add_to_basket_target202110_request import AddToBasketTarget202110Request from criteo_api_retailmedia_v2023_07.model.add_to_basket_target202110_response import AddToBasketTarget202110Response @@ -55,6 +56,7 @@ from criteo_api_retailmedia_v2023_07.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers from criteo_api_retailmedia_v2023_07.model.keyword_target202110_request import KeywordTarget202110Request from criteo_api_retailmedia_v2023_07.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2023_07.model.keywords_model_response import KeywordsModelResponse from criteo_api_retailmedia_v2023_07.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_v2023_07.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse from criteo_api_retailmedia_v2023_07.model.post_campaign_v202301 import PostCampaignV202301 @@ -64,12 +66,10 @@ from criteo_api_retailmedia_v2023_07.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request from criteo_api_retailmedia_v2023_07.model.promoted_product202110_list_request import PromotedProduct202110ListRequest from criteo_api_retailmedia_v2023_07.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2023_07.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_v2023_07.model.put_campaign_v202301 import PutCampaignV202301 -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_v2023_07.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_07.model.set_bids_model_request import SetBidsModelRequest from criteo_api_retailmedia_v2023_07.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_07.model.store_target202110_request import StoreTarget202110Request from criteo_api_retailmedia_v2023_07.model.store_target202110_response import StoreTarget202110Response @@ -90,7 +90,7 @@ def __init__(self, api_client=None): self.api_client = api_client self.add_remove_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -103,7 +103,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_add_remove_keywords_model_request', + 'add_remove_keywords_model_request', ], 'required': [ 'id', @@ -123,24 +123,22 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_add_remove_keywords_model_request': - (RetailMediaExternalv1AddRemoveKeywordsModelRequest,), + 'add_remove_keywords_model_request': + (AddRemoveKeywordsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_add_remove_keywords_model_request': 'body', + 'add_remove_keywords_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [ 'application/json' @@ -206,7 +204,7 @@ def __init__(self, api_client=None): ) self.fetch_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1KeywordsModelResponse,), + 'response_type': (KeywordsModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -250,9 +248,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -260,7 +256,7 @@ def __init__(self, api_client=None): ) self.fetch_proposal_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -304,9 +300,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -3609,7 +3603,7 @@ def __init__(self, api_client=None): ) self.set_keyword_bids_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -3622,7 +3616,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_set_bids_model_request', + 'set_bids_model_request', ], 'required': [ 'id', @@ -3642,24 +3636,22 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_set_bids_model_request': - (RetailMediaExternalv1SetBidsModelRequest,), + 'set_bids_model_request': + (SetBidsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_set_bids_model_request': 'body', + 'set_bids_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [ 'application/json' @@ -3669,7 +3661,7 @@ def __init__(self, api_client=None): ) self.submit_proposal_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -3713,9 +3705,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -3729,7 +3719,7 @@ def add_remove_keywords( ): """add_remove_keywords # noqa: E501 - Add or Remove keywords from the associated line item in bulk # noqa: E501 + Add or Remove keywords from the line item in bulk # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3737,10 +3727,10 @@ def add_remove_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_add_remove_keywords_model_request (RetailMediaExternalv1AddRemoveKeywordsModelRequest): Object containing keywords to be added or removed. [optional] + add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [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 @@ -3773,7 +3763,7 @@ def add_remove_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -3904,7 +3894,7 @@ def fetch_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -3939,7 +3929,7 @@ def fetch_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1KeywordsModelResponse + KeywordsModelResponse If the method is called asynchronously, returns the request thread. """ @@ -3979,7 +3969,7 @@ def fetch_proposal( ): """fetch_proposal # noqa: E501 - Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501 + Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3987,7 +3977,7 @@ def fetch_proposal( >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -4022,7 +4012,7 @@ def fetch_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ @@ -8784,10 +8774,10 @@ def set_keyword_bids( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_set_bids_model_request (RetailMediaExternalv1SetBidsModelRequest): Object containing a list of bid overrides for associated keywords. [optional] + set_bids_model_request (SetBidsModelRequest): [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 @@ -8820,7 +8810,7 @@ def set_keyword_bids( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -8860,7 +8850,7 @@ def submit_proposal( ): """submit_proposal # noqa: E501 - Submit a proposal to modify a Preferred Deal Line Item for review. # noqa: E501 + Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -8868,7 +8858,7 @@ def submit_proposal( >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -8903,7 +8893,7 @@ def submit_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ 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 3430933d..70a752cf 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.240404/python' + self.user_agent = 'OpenAPI-Generator/2023.07.0.240515/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 d57af5a6..4621954f 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.240404".\ + "SDK Package Version: 2023.07.0.240515".\ 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/add_remove_keyword_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keyword_model.py new file mode 100644 index 00000000..1d3670a5 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keyword_model.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.match_type_model import MatchTypeModel + globals()['MatchTypeModel'] = MatchTypeModel + + +class AddRemoveKeywordModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'is_deleted': (bool, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'is_deleted': 'isDeleted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model.py new file mode 100644 index 00000000..37c0f6c3 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.add_remove_keyword_model import AddRemoveKeywordModel + globals()['AddRemoveKeywordModel'] = AddRemoveKeywordModel + + +class AddRemoveKeywordsModel(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 { + 'keywords': ([AddRemoveKeywordModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_request.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_request.py new file mode 100644 index 00000000..761d2872 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource + globals()['AddRemoveKeywordsModelResource'] = AddRemoveKeywordsModelResource + + +class AddRemoveKeywordsModelRequest(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': (AddRemoveKeywordsModelResource,), # 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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_resource.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_resource.py new file mode 100644 index 00000000..3cc9b8a5 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.add_remove_keywords_model import AddRemoveKeywordsModel + globals()['AddRemoveKeywordsModel'] = AddRemoveKeywordsModel + + +class AddRemoveKeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (AddRemoveKeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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_2023-07/criteo_api_retailmedia_v2023_07/model/approval_status_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/approval_status_model.py new file mode 100644 index 00000000..c49f71f1 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/approval_status_model.py @@ -0,0 +1,292 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + + +class ApprovalStatusModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'NOTSUBMITTED': "NotSubmitted", + 'SUBMITTED': "Submitted", + 'REJECTED': "Rejected", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return 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 90c2bf8f..b8084e52 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 @@ -57,11 +57,13 @@ class AsyncCampaignsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncCampaignsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncCampaignsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncCampaignsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 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 a3b1bbf0..d3ed5513 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 @@ -57,11 +57,13 @@ class AsyncLineItemsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncLineItemsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncLineItemsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncLineItemsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/input_keywords_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/input_keywords_model.py new file mode 100644 index 00000000..f3f9aaa0 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/input_keywords_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + + +class InputKeywordsModel(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 { + 'negative_broad': ([str], none_type,), # noqa: E501 + 'negative_exact': ([str], none_type,), # noqa: E501 + 'positive_exact': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negative_broad': 'negativeBroad', # noqa: E501 + 'negative_exact': 'negativeExact', # noqa: E501 + 'positive_exact': 'positiveExact', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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_2023-07/criteo_api_retailmedia_v2023_07/model/keyword_data_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/keyword_data_model.py new file mode 100644 index 00000000..e53b67d8 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/keyword_data_model.py @@ -0,0 +1,286 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.input_keywords_model import InputKeywordsModel + from criteo_api_retailmedia_v2023_07.model.match_type_model import MatchTypeModel + from criteo_api_retailmedia_v2023_07.model.review_state_model import ReviewStateModel + globals()['InputKeywordsModel'] = InputKeywordsModel + globals()['MatchTypeModel'] = MatchTypeModel + globals()['ReviewStateModel'] = ReviewStateModel + + +class KeywordDataModel(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 { + 'review_state': (ReviewStateModel,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + 'input_keywords': (InputKeywordsModel,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'review_state': 'reviewState', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'bid': 'bid', # noqa: E501 + 'input_keywords': 'inputKeywords', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model.py new file mode 100644 index 00000000..c1605c61 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.keyword_data_model import KeywordDataModel + globals()['KeywordDataModel'] = KeywordDataModel + + +class KeywordsModel(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 { + 'keywords': ({str: (KeywordDataModel,)}, none_type,), # noqa: E501 + 'rank': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + 'rank': 'rank', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model_resource.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model_resource.py new file mode 100644 index 00000000..46363266 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.keywords_model import KeywordsModel + globals()['KeywordsModel'] = KeywordsModel + + +class KeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (KeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model_response.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model_response.py new file mode 100644 index 00000000..d50104de --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/keywords_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.keywords_model_resource import KeywordsModelResource + from criteo_api_retailmedia_v2023_07.model.rmca_common_problem import RmcaCommonProblem + globals()['KeywordsModelResource'] = KeywordsModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class KeywordsModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (KeywordsModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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_2023-07/criteo_api_retailmedia_v2023_07/model/match_type_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/match_type_model.py new file mode 100644 index 00000000..56bb978b --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/match_type_model.py @@ -0,0 +1,291 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + + +class MatchTypeModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'POSITIVEEXACTMATCH': "PositiveExactMatch", + 'NEGATIVEEXACTMATCH': "NegativeExactMatch", + 'NEGATIVEBROADMATCH': "NegativeBroadMatch", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/negotiation_state_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/negotiation_state_model.py new file mode 100644 index 00000000..b6bcd5f5 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/negotiation_state_model.py @@ -0,0 +1,293 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + + +class NegotiationStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INVALID': "Invalid", + 'MODIFIED': "Modified", + 'SUBMITTED': "Submitted", + 'REVIEWED': "Reviewed", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model.py new file mode 100644 index 00000000..199ae0a4 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model.py @@ -0,0 +1,284 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.approval_status_model import ApprovalStatusModel + from criteo_api_retailmedia_v2023_07.model.negotiation_state_model import NegotiationStateModel + globals()['ApprovalStatusModel'] = ApprovalStatusModel + globals()['NegotiationStateModel'] = NegotiationStateModel + + +class ProposalStatusModel(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 { + 'negotiation_state': (NegotiationStateModel,), # noqa: E501 + 'booking_status': (ApprovalStatusModel,), # noqa: E501 + 'runnable_status': (ApprovalStatusModel,), # noqa: E501 + 'comment': (str, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negotiation_state': 'negotiationState', # noqa: E501 + 'booking_status': 'bookingStatus', # noqa: E501 + 'runnable_status': 'runnableStatus', # noqa: E501 + 'comment': 'comment', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model_resource.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model_resource.py new file mode 100644 index 00000000..802b186d --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.proposal_status_model import ProposalStatusModel + globals()['ProposalStatusModel'] = ProposalStatusModel + + +class ProposalStatusModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (ProposalStatusModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model_response.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model_response.py new file mode 100644 index 00000000..c3bec824 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/proposal_status_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.proposal_status_model_resource import ProposalStatusModelResource + from criteo_api_retailmedia_v2023_07.model.rmca_common_problem import RmcaCommonProblem + globals()['ProposalStatusModelResource'] = ProposalStatusModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ProposalStatusModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (ProposalStatusModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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_2023-07/criteo_api_retailmedia_v2023_07/model/resource_outcome.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/resource_outcome.py new file mode 100644 index 00000000..d5d38134 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/resource_outcome.py @@ -0,0 +1,268 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.rmca_common_problem import RmcaCommonProblem + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ResourceOutcome(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keyword_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keyword_model.py deleted file mode 100644 index dc6fe1a3..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keyword_model.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1AddRemoveKeywordModel(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 = { - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - validations = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'is_deleted': (bool, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'is_deleted': 'isDeleted', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model.py deleted file mode 100644 index 8c32bdcd..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel - globals()['RetailMediaExternalv1AddRemoveKeywordModel'] = RetailMediaExternalv1AddRemoveKeywordModel - - -class RetailMediaExternalv1AddRemoveKeywordsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1AddRemoveKeywordModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model_request.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model_request.py deleted file mode 100644 index 2050a43d..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource - globals()['RetailMediaExternalv1AddRemoveKeywordsModelResource'] = RetailMediaExternalv1AddRemoveKeywordsModelResource - - -class RetailMediaExternalv1AddRemoveKeywordsModelRequest(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': (RetailMediaExternalv1AddRemoveKeywordsModelResource,), # 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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model_resource.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model_resource.py deleted file mode 100644 index 41c3639d..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_add_remove_keywords_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel - globals()['RetailMediaExternalv1AddRemoveKeywordsModel'] = RetailMediaExternalv1AddRemoveKeywordsModel - - -class RetailMediaExternalv1AddRemoveKeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1AddRemoveKeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_input_keywords_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_input_keywords_model.py deleted file mode 100644 index 9cb0e701..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_input_keywords_model.py +++ /dev/null @@ -1,277 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1InputKeywordsModel(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 = { - ('negative_broad',): { - }, - ('negative_exact',): { - }, - ('positive_exact',): { - }, - } - - @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 { - 'negative_broad': ([str], none_type,), # noqa: E501 - 'negative_exact': ([str], none_type,), # noqa: E501 - 'positive_exact': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negative_broad': 'negativeBroad', # noqa: E501 - 'negative_exact': 'negativeExact', # noqa: E501 - 'positive_exact': 'positiveExact', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keyword_data_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keyword_data_model.py deleted file mode 100644 index 4ead2060..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keyword_data_model.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel - globals()['RetailMediaExternalv1InputKeywordsModel'] = RetailMediaExternalv1InputKeywordsModel - - -class RetailMediaExternalv1KeywordDataModel(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 = { - ('review_state',): { - 'None': None, - 'INREVIEW': "InReview", - 'RECOMMENDED': "Recommended", - 'APPROVED': "Approved", - 'AUTOAPPROVED': "AutoApproved", - 'REJECTED': "Rejected", - 'AUTOREJECTED': "AutoRejected", - }, - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - 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 { - 'review_state': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - 'input_keywords': (RetailMediaExternalv1InputKeywordsModel,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'review_state': 'reviewState', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'bid': 'bid', # noqa: E501 - 'input_keywords': 'inputKeywords', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model.py deleted file mode 100644 index 1f3509c2..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel - globals()['RetailMediaExternalv1KeywordDataModel'] = RetailMediaExternalv1KeywordDataModel - - -class RetailMediaExternalv1KeywordsModel(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 = { - ('rank',): { - }, - } - - @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 { - 'keywords': (RetailMediaExternalv1KeywordDataModel,), # noqa: E501 - 'rank': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - 'rank': 'rank', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_resource.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_resource.py deleted file mode 100644 index d7325759..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel - globals()['RetailMediaExternalv1KeywordsModel'] = RetailMediaExternalv1KeywordsModel - - -class RetailMediaExternalv1KeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1KeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_response.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_response.py deleted file mode 100644 index cf97331e..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1KeywordsModelResource'] = RetailMediaExternalv1KeywordsModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1KeywordsModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1KeywordsModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_problem_details.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_problem_details.py deleted file mode 100644 index cccd556d..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_problem_details.py +++ /dev/null @@ -1,295 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1ProblemDetails(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 ({str: (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_identifier': (str, none_type,), # noqa: E501 - 'code': (str, none_type,), # noqa: E501 - 'source': ({str: (str,)}, none_type,), # noqa: E501 - 'stack_trace': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'status': (int, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'instance': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'code': 'code', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - 'type': 'type', # noqa: E501 - 'title': 'title', # noqa: E501 - 'status': 'status', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'instance': 'instance', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model.py deleted file mode 100644 index 17b696d0..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1ProposalStatusModel(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 = { - ('negotiation_state',): { - 'INVALID': "Invalid", - 'MODIFIED': "Modified", - 'SUBMITTED': "Submitted", - 'REVIEWED': "Reviewed", - 'APPROVED': "Approved", - }, - ('booking_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - ('runnable_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - } - - 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 { - 'negotiation_state': (str,), # noqa: E501 - 'booking_status': (str,), # noqa: E501 - 'runnable_status': (str,), # noqa: E501 - 'comment': (str, none_type,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negotiation_state': 'negotiationState', # noqa: E501 - 'booking_status': 'bookingStatus', # noqa: E501 - 'runnable_status': 'runnableStatus', # noqa: E501 - 'comment': 'comment', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_resource.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_resource.py deleted file mode 100644 index 3c7a8350..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel - globals()['RetailMediaExternalv1ProposalStatusModel'] = RetailMediaExternalv1ProposalStatusModel - - -class RetailMediaExternalv1ProposalStatusModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1ProposalStatusModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_response.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_response.py deleted file mode 100644 index 38a60127..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProposalStatusModelResource'] = RetailMediaExternalv1ProposalStatusModelResource - - -class RetailMediaExternalv1ProposalStatusModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1ProposalStatusModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_resource_outcome.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_resource_outcome.py deleted file mode 100644 index 739ba30f..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_resource_outcome.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1ResourceOutcome(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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 { - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'errors': 'errors', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - } - - read_only_vars = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bid_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bid_model.py deleted file mode 100644 index 352f2814..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bid_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1SetBidModel(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 = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'bid': 'bid', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model.py deleted file mode 100644 index 0ac9f1f4..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel - globals()['RetailMediaExternalv1SetBidModel'] = RetailMediaExternalv1SetBidModel - - -class RetailMediaExternalv1SetBidsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1SetBidModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model_request.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model_request.py deleted file mode 100644 index 3afbcbae..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource - globals()['RetailMediaExternalv1SetBidsModelResource'] = RetailMediaExternalv1SetBidsModelResource - - -class RetailMediaExternalv1SetBidsModelRequest(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': (RetailMediaExternalv1SetBidsModelResource,), # 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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model_resource.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model_resource.py deleted file mode 100644 index 131ba044..00000000 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_set_bids_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-07 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel - globals()['RetailMediaExternalv1SetBidsModel'] = RetailMediaExternalv1SetBidsModel - - -class RetailMediaExternalv1SetBidsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1SetBidsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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_2023-07/criteo_api_retailmedia_v2023_07/model/review_state_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/review_state_model.py new file mode 100644 index 00000000..ce1359a8 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/review_state_model.py @@ -0,0 +1,294 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + + +class ReviewStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INREVIEW': "InReview", + 'RECOMMENDED': "Recommended", + 'APPROVED': "Approved", + 'AUTOAPPROVED': "AutoApproved", + 'REJECTED': "Rejected", + 'AUTOREJECTED': "AutoRejected", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/rmca_common_problem.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/rmca_common_problem.py new file mode 100644 index 00000000..7047f58e --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/rmca_common_problem.py @@ -0,0 +1,306 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + + +class RmcaCommonProblem(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + 'status': (int, none_type,), # 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 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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_2023-07/criteo_api_retailmedia_v2023_07/model/set_bid_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/set_bid_model.py new file mode 100644 index 00000000..53d99e28 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/set_bid_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + + +class SetBidModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'bid': 'bid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model.py new file mode 100644 index 00000000..2337c49d --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.set_bid_model import SetBidModel + globals()['SetBidModel'] = SetBidModel + + +class SetBidsModel(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 { + 'keywords': ([SetBidModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model_request.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model_request.py new file mode 100644 index 00000000..2fdd0e50 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.set_bids_model_resource import SetBidsModelResource + globals()['SetBidsModelResource'] = SetBidsModelResource + + +class SetBidsModelRequest(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': (SetBidsModelResource,), # 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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model_resource.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model_resource.py new file mode 100644 index 00000000..9491fdf0 --- /dev/null +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/model/set_bids_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-07 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_07.model.set_bids_model import SetBidsModel + globals()['SetBidsModel'] = SetBidsModel + + +class SetBidsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (SetBidsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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_2023-07/criteo_api_retailmedia_v2023_07/models/__init__.py b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/models/__init__.py index aeee0da0..c4f6da16 100644 --- a/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/models/__init__.py +++ b/sdks/retailmedia_2023-07/criteo_api_retailmedia_v2023_07/models/__init__.py @@ -9,12 +9,17 @@ # import sys # sys.setrecursionlimit(n) +from criteo_api_retailmedia_v2023_07.model.add_remove_keyword_model import AddRemoveKeywordModel +from criteo_api_retailmedia_v2023_07.model.add_remove_keywords_model import AddRemoveKeywordsModel +from criteo_api_retailmedia_v2023_07.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2023_07.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource from criteo_api_retailmedia_v2023_07.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_07.model.add_to_basket_target202110_request import AddToBasketTarget202110Request from criteo_api_retailmedia_v2023_07.model.add_to_basket_target202110_response import AddToBasketTarget202110Response from criteo_api_retailmedia_v2023_07.model.application_summary_model import ApplicationSummaryModel from criteo_api_retailmedia_v2023_07.model.application_summary_model_resource import ApplicationSummaryModelResource from criteo_api_retailmedia_v2023_07.model.application_summary_model_response import ApplicationSummaryModelResponse +from criteo_api_retailmedia_v2023_07.model.approval_status_model import ApprovalStatusModel from criteo_api_retailmedia_v2023_07.model.asset import Asset from criteo_api_retailmedia_v2023_07.model.asset_resource import AssetResource from criteo_api_retailmedia_v2023_07.model.asset_response import AssetResponse @@ -84,6 +89,7 @@ from criteo_api_retailmedia_v2023_07.model.files_variable_value import FilesVariableValue from criteo_api_retailmedia_v2023_07.model.files_variables_specification import FilesVariablesSpecification from criteo_api_retailmedia_v2023_07.model.hyperlink_variable_value import HyperlinkVariableValue +from criteo_api_retailmedia_v2023_07.model.input_keywords_model import InputKeywordsModel from criteo_api_retailmedia_v2023_07.model.input_resource_of_auction_line_item_create_model import InputResourceOfAuctionLineItemCreateModel from criteo_api_retailmedia_v2023_07.model.input_resource_of_preferred_line_item_create_model202110 import InputResourceOfPreferredLineItemCreateModel202110 from criteo_api_retailmedia_v2023_07.model.json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 @@ -103,11 +109,17 @@ from criteo_api_retailmedia_v2023_07.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 from criteo_api_retailmedia_v2023_07.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus from criteo_api_retailmedia_v2023_07.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers +from criteo_api_retailmedia_v2023_07.model.keyword_data_model import KeywordDataModel from criteo_api_retailmedia_v2023_07.model.keyword_target202110_request import KeywordTarget202110Request from criteo_api_retailmedia_v2023_07.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2023_07.model.keywords_model import KeywordsModel +from criteo_api_retailmedia_v2023_07.model.keywords_model_resource import KeywordsModelResource +from criteo_api_retailmedia_v2023_07.model.keywords_model_response import KeywordsModelResponse from criteo_api_retailmedia_v2023_07.model.line_item_bid_multipliers import LineItemBidMultipliers from criteo_api_retailmedia_v2023_07.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_v2023_07.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse +from criteo_api_retailmedia_v2023_07.model.match_type_model import MatchTypeModel +from criteo_api_retailmedia_v2023_07.model.negotiation_state_model import NegotiationStateModel from criteo_api_retailmedia_v2023_07.model.page_metadata import PageMetadata from criteo_api_retailmedia_v2023_07.model.page_type_environment import PageTypeEnvironment from criteo_api_retailmedia_v2023_07.model.post_campaign_v202301 import PostCampaignV202301 @@ -118,6 +130,9 @@ from criteo_api_retailmedia_v2023_07.model.problem_details import ProblemDetails from criteo_api_retailmedia_v2023_07.model.promoted_product202110_list_request import PromotedProduct202110ListRequest from criteo_api_retailmedia_v2023_07.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2023_07.model.proposal_status_model import ProposalStatusModel +from criteo_api_retailmedia_v2023_07.model.proposal_status_model_resource import ProposalStatusModelResource +from criteo_api_retailmedia_v2023_07.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_v2023_07.model.put_campaign_v202301 import PutCampaignV202301 from criteo_api_retailmedia_v2023_07.model.report_outcome import ReportOutcome from criteo_api_retailmedia_v2023_07.model.resource_of_auction_line_item import ResourceOfAuctionLineItem @@ -133,24 +148,8 @@ from criteo_api_retailmedia_v2023_07.model.resource_of_preferred_line_item_update_model202110 import ResourceOfPreferredLineItemUpdateModel202110 from criteo_api_retailmedia_v2023_07.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 from criteo_api_retailmedia_v2023_07.model.resource_of_template import ResourceOfTemplate -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource +from criteo_api_retailmedia_v2023_07.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_07.model.review_state_model import ReviewStateModel from criteo_api_retailmedia_v2023_07.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1 from criteo_api_retailmedia_v2023_07.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource from criteo_api_retailmedia_v2023_07.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response @@ -171,7 +170,12 @@ from criteo_api_retailmedia_v2023_07.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2 from criteo_api_retailmedia_v2023_07.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 from criteo_api_retailmedia_v2023_07.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 +from criteo_api_retailmedia_v2023_07.model.rmca_common_problem import RmcaCommonProblem from criteo_api_retailmedia_v2023_07.model.section import Section +from criteo_api_retailmedia_v2023_07.model.set_bid_model import SetBidModel +from criteo_api_retailmedia_v2023_07.model.set_bids_model import SetBidsModel +from criteo_api_retailmedia_v2023_07.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2023_07.model.set_bids_model_resource import SetBidsModelResource from criteo_api_retailmedia_v2023_07.model.status_response import StatusResponse from criteo_api_retailmedia_v2023_07.model.status_response_resource import StatusResponseResource from criteo_api_retailmedia_v2023_07.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request diff --git a/sdks/retailmedia_2023-07/docs/AddRemoveKeywordModel.md b/sdks/retailmedia_2023-07/docs/AddRemoveKeywordModel.md new file mode 100644 index 00000000..8546f1f2 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/AddRemoveKeywordModel.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordModel + +A single keyword to be added or removed + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**is_deleted** | **bool, 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_2023-07/docs/AddRemoveKeywordsModel.md b/sdks/retailmedia_2023-07/docs/AddRemoveKeywordsModel.md new file mode 100644 index 00000000..27980d2b --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/AddRemoveKeywordsModel.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModel + +Data model containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[AddRemoveKeywordModel], none_type**](AddRemoveKeywordModel.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_2023-07/docs/AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2023-07/docs/AddRemoveKeywordsModelRequest.md new file mode 100644 index 00000000..577c720e --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/AddRemoveKeywordsModelRequest.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModelRequest + +Request object to add or remove keywords from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AddRemoveKeywordsModelResource**](AddRemoveKeywordsModelResource.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_2023-07/docs/AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2023-07/docs/AddRemoveKeywordsModelResource.md new file mode 100644 index 00000000..ad36e151 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/AddRemoveKeywordsModelResource.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordsModelResource + +Resource object containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**AddRemoveKeywordsModel**](AddRemoveKeywordsModel.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_2023-07/docs/AnalyticsApi.md b/sdks/retailmedia_2023-07/docs/AnalyticsApi.md index fcbe29bd..070eb175 100644 --- a/sdks/retailmedia_2023-07/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2023-07/docs/AnalyticsApi.md @@ -65,8 +65,8 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", @@ -178,8 +178,8 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", diff --git a/sdks/retailmedia_2023-07/docs/ApprovalStatusModel.md b/sdks/retailmedia_2023-07/docs/ApprovalStatusModel.md new file mode 100644 index 00000000..52ab7863 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/ApprovalStatusModel.md @@ -0,0 +1,12 @@ +# ApprovalStatusModel + +The status of a booking or runnable in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of a booking or runnable in the context of a line item. | must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] + +[[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_2023-07/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2023-07/docs/AsyncCampaignsReport.md index 21dd57bd..f4385127 100644 --- a/sdks/retailmedia_2023-07/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2023-07/docs/AsyncCampaignsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **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] -**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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-07/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2023-07/docs/AsyncLineItemsReport.md index ccb01090..eece64e3 100644 --- a/sdks/retailmedia_2023-07/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2023-07/docs/AsyncLineItemsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **end_date** | **datetime** | End date | **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-07/docs/CampaignApi.md b/sdks/retailmedia_2023-07/docs/CampaignApi.md index baf4b8ce..606f4335 100644 --- a/sdks/retailmedia_2023-07/docs/CampaignApi.md +++ b/sdks/retailmedia_2023-07/docs/CampaignApi.md @@ -69,11 +69,11 @@ Method | HTTP request | Description # **add_remove_keywords** -> RetailMediaExternalv1ResourceOutcome add_remove_keywords(id) +> ResourceOutcome add_remove_keywords(id) -Add or Remove keywords from the associated line item in bulk +Add or Remove keywords from the line item in bulk ### Example @@ -84,8 +84,8 @@ Add or Remove keywords from the associated line item in bulk import time import criteo_api_retailmedia_v2023_07 from criteo_api_retailmedia_v2023_07.api import campaign_api -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2023_07.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2023_07.model.resource_outcome import ResourceOutcome 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. @@ -114,22 +114,22 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_add_remove_keywords_model_request = RetailMediaExternalv1AddRemoveKeywordsModelRequest( - data=RetailMediaExternalv1AddRemoveKeywordsModelResource( + id = "id_example" # str | ID of the line item + add_remove_keywords_model_request = AddRemoveKeywordsModelRequest( + data=AddRemoveKeywordsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1AddRemoveKeywordsModel( + attributes=AddRemoveKeywordsModel( keywords=[ - RetailMediaExternalv1AddRemoveKeywordModel( + AddRemoveKeywordModel( phrase="phrase_example", - match_type="PositiveExactMatch", + match_type=MatchTypeModel("PositiveExactMatch"), is_deleted=True, ), ], ), ), - ) # RetailMediaExternalv1AddRemoveKeywordsModelRequest | Object containing keywords to be added or removed (optional) + ) # AddRemoveKeywordsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -141,7 +141,7 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.add_remove_keywords(id, retail_media_externalv1_add_remove_keywords_model_request=retail_media_externalv1_add_remove_keywords_model_request) + api_response = api_instance.add_remove_keywords(id, add_remove_keywords_model_request=add_remove_keywords_model_request) pprint(api_response) except criteo_api_retailmedia_v2023_07.ApiException as e: print("Exception when calling CampaignApi->add_remove_keywords: %s\n" % e) @@ -152,12 +152,12 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_add_remove_keywords_model_request** | [**RetailMediaExternalv1AddRemoveKeywordsModelRequest**](RetailMediaExternalv1AddRemoveKeywordsModelRequest.md)| Object containing keywords to be added or removed | [optional] + **id** | **str**| ID of the line item | + **add_remove_keywords_model_request** | [**AddRemoveKeywordsModelRequest**](AddRemoveKeywordsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -166,7 +166,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -263,7 +263,7 @@ 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) # **fetch_keywords** -> RetailMediaExternalv1KeywordsModelResponse fetch_keywords(id) +> KeywordsModelResponse fetch_keywords(id) @@ -278,7 +278,8 @@ Fetch keywords associated with the specified line item import time import criteo_api_retailmedia_v2023_07 from criteo_api_retailmedia_v2023_07.api import campaign_api -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse +from criteo_api_retailmedia_v2023_07.model.keywords_model_response import KeywordsModelResponse +from criteo_api_retailmedia_v2023_07.model.resource_outcome import ResourceOutcome 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. @@ -307,7 +308,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -322,11 +323,11 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1KeywordsModelResponse**](RetailMediaExternalv1KeywordsModelResponse.md) +[**KeywordsModelResponse**](KeywordsModelResponse.md) ### Authorization @@ -335,7 +336,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 @@ -348,11 +349,11 @@ 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) # **fetch_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse fetch_proposal(id) +> ProposalStatusModelResponse fetch_proposal(id) -Fetch the status of a proposal to modify a Preferred Deal Line Item. +Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. ### Example @@ -363,7 +364,8 @@ Fetch the status of a proposal to modify a Preferred Deal Line Item. import time import criteo_api_retailmedia_v2023_07 from criteo_api_retailmedia_v2023_07.api import campaign_api -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_v2023_07.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_v2023_07.model.resource_outcome import ResourceOutcome 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. @@ -392,7 +394,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -407,11 +409,11 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -420,7 +422,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 @@ -429,7 +431,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) @@ -6024,7 +6025,7 @@ 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) # **set_keyword_bids** -> RetailMediaExternalv1ResourceOutcome set_keyword_bids(id) +> ResourceOutcome set_keyword_bids(id) @@ -6039,8 +6040,8 @@ Set bid overrides for associated keywords to the given line item in bulk import time import criteo_api_retailmedia_v2023_07 from criteo_api_retailmedia_v2023_07.api import campaign_api -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_v2023_07.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2023_07.model.resource_outcome import ResourceOutcome 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. @@ -6069,21 +6070,21 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_set_bids_model_request = RetailMediaExternalv1SetBidsModelRequest( - data=RetailMediaExternalv1SetBidsModelResource( + id = "id_example" # str | ID of the line item + set_bids_model_request = SetBidsModelRequest( + data=SetBidsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1SetBidsModel( + attributes=SetBidsModel( keywords=[ - RetailMediaExternalv1SetBidModel( + SetBidModel( phrase="phrase_example", bid=3.14, ), ], ), ), - ) # RetailMediaExternalv1SetBidsModelRequest | Object containing a list of bid overrides for associated keywords (optional) + ) # SetBidsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -6095,7 +6096,7 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.set_keyword_bids(id, retail_media_externalv1_set_bids_model_request=retail_media_externalv1_set_bids_model_request) + api_response = api_instance.set_keyword_bids(id, set_bids_model_request=set_bids_model_request) pprint(api_response) except criteo_api_retailmedia_v2023_07.ApiException as e: print("Exception when calling CampaignApi->set_keyword_bids: %s\n" % e) @@ -6106,12 +6107,12 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_set_bids_model_request** | [**RetailMediaExternalv1SetBidsModelRequest**](RetailMediaExternalv1SetBidsModelRequest.md)| Object containing a list of bid overrides for associated keywords | [optional] + **id** | **str**| ID of the line item | + **set_bids_model_request** | [**SetBidsModelRequest**](SetBidsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -6120,7 +6121,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -6133,11 +6134,11 @@ 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) # **submit_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse submit_proposal(id) +> ProposalStatusModelResponse submit_proposal(id) -Submit a proposal to modify a Preferred Deal Line Item for review. +Only the components of the Line Item that are in a valid state will be reviewed. ### Example @@ -6148,7 +6149,8 @@ Submit a proposal to modify a Preferred Deal Line Item for review. import time import criteo_api_retailmedia_v2023_07 from criteo_api_retailmedia_v2023_07.api import campaign_api -from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_v2023_07.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_v2023_07.model.resource_outcome import ResourceOutcome 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. @@ -6177,7 +6179,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -6192,11 +6194,11 @@ with criteo_api_retailmedia_v2023_07.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -6205,7 +6207,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 @@ -6214,7 +6216,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) diff --git a/sdks/retailmedia_2023-07/docs/InputKeywordsModel.md b/sdks/retailmedia_2023-07/docs/InputKeywordsModel.md new file mode 100644 index 00000000..9a080793 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/InputKeywordsModel.md @@ -0,0 +1,14 @@ +# InputKeywordsModel + +The keywords to be added or removed from a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negative_broad** | **[str], none_type** | | [optional] +**negative_exact** | **[str], none_type** | | [optional] +**positive_exact** | **[str], 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_2023-07/docs/KeywordDataModel.md b/sdks/retailmedia_2023-07/docs/KeywordDataModel.md new file mode 100644 index 00000000..fca58d73 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/KeywordDataModel.md @@ -0,0 +1,17 @@ +# KeywordDataModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**review_state** | [**ReviewStateModel**](ReviewStateModel.md) | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**bid** | **float, none_type** | | [optional] +**input_keywords** | [**InputKeywordsModel**](InputKeywordsModel.md) | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2023-07/docs/KeywordsModel.md b/sdks/retailmedia_2023-07/docs/KeywordsModel.md new file mode 100644 index 00000000..d31dabad --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/KeywordsModel.md @@ -0,0 +1,13 @@ +# KeywordsModel + +The keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**{str: (KeywordDataModel,)}, none_type**](KeywordDataModel.md) | | [optional] +**rank** | **[str], 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_2023-07/docs/KeywordsModelResource.md b/sdks/retailmedia_2023-07/docs/KeywordsModelResource.md new file mode 100644 index 00000000..9a26bd3a --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/KeywordsModelResource.md @@ -0,0 +1,14 @@ +# KeywordsModelResource + +Resource object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**KeywordsModel**](KeywordsModel.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_2023-07/docs/KeywordsModelResponse.md b/sdks/retailmedia_2023-07/docs/KeywordsModelResponse.md new file mode 100644 index 00000000..2d24cc4e --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/KeywordsModelResponse.md @@ -0,0 +1,14 @@ +# KeywordsModelResponse + +Response object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**KeywordsModelResource**](KeywordsModelResource.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_2023-07/docs/MatchTypeModel.md b/sdks/retailmedia_2023-07/docs/MatchTypeModel.md new file mode 100644 index 00000000..9406306f --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/MatchTypeModel.md @@ -0,0 +1,12 @@ +# MatchTypeModel + +The match type of a keyword. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The match type of a keyword. | must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] + +[[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_2023-07/docs/NegotiationStateModel.md b/sdks/retailmedia_2023-07/docs/NegotiationStateModel.md new file mode 100644 index 00000000..e34ddbf4 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/NegotiationStateModel.md @@ -0,0 +1,12 @@ +# NegotiationStateModel + +The state of a negotiation in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a negotiation in the context of a line item. | must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] + +[[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_2023-07/docs/ProposalStatusModel.md b/sdks/retailmedia_2023-07/docs/ProposalStatusModel.md new file mode 100644 index 00000000..49d39c19 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/ProposalStatusModel.md @@ -0,0 +1,17 @@ +# ProposalStatusModel + +The state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negotiation_state** | [**NegotiationStateModel**](NegotiationStateModel.md) | | [optional] +**booking_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**runnable_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**comment** | **str, none_type** | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2023-07/docs/ProposalStatusModelResource.md b/sdks/retailmedia_2023-07/docs/ProposalStatusModelResource.md new file mode 100644 index 00000000..f89ca4eb --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/ProposalStatusModelResource.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResource + +Resource object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**ProposalStatusModel**](ProposalStatusModel.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_2023-07/docs/ProposalStatusModelResponse.md b/sdks/retailmedia_2023-07/docs/ProposalStatusModelResponse.md new file mode 100644 index 00000000..2e87ff0d --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/ProposalStatusModelResponse.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResponse + +Response object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**ProposalStatusModelResource**](ProposalStatusModelResource.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_2023-07/docs/ResourceOutcome.md b/sdks/retailmedia_2023-07/docs/ResourceOutcome.md new file mode 100644 index 00000000..3bf8a5e5 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/ResourceOutcome.md @@ -0,0 +1,13 @@ +# ResourceOutcome + +Outcome object containing errors and warnings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.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_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordModel.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordModel.md deleted file mode 100644 index 98c859cd..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordModel - -A single keyword to be added or removed - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**is_deleted** | **bool, 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_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md deleted file mode 100644 index 2d39bd84..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModel - -Data model containing keywords to be added or removed from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1AddRemoveKeywordModel], none_type**](RetailMediaExternalv1AddRemoveKeywordModel.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_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md deleted file mode 100644 index d623d5f5..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelRequest - -Request object to add or remove keywords from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1AddRemoveKeywordsModelResource**](RetailMediaExternalv1AddRemoveKeywordsModelResource.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_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md deleted file mode 100644 index 1abf3809..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelResource - -Resource wrapper the keyword add and remove datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1AddRemoveKeywordsModel**](RetailMediaExternalv1AddRemoveKeywordsModel.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_2023-07/docs/RetailMediaExternalv1InputKeywordsModel.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1InputKeywordsModel.md deleted file mode 100644 index 19807cea..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1InputKeywordsModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1InputKeywordsModel - -Input values associated with a keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negative_broad** | **[str], none_type** | | [optional] -**negative_exact** | **[str], none_type** | | [optional] -**positive_exact** | **[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_2023-07/docs/RetailMediaExternalv1KeywordDataModel.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1KeywordDataModel.md deleted file mode 100644 index d7326d7a..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1KeywordDataModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1KeywordDataModel - -Details for a specific keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**review_state** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**bid** | **float, none_type** | | [optional] -**input_keywords** | [**RetailMediaExternalv1InputKeywordsModel**](RetailMediaExternalv1InputKeywordsModel.md) | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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_2023-07/docs/RetailMediaExternalv1KeywordsModel.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1KeywordsModel.md deleted file mode 100644 index 105b25b5..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1KeywordsModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1KeywordsModel - -Datamodel representing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**RetailMediaExternalv1KeywordDataModel**](RetailMediaExternalv1KeywordDataModel.md) | | [optional] -**rank** | **[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_2023-07/docs/RetailMediaExternalv1KeywordsModelResource.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1KeywordsModelResource.md deleted file mode 100644 index 8aabe795..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1KeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResource - -Resource wrapper of associated keywords with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1KeywordsModel**](RetailMediaExternalv1KeywordsModel.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_2023-07/docs/RetailMediaExternalv1KeywordsModelResponse.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1KeywordsModelResponse.md deleted file mode 100644 index eb84587c..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1KeywordsModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResponse - -Response object containing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1KeywordsModelResource**](RetailMediaExternalv1KeywordsModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-07/docs/RetailMediaExternalv1ProblemDetails.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ProblemDetails.md deleted file mode 100644 index 32758436..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ProblemDetails.md +++ /dev/null @@ -1,21 +0,0 @@ -# RetailMediaExternalv1ProblemDetails - -Datamodel for common errors and warnings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**trace_identifier** | **str, none_type** | | [optional] -**code** | **str, none_type** | | [optional] -**source** | **{str: (str,)}, none_type** | | [optional] -**stack_trace** | **str, none_type** | | [optional] -**type** | **str, none_type** | | [optional] -**title** | **str, none_type** | | [optional] -**status** | **int, none_type** | | [optional] -**detail** | **str, none_type** | | [optional] -**instance** | **str, none_type** | | [optional] -**any string name** | **{str: (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_2023-07/docs/RetailMediaExternalv1ProposalStatusModel.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ProposalStatusModel.md deleted file mode 100644 index 93cf4401..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ProposalStatusModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModel - -The proposal status includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negotiation_state** | **str** | | -**booking_status** | **str** | | -**runnable_status** | **str** | | -**comment** | **str, none_type** | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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_2023-07/docs/RetailMediaExternalv1ProposalStatusModelResource.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ProposalStatusModelResource.md deleted file mode 100644 index 4c5ebc52..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ProposalStatusModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResource - -Wrapper for the proposal status - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1ProposalStatusModel**](RetailMediaExternalv1ProposalStatusModel.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_2023-07/docs/RetailMediaExternalv1ProposalStatusModelResponse.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ProposalStatusModelResponse.md deleted file mode 100644 index 2550a175..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ProposalStatusModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResponse - -Wrapper for the proposal status resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1ProposalStatusModelResource**](RetailMediaExternalv1ProposalStatusModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-07/docs/RetailMediaExternalv1ResourceOutcome.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ResourceOutcome.md deleted file mode 100644 index 7b1c09f1..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1ResourceOutcome.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1ResourceOutcome - -A response object containing errors or warnings if required - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-07/docs/RetailMediaExternalv1SetBidModel.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidModel.md deleted file mode 100644 index 978f8b12..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1SetBidModel - -A single keyword and associated bid override - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**bid** | **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/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidsModel.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidsModel.md deleted file mode 100644 index 2b1359ff..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModel - -Data model containing keywords and bid overrides to associate to them - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1SetBidModel], none_type**](RetailMediaExternalv1SetBidModel.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_2023-07/docs/RetailMediaExternalv1SetBidsModelRequest.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidsModelRequest.md deleted file mode 100644 index e40b943e..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModelRequest - -Request to set bid overrides for specified keywords on a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1SetBidsModelResource**](RetailMediaExternalv1SetBidsModelResource.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_2023-07/docs/RetailMediaExternalv1SetBidsModelResource.md b/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidsModelResource.md deleted file mode 100644 index 4a4e3082..00000000 --- a/sdks/retailmedia_2023-07/docs/RetailMediaExternalv1SetBidsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1SetBidsModelResource - -Wrapper of the Set Bids datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1SetBidsModel**](RetailMediaExternalv1SetBidsModel.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_2023-07/docs/ReviewStateModel.md b/sdks/retailmedia_2023-07/docs/ReviewStateModel.md new file mode 100644 index 00000000..e905d467 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/ReviewStateModel.md @@ -0,0 +1,12 @@ +# ReviewStateModel + +The state of a keyword in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a keyword in the context of a line item. | must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] + +[[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_2023-07/docs/RmLegacyAudienceGetEntityV1ListResponse.md b/sdks/retailmedia_2023-07/docs/RmLegacyAudienceGetEntityV1ListResponse.md index a086fc52..177bd87b 100644 --- a/sdks/retailmedia_2023-07/docs/RmLegacyAudienceGetEntityV1ListResponse.md +++ b/sdks/retailmedia_2023-07/docs/RmLegacyAudienceGetEntityV1ListResponse.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1ListResponse -List of responses +A top-level object that encapsulates a Criteo API response for several entities and metadata ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2023-07/docs/RmLegacyAudienceGetEntityV1Resource.md b/sdks/retailmedia_2023-07/docs/RmLegacyAudienceGetEntityV1Resource.md index 7d4b9798..dad0c799 100644 --- a/sdks/retailmedia_2023-07/docs/RmLegacyAudienceGetEntityV1Resource.md +++ b/sdks/retailmedia_2023-07/docs/RmLegacyAudienceGetEntityV1Resource.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1Resource -Legacy resource +A class that represents a domain entity exposed by an API ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2023-07/docs/RmcaCommonProblem.md b/sdks/retailmedia_2023-07/docs/RmcaCommonProblem.md new file mode 100644 index 00000000..fba2c66b --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/RmcaCommonProblem.md @@ -0,0 +1,21 @@ +# RmcaCommonProblem + +Common problem object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trace_id** | **str, none_type** | The request correlation ID this problem comes from. | [optional] +**type** | **str, none_type** | The problem's category. | [optional] +**code** | **str, none_type** | A machine-readable error code, expressed as a string value. | [optional] +**instance** | **str, none_type** | A URI that identifies the specific occurrence of the problem. | [optional] +**title** | **str, none_type** | A short human-readable description of the problem type | [optional] +**detail** | **str, none_type** | A human-readable explanation specific to this occurrence of the problem | [optional] +**source** | **{str: (str,)}, none_type** | A machine-readable structure to reference to the exact location(s) causing the error(s) | [optional] +**stack_trace** | **str, none_type** | | [optional] +**status** | **int, none_type** | The problem's HTTP Status code. | [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_2023-07/docs/SetBidModel.md b/sdks/retailmedia_2023-07/docs/SetBidModel.md new file mode 100644 index 00000000..979e91d0 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/SetBidModel.md @@ -0,0 +1,13 @@ +# SetBidModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**bid** | **float, 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_2023-07/docs/SetBidsModel.md b/sdks/retailmedia_2023-07/docs/SetBidsModel.md new file mode 100644 index 00000000..e5e1b0c8 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/SetBidsModel.md @@ -0,0 +1,12 @@ +# SetBidsModel + +Data model containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[SetBidModel], none_type**](SetBidModel.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_2023-07/docs/SetBidsModelRequest.md b/sdks/retailmedia_2023-07/docs/SetBidsModelRequest.md new file mode 100644 index 00000000..9c19c9c2 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/SetBidsModelRequest.md @@ -0,0 +1,12 @@ +# SetBidsModelRequest + +Request object to set bid overrides for keywords associated with a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SetBidsModelResource**](SetBidsModelResource.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_2023-07/docs/SetBidsModelResource.md b/sdks/retailmedia_2023-07/docs/SetBidsModelResource.md new file mode 100644 index 00000000..6e436263 --- /dev/null +++ b/sdks/retailmedia_2023-07/docs/SetBidsModelResource.md @@ -0,0 +1,14 @@ +# SetBidsModelResource + +Resource object containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**SetBidsModel**](SetBidsModel.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_2023-07/setup.py b/sdks/retailmedia_2023-07/setup.py index fbb7aa1d..6a17919d 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.240404" +VERSION = "2023.07.0.240515" # 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.240404 +pip install criteo-api-retailmedia-sdk==2023.07.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-10/.openapi-generator/FILES b/sdks/retailmedia_2023-10/.openapi-generator/FILES index 731311b3..509c8a37 100644 --- a/sdks/retailmedia_2023-10/.openapi-generator/FILES +++ b/sdks/retailmedia_2023-10/.openapi-generator/FILES @@ -20,12 +20,17 @@ criteo_api_retailmedia_v2023_10/exceptions.py criteo_api_retailmedia_v2023_10/flow_constants.py criteo_api_retailmedia_v2023_10/model/__init__.py criteo_api_retailmedia_v2023_10/model/add_funds_to_balance_request.py +criteo_api_retailmedia_v2023_10/model/add_remove_keyword_model.py +criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model.py +criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_request.py +criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_resource.py criteo_api_retailmedia_v2023_10/model/add_to_basket_ids_update_model202110_request.py criteo_api_retailmedia_v2023_10/model/add_to_basket_target202110_request.py criteo_api_retailmedia_v2023_10/model/add_to_basket_target202110_response.py criteo_api_retailmedia_v2023_10/model/application_summary_model.py criteo_api_retailmedia_v2023_10/model/application_summary_model_resource.py criteo_api_retailmedia_v2023_10/model/application_summary_model_response.py +criteo_api_retailmedia_v2023_10/model/approval_status_model.py criteo_api_retailmedia_v2023_10/model/asset.py criteo_api_retailmedia_v2023_10/model/asset_resource.py criteo_api_retailmedia_v2023_10/model/asset_response.py @@ -105,6 +110,7 @@ criteo_api_retailmedia_v2023_10/model/external_update_balance_model.py criteo_api_retailmedia_v2023_10/model/files_variable_value.py criteo_api_retailmedia_v2023_10/model/files_variables_specification.py criteo_api_retailmedia_v2023_10/model/hyperlink_variable_value.py +criteo_api_retailmedia_v2023_10/model/input_keywords_model.py criteo_api_retailmedia_v2023_10/model/input_resource_of_auction_line_item_create_model.py criteo_api_retailmedia_v2023_10/model/input_resource_of_preferred_line_item_create_model202110.py criteo_api_retailmedia_v2023_10/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py @@ -124,11 +130,17 @@ criteo_api_retailmedia_v2023_10/model/json_api_request_of_catalog_request.py criteo_api_retailmedia_v2023_10/model/json_api_single_response_of_campaign_v202301.py criteo_api_retailmedia_v2023_10/model/json_api_single_response_of_catalog_status.py criteo_api_retailmedia_v2023_10/model/json_api_single_response_of_line_item_bid_multipliers.py +criteo_api_retailmedia_v2023_10/model/keyword_data_model.py criteo_api_retailmedia_v2023_10/model/keyword_target202110_request.py criteo_api_retailmedia_v2023_10/model/keyword_target202110_response.py +criteo_api_retailmedia_v2023_10/model/keywords_model.py +criteo_api_retailmedia_v2023_10/model/keywords_model_resource.py +criteo_api_retailmedia_v2023_10/model/keywords_model_response.py criteo_api_retailmedia_v2023_10/model/line_item_bid_multipliers.py criteo_api_retailmedia_v2023_10/model/line_item_bid_multipliers_request.py criteo_api_retailmedia_v2023_10/model/line_item_bid_multipliers_response.py +criteo_api_retailmedia_v2023_10/model/match_type_model.py +criteo_api_retailmedia_v2023_10/model/negotiation_state_model.py criteo_api_retailmedia_v2023_10/model/page_metadata.py criteo_api_retailmedia_v2023_10/model/page_type_environment.py criteo_api_retailmedia_v2023_10/model/post_campaign_v202301.py @@ -139,6 +151,9 @@ criteo_api_retailmedia_v2023_10/model/preferred_line_item_update_model202110_req criteo_api_retailmedia_v2023_10/model/problem_details.py criteo_api_retailmedia_v2023_10/model/promoted_product202110_list_request.py criteo_api_retailmedia_v2023_10/model/promoted_product202110_paged_list_response.py +criteo_api_retailmedia_v2023_10/model/proposal_status_model.py +criteo_api_retailmedia_v2023_10/model/proposal_status_model_resource.py +criteo_api_retailmedia_v2023_10/model/proposal_status_model_response.py criteo_api_retailmedia_v2023_10/model/put_campaign_v202301.py criteo_api_retailmedia_v2023_10/model/report_outcome.py criteo_api_retailmedia_v2023_10/model/resource_of_add_funds_to_balance.py @@ -158,24 +173,8 @@ criteo_api_retailmedia_v2023_10/model/resource_of_preferred_line_item_update_mod criteo_api_retailmedia_v2023_10/model/resource_of_promoted_product202110.py criteo_api_retailmedia_v2023_10/model/resource_of_template.py criteo_api_retailmedia_v2023_10/model/resource_of_update_balance_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keyword_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model_request.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model_resource.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_input_keywords_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keyword_data_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_resource.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_response.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_problem_details.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_resource.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_response.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_resource_outcome.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bid_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model_request.py -criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model_resource.py +criteo_api_retailmedia_v2023_10/model/resource_outcome.py +criteo_api_retailmedia_v2023_10/model/review_state_model.py criteo_api_retailmedia_v2023_10/model/rm_legacy_audience_create_entity_v1.py criteo_api_retailmedia_v2023_10/model/rm_legacy_audience_create_entity_v1_resource.py criteo_api_retailmedia_v2023_10/model/rm_legacy_audience_create_entity_v1_response.py @@ -196,7 +195,12 @@ criteo_api_retailmedia_v2023_10/model/rm_legacy_segment_customer_list.py criteo_api_retailmedia_v2023_10/model/rm_legacy_segment_user_behavior_create_v2.py criteo_api_retailmedia_v2023_10/model/rm_legacy_segment_user_behavior_v1.py criteo_api_retailmedia_v2023_10/model/rm_legacy_segment_user_behavior_v2.py +criteo_api_retailmedia_v2023_10/model/rmca_common_problem.py criteo_api_retailmedia_v2023_10/model/section.py +criteo_api_retailmedia_v2023_10/model/set_bid_model.py +criteo_api_retailmedia_v2023_10/model/set_bids_model.py +criteo_api_retailmedia_v2023_10/model/set_bids_model_request.py +criteo_api_retailmedia_v2023_10/model/set_bids_model_resource.py criteo_api_retailmedia_v2023_10/model/status_response.py criteo_api_retailmedia_v2023_10/model/status_response_resource.py criteo_api_retailmedia_v2023_10/model/store_ids_update_model202110_request.py @@ -221,6 +225,10 @@ criteo_api_retailmedia_v2023_10/model_utils.py criteo_api_retailmedia_v2023_10/models/__init__.py criteo_api_retailmedia_v2023_10/rest.py docs/AddFundsToBalanceRequest.md +docs/AddRemoveKeywordModel.md +docs/AddRemoveKeywordsModel.md +docs/AddRemoveKeywordsModelRequest.md +docs/AddRemoveKeywordsModelResource.md docs/AddToBasketIdsUpdateModel202110Request.md docs/AddToBasketTarget202110Request.md docs/AddToBasketTarget202110Response.md @@ -228,6 +236,7 @@ docs/AnalyticsApi.md docs/ApplicationSummaryModel.md docs/ApplicationSummaryModelResource.md docs/ApplicationSummaryModelResponse.md +docs/ApprovalStatusModel.md docs/Asset.md docs/AssetResource.md docs/AssetResponse.md @@ -310,6 +319,7 @@ docs/FilesVariableValue.md docs/FilesVariablesSpecification.md docs/GatewayApi.md docs/HyperlinkVariableValue.md +docs/InputKeywordsModel.md docs/InputResourceOfAuctionLineItemCreateModel.md docs/InputResourceOfPreferredLineItemCreateModel202110.md docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md @@ -329,11 +339,17 @@ docs/JsonApiRequestOfCatalogRequest.md docs/JsonApiSingleResponseOfCampaignV202301.md docs/JsonApiSingleResponseOfCatalogStatus.md docs/JsonApiSingleResponseOfLineItemBidMultipliers.md +docs/KeywordDataModel.md docs/KeywordTarget202110Request.md docs/KeywordTarget202110Response.md +docs/KeywordsModel.md +docs/KeywordsModelResource.md +docs/KeywordsModelResponse.md docs/LineItemBidMultipliers.md docs/LineItemBidMultipliersRequest.md docs/LineItemBidMultipliersResponse.md +docs/MatchTypeModel.md +docs/NegotiationStateModel.md docs/PageMetadata.md docs/PageTypeEnvironment.md docs/PostCampaignV202301.md @@ -344,6 +360,9 @@ docs/PreferredLineItemUpdateModel202110Request.md docs/ProblemDetails.md docs/PromotedProduct202110ListRequest.md docs/PromotedProduct202110PagedListResponse.md +docs/ProposalStatusModel.md +docs/ProposalStatusModelResource.md +docs/ProposalStatusModelResponse.md docs/PutCampaignV202301.md docs/ReportOutcome.md docs/ResourceOfAddFundsToBalance.md @@ -363,24 +382,8 @@ docs/ResourceOfPreferredLineItemUpdateModel202110.md docs/ResourceOfPromotedProduct202110.md docs/ResourceOfTemplate.md docs/ResourceOfUpdateBalanceModel.md -docs/RetailMediaExternalv1AddRemoveKeywordModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md -docs/RetailMediaExternalv1InputKeywordsModel.md -docs/RetailMediaExternalv1KeywordDataModel.md -docs/RetailMediaExternalv1KeywordsModel.md -docs/RetailMediaExternalv1KeywordsModelResource.md -docs/RetailMediaExternalv1KeywordsModelResponse.md -docs/RetailMediaExternalv1ProblemDetails.md -docs/RetailMediaExternalv1ProposalStatusModel.md -docs/RetailMediaExternalv1ProposalStatusModelResource.md -docs/RetailMediaExternalv1ProposalStatusModelResponse.md -docs/RetailMediaExternalv1ResourceOutcome.md -docs/RetailMediaExternalv1SetBidModel.md -docs/RetailMediaExternalv1SetBidsModel.md -docs/RetailMediaExternalv1SetBidsModelRequest.md -docs/RetailMediaExternalv1SetBidsModelResource.md +docs/ResourceOutcome.md +docs/ReviewStateModel.md docs/RmLegacyAudienceCreateEntityV1.md docs/RmLegacyAudienceCreateEntityV1Resource.md docs/RmLegacyAudienceCreateEntityV1Response.md @@ -401,7 +404,12 @@ docs/RmLegacySegmentCustomerList.md docs/RmLegacySegmentUserBehaviorCreateV2.md docs/RmLegacySegmentUserBehaviorV1.md docs/RmLegacySegmentUserBehaviorV2.md +docs/RmcaCommonProblem.md docs/Section.md +docs/SetBidModel.md +docs/SetBidsModel.md +docs/SetBidsModelRequest.md +docs/SetBidsModelResource.md docs/StatusResponse.md docs/StatusResponseResource.md docs/StoreIdsUpdateModel202110Request.md diff --git a/sdks/retailmedia_2023-10/README.md b/sdks/retailmedia_2023-10/README.md index 1cbb2672..4fd4e544 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.240404 +- Package version: 2023.10.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2023.10.0.240404 +pip install criteo-api-retailmedia-sdk==2023.10.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python @@ -61,12 +61,17 @@ Class | Method | HTTP request | Description ## Documentation For Models - [AddFundsToBalanceRequest](docs/AddFundsToBalanceRequest.md) + - [AddRemoveKeywordModel](docs/AddRemoveKeywordModel.md) + - [AddRemoveKeywordsModel](docs/AddRemoveKeywordsModel.md) + - [AddRemoveKeywordsModelRequest](docs/AddRemoveKeywordsModelRequest.md) + - [AddRemoveKeywordsModelResource](docs/AddRemoveKeywordsModelResource.md) - [AddToBasketIdsUpdateModel202110Request](docs/AddToBasketIdsUpdateModel202110Request.md) - [AddToBasketTarget202110Request](docs/AddToBasketTarget202110Request.md) - [AddToBasketTarget202110Response](docs/AddToBasketTarget202110Response.md) - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) + - [ApprovalStatusModel](docs/ApprovalStatusModel.md) - [Asset](docs/Asset.md) - [AssetResource](docs/AssetResource.md) - [AssetResponse](docs/AssetResponse.md) @@ -146,6 +151,7 @@ Class | Method | HTTP request | Description - [FilesVariableValue](docs/FilesVariableValue.md) - [FilesVariablesSpecification](docs/FilesVariablesSpecification.md) - [HyperlinkVariableValue](docs/HyperlinkVariableValue.md) + - [InputKeywordsModel](docs/InputKeywordsModel.md) - [InputResourceOfAuctionLineItemCreateModel](docs/InputResourceOfAuctionLineItemCreateModel.md) - [InputResourceOfPreferredLineItemCreateModel202110](docs/InputResourceOfPreferredLineItemCreateModel202110.md) - [JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301](docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md) @@ -165,11 +171,17 @@ Class | Method | HTTP request | Description - [JsonApiSingleResponseOfCampaignV202301](docs/JsonApiSingleResponseOfCampaignV202301.md) - [JsonApiSingleResponseOfCatalogStatus](docs/JsonApiSingleResponseOfCatalogStatus.md) - [JsonApiSingleResponseOfLineItemBidMultipliers](docs/JsonApiSingleResponseOfLineItemBidMultipliers.md) + - [KeywordDataModel](docs/KeywordDataModel.md) - [KeywordTarget202110Request](docs/KeywordTarget202110Request.md) - [KeywordTarget202110Response](docs/KeywordTarget202110Response.md) + - [KeywordsModel](docs/KeywordsModel.md) + - [KeywordsModelResource](docs/KeywordsModelResource.md) + - [KeywordsModelResponse](docs/KeywordsModelResponse.md) - [LineItemBidMultipliers](docs/LineItemBidMultipliers.md) - [LineItemBidMultipliersRequest](docs/LineItemBidMultipliersRequest.md) - [LineItemBidMultipliersResponse](docs/LineItemBidMultipliersResponse.md) + - [MatchTypeModel](docs/MatchTypeModel.md) + - [NegotiationStateModel](docs/NegotiationStateModel.md) - [PageMetadata](docs/PageMetadata.md) - [PageTypeEnvironment](docs/PageTypeEnvironment.md) - [PostCampaignV202301](docs/PostCampaignV202301.md) @@ -180,6 +192,9 @@ Class | Method | HTTP request | Description - [ProblemDetails](docs/ProblemDetails.md) - [PromotedProduct202110ListRequest](docs/PromotedProduct202110ListRequest.md) - [PromotedProduct202110PagedListResponse](docs/PromotedProduct202110PagedListResponse.md) + - [ProposalStatusModel](docs/ProposalStatusModel.md) + - [ProposalStatusModelResource](docs/ProposalStatusModelResource.md) + - [ProposalStatusModelResponse](docs/ProposalStatusModelResponse.md) - [PutCampaignV202301](docs/PutCampaignV202301.md) - [ReportOutcome](docs/ReportOutcome.md) - [ResourceOfAddFundsToBalance](docs/ResourceOfAddFundsToBalance.md) @@ -199,24 +214,8 @@ Class | Method | HTTP request | Description - [ResourceOfPromotedProduct202110](docs/ResourceOfPromotedProduct202110.md) - [ResourceOfTemplate](docs/ResourceOfTemplate.md) - [ResourceOfUpdateBalanceModel](docs/ResourceOfUpdateBalanceModel.md) - - [RetailMediaExternalv1AddRemoveKeywordModel](docs/RetailMediaExternalv1AddRemoveKeywordModel.md) - - [RetailMediaExternalv1AddRemoveKeywordsModel](docs/RetailMediaExternalv1AddRemoveKeywordsModel.md) - - [RetailMediaExternalv1AddRemoveKeywordsModelRequest](docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md) - - [RetailMediaExternalv1AddRemoveKeywordsModelResource](docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md) - - [RetailMediaExternalv1InputKeywordsModel](docs/RetailMediaExternalv1InputKeywordsModel.md) - - [RetailMediaExternalv1KeywordDataModel](docs/RetailMediaExternalv1KeywordDataModel.md) - - [RetailMediaExternalv1KeywordsModel](docs/RetailMediaExternalv1KeywordsModel.md) - - [RetailMediaExternalv1KeywordsModelResource](docs/RetailMediaExternalv1KeywordsModelResource.md) - - [RetailMediaExternalv1KeywordsModelResponse](docs/RetailMediaExternalv1KeywordsModelResponse.md) - - [RetailMediaExternalv1ProblemDetails](docs/RetailMediaExternalv1ProblemDetails.md) - - [RetailMediaExternalv1ProposalStatusModel](docs/RetailMediaExternalv1ProposalStatusModel.md) - - [RetailMediaExternalv1ProposalStatusModelResource](docs/RetailMediaExternalv1ProposalStatusModelResource.md) - - [RetailMediaExternalv1ProposalStatusModelResponse](docs/RetailMediaExternalv1ProposalStatusModelResponse.md) - - [RetailMediaExternalv1ResourceOutcome](docs/RetailMediaExternalv1ResourceOutcome.md) - - [RetailMediaExternalv1SetBidModel](docs/RetailMediaExternalv1SetBidModel.md) - - [RetailMediaExternalv1SetBidsModel](docs/RetailMediaExternalv1SetBidsModel.md) - - [RetailMediaExternalv1SetBidsModelRequest](docs/RetailMediaExternalv1SetBidsModelRequest.md) - - [RetailMediaExternalv1SetBidsModelResource](docs/RetailMediaExternalv1SetBidsModelResource.md) + - [ResourceOutcome](docs/ResourceOutcome.md) + - [ReviewStateModel](docs/ReviewStateModel.md) - [RmLegacyAudienceCreateEntityV1](docs/RmLegacyAudienceCreateEntityV1.md) - [RmLegacyAudienceCreateEntityV1Resource](docs/RmLegacyAudienceCreateEntityV1Resource.md) - [RmLegacyAudienceCreateEntityV1Response](docs/RmLegacyAudienceCreateEntityV1Response.md) @@ -237,7 +236,12 @@ Class | Method | HTTP request | Description - [RmLegacySegmentUserBehaviorCreateV2](docs/RmLegacySegmentUserBehaviorCreateV2.md) - [RmLegacySegmentUserBehaviorV1](docs/RmLegacySegmentUserBehaviorV1.md) - [RmLegacySegmentUserBehaviorV2](docs/RmLegacySegmentUserBehaviorV2.md) + - [RmcaCommonProblem](docs/RmcaCommonProblem.md) - [Section](docs/Section.md) + - [SetBidModel](docs/SetBidModel.md) + - [SetBidsModel](docs/SetBidsModel.md) + - [SetBidsModelRequest](docs/SetBidsModelRequest.md) + - [SetBidsModelResource](docs/SetBidsModelResource.md) - [StatusResponse](docs/StatusResponse.md) - [StatusResponseResource](docs/StatusResponseResource.md) - [StoreIdsUpdateModel202110Request](docs/StoreIdsUpdateModel202110Request.md) 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 7d0d9bd1..2b7fd280 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.240404" +__version__ = "2023.10.0.240515" # 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/campaign_api.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/api/campaign_api.py index 635530aa..6c0403cf 100644 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/api/campaign_api.py +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/api/campaign_api.py @@ -22,6 +22,7 @@ validate_and_convert_types ) from criteo_api_retailmedia_v2023_10.model.add_funds_to_balance_request import AddFundsToBalanceRequest +from criteo_api_retailmedia_v2023_10.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest from criteo_api_retailmedia_v2023_10.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_10.model.add_to_basket_target202110_request import AddToBasketTarget202110Request from criteo_api_retailmedia_v2023_10.model.add_to_basket_target202110_response import AddToBasketTarget202110Response @@ -59,6 +60,7 @@ from criteo_api_retailmedia_v2023_10.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers from criteo_api_retailmedia_v2023_10.model.keyword_target202110_request import KeywordTarget202110Request from criteo_api_retailmedia_v2023_10.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2023_10.model.keywords_model_response import KeywordsModelResponse from criteo_api_retailmedia_v2023_10.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_v2023_10.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse from criteo_api_retailmedia_v2023_10.model.post_campaign_v202301 import PostCampaignV202301 @@ -68,12 +70,10 @@ from criteo_api_retailmedia_v2023_10.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request from criteo_api_retailmedia_v2023_10.model.promoted_product202110_list_request import PromotedProduct202110ListRequest from criteo_api_retailmedia_v2023_10.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2023_10.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_v2023_10.model.put_campaign_v202301 import PutCampaignV202301 -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_v2023_10.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.set_bids_model_request import SetBidsModelRequest from criteo_api_retailmedia_v2023_10.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_10.model.store_target202110_request import StoreTarget202110Request from criteo_api_retailmedia_v2023_10.model.store_target202110_response import StoreTarget202110Response @@ -95,7 +95,7 @@ def __init__(self, api_client=None): self.api_client = api_client self.add_remove_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -108,7 +108,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_add_remove_keywords_model_request', + 'add_remove_keywords_model_request', ], 'required': [ 'id', @@ -128,24 +128,22 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_add_remove_keywords_model_request': - (RetailMediaExternalv1AddRemoveKeywordsModelRequest,), + 'add_remove_keywords_model_request': + (AddRemoveKeywordsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_add_remove_keywords_model_request': 'body', + 'add_remove_keywords_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [ 'application/json' @@ -211,7 +209,7 @@ def __init__(self, api_client=None): ) self.fetch_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1KeywordsModelResponse,), + 'response_type': (KeywordsModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -255,9 +253,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -265,7 +261,7 @@ def __init__(self, api_client=None): ) self.fetch_proposal_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -309,9 +305,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -3922,7 +3916,7 @@ def __init__(self, api_client=None): ) self.set_keyword_bids_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -3935,7 +3929,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_set_bids_model_request', + 'set_bids_model_request', ], 'required': [ 'id', @@ -3955,24 +3949,22 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_set_bids_model_request': - (RetailMediaExternalv1SetBidsModelRequest,), + 'set_bids_model_request': + (SetBidsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_set_bids_model_request': 'body', + 'set_bids_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [ 'application/json' @@ -3982,7 +3974,7 @@ def __init__(self, api_client=None): ) self.submit_proposal_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -4026,9 +4018,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -4042,7 +4032,7 @@ def add_remove_keywords( ): """add_remove_keywords # noqa: E501 - Add or Remove keywords from the associated line item in bulk # noqa: E501 + Add or Remove keywords from the line item in bulk # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -4050,10 +4040,10 @@ def add_remove_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_add_remove_keywords_model_request (RetailMediaExternalv1AddRemoveKeywordsModelRequest): Object containing keywords to be added or removed. [optional] + add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [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 @@ -4086,7 +4076,7 @@ def add_remove_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -4217,7 +4207,7 @@ def fetch_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -4252,7 +4242,7 @@ def fetch_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1KeywordsModelResponse + KeywordsModelResponse If the method is called asynchronously, returns the request thread. """ @@ -4292,7 +4282,7 @@ def fetch_proposal( ): """fetch_proposal # noqa: E501 - Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501 + Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -4300,7 +4290,7 @@ def fetch_proposal( >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -4335,7 +4325,7 @@ def fetch_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ @@ -9532,10 +9522,10 @@ def set_keyword_bids( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_set_bids_model_request (RetailMediaExternalv1SetBidsModelRequest): Object containing a list of bid overrides for associated keywords. [optional] + set_bids_model_request (SetBidsModelRequest): [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 @@ -9568,7 +9558,7 @@ def set_keyword_bids( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -9608,7 +9598,7 @@ def submit_proposal( ): """submit_proposal # noqa: E501 - Submit a proposal to modify a Preferred Deal Line Item for review. # noqa: E501 + Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -9616,7 +9606,7 @@ def submit_proposal( >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -9651,7 +9641,7 @@ def submit_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ 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 7f7e16a6..38da6915 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.240404/python' + self.user_agent = 'OpenAPI-Generator/2023.10.0.240515/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 c7c639d0..512afb6a 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.240404".\ + "SDK Package Version: 2023.10.0.240515".\ 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/add_remove_keyword_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keyword_model.py new file mode 100644 index 00000000..5bdec5da --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keyword_model.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.match_type_model import MatchTypeModel + globals()['MatchTypeModel'] = MatchTypeModel + + +class AddRemoveKeywordModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'is_deleted': (bool, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'is_deleted': 'isDeleted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model.py new file mode 100644 index 00000000..220a1994 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.add_remove_keyword_model import AddRemoveKeywordModel + globals()['AddRemoveKeywordModel'] = AddRemoveKeywordModel + + +class AddRemoveKeywordsModel(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 { + 'keywords': ([AddRemoveKeywordModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_request.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_request.py new file mode 100644 index 00000000..129c8be8 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource + globals()['AddRemoveKeywordsModelResource'] = AddRemoveKeywordsModelResource + + +class AddRemoveKeywordsModelRequest(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': (AddRemoveKeywordsModelResource,), # 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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_resource.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_resource.py new file mode 100644 index 00000000..fa7081aa --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.add_remove_keywords_model import AddRemoveKeywordsModel + globals()['AddRemoveKeywordsModel'] = AddRemoveKeywordsModel + + +class AddRemoveKeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (AddRemoveKeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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_2023-10/criteo_api_retailmedia_v2023_10/model/approval_status_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/approval_status_model.py new file mode 100644 index 00000000..e960a449 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/approval_status_model.py @@ -0,0 +1,292 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + + +class ApprovalStatusModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'NOTSUBMITTED': "NotSubmitted", + 'SUBMITTED': "Submitted", + 'REJECTED': "Rejected", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return 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 d5318b17..f4249d4f 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 @@ -57,11 +57,13 @@ class AsyncCampaignsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncCampaignsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncCampaignsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncCampaignsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 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 10a07c51..122aa999 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 @@ -57,11 +57,13 @@ class AsyncLineItemsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncLineItemsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncLineItemsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncLineItemsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 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 ea3afac0..2188b17c 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,6 +68,26 @@ class AsyncRevenueReport(ModelNormal): 'AUCTION': "auction", 'PREFERRED': "preferred", }, + ('sold_by',): { + 'None': None, + 'DIRECTSOLD': "directSold", + 'INDIRECTSOLD': "indirectSold", + 'PRIVATEMARKET': "privateMarket", + }, + ('buy_type',): { + 'None': None, + 'AUCTION': "auction", + 'PREFERREDDEALS': "preferredDeals", + 'SPONSORSHIP': "sponsorship", + }, + ('sku_relations',): { + 'None': None, + 'SAMESKU': "sameSku", + 'SAMEPARENTSKU': "sameParentSku", + 'SAMECATEGORY': "sameCategory", + 'SAMEBRAND': "sameBrand", + 'SAMESELLER': "sameSeller", + }, ('format',): { 'None': None, 'JSON': "json", @@ -75,72 +95,123 @@ class AsyncRevenueReport(ModelNormal): 'JSON-NEWLINE': "json-newline", 'CSV': "csv", }, - ('sold_by',): { + ('campaign_type',): { 'None': None, - 'DIRECTSOLD': "directSold", - 'INDIRECTSOLD': "indirectSold", - 'PRIVATEMARKET': "privateMarket", + 'ALL': "all", + 'SPONSOREDPRODUCTS': "sponsoredProducts", + 'ONSITEDISPLAYS': "onSiteDisplays", }, - ('campaign_sub_type',): { + ('sales_channel',): { 'None': None, - 'AUCTIONANDPREFERRED': "auctionAndPreferred", - 'LOCKOUT': "lockout", + 'ALL': "all", + 'OFFLINE': "offline", + 'ONLINE': "online", }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + '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, 'DATE': "date", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", + 'HOUR': "hour", + 'PARENTACCOUNT': "parentAccount", 'ACCOUNTID': "accountId", 'ACCOUNTNAME': "accountName", - 'ENVIRONMENT': "environment", - 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ACCOUNTTYPENAME': "accountTypeName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'CAMPAIGNSTARTDATE': "campaignStartDate", + 'CAMPAIGNENDDATE': "campaignEndDate", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'LINEITEMSTARTDATE': "lineItemStartDate", + 'LINEITEMENDDATE': "lineItemEndDate", + 'LINEITEMSTATUS': "lineItemStatus", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", 'BRANDID': "brandId", 'BRANDNAME': "brandName", + 'PLACEMENTID': "placementId", + 'PLACEMENTNAME': "placementName", 'PAGETYPENAME': "pageTypeName", + 'ENVIRONMENT': "environment", + 'PAGECATEGORY': "pageCategory", + 'ADVPRODUCTID': "advProductId", 'ADVPRODUCTNAME': "advProductName", 'ADVPRODUCTGTIN': "advProductGtin", 'ADVPRODUCTMPN': "advProductMpn", - 'ADVPRODUCTID': "advProductId", + 'SOLDBY': "soldBy", + 'SALECHANNEL': "saleChannel", + 'ATTRIBUTIONSETTINGS': "attributionSettings", + 'ACTIVITYTYPE': "activityType", + 'KEYWORD': "keyword", + 'SKURELATION': "skuRelation", + 'RETAILERCATEGORYID': "retailerCategoryId", + 'RETAILERCATEGORYNAME': "retailerCategoryName", + 'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb", + 'TAXONOMY1ID': "taxonomy1Id", + 'TAXONOMY1NAME': "taxonomy1Name", + 'TAXONOMY2ID': "taxonomy2Id", + 'TAXONOMY2NAME': "taxonomy2Name", + 'TAXONOMY3ID': "taxonomy3Id", + 'TAXONOMY3NAME': "taxonomy3Name", + 'TAXONOMY4ID': "taxonomy4Id", + 'TAXONOMY4NAME': "taxonomy4Name", + 'TAXONOMY5ID': "taxonomy5Id", + 'TAXONOMY5NAME': "taxonomy5Name", + 'TAXONOMY6ID': "taxonomy6Id", + 'TAXONOMY6NAME': "taxonomy6Name", + 'TAXONOMY7ID': "taxonomy7Id", + 'TAXONOMY7NAME': "taxonomy7Name", }, ('metrics',): { 'None': None, + 'NUMBEROFCAMPAIGNS': "numberOfCampaigns", + 'NUMBEROFLINEITEMS': "numberOfLineItems", + 'NUMBEROFSKUS': "numberOfSkus", + 'SKUPRICE': "skuPrice", + 'PAGEVIEWS': "pageViews", 'IMPRESSIONS': "impressions", + 'PRODUCTCLICKS': "productClicks", + 'PLACEMENTCLICKS': "placementClicks", 'CLICKS': "clicks", - 'SPEND': "spend", 'SALES': "sales", 'UNITS': "units", - 'CPO': "cpo", - 'ROAS': "roas", + 'TRANSACTIONS': "transactions", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", 'OPENAUCTIONREVENUE': "openAuctionRevenue", 'PREFERREDDEALSREVENUE': "preferredDealsRevenue", - 'AVGCPC': "avgCpc", - 'AVGCPM': "avgCpm", + 'CTR': "ctr", + 'CR': "cr", + 'CPC': "cpc", + 'CPM': "cpm", + 'ROAS': "roas", + 'WORKINGMEDIA': "workingMedia", + 'NETREVENUE': "netRevenue", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", }, } @@ -174,13 +245,14 @@ def openapi_types(): 'id': (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 - 'click_attribution_window': (str, none_type,), # noqa: E501 - 'view_attribution_window': (str, none_type,), # noqa: E501 + 'buy_type': (str, none_type,), # noqa: E501 + 'sku_relations': ([str], none_type,), # noqa: E501 + 'format': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (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 @@ -198,13 +270,14 @@ def discriminator(): 'id': 'id', # 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 - 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 - 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 + 'buy_type': 'buyType', # noqa: E501 + 'sku_relations': 'skuRelations', # noqa: E501 + 'format': 'format', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # 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 @@ -259,13 +332,14 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 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 + sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional] # noqa: E501 + buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional] # noqa: E501 + sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -364,13 +438,14 @@ def __init__(self, start_date, end_date, *args, **kwargs): # 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 + sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional] # noqa: E501 + buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional] # noqa: E501 + sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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_2023-10/criteo_api_retailmedia_v2023_10/model/input_keywords_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/input_keywords_model.py new file mode 100644 index 00000000..c6b05cb7 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/input_keywords_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + + +class InputKeywordsModel(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 { + 'negative_broad': ([str], none_type,), # noqa: E501 + 'negative_exact': ([str], none_type,), # noqa: E501 + 'positive_exact': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negative_broad': 'negativeBroad', # noqa: E501 + 'negative_exact': 'negativeExact', # noqa: E501 + 'positive_exact': 'positiveExact', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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_2023-10/criteo_api_retailmedia_v2023_10/model/keyword_data_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/keyword_data_model.py new file mode 100644 index 00000000..9b10d2ab --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/keyword_data_model.py @@ -0,0 +1,286 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.input_keywords_model import InputKeywordsModel + from criteo_api_retailmedia_v2023_10.model.match_type_model import MatchTypeModel + from criteo_api_retailmedia_v2023_10.model.review_state_model import ReviewStateModel + globals()['InputKeywordsModel'] = InputKeywordsModel + globals()['MatchTypeModel'] = MatchTypeModel + globals()['ReviewStateModel'] = ReviewStateModel + + +class KeywordDataModel(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 { + 'review_state': (ReviewStateModel,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + 'input_keywords': (InputKeywordsModel,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'review_state': 'reviewState', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'bid': 'bid', # noqa: E501 + 'input_keywords': 'inputKeywords', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model.py new file mode 100644 index 00000000..22f5e85e --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.keyword_data_model import KeywordDataModel + globals()['KeywordDataModel'] = KeywordDataModel + + +class KeywordsModel(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 { + 'keywords': ({str: (KeywordDataModel,)}, none_type,), # noqa: E501 + 'rank': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + 'rank': 'rank', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model_resource.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model_resource.py new file mode 100644 index 00000000..e7b71255 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.keywords_model import KeywordsModel + globals()['KeywordsModel'] = KeywordsModel + + +class KeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (KeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model_response.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model_response.py new file mode 100644 index 00000000..27c104ea --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/keywords_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.keywords_model_resource import KeywordsModelResource + from criteo_api_retailmedia_v2023_10.model.rmca_common_problem import RmcaCommonProblem + globals()['KeywordsModelResource'] = KeywordsModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class KeywordsModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (KeywordsModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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_2023-10/criteo_api_retailmedia_v2023_10/model/match_type_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/match_type_model.py new file mode 100644 index 00000000..5967c68e --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/match_type_model.py @@ -0,0 +1,291 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + + +class MatchTypeModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'POSITIVEEXACTMATCH': "PositiveExactMatch", + 'NEGATIVEEXACTMATCH': "NegativeExactMatch", + 'NEGATIVEBROADMATCH': "NegativeBroadMatch", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/negotiation_state_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/negotiation_state_model.py new file mode 100644 index 00000000..e2805dd1 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/negotiation_state_model.py @@ -0,0 +1,293 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + + +class NegotiationStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INVALID': "Invalid", + 'MODIFIED': "Modified", + 'SUBMITTED': "Submitted", + 'REVIEWED': "Reviewed", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model.py new file mode 100644 index 00000000..2a890dd4 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model.py @@ -0,0 +1,284 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.approval_status_model import ApprovalStatusModel + from criteo_api_retailmedia_v2023_10.model.negotiation_state_model import NegotiationStateModel + globals()['ApprovalStatusModel'] = ApprovalStatusModel + globals()['NegotiationStateModel'] = NegotiationStateModel + + +class ProposalStatusModel(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 { + 'negotiation_state': (NegotiationStateModel,), # noqa: E501 + 'booking_status': (ApprovalStatusModel,), # noqa: E501 + 'runnable_status': (ApprovalStatusModel,), # noqa: E501 + 'comment': (str, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negotiation_state': 'negotiationState', # noqa: E501 + 'booking_status': 'bookingStatus', # noqa: E501 + 'runnable_status': 'runnableStatus', # noqa: E501 + 'comment': 'comment', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model_resource.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model_resource.py new file mode 100644 index 00000000..507793d1 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.proposal_status_model import ProposalStatusModel + globals()['ProposalStatusModel'] = ProposalStatusModel + + +class ProposalStatusModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (ProposalStatusModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model_response.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model_response.py new file mode 100644 index 00000000..4223722c --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/proposal_status_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.proposal_status_model_resource import ProposalStatusModelResource + from criteo_api_retailmedia_v2023_10.model.rmca_common_problem import RmcaCommonProblem + globals()['ProposalStatusModelResource'] = ProposalStatusModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ProposalStatusModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (ProposalStatusModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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_2023-10/criteo_api_retailmedia_v2023_10/model/resource_outcome.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/resource_outcome.py new file mode 100644 index 00000000..4966451e --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/resource_outcome.py @@ -0,0 +1,268 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.rmca_common_problem import RmcaCommonProblem + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ResourceOutcome(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keyword_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keyword_model.py deleted file mode 100644 index a86f1556..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keyword_model.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1AddRemoveKeywordModel(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 = { - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - validations = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'is_deleted': (bool, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'is_deleted': 'isDeleted', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model.py deleted file mode 100644 index 74769a0a..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel - globals()['RetailMediaExternalv1AddRemoveKeywordModel'] = RetailMediaExternalv1AddRemoveKeywordModel - - -class RetailMediaExternalv1AddRemoveKeywordsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1AddRemoveKeywordModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model_request.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model_request.py deleted file mode 100644 index b2118a4f..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource - globals()['RetailMediaExternalv1AddRemoveKeywordsModelResource'] = RetailMediaExternalv1AddRemoveKeywordsModelResource - - -class RetailMediaExternalv1AddRemoveKeywordsModelRequest(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': (RetailMediaExternalv1AddRemoveKeywordsModelResource,), # 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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model_resource.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model_resource.py deleted file mode 100644 index d022afc5..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_add_remove_keywords_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel - globals()['RetailMediaExternalv1AddRemoveKeywordsModel'] = RetailMediaExternalv1AddRemoveKeywordsModel - - -class RetailMediaExternalv1AddRemoveKeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1AddRemoveKeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_input_keywords_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_input_keywords_model.py deleted file mode 100644 index fc0719d4..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_input_keywords_model.py +++ /dev/null @@ -1,277 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1InputKeywordsModel(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 = { - ('negative_broad',): { - }, - ('negative_exact',): { - }, - ('positive_exact',): { - }, - } - - @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 { - 'negative_broad': ([str], none_type,), # noqa: E501 - 'negative_exact': ([str], none_type,), # noqa: E501 - 'positive_exact': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negative_broad': 'negativeBroad', # noqa: E501 - 'negative_exact': 'negativeExact', # noqa: E501 - 'positive_exact': 'positiveExact', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keyword_data_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keyword_data_model.py deleted file mode 100644 index 3af21c1a..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keyword_data_model.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel - globals()['RetailMediaExternalv1InputKeywordsModel'] = RetailMediaExternalv1InputKeywordsModel - - -class RetailMediaExternalv1KeywordDataModel(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 = { - ('review_state',): { - 'None': None, - 'INREVIEW': "InReview", - 'RECOMMENDED': "Recommended", - 'APPROVED': "Approved", - 'AUTOAPPROVED': "AutoApproved", - 'REJECTED': "Rejected", - 'AUTOREJECTED': "AutoRejected", - }, - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - 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 { - 'review_state': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - 'input_keywords': (RetailMediaExternalv1InputKeywordsModel,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'review_state': 'reviewState', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'bid': 'bid', # noqa: E501 - 'input_keywords': 'inputKeywords', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model.py deleted file mode 100644 index 0180ab3e..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel - globals()['RetailMediaExternalv1KeywordDataModel'] = RetailMediaExternalv1KeywordDataModel - - -class RetailMediaExternalv1KeywordsModel(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 = { - ('rank',): { - }, - } - - @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 { - 'keywords': (RetailMediaExternalv1KeywordDataModel,), # noqa: E501 - 'rank': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - 'rank': 'rank', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_resource.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_resource.py deleted file mode 100644 index fda1a7be..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel - globals()['RetailMediaExternalv1KeywordsModel'] = RetailMediaExternalv1KeywordsModel - - -class RetailMediaExternalv1KeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1KeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_response.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_response.py deleted file mode 100644 index 2f241a5e..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1KeywordsModelResource'] = RetailMediaExternalv1KeywordsModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1KeywordsModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1KeywordsModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_problem_details.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_problem_details.py deleted file mode 100644 index c58b7cae..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_problem_details.py +++ /dev/null @@ -1,295 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1ProblemDetails(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 ({str: (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_identifier': (str, none_type,), # noqa: E501 - 'code': (str, none_type,), # noqa: E501 - 'source': ({str: (str,)}, none_type,), # noqa: E501 - 'stack_trace': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'status': (int, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'instance': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'code': 'code', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - 'type': 'type', # noqa: E501 - 'title': 'title', # noqa: E501 - 'status': 'status', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'instance': 'instance', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model.py deleted file mode 100644 index 548fcc17..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1ProposalStatusModel(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 = { - ('negotiation_state',): { - 'INVALID': "Invalid", - 'MODIFIED': "Modified", - 'SUBMITTED': "Submitted", - 'REVIEWED': "Reviewed", - 'APPROVED': "Approved", - }, - ('booking_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - ('runnable_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - } - - 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 { - 'negotiation_state': (str,), # noqa: E501 - 'booking_status': (str,), # noqa: E501 - 'runnable_status': (str,), # noqa: E501 - 'comment': (str, none_type,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negotiation_state': 'negotiationState', # noqa: E501 - 'booking_status': 'bookingStatus', # noqa: E501 - 'runnable_status': 'runnableStatus', # noqa: E501 - 'comment': 'comment', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_resource.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_resource.py deleted file mode 100644 index ee8e32bb..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel - globals()['RetailMediaExternalv1ProposalStatusModel'] = RetailMediaExternalv1ProposalStatusModel - - -class RetailMediaExternalv1ProposalStatusModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1ProposalStatusModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_response.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_response.py deleted file mode 100644 index fce3e280..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProposalStatusModelResource'] = RetailMediaExternalv1ProposalStatusModelResource - - -class RetailMediaExternalv1ProposalStatusModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1ProposalStatusModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_resource_outcome.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_resource_outcome.py deleted file mode 100644 index c9183d34..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_resource_outcome.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1ResourceOutcome(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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 { - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'errors': 'errors', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - } - - read_only_vars = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bid_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bid_model.py deleted file mode 100644 index a0201b21..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bid_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1SetBidModel(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 = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'bid': 'bid', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model.py deleted file mode 100644 index 2bdd780e..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel - globals()['RetailMediaExternalv1SetBidModel'] = RetailMediaExternalv1SetBidModel - - -class RetailMediaExternalv1SetBidsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1SetBidModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model_request.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model_request.py deleted file mode 100644 index 6db0d6a1..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource - globals()['RetailMediaExternalv1SetBidsModelResource'] = RetailMediaExternalv1SetBidsModelResource - - -class RetailMediaExternalv1SetBidsModelRequest(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': (RetailMediaExternalv1SetBidsModelResource,), # 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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model_resource.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model_resource.py deleted file mode 100644 index 5ede04a6..00000000 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_set_bids_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2023-10 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel - globals()['RetailMediaExternalv1SetBidsModel'] = RetailMediaExternalv1SetBidsModel - - -class RetailMediaExternalv1SetBidsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1SetBidsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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_2023-10/criteo_api_retailmedia_v2023_10/model/review_state_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/review_state_model.py new file mode 100644 index 00000000..6daa66ee --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/review_state_model.py @@ -0,0 +1,294 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + + +class ReviewStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INREVIEW': "InReview", + 'RECOMMENDED': "Recommended", + 'APPROVED': "Approved", + 'AUTOAPPROVED': "AutoApproved", + 'REJECTED': "Rejected", + 'AUTOREJECTED': "AutoRejected", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/rmca_common_problem.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/rmca_common_problem.py new file mode 100644 index 00000000..2281c26b --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/rmca_common_problem.py @@ -0,0 +1,306 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + + +class RmcaCommonProblem(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + 'status': (int, none_type,), # 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 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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_2023-10/criteo_api_retailmedia_v2023_10/model/set_bid_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/set_bid_model.py new file mode 100644 index 00000000..33f6896a --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/set_bid_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + + +class SetBidModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'bid': 'bid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model.py new file mode 100644 index 00000000..2eece818 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.set_bid_model import SetBidModel + globals()['SetBidModel'] = SetBidModel + + +class SetBidsModel(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 { + 'keywords': ([SetBidModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model_request.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model_request.py new file mode 100644 index 00000000..b43530c3 --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.set_bids_model_resource import SetBidsModelResource + globals()['SetBidsModelResource'] = SetBidsModelResource + + +class SetBidsModelRequest(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': (SetBidsModelResource,), # 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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model_resource.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model_resource.py new file mode 100644 index 00000000..c1de79ea --- /dev/null +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/model/set_bids_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2023-10 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2023_10.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_v2023_10.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2023_10.model.set_bids_model import SetBidsModel + globals()['SetBidsModel'] = SetBidsModel + + +class SetBidsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (SetBidsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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_2023-10/criteo_api_retailmedia_v2023_10/models/__init__.py b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/models/__init__.py index 25eff0ef..72b15fac 100644 --- a/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/models/__init__.py +++ b/sdks/retailmedia_2023-10/criteo_api_retailmedia_v2023_10/models/__init__.py @@ -10,12 +10,17 @@ # sys.setrecursionlimit(n) from criteo_api_retailmedia_v2023_10.model.add_funds_to_balance_request import AddFundsToBalanceRequest +from criteo_api_retailmedia_v2023_10.model.add_remove_keyword_model import AddRemoveKeywordModel +from criteo_api_retailmedia_v2023_10.model.add_remove_keywords_model import AddRemoveKeywordsModel +from criteo_api_retailmedia_v2023_10.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2023_10.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource from criteo_api_retailmedia_v2023_10.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request from criteo_api_retailmedia_v2023_10.model.add_to_basket_target202110_request import AddToBasketTarget202110Request from criteo_api_retailmedia_v2023_10.model.add_to_basket_target202110_response import AddToBasketTarget202110Response from criteo_api_retailmedia_v2023_10.model.application_summary_model import ApplicationSummaryModel from criteo_api_retailmedia_v2023_10.model.application_summary_model_resource import ApplicationSummaryModelResource from criteo_api_retailmedia_v2023_10.model.application_summary_model_response import ApplicationSummaryModelResponse +from criteo_api_retailmedia_v2023_10.model.approval_status_model import ApprovalStatusModel from criteo_api_retailmedia_v2023_10.model.asset import Asset from criteo_api_retailmedia_v2023_10.model.asset_resource import AssetResource from criteo_api_retailmedia_v2023_10.model.asset_response import AssetResponse @@ -95,6 +100,7 @@ from criteo_api_retailmedia_v2023_10.model.files_variable_value import FilesVariableValue from criteo_api_retailmedia_v2023_10.model.files_variables_specification import FilesVariablesSpecification from criteo_api_retailmedia_v2023_10.model.hyperlink_variable_value import HyperlinkVariableValue +from criteo_api_retailmedia_v2023_10.model.input_keywords_model import InputKeywordsModel from criteo_api_retailmedia_v2023_10.model.input_resource_of_auction_line_item_create_model import InputResourceOfAuctionLineItemCreateModel from criteo_api_retailmedia_v2023_10.model.input_resource_of_preferred_line_item_create_model202110 import InputResourceOfPreferredLineItemCreateModel202110 from criteo_api_retailmedia_v2023_10.model.json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 @@ -114,11 +120,17 @@ from criteo_api_retailmedia_v2023_10.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 from criteo_api_retailmedia_v2023_10.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus from criteo_api_retailmedia_v2023_10.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers +from criteo_api_retailmedia_v2023_10.model.keyword_data_model import KeywordDataModel from criteo_api_retailmedia_v2023_10.model.keyword_target202110_request import KeywordTarget202110Request from criteo_api_retailmedia_v2023_10.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2023_10.model.keywords_model import KeywordsModel +from criteo_api_retailmedia_v2023_10.model.keywords_model_resource import KeywordsModelResource +from criteo_api_retailmedia_v2023_10.model.keywords_model_response import KeywordsModelResponse from criteo_api_retailmedia_v2023_10.model.line_item_bid_multipliers import LineItemBidMultipliers from criteo_api_retailmedia_v2023_10.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_v2023_10.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse +from criteo_api_retailmedia_v2023_10.model.match_type_model import MatchTypeModel +from criteo_api_retailmedia_v2023_10.model.negotiation_state_model import NegotiationStateModel from criteo_api_retailmedia_v2023_10.model.page_metadata import PageMetadata from criteo_api_retailmedia_v2023_10.model.page_type_environment import PageTypeEnvironment from criteo_api_retailmedia_v2023_10.model.post_campaign_v202301 import PostCampaignV202301 @@ -129,6 +141,9 @@ from criteo_api_retailmedia_v2023_10.model.problem_details import ProblemDetails from criteo_api_retailmedia_v2023_10.model.promoted_product202110_list_request import PromotedProduct202110ListRequest from criteo_api_retailmedia_v2023_10.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2023_10.model.proposal_status_model import ProposalStatusModel +from criteo_api_retailmedia_v2023_10.model.proposal_status_model_resource import ProposalStatusModelResource +from criteo_api_retailmedia_v2023_10.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_v2023_10.model.put_campaign_v202301 import PutCampaignV202301 from criteo_api_retailmedia_v2023_10.model.report_outcome import ReportOutcome from criteo_api_retailmedia_v2023_10.model.resource_of_add_funds_to_balance import ResourceOfAddFundsToBalance @@ -148,24 +163,8 @@ from criteo_api_retailmedia_v2023_10.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 from criteo_api_retailmedia_v2023_10.model.resource_of_template import ResourceOfTemplate from criteo_api_retailmedia_v2023_10.model.resource_of_update_balance_model import ResourceOfUpdateBalanceModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource +from criteo_api_retailmedia_v2023_10.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.review_state_model import ReviewStateModel from criteo_api_retailmedia_v2023_10.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1 from criteo_api_retailmedia_v2023_10.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource from criteo_api_retailmedia_v2023_10.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response @@ -186,7 +185,12 @@ from criteo_api_retailmedia_v2023_10.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2 from criteo_api_retailmedia_v2023_10.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 from criteo_api_retailmedia_v2023_10.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 +from criteo_api_retailmedia_v2023_10.model.rmca_common_problem import RmcaCommonProblem from criteo_api_retailmedia_v2023_10.model.section import Section +from criteo_api_retailmedia_v2023_10.model.set_bid_model import SetBidModel +from criteo_api_retailmedia_v2023_10.model.set_bids_model import SetBidsModel +from criteo_api_retailmedia_v2023_10.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2023_10.model.set_bids_model_resource import SetBidsModelResource from criteo_api_retailmedia_v2023_10.model.status_response import StatusResponse from criteo_api_retailmedia_v2023_10.model.status_response_resource import StatusResponseResource from criteo_api_retailmedia_v2023_10.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request diff --git a/sdks/retailmedia_2023-10/docs/AddRemoveKeywordModel.md b/sdks/retailmedia_2023-10/docs/AddRemoveKeywordModel.md new file mode 100644 index 00000000..8546f1f2 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/AddRemoveKeywordModel.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordModel + +A single keyword to be added or removed + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**is_deleted** | **bool, 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_2023-10/docs/AddRemoveKeywordsModel.md b/sdks/retailmedia_2023-10/docs/AddRemoveKeywordsModel.md new file mode 100644 index 00000000..27980d2b --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/AddRemoveKeywordsModel.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModel + +Data model containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[AddRemoveKeywordModel], none_type**](AddRemoveKeywordModel.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_2023-10/docs/AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2023-10/docs/AddRemoveKeywordsModelRequest.md new file mode 100644 index 00000000..577c720e --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/AddRemoveKeywordsModelRequest.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModelRequest + +Request object to add or remove keywords from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AddRemoveKeywordsModelResource**](AddRemoveKeywordsModelResource.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_2023-10/docs/AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2023-10/docs/AddRemoveKeywordsModelResource.md new file mode 100644 index 00000000..ad36e151 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/AddRemoveKeywordsModelResource.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordsModelResource + +Resource object containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**AddRemoveKeywordsModel**](AddRemoveKeywordsModel.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_2023-10/docs/AnalyticsApi.md b/sdks/retailmedia_2023-10/docs/AnalyticsApi.md index 11c16d3c..92782ff5 100644 --- a/sdks/retailmedia_2023-10/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2023-10/docs/AnalyticsApi.md @@ -66,8 +66,8 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", @@ -179,8 +179,8 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", @@ -294,18 +294,21 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: id="id_example", report_type="advertiser", revenue_type="auction", - format="json", sold_by="directSold", - campaign_sub_type="auctionAndPreferred", + buy_type="auction", + sku_relations=[ + "sameSku", + ], + format="json", + campaign_type="all", + sales_channel="all", click_attribution_window="none", view_attribution_window="none", - campaign_type="sponsoredProducts", - sales_channel="offline", dimensions=[ "date", ], metrics=[ - "impressions", + "numberOfCampaigns", ], start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), diff --git a/sdks/retailmedia_2023-10/docs/ApprovalStatusModel.md b/sdks/retailmedia_2023-10/docs/ApprovalStatusModel.md new file mode 100644 index 00000000..52ab7863 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/ApprovalStatusModel.md @@ -0,0 +1,12 @@ +# ApprovalStatusModel + +The status of a booking or runnable in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of a booking or runnable in the context of a line item. | must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] + +[[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_2023-10/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2023-10/docs/AsyncCampaignsReport.md index 21dd57bd..f4385127 100644 --- a/sdks/retailmedia_2023-10/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2023-10/docs/AsyncCampaignsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **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] -**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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-10/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2023-10/docs/AsyncLineItemsReport.md index ccb01090..eece64e3 100644 --- a/sdks/retailmedia_2023-10/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2023-10/docs/AsyncLineItemsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **end_date** | **datetime** | End date | **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-10/docs/AsyncRevenueReport.md b/sdks/retailmedia_2023-10/docs/AsyncRevenueReport.md index 53b4ca21..e7d30dbc 100644 --- a/sdks/retailmedia_2023-10/docs/AsyncRevenueReport.md +++ b/sdks/retailmedia_2023-10/docs/AsyncRevenueReport.md @@ -11,13 +11,14 @@ Name | Type | Description | Notes **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] +**sold_by** | **str, none_type** | Filter on the seller: Indirect Sold, Direct Sold or Private Market | [optional] +**buy_type** | **str, none_type** | Filter on buy type: Auction, Preferred Deals or Sponsorship | [optional] +**sku_relations** | **[str], none_type** | Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller | [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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-10/docs/CampaignApi.md b/sdks/retailmedia_2023-10/docs/CampaignApi.md index c6ad06e4..ff9d9daa 100644 --- a/sdks/retailmedia_2023-10/docs/CampaignApi.md +++ b/sdks/retailmedia_2023-10/docs/CampaignApi.md @@ -74,11 +74,11 @@ Method | HTTP request | Description # **add_remove_keywords** -> RetailMediaExternalv1ResourceOutcome add_remove_keywords(id) +> ResourceOutcome add_remove_keywords(id) -Add or Remove keywords from the associated line item in bulk +Add or Remove keywords from the line item in bulk ### Example @@ -89,8 +89,8 @@ Add or Remove keywords from the associated line item in bulk import time import criteo_api_retailmedia_v2023_10 from criteo_api_retailmedia_v2023_10.api import campaign_api -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest 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. @@ -119,22 +119,22 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_add_remove_keywords_model_request = RetailMediaExternalv1AddRemoveKeywordsModelRequest( - data=RetailMediaExternalv1AddRemoveKeywordsModelResource( + id = "id_example" # str | ID of the line item + add_remove_keywords_model_request = AddRemoveKeywordsModelRequest( + data=AddRemoveKeywordsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1AddRemoveKeywordsModel( + attributes=AddRemoveKeywordsModel( keywords=[ - RetailMediaExternalv1AddRemoveKeywordModel( + AddRemoveKeywordModel( phrase="phrase_example", - match_type="PositiveExactMatch", + match_type=MatchTypeModel("PositiveExactMatch"), is_deleted=True, ), ], ), ), - ) # RetailMediaExternalv1AddRemoveKeywordsModelRequest | Object containing keywords to be added or removed (optional) + ) # AddRemoveKeywordsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -146,7 +146,7 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.add_remove_keywords(id, retail_media_externalv1_add_remove_keywords_model_request=retail_media_externalv1_add_remove_keywords_model_request) + api_response = api_instance.add_remove_keywords(id, add_remove_keywords_model_request=add_remove_keywords_model_request) pprint(api_response) except criteo_api_retailmedia_v2023_10.ApiException as e: print("Exception when calling CampaignApi->add_remove_keywords: %s\n" % e) @@ -157,12 +157,12 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_add_remove_keywords_model_request** | [**RetailMediaExternalv1AddRemoveKeywordsModelRequest**](RetailMediaExternalv1AddRemoveKeywordsModelRequest.md)| Object containing keywords to be added or removed | [optional] + **id** | **str**| ID of the line item | + **add_remove_keywords_model_request** | [**AddRemoveKeywordsModelRequest**](AddRemoveKeywordsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -171,7 +171,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -268,7 +268,7 @@ 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) # **fetch_keywords** -> RetailMediaExternalv1KeywordsModelResponse fetch_keywords(id) +> KeywordsModelResponse fetch_keywords(id) @@ -283,7 +283,8 @@ Fetch keywords associated with the specified line item import time import criteo_api_retailmedia_v2023_10 from criteo_api_retailmedia_v2023_10.api import campaign_api -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse +from criteo_api_retailmedia_v2023_10.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.keywords_model_response import KeywordsModelResponse 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. @@ -312,7 +313,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -327,11 +328,11 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1KeywordsModelResponse**](RetailMediaExternalv1KeywordsModelResponse.md) +[**KeywordsModelResponse**](KeywordsModelResponse.md) ### Authorization @@ -340,7 +341,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 @@ -353,11 +354,11 @@ 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) # **fetch_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse fetch_proposal(id) +> ProposalStatusModelResponse fetch_proposal(id) -Fetch the status of a proposal to modify a Preferred Deal Line Item. +Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. ### Example @@ -368,7 +369,8 @@ Fetch the status of a proposal to modify a Preferred Deal Line Item. import time import criteo_api_retailmedia_v2023_10 from criteo_api_retailmedia_v2023_10.api import campaign_api -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_v2023_10.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.proposal_status_model_response import ProposalStatusModelResponse 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. @@ -397,7 +399,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -412,11 +414,11 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -425,7 +427,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 @@ -434,7 +436,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) @@ -6549,7 +6550,7 @@ 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) # **set_keyword_bids** -> RetailMediaExternalv1ResourceOutcome set_keyword_bids(id) +> ResourceOutcome set_keyword_bids(id) @@ -6564,8 +6565,8 @@ Set bid overrides for associated keywords to the given line item in bulk import time import criteo_api_retailmedia_v2023_10 from criteo_api_retailmedia_v2023_10.api import campaign_api -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.set_bids_model_request import SetBidsModelRequest 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. @@ -6594,21 +6595,21 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_set_bids_model_request = RetailMediaExternalv1SetBidsModelRequest( - data=RetailMediaExternalv1SetBidsModelResource( + id = "id_example" # str | ID of the line item + set_bids_model_request = SetBidsModelRequest( + data=SetBidsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1SetBidsModel( + attributes=SetBidsModel( keywords=[ - RetailMediaExternalv1SetBidModel( + SetBidModel( phrase="phrase_example", bid=3.14, ), ], ), ), - ) # RetailMediaExternalv1SetBidsModelRequest | Object containing a list of bid overrides for associated keywords (optional) + ) # SetBidsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -6620,7 +6621,7 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.set_keyword_bids(id, retail_media_externalv1_set_bids_model_request=retail_media_externalv1_set_bids_model_request) + api_response = api_instance.set_keyword_bids(id, set_bids_model_request=set_bids_model_request) pprint(api_response) except criteo_api_retailmedia_v2023_10.ApiException as e: print("Exception when calling CampaignApi->set_keyword_bids: %s\n" % e) @@ -6631,12 +6632,12 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_set_bids_model_request** | [**RetailMediaExternalv1SetBidsModelRequest**](RetailMediaExternalv1SetBidsModelRequest.md)| Object containing a list of bid overrides for associated keywords | [optional] + **id** | **str**| ID of the line item | + **set_bids_model_request** | [**SetBidsModelRequest**](SetBidsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -6645,7 +6646,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -6658,11 +6659,11 @@ 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) # **submit_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse submit_proposal(id) +> ProposalStatusModelResponse submit_proposal(id) -Submit a proposal to modify a Preferred Deal Line Item for review. +Only the components of the Line Item that are in a valid state will be reviewed. ### Example @@ -6673,7 +6674,8 @@ Submit a proposal to modify a Preferred Deal Line Item for review. import time import criteo_api_retailmedia_v2023_10 from criteo_api_retailmedia_v2023_10.api import campaign_api -from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_v2023_10.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2023_10.model.proposal_status_model_response import ProposalStatusModelResponse 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. @@ -6702,7 +6704,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -6717,11 +6719,11 @@ with criteo_api_retailmedia_v2023_10.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -6730,7 +6732,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 @@ -6739,7 +6741,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) diff --git a/sdks/retailmedia_2023-10/docs/InputKeywordsModel.md b/sdks/retailmedia_2023-10/docs/InputKeywordsModel.md new file mode 100644 index 00000000..9a080793 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/InputKeywordsModel.md @@ -0,0 +1,14 @@ +# InputKeywordsModel + +The keywords to be added or removed from a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negative_broad** | **[str], none_type** | | [optional] +**negative_exact** | **[str], none_type** | | [optional] +**positive_exact** | **[str], 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_2023-10/docs/KeywordDataModel.md b/sdks/retailmedia_2023-10/docs/KeywordDataModel.md new file mode 100644 index 00000000..fca58d73 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/KeywordDataModel.md @@ -0,0 +1,17 @@ +# KeywordDataModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**review_state** | [**ReviewStateModel**](ReviewStateModel.md) | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**bid** | **float, none_type** | | [optional] +**input_keywords** | [**InputKeywordsModel**](InputKeywordsModel.md) | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2023-10/docs/KeywordsModel.md b/sdks/retailmedia_2023-10/docs/KeywordsModel.md new file mode 100644 index 00000000..d31dabad --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/KeywordsModel.md @@ -0,0 +1,13 @@ +# KeywordsModel + +The keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**{str: (KeywordDataModel,)}, none_type**](KeywordDataModel.md) | | [optional] +**rank** | **[str], 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_2023-10/docs/KeywordsModelResource.md b/sdks/retailmedia_2023-10/docs/KeywordsModelResource.md new file mode 100644 index 00000000..9a26bd3a --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/KeywordsModelResource.md @@ -0,0 +1,14 @@ +# KeywordsModelResource + +Resource object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**KeywordsModel**](KeywordsModel.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_2023-10/docs/KeywordsModelResponse.md b/sdks/retailmedia_2023-10/docs/KeywordsModelResponse.md new file mode 100644 index 00000000..2d24cc4e --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/KeywordsModelResponse.md @@ -0,0 +1,14 @@ +# KeywordsModelResponse + +Response object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**KeywordsModelResource**](KeywordsModelResource.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_2023-10/docs/MatchTypeModel.md b/sdks/retailmedia_2023-10/docs/MatchTypeModel.md new file mode 100644 index 00000000..9406306f --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/MatchTypeModel.md @@ -0,0 +1,12 @@ +# MatchTypeModel + +The match type of a keyword. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The match type of a keyword. | must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] + +[[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_2023-10/docs/NegotiationStateModel.md b/sdks/retailmedia_2023-10/docs/NegotiationStateModel.md new file mode 100644 index 00000000..e34ddbf4 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/NegotiationStateModel.md @@ -0,0 +1,12 @@ +# NegotiationStateModel + +The state of a negotiation in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a negotiation in the context of a line item. | must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] + +[[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_2023-10/docs/ProposalStatusModel.md b/sdks/retailmedia_2023-10/docs/ProposalStatusModel.md new file mode 100644 index 00000000..49d39c19 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/ProposalStatusModel.md @@ -0,0 +1,17 @@ +# ProposalStatusModel + +The state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negotiation_state** | [**NegotiationStateModel**](NegotiationStateModel.md) | | [optional] +**booking_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**runnable_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**comment** | **str, none_type** | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2023-10/docs/ProposalStatusModelResource.md b/sdks/retailmedia_2023-10/docs/ProposalStatusModelResource.md new file mode 100644 index 00000000..f89ca4eb --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/ProposalStatusModelResource.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResource + +Resource object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**ProposalStatusModel**](ProposalStatusModel.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_2023-10/docs/ProposalStatusModelResponse.md b/sdks/retailmedia_2023-10/docs/ProposalStatusModelResponse.md new file mode 100644 index 00000000..2e87ff0d --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/ProposalStatusModelResponse.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResponse + +Response object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**ProposalStatusModelResource**](ProposalStatusModelResource.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_2023-10/docs/ResourceOutcome.md b/sdks/retailmedia_2023-10/docs/ResourceOutcome.md new file mode 100644 index 00000000..3bf8a5e5 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/ResourceOutcome.md @@ -0,0 +1,13 @@ +# ResourceOutcome + +Outcome object containing errors and warnings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.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_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordModel.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordModel.md deleted file mode 100644 index 98c859cd..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordModel - -A single keyword to be added or removed - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**is_deleted** | **bool, 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_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md deleted file mode 100644 index 2d39bd84..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModel - -Data model containing keywords to be added or removed from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1AddRemoveKeywordModel], none_type**](RetailMediaExternalv1AddRemoveKeywordModel.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_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md deleted file mode 100644 index d623d5f5..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelRequest - -Request object to add or remove keywords from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1AddRemoveKeywordsModelResource**](RetailMediaExternalv1AddRemoveKeywordsModelResource.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_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md deleted file mode 100644 index 1abf3809..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelResource - -Resource wrapper the keyword add and remove datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1AddRemoveKeywordsModel**](RetailMediaExternalv1AddRemoveKeywordsModel.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_2023-10/docs/RetailMediaExternalv1InputKeywordsModel.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1InputKeywordsModel.md deleted file mode 100644 index 19807cea..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1InputKeywordsModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1InputKeywordsModel - -Input values associated with a keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negative_broad** | **[str], none_type** | | [optional] -**negative_exact** | **[str], none_type** | | [optional] -**positive_exact** | **[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_2023-10/docs/RetailMediaExternalv1KeywordDataModel.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1KeywordDataModel.md deleted file mode 100644 index d7326d7a..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1KeywordDataModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1KeywordDataModel - -Details for a specific keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**review_state** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**bid** | **float, none_type** | | [optional] -**input_keywords** | [**RetailMediaExternalv1InputKeywordsModel**](RetailMediaExternalv1InputKeywordsModel.md) | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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_2023-10/docs/RetailMediaExternalv1KeywordsModel.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1KeywordsModel.md deleted file mode 100644 index 105b25b5..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1KeywordsModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1KeywordsModel - -Datamodel representing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**RetailMediaExternalv1KeywordDataModel**](RetailMediaExternalv1KeywordDataModel.md) | | [optional] -**rank** | **[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_2023-10/docs/RetailMediaExternalv1KeywordsModelResource.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1KeywordsModelResource.md deleted file mode 100644 index 8aabe795..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1KeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResource - -Resource wrapper of associated keywords with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1KeywordsModel**](RetailMediaExternalv1KeywordsModel.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_2023-10/docs/RetailMediaExternalv1KeywordsModelResponse.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1KeywordsModelResponse.md deleted file mode 100644 index eb84587c..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1KeywordsModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResponse - -Response object containing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1KeywordsModelResource**](RetailMediaExternalv1KeywordsModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-10/docs/RetailMediaExternalv1ProblemDetails.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ProblemDetails.md deleted file mode 100644 index 32758436..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ProblemDetails.md +++ /dev/null @@ -1,21 +0,0 @@ -# RetailMediaExternalv1ProblemDetails - -Datamodel for common errors and warnings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**trace_identifier** | **str, none_type** | | [optional] -**code** | **str, none_type** | | [optional] -**source** | **{str: (str,)}, none_type** | | [optional] -**stack_trace** | **str, none_type** | | [optional] -**type** | **str, none_type** | | [optional] -**title** | **str, none_type** | | [optional] -**status** | **int, none_type** | | [optional] -**detail** | **str, none_type** | | [optional] -**instance** | **str, none_type** | | [optional] -**any string name** | **{str: (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_2023-10/docs/RetailMediaExternalv1ProposalStatusModel.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ProposalStatusModel.md deleted file mode 100644 index 93cf4401..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ProposalStatusModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModel - -The proposal status includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negotiation_state** | **str** | | -**booking_status** | **str** | | -**runnable_status** | **str** | | -**comment** | **str, none_type** | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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_2023-10/docs/RetailMediaExternalv1ProposalStatusModelResource.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ProposalStatusModelResource.md deleted file mode 100644 index 4c5ebc52..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ProposalStatusModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResource - -Wrapper for the proposal status - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1ProposalStatusModel**](RetailMediaExternalv1ProposalStatusModel.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_2023-10/docs/RetailMediaExternalv1ProposalStatusModelResponse.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ProposalStatusModelResponse.md deleted file mode 100644 index 2550a175..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ProposalStatusModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResponse - -Wrapper for the proposal status resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1ProposalStatusModelResource**](RetailMediaExternalv1ProposalStatusModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-10/docs/RetailMediaExternalv1ResourceOutcome.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ResourceOutcome.md deleted file mode 100644 index 7b1c09f1..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1ResourceOutcome.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1ResourceOutcome - -A response object containing errors or warnings if required - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2023-10/docs/RetailMediaExternalv1SetBidModel.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidModel.md deleted file mode 100644 index 978f8b12..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1SetBidModel - -A single keyword and associated bid override - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**bid** | **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/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidsModel.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidsModel.md deleted file mode 100644 index 2b1359ff..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModel - -Data model containing keywords and bid overrides to associate to them - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1SetBidModel], none_type**](RetailMediaExternalv1SetBidModel.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_2023-10/docs/RetailMediaExternalv1SetBidsModelRequest.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidsModelRequest.md deleted file mode 100644 index e40b943e..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModelRequest - -Request to set bid overrides for specified keywords on a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1SetBidsModelResource**](RetailMediaExternalv1SetBidsModelResource.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_2023-10/docs/RetailMediaExternalv1SetBidsModelResource.md b/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidsModelResource.md deleted file mode 100644 index 4a4e3082..00000000 --- a/sdks/retailmedia_2023-10/docs/RetailMediaExternalv1SetBidsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1SetBidsModelResource - -Wrapper of the Set Bids datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1SetBidsModel**](RetailMediaExternalv1SetBidsModel.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_2023-10/docs/ReviewStateModel.md b/sdks/retailmedia_2023-10/docs/ReviewStateModel.md new file mode 100644 index 00000000..e905d467 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/ReviewStateModel.md @@ -0,0 +1,12 @@ +# ReviewStateModel + +The state of a keyword in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a keyword in the context of a line item. | must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] + +[[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_2023-10/docs/RmLegacyAudienceGetEntityV1ListResponse.md b/sdks/retailmedia_2023-10/docs/RmLegacyAudienceGetEntityV1ListResponse.md index a086fc52..177bd87b 100644 --- a/sdks/retailmedia_2023-10/docs/RmLegacyAudienceGetEntityV1ListResponse.md +++ b/sdks/retailmedia_2023-10/docs/RmLegacyAudienceGetEntityV1ListResponse.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1ListResponse -List of responses +A top-level object that encapsulates a Criteo API response for several entities and metadata ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2023-10/docs/RmLegacyAudienceGetEntityV1Resource.md b/sdks/retailmedia_2023-10/docs/RmLegacyAudienceGetEntityV1Resource.md index 7d4b9798..dad0c799 100644 --- a/sdks/retailmedia_2023-10/docs/RmLegacyAudienceGetEntityV1Resource.md +++ b/sdks/retailmedia_2023-10/docs/RmLegacyAudienceGetEntityV1Resource.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1Resource -Legacy resource +A class that represents a domain entity exposed by an API ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2023-10/docs/RmcaCommonProblem.md b/sdks/retailmedia_2023-10/docs/RmcaCommonProblem.md new file mode 100644 index 00000000..fba2c66b --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/RmcaCommonProblem.md @@ -0,0 +1,21 @@ +# RmcaCommonProblem + +Common problem object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trace_id** | **str, none_type** | The request correlation ID this problem comes from. | [optional] +**type** | **str, none_type** | The problem's category. | [optional] +**code** | **str, none_type** | A machine-readable error code, expressed as a string value. | [optional] +**instance** | **str, none_type** | A URI that identifies the specific occurrence of the problem. | [optional] +**title** | **str, none_type** | A short human-readable description of the problem type | [optional] +**detail** | **str, none_type** | A human-readable explanation specific to this occurrence of the problem | [optional] +**source** | **{str: (str,)}, none_type** | A machine-readable structure to reference to the exact location(s) causing the error(s) | [optional] +**stack_trace** | **str, none_type** | | [optional] +**status** | **int, none_type** | The problem's HTTP Status code. | [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_2023-10/docs/SetBidModel.md b/sdks/retailmedia_2023-10/docs/SetBidModel.md new file mode 100644 index 00000000..979e91d0 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/SetBidModel.md @@ -0,0 +1,13 @@ +# SetBidModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**bid** | **float, 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_2023-10/docs/SetBidsModel.md b/sdks/retailmedia_2023-10/docs/SetBidsModel.md new file mode 100644 index 00000000..e5e1b0c8 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/SetBidsModel.md @@ -0,0 +1,12 @@ +# SetBidsModel + +Data model containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[SetBidModel], none_type**](SetBidModel.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_2023-10/docs/SetBidsModelRequest.md b/sdks/retailmedia_2023-10/docs/SetBidsModelRequest.md new file mode 100644 index 00000000..9c19c9c2 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/SetBidsModelRequest.md @@ -0,0 +1,12 @@ +# SetBidsModelRequest + +Request object to set bid overrides for keywords associated with a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SetBidsModelResource**](SetBidsModelResource.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_2023-10/docs/SetBidsModelResource.md b/sdks/retailmedia_2023-10/docs/SetBidsModelResource.md new file mode 100644 index 00000000..6e436263 --- /dev/null +++ b/sdks/retailmedia_2023-10/docs/SetBidsModelResource.md @@ -0,0 +1,14 @@ +# SetBidsModelResource + +Resource object containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**SetBidsModel**](SetBidsModel.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_2023-10/setup.py b/sdks/retailmedia_2023-10/setup.py index bcea29aa..e8f2c338 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.240404" +VERSION = "2023.10.0.240515" # 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.240404 +pip install criteo-api-retailmedia-sdk==2023.10.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/retailmedia_2024-01/.openapi-generator/FILES b/sdks/retailmedia_2024-01/.openapi-generator/FILES index d35fa6ce..15fd0c27 100644 --- a/sdks/retailmedia_2024-01/.openapi-generator/FILES +++ b/sdks/retailmedia_2024-01/.openapi-generator/FILES @@ -20,12 +20,17 @@ criteo_api_retailmedia_v2024_01/exceptions.py criteo_api_retailmedia_v2024_01/flow_constants.py criteo_api_retailmedia_v2024_01/model/__init__.py criteo_api_retailmedia_v2024_01/model/add_funds_to_balance_request.py +criteo_api_retailmedia_v2024_01/model/add_remove_keyword_model.py +criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model.py +criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model_request.py +criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model_resource.py criteo_api_retailmedia_v2024_01/model/add_to_basket_ids_update_model202110_request.py criteo_api_retailmedia_v2024_01/model/add_to_basket_target202110_request.py criteo_api_retailmedia_v2024_01/model/add_to_basket_target202110_response.py criteo_api_retailmedia_v2024_01/model/application_summary_model.py criteo_api_retailmedia_v2024_01/model/application_summary_model_resource.py criteo_api_retailmedia_v2024_01/model/application_summary_model_response.py +criteo_api_retailmedia_v2024_01/model/approval_status_model.py criteo_api_retailmedia_v2024_01/model/asset.py criteo_api_retailmedia_v2024_01/model/asset_resource.py criteo_api_retailmedia_v2024_01/model/asset_response.py @@ -109,6 +114,7 @@ criteo_api_retailmedia_v2024_01/model/external_update_balance_model.py criteo_api_retailmedia_v2024_01/model/files_variable_value.py criteo_api_retailmedia_v2024_01/model/files_variables_specification.py criteo_api_retailmedia_v2024_01/model/hyperlink_variable_value.py +criteo_api_retailmedia_v2024_01/model/input_keywords_model.py criteo_api_retailmedia_v2024_01/model/input_resource_of_auction_line_item_create_model.py criteo_api_retailmedia_v2024_01/model/input_resource_of_preferred_line_item_create_model202110.py criteo_api_retailmedia_v2024_01/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py @@ -128,13 +134,19 @@ criteo_api_retailmedia_v2024_01/model/json_api_request_of_catalog_request.py criteo_api_retailmedia_v2024_01/model/json_api_single_response_of_campaign_v202301.py criteo_api_retailmedia_v2024_01/model/json_api_single_response_of_catalog_status.py criteo_api_retailmedia_v2024_01/model/json_api_single_response_of_line_item_bid_multipliers.py +criteo_api_retailmedia_v2024_01/model/keyword_data_model.py criteo_api_retailmedia_v2024_01/model/keyword_target202110_request.py criteo_api_retailmedia_v2024_01/model/keyword_target202110_response.py +criteo_api_retailmedia_v2024_01/model/keywords_model.py +criteo_api_retailmedia_v2024_01/model/keywords_model_resource.py +criteo_api_retailmedia_v2024_01/model/keywords_model_response.py criteo_api_retailmedia_v2024_01/model/line_item_bid_multipliers.py criteo_api_retailmedia_v2024_01/model/line_item_bid_multipliers_request.py criteo_api_retailmedia_v2024_01/model/line_item_bid_multipliers_response.py criteo_api_retailmedia_v2024_01/model/line_item_budget_overrides.py +criteo_api_retailmedia_v2024_01/model/match_type_model.py criteo_api_retailmedia_v2024_01/model/monthly_line_item_budeget_override.py +criteo_api_retailmedia_v2024_01/model/negotiation_state_model.py criteo_api_retailmedia_v2024_01/model/page_metadata.py criteo_api_retailmedia_v2024_01/model/page_type_environment.py criteo_api_retailmedia_v2024_01/model/post_campaign_v202301.py @@ -145,6 +157,9 @@ criteo_api_retailmedia_v2024_01/model/preferred_line_item_update_model202110_req criteo_api_retailmedia_v2024_01/model/problem_details.py criteo_api_retailmedia_v2024_01/model/promoted_product202110_list_request.py criteo_api_retailmedia_v2024_01/model/promoted_product202110_paged_list_response.py +criteo_api_retailmedia_v2024_01/model/proposal_status_model.py +criteo_api_retailmedia_v2024_01/model/proposal_status_model_resource.py +criteo_api_retailmedia_v2024_01/model/proposal_status_model_response.py criteo_api_retailmedia_v2024_01/model/put_campaign_v202301.py criteo_api_retailmedia_v2024_01/model/report_outcome.py criteo_api_retailmedia_v2024_01/model/resource_of_add_funds_to_balance.py @@ -164,24 +179,8 @@ criteo_api_retailmedia_v2024_01/model/resource_of_preferred_line_item_update_mod criteo_api_retailmedia_v2024_01/model/resource_of_promoted_product202110.py criteo_api_retailmedia_v2024_01/model/resource_of_template.py criteo_api_retailmedia_v2024_01/model/resource_of_update_balance_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keyword_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model_request.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model_resource.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_input_keywords_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keyword_data_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model_resource.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model_response.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_problem_details.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model_resource.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model_response.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_resource_outcome.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bid_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model_request.py -criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model_resource.py +criteo_api_retailmedia_v2024_01/model/resource_outcome.py +criteo_api_retailmedia_v2024_01/model/review_state_model.py criteo_api_retailmedia_v2024_01/model/rm_legacy_audience_create_entity_v1.py criteo_api_retailmedia_v2024_01/model/rm_legacy_audience_create_entity_v1_resource.py criteo_api_retailmedia_v2024_01/model/rm_legacy_audience_create_entity_v1_response.py @@ -202,7 +201,12 @@ criteo_api_retailmedia_v2024_01/model/rm_legacy_segment_customer_list.py criteo_api_retailmedia_v2024_01/model/rm_legacy_segment_user_behavior_create_v2.py criteo_api_retailmedia_v2024_01/model/rm_legacy_segment_user_behavior_v1.py criteo_api_retailmedia_v2024_01/model/rm_legacy_segment_user_behavior_v2.py +criteo_api_retailmedia_v2024_01/model/rmca_common_problem.py criteo_api_retailmedia_v2024_01/model/section.py +criteo_api_retailmedia_v2024_01/model/set_bid_model.py +criteo_api_retailmedia_v2024_01/model/set_bids_model.py +criteo_api_retailmedia_v2024_01/model/set_bids_model_request.py +criteo_api_retailmedia_v2024_01/model/set_bids_model_resource.py criteo_api_retailmedia_v2024_01/model/status_response.py criteo_api_retailmedia_v2024_01/model/status_response_resource.py criteo_api_retailmedia_v2024_01/model/store_ids_update_model202110_request.py @@ -233,6 +237,10 @@ criteo_api_retailmedia_v2024_01/model_utils.py criteo_api_retailmedia_v2024_01/models/__init__.py criteo_api_retailmedia_v2024_01/rest.py docs/AddFundsToBalanceRequest.md +docs/AddRemoveKeywordModel.md +docs/AddRemoveKeywordsModel.md +docs/AddRemoveKeywordsModelRequest.md +docs/AddRemoveKeywordsModelResource.md docs/AddToBasketIdsUpdateModel202110Request.md docs/AddToBasketTarget202110Request.md docs/AddToBasketTarget202110Response.md @@ -240,6 +248,7 @@ docs/AnalyticsApi.md docs/ApplicationSummaryModel.md docs/ApplicationSummaryModelResource.md docs/ApplicationSummaryModelResponse.md +docs/ApprovalStatusModel.md docs/Asset.md docs/AssetResource.md docs/AssetResponse.md @@ -326,6 +335,7 @@ docs/FilesVariableValue.md docs/FilesVariablesSpecification.md docs/GatewayApi.md docs/HyperlinkVariableValue.md +docs/InputKeywordsModel.md docs/InputResourceOfAuctionLineItemCreateModel.md docs/InputResourceOfPreferredLineItemCreateModel202110.md docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md @@ -345,13 +355,19 @@ docs/JsonApiRequestOfCatalogRequest.md docs/JsonApiSingleResponseOfCampaignV202301.md docs/JsonApiSingleResponseOfCatalogStatus.md docs/JsonApiSingleResponseOfLineItemBidMultipliers.md +docs/KeywordDataModel.md docs/KeywordTarget202110Request.md docs/KeywordTarget202110Response.md +docs/KeywordsModel.md +docs/KeywordsModelResource.md +docs/KeywordsModelResponse.md docs/LineItemBidMultipliers.md docs/LineItemBidMultipliersRequest.md docs/LineItemBidMultipliersResponse.md docs/LineItemBudgetOverrides.md +docs/MatchTypeModel.md docs/MonthlyLineItemBudegetOverride.md +docs/NegotiationStateModel.md docs/PageMetadata.md docs/PageTypeEnvironment.md docs/PostCampaignV202301.md @@ -362,6 +378,9 @@ docs/PreferredLineItemUpdateModel202110Request.md docs/ProblemDetails.md docs/PromotedProduct202110ListRequest.md docs/PromotedProduct202110PagedListResponse.md +docs/ProposalStatusModel.md +docs/ProposalStatusModelResource.md +docs/ProposalStatusModelResponse.md docs/PutCampaignV202301.md docs/ReportOutcome.md docs/ResourceOfAddFundsToBalance.md @@ -381,24 +400,8 @@ docs/ResourceOfPreferredLineItemUpdateModel202110.md docs/ResourceOfPromotedProduct202110.md docs/ResourceOfTemplate.md docs/ResourceOfUpdateBalanceModel.md -docs/RetailMediaExternalv1AddRemoveKeywordModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md -docs/RetailMediaExternalv1InputKeywordsModel.md -docs/RetailMediaExternalv1KeywordDataModel.md -docs/RetailMediaExternalv1KeywordsModel.md -docs/RetailMediaExternalv1KeywordsModelResource.md -docs/RetailMediaExternalv1KeywordsModelResponse.md -docs/RetailMediaExternalv1ProblemDetails.md -docs/RetailMediaExternalv1ProposalStatusModel.md -docs/RetailMediaExternalv1ProposalStatusModelResource.md -docs/RetailMediaExternalv1ProposalStatusModelResponse.md -docs/RetailMediaExternalv1ResourceOutcome.md -docs/RetailMediaExternalv1SetBidModel.md -docs/RetailMediaExternalv1SetBidsModel.md -docs/RetailMediaExternalv1SetBidsModelRequest.md -docs/RetailMediaExternalv1SetBidsModelResource.md +docs/ResourceOutcome.md +docs/ReviewStateModel.md docs/RmLegacyAudienceCreateEntityV1.md docs/RmLegacyAudienceCreateEntityV1Resource.md docs/RmLegacyAudienceCreateEntityV1Response.md @@ -419,7 +422,12 @@ docs/RmLegacySegmentCustomerList.md docs/RmLegacySegmentUserBehaviorCreateV2.md docs/RmLegacySegmentUserBehaviorV1.md docs/RmLegacySegmentUserBehaviorV2.md +docs/RmcaCommonProblem.md docs/Section.md +docs/SetBidModel.md +docs/SetBidsModel.md +docs/SetBidsModelRequest.md +docs/SetBidsModelResource.md docs/StatusResponse.md docs/StatusResponseResource.md docs/StoreIdsUpdateModel202110Request.md diff --git a/sdks/retailmedia_2024-01/README.md b/sdks/retailmedia_2024-01/README.md index 3ef28b4b..b66ee961 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.240404 +- Package version: 2024.01.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==2024.01.0.240404 +pip install criteo-api-retailmedia-sdk==2024.01.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python @@ -61,12 +61,17 @@ Class | Method | HTTP request | Description ## Documentation For Models - [AddFundsToBalanceRequest](docs/AddFundsToBalanceRequest.md) + - [AddRemoveKeywordModel](docs/AddRemoveKeywordModel.md) + - [AddRemoveKeywordsModel](docs/AddRemoveKeywordsModel.md) + - [AddRemoveKeywordsModelRequest](docs/AddRemoveKeywordsModelRequest.md) + - [AddRemoveKeywordsModelResource](docs/AddRemoveKeywordsModelResource.md) - [AddToBasketIdsUpdateModel202110Request](docs/AddToBasketIdsUpdateModel202110Request.md) - [AddToBasketTarget202110Request](docs/AddToBasketTarget202110Request.md) - [AddToBasketTarget202110Response](docs/AddToBasketTarget202110Response.md) - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) + - [ApprovalStatusModel](docs/ApprovalStatusModel.md) - [Asset](docs/Asset.md) - [AssetResource](docs/AssetResource.md) - [AssetResponse](docs/AssetResponse.md) @@ -150,6 +155,7 @@ Class | Method | HTTP request | Description - [FilesVariableValue](docs/FilesVariableValue.md) - [FilesVariablesSpecification](docs/FilesVariablesSpecification.md) - [HyperlinkVariableValue](docs/HyperlinkVariableValue.md) + - [InputKeywordsModel](docs/InputKeywordsModel.md) - [InputResourceOfAuctionLineItemCreateModel](docs/InputResourceOfAuctionLineItemCreateModel.md) - [InputResourceOfPreferredLineItemCreateModel202110](docs/InputResourceOfPreferredLineItemCreateModel202110.md) - [JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301](docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md) @@ -169,13 +175,19 @@ Class | Method | HTTP request | Description - [JsonApiSingleResponseOfCampaignV202301](docs/JsonApiSingleResponseOfCampaignV202301.md) - [JsonApiSingleResponseOfCatalogStatus](docs/JsonApiSingleResponseOfCatalogStatus.md) - [JsonApiSingleResponseOfLineItemBidMultipliers](docs/JsonApiSingleResponseOfLineItemBidMultipliers.md) + - [KeywordDataModel](docs/KeywordDataModel.md) - [KeywordTarget202110Request](docs/KeywordTarget202110Request.md) - [KeywordTarget202110Response](docs/KeywordTarget202110Response.md) + - [KeywordsModel](docs/KeywordsModel.md) + - [KeywordsModelResource](docs/KeywordsModelResource.md) + - [KeywordsModelResponse](docs/KeywordsModelResponse.md) - [LineItemBidMultipliers](docs/LineItemBidMultipliers.md) - [LineItemBidMultipliersRequest](docs/LineItemBidMultipliersRequest.md) - [LineItemBidMultipliersResponse](docs/LineItemBidMultipliersResponse.md) - [LineItemBudgetOverrides](docs/LineItemBudgetOverrides.md) + - [MatchTypeModel](docs/MatchTypeModel.md) - [MonthlyLineItemBudegetOverride](docs/MonthlyLineItemBudegetOverride.md) + - [NegotiationStateModel](docs/NegotiationStateModel.md) - [PageMetadata](docs/PageMetadata.md) - [PageTypeEnvironment](docs/PageTypeEnvironment.md) - [PostCampaignV202301](docs/PostCampaignV202301.md) @@ -186,6 +198,9 @@ Class | Method | HTTP request | Description - [ProblemDetails](docs/ProblemDetails.md) - [PromotedProduct202110ListRequest](docs/PromotedProduct202110ListRequest.md) - [PromotedProduct202110PagedListResponse](docs/PromotedProduct202110PagedListResponse.md) + - [ProposalStatusModel](docs/ProposalStatusModel.md) + - [ProposalStatusModelResource](docs/ProposalStatusModelResource.md) + - [ProposalStatusModelResponse](docs/ProposalStatusModelResponse.md) - [PutCampaignV202301](docs/PutCampaignV202301.md) - [ReportOutcome](docs/ReportOutcome.md) - [ResourceOfAddFundsToBalance](docs/ResourceOfAddFundsToBalance.md) @@ -205,24 +220,8 @@ Class | Method | HTTP request | Description - [ResourceOfPromotedProduct202110](docs/ResourceOfPromotedProduct202110.md) - [ResourceOfTemplate](docs/ResourceOfTemplate.md) - [ResourceOfUpdateBalanceModel](docs/ResourceOfUpdateBalanceModel.md) - - [RetailMediaExternalv1AddRemoveKeywordModel](docs/RetailMediaExternalv1AddRemoveKeywordModel.md) - - [RetailMediaExternalv1AddRemoveKeywordsModel](docs/RetailMediaExternalv1AddRemoveKeywordsModel.md) - - [RetailMediaExternalv1AddRemoveKeywordsModelRequest](docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md) - - [RetailMediaExternalv1AddRemoveKeywordsModelResource](docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md) - - [RetailMediaExternalv1InputKeywordsModel](docs/RetailMediaExternalv1InputKeywordsModel.md) - - [RetailMediaExternalv1KeywordDataModel](docs/RetailMediaExternalv1KeywordDataModel.md) - - [RetailMediaExternalv1KeywordsModel](docs/RetailMediaExternalv1KeywordsModel.md) - - [RetailMediaExternalv1KeywordsModelResource](docs/RetailMediaExternalv1KeywordsModelResource.md) - - [RetailMediaExternalv1KeywordsModelResponse](docs/RetailMediaExternalv1KeywordsModelResponse.md) - - [RetailMediaExternalv1ProblemDetails](docs/RetailMediaExternalv1ProblemDetails.md) - - [RetailMediaExternalv1ProposalStatusModel](docs/RetailMediaExternalv1ProposalStatusModel.md) - - [RetailMediaExternalv1ProposalStatusModelResource](docs/RetailMediaExternalv1ProposalStatusModelResource.md) - - [RetailMediaExternalv1ProposalStatusModelResponse](docs/RetailMediaExternalv1ProposalStatusModelResponse.md) - - [RetailMediaExternalv1ResourceOutcome](docs/RetailMediaExternalv1ResourceOutcome.md) - - [RetailMediaExternalv1SetBidModel](docs/RetailMediaExternalv1SetBidModel.md) - - [RetailMediaExternalv1SetBidsModel](docs/RetailMediaExternalv1SetBidsModel.md) - - [RetailMediaExternalv1SetBidsModelRequest](docs/RetailMediaExternalv1SetBidsModelRequest.md) - - [RetailMediaExternalv1SetBidsModelResource](docs/RetailMediaExternalv1SetBidsModelResource.md) + - [ResourceOutcome](docs/ResourceOutcome.md) + - [ReviewStateModel](docs/ReviewStateModel.md) - [RmLegacyAudienceCreateEntityV1](docs/RmLegacyAudienceCreateEntityV1.md) - [RmLegacyAudienceCreateEntityV1Resource](docs/RmLegacyAudienceCreateEntityV1Resource.md) - [RmLegacyAudienceCreateEntityV1Response](docs/RmLegacyAudienceCreateEntityV1Response.md) @@ -243,7 +242,12 @@ Class | Method | HTTP request | Description - [RmLegacySegmentUserBehaviorCreateV2](docs/RmLegacySegmentUserBehaviorCreateV2.md) - [RmLegacySegmentUserBehaviorV1](docs/RmLegacySegmentUserBehaviorV1.md) - [RmLegacySegmentUserBehaviorV2](docs/RmLegacySegmentUserBehaviorV2.md) + - [RmcaCommonProblem](docs/RmcaCommonProblem.md) - [Section](docs/Section.md) + - [SetBidModel](docs/SetBidModel.md) + - [SetBidsModel](docs/SetBidsModel.md) + - [SetBidsModelRequest](docs/SetBidsModelRequest.md) + - [SetBidsModelResource](docs/SetBidsModelResource.md) - [StatusResponse](docs/StatusResponse.md) - [StatusResponseResource](docs/StatusResponseResource.md) - [StoreIdsUpdateModel202110Request](docs/StoreIdsUpdateModel202110Request.md) 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 951e84b6..52174028 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.240404" +__version__ = "2024.01.0.240515" # 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/campaign_api.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/api/campaign_api.py index a44068c4..a27c5e9f 100644 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/api/campaign_api.py +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/api/campaign_api.py @@ -22,6 +22,7 @@ validate_and_convert_types ) from criteo_api_retailmedia_v2024_01.model.add_funds_to_balance_request import AddFundsToBalanceRequest +from criteo_api_retailmedia_v2024_01.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest from criteo_api_retailmedia_v2024_01.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request from criteo_api_retailmedia_v2024_01.model.add_to_basket_target202110_request import AddToBasketTarget202110Request from criteo_api_retailmedia_v2024_01.model.add_to_basket_target202110_response import AddToBasketTarget202110Response @@ -59,6 +60,7 @@ from criteo_api_retailmedia_v2024_01.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers from criteo_api_retailmedia_v2024_01.model.keyword_target202110_request import KeywordTarget202110Request from criteo_api_retailmedia_v2024_01.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2024_01.model.keywords_model_response import KeywordsModelResponse from criteo_api_retailmedia_v2024_01.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_v2024_01.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse from criteo_api_retailmedia_v2024_01.model.post_campaign_v202301 import PostCampaignV202301 @@ -68,12 +70,10 @@ from criteo_api_retailmedia_v2024_01.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request from criteo_api_retailmedia_v2024_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest from criteo_api_retailmedia_v2024_01.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2024_01.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_v2024_01.model.put_campaign_v202301 import PutCampaignV202301 -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_v2024_01.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2024_01.model.set_bids_model_request import SetBidsModelRequest from criteo_api_retailmedia_v2024_01.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request from criteo_api_retailmedia_v2024_01.model.store_target202110_request import StoreTarget202110Request from criteo_api_retailmedia_v2024_01.model.store_target202110_response import StoreTarget202110Response @@ -99,7 +99,7 @@ def __init__(self, api_client=None): self.api_client = api_client self.add_remove_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -112,7 +112,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_add_remove_keywords_model_request', + 'add_remove_keywords_model_request', ], 'required': [ 'id', @@ -132,24 +132,22 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_add_remove_keywords_model_request': - (RetailMediaExternalv1AddRemoveKeywordsModelRequest,), + 'add_remove_keywords_model_request': + (AddRemoveKeywordsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_add_remove_keywords_model_request': 'body', + 'add_remove_keywords_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [ 'application/json' @@ -215,7 +213,7 @@ def __init__(self, api_client=None): ) self.fetch_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1KeywordsModelResponse,), + 'response_type': (KeywordsModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -259,9 +257,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -269,7 +265,7 @@ def __init__(self, api_client=None): ) self.fetch_proposal_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -313,9 +309,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -4030,7 +4024,7 @@ def __init__(self, api_client=None): ) self.set_keyword_bids_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -4043,7 +4037,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_set_bids_model_request', + 'set_bids_model_request', ], 'required': [ 'id', @@ -4063,24 +4057,22 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_set_bids_model_request': - (RetailMediaExternalv1SetBidsModelRequest,), + 'set_bids_model_request': + (SetBidsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_set_bids_model_request': 'body', + 'set_bids_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [ 'application/json' @@ -4090,7 +4082,7 @@ def __init__(self, api_client=None): ) self.submit_proposal_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -4134,9 +4126,7 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -4272,7 +4262,7 @@ def add_remove_keywords( ): """add_remove_keywords # noqa: E501 - Add or Remove keywords from the associated line item in bulk # noqa: E501 + Add or Remove keywords from the line item in bulk # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -4280,10 +4270,10 @@ def add_remove_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_add_remove_keywords_model_request (RetailMediaExternalv1AddRemoveKeywordsModelRequest): Object containing keywords to be added or removed. [optional] + add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [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 @@ -4316,7 +4306,7 @@ def add_remove_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -4447,7 +4437,7 @@ def fetch_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -4482,7 +4472,7 @@ def fetch_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1KeywordsModelResponse + KeywordsModelResponse If the method is called asynchronously, returns the request thread. """ @@ -4522,7 +4512,7 @@ def fetch_proposal( ): """fetch_proposal # noqa: E501 - Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501 + Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -4530,7 +4520,7 @@ def fetch_proposal( >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -4565,7 +4555,7 @@ def fetch_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ @@ -9928,10 +9918,10 @@ def set_keyword_bids( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_set_bids_model_request (RetailMediaExternalv1SetBidsModelRequest): Object containing a list of bid overrides for associated keywords. [optional] + set_bids_model_request (SetBidsModelRequest): [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 @@ -9964,7 +9954,7 @@ def set_keyword_bids( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -10004,7 +9994,7 @@ def submit_proposal( ): """submit_proposal # noqa: E501 - Submit a proposal to modify a Preferred Deal Line Item for review. # noqa: E501 + Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -10012,7 +10002,7 @@ def submit_proposal( >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -10047,7 +10037,7 @@ def submit_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ 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 d817f288..f046cde7 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.240404/python' + self.user_agent = 'OpenAPI-Generator/2024.01.0.240515/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 09995b8c..d23571c2 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.240404".\ + "SDK Package Version: 2024.01.0.240515".\ 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/add_remove_keyword_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keyword_model.py new file mode 100644 index 00000000..04b238dd --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keyword_model.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.match_type_model import MatchTypeModel + globals()['MatchTypeModel'] = MatchTypeModel + + +class AddRemoveKeywordModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'is_deleted': (bool, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'is_deleted': 'isDeleted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model.py new file mode 100644 index 00000000..41eb6ebd --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.add_remove_keyword_model import AddRemoveKeywordModel + globals()['AddRemoveKeywordModel'] = AddRemoveKeywordModel + + +class AddRemoveKeywordsModel(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 { + 'keywords': ([AddRemoveKeywordModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model_request.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model_request.py new file mode 100644 index 00000000..2965079b --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource + globals()['AddRemoveKeywordsModelResource'] = AddRemoveKeywordsModelResource + + +class AddRemoveKeywordsModelRequest(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': (AddRemoveKeywordsModelResource,), # 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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model_resource.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model_resource.py new file mode 100644 index 00000000..f481e074 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/add_remove_keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.add_remove_keywords_model import AddRemoveKeywordsModel + globals()['AddRemoveKeywordsModel'] = AddRemoveKeywordsModel + + +class AddRemoveKeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (AddRemoveKeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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_2024-01/criteo_api_retailmedia_v2024_01/model/approval_status_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/approval_status_model.py new file mode 100644 index 00000000..117ded2d --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/approval_status_model.py @@ -0,0 +1,292 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + + +class ApprovalStatusModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'NOTSUBMITTED': "NotSubmitted", + 'SUBMITTED': "Submitted", + 'REJECTED': "Rejected", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return 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 77d464e9..57fd4532 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 @@ -57,11 +57,13 @@ class AsyncCampaignsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncCampaignsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncCampaignsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncCampaignsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 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 8d63baa8..e14d00f1 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 @@ -57,11 +57,13 @@ class AsyncLineItemsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncLineItemsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncLineItemsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncLineItemsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 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 2a86ea10..b7a9dc15 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,6 +68,26 @@ class AsyncRevenueReport(ModelNormal): 'AUCTION': "auction", 'PREFERRED': "preferred", }, + ('sold_by',): { + 'None': None, + 'DIRECTSOLD': "directSold", + 'INDIRECTSOLD': "indirectSold", + 'PRIVATEMARKET': "privateMarket", + }, + ('buy_type',): { + 'None': None, + 'AUCTION': "auction", + 'PREFERREDDEALS': "preferredDeals", + 'SPONSORSHIP': "sponsorship", + }, + ('sku_relations',): { + 'None': None, + 'SAMESKU': "sameSku", + 'SAMEPARENTSKU': "sameParentSku", + 'SAMECATEGORY': "sameCategory", + 'SAMEBRAND': "sameBrand", + 'SAMESELLER': "sameSeller", + }, ('format',): { 'None': None, 'JSON': "json", @@ -75,72 +95,123 @@ class AsyncRevenueReport(ModelNormal): 'JSON-NEWLINE': "json-newline", 'CSV': "csv", }, - ('sold_by',): { + ('campaign_type',): { 'None': None, - 'DIRECTSOLD': "directSold", - 'INDIRECTSOLD': "indirectSold", - 'PRIVATEMARKET': "privateMarket", + 'ALL': "all", + 'SPONSOREDPRODUCTS': "sponsoredProducts", + 'ONSITEDISPLAYS': "onSiteDisplays", }, - ('campaign_sub_type',): { + ('sales_channel',): { 'None': None, - 'AUCTIONANDPREFERRED': "auctionAndPreferred", - 'LOCKOUT': "lockout", + 'ALL': "all", + 'OFFLINE': "offline", + 'ONLINE': "online", }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + '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, 'DATE': "date", - 'CAMPAIGNID': "campaignId", - 'CAMPAIGNNAME': "campaignName", + 'HOUR': "hour", + 'PARENTACCOUNT': "parentAccount", 'ACCOUNTID': "accountId", 'ACCOUNTNAME': "accountName", - 'ENVIRONMENT': "environment", - 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ACCOUNTTYPENAME': "accountTypeName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'CAMPAIGNSTARTDATE': "campaignStartDate", + 'CAMPAIGNENDDATE': "campaignEndDate", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'LINEITEMSTARTDATE': "lineItemStartDate", + 'LINEITEMENDDATE': "lineItemEndDate", + 'LINEITEMSTATUS': "lineItemStatus", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", 'BRANDID': "brandId", 'BRANDNAME': "brandName", + 'PLACEMENTID': "placementId", + 'PLACEMENTNAME': "placementName", 'PAGETYPENAME': "pageTypeName", + 'ENVIRONMENT': "environment", + 'PAGECATEGORY': "pageCategory", + 'ADVPRODUCTID': "advProductId", 'ADVPRODUCTNAME': "advProductName", 'ADVPRODUCTGTIN': "advProductGtin", 'ADVPRODUCTMPN': "advProductMpn", - 'ADVPRODUCTID': "advProductId", + 'SOLDBY': "soldBy", + 'SALECHANNEL': "saleChannel", + 'ATTRIBUTIONSETTINGS': "attributionSettings", + 'ACTIVITYTYPE': "activityType", + 'KEYWORD': "keyword", + 'SKURELATION': "skuRelation", + 'RETAILERCATEGORYID': "retailerCategoryId", + 'RETAILERCATEGORYNAME': "retailerCategoryName", + 'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb", + 'TAXONOMY1ID': "taxonomy1Id", + 'TAXONOMY1NAME': "taxonomy1Name", + 'TAXONOMY2ID': "taxonomy2Id", + 'TAXONOMY2NAME': "taxonomy2Name", + 'TAXONOMY3ID': "taxonomy3Id", + 'TAXONOMY3NAME': "taxonomy3Name", + 'TAXONOMY4ID': "taxonomy4Id", + 'TAXONOMY4NAME': "taxonomy4Name", + 'TAXONOMY5ID': "taxonomy5Id", + 'TAXONOMY5NAME': "taxonomy5Name", + 'TAXONOMY6ID': "taxonomy6Id", + 'TAXONOMY6NAME': "taxonomy6Name", + 'TAXONOMY7ID': "taxonomy7Id", + 'TAXONOMY7NAME': "taxonomy7Name", }, ('metrics',): { 'None': None, + 'NUMBEROFCAMPAIGNS': "numberOfCampaigns", + 'NUMBEROFLINEITEMS': "numberOfLineItems", + 'NUMBEROFSKUS': "numberOfSkus", + 'SKUPRICE': "skuPrice", + 'PAGEVIEWS': "pageViews", 'IMPRESSIONS': "impressions", + 'PRODUCTCLICKS': "productClicks", + 'PLACEMENTCLICKS': "placementClicks", 'CLICKS': "clicks", - 'SPEND': "spend", 'SALES': "sales", 'UNITS': "units", - 'CPO': "cpo", - 'ROAS': "roas", + 'TRANSACTIONS': "transactions", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", 'OPENAUCTIONREVENUE': "openAuctionRevenue", 'PREFERREDDEALSREVENUE': "preferredDealsRevenue", - 'AVGCPC': "avgCpc", - 'AVGCPM': "avgCpm", + 'CTR': "ctr", + 'CR': "cr", + 'CPC': "cpc", + 'CPM': "cpm", + 'ROAS': "roas", + 'WORKINGMEDIA': "workingMedia", + 'NETREVENUE': "netRevenue", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", }, } @@ -174,13 +245,14 @@ def openapi_types(): 'id': (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 - 'click_attribution_window': (str, none_type,), # noqa: E501 - 'view_attribution_window': (str, none_type,), # noqa: E501 + 'buy_type': (str, none_type,), # noqa: E501 + 'sku_relations': ([str], none_type,), # noqa: E501 + 'format': (str, none_type,), # noqa: E501 'campaign_type': (str, none_type,), # noqa: E501 'sales_channel': (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 @@ -198,13 +270,14 @@ def discriminator(): 'id': 'id', # 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 - 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 - 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 + 'buy_type': 'buyType', # noqa: E501 + 'sku_relations': 'skuRelations', # noqa: E501 + 'format': 'format', # noqa: E501 'campaign_type': 'campaignType', # noqa: E501 'sales_channel': 'salesChannel', # 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 @@ -259,13 +332,14 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 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 + sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional] # noqa: E501 + buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional] # noqa: E501 + sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -364,13 +438,14 @@ def __init__(self, start_date, end_date, *args, **kwargs): # 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 + sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional] # noqa: E501 + buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional] # noqa: E501 + sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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_2024-01/criteo_api_retailmedia_v2024_01/model/input_keywords_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/input_keywords_model.py new file mode 100644 index 00000000..1b925eed --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/input_keywords_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + + +class InputKeywordsModel(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 { + 'negative_broad': ([str], none_type,), # noqa: E501 + 'negative_exact': ([str], none_type,), # noqa: E501 + 'positive_exact': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negative_broad': 'negativeBroad', # noqa: E501 + 'negative_exact': 'negativeExact', # noqa: E501 + 'positive_exact': 'positiveExact', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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_2024-01/criteo_api_retailmedia_v2024_01/model/keyword_data_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/keyword_data_model.py new file mode 100644 index 00000000..eac0fa1b --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/keyword_data_model.py @@ -0,0 +1,286 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.input_keywords_model import InputKeywordsModel + from criteo_api_retailmedia_v2024_01.model.match_type_model import MatchTypeModel + from criteo_api_retailmedia_v2024_01.model.review_state_model import ReviewStateModel + globals()['InputKeywordsModel'] = InputKeywordsModel + globals()['MatchTypeModel'] = MatchTypeModel + globals()['ReviewStateModel'] = ReviewStateModel + + +class KeywordDataModel(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 { + 'review_state': (ReviewStateModel,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + 'input_keywords': (InputKeywordsModel,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'review_state': 'reviewState', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'bid': 'bid', # noqa: E501 + 'input_keywords': 'inputKeywords', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model.py new file mode 100644 index 00000000..e88aa388 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.keyword_data_model import KeywordDataModel + globals()['KeywordDataModel'] = KeywordDataModel + + +class KeywordsModel(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 { + 'keywords': ({str: (KeywordDataModel,)}, none_type,), # noqa: E501 + 'rank': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + 'rank': 'rank', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model_resource.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model_resource.py new file mode 100644 index 00000000..78162fbf --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.keywords_model import KeywordsModel + globals()['KeywordsModel'] = KeywordsModel + + +class KeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (KeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model_response.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model_response.py new file mode 100644 index 00000000..7f6888e3 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/keywords_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.keywords_model_resource import KeywordsModelResource + from criteo_api_retailmedia_v2024_01.model.rmca_common_problem import RmcaCommonProblem + globals()['KeywordsModelResource'] = KeywordsModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class KeywordsModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (KeywordsModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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_2024-01/criteo_api_retailmedia_v2024_01/model/match_type_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/match_type_model.py new file mode 100644 index 00000000..c1567fb7 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/match_type_model.py @@ -0,0 +1,291 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + + +class MatchTypeModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'POSITIVEEXACTMATCH': "PositiveExactMatch", + 'NEGATIVEEXACTMATCH': "NegativeExactMatch", + 'NEGATIVEBROADMATCH': "NegativeBroadMatch", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/negotiation_state_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/negotiation_state_model.py new file mode 100644 index 00000000..48374c21 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/negotiation_state_model.py @@ -0,0 +1,293 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + + +class NegotiationStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INVALID': "Invalid", + 'MODIFIED': "Modified", + 'SUBMITTED': "Submitted", + 'REVIEWED': "Reviewed", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model.py new file mode 100644 index 00000000..3978a103 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model.py @@ -0,0 +1,284 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.approval_status_model import ApprovalStatusModel + from criteo_api_retailmedia_v2024_01.model.negotiation_state_model import NegotiationStateModel + globals()['ApprovalStatusModel'] = ApprovalStatusModel + globals()['NegotiationStateModel'] = NegotiationStateModel + + +class ProposalStatusModel(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 { + 'negotiation_state': (NegotiationStateModel,), # noqa: E501 + 'booking_status': (ApprovalStatusModel,), # noqa: E501 + 'runnable_status': (ApprovalStatusModel,), # noqa: E501 + 'comment': (str, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negotiation_state': 'negotiationState', # noqa: E501 + 'booking_status': 'bookingStatus', # noqa: E501 + 'runnable_status': 'runnableStatus', # noqa: E501 + 'comment': 'comment', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model_resource.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model_resource.py new file mode 100644 index 00000000..d9818560 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.proposal_status_model import ProposalStatusModel + globals()['ProposalStatusModel'] = ProposalStatusModel + + +class ProposalStatusModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (ProposalStatusModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model_response.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model_response.py new file mode 100644 index 00000000..64754008 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/proposal_status_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.proposal_status_model_resource import ProposalStatusModelResource + from criteo_api_retailmedia_v2024_01.model.rmca_common_problem import RmcaCommonProblem + globals()['ProposalStatusModelResource'] = ProposalStatusModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ProposalStatusModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (ProposalStatusModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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_2024-01/criteo_api_retailmedia_v2024_01/model/resource_outcome.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/resource_outcome.py new file mode 100644 index 00000000..a6a2d2de --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/resource_outcome.py @@ -0,0 +1,268 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.rmca_common_problem import RmcaCommonProblem + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ResourceOutcome(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keyword_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keyword_model.py deleted file mode 100644 index 9594e9cf..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keyword_model.py +++ /dev/null @@ -1,281 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1AddRemoveKeywordModel(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 = { - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - validations = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'is_deleted': (bool, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'is_deleted': 'isDeleted', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model.py deleted file mode 100644 index 1193a28f..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel - globals()['RetailMediaExternalv1AddRemoveKeywordModel'] = RetailMediaExternalv1AddRemoveKeywordModel - - -class RetailMediaExternalv1AddRemoveKeywordsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1AddRemoveKeywordModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model_request.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model_request.py deleted file mode 100644 index 91ade709..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource - globals()['RetailMediaExternalv1AddRemoveKeywordsModelResource'] = RetailMediaExternalv1AddRemoveKeywordsModelResource - - -class RetailMediaExternalv1AddRemoveKeywordsModelRequest(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': (RetailMediaExternalv1AddRemoveKeywordsModelResource,), # 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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model_resource.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model_resource.py deleted file mode 100644 index 920c67c7..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_add_remove_keywords_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel - globals()['RetailMediaExternalv1AddRemoveKeywordsModel'] = RetailMediaExternalv1AddRemoveKeywordsModel - - -class RetailMediaExternalv1AddRemoveKeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1AddRemoveKeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_input_keywords_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_input_keywords_model.py deleted file mode 100644 index 58fcfde4..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_input_keywords_model.py +++ /dev/null @@ -1,277 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1InputKeywordsModel(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 = { - ('negative_broad',): { - }, - ('negative_exact',): { - }, - ('positive_exact',): { - }, - } - - @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 { - 'negative_broad': ([str], none_type,), # noqa: E501 - 'negative_exact': ([str], none_type,), # noqa: E501 - 'positive_exact': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negative_broad': 'negativeBroad', # noqa: E501 - 'negative_exact': 'negativeExact', # noqa: E501 - 'positive_exact': 'positiveExact', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keyword_data_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keyword_data_model.py deleted file mode 100644 index 751bfa4c..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keyword_data_model.py +++ /dev/null @@ -1,304 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel - globals()['RetailMediaExternalv1InputKeywordsModel'] = RetailMediaExternalv1InputKeywordsModel - - -class RetailMediaExternalv1KeywordDataModel(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 = { - ('review_state',): { - 'None': None, - 'INREVIEW': "InReview", - 'RECOMMENDED': "Recommended", - 'APPROVED': "Approved", - 'AUTOAPPROVED': "AutoApproved", - 'REJECTED': "Rejected", - 'AUTOREJECTED': "AutoRejected", - }, - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - 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 { - 'review_state': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - 'input_keywords': (RetailMediaExternalv1InputKeywordsModel,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'review_state': 'reviewState', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'bid': 'bid', # noqa: E501 - 'input_keywords': 'inputKeywords', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model.py deleted file mode 100644 index 73da3792..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model.py +++ /dev/null @@ -1,275 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel - globals()['RetailMediaExternalv1KeywordDataModel'] = RetailMediaExternalv1KeywordDataModel - - -class RetailMediaExternalv1KeywordsModel(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 = { - ('rank',): { - }, - } - - @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 { - 'keywords': (RetailMediaExternalv1KeywordDataModel,), # noqa: E501 - 'rank': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - 'rank': 'rank', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model_resource.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model_resource.py deleted file mode 100644 index 84685af0..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel - globals()['RetailMediaExternalv1KeywordsModel'] = RetailMediaExternalv1KeywordsModel - - -class RetailMediaExternalv1KeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1KeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model_response.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model_response.py deleted file mode 100644 index fa1c8d71..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_keywords_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1KeywordsModelResource'] = RetailMediaExternalv1KeywordsModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1KeywordsModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1KeywordsModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_problem_details.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_problem_details.py deleted file mode 100644 index 44d6732d..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_problem_details.py +++ /dev/null @@ -1,295 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1ProblemDetails(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 ({str: (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_identifier': (str, none_type,), # noqa: E501 - 'code': (str, none_type,), # noqa: E501 - 'source': ({str: (str,)}, none_type,), # noqa: E501 - 'stack_trace': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'status': (int, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'instance': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'code': 'code', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - 'type': 'type', # noqa: E501 - 'title': 'title', # noqa: E501 - 'status': 'status', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'instance': 'instance', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model.py deleted file mode 100644 index 1595c0f2..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1ProposalStatusModel(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 = { - ('negotiation_state',): { - 'INVALID': "Invalid", - 'MODIFIED': "Modified", - 'SUBMITTED': "Submitted", - 'REVIEWED': "Reviewed", - 'APPROVED': "Approved", - }, - ('booking_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - ('runnable_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - } - - 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 { - 'negotiation_state': (str,), # noqa: E501 - 'booking_status': (str,), # noqa: E501 - 'runnable_status': (str,), # noqa: E501 - 'comment': (str, none_type,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negotiation_state': 'negotiationState', # noqa: E501 - 'booking_status': 'bookingStatus', # noqa: E501 - 'runnable_status': 'runnableStatus', # noqa: E501 - 'comment': 'comment', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model_resource.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model_resource.py deleted file mode 100644 index 3dcb5488..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel - globals()['RetailMediaExternalv1ProposalStatusModel'] = RetailMediaExternalv1ProposalStatusModel - - -class RetailMediaExternalv1ProposalStatusModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1ProposalStatusModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model_response.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model_response.py deleted file mode 100644 index c88a82e6..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_proposal_status_model_response.py +++ /dev/null @@ -1,285 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProposalStatusModelResource'] = RetailMediaExternalv1ProposalStatusModelResource - - -class RetailMediaExternalv1ProposalStatusModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1ProposalStatusModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_resource_outcome.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_resource_outcome.py deleted file mode 100644 index d93d1dc3..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_resource_outcome.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1ResourceOutcome(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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 { - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'errors': 'errors', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - } - - read_only_vars = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bid_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bid_model.py deleted file mode 100644 index 732f188b..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bid_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - - -class RetailMediaExternalv1SetBidModel(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 = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'bid': 'bid', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model.py deleted file mode 100644 index ceff7f94..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model.py +++ /dev/null @@ -1,271 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel - globals()['RetailMediaExternalv1SetBidModel'] = RetailMediaExternalv1SetBidModel - - -class RetailMediaExternalv1SetBidsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1SetBidModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model_request.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model_request.py deleted file mode 100644 index 5adfa3f8..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model_request.py +++ /dev/null @@ -1,269 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource - globals()['RetailMediaExternalv1SetBidsModelResource'] = RetailMediaExternalv1SetBidsModelResource - - -class RetailMediaExternalv1SetBidsModelRequest(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': (RetailMediaExternalv1SetBidsModelResource,), # 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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model_resource.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model_resource.py deleted file mode 100644 index 6a70d094..00000000 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/retail_media_externalv1_set_bids_model_resource.py +++ /dev/null @@ -1,283 +0,0 @@ -""" - Criteo API - - Criteo API - RetailMedia # noqa: E501 - - The version of the OpenAPI document: 2024-01 - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError - - -def lazy_import(): - from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel - globals()['RetailMediaExternalv1SetBidsModel'] = RetailMediaExternalv1SetBidsModel - - -class RetailMediaExternalv1SetBidsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1SetBidsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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_2024-01/criteo_api_retailmedia_v2024_01/model/review_state_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/review_state_model.py new file mode 100644 index 00000000..917d759c --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/review_state_model.py @@ -0,0 +1,294 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + + +class ReviewStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INREVIEW': "InReview", + 'RECOMMENDED': "Recommended", + 'APPROVED': "Approved", + 'AUTOAPPROVED': "AutoApproved", + 'REJECTED': "Rejected", + 'AUTOREJECTED': "AutoRejected", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/rmca_common_problem.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/rmca_common_problem.py new file mode 100644 index 00000000..04659f3a --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/rmca_common_problem.py @@ -0,0 +1,306 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + + +class RmcaCommonProblem(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + 'status': (int, none_type,), # 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 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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_2024-01/criteo_api_retailmedia_v2024_01/model/set_bid_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/set_bid_model.py new file mode 100644 index 00000000..44a00c36 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/set_bid_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + + +class SetBidModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'bid': 'bid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model.py new file mode 100644 index 00000000..1bde6a82 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.set_bid_model import SetBidModel + globals()['SetBidModel'] = SetBidModel + + +class SetBidsModel(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 { + 'keywords': ([SetBidModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model_request.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model_request.py new file mode 100644 index 00000000..358c4f75 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.set_bids_model_resource import SetBidsModelResource + globals()['SetBidsModelResource'] = SetBidsModelResource + + +class SetBidsModelRequest(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': (SetBidsModelResource,), # 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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model_resource.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model_resource.py new file mode 100644 index 00000000..80ddc1f7 --- /dev/null +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/model/set_bids_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-01 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_01.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_v2024_01.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_01.model.set_bids_model import SetBidsModel + globals()['SetBidsModel'] = SetBidsModel + + +class SetBidsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (SetBidsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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_2024-01/criteo_api_retailmedia_v2024_01/models/__init__.py b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/models/__init__.py index 4fcde648..d79b65e5 100644 --- a/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/models/__init__.py +++ b/sdks/retailmedia_2024-01/criteo_api_retailmedia_v2024_01/models/__init__.py @@ -10,12 +10,17 @@ # sys.setrecursionlimit(n) from criteo_api_retailmedia_v2024_01.model.add_funds_to_balance_request import AddFundsToBalanceRequest +from criteo_api_retailmedia_v2024_01.model.add_remove_keyword_model import AddRemoveKeywordModel +from criteo_api_retailmedia_v2024_01.model.add_remove_keywords_model import AddRemoveKeywordsModel +from criteo_api_retailmedia_v2024_01.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2024_01.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource from criteo_api_retailmedia_v2024_01.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request from criteo_api_retailmedia_v2024_01.model.add_to_basket_target202110_request import AddToBasketTarget202110Request from criteo_api_retailmedia_v2024_01.model.add_to_basket_target202110_response import AddToBasketTarget202110Response from criteo_api_retailmedia_v2024_01.model.application_summary_model import ApplicationSummaryModel from criteo_api_retailmedia_v2024_01.model.application_summary_model_resource import ApplicationSummaryModelResource from criteo_api_retailmedia_v2024_01.model.application_summary_model_response import ApplicationSummaryModelResponse +from criteo_api_retailmedia_v2024_01.model.approval_status_model import ApprovalStatusModel from criteo_api_retailmedia_v2024_01.model.asset import Asset from criteo_api_retailmedia_v2024_01.model.asset_resource import AssetResource from criteo_api_retailmedia_v2024_01.model.asset_response import AssetResponse @@ -99,6 +104,7 @@ from criteo_api_retailmedia_v2024_01.model.files_variable_value import FilesVariableValue from criteo_api_retailmedia_v2024_01.model.files_variables_specification import FilesVariablesSpecification from criteo_api_retailmedia_v2024_01.model.hyperlink_variable_value import HyperlinkVariableValue +from criteo_api_retailmedia_v2024_01.model.input_keywords_model import InputKeywordsModel from criteo_api_retailmedia_v2024_01.model.input_resource_of_auction_line_item_create_model import InputResourceOfAuctionLineItemCreateModel from criteo_api_retailmedia_v2024_01.model.input_resource_of_preferred_line_item_create_model202110 import InputResourceOfPreferredLineItemCreateModel202110 from criteo_api_retailmedia_v2024_01.model.json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 @@ -118,13 +124,19 @@ from criteo_api_retailmedia_v2024_01.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 from criteo_api_retailmedia_v2024_01.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus from criteo_api_retailmedia_v2024_01.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers +from criteo_api_retailmedia_v2024_01.model.keyword_data_model import KeywordDataModel from criteo_api_retailmedia_v2024_01.model.keyword_target202110_request import KeywordTarget202110Request from criteo_api_retailmedia_v2024_01.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2024_01.model.keywords_model import KeywordsModel +from criteo_api_retailmedia_v2024_01.model.keywords_model_resource import KeywordsModelResource +from criteo_api_retailmedia_v2024_01.model.keywords_model_response import KeywordsModelResponse from criteo_api_retailmedia_v2024_01.model.line_item_bid_multipliers import LineItemBidMultipliers from criteo_api_retailmedia_v2024_01.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest from criteo_api_retailmedia_v2024_01.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse from criteo_api_retailmedia_v2024_01.model.line_item_budget_overrides import LineItemBudgetOverrides +from criteo_api_retailmedia_v2024_01.model.match_type_model import MatchTypeModel from criteo_api_retailmedia_v2024_01.model.monthly_line_item_budeget_override import MonthlyLineItemBudegetOverride +from criteo_api_retailmedia_v2024_01.model.negotiation_state_model import NegotiationStateModel from criteo_api_retailmedia_v2024_01.model.page_metadata import PageMetadata from criteo_api_retailmedia_v2024_01.model.page_type_environment import PageTypeEnvironment from criteo_api_retailmedia_v2024_01.model.post_campaign_v202301 import PostCampaignV202301 @@ -135,6 +147,9 @@ from criteo_api_retailmedia_v2024_01.model.problem_details import ProblemDetails from criteo_api_retailmedia_v2024_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest from criteo_api_retailmedia_v2024_01.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2024_01.model.proposal_status_model import ProposalStatusModel +from criteo_api_retailmedia_v2024_01.model.proposal_status_model_resource import ProposalStatusModelResource +from criteo_api_retailmedia_v2024_01.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_v2024_01.model.put_campaign_v202301 import PutCampaignV202301 from criteo_api_retailmedia_v2024_01.model.report_outcome import ReportOutcome from criteo_api_retailmedia_v2024_01.model.resource_of_add_funds_to_balance import ResourceOfAddFundsToBalance @@ -154,24 +169,8 @@ from criteo_api_retailmedia_v2024_01.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 from criteo_api_retailmedia_v2024_01.model.resource_of_template import ResourceOfTemplate from criteo_api_retailmedia_v2024_01.model.resource_of_update_balance_model import ResourceOfUpdateBalanceModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource +from criteo_api_retailmedia_v2024_01.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2024_01.model.review_state_model import ReviewStateModel from criteo_api_retailmedia_v2024_01.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1 from criteo_api_retailmedia_v2024_01.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource from criteo_api_retailmedia_v2024_01.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response @@ -192,7 +191,12 @@ from criteo_api_retailmedia_v2024_01.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2 from criteo_api_retailmedia_v2024_01.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 from criteo_api_retailmedia_v2024_01.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 +from criteo_api_retailmedia_v2024_01.model.rmca_common_problem import RmcaCommonProblem from criteo_api_retailmedia_v2024_01.model.section import Section +from criteo_api_retailmedia_v2024_01.model.set_bid_model import SetBidModel +from criteo_api_retailmedia_v2024_01.model.set_bids_model import SetBidsModel +from criteo_api_retailmedia_v2024_01.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2024_01.model.set_bids_model_resource import SetBidsModelResource from criteo_api_retailmedia_v2024_01.model.status_response import StatusResponse from criteo_api_retailmedia_v2024_01.model.status_response_resource import StatusResponseResource from criteo_api_retailmedia_v2024_01.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request diff --git a/sdks/retailmedia_2024-01/docs/AddRemoveKeywordModel.md b/sdks/retailmedia_2024-01/docs/AddRemoveKeywordModel.md new file mode 100644 index 00000000..8546f1f2 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/AddRemoveKeywordModel.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordModel + +A single keyword to be added or removed + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**is_deleted** | **bool, 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_2024-01/docs/AddRemoveKeywordsModel.md b/sdks/retailmedia_2024-01/docs/AddRemoveKeywordsModel.md new file mode 100644 index 00000000..27980d2b --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/AddRemoveKeywordsModel.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModel + +Data model containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[AddRemoveKeywordModel], none_type**](AddRemoveKeywordModel.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_2024-01/docs/AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2024-01/docs/AddRemoveKeywordsModelRequest.md new file mode 100644 index 00000000..577c720e --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/AddRemoveKeywordsModelRequest.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModelRequest + +Request object to add or remove keywords from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AddRemoveKeywordsModelResource**](AddRemoveKeywordsModelResource.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_2024-01/docs/AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2024-01/docs/AddRemoveKeywordsModelResource.md new file mode 100644 index 00000000..ad36e151 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/AddRemoveKeywordsModelResource.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordsModelResource + +Resource object containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**AddRemoveKeywordsModel**](AddRemoveKeywordsModel.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_2024-01/docs/AnalyticsApi.md b/sdks/retailmedia_2024-01/docs/AnalyticsApi.md index e0c865ef..811d5a57 100644 --- a/sdks/retailmedia_2024-01/docs/AnalyticsApi.md +++ b/sdks/retailmedia_2024-01/docs/AnalyticsApi.md @@ -66,8 +66,8 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", @@ -179,8 +179,8 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", @@ -294,18 +294,21 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: id="id_example", report_type="advertiser", revenue_type="auction", - format="json", sold_by="directSold", - campaign_sub_type="auctionAndPreferred", + buy_type="auction", + sku_relations=[ + "sameSku", + ], + format="json", + campaign_type="all", + sales_channel="all", click_attribution_window="none", view_attribution_window="none", - campaign_type="sponsoredProducts", - sales_channel="offline", dimensions=[ "date", ], metrics=[ - "impressions", + "numberOfCampaigns", ], start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), diff --git a/sdks/retailmedia_2024-01/docs/ApprovalStatusModel.md b/sdks/retailmedia_2024-01/docs/ApprovalStatusModel.md new file mode 100644 index 00000000..52ab7863 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/ApprovalStatusModel.md @@ -0,0 +1,12 @@ +# ApprovalStatusModel + +The status of a booking or runnable in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of a booking or runnable in the context of a line item. | must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] + +[[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_2024-01/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2024-01/docs/AsyncCampaignsReport.md index 21dd57bd..f4385127 100644 --- a/sdks/retailmedia_2024-01/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2024-01/docs/AsyncCampaignsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **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] -**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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2024-01/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2024-01/docs/AsyncLineItemsReport.md index ccb01090..eece64e3 100644 --- a/sdks/retailmedia_2024-01/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2024-01/docs/AsyncLineItemsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **end_date** | **datetime** | End date | **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2024-01/docs/AsyncRevenueReport.md b/sdks/retailmedia_2024-01/docs/AsyncRevenueReport.md index 53b4ca21..e7d30dbc 100644 --- a/sdks/retailmedia_2024-01/docs/AsyncRevenueReport.md +++ b/sdks/retailmedia_2024-01/docs/AsyncRevenueReport.md @@ -11,13 +11,14 @@ Name | Type | Description | Notes **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] +**sold_by** | **str, none_type** | Filter on the seller: Indirect Sold, Direct Sold or Private Market | [optional] +**buy_type** | **str, none_type** | Filter on buy type: Auction, Preferred Deals or Sponsorship | [optional] +**sku_relations** | **[str], none_type** | Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller | [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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2024-01/docs/CampaignApi.md b/sdks/retailmedia_2024-01/docs/CampaignApi.md index aebdf37e..113ddc2c 100644 --- a/sdks/retailmedia_2024-01/docs/CampaignApi.md +++ b/sdks/retailmedia_2024-01/docs/CampaignApi.md @@ -78,11 +78,11 @@ Method | HTTP request | Description # **add_remove_keywords** -> RetailMediaExternalv1ResourceOutcome add_remove_keywords(id) +> ResourceOutcome add_remove_keywords(id) -Add or Remove keywords from the associated line item in bulk +Add or Remove keywords from the line item in bulk ### Example @@ -93,8 +93,8 @@ Add or Remove keywords from the associated line item in bulk import time import criteo_api_retailmedia_v2024_01 from criteo_api_retailmedia_v2024_01.api import campaign_api -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2024_01.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2024_01.model.resource_outcome import ResourceOutcome 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. @@ -123,22 +123,22 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_add_remove_keywords_model_request = RetailMediaExternalv1AddRemoveKeywordsModelRequest( - data=RetailMediaExternalv1AddRemoveKeywordsModelResource( + id = "id_example" # str | ID of the line item + add_remove_keywords_model_request = AddRemoveKeywordsModelRequest( + data=AddRemoveKeywordsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1AddRemoveKeywordsModel( + attributes=AddRemoveKeywordsModel( keywords=[ - RetailMediaExternalv1AddRemoveKeywordModel( + AddRemoveKeywordModel( phrase="phrase_example", - match_type="PositiveExactMatch", + match_type=MatchTypeModel("PositiveExactMatch"), is_deleted=True, ), ], ), ), - ) # RetailMediaExternalv1AddRemoveKeywordsModelRequest | Object containing keywords to be added or removed (optional) + ) # AddRemoveKeywordsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -150,7 +150,7 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.add_remove_keywords(id, retail_media_externalv1_add_remove_keywords_model_request=retail_media_externalv1_add_remove_keywords_model_request) + api_response = api_instance.add_remove_keywords(id, add_remove_keywords_model_request=add_remove_keywords_model_request) pprint(api_response) except criteo_api_retailmedia_v2024_01.ApiException as e: print("Exception when calling CampaignApi->add_remove_keywords: %s\n" % e) @@ -161,12 +161,12 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_add_remove_keywords_model_request** | [**RetailMediaExternalv1AddRemoveKeywordsModelRequest**](RetailMediaExternalv1AddRemoveKeywordsModelRequest.md)| Object containing keywords to be added or removed | [optional] + **id** | **str**| ID of the line item | + **add_remove_keywords_model_request** | [**AddRemoveKeywordsModelRequest**](AddRemoveKeywordsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -175,7 +175,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -272,7 +272,7 @@ 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) # **fetch_keywords** -> RetailMediaExternalv1KeywordsModelResponse fetch_keywords(id) +> KeywordsModelResponse fetch_keywords(id) @@ -287,7 +287,8 @@ Fetch keywords associated with the specified line item import time import criteo_api_retailmedia_v2024_01 from criteo_api_retailmedia_v2024_01.api import campaign_api -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse +from criteo_api_retailmedia_v2024_01.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2024_01.model.keywords_model_response import KeywordsModelResponse 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. @@ -316,7 +317,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -331,11 +332,11 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1KeywordsModelResponse**](RetailMediaExternalv1KeywordsModelResponse.md) +[**KeywordsModelResponse**](KeywordsModelResponse.md) ### Authorization @@ -344,7 +345,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 @@ -357,11 +358,11 @@ 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) # **fetch_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse fetch_proposal(id) +> ProposalStatusModelResponse fetch_proposal(id) -Fetch the status of a proposal to modify a Preferred Deal Line Item. +Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. ### Example @@ -372,7 +373,8 @@ Fetch the status of a proposal to modify a Preferred Deal Line Item. import time import criteo_api_retailmedia_v2024_01 from criteo_api_retailmedia_v2024_01.api import campaign_api -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_v2024_01.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_v2024_01.model.resource_outcome import ResourceOutcome 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. @@ -401,7 +403,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -416,11 +418,11 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -429,7 +431,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 @@ -438,7 +440,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) @@ -6721,7 +6722,7 @@ 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) # **set_keyword_bids** -> RetailMediaExternalv1ResourceOutcome set_keyword_bids(id) +> ResourceOutcome set_keyword_bids(id) @@ -6736,8 +6737,8 @@ Set bid overrides for associated keywords to the given line item in bulk import time import criteo_api_retailmedia_v2024_01 from criteo_api_retailmedia_v2024_01.api import campaign_api -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_v2024_01.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2024_01.model.resource_outcome import ResourceOutcome 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. @@ -6766,21 +6767,21 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_set_bids_model_request = RetailMediaExternalv1SetBidsModelRequest( - data=RetailMediaExternalv1SetBidsModelResource( + id = "id_example" # str | ID of the line item + set_bids_model_request = SetBidsModelRequest( + data=SetBidsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1SetBidsModel( + attributes=SetBidsModel( keywords=[ - RetailMediaExternalv1SetBidModel( + SetBidModel( phrase="phrase_example", bid=3.14, ), ], ), ), - ) # RetailMediaExternalv1SetBidsModelRequest | Object containing a list of bid overrides for associated keywords (optional) + ) # SetBidsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -6792,7 +6793,7 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.set_keyword_bids(id, retail_media_externalv1_set_bids_model_request=retail_media_externalv1_set_bids_model_request) + api_response = api_instance.set_keyword_bids(id, set_bids_model_request=set_bids_model_request) pprint(api_response) except criteo_api_retailmedia_v2024_01.ApiException as e: print("Exception when calling CampaignApi->set_keyword_bids: %s\n" % e) @@ -6803,12 +6804,12 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_set_bids_model_request** | [**RetailMediaExternalv1SetBidsModelRequest**](RetailMediaExternalv1SetBidsModelRequest.md)| Object containing a list of bid overrides for associated keywords | [optional] + **id** | **str**| ID of the line item | + **set_bids_model_request** | [**SetBidsModelRequest**](SetBidsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -6817,7 +6818,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -6830,11 +6831,11 @@ 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) # **submit_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse submit_proposal(id) +> ProposalStatusModelResponse submit_proposal(id) -Submit a proposal to modify a Preferred Deal Line Item for review. +Only the components of the Line Item that are in a valid state will be reviewed. ### Example @@ -6845,7 +6846,8 @@ Submit a proposal to modify a Preferred Deal Line Item for review. import time import criteo_api_retailmedia_v2024_01 from criteo_api_retailmedia_v2024_01.api import campaign_api -from criteo_api_retailmedia_v2024_01.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_v2024_01.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_v2024_01.model.resource_outcome import ResourceOutcome 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. @@ -6874,7 +6876,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN' with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = campaign_api.CampaignApi(api_client) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -6889,11 +6891,11 @@ with criteo_api_retailmedia_v2024_01.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -6902,7 +6904,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 @@ -6911,7 +6913,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) diff --git a/sdks/retailmedia_2024-01/docs/InputKeywordsModel.md b/sdks/retailmedia_2024-01/docs/InputKeywordsModel.md new file mode 100644 index 00000000..9a080793 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/InputKeywordsModel.md @@ -0,0 +1,14 @@ +# InputKeywordsModel + +The keywords to be added or removed from a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negative_broad** | **[str], none_type** | | [optional] +**negative_exact** | **[str], none_type** | | [optional] +**positive_exact** | **[str], 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_2024-01/docs/KeywordDataModel.md b/sdks/retailmedia_2024-01/docs/KeywordDataModel.md new file mode 100644 index 00000000..fca58d73 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/KeywordDataModel.md @@ -0,0 +1,17 @@ +# KeywordDataModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**review_state** | [**ReviewStateModel**](ReviewStateModel.md) | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**bid** | **float, none_type** | | [optional] +**input_keywords** | [**InputKeywordsModel**](InputKeywordsModel.md) | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2024-01/docs/KeywordsModel.md b/sdks/retailmedia_2024-01/docs/KeywordsModel.md new file mode 100644 index 00000000..d31dabad --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/KeywordsModel.md @@ -0,0 +1,13 @@ +# KeywordsModel + +The keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**{str: (KeywordDataModel,)}, none_type**](KeywordDataModel.md) | | [optional] +**rank** | **[str], 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_2024-01/docs/KeywordsModelResource.md b/sdks/retailmedia_2024-01/docs/KeywordsModelResource.md new file mode 100644 index 00000000..9a26bd3a --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/KeywordsModelResource.md @@ -0,0 +1,14 @@ +# KeywordsModelResource + +Resource object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**KeywordsModel**](KeywordsModel.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_2024-01/docs/KeywordsModelResponse.md b/sdks/retailmedia_2024-01/docs/KeywordsModelResponse.md new file mode 100644 index 00000000..2d24cc4e --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/KeywordsModelResponse.md @@ -0,0 +1,14 @@ +# KeywordsModelResponse + +Response object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**KeywordsModelResource**](KeywordsModelResource.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_2024-01/docs/MatchTypeModel.md b/sdks/retailmedia_2024-01/docs/MatchTypeModel.md new file mode 100644 index 00000000..9406306f --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/MatchTypeModel.md @@ -0,0 +1,12 @@ +# MatchTypeModel + +The match type of a keyword. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The match type of a keyword. | must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] + +[[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_2024-01/docs/NegotiationStateModel.md b/sdks/retailmedia_2024-01/docs/NegotiationStateModel.md new file mode 100644 index 00000000..e34ddbf4 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/NegotiationStateModel.md @@ -0,0 +1,12 @@ +# NegotiationStateModel + +The state of a negotiation in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a negotiation in the context of a line item. | must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] + +[[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_2024-01/docs/ProposalStatusModel.md b/sdks/retailmedia_2024-01/docs/ProposalStatusModel.md new file mode 100644 index 00000000..49d39c19 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/ProposalStatusModel.md @@ -0,0 +1,17 @@ +# ProposalStatusModel + +The state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negotiation_state** | [**NegotiationStateModel**](NegotiationStateModel.md) | | [optional] +**booking_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**runnable_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**comment** | **str, none_type** | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2024-01/docs/ProposalStatusModelResource.md b/sdks/retailmedia_2024-01/docs/ProposalStatusModelResource.md new file mode 100644 index 00000000..f89ca4eb --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/ProposalStatusModelResource.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResource + +Resource object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**ProposalStatusModel**](ProposalStatusModel.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_2024-01/docs/ProposalStatusModelResponse.md b/sdks/retailmedia_2024-01/docs/ProposalStatusModelResponse.md new file mode 100644 index 00000000..2e87ff0d --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/ProposalStatusModelResponse.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResponse + +Response object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**ProposalStatusModelResource**](ProposalStatusModelResource.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_2024-01/docs/ResourceOutcome.md b/sdks/retailmedia_2024-01/docs/ResourceOutcome.md new file mode 100644 index 00000000..3bf8a5e5 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/ResourceOutcome.md @@ -0,0 +1,13 @@ +# ResourceOutcome + +Outcome object containing errors and warnings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.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_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordModel.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordModel.md deleted file mode 100644 index 98c859cd..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordModel - -A single keyword to be added or removed - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**is_deleted** | **bool, 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_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md deleted file mode 100644 index 2d39bd84..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModel - -Data model containing keywords to be added or removed from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1AddRemoveKeywordModel], none_type**](RetailMediaExternalv1AddRemoveKeywordModel.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_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md deleted file mode 100644 index d623d5f5..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelRequest - -Request object to add or remove keywords from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1AddRemoveKeywordsModelResource**](RetailMediaExternalv1AddRemoveKeywordsModelResource.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_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md deleted file mode 100644 index 1abf3809..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelResource - -Resource wrapper the keyword add and remove datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1AddRemoveKeywordsModel**](RetailMediaExternalv1AddRemoveKeywordsModel.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_2024-01/docs/RetailMediaExternalv1InputKeywordsModel.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1InputKeywordsModel.md deleted file mode 100644 index 19807cea..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1InputKeywordsModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1InputKeywordsModel - -Input values associated with a keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negative_broad** | **[str], none_type** | | [optional] -**negative_exact** | **[str], none_type** | | [optional] -**positive_exact** | **[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_2024-01/docs/RetailMediaExternalv1KeywordDataModel.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1KeywordDataModel.md deleted file mode 100644 index d7326d7a..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1KeywordDataModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1KeywordDataModel - -Details for a specific keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**review_state** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**bid** | **float, none_type** | | [optional] -**input_keywords** | [**RetailMediaExternalv1InputKeywordsModel**](RetailMediaExternalv1InputKeywordsModel.md) | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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_2024-01/docs/RetailMediaExternalv1KeywordsModel.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1KeywordsModel.md deleted file mode 100644 index 105b25b5..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1KeywordsModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1KeywordsModel - -Datamodel representing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**RetailMediaExternalv1KeywordDataModel**](RetailMediaExternalv1KeywordDataModel.md) | | [optional] -**rank** | **[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_2024-01/docs/RetailMediaExternalv1KeywordsModelResource.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1KeywordsModelResource.md deleted file mode 100644 index 8aabe795..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1KeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResource - -Resource wrapper of associated keywords with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1KeywordsModel**](RetailMediaExternalv1KeywordsModel.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_2024-01/docs/RetailMediaExternalv1KeywordsModelResponse.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1KeywordsModelResponse.md deleted file mode 100644 index eb84587c..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1KeywordsModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResponse - -Response object containing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1KeywordsModelResource**](RetailMediaExternalv1KeywordsModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2024-01/docs/RetailMediaExternalv1ProblemDetails.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ProblemDetails.md deleted file mode 100644 index 32758436..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ProblemDetails.md +++ /dev/null @@ -1,21 +0,0 @@ -# RetailMediaExternalv1ProblemDetails - -Datamodel for common errors and warnings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**trace_identifier** | **str, none_type** | | [optional] -**code** | **str, none_type** | | [optional] -**source** | **{str: (str,)}, none_type** | | [optional] -**stack_trace** | **str, none_type** | | [optional] -**type** | **str, none_type** | | [optional] -**title** | **str, none_type** | | [optional] -**status** | **int, none_type** | | [optional] -**detail** | **str, none_type** | | [optional] -**instance** | **str, none_type** | | [optional] -**any string name** | **{str: (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_2024-01/docs/RetailMediaExternalv1ProposalStatusModel.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ProposalStatusModel.md deleted file mode 100644 index 93cf4401..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ProposalStatusModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModel - -The proposal status includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negotiation_state** | **str** | | -**booking_status** | **str** | | -**runnable_status** | **str** | | -**comment** | **str, none_type** | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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_2024-01/docs/RetailMediaExternalv1ProposalStatusModelResource.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ProposalStatusModelResource.md deleted file mode 100644 index 4c5ebc52..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ProposalStatusModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResource - -Wrapper for the proposal status - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1ProposalStatusModel**](RetailMediaExternalv1ProposalStatusModel.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_2024-01/docs/RetailMediaExternalv1ProposalStatusModelResponse.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ProposalStatusModelResponse.md deleted file mode 100644 index 2550a175..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ProposalStatusModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResponse - -Wrapper for the proposal status resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1ProposalStatusModelResource**](RetailMediaExternalv1ProposalStatusModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2024-01/docs/RetailMediaExternalv1ResourceOutcome.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ResourceOutcome.md deleted file mode 100644 index 7b1c09f1..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1ResourceOutcome.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1ResourceOutcome - -A response object containing errors or warnings if required - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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_2024-01/docs/RetailMediaExternalv1SetBidModel.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidModel.md deleted file mode 100644 index 978f8b12..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1SetBidModel - -A single keyword and associated bid override - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**bid** | **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/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidsModel.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidsModel.md deleted file mode 100644 index 2b1359ff..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModel - -Data model containing keywords and bid overrides to associate to them - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1SetBidModel], none_type**](RetailMediaExternalv1SetBidModel.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_2024-01/docs/RetailMediaExternalv1SetBidsModelRequest.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidsModelRequest.md deleted file mode 100644 index e40b943e..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModelRequest - -Request to set bid overrides for specified keywords on a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1SetBidsModelResource**](RetailMediaExternalv1SetBidsModelResource.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_2024-01/docs/RetailMediaExternalv1SetBidsModelResource.md b/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidsModelResource.md deleted file mode 100644 index 4a4e3082..00000000 --- a/sdks/retailmedia_2024-01/docs/RetailMediaExternalv1SetBidsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1SetBidsModelResource - -Wrapper of the Set Bids datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1SetBidsModel**](RetailMediaExternalv1SetBidsModel.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_2024-01/docs/ReviewStateModel.md b/sdks/retailmedia_2024-01/docs/ReviewStateModel.md new file mode 100644 index 00000000..e905d467 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/ReviewStateModel.md @@ -0,0 +1,12 @@ +# ReviewStateModel + +The state of a keyword in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a keyword in the context of a line item. | must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] + +[[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_2024-01/docs/RmLegacyAudienceGetEntityV1ListResponse.md b/sdks/retailmedia_2024-01/docs/RmLegacyAudienceGetEntityV1ListResponse.md index a086fc52..177bd87b 100644 --- a/sdks/retailmedia_2024-01/docs/RmLegacyAudienceGetEntityV1ListResponse.md +++ b/sdks/retailmedia_2024-01/docs/RmLegacyAudienceGetEntityV1ListResponse.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1ListResponse -List of responses +A top-level object that encapsulates a Criteo API response for several entities and metadata ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2024-01/docs/RmLegacyAudienceGetEntityV1Resource.md b/sdks/retailmedia_2024-01/docs/RmLegacyAudienceGetEntityV1Resource.md index 7d4b9798..dad0c799 100644 --- a/sdks/retailmedia_2024-01/docs/RmLegacyAudienceGetEntityV1Resource.md +++ b/sdks/retailmedia_2024-01/docs/RmLegacyAudienceGetEntityV1Resource.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1Resource -Legacy resource +A class that represents a domain entity exposed by an API ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2024-01/docs/RmcaCommonProblem.md b/sdks/retailmedia_2024-01/docs/RmcaCommonProblem.md new file mode 100644 index 00000000..fba2c66b --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/RmcaCommonProblem.md @@ -0,0 +1,21 @@ +# RmcaCommonProblem + +Common problem object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trace_id** | **str, none_type** | The request correlation ID this problem comes from. | [optional] +**type** | **str, none_type** | The problem's category. | [optional] +**code** | **str, none_type** | A machine-readable error code, expressed as a string value. | [optional] +**instance** | **str, none_type** | A URI that identifies the specific occurrence of the problem. | [optional] +**title** | **str, none_type** | A short human-readable description of the problem type | [optional] +**detail** | **str, none_type** | A human-readable explanation specific to this occurrence of the problem | [optional] +**source** | **{str: (str,)}, none_type** | A machine-readable structure to reference to the exact location(s) causing the error(s) | [optional] +**stack_trace** | **str, none_type** | | [optional] +**status** | **int, none_type** | The problem's HTTP Status code. | [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_2024-01/docs/SetBidModel.md b/sdks/retailmedia_2024-01/docs/SetBidModel.md new file mode 100644 index 00000000..979e91d0 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/SetBidModel.md @@ -0,0 +1,13 @@ +# SetBidModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**bid** | **float, 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_2024-01/docs/SetBidsModel.md b/sdks/retailmedia_2024-01/docs/SetBidsModel.md new file mode 100644 index 00000000..e5e1b0c8 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/SetBidsModel.md @@ -0,0 +1,12 @@ +# SetBidsModel + +Data model containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[SetBidModel], none_type**](SetBidModel.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_2024-01/docs/SetBidsModelRequest.md b/sdks/retailmedia_2024-01/docs/SetBidsModelRequest.md new file mode 100644 index 00000000..9c19c9c2 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/SetBidsModelRequest.md @@ -0,0 +1,12 @@ +# SetBidsModelRequest + +Request object to set bid overrides for keywords associated with a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SetBidsModelResource**](SetBidsModelResource.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_2024-01/docs/SetBidsModelResource.md b/sdks/retailmedia_2024-01/docs/SetBidsModelResource.md new file mode 100644 index 00000000..6e436263 --- /dev/null +++ b/sdks/retailmedia_2024-01/docs/SetBidsModelResource.md @@ -0,0 +1,14 @@ +# SetBidsModelResource + +Resource object containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**SetBidsModel**](SetBidsModel.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_2024-01/setup.py b/sdks/retailmedia_2024-01/setup.py index aad28d40..6d22eaed 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.240404" +VERSION = "2024.01.0.240515" # 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.240404 +pip install criteo-api-retailmedia-sdk==2024.01.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python diff --git a/sdks/retailmedia_2023-01/.gitignore b/sdks/retailmedia_2024-04/.gitignore similarity index 100% rename from sdks/retailmedia_2023-01/.gitignore rename to sdks/retailmedia_2024-04/.gitignore diff --git a/sdks/retailmedia_2024-04/.gitlab-ci.yml b/sdks/retailmedia_2024-04/.gitlab-ci.yml new file mode 100644 index 00000000..bd14289e --- /dev/null +++ b/sdks/retailmedia_2024-04/.gitlab-ci.yml @@ -0,0 +1,24 @@ +# ref: https://docs.gitlab.com/ee/ci/README.html + +stages: + - test + +.tests: + stage: test + script: + - pip install -r requirements.txt + - pip install -r test-requirements.txt + - pytest --cov=criteo_api_retailmedia_v2024_04 + +test-3.6: + extends: .tests + image: python:3.6-alpine +test-3.7: + extends: .tests + image: python:3.7-alpine +test-3.8: + extends: .tests + image: python:3.8-alpine +test-3.9: + extends: .tests + image: python:3.9-alpine diff --git a/sdks/retailmedia_2024-04/.openapi-generator/FILES b/sdks/retailmedia_2024-04/.openapi-generator/FILES new file mode 100644 index 00000000..76088511 --- /dev/null +++ b/sdks/retailmedia_2024-04/.openapi-generator/FILES @@ -0,0 +1,494 @@ +.gitignore +.gitlab-ci.yml +.openapi-generator-ignore +.travis.yml +README.md +criteo_api_retailmedia_v2024_04/__init__.py +criteo_api_retailmedia_v2024_04/api/__init__.py +criteo_api_retailmedia_v2024_04/api/accounts_api.py +criteo_api_retailmedia_v2024_04/api/analytics_api.py +criteo_api_retailmedia_v2024_04/api/audience_api.py +criteo_api_retailmedia_v2024_04/api/campaign_api.py +criteo_api_retailmedia_v2024_04/api/gateway_api.py +criteo_api_retailmedia_v2024_04/api_client.py +criteo_api_retailmedia_v2024_04/api_client_builder.py +criteo_api_retailmedia_v2024_04/apis/__init__.py +criteo_api_retailmedia_v2024_04/configuration.py +criteo_api_retailmedia_v2024_04/criteo_api_client.py +criteo_api_retailmedia_v2024_04/criteo_auth.py +criteo_api_retailmedia_v2024_04/criteo_rest.py +criteo_api_retailmedia_v2024_04/exceptions.py +criteo_api_retailmedia_v2024_04/flow_constants.py +criteo_api_retailmedia_v2024_04/model/__init__.py +criteo_api_retailmedia_v2024_04/model/add_funds_to_balance_request.py +criteo_api_retailmedia_v2024_04/model/add_remove_keyword_model.py +criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model.py +criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model_request.py +criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model_resource.py +criteo_api_retailmedia_v2024_04/model/add_to_basket_ids_update_model202110_request.py +criteo_api_retailmedia_v2024_04/model/add_to_basket_target202110_request.py +criteo_api_retailmedia_v2024_04/model/add_to_basket_target202110_response.py +criteo_api_retailmedia_v2024_04/model/application_summary_model.py +criteo_api_retailmedia_v2024_04/model/application_summary_model_resource.py +criteo_api_retailmedia_v2024_04/model/application_summary_model_response.py +criteo_api_retailmedia_v2024_04/model/approval_status_model.py +criteo_api_retailmedia_v2024_04/model/asset.py +criteo_api_retailmedia_v2024_04/model/asset_resource.py +criteo_api_retailmedia_v2024_04/model/asset_response.py +criteo_api_retailmedia_v2024_04/model/async_campaigns_report.py +criteo_api_retailmedia_v2024_04/model/async_campaigns_report_request.py +criteo_api_retailmedia_v2024_04/model/async_campaigns_report_resource.py +criteo_api_retailmedia_v2024_04/model/async_line_items_report.py +criteo_api_retailmedia_v2024_04/model/async_line_items_report_request.py +criteo_api_retailmedia_v2024_04/model/async_line_items_report_resource.py +criteo_api_retailmedia_v2024_04/model/async_report_response.py +criteo_api_retailmedia_v2024_04/model/async_revenue_report.py +criteo_api_retailmedia_v2024_04/model/async_revenue_report_request.py +criteo_api_retailmedia_v2024_04/model/async_revenue_report_resource.py +criteo_api_retailmedia_v2024_04/model/auction_line_item_create_model_request.py +criteo_api_retailmedia_v2024_04/model/auction_line_item_paged_list_response.py +criteo_api_retailmedia_v2024_04/model/auction_line_item_response.py +criteo_api_retailmedia_v2024_04/model/auction_line_item_update_model_request.py +criteo_api_retailmedia_v2024_04/model/audience_ids_update_model202110_request.py +criteo_api_retailmedia_v2024_04/model/audience_target202110_request.py +criteo_api_retailmedia_v2024_04/model/audience_target202110_response.py +criteo_api_retailmedia_v2024_04/model/balance_campaign202110_list_request.py +criteo_api_retailmedia_v2024_04/model/balance_campaign202110_paged_list_response.py +criteo_api_retailmedia_v2024_04/model/balance_response.py +criteo_api_retailmedia_v2024_04/model/balance_response_paged_list_response.py +criteo_api_retailmedia_v2024_04/model/campaign_attributes_v202301.py +criteo_api_retailmedia_v2024_04/model/campaign_budget_overrides.py +criteo_api_retailmedia_v2024_04/model/campaign_daily_budget_override.py +criteo_api_retailmedia_v2024_04/model/campaign_monthly_budget_override.py +criteo_api_retailmedia_v2024_04/model/campaign_v202301.py +criteo_api_retailmedia_v2024_04/model/category202204.py +criteo_api_retailmedia_v2024_04/model/category202204_list_response.py +criteo_api_retailmedia_v2024_04/model/change_dates_of_balance_request.py +criteo_api_retailmedia_v2024_04/model/change_details.py +criteo_api_retailmedia_v2024_04/model/choice_option.py +criteo_api_retailmedia_v2024_04/model/choice_variable_specification.py +criteo_api_retailmedia_v2024_04/model/choice_variable_value.py +criteo_api_retailmedia_v2024_04/model/color_variable_value.py +criteo_api_retailmedia_v2024_04/model/common_error.py +criteo_api_retailmedia_v2024_04/model/common_line_item_paged_list_response.py +criteo_api_retailmedia_v2024_04/model/common_line_item_response.py +criteo_api_retailmedia_v2024_04/model/common_problem.py +criteo_api_retailmedia_v2024_04/model/common_warning.py +criteo_api_retailmedia_v2024_04/model/create_balance_request.py +criteo_api_retailmedia_v2024_04/model/creative202110.py +criteo_api_retailmedia_v2024_04/model/creative202110_list_response.py +criteo_api_retailmedia_v2024_04/model/creative202210.py +criteo_api_retailmedia_v2024_04/model/creative202210_list_response.py +criteo_api_retailmedia_v2024_04/model/creative202210_response.py +criteo_api_retailmedia_v2024_04/model/creative_create_model202207.py +criteo_api_retailmedia_v2024_04/model/creative_update_model202207.py +criteo_api_retailmedia_v2024_04/model/daily_line_item_budget_override.py +criteo_api_retailmedia_v2024_04/model/editable_campaign_attributes_v202301.py +criteo_api_retailmedia_v2024_04/model/external_account.py +criteo_api_retailmedia_v2024_04/model/external_add_funds_to_balance.py +criteo_api_retailmedia_v2024_04/model/external_add_to_basket_ids_update_model202110.py +criteo_api_retailmedia_v2024_04/model/external_add_to_basket_target202110.py +criteo_api_retailmedia_v2024_04/model/external_auction_line_item.py +criteo_api_retailmedia_v2024_04/model/external_auction_line_item_create_model.py +criteo_api_retailmedia_v2024_04/model/external_auction_line_item_update_model.py +criteo_api_retailmedia_v2024_04/model/external_audience_ids_update_model202110.py +criteo_api_retailmedia_v2024_04/model/external_audience_target202110.py +criteo_api_retailmedia_v2024_04/model/external_balance_response.py +criteo_api_retailmedia_v2024_04/model/external_brand.py +criteo_api_retailmedia_v2024_04/model/external_catalog_request.py +criteo_api_retailmedia_v2024_04/model/external_catalog_status.py +criteo_api_retailmedia_v2024_04/model/external_change_dates_of_balance.py +criteo_api_retailmedia_v2024_04/model/external_common_line_item.py +criteo_api_retailmedia_v2024_04/model/external_create_balance.py +criteo_api_retailmedia_v2024_04/model/external_keyword_target202110.py +criteo_api_retailmedia_v2024_04/model/external_line_item_capping202110.py +criteo_api_retailmedia_v2024_04/model/external_line_item_page202110.py +criteo_api_retailmedia_v2024_04/model/external_line_item_page_category202110.py +criteo_api_retailmedia_v2024_04/model/external_preferred_line_item202110.py +criteo_api_retailmedia_v2024_04/model/external_preferred_line_item_create_model202110.py +criteo_api_retailmedia_v2024_04/model/external_preferred_line_item_update_model202110.py +criteo_api_retailmedia_v2024_04/model/external_promoted_product202110.py +criteo_api_retailmedia_v2024_04/model/external_retailer.py +criteo_api_retailmedia_v2024_04/model/external_retailer_pages202110.py +criteo_api_retailmedia_v2024_04/model/external_store_ids_update_model202110.py +criteo_api_retailmedia_v2024_04/model/external_store_target202110.py +criteo_api_retailmedia_v2024_04/model/external_update_balance_model.py +criteo_api_retailmedia_v2024_04/model/files_variable_value.py +criteo_api_retailmedia_v2024_04/model/files_variables_specification.py +criteo_api_retailmedia_v2024_04/model/hyperlink_variable_value.py +criteo_api_retailmedia_v2024_04/model/input_keywords_model.py +criteo_api_retailmedia_v2024_04/model/input_resource_of_auction_line_item_create_model.py +criteo_api_retailmedia_v2024_04/model/input_resource_of_preferred_line_item_create_model202110.py +criteo_api_retailmedia_v2024_04/model/insertion_order_history_change_data_capture.py +criteo_api_retailmedia_v2024_04/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py +criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_account_and_account.py +criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_brand_and_brand.py +criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py +criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py +criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py +criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py +criteo_api_retailmedia_v2024_04/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py +criteo_api_retailmedia_v2024_04/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py +criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_account.py +criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_brand.py +criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_campaign_v202301.py +criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_retailer.py +criteo_api_retailmedia_v2024_04/model/json_api_request_of_catalog_request.py +criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_campaign_v202301.py +criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_catalog_status.py +criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_line_item_bid_multipliers.py +criteo_api_retailmedia_v2024_04/model/keyword_data_model.py +criteo_api_retailmedia_v2024_04/model/keyword_target202110_request.py +criteo_api_retailmedia_v2024_04/model/keyword_target202110_response.py +criteo_api_retailmedia_v2024_04/model/keywords_model.py +criteo_api_retailmedia_v2024_04/model/keywords_model_resource.py +criteo_api_retailmedia_v2024_04/model/keywords_model_response.py +criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers.py +criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers_request.py +criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers_response.py +criteo_api_retailmedia_v2024_04/model/line_item_budget_overrides.py +criteo_api_retailmedia_v2024_04/model/match_type_model.py +criteo_api_retailmedia_v2024_04/model/metadata.py +criteo_api_retailmedia_v2024_04/model/monthly_line_item_budeget_override.py +criteo_api_retailmedia_v2024_04/model/negotiation_state_model.py +criteo_api_retailmedia_v2024_04/model/page_metadata.py +criteo_api_retailmedia_v2024_04/model/page_of_insertion_order_history_change_data_capture.py +criteo_api_retailmedia_v2024_04/model/page_type_environment.py +criteo_api_retailmedia_v2024_04/model/post_campaign_v202301.py +criteo_api_retailmedia_v2024_04/model/preferred_line_item202110_paged_list_response.py +criteo_api_retailmedia_v2024_04/model/preferred_line_item202110_response.py +criteo_api_retailmedia_v2024_04/model/preferred_line_item_create_model202110_request.py +criteo_api_retailmedia_v2024_04/model/preferred_line_item_update_model202110_request.py +criteo_api_retailmedia_v2024_04/model/problem_details.py +criteo_api_retailmedia_v2024_04/model/promoted_product202110_list_request.py +criteo_api_retailmedia_v2024_04/model/promoted_product202110_paged_list_response.py +criteo_api_retailmedia_v2024_04/model/proposal_status_model.py +criteo_api_retailmedia_v2024_04/model/proposal_status_model_resource.py +criteo_api_retailmedia_v2024_04/model/proposal_status_model_response.py +criteo_api_retailmedia_v2024_04/model/put_campaign_v202301.py +criteo_api_retailmedia_v2024_04/model/report_outcome.py +criteo_api_retailmedia_v2024_04/model/resource_of_add_funds_to_balance.py +criteo_api_retailmedia_v2024_04/model/resource_of_auction_line_item.py +criteo_api_retailmedia_v2024_04/model/resource_of_auction_line_item_update_model.py +criteo_api_retailmedia_v2024_04/model/resource_of_balance_campaign202110.py +criteo_api_retailmedia_v2024_04/model/resource_of_balance_response.py +criteo_api_retailmedia_v2024_04/model/resource_of_category202204.py +criteo_api_retailmedia_v2024_04/model/resource_of_change_dates_of_balance.py +criteo_api_retailmedia_v2024_04/model/resource_of_common_line_item.py +criteo_api_retailmedia_v2024_04/model/resource_of_create_balance.py +criteo_api_retailmedia_v2024_04/model/resource_of_creative202110.py +criteo_api_retailmedia_v2024_04/model/resource_of_creative202210.py +criteo_api_retailmedia_v2024_04/model/resource_of_line_item_bid_multipliers.py +criteo_api_retailmedia_v2024_04/model/resource_of_preferred_line_item202110.py +criteo_api_retailmedia_v2024_04/model/resource_of_preferred_line_item_update_model202110.py +criteo_api_retailmedia_v2024_04/model/resource_of_promoted_product202110.py +criteo_api_retailmedia_v2024_04/model/resource_of_retail_media_account.py +criteo_api_retailmedia_v2024_04/model/resource_of_template.py +criteo_api_retailmedia_v2024_04/model/resource_of_update_balance_model.py +criteo_api_retailmedia_v2024_04/model/resource_outcome.py +criteo_api_retailmedia_v2024_04/model/resource_outcome_of_retail_media_account.py +criteo_api_retailmedia_v2024_04/model/retail_media_account.py +criteo_api_retailmedia_v2024_04/model/retail_media_brand_account_creation.py +criteo_api_retailmedia_v2024_04/model/retail_media_brands.py +criteo_api_retailmedia_v2024_04/model/review_state_model.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1_resource.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1_response.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2_resource.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2_response.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_input_entity_v1.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_input_entity_v2.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1_list_response.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1_resource.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2_list_response.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2_resource.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_user_behavior_create_v2.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_user_behavior_details_v2.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_customer_list.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_create_v2.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_v1.py +criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_v2.py +criteo_api_retailmedia_v2024_04/model/rmca_common_problem.py +criteo_api_retailmedia_v2024_04/model/section.py +criteo_api_retailmedia_v2024_04/model/set_bid_model.py +criteo_api_retailmedia_v2024_04/model/set_bids_model.py +criteo_api_retailmedia_v2024_04/model/set_bids_model_request.py +criteo_api_retailmedia_v2024_04/model/set_bids_model_resource.py +criteo_api_retailmedia_v2024_04/model/status_response.py +criteo_api_retailmedia_v2024_04/model/status_response_resource.py +criteo_api_retailmedia_v2024_04/model/store_ids_update_model202110_request.py +criteo_api_retailmedia_v2024_04/model/store_target202110_request.py +criteo_api_retailmedia_v2024_04/model/store_target202110_response.py +criteo_api_retailmedia_v2024_04/model/template.py +criteo_api_retailmedia_v2024_04/model/template_list_response.py +criteo_api_retailmedia_v2024_04/model/template_response.py +criteo_api_retailmedia_v2024_04/model/template_variable.py +criteo_api_retailmedia_v2024_04/model/template_variable_value.py +criteo_api_retailmedia_v2024_04/model/text_variable_specification.py +criteo_api_retailmedia_v2024_04/model/text_variable_value.py +criteo_api_retailmedia_v2024_04/model/update_balance_model_request.py +criteo_api_retailmedia_v2024_04/model/value_resource_input_of_campaign_budget_overrides.py +criteo_api_retailmedia_v2024_04/model/value_resource_input_of_line_item_budget_overrides.py +criteo_api_retailmedia_v2024_04/model/value_resource_input_of_retail_media_brand_account_creation.py +criteo_api_retailmedia_v2024_04/model/value_resource_input_of_retail_media_brands.py +criteo_api_retailmedia_v2024_04/model/value_resource_of_campaign_budget_overrides.py +criteo_api_retailmedia_v2024_04/model/value_resource_of_line_item_budget_overrides.py +criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brand_account_creation.py +criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brands.py +criteo_api_retailmedia_v2024_04/model/value_resource_outcome_of_campaign_budget_overrides.py +criteo_api_retailmedia_v2024_04/model/value_resource_outcome_of_line_item_budget_overrides.py +criteo_api_retailmedia_v2024_04/model/value_type_resource_of_add_to_basket_ids_update_model202110.py +criteo_api_retailmedia_v2024_04/model/value_type_resource_of_add_to_basket_target202110.py +criteo_api_retailmedia_v2024_04/model/value_type_resource_of_audience_ids_update_model202110.py +criteo_api_retailmedia_v2024_04/model/value_type_resource_of_audience_target202110.py +criteo_api_retailmedia_v2024_04/model/value_type_resource_of_keyword_target202110.py +criteo_api_retailmedia_v2024_04/model/value_type_resource_of_store_ids_update_model202110.py +criteo_api_retailmedia_v2024_04/model/value_type_resource_of_store_target202110.py +criteo_api_retailmedia_v2024_04/model_utils.py +criteo_api_retailmedia_v2024_04/models/__init__.py +criteo_api_retailmedia_v2024_04/rest.py +docs/AccountsApi.md +docs/AddFundsToBalanceRequest.md +docs/AddRemoveKeywordModel.md +docs/AddRemoveKeywordsModel.md +docs/AddRemoveKeywordsModelRequest.md +docs/AddRemoveKeywordsModelResource.md +docs/AddToBasketIdsUpdateModel202110Request.md +docs/AddToBasketTarget202110Request.md +docs/AddToBasketTarget202110Response.md +docs/AnalyticsApi.md +docs/ApplicationSummaryModel.md +docs/ApplicationSummaryModelResource.md +docs/ApplicationSummaryModelResponse.md +docs/ApprovalStatusModel.md +docs/Asset.md +docs/AssetResource.md +docs/AssetResponse.md +docs/AsyncCampaignsReport.md +docs/AsyncCampaignsReportRequest.md +docs/AsyncCampaignsReportResource.md +docs/AsyncLineItemsReport.md +docs/AsyncLineItemsReportRequest.md +docs/AsyncLineItemsReportResource.md +docs/AsyncReportResponse.md +docs/AsyncRevenueReport.md +docs/AsyncRevenueReportRequest.md +docs/AsyncRevenueReportResource.md +docs/AuctionLineItemCreateModelRequest.md +docs/AuctionLineItemPagedListResponse.md +docs/AuctionLineItemResponse.md +docs/AuctionLineItemUpdateModelRequest.md +docs/AudienceApi.md +docs/AudienceIdsUpdateModel202110Request.md +docs/AudienceTarget202110Request.md +docs/AudienceTarget202110Response.md +docs/BalanceCampaign202110ListRequest.md +docs/BalanceCampaign202110PagedListResponse.md +docs/BalanceResponse.md +docs/BalanceResponsePagedListResponse.md +docs/CampaignApi.md +docs/CampaignAttributesV202301.md +docs/CampaignBudgetOverrides.md +docs/CampaignDailyBudgetOverride.md +docs/CampaignMonthlyBudgetOverride.md +docs/CampaignV202301.md +docs/Category202204.md +docs/Category202204ListResponse.md +docs/ChangeDatesOfBalanceRequest.md +docs/ChangeDetails.md +docs/ChoiceOption.md +docs/ChoiceVariableSpecification.md +docs/ChoiceVariableValue.md +docs/ColorVariableValue.md +docs/CommonError.md +docs/CommonLineItemPagedListResponse.md +docs/CommonLineItemResponse.md +docs/CommonProblem.md +docs/CommonWarning.md +docs/CreateBalanceRequest.md +docs/Creative202110.md +docs/Creative202110ListResponse.md +docs/Creative202210.md +docs/Creative202210ListResponse.md +docs/Creative202210Response.md +docs/CreativeCreateModel202207.md +docs/CreativeUpdateModel202207.md +docs/DailyLineItemBudgetOverride.md +docs/EditableCampaignAttributesV202301.md +docs/ExternalAccount.md +docs/ExternalAddFundsToBalance.md +docs/ExternalAddToBasketIdsUpdateModel202110.md +docs/ExternalAddToBasketTarget202110.md +docs/ExternalAuctionLineItem.md +docs/ExternalAuctionLineItemCreateModel.md +docs/ExternalAuctionLineItemUpdateModel.md +docs/ExternalAudienceIdsUpdateModel202110.md +docs/ExternalAudienceTarget202110.md +docs/ExternalBalanceResponse.md +docs/ExternalBrand.md +docs/ExternalCatalogRequest.md +docs/ExternalCatalogStatus.md +docs/ExternalChangeDatesOfBalance.md +docs/ExternalCommonLineItem.md +docs/ExternalCreateBalance.md +docs/ExternalKeywordTarget202110.md +docs/ExternalLineItemCapping202110.md +docs/ExternalLineItemPage202110.md +docs/ExternalLineItemPageCategory202110.md +docs/ExternalPreferredLineItem202110.md +docs/ExternalPreferredLineItemCreateModel202110.md +docs/ExternalPreferredLineItemUpdateModel202110.md +docs/ExternalPromotedProduct202110.md +docs/ExternalRetailer.md +docs/ExternalRetailerPages202110.md +docs/ExternalStoreIdsUpdateModel202110.md +docs/ExternalStoreTarget202110.md +docs/ExternalUpdateBalanceModel.md +docs/FilesVariableValue.md +docs/FilesVariablesSpecification.md +docs/GatewayApi.md +docs/HyperlinkVariableValue.md +docs/InputKeywordsModel.md +docs/InputResourceOfAuctionLineItemCreateModel.md +docs/InputResourceOfPreferredLineItemCreateModel202110.md +docs/InsertionOrderHistoryChangeDataCapture.md +docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md +docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md +docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md +docs/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301.md +docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md +docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md +docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md +docs/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301.md +docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest.md +docs/JsonApiPageResponseOfAccount.md +docs/JsonApiPageResponseOfBrand.md +docs/JsonApiPageResponseOfCampaignV202301.md +docs/JsonApiPageResponseOfRetailer.md +docs/JsonApiRequestOfCatalogRequest.md +docs/JsonApiSingleResponseOfCampaignV202301.md +docs/JsonApiSingleResponseOfCatalogStatus.md +docs/JsonApiSingleResponseOfLineItemBidMultipliers.md +docs/KeywordDataModel.md +docs/KeywordTarget202110Request.md +docs/KeywordTarget202110Response.md +docs/KeywordsModel.md +docs/KeywordsModelResource.md +docs/KeywordsModelResponse.md +docs/LineItemBidMultipliers.md +docs/LineItemBidMultipliersRequest.md +docs/LineItemBidMultipliersResponse.md +docs/LineItemBudgetOverrides.md +docs/MatchTypeModel.md +docs/Metadata.md +docs/MonthlyLineItemBudegetOverride.md +docs/NegotiationStateModel.md +docs/PageMetadata.md +docs/PageOfInsertionOrderHistoryChangeDataCapture.md +docs/PageTypeEnvironment.md +docs/PostCampaignV202301.md +docs/PreferredLineItem202110PagedListResponse.md +docs/PreferredLineItem202110Response.md +docs/PreferredLineItemCreateModel202110Request.md +docs/PreferredLineItemUpdateModel202110Request.md +docs/ProblemDetails.md +docs/PromotedProduct202110ListRequest.md +docs/PromotedProduct202110PagedListResponse.md +docs/ProposalStatusModel.md +docs/ProposalStatusModelResource.md +docs/ProposalStatusModelResponse.md +docs/PutCampaignV202301.md +docs/ReportOutcome.md +docs/ResourceOfAddFundsToBalance.md +docs/ResourceOfAuctionLineItem.md +docs/ResourceOfAuctionLineItemUpdateModel.md +docs/ResourceOfBalanceCampaign202110.md +docs/ResourceOfBalanceResponse.md +docs/ResourceOfCategory202204.md +docs/ResourceOfChangeDatesOfBalance.md +docs/ResourceOfCommonLineItem.md +docs/ResourceOfCreateBalance.md +docs/ResourceOfCreative202110.md +docs/ResourceOfCreative202210.md +docs/ResourceOfLineItemBidMultipliers.md +docs/ResourceOfPreferredLineItem202110.md +docs/ResourceOfPreferredLineItemUpdateModel202110.md +docs/ResourceOfPromotedProduct202110.md +docs/ResourceOfRetailMediaAccount.md +docs/ResourceOfTemplate.md +docs/ResourceOfUpdateBalanceModel.md +docs/ResourceOutcome.md +docs/ResourceOutcomeOfRetailMediaAccount.md +docs/RetailMediaAccount.md +docs/RetailMediaBrandAccountCreation.md +docs/RetailMediaBrands.md +docs/ReviewStateModel.md +docs/RmLegacyAudienceCreateEntityV1.md +docs/RmLegacyAudienceCreateEntityV1Resource.md +docs/RmLegacyAudienceCreateEntityV1Response.md +docs/RmLegacyAudienceCreateEntityV2.md +docs/RmLegacyAudienceCreateEntityV2Resource.md +docs/RmLegacyAudienceCreateEntityV2Response.md +docs/RmLegacyAudienceCreateInputEntityV1.md +docs/RmLegacyAudienceCreateInputEntityV2.md +docs/RmLegacyAudienceGetEntityV1.md +docs/RmLegacyAudienceGetEntityV1ListResponse.md +docs/RmLegacyAudienceGetEntityV1Resource.md +docs/RmLegacyAudienceGetEntityV2.md +docs/RmLegacyAudienceGetEntityV2ListResponse.md +docs/RmLegacyAudienceGetEntityV2Resource.md +docs/RmLegacyAudienceUserBehaviorCreateV2.md +docs/RmLegacyAudienceUserBehaviorDetailsV2.md +docs/RmLegacySegmentCustomerList.md +docs/RmLegacySegmentUserBehaviorCreateV2.md +docs/RmLegacySegmentUserBehaviorV1.md +docs/RmLegacySegmentUserBehaviorV2.md +docs/RmcaCommonProblem.md +docs/Section.md +docs/SetBidModel.md +docs/SetBidsModel.md +docs/SetBidsModelRequest.md +docs/SetBidsModelResource.md +docs/StatusResponse.md +docs/StatusResponseResource.md +docs/StoreIdsUpdateModel202110Request.md +docs/StoreTarget202110Request.md +docs/StoreTarget202110Response.md +docs/Template.md +docs/TemplateListResponse.md +docs/TemplateResponse.md +docs/TemplateVariable.md +docs/TemplateVariableValue.md +docs/TextVariableSpecification.md +docs/TextVariableValue.md +docs/UpdateBalanceModelRequest.md +docs/ValueResourceInputOfCampaignBudgetOverrides.md +docs/ValueResourceInputOfLineItemBudgetOverrides.md +docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md +docs/ValueResourceInputOfRetailMediaBrands.md +docs/ValueResourceOfCampaignBudgetOverrides.md +docs/ValueResourceOfLineItemBudgetOverrides.md +docs/ValueResourceOfRetailMediaBrandAccountCreation.md +docs/ValueResourceOfRetailMediaBrands.md +docs/ValueResourceOutcomeOfCampaignBudgetOverrides.md +docs/ValueResourceOutcomeOfLineItemBudgetOverrides.md +docs/ValueTypeResourceOfAddToBasketIdsUpdateModel202110.md +docs/ValueTypeResourceOfAddToBasketTarget202110.md +docs/ValueTypeResourceOfAudienceIdsUpdateModel202110.md +docs/ValueTypeResourceOfAudienceTarget202110.md +docs/ValueTypeResourceOfKeywordTarget202110.md +docs/ValueTypeResourceOfStoreIdsUpdateModel202110.md +docs/ValueTypeResourceOfStoreTarget202110.md +git_push.sh +requirements.txt +setup.cfg +setup.py +test-requirements.txt +test/example_application_with_auth_code.py +test/example_application_with_client_credentials.py +test/example_application_with_refresh_token.py +test/test_gateway_api.py +tox.ini diff --git a/sdks/retailmedia_2023-01/.openapi-generator/VERSION b/sdks/retailmedia_2024-04/.openapi-generator/VERSION similarity index 100% rename from sdks/retailmedia_2023-01/.openapi-generator/VERSION rename to sdks/retailmedia_2024-04/.openapi-generator/VERSION diff --git a/sdks/retailmedia_2024-04/README.md b/sdks/retailmedia_2024-04/README.md new file mode 100644 index 00000000..f8489b45 --- /dev/null +++ b/sdks/retailmedia_2024-04/README.md @@ -0,0 +1,294 @@ +# Criteo API SDK for Python + +## Introduction +API Client Libraries can facilitate your use of the Criteo API allowing you to build unique and customized solutions to serve your businesses and clients. +These libraries can reduce the amount of code you need to write in order to start accessing Criteo programmatically. They also can help expedite troubleshooting, should you encounter any issues. + +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.04.0.240515 + +## Requirements + +Python 2.7 and 3.5+ + +## Installation & Usage +### pip install + +```sh +pip install criteo-api-retailmedia-sdk==2024.04.0.240515 +``` +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.04.0.240515`) + +Then import the package: +```python +import criteo_api_retailmedia_v2024_04 +``` + +### Manual Installation using [Setuptools](http://pypi.python.org/pypi/setuptools) + +Download the code or clone the repository locally, then execute the following command: + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) + +Then import the package: +```python +import criteo_api_retailmedia_v2024_04 +``` + +## Example +There are multiple examples for the different OAuth flows that the SDK supports. +- See [test/example_application_with_client_credentials.py](test/example_application_with_client_credentials.py) for an example with Client Credentials. +- See [test/example_application_with_auth_code.py](test/example_application_with_auth_code.py) for an example with Authorization Code. +Once you follow the authorization code flow, you will have a refresh token that has to be used to regenerate access token for future usage. + - See [test/example_application_with_refresh_token.py](test/example_application_with_refresh_token.py) for an example with Refresh Token . + +## Documentation for API Endpoints + +The developers documentation is available at: *https://developers.criteo.com*. + +All URIs are relative to *https://api.criteo.com*. + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- + + +## Documentation For Models + + - [AddFundsToBalanceRequest](docs/AddFundsToBalanceRequest.md) + - [AddRemoveKeywordModel](docs/AddRemoveKeywordModel.md) + - [AddRemoveKeywordsModel](docs/AddRemoveKeywordsModel.md) + - [AddRemoveKeywordsModelRequest](docs/AddRemoveKeywordsModelRequest.md) + - [AddRemoveKeywordsModelResource](docs/AddRemoveKeywordsModelResource.md) + - [AddToBasketIdsUpdateModel202110Request](docs/AddToBasketIdsUpdateModel202110Request.md) + - [AddToBasketTarget202110Request](docs/AddToBasketTarget202110Request.md) + - [AddToBasketTarget202110Response](docs/AddToBasketTarget202110Response.md) + - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) + - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) + - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) + - [ApprovalStatusModel](docs/ApprovalStatusModel.md) + - [Asset](docs/Asset.md) + - [AssetResource](docs/AssetResource.md) + - [AssetResponse](docs/AssetResponse.md) + - [AsyncCampaignsReport](docs/AsyncCampaignsReport.md) + - [AsyncCampaignsReportRequest](docs/AsyncCampaignsReportRequest.md) + - [AsyncCampaignsReportResource](docs/AsyncCampaignsReportResource.md) + - [AsyncLineItemsReport](docs/AsyncLineItemsReport.md) + - [AsyncLineItemsReportRequest](docs/AsyncLineItemsReportRequest.md) + - [AsyncLineItemsReportResource](docs/AsyncLineItemsReportResource.md) + - [AsyncReportResponse](docs/AsyncReportResponse.md) + - [AsyncRevenueReport](docs/AsyncRevenueReport.md) + - [AsyncRevenueReportRequest](docs/AsyncRevenueReportRequest.md) + - [AsyncRevenueReportResource](docs/AsyncRevenueReportResource.md) + - [AuctionLineItemCreateModelRequest](docs/AuctionLineItemCreateModelRequest.md) + - [AuctionLineItemPagedListResponse](docs/AuctionLineItemPagedListResponse.md) + - [AuctionLineItemResponse](docs/AuctionLineItemResponse.md) + - [AuctionLineItemUpdateModelRequest](docs/AuctionLineItemUpdateModelRequest.md) + - [AudienceIdsUpdateModel202110Request](docs/AudienceIdsUpdateModel202110Request.md) + - [AudienceTarget202110Request](docs/AudienceTarget202110Request.md) + - [AudienceTarget202110Response](docs/AudienceTarget202110Response.md) + - [BalanceCampaign202110ListRequest](docs/BalanceCampaign202110ListRequest.md) + - [BalanceCampaign202110PagedListResponse](docs/BalanceCampaign202110PagedListResponse.md) + - [BalanceResponse](docs/BalanceResponse.md) + - [BalanceResponsePagedListResponse](docs/BalanceResponsePagedListResponse.md) + - [CampaignAttributesV202301](docs/CampaignAttributesV202301.md) + - [CampaignBudgetOverrides](docs/CampaignBudgetOverrides.md) + - [CampaignDailyBudgetOverride](docs/CampaignDailyBudgetOverride.md) + - [CampaignMonthlyBudgetOverride](docs/CampaignMonthlyBudgetOverride.md) + - [CampaignV202301](docs/CampaignV202301.md) + - [Category202204](docs/Category202204.md) + - [Category202204ListResponse](docs/Category202204ListResponse.md) + - [ChangeDatesOfBalanceRequest](docs/ChangeDatesOfBalanceRequest.md) + - [ChangeDetails](docs/ChangeDetails.md) + - [ChoiceOption](docs/ChoiceOption.md) + - [ChoiceVariableSpecification](docs/ChoiceVariableSpecification.md) + - [ChoiceVariableValue](docs/ChoiceVariableValue.md) + - [ColorVariableValue](docs/ColorVariableValue.md) + - [CommonError](docs/CommonError.md) + - [CommonLineItemPagedListResponse](docs/CommonLineItemPagedListResponse.md) + - [CommonLineItemResponse](docs/CommonLineItemResponse.md) + - [CommonProblem](docs/CommonProblem.md) + - [CommonWarning](docs/CommonWarning.md) + - [CreateBalanceRequest](docs/CreateBalanceRequest.md) + - [Creative202110](docs/Creative202110.md) + - [Creative202110ListResponse](docs/Creative202110ListResponse.md) + - [Creative202210](docs/Creative202210.md) + - [Creative202210ListResponse](docs/Creative202210ListResponse.md) + - [Creative202210Response](docs/Creative202210Response.md) + - [CreativeCreateModel202207](docs/CreativeCreateModel202207.md) + - [CreativeUpdateModel202207](docs/CreativeUpdateModel202207.md) + - [DailyLineItemBudgetOverride](docs/DailyLineItemBudgetOverride.md) + - [EditableCampaignAttributesV202301](docs/EditableCampaignAttributesV202301.md) + - [ExternalAccount](docs/ExternalAccount.md) + - [ExternalAddFundsToBalance](docs/ExternalAddFundsToBalance.md) + - [ExternalAddToBasketIdsUpdateModel202110](docs/ExternalAddToBasketIdsUpdateModel202110.md) + - [ExternalAddToBasketTarget202110](docs/ExternalAddToBasketTarget202110.md) + - [ExternalAuctionLineItem](docs/ExternalAuctionLineItem.md) + - [ExternalAuctionLineItemCreateModel](docs/ExternalAuctionLineItemCreateModel.md) + - [ExternalAuctionLineItemUpdateModel](docs/ExternalAuctionLineItemUpdateModel.md) + - [ExternalAudienceIdsUpdateModel202110](docs/ExternalAudienceIdsUpdateModel202110.md) + - [ExternalAudienceTarget202110](docs/ExternalAudienceTarget202110.md) + - [ExternalBalanceResponse](docs/ExternalBalanceResponse.md) + - [ExternalBrand](docs/ExternalBrand.md) + - [ExternalCatalogRequest](docs/ExternalCatalogRequest.md) + - [ExternalCatalogStatus](docs/ExternalCatalogStatus.md) + - [ExternalChangeDatesOfBalance](docs/ExternalChangeDatesOfBalance.md) + - [ExternalCommonLineItem](docs/ExternalCommonLineItem.md) + - [ExternalCreateBalance](docs/ExternalCreateBalance.md) + - [ExternalKeywordTarget202110](docs/ExternalKeywordTarget202110.md) + - [ExternalLineItemCapping202110](docs/ExternalLineItemCapping202110.md) + - [ExternalLineItemPage202110](docs/ExternalLineItemPage202110.md) + - [ExternalLineItemPageCategory202110](docs/ExternalLineItemPageCategory202110.md) + - [ExternalPreferredLineItem202110](docs/ExternalPreferredLineItem202110.md) + - [ExternalPreferredLineItemCreateModel202110](docs/ExternalPreferredLineItemCreateModel202110.md) + - [ExternalPreferredLineItemUpdateModel202110](docs/ExternalPreferredLineItemUpdateModel202110.md) + - [ExternalPromotedProduct202110](docs/ExternalPromotedProduct202110.md) + - [ExternalRetailer](docs/ExternalRetailer.md) + - [ExternalRetailerPages202110](docs/ExternalRetailerPages202110.md) + - [ExternalStoreIdsUpdateModel202110](docs/ExternalStoreIdsUpdateModel202110.md) + - [ExternalStoreTarget202110](docs/ExternalStoreTarget202110.md) + - [ExternalUpdateBalanceModel](docs/ExternalUpdateBalanceModel.md) + - [FilesVariableValue](docs/FilesVariableValue.md) + - [FilesVariablesSpecification](docs/FilesVariablesSpecification.md) + - [HyperlinkVariableValue](docs/HyperlinkVariableValue.md) + - [InputKeywordsModel](docs/InputKeywordsModel.md) + - [InputResourceOfAuctionLineItemCreateModel](docs/InputResourceOfAuctionLineItemCreateModel.md) + - [InputResourceOfPreferredLineItemCreateModel202110](docs/InputResourceOfPreferredLineItemCreateModel202110.md) + - [InsertionOrderHistoryChangeDataCapture](docs/InsertionOrderHistoryChangeDataCapture.md) + - [JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301](docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md) + - [JsonApiBodyWithIdOfInt64AndAccountAndAccount](docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md) + - [JsonApiBodyWithIdOfInt64AndBrandAndBrand](docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md) + - [JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301](docs/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301.md) + - [JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus](docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md) + - [JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers](docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md) + - [JsonApiBodyWithIdOfInt64AndRetailerAndRetailer](docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md) + - [JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301](docs/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301.md) + - [JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest](docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest.md) + - [JsonApiPageResponseOfAccount](docs/JsonApiPageResponseOfAccount.md) + - [JsonApiPageResponseOfBrand](docs/JsonApiPageResponseOfBrand.md) + - [JsonApiPageResponseOfCampaignV202301](docs/JsonApiPageResponseOfCampaignV202301.md) + - [JsonApiPageResponseOfRetailer](docs/JsonApiPageResponseOfRetailer.md) + - [JsonApiRequestOfCatalogRequest](docs/JsonApiRequestOfCatalogRequest.md) + - [JsonApiSingleResponseOfCampaignV202301](docs/JsonApiSingleResponseOfCampaignV202301.md) + - [JsonApiSingleResponseOfCatalogStatus](docs/JsonApiSingleResponseOfCatalogStatus.md) + - [JsonApiSingleResponseOfLineItemBidMultipliers](docs/JsonApiSingleResponseOfLineItemBidMultipliers.md) + - [KeywordDataModel](docs/KeywordDataModel.md) + - [KeywordTarget202110Request](docs/KeywordTarget202110Request.md) + - [KeywordTarget202110Response](docs/KeywordTarget202110Response.md) + - [KeywordsModel](docs/KeywordsModel.md) + - [KeywordsModelResource](docs/KeywordsModelResource.md) + - [KeywordsModelResponse](docs/KeywordsModelResponse.md) + - [LineItemBidMultipliers](docs/LineItemBidMultipliers.md) + - [LineItemBidMultipliersRequest](docs/LineItemBidMultipliersRequest.md) + - [LineItemBidMultipliersResponse](docs/LineItemBidMultipliersResponse.md) + - [LineItemBudgetOverrides](docs/LineItemBudgetOverrides.md) + - [MatchTypeModel](docs/MatchTypeModel.md) + - [Metadata](docs/Metadata.md) + - [MonthlyLineItemBudegetOverride](docs/MonthlyLineItemBudegetOverride.md) + - [NegotiationStateModel](docs/NegotiationStateModel.md) + - [PageMetadata](docs/PageMetadata.md) + - [PageOfInsertionOrderHistoryChangeDataCapture](docs/PageOfInsertionOrderHistoryChangeDataCapture.md) + - [PageTypeEnvironment](docs/PageTypeEnvironment.md) + - [PostCampaignV202301](docs/PostCampaignV202301.md) + - [PreferredLineItem202110PagedListResponse](docs/PreferredLineItem202110PagedListResponse.md) + - [PreferredLineItem202110Response](docs/PreferredLineItem202110Response.md) + - [PreferredLineItemCreateModel202110Request](docs/PreferredLineItemCreateModel202110Request.md) + - [PreferredLineItemUpdateModel202110Request](docs/PreferredLineItemUpdateModel202110Request.md) + - [ProblemDetails](docs/ProblemDetails.md) + - [PromotedProduct202110ListRequest](docs/PromotedProduct202110ListRequest.md) + - [PromotedProduct202110PagedListResponse](docs/PromotedProduct202110PagedListResponse.md) + - [ProposalStatusModel](docs/ProposalStatusModel.md) + - [ProposalStatusModelResource](docs/ProposalStatusModelResource.md) + - [ProposalStatusModelResponse](docs/ProposalStatusModelResponse.md) + - [PutCampaignV202301](docs/PutCampaignV202301.md) + - [ReportOutcome](docs/ReportOutcome.md) + - [ResourceOfAddFundsToBalance](docs/ResourceOfAddFundsToBalance.md) + - [ResourceOfAuctionLineItem](docs/ResourceOfAuctionLineItem.md) + - [ResourceOfAuctionLineItemUpdateModel](docs/ResourceOfAuctionLineItemUpdateModel.md) + - [ResourceOfBalanceCampaign202110](docs/ResourceOfBalanceCampaign202110.md) + - [ResourceOfBalanceResponse](docs/ResourceOfBalanceResponse.md) + - [ResourceOfCategory202204](docs/ResourceOfCategory202204.md) + - [ResourceOfChangeDatesOfBalance](docs/ResourceOfChangeDatesOfBalance.md) + - [ResourceOfCommonLineItem](docs/ResourceOfCommonLineItem.md) + - [ResourceOfCreateBalance](docs/ResourceOfCreateBalance.md) + - [ResourceOfCreative202110](docs/ResourceOfCreative202110.md) + - [ResourceOfCreative202210](docs/ResourceOfCreative202210.md) + - [ResourceOfLineItemBidMultipliers](docs/ResourceOfLineItemBidMultipliers.md) + - [ResourceOfPreferredLineItem202110](docs/ResourceOfPreferredLineItem202110.md) + - [ResourceOfPreferredLineItemUpdateModel202110](docs/ResourceOfPreferredLineItemUpdateModel202110.md) + - [ResourceOfPromotedProduct202110](docs/ResourceOfPromotedProduct202110.md) + - [ResourceOfRetailMediaAccount](docs/ResourceOfRetailMediaAccount.md) + - [ResourceOfTemplate](docs/ResourceOfTemplate.md) + - [ResourceOfUpdateBalanceModel](docs/ResourceOfUpdateBalanceModel.md) + - [ResourceOutcome](docs/ResourceOutcome.md) + - [ResourceOutcomeOfRetailMediaAccount](docs/ResourceOutcomeOfRetailMediaAccount.md) + - [RetailMediaAccount](docs/RetailMediaAccount.md) + - [RetailMediaBrandAccountCreation](docs/RetailMediaBrandAccountCreation.md) + - [RetailMediaBrands](docs/RetailMediaBrands.md) + - [ReviewStateModel](docs/ReviewStateModel.md) + - [RmLegacyAudienceCreateEntityV1](docs/RmLegacyAudienceCreateEntityV1.md) + - [RmLegacyAudienceCreateEntityV1Resource](docs/RmLegacyAudienceCreateEntityV1Resource.md) + - [RmLegacyAudienceCreateEntityV1Response](docs/RmLegacyAudienceCreateEntityV1Response.md) + - [RmLegacyAudienceCreateEntityV2](docs/RmLegacyAudienceCreateEntityV2.md) + - [RmLegacyAudienceCreateEntityV2Resource](docs/RmLegacyAudienceCreateEntityV2Resource.md) + - [RmLegacyAudienceCreateEntityV2Response](docs/RmLegacyAudienceCreateEntityV2Response.md) + - [RmLegacyAudienceCreateInputEntityV1](docs/RmLegacyAudienceCreateInputEntityV1.md) + - [RmLegacyAudienceCreateInputEntityV2](docs/RmLegacyAudienceCreateInputEntityV2.md) + - [RmLegacyAudienceGetEntityV1](docs/RmLegacyAudienceGetEntityV1.md) + - [RmLegacyAudienceGetEntityV1ListResponse](docs/RmLegacyAudienceGetEntityV1ListResponse.md) + - [RmLegacyAudienceGetEntityV1Resource](docs/RmLegacyAudienceGetEntityV1Resource.md) + - [RmLegacyAudienceGetEntityV2](docs/RmLegacyAudienceGetEntityV2.md) + - [RmLegacyAudienceGetEntityV2ListResponse](docs/RmLegacyAudienceGetEntityV2ListResponse.md) + - [RmLegacyAudienceGetEntityV2Resource](docs/RmLegacyAudienceGetEntityV2Resource.md) + - [RmLegacyAudienceUserBehaviorCreateV2](docs/RmLegacyAudienceUserBehaviorCreateV2.md) + - [RmLegacyAudienceUserBehaviorDetailsV2](docs/RmLegacyAudienceUserBehaviorDetailsV2.md) + - [RmLegacySegmentCustomerList](docs/RmLegacySegmentCustomerList.md) + - [RmLegacySegmentUserBehaviorCreateV2](docs/RmLegacySegmentUserBehaviorCreateV2.md) + - [RmLegacySegmentUserBehaviorV1](docs/RmLegacySegmentUserBehaviorV1.md) + - [RmLegacySegmentUserBehaviorV2](docs/RmLegacySegmentUserBehaviorV2.md) + - [RmcaCommonProblem](docs/RmcaCommonProblem.md) + - [Section](docs/Section.md) + - [SetBidModel](docs/SetBidModel.md) + - [SetBidsModel](docs/SetBidsModel.md) + - [SetBidsModelRequest](docs/SetBidsModelRequest.md) + - [SetBidsModelResource](docs/SetBidsModelResource.md) + - [StatusResponse](docs/StatusResponse.md) + - [StatusResponseResource](docs/StatusResponseResource.md) + - [StoreIdsUpdateModel202110Request](docs/StoreIdsUpdateModel202110Request.md) + - [StoreTarget202110Request](docs/StoreTarget202110Request.md) + - [StoreTarget202110Response](docs/StoreTarget202110Response.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) + - [UpdateBalanceModelRequest](docs/UpdateBalanceModelRequest.md) + - [ValueResourceInputOfCampaignBudgetOverrides](docs/ValueResourceInputOfCampaignBudgetOverrides.md) + - [ValueResourceInputOfLineItemBudgetOverrides](docs/ValueResourceInputOfLineItemBudgetOverrides.md) + - [ValueResourceInputOfRetailMediaBrandAccountCreation](docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md) + - [ValueResourceInputOfRetailMediaBrands](docs/ValueResourceInputOfRetailMediaBrands.md) + - [ValueResourceOfCampaignBudgetOverrides](docs/ValueResourceOfCampaignBudgetOverrides.md) + - [ValueResourceOfLineItemBudgetOverrides](docs/ValueResourceOfLineItemBudgetOverrides.md) + - [ValueResourceOfRetailMediaBrandAccountCreation](docs/ValueResourceOfRetailMediaBrandAccountCreation.md) + - [ValueResourceOfRetailMediaBrands](docs/ValueResourceOfRetailMediaBrands.md) + - [ValueResourceOutcomeOfCampaignBudgetOverrides](docs/ValueResourceOutcomeOfCampaignBudgetOverrides.md) + - [ValueResourceOutcomeOfLineItemBudgetOverrides](docs/ValueResourceOutcomeOfLineItemBudgetOverrides.md) + - [ValueTypeResourceOfAddToBasketIdsUpdateModel202110](docs/ValueTypeResourceOfAddToBasketIdsUpdateModel202110.md) + - [ValueTypeResourceOfAddToBasketTarget202110](docs/ValueTypeResourceOfAddToBasketTarget202110.md) + - [ValueTypeResourceOfAudienceIdsUpdateModel202110](docs/ValueTypeResourceOfAudienceIdsUpdateModel202110.md) + - [ValueTypeResourceOfAudienceTarget202110](docs/ValueTypeResourceOfAudienceTarget202110.md) + - [ValueTypeResourceOfKeywordTarget202110](docs/ValueTypeResourceOfKeywordTarget202110.md) + - [ValueTypeResourceOfStoreIdsUpdateModel202110](docs/ValueTypeResourceOfStoreIdsUpdateModel202110.md) + - [ValueTypeResourceOfStoreTarget202110](docs/ValueTypeResourceOfStoreTarget202110.md) + + +## Disclaimer + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/__init__.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/__init__.py new file mode 100644 index 00000000..077d53c0 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/__init__.py @@ -0,0 +1,31 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +__version__ = "2024.04.0.240515" + +# import ApiClient +from criteo_api_retailmedia_v2024_04.api_client import ApiClient +from criteo_api_retailmedia_v2024_04.criteo_api_client import CriteoApiClient +from criteo_api_retailmedia_v2024_04.api_client_builder import ApiClientBuilder +from criteo_api_retailmedia_v2024_04 import flow_constants + +# import Configuration +from criteo_api_retailmedia_v2024_04.configuration import Configuration + +# import exceptions +from criteo_api_retailmedia_v2024_04.exceptions import OpenApiException +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiTypeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiValueError +from criteo_api_retailmedia_v2024_04.exceptions import ApiKeyError +from criteo_api_retailmedia_v2024_04.exceptions import ApiException + + + diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/__init__.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/__init__.py new file mode 100644 index 00000000..f6e836c2 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/__init__.py @@ -0,0 +1,3 @@ +# do not import all apis into this module because that uses a lot of memory and stack frames +# if you need the ability to import all apis from one package, import them with +# from criteo_api_retailmedia_v2024_04.apis import AccountsApi diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/accounts_api.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/accounts_api.py new file mode 100644 index 00000000..43d51d7d --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/accounts_api.py @@ -0,0 +1,476 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_retailmedia_v2024_04.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_retail_media_brand_account_creation import ValueResourceInputOfRetailMediaBrandAccountCreation +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands +from criteo_api_retailmedia_v2024_04.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands + + +class AccountsApi(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.add_brands_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOfRetailMediaBrands,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/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,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/account-management/accounts/{accountId}/create-brand-account', + 'operation_id': 'create_private_market_demand_brand_account', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'value_resource_input_of_retail_media_brand_account_creation', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'value_resource_input_of_retail_media_brand_account_creation': + (ValueResourceInputOfRetailMediaBrandAccountCreation,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'value_resource_input_of_retail_media_brand_account_creation': '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.remove_brands_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOfRetailMediaBrands,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/account-management/accounts/{accountId}/brands/remove', + 'operation_id': 'remove_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 + ) + + 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, + **kwargs + ): + """create_private_market_demand_brand_account # noqa: E501 + + Creates a new child Demand Brand Account for the provided parent private market 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.create_private_market_demand_brand_account(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): Account Id for the parent private market account + + Keyword Args: + 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 + 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: + ResourceOutcomeOfRetailMediaAccount + 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.create_private_market_demand_brand_account_endpoint.call_with_http_info(**kwargs) + + def remove_brands( + self, + account_id, + **kwargs + ): + """remove_brands # 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.remove_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): [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.remove_brands_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/analytics_api.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/analytics_api.py new file mode 100644 index 00000000..114ca943 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/analytics_api.py @@ -0,0 +1,739 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_retailmedia_v2024_04.model.async_campaigns_report_request import AsyncCampaignsReportRequest +from criteo_api_retailmedia_v2024_04.model.async_line_items_report_request import AsyncLineItemsReportRequest +from criteo_api_retailmedia_v2024_04.model.async_report_response import AsyncReportResponse +from criteo_api_retailmedia_v2024_04.model.async_revenue_report_request import AsyncRevenueReportRequest +from criteo_api_retailmedia_v2024_04.model.report_outcome import ReportOutcome + + +class AnalyticsApi(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.generate_async_campaigns_report_endpoint = _Endpoint( + settings={ + 'response_type': (AsyncReportResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/reports/campaigns', + 'operation_id': 'generate_async_campaigns_report', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'async_campaigns_report_request', + ], + 'required': [ + 'async_campaigns_report_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'async_campaigns_report_request': + (AsyncCampaignsReportRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'async_campaigns_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_line_items_report_endpoint = _Endpoint( + settings={ + 'response_type': (AsyncReportResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/reports/line-items', + 'operation_id': 'generate_async_line_items_report', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'async_line_items_report_request', + ], + 'required': [ + 'async_line_items_report_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'async_line_items_report_request': + (AsyncLineItemsReportRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'async_line_items_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_revenue_report_endpoint = _Endpoint( + settings={ + 'response_type': (AsyncReportResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/reports/revenue', + 'operation_id': 'generate_async_revenue_report', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'async_revenue_report_request', + ], + 'required': [ + 'async_revenue_report_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'async_revenue_report_request': + (AsyncRevenueReportRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'async_revenue_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.get_async_export_output_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/reports/{reportId}/output', + 'operation_id': 'get_async_export_output', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'report_id', + ], + 'required': [ + 'report_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'report_id': + (str,), + }, + 'attribute_map': { + 'report_id': 'reportId', + }, + 'location_map': { + 'report_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_async_export_status_endpoint = _Endpoint( + settings={ + 'response_type': (AsyncReportResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/reports/{reportId}/status', + 'operation_id': 'get_async_export_status', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'report_id', + ], + 'required': [ + 'report_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'report_id': + (str,), + }, + 'attribute_map': { + 'report_id': 'reportId', + }, + 'location_map': { + 'report_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def generate_async_campaigns_report( + self, + async_campaigns_report_request, + **kwargs + ): + """generate_async_campaigns_report # noqa: E501 + + Return an asynchronous Campaigns 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_campaigns_report(async_campaigns_report_request, async_req=True) + >>> result = thread.get() + + Args: + async_campaigns_report_request (AsyncCampaignsReportRequest): + + 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_campaigns_report_request'] = \ + async_campaigns_report_request + return self.generate_async_campaigns_report_endpoint.call_with_http_info(**kwargs) + + def generate_async_line_items_report( + self, + async_line_items_report_request, + **kwargs + ): + """generate_async_line_items_report # noqa: E501 + + Returns an asynchronous Line Items 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_line_items_report(async_line_items_report_request, async_req=True) + >>> result = thread.get() + + Args: + async_line_items_report_request (AsyncLineItemsReportRequest): + + 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_line_items_report_request'] = \ + async_line_items_report_request + return self.generate_async_line_items_report_endpoint.call_with_http_info(**kwargs) + + def generate_async_revenue_report( + self, + async_revenue_report_request, + **kwargs + ): + """generate_async_revenue_report # noqa: E501 + + Returns an asynchronous Revenue 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_revenue_report(async_revenue_report_request, async_req=True) + >>> result = thread.get() + + Args: + async_revenue_report_request (AsyncRevenueReportRequest): + + 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_revenue_report_request'] = \ + async_revenue_report_request + return self.generate_async_revenue_report_endpoint.call_with_http_info(**kwargs) + + def get_async_export_output( + self, + report_id, + **kwargs + ): + """get_async_export_output # noqa: E501 + + Returns the output of an async 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.get_async_export_output(report_id, async_req=True) + >>> result = thread.get() + + Args: + report_id (str): The ID of the report to retrieve + + 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: + str + 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['report_id'] = \ + report_id + return self.get_async_export_output_endpoint.call_with_http_info(**kwargs) + + def get_async_export_status( + self, + report_id, + **kwargs + ): + """get_async_export_status # noqa: E501 + + Returns the status of an async 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.get_async_export_status(report_id, async_req=True) + >>> result = thread.get() + + Args: + report_id (str): The ID of the report to retrieve + + 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['report_id'] = \ + report_id + return self.get_async_export_status_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/audience_api.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/audience_api.py new file mode 100644 index 00000000..4699fd1f --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/audience_api.py @@ -0,0 +1,657 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v2_response import RmLegacyAudienceCreateEntityV2Response +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_input_entity_v1 import RmLegacyAudienceCreateInputEntityV1 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_input_entity_v2 import RmLegacyAudienceCreateInputEntityV2 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse + + +class AudienceApi(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.legacy_create_audience_v1_endpoint = _Endpoint( + settings={ + 'response_type': (RmLegacyAudienceCreateEntityV1Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{accountId}/audiences', + 'operation_id': 'legacy_create_audience_v1', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'rm_legacy_audience_create_input_entity_v1', + ], + 'required': [ + 'account_id', + 'rm_legacy_audience_create_input_entity_v1', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (int,), + 'rm_legacy_audience_create_input_entity_v1': + (RmLegacyAudienceCreateInputEntityV1,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'rm_legacy_audience_create_input_entity_v1': '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.legacy_get_audience_v1_endpoint = _Endpoint( + settings={ + 'response_type': (RmLegacyAudienceGetEntityV1ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{accountId}/audiences', + 'operation_id': 'legacy_get_audience_v1', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'limit_to_id', + 'page_size', + 'page_index', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (int,), + 'limit_to_id': + ([int],), + 'page_size': + (int,), + 'page_index': + (int,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'limit_to_id': 'limitToId', + 'page_size': 'pageSize', + 'page_index': 'pageIndex', + }, + 'location_map': { + 'account_id': 'path', + 'limit_to_id': 'query', + 'page_size': 'query', + 'page_index': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.legacy_get_audience_v2_endpoint = _Endpoint( + settings={ + 'response_type': (RmLegacyAudienceGetEntityV2ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/v2/accounts/{accountId}/audiences', + 'operation_id': 'legacy_get_audience_v2', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'limit_to_id', + 'page_size', + 'page_index', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (int,), + 'limit_to_id': + ([int],), + 'page_size': + (int,), + 'page_index': + (int,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'limit_to_id': 'limitToId', + 'page_size': 'pageSize', + 'page_index': 'pageIndex', + }, + 'location_map': { + 'account_id': 'path', + 'limit_to_id': 'query', + 'page_size': 'query', + 'page_index': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.legacy_update_audience_v2_endpoint = _Endpoint( + settings={ + 'response_type': (RmLegacyAudienceCreateEntityV2Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/v2/accounts/{accountId}/audiences', + 'operation_id': 'legacy_update_audience_v2', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'rm_legacy_audience_create_input_entity_v2', + ], + 'required': [ + 'account_id', + 'rm_legacy_audience_create_input_entity_v2', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (int,), + 'rm_legacy_audience_create_input_entity_v2': + (RmLegacyAudienceCreateInputEntityV2,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'rm_legacy_audience_create_input_entity_v2': '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 + ) + + def legacy_create_audience_v1( + self, + account_id, + rm_legacy_audience_create_input_entity_v1, + **kwargs + ): + """legacy_create_audience_v1 # noqa: E501 + + Create an Audience (deprecated Public API) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.legacy_create_audience_v1(account_id, rm_legacy_audience_create_input_entity_v1, async_req=True) + >>> result = thread.get() + + Args: + account_id (int): ID of the account to which this audience belongs. + rm_legacy_audience_create_input_entity_v1 (RmLegacyAudienceCreateInputEntityV1): Audience creation request. + + 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: + RmLegacyAudienceCreateEntityV1Response + 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['rm_legacy_audience_create_input_entity_v1'] = \ + rm_legacy_audience_create_input_entity_v1 + return self.legacy_create_audience_v1_endpoint.call_with_http_info(**kwargs) + + def legacy_get_audience_v1( + self, + account_id, + **kwargs + ): + """legacy_get_audience_v1 # noqa: E501 + + Get a page of Audiences. (deprecated Public API) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.legacy_get_audience_v1(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (int): ID of the account to which this audience belongs. + + Keyword Args: + limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional] + page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional] + page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [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: + RmLegacyAudienceGetEntityV1ListResponse + 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.legacy_get_audience_v1_endpoint.call_with_http_info(**kwargs) + + def legacy_get_audience_v2( + self, + account_id, + **kwargs + ): + """legacy_get_audience_v2 # noqa: E501 + + Get a page of Audiences. (deprecated Public API) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.legacy_get_audience_v2(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (int): ID of the account to which this audience belongs. + + Keyword Args: + limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional] + page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional] + page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [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: + RmLegacyAudienceGetEntityV2ListResponse + 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.legacy_get_audience_v2_endpoint.call_with_http_info(**kwargs) + + def legacy_update_audience_v2( + self, + account_id, + rm_legacy_audience_create_input_entity_v2, + **kwargs + ): + """legacy_update_audience_v2 # noqa: E501 + + Create an Audience (deprecated Public API) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.legacy_update_audience_v2(account_id, rm_legacy_audience_create_input_entity_v2, async_req=True) + >>> result = thread.get() + + Args: + account_id (int): ID of the account to which this audience belongs. + rm_legacy_audience_create_input_entity_v2 (RmLegacyAudienceCreateInputEntityV2): Audience creation request. + + 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: + RmLegacyAudienceCreateEntityV2Response + 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['rm_legacy_audience_create_input_entity_v2'] = \ + rm_legacy_audience_create_input_entity_v2 + return self.legacy_update_audience_v2_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/campaign_api.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/campaign_api.py new file mode 100644 index 00000000..58d45a62 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/campaign_api.py @@ -0,0 +1,10406 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_retailmedia_v2024_04.model.add_funds_to_balance_request import AddFundsToBalanceRequest +from criteo_api_retailmedia_v2024_04.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2024_04.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_request import AddToBasketTarget202110Request +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_response import AddToBasketTarget202110Response +from criteo_api_retailmedia_v2024_04.model.asset_response import AssetResponse +from criteo_api_retailmedia_v2024_04.model.auction_line_item_create_model_request import AuctionLineItemCreateModelRequest +from criteo_api_retailmedia_v2024_04.model.auction_line_item_paged_list_response import AuctionLineItemPagedListResponse +from criteo_api_retailmedia_v2024_04.model.auction_line_item_response import AuctionLineItemResponse +from criteo_api_retailmedia_v2024_04.model.auction_line_item_update_model_request import AuctionLineItemUpdateModelRequest +from criteo_api_retailmedia_v2024_04.model.audience_ids_update_model202110_request import AudienceIdsUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.audience_target202110_request import AudienceTarget202110Request +from criteo_api_retailmedia_v2024_04.model.audience_target202110_response import AudienceTarget202110Response +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_list_request import BalanceCampaign202110ListRequest +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse +from criteo_api_retailmedia_v2024_04.model.balance_response_paged_list_response import BalanceResponsePagedListResponse +from criteo_api_retailmedia_v2024_04.model.category202204 import Category202204 +from criteo_api_retailmedia_v2024_04.model.category202204_list_response import Category202204ListResponse +from criteo_api_retailmedia_v2024_04.model.change_dates_of_balance_request import ChangeDatesOfBalanceRequest +from criteo_api_retailmedia_v2024_04.model.common_line_item_paged_list_response import CommonLineItemPagedListResponse +from criteo_api_retailmedia_v2024_04.model.common_line_item_response import CommonLineItemResponse +from criteo_api_retailmedia_v2024_04.model.create_balance_request import CreateBalanceRequest +from criteo_api_retailmedia_v2024_04.model.creative202110_list_response import Creative202110ListResponse +from criteo_api_retailmedia_v2024_04.model.creative202210_list_response import Creative202210ListResponse +from criteo_api_retailmedia_v2024_04.model.creative202210_response import Creative202210Response +from criteo_api_retailmedia_v2024_04.model.creative_create_model202207 import CreativeCreateModel202207 +from criteo_api_retailmedia_v2024_04.model.creative_update_model202207 import CreativeUpdateModel202207 +from criteo_api_retailmedia_v2024_04.model.external_retailer_pages202110 import ExternalRetailerPages202110 +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_campaign_v202301 import JsonApiPageResponseOfCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer +from criteo_api_retailmedia_v2024_04.model.json_api_request_of_catalog_request import JsonApiRequestOfCatalogRequest +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_request import KeywordTarget202110Request +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2024_04.model.keywords_model_response import KeywordsModelResponse +from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest +from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse +from criteo_api_retailmedia_v2024_04.model.page_of_insertion_order_history_change_data_capture import PageOfInsertionOrderHistoryChangeDataCapture +from criteo_api_retailmedia_v2024_04.model.post_campaign_v202301 import PostCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.preferred_line_item202110_paged_list_response import PreferredLineItem202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.preferred_line_item202110_response import PreferredLineItem202110Response +from criteo_api_retailmedia_v2024_04.model.preferred_line_item_create_model202110_request import PreferredLineItemCreateModel202110Request +from criteo_api_retailmedia_v2024_04.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_v2024_04.model.put_campaign_v202301 import PutCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2024_04.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2024_04.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.store_target202110_request import StoreTarget202110Request +from criteo_api_retailmedia_v2024_04.model.store_target202110_response import StoreTarget202110Response +from criteo_api_retailmedia_v2024_04.model.template_list_response import TemplateListResponse +from criteo_api_retailmedia_v2024_04.model.template_response import TemplateResponse +from criteo_api_retailmedia_v2024_04.model.update_balance_model_request import UpdateBalanceModelRequest +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_campaign_budget_overrides import ValueResourceInputOfCampaignBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_line_item_budget_overrides import ValueResourceInputOfLineItemBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_outcome_of_campaign_budget_overrides import ValueResourceOutcomeOfCampaignBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_outcome_of_line_item_budget_overrides import ValueResourceOutcomeOfLineItemBudgetOverrides + + +class CampaignApi(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.add_remove_keywords_endpoint = _Endpoint( + settings={ + 'response_type': (ResourceOutcome,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{id}/keywords/add-remove', + 'operation_id': 'add_remove_keywords', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'add_remove_keywords_model_request', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'add_remove_keywords_model_request': + (AddRemoveKeywordsModelRequest,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'add_remove_keywords_model_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.create_asset_endpoint = _Endpoint( + settings={ + 'response_type': (AssetResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/assets', + 'operation_id': 'create_asset', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'asset_file', + ], + 'required': [ + 'asset_file', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'asset_file': + (file_type,), + }, + 'attribute_map': { + 'asset_file': 'AssetFile', + }, + 'location_map': { + 'asset_file': 'form', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [ + 'multipart/form-data' + ] + }, + api_client=api_client + ) + self.fetch_keywords_endpoint = _Endpoint( + settings={ + 'response_type': (KeywordsModelResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{id}/keywords', + 'operation_id': 'fetch_keywords', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.fetch_proposal_endpoint = _Endpoint( + settings={ + 'response_type': (ProposalStatusModelResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-deal-line-items/{id}/proposal', + 'operation_id': 'fetch_proposal', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_account_creatives_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (Creative202110ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/creatives', + 'operation_id': 'get_api202110_external_account_creatives_by_account_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + }, + 'attribute_map': { + 'account_id': 'account-id', + }, + 'location_map': { + 'account_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (KeywordTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/auction-line-items/{line-item-id}/targeting/keywords', + 'operation_id': 'get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_balance_campaigns_by_balance_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceCampaign202110PagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/balances/{balance-id}/campaigns', + 'operation_id': 'get_api202110_external_balance_campaigns_by_balance_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'balance_id', + 'limit_to_id', + 'page_index', + 'page_size', + ], + 'required': [ + 'balance_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'balance_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'balance_id': 'balance-id', + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'balance_id': 'path', + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint( + settings={ + 'response_type': (PreferredLineItem202110PagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/campaigns/{campaign-id}/preferred-line-items', + 'operation_id': 'get_api202110_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', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + '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={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_line_item_products_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (PromotedProduct202110PagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{line-item-id}/products', + 'operation_id': 'get_api202110_external_line_item_products_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'limit_to_id', + 'page_index', + 'page_size', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'line_item_id': 'path', + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (PreferredLineItem202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}', + 'operation_id': 'get_api202110_external_preferred_line_item_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AddToBasketTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket', + 'operation_id': 'get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/audiences', + 'operation_id': 'get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (StoreTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/stores', + 'operation_id': 'get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202110_external_retailer_pages_by_retailer_id_endpoint = _Endpoint( + settings={ + 'response_type': (ExternalRetailerPages202110,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/retailers/{retailerId}/pages', + 'operation_id': 'get_api202110_external_retailer_pages_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': 'retailerId', + }, + 'location_map': { + 'retailer_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202204_external_categorie_by_category_id_endpoint = _Endpoint( + settings={ + 'response_type': (Category202204,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/categories/{categoryId}', + 'operation_id': 'get_api202204_external_categorie_by_category_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'category_id', + ], + 'required': [ + 'category_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'category_id': + (int,), + }, + 'attribute_map': { + 'category_id': 'categoryId', + }, + 'location_map': { + 'category_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202204_external_categories_endpoint = _Endpoint( + settings={ + 'response_type': (Category202204ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/categories', + 'operation_id': 'get_api202204_external_categories', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'retailer_id', + 'text_substring', + 'page_index', + 'page_size', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'page_index', + 'page_size', + ] + }, + root_map={ + 'validations': { + ('page_index',): { + + 'inclusive_maximum': 500, + 'inclusive_minimum': 0, + }, + ('page_size',): { + + 'inclusive_maximum': 100, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'retailer_id': + (int,), + 'text_substring': + (str,), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'retailer_id': 'retailerId', + 'text_substring': 'textSubstring', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'retailer_id': 'query', + 'text_substring': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + 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': '/2024-04/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': '/2024-04/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': '/2024-04/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_api202301_external_account_campaigns_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPageResponseOfCampaignV202301,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/campaigns', + 'operation_id': 'get_api202301_external_account_campaigns_by_account_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'limit_to_id', + 'page_index', + 'page_size', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'account_id': 'path', + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202301_external_campaign_by_campaign_id_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiSingleResponseOfCampaignV202301,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/campaigns/{campaignId}', + 'operation_id': 'get_api202301_external_campaign_by_campaign_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'campaign_id', + ], + 'required': [ + 'campaign_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (str,), + }, + 'attribute_map': { + 'campaign_id': 'campaignId', + }, + 'location_map': { + 'campaign_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiSingleResponseOfLineItemBidMultipliers,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{line-item-id}/bid-multipliers', + 'operation_id': 'get_api202301_external_line_item_bid_multipliers_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api_v1_external_account_balances_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceResponsePagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances', + 'operation_id': 'get_api_v1_external_account_balances_by_account_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'limit_to_id', + 'page_index', + 'page_size', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'account_id': 'path', + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + 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,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{accountId}/brands', + 'operation_id': 'get_api_v1_external_account_brands_by_account_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'limit_to_id', + 'page_index', + 'page_size', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'account_id': 'path', + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api_v1_external_account_by_account_id_and_balance_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}', + 'operation_id': 'get_api_v1_external_account_by_account_id_and_balance_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'balance_id', + ], + 'required': [ + 'account_id', + 'balance_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'balance_id': + (str,), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'balance_id': 'balanceId', + }, + 'location_map': { + 'account_id': 'path', + 'balance_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api_v1_external_account_retailers_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPageResponseOfRetailer,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{accountId}/retailers', + 'operation_id': 'get_api_v1_external_account_retailers_by_account_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'limit_to_id', + 'page_index', + 'page_size', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'account_id': 'accountId', + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'account_id': 'path', + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api_v1_external_accounts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPageResponseOfAccount,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts', + 'operation_id': 'get_api_v1_external_accounts', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'limit_to_id', + 'page_index', + 'page_size', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api_v1_external_catalog_output_by_catalog_id_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/catalogs/{catalogId}/output', + 'operation_id': 'get_api_v1_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_v1_external_catalog_status_by_catalog_id_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiSingleResponseOfCatalogStatus,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/catalogs/{catalogId}/status', + 'operation_id': 'get_api_v1_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_v2_external_account_line_items_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (CommonLineItemPagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/line-items', + 'operation_id': 'get_api_v2_external_account_line_items_by_account_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'limit_to_campaign_id', + 'limit_to_type', + 'limit_to_id', + 'page_index', + 'page_size', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + 'limit_to_type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('limit_to_type',): { + + "UNKNOWN": "Unknown", + "AUCTION": "Auction", + "PREFERRED": "Preferred" + }, + }, + 'openapi_types': { + 'account_id': + (str,), + 'limit_to_campaign_id': + ([str],), + 'limit_to_type': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'limit_to_campaign_id': 'limitToCampaignId', + 'limit_to_type': 'limitToType', + 'limit_to_id': 'limitToId', + 'page_index': 'pageIndex', + 'page_size': 'pageSize', + }, + 'location_map': { + 'account_id': 'path', + 'limit_to_campaign_id': 'query', + 'limit_to_type': 'query', + 'limit_to_id': 'query', + 'page_index': 'query', + 'page_size': 'query', + }, + 'collection_format_map': { + 'limit_to_campaign_id': 'multi', + 'limit_to_id': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api_v2_external_auction_line_item_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AuctionLineItemResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/auction-line-items/{line-item-id}', + 'operation_id': 'get_api_v2_external_auction_line_item_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api_v2_external_campaign_auction_line_items_by_campaign_id_endpoint = _Endpoint( + settings={ + 'response_type': (AuctionLineItemPagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/campaigns/{campaign-id}/auction-line-items', + 'operation_id': 'get_api_v2_external_campaign_auction_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', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (str,), + 'limit_to_id': + ([str],), + 'page_index': + (int,), + 'page_size': + (int,), + }, + 'attribute_map': { + '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={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_api_v2_external_line_item_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (CommonLineItemResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{line-item-id}', + 'operation_id': 'get_api_v2_external_line_item_by_line_item_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_campaign_budget_overrides_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/campaigns/{campaignId}/campaign-budget-overrides', + 'operation_id': 'get_campaign_budget_overrides', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'campaign_id', + ], + 'required': [ + 'campaign_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (int,), + }, + 'attribute_map': { + 'campaign_id': 'campaignId', + }, + 'location_map': { + 'campaign_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_insertion_order_history_change_data_capture_endpoint = _Endpoint( + settings={ + 'response_type': (PageOfInsertionOrderHistoryChangeDataCapture,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/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': [ + 'insertion_order_id', + 'offset', + 'limit', + 'limit_to_change_types', + ], + 'required': [ + 'insertion_order_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'offset', + 'limit', + ] + }, + root_map={ + 'validations': { + ('offset',): { + + 'inclusive_maximum': 2147483647, + 'inclusive_minimum': 0, + }, + ('limit',): { + + 'inclusive_maximum': 100, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'insertion_order_id': + (str,), + 'offset': + (int,), + 'limit': + (int,), + 'limit_to_change_types': + (str,), + }, + 'attribute_map': { + 'insertion_order_id': 'insertionOrderId', + 'offset': 'offset', + 'limit': 'limit', + 'limit_to_change_types': 'limitToChangeTypes', + }, + 'location_map': { + 'insertion_order_id': 'path', + 'offset': 'query', + 'limit': 'query', + 'limit_to_change_types': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_line_item_budget_overrides_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOutcomeOfLineItemBudgetOverrides,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{lineItemId}/line-item-budget-overrides', + 'operation_id': 'get_line_item_budget_overrides', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'lineItemId', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_api_v1_external_account_by_account_id_and_balance_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}', + 'operation_id': 'patch_api_v1_external_account_by_account_id_and_balance_id', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'balance_id', + 'update_balance_model_request', + ], + 'required': [ + 'account_id', + 'balance_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'balance_id': + (str,), + 'update_balance_model_request': + (UpdateBalanceModelRequest,), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'balance_id': 'balanceId', + }, + 'location_map': { + 'account_id': 'path', + 'balance_id': 'path', + 'update_balance_model_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (KeywordTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/auction-line-items/{line-item-id}/targeting/keywords/append', + 'operation_id': 'post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'keyword_target202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'keyword_target202110_request': + (KeywordTarget202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'keyword_target202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (KeywordTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/auction-line-items/{line-item-id}/targeting/keywords/delete', + 'operation_id': 'post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'keyword_target202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'keyword_target202110_request': + (KeywordTarget202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'keyword_target202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_balance_campaigns_append_by_balance_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceCampaign202110PagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/balances/{balance-id}/campaigns/append', + 'operation_id': 'post_api202110_external_balance_campaigns_append_by_balance_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'balance_id', + 'balance_campaign202110_list_request', + ], + 'required': [ + 'balance_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'balance_id': + (str,), + 'balance_campaign202110_list_request': + (BalanceCampaign202110ListRequest,), + }, + 'attribute_map': { + 'balance_id': 'balance-id', + }, + 'location_map': { + 'balance_id': 'path', + 'balance_campaign202110_list_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_balance_campaigns_delete_by_balance_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceCampaign202110PagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/balances/{balance-id}/campaigns/delete', + 'operation_id': 'post_api202110_external_balance_campaigns_delete_by_balance_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'balance_id', + 'balance_campaign202110_list_request', + ], + 'required': [ + 'balance_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'balance_id': + (str,), + 'balance_campaign202110_list_request': + (BalanceCampaign202110ListRequest,), + }, + 'attribute_map': { + 'balance_id': 'balance-id', + }, + 'location_map': { + 'balance_id': 'path', + 'balance_campaign202110_list_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint( + settings={ + 'response_type': (PreferredLineItem202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/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': [ + 'campaign_id', + 'preferred_line_item_create_model202110_request', + ], + 'required': [ + 'campaign_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (str,), + 'preferred_line_item_create_model202110_request': + (PreferredLineItemCreateModel202110Request,), + }, + 'attribute_map': { + 'campaign_id': 'campaign-id', + }, + 'location_map': { + 'campaign_id': 'path', + 'preferred_line_item_create_model202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_line_item_products_append_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (PromotedProduct202110PagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{line-item-id}/products/append', + 'operation_id': 'post_api202110_external_line_item_products_append_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'promoted_product202110_list_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'promoted_product202110_list_request': + (PromotedProduct202110ListRequest,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'promoted_product202110_list_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_line_item_products_delete_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (PromotedProduct202110PagedListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{line-item-id}/products/delete', + 'operation_id': 'post_api202110_external_line_item_products_delete_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'promoted_product202110_list_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'promoted_product202110_list_request': + (PromotedProduct202110ListRequest,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'promoted_product202110_list_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_line_item_products_pause_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{line-item-id}/products/pause', + 'operation_id': 'post_api202110_external_line_item_products_pause_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'promoted_product202110_list_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'promoted_product202110_list_request': + (PromotedProduct202110ListRequest,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'promoted_product202110_list_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_line_item_products_unpause_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{line-item-id}/products/unpause', + 'operation_id': 'post_api202110_external_line_item_products_unpause_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'promoted_product202110_list_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'promoted_product202110_list_request': + (PromotedProduct202110ListRequest,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'promoted_product202110_list_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AddToBasketTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append', + 'operation_id': 'post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'add_to_basket_ids_update_model202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'add_to_basket_ids_update_model202110_request': + (AddToBasketIdsUpdateModel202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'add_to_basket_ids_update_model202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AddToBasketTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete', + 'operation_id': 'post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'add_to_basket_ids_update_model202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'add_to_basket_ids_update_model202110_request': + (AddToBasketIdsUpdateModel202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'add_to_basket_ids_update_model202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append', + 'operation_id': 'post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'audience_ids_update_model202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'audience_ids_update_model202110_request': + (AudienceIdsUpdateModel202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'audience_ids_update_model202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete', + 'operation_id': 'post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'audience_ids_update_model202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'audience_ids_update_model202110_request': + (AudienceIdsUpdateModel202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'audience_ids_update_model202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (StoreTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append', + 'operation_id': 'post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'store_ids_update_model202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'store_ids_update_model202110_request': + (StoreIdsUpdateModel202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'store_ids_update_model202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (StoreTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete', + 'operation_id': 'post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'store_ids_update_model202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'store_ids_update_model202110_request': + (StoreIdsUpdateModel202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'store_ids_update_model202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202210_external_account_creatives_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (Creative202210Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/creatives', + 'operation_id': 'post_api202210_external_account_creatives_by_account_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'creative_create_model202207', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'creative_create_model202207': + (CreativeCreateModel202207,), + }, + 'attribute_map': { + 'account_id': 'account-id', + }, + 'location_map': { + 'account_id': 'path', + 'creative_create_model202207': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api202210_external_account_creatives_search_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (Creative202210ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/creatives/search', + 'operation_id': 'post_api202210_external_account_creatives_search_by_account_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'creative_ids', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'creative_ids': + ([str],), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'creative_ids': 'creative-ids', + }, + 'location_map': { + 'account_id': 'path', + 'creative_ids': 'query', + }, + 'collection_format_map': { + 'creative_ids': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.post_api202301_external_account_campaigns_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiSingleResponseOfCampaignV202301,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/campaigns', + 'operation_id': 'post_api202301_external_account_campaigns_by_account_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'post_campaign_v202301', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'post_campaign_v202301': + (PostCampaignV202301,), + }, + 'attribute_map': { + 'account_id': 'account-id', + }, + 'location_map': { + 'account_id': 'path', + 'post_campaign_v202301': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api_v1_external_account_add_funds_by_account_id_and_balance_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}/add-funds', + 'operation_id': 'post_api_v1_external_account_add_funds_by_account_id_and_balance_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'balance_id', + 'add_funds_to_balance_request', + ], + 'required': [ + 'account_id', + 'balance_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'balance_id': + (str,), + 'add_funds_to_balance_request': + (AddFundsToBalanceRequest,), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'balance_id': 'balanceId', + }, + 'location_map': { + 'account_id': 'path', + 'balance_id': 'path', + 'add_funds_to_balance_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api_v1_external_account_balances_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances', + 'operation_id': 'post_api_v1_external_account_balances_by_account_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'create_balance_request', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'create_balance_request': + (CreateBalanceRequest,), + }, + 'attribute_map': { + 'account_id': 'account-id', + }, + 'location_map': { + 'account_id': 'path', + 'create_balance_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api_v1_external_account_catalogs_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiSingleResponseOfCatalogStatus,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{accountId}/catalogs', + 'operation_id': 'post_api_v1_external_account_catalogs_by_account_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'json_api_request_of_catalog_request', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'json_api_request_of_catalog_request': + (JsonApiRequestOfCatalogRequest,), + }, + 'attribute_map': { + 'account_id': 'accountId', + }, + 'location_map': { + 'account_id': 'path', + 'json_api_request_of_catalog_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api_v1_external_account_change_dates_by_account_id_and_balance_id_endpoint = _Endpoint( + settings={ + 'response_type': (BalanceResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}/change-dates', + 'operation_id': 'post_api_v1_external_account_change_dates_by_account_id_and_balance_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'balance_id', + 'change_dates_of_balance_request', + ], + 'required': [ + 'account_id', + 'balance_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'balance_id': + (str,), + 'change_dates_of_balance_request': + (ChangeDatesOfBalanceRequest,), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'balance_id': 'balanceId', + }, + 'location_map': { + 'account_id': 'path', + 'balance_id': 'path', + 'change_dates_of_balance_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api_v2_external_campaign_auction_line_items_by_campaign_id_endpoint = _Endpoint( + settings={ + 'response_type': (AuctionLineItemResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/campaigns/{campaign-id}/auction-line-items', + 'operation_id': 'post_api_v2_external_campaign_auction_line_items_by_campaign_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'campaign_id', + 'auction_line_item_create_model_request', + ], + 'required': [ + 'campaign_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (str,), + 'auction_line_item_create_model_request': + (AuctionLineItemCreateModelRequest,), + }, + 'attribute_map': { + 'campaign_id': 'campaign-id', + }, + 'location_map': { + 'campaign_id': 'path', + 'auction_line_item_create_model_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (PreferredLineItem202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/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': [ + 'line_item_id', + 'preferred_line_item_update_model202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'preferred_line_item_update_model202110_request': + (PreferredLineItemUpdateModel202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'preferred_line_item_update_model202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AddToBasketTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket', + 'operation_id': 'put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'add_to_basket_target202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'add_to_basket_target202110_request': + (AddToBasketTarget202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'add_to_basket_target202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AudienceTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/audiences', + 'operation_id': 'put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'audience_target202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'audience_target202110_request': + (AudienceTarget202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'audience_target202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (StoreTarget202110Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/stores', + 'operation_id': 'put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'store_target202110_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'store_target202110_request': + (StoreTarget202110Request,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'store_target202110_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.put_api202210_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint( + settings={ + 'response_type': (Creative202210Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/creatives/{creative-id}', + 'operation_id': 'put_api202210_external_account_by_account_id_creativescreative_id', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'creative_id', + 'creative_update_model202207', + ], + 'required': [ + 'account_id', + 'creative_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'creative_id': + (str,), + 'creative_update_model202207': + (CreativeUpdateModel202207,), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'creative_id': 'creative-id', + }, + 'location_map': { + 'account_id': 'path', + 'creative_id': 'path', + 'creative_update_model202207': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.put_api202301_external_campaign_by_campaign_id_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiSingleResponseOfCampaignV202301,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/campaigns/{campaignId}', + 'operation_id': 'put_api202301_external_campaign_by_campaign_id', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'campaign_id', + 'put_campaign_v202301', + ], + 'required': [ + 'campaign_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (str,), + 'put_campaign_v202301': + (PutCampaignV202301,), + }, + 'attribute_map': { + 'campaign_id': 'campaignId', + }, + 'location_map': { + 'campaign_id': 'path', + 'put_campaign_v202301': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.put_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (LineItemBidMultipliersResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{line-item-id}/bid-multipliers', + 'operation_id': 'put_api202301_external_line_item_bid_multipliers_by_line_item_id', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'line_item_bid_multipliers_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'line_item_bid_multipliers_request': + (LineItemBidMultipliersRequest,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'line_item_bid_multipliers_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.put_api_v2_external_auction_line_item_by_line_item_id_endpoint = _Endpoint( + settings={ + 'response_type': (AuctionLineItemResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/auction-line-items/{line-item-id}', + 'operation_id': 'put_api_v2_external_auction_line_item_by_line_item_id', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'auction_line_item_update_model_request', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'auction_line_item_update_model_request': + (AuctionLineItemUpdateModelRequest,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + 'auction_line_item_update_model_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.set_keyword_bids_endpoint = _Endpoint( + settings={ + 'response_type': (ResourceOutcome,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{id}/keywords/set-bid', + 'operation_id': 'set_keyword_bids', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'set_bids_model_request', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'set_bids_model_request': + (SetBidsModelRequest,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'set_bids_model_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.submit_proposal_endpoint = _Endpoint( + settings={ + 'response_type': (ProposalStatusModelResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/preferred-deal-line-items/{id}/proposal/submit', + 'operation_id': 'submit_proposal', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_campaign_budget_overrides_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/campaigns/{campaignId}/campaign-budget-overrides', + 'operation_id': 'update_campaign_budget_overrides', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'campaign_id', + 'value_resource_input_of_campaign_budget_overrides', + ], + 'required': [ + 'campaign_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'campaign_id': + (int,), + 'value_resource_input_of_campaign_budget_overrides': + (ValueResourceInputOfCampaignBudgetOverrides,), + }, + 'attribute_map': { + 'campaign_id': 'campaignId', + }, + 'location_map': { + 'campaign_id': 'path', + 'value_resource_input_of_campaign_budget_overrides': '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.update_line_item_budget_overrides_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOutcomeOfLineItemBudgetOverrides,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/line-items/{lineItemId}/line-item-budget-overrides', + 'operation_id': 'update_line_item_budget_overrides', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'value_resource_input_of_line_item_budget_overrides', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'value_resource_input_of_line_item_budget_overrides': + (ValueResourceInputOfLineItemBudgetOverrides,), + }, + 'attribute_map': { + 'line_item_id': 'lineItemId', + }, + 'location_map': { + 'line_item_id': 'path', + 'value_resource_input_of_line_item_budget_overrides': '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 + ) + + def add_remove_keywords( + self, + id, + **kwargs + ): + """add_remove_keywords # noqa: E501 + + Add or Remove keywords from the line item in bulk # 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_remove_keywords(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the line item + + Keyword Args: + add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [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: + ResourceOutcome + 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.add_remove_keywords_endpoint.call_with_http_info(**kwargs) + + def create_asset( + self, + asset_file, + **kwargs + ): + """create_asset # noqa: E501 + + Creates an asset # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_asset(asset_file, async_req=True) + >>> result = thread.get() + + Args: + asset_file (file_type): The asset binary content + + 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: + AssetResponse + 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['asset_file'] = \ + asset_file + return self.create_asset_endpoint.call_with_http_info(**kwargs) + + def fetch_keywords( + self, + id, + **kwargs + ): + """fetch_keywords # noqa: E501 + + Fetch keywords associated with the specified 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_keywords(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the 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: + KeywordsModelResponse + 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_keywords_endpoint.call_with_http_info(**kwargs) + + def fetch_proposal( + self, + id, + **kwargs + ): + """fetch_proposal # noqa: E501 + + Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. # 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): ID of the 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: + ProposalStatusModelResponse + 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_api202110_external_account_creatives_by_account_id( + self, + account_id, + **kwargs + ): + """get_api202110_external_account_creatives_by_account_id # noqa: E501 + + Get account creatives # 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_api202110_external_account_creatives_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): External account id to retrieve creatives 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: + Creative202110ListResponse + 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.get_api202110_external_account_creatives_by_account_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id # noqa: E501 + + This endpoint gets the keyword target on the specified 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_api202110_external_auction_line_item_targeting_keywords_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + 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: + KeywordTarget202110Response + 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_api202110_external_auction_line_item_targeting_keywords_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_balance_campaigns_by_balance_id( + self, + balance_id, + **kwargs + ): + """get_api202110_external_balance_campaigns_by_balance_id # noqa: E501 + + Gets page of campaigns for the given balanceId # 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_api202110_external_balance_campaigns_by_balance_id(balance_id, async_req=True) + >>> result = thread.get() + + Args: + balance_id (str): The balance to get campaigns from + + 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 + 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: + BalanceCampaign202110PagedListResponse + 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['balance_id'] = \ + balance_id + return self.get_api202110_external_balance_campaigns_by_balance_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_campaign_preferred_line_items_by_campaign_id( + self, + campaign_id, + **kwargs + ): + """get_api202110_external_campaign_preferred_line_items_by_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_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + 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 + 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: + PreferredLineItem202110PagedListResponse + 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['campaign_id'] = \ + campaign_id + return self.get_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_line_item_products_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api202110_external_line_item_products_by_line_item_id # noqa: E501 + + This endpoint gets the promoted products on the specified 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_api202110_external_line_item_products_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + 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 + 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: + PromotedProduct202110PagedListResponse + 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_api202110_external_line_item_products_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_preferred_line_item_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api202110_external_preferred_line_item_by_line_item_id # 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_api202110_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The given line item 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: + PreferredLineItem202110Response + 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_api202110_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id # noqa: E501 + + This endpoint gets the add to basket target on the specified 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_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + 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: + AddToBasketTarget202110Response + 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_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id # noqa: E501 + + This endpoint gets the audience target on the specified 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_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + 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: + AudienceTarget202110Response + 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_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id # noqa: E501 + + This endpoint gets the store target on the specified 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_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + 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: + StoreTarget202110Response + 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_api202110_external_preferred_line_item_targeting_stores_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_api202110_external_retailer_pages_by_retailer_id( + self, + retailer_id, + **kwargs + ): + """get_api202110_external_retailer_pages_by_retailer_id # noqa: E501 + + Get the page types available for the given retailer # 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_api202110_external_retailer_pages_by_retailer_id(retailer_id, async_req=True) + >>> result = thread.get() + + Args: + retailer_id (int): The retailers to fetch pages 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: + ExternalRetailerPages202110 + 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_api202110_external_retailer_pages_by_retailer_id_endpoint.call_with_http_info(**kwargs) + + def get_api202204_external_categorie_by_category_id( + self, + category_id, + **kwargs + ): + """get_api202204_external_categorie_by_category_id # noqa: E501 + + Endpoint to search for a specific category by categoryId. # 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_api202204_external_categorie_by_category_id(category_id, async_req=True) + >>> result = thread.get() + + Args: + category_id (int): ID of the desired category + + 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: + Category202204 + 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['category_id'] = \ + category_id + return self.get_api202204_external_categorie_by_category_id_endpoint.call_with_http_info(**kwargs) + + def get_api202204_external_categories( + self, + **kwargs + ): + """get_api202204_external_categories # noqa: E501 + + Endpoint to search categories by text and retailer. # 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_api202204_external_categories(async_req=True) + >>> result = thread.get() + + + Keyword Args: + retailer_id (int): The retailer id for which Categories fetched. [optional] + text_substring (str): Query string to search across Categories. [optional] + page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 + page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100 + _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: + Category202204ListResponse + 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) + return self.get_api202204_external_categories_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_api202301_external_account_campaigns_by_account_id( + self, + account_id, + **kwargs + ): + """get_api202301_external_account_campaigns_by_account_id # noqa: E501 + + Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign 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.get_api202301_external_account_campaigns_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account to request the campaign for. + + 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] if omitted the server will use the default value of 0 + page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25 + _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: + JsonApiPageResponseOfCampaignV202301 + 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.get_api202301_external_account_campaigns_by_account_id_endpoint.call_with_http_info(**kwargs) + + def get_api202301_external_campaign_by_campaign_id( + self, + campaign_id, + **kwargs + ): + """get_api202301_external_campaign_by_campaign_id # noqa: E501 + + Get all the editable and creatable campaign attributes including all types of budgets given the 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_api202301_external_campaign_by_campaign_id(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + campaign_id (str): Campaign Id of the campaign detail + + 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: + JsonApiSingleResponseOfCampaignV202301 + 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['campaign_id'] = \ + campaign_id + return self.get_api202301_external_campaign_by_campaign_id_endpoint.call_with_http_info(**kwargs) + + def get_api202301_external_line_item_bid_multipliers_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api202301_external_line_item_bid_multipliers_by_line_item_id # 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_api202301_external_line_item_bid_multipliers_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: + JsonApiSingleResponseOfLineItemBidMultipliers + 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_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_account_balances_by_account_id( + self, + account_id, + **kwargs + ): + """get_api_v1_external_account_balances_by_account_id # noqa: E501 + + Get page of balances for the given accountId. # 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_v1_external_account_balances_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account to get page of balances for + + 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] if omitted the server will use the default value of 0 + page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25 + _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: + BalanceResponsePagedListResponse + 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.get_api_v1_external_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_account_brands_by_account_id( + self, + account_id, + **kwargs + ): + """get_api_v1_external_account_brands_by_account_id # noqa: E501 + + Gets page of retailer objects that are associated with the given 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.get_api_v1_external_account_brands_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The given account 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 + 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: + JsonApiPageResponseOfBrand + 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.get_api_v1_external_account_brands_by_account_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_account_by_account_id_and_balance_id( + self, + account_id, + balance_id, + **kwargs + ): + """get_api_v1_external_account_by_account_id_and_balance_id # noqa: E501 + + Get a balance for the given account id and balance 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_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account of the balance + balance_id (str): The balance 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: + BalanceResponse + 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['balance_id'] = \ + balance_id + return self.get_api_v1_external_account_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_account_retailers_by_account_id( + self, + account_id, + **kwargs + ): + """get_api_v1_external_account_retailers_by_account_id # noqa: E501 + + Gets page of retailer objects that are associated with the given 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.get_api_v1_external_account_retailers_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The given account 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 + 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: + JsonApiPageResponseOfRetailer + 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.get_api_v1_external_account_retailers_by_account_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_accounts( + self, + **kwargs + ): + """get_api_v1_external_accounts # noqa: E501 + + Gets page of account objects that the current user can access # 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_v1_external_accounts(async_req=True) + >>> result = thread.get() + + + 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 + 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: + JsonApiPageResponseOfAccount + 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) + return self.get_api_v1_external_accounts_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_catalog_output_by_catalog_id( + self, + catalog_id, + **kwargs + ): + """get_api_v1_external_catalog_output_by_catalog_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 v2021_07 CatalogProduct json objects. # 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_v1_external_catalog_output_by_catalog_id(catalog_id, async_req=True) + >>> result = thread.get() + + Args: + catalog_id (str): A catalog ID returned from an account catalog request. + + 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: + None + 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['catalog_id'] = \ + catalog_id + return self.get_api_v1_external_catalog_output_by_catalog_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_catalog_status_by_catalog_id( + self, + catalog_id, + **kwargs + ): + """get_api_v1_external_catalog_status_by_catalog_id # noqa: E501 + + Check the status of a catalog request. # 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_v1_external_catalog_status_by_catalog_id(catalog_id, async_req=True) + >>> result = thread.get() + + Args: + catalog_id (str): A catalog ID returned from an account catalog request. + + 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: + JsonApiSingleResponseOfCatalogStatus + 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['catalog_id'] = \ + catalog_id + return self.get_api_v1_external_catalog_status_by_catalog_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v2_external_account_line_items_by_account_id( + self, + account_id, + **kwargs + ): + """get_api_v2_external_account_line_items_by_account_id # noqa: E501 + + Gets page of line item objects for the given account 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_api_v2_external_account_line_items_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The given account id + + Keyword Args: + limit_to_campaign_id ([str]): The campaign ids that you would like to limit your result set to. [optional] + limit_to_type (str): The campaign types that you would like to limit your result set to. [optional] + 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 + 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: + CommonLineItemPagedListResponse + 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.get_api_v2_external_account_line_items_by_account_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v2_external_auction_line_item_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api_v2_external_auction_line_item_by_line_item_id # noqa: E501 + + Gets the auction 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_api_v2_external_auction_line_item_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The given line item 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: + AuctionLineItemResponse + 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_api_v2_external_auction_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v2_external_campaign_auction_line_items_by_campaign_id( + self, + campaign_id, + **kwargs + ): + """get_api_v2_external_campaign_auction_line_items_by_campaign_id # noqa: E501 + + Gets page of auction 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_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + 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 + 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: + AuctionLineItemPagedListResponse + 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['campaign_id'] = \ + campaign_id + return self.get_api_v2_external_campaign_auction_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v2_external_line_item_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """get_api_v2_external_line_item_by_line_item_id # noqa: E501 + + Gets the 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_api_v2_external_line_item_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The given line item 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: + CommonLineItemResponse + 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_api_v2_external_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def get_campaign_budget_overrides( + self, + campaign_id, + **kwargs + ): + """get_campaign_budget_overrides # 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_campaign_budget_overrides(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + campaign_id (int): External campaign 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: + ValueResourceOutcomeOfCampaignBudgetOverrides + 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['campaign_id'] = \ + campaign_id + return self.get_campaign_budget_overrides_endpoint.call_with_http_info(**kwargs) + + def get_insertion_order_history_change_data_capture( + self, + insertion_order_id, + **kwargs + ): + """get_insertion_order_history_change_data_capture # 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_insertion_order_history_change_data_capture(insertion_order_id, async_req=True) + >>> result = thread.get() + + Args: + insertion_order_id (str): External insertion order id. + + Keyword Args: + 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 + 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: + PageOfInsertionOrderHistoryChangeDataCapture + 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['insertion_order_id'] = \ + insertion_order_id + return self.get_insertion_order_history_change_data_capture_endpoint.call_with_http_info(**kwargs) + + def get_line_item_budget_overrides( + self, + line_item_id, + **kwargs + ): + """get_line_item_budget_overrides # 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.get_line_item_budget_overrides(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item id to get budget overrides 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: + ValueResourceOutcomeOfLineItemBudgetOverrides + 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_line_item_budget_overrides_endpoint.call_with_http_info(**kwargs) + + def patch_api_v1_external_account_by_account_id_and_balance_id( + self, + account_id, + balance_id, + **kwargs + ): + """patch_api_v1_external_account_by_account_id_and_balance_id # noqa: E501 + + Modify a balance for the given account 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.patch_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account of the balance + balance_id (str): The balance to change the dates + + Keyword Args: + update_balance_model_request (UpdateBalanceModelRequest): [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: + BalanceResponse + 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['balance_id'] = \ + balance_id + return self.patch_api_v1_external_account_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id # noqa: E501 + + This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned. # 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_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + keyword_target202110_request (KeywordTarget202110Request): . [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: + KeywordTarget202110Response + 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.post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id # noqa: E501 + + This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned. # 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_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + keyword_target202110_request (KeywordTarget202110Request): . [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: + KeywordTarget202110Response + 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.post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_balance_campaigns_append_by_balance_id( + self, + balance_id, + **kwargs + ): + """post_api202110_external_balance_campaigns_append_by_balance_id # noqa: E501 + + appends one or more campaigns to the specified balance # 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_api202110_external_balance_campaigns_append_by_balance_id(balance_id, async_req=True) + >>> result = thread.get() + + Args: + balance_id (str): The balance to add campaigns from + + Keyword Args: + balance_campaign202110_list_request (BalanceCampaign202110ListRequest): The campaigns to append. [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: + BalanceCampaign202110PagedListResponse + 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['balance_id'] = \ + balance_id + return self.post_api202110_external_balance_campaigns_append_by_balance_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_balance_campaigns_delete_by_balance_id( + self, + balance_id, + **kwargs + ): + """post_api202110_external_balance_campaigns_delete_by_balance_id # noqa: E501 + + Removes one or more campaigns on the specified balance # 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_api202110_external_balance_campaigns_delete_by_balance_id(balance_id, async_req=True) + >>> result = thread.get() + + Args: + balance_id (str): The balance to remove campaigns from + + Keyword Args: + balance_campaign202110_list_request (BalanceCampaign202110ListRequest): The campaigns to append. [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: + BalanceCampaign202110PagedListResponse + 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['balance_id'] = \ + balance_id + return self.post_api202110_external_balance_campaigns_delete_by_balance_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_campaign_preferred_line_items_by_campaign_id( + self, + campaign_id, + **kwargs + ): + """post_api202110_external_campaign_preferred_line_items_by_campaign_id # 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_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + campaign_id (str): The given campaign id + + Keyword Args: + preferred_line_item_create_model202110_request (PreferredLineItemCreateModel202110Request): The line item settings to create a line item with. [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: + PreferredLineItem202110Response + 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['campaign_id'] = \ + campaign_id + return self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_line_item_products_append_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_line_item_products_append_by_line_item_id # noqa: E501 + + This endpoint appends one or more products to promote on the specified line item. The resulting state of the line item is returned. # 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_api202110_external_line_item_products_append_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + promoted_product202110_list_request (PromotedProduct202110ListRequest): the products to append to this 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 + 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: + PromotedProduct202110PagedListResponse + 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.post_api202110_external_line_item_products_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_line_item_products_delete_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_line_item_products_delete_by_line_item_id # noqa: E501 + + This endpoint removes one or more products from promotion on the specified line item. The resulting state of the line item is returned. # 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_api202110_external_line_item_products_delete_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + promoted_product202110_list_request (PromotedProduct202110ListRequest): . [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: + PromotedProduct202110PagedListResponse + 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.post_api202110_external_line_item_products_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_line_item_products_pause_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_line_item_products_pause_by_line_item_id # noqa: E501 + + This endpoint pauses one or more promoted products on a specified 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_api202110_external_line_item_products_pause_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with. + + Keyword Args: + promoted_product202110_list_request (PromotedProduct202110ListRequest): The products from which their IDs will be used to pause.. [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: + None + 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.post_api202110_external_line_item_products_pause_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_line_item_products_unpause_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_line_item_products_unpause_by_line_item_id # noqa: E501 + + This endpoint unpauses one or more promoted products on a specified 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_api202110_external_line_item_products_unpause_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with. + + Keyword Args: + promoted_product202110_list_request (PromotedProduct202110ListRequest): The products from which their IDs will be used to unpause.. [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: + None + 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.post_api202110_external_line_item_products_unpause_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id # noqa: E501 + + This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned. # 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_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + add_to_basket_ids_update_model202110_request (AddToBasketIdsUpdateModel202110Request): Ids to append to the target. [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: + AddToBasketTarget202110Response + 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.post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id # noqa: E501 + + This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned. # 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_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + add_to_basket_ids_update_model202110_request (AddToBasketIdsUpdateModel202110Request): Ids to remove from the target. [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: + AddToBasketTarget202110Response + 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.post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id # noqa: E501 + + This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned. # 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_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + audience_ids_update_model202110_request (AudienceIdsUpdateModel202110Request): Audience ids to append to the target. [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: + AudienceTarget202110Response + 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.post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id # noqa: E501 + + This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned. # 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_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + audience_ids_update_model202110_request (AudienceIdsUpdateModel202110Request): Audience ids to remove from the target. [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: + AudienceTarget202110Response + 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.post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id # noqa: E501 + + This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned. # 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_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + store_ids_update_model202110_request (StoreIdsUpdateModel202110Request): Store ids to append to the target. [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: + StoreTarget202110Response + 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.post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id # noqa: E501 + + This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned. # 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_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + store_ids_update_model202110_request (StoreIdsUpdateModel202110Request): Store ids to remove from the target. [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: + StoreTarget202110Response + 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.post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def post_api202210_external_account_creatives_by_account_id( + self, + account_id, + **kwargs + ): + """post_api202210_external_account_creatives_by_account_id # noqa: E501 + + Create a creative for 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.post_api202210_external_account_creatives_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): External account id to create a creative 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 + 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 + return self.post_api202210_external_account_creatives_by_account_id_endpoint.call_with_http_info(**kwargs) + + def post_api202210_external_account_creatives_search_by_account_id( + self, + account_id, + **kwargs + ): + """post_api202210_external_account_creatives_search_by_account_id # noqa: E501 + + Get account creatives # 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) + >>> result = thread.get() + + Args: + account_id (str): External account id to retrieve creatives for + + Keyword Args: + creative_ids ([str]): Creatives to filter by. [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: + Creative202210ListResponse + 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.post_api202210_external_account_creatives_search_by_account_id_endpoint.call_with_http_info(**kwargs) + + def post_api202301_external_account_campaigns_by_account_id( + self, + account_id, + **kwargs + ): + """post_api202301_external_account_campaigns_by_account_id # noqa: E501 + + Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled. # 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_api202301_external_account_campaigns_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account to request the campaign for. + + Keyword Args: + post_campaign_v202301 (PostCampaignV202301): Creatable campaign attributes. [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: + JsonApiSingleResponseOfCampaignV202301 + 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.post_api202301_external_account_campaigns_by_account_id_endpoint.call_with_http_info(**kwargs) + + def post_api_v1_external_account_add_funds_by_account_id_and_balance_id( + self, + account_id, + balance_id, + **kwargs + ): + """post_api_v1_external_account_add_funds_by_account_id_and_balance_id # noqa: E501 + + Add funds to a balance for the given account 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.post_api_v1_external_account_add_funds_by_account_id_and_balance_id(account_id, balance_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account of the balance + balance_id (str): The balance to add funds to + + Keyword Args: + add_funds_to_balance_request (AddFundsToBalanceRequest): [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: + BalanceResponse + 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['balance_id'] = \ + balance_id + return self.post_api_v1_external_account_add_funds_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs) + + def post_api_v1_external_account_balances_by_account_id( + self, + account_id, + **kwargs + ): + """post_api_v1_external_account_balances_by_account_id # noqa: E501 + + Create balance for the given account 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.post_api_v1_external_account_balances_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account to create balances for + + Keyword Args: + create_balance_request (CreateBalanceRequest): [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: + BalanceResponse + 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.post_api_v1_external_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs) + + def post_api_v1_external_account_catalogs_by_account_id( + self, + account_id, + **kwargs + ): + """post_api_v1_external_account_catalogs_by_account_id # noqa: E501 + + Create a request for a Catalog available to the indicated 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.post_api_v1_external_account_catalogs_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account to request the catalog for. + + Keyword Args: + json_api_request_of_catalog_request (JsonApiRequestOfCatalogRequest): [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: + JsonApiSingleResponseOfCatalogStatus + 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.post_api_v1_external_account_catalogs_by_account_id_endpoint.call_with_http_info(**kwargs) + + def post_api_v1_external_account_change_dates_by_account_id_and_balance_id( + self, + account_id, + balance_id, + **kwargs + ): + """post_api_v1_external_account_change_dates_by_account_id_and_balance_id # noqa: E501 + + Change dates of a balance for the given account 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.post_api_v1_external_account_change_dates_by_account_id_and_balance_id(account_id, balance_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The account of the balance + balance_id (str): The balance to change the dates + + Keyword Args: + change_dates_of_balance_request (ChangeDatesOfBalanceRequest): [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: + BalanceResponse + 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['balance_id'] = \ + balance_id + return self.post_api_v1_external_account_change_dates_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs) + + def post_api_v2_external_campaign_auction_line_items_by_campaign_id( + self, + campaign_id, + **kwargs + ): + """post_api_v2_external_campaign_auction_line_items_by_campaign_id # noqa: E501 + + Creates new auction 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_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + campaign_id (str): The given campaign id + + Keyword Args: + auction_line_item_create_model_request (AuctionLineItemCreateModelRequest): The line item settings to create a line item with. [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: + AuctionLineItemResponse + 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['campaign_id'] = \ + campaign_id + return self.post_api_v2_external_campaign_auction_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) + + def put_api202110_external_preferred_line_item_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """put_api202110_external_preferred_line_item_by_line_item_id # 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_api202110_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The given line item id + + Keyword Args: + preferred_line_item_update_model202110_request (PreferredLineItemUpdateModel202110Request): The line item settings to create a line item with. [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: + PreferredLineItem202110Response + 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.put_api202110_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id # noqa: E501 + + This endpoint sets the scope of the add to basket target on the specified 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.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + add_to_basket_target202110_request (AddToBasketTarget202110Request): The add to basket target to set the scope for. [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: + AddToBasketTarget202110Response + 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.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id # noqa: E501 + + This endpoint sets the scope of the audience target on the specified 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.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + audience_target202110_request (AudienceTarget202110Request): The audience target to set the scope for. [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: + AudienceTarget202110Response + 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.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id # noqa: E501 + + This endpoint sets the scope of the store target on the specified 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.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The line item to interact with + + Keyword Args: + store_target202110_request (StoreTarget202110Request): The store target to set the scope for. [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: + StoreTarget202110Response + 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.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def put_api202210_external_account_by_account_id_creativescreative_id( + self, + account_id, + creative_id, + **kwargs + ): + """put_api202210_external_account_by_account_id_creativescreative_id # noqa: E501 + + Update a 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.put_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 containing the creative + creative_id (str): Creative to update + + 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 + 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.put_api202210_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs) + + def put_api202301_external_campaign_by_campaign_id( + self, + campaign_id, + **kwargs + ): + """put_api202301_external_campaign_by_campaign_id # noqa: E501 + + Edit a campaign for the given campaign id with a given editable attributes. This will return updated creatable and editable attributes of the campaign as the result of the operation. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled. # 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_api202301_external_campaign_by_campaign_id(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + campaign_id (str): Campaign Id of the updating campaign + + Keyword Args: + put_campaign_v202301 (PutCampaignV202301): Editable campaign attributes. [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: + JsonApiSingleResponseOfCampaignV202301 + 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['campaign_id'] = \ + campaign_id + return self.put_api202301_external_campaign_by_campaign_id_endpoint.call_with_http_info(**kwargs) + + def put_api202301_external_line_item_bid_multipliers_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """put_api202301_external_line_item_bid_multipliers_by_line_item_id # noqa: E501 + + Replace bid multipliers on 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.put_api202301_external_line_item_bid_multipliers_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: + line_item_bid_multipliers_request (LineItemBidMultipliersRequest): [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: + LineItemBidMultipliersResponse + 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.put_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def put_api_v2_external_auction_line_item_by_line_item_id( + self, + line_item_id, + **kwargs + ): + """put_api_v2_external_auction_line_item_by_line_item_id # noqa: E501 + + Updates the auction 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_api_v2_external_auction_line_item_by_line_item_id(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): The given line item id + + Keyword Args: + auction_line_item_update_model_request (AuctionLineItemUpdateModelRequest): The line item settings to create a line item with. [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: + AuctionLineItemResponse + 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.put_api_v2_external_auction_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) + + def set_keyword_bids( + self, + id, + **kwargs + ): + """set_keyword_bids # noqa: E501 + + Set bid overrides for associated keywords to the given line item in bulk # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_keyword_bids(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the line item + + Keyword Args: + set_bids_model_request (SetBidsModelRequest): [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: + ResourceOutcome + 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.set_keyword_bids_endpoint.call_with_http_info(**kwargs) + + def submit_proposal( + self, + id, + **kwargs + ): + """submit_proposal # noqa: E501 + + Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.submit_proposal(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the 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: + ProposalStatusModelResponse + 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.submit_proposal_endpoint.call_with_http_info(**kwargs) + + def update_campaign_budget_overrides( + self, + campaign_id, + **kwargs + ): + """update_campaign_budget_overrides # noqa: E501 + + Update campaign budget overrides by given external campaign id and new campaign budget overrides 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.update_campaign_budget_overrides(campaign_id, async_req=True) + >>> result = thread.get() + + Args: + campaign_id (int): External campaign id. + + Keyword Args: + value_resource_input_of_campaign_budget_overrides (ValueResourceInputOfCampaignBudgetOverrides): New campaign budget overrides settings value resource input.. [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: + ValueResourceOutcomeOfCampaignBudgetOverrides + 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['campaign_id'] = \ + campaign_id + return self.update_campaign_budget_overrides_endpoint.call_with_http_info(**kwargs) + + def update_line_item_budget_overrides( + self, + line_item_id, + **kwargs + ): + """update_line_item_budget_overrides # noqa: E501 + + Update line item budget overrides by given external line item id and new line item budget overrides 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.update_line_item_budget_overrides(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): Line item external id. + + Keyword Args: + value_resource_input_of_line_item_budget_overrides (ValueResourceInputOfLineItemBudgetOverrides): New line item budget overrides settings value resource input.. [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: + ValueResourceOutcomeOfLineItemBudgetOverrides + 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.update_line_item_budget_overrides_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/gateway_api.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/gateway_api.py new file mode 100644 index 00000000..e2d42c4d --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api/gateway_api.py @@ -0,0 +1,161 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.api_client import ApiClient, Endpoint as _Endpoint +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from criteo_api_retailmedia_v2024_04.model.application_summary_model_response import ApplicationSummaryModelResponse + + +class GatewayApi(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.get_current_application_endpoint = _Endpoint( + settings={ + 'response_type': (ApplicationSummaryModelResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/2024-04/retail-media/me', + 'operation_id': 'get_current_application', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_current_application( + self, + **kwargs + ): + """get_current_application # noqa: E501 + + Get information about the currently logged application # 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_current_application(async_req=True) + >>> result = thread.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: + ApplicationSummaryModelResponse + 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) + return self.get_current_application_endpoint.call_with_http_info(**kwargs) + diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api_client.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api_client.py new file mode 100644 index 00000000..f19e14e8 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api_client.py @@ -0,0 +1,898 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import json +import atexit +import mimetypes +from multiprocessing.pool import ThreadPool +import io +import os +import re +import typing +from urllib.parse import quote +from urllib3.fields import RequestField + + +from criteo_api_retailmedia_v2024_04 import rest +from criteo_api_retailmedia_v2024_04.configuration import Configuration +from criteo_api_retailmedia_v2024_04.exceptions import ApiTypeError, ApiValueError, ApiException +from criteo_api_retailmedia_v2024_04.model_utils import ( + ModelNormal, + ModelSimple, + ModelComposed, + check_allowed_values, + check_validations, + date, + datetime, + deserialize_file, + file_type, + model_to_dict, + none_type, + validate_and_convert_types +) + + +class ApiClient(object): + """Generic API client for OpenAPI client library builds. + + OpenAPI generic API client. This client handles the client- + server communication, and is invariant across implementations. Specifics of + the methods and models for each application are generated from the OpenAPI + templates. + + NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param configuration: .Configuration object for this client + :param header_name: a header to pass when making calls to the API. + :param header_value: a header value to pass when making calls to + the API. + :param cookie: a cookie to include in the header when making calls + to the API + :param pool_threads: The number of threads to use for async requests + to the API. More threads means more concurrent API requests. + """ + + _pool = None + + def __init__(self, configuration=None, header_name=None, header_value=None, + cookie=None, pool_threads=1): + if configuration is None: + configuration = Configuration.get_default_copy() + self.configuration = configuration + self.pool_threads = pool_threads + + self.rest_client = rest.RESTClientObject(configuration) + self.default_headers = {} + if header_name is not None: + self.default_headers[header_name] = header_value + self.cookie = cookie + # Set default User-Agent. + self.user_agent = 'OpenAPI-Generator/2024.04.0.240515/python' + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_value, traceback): + self.close() + + def close(self): + if self._pool: + self._pool.close() + self._pool.join() + self._pool = None + if hasattr(atexit, 'unregister'): + atexit.unregister(self.close) + + @property + def pool(self): + """Create thread pool on first request + avoids instantiating unused threadpool for blocking clients. + """ + if self._pool is None: + atexit.register(self.close) + self._pool = ThreadPool(self.pool_threads) + return self._pool + + @property + def user_agent(self): + """User agent for this API client""" + return self.default_headers['User-Agent'] + + @user_agent.setter + def user_agent(self, value): + self.default_headers['User-Agent'] = value + + def set_default_header(self, header_name, header_value): + self.default_headers[header_name] = header_value + + def __call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None, + _content_type: typing.Optional[str] = None, + _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None + ): + + config = self.configuration + + # header parameters + header_params = header_params or {} + header_params.update(self.default_headers) + if self.cookie: + header_params['Cookie'] = self.cookie + if header_params: + header_params = self.sanitize_for_serialization(header_params) + header_params = dict(self.parameters_to_tuples(header_params, + collection_formats)) + + # path parameters + if path_params: + path_params = self.sanitize_for_serialization(path_params) + path_params = self.parameters_to_tuples(path_params, + collection_formats) + for k, v in path_params: + # specified safe chars, encode everything + resource_path = resource_path.replace( + '{%s}' % k, + quote(str(v), safe=config.safe_chars_for_path_param) + ) + + # query parameters + if query_params: + query_params = self.sanitize_for_serialization(query_params) + query_params = self.parameters_to_tuples(query_params, + collection_formats) + + # post parameters + if post_params or files: + post_params = post_params if post_params else [] + post_params = self.sanitize_for_serialization(post_params) + post_params = self.parameters_to_tuples(post_params, + collection_formats) + post_params.extend(self.files_parameters(files)) + if header_params['Content-Type'].startswith("multipart"): + post_params = self.parameters_to_multipart(post_params, + (dict)) + + # body + if body: + body = self.sanitize_for_serialization(body) + + # auth setting + self.update_params_for_auth(header_params, query_params, + auth_settings, resource_path, method, body, + request_auths=_request_auths) + + # request url + if _host is None: + url = self.configuration.host + resource_path + else: + # use server/host defined in path or operation instead + url = _host + resource_path + + try: + # perform request and return response + response_data = self.request( + method, url, query_params=query_params, headers=header_params, + post_params=post_params, body=body, + _preload_content=_preload_content, + _request_timeout=_request_timeout) + except ApiException as e: + e.body = e.body.decode('utf-8') + raise e + + self.last_response = response_data + + return_data = response_data + + if not _preload_content: + return (return_data) + return return_data + + # deserialize response data + if response_type: + if response_type != (file_type,): + encoding = "utf-8" + content_type = response_data.getheader('content-type') + if content_type is not None: + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s\;]?", content_type) + if match: + encoding = match.group(1) + response_data.data = response_data.data.decode(encoding) + + return_data = self.deserialize( + response_data, + response_type, + _check_type + ) + else: + return_data = None + + if _return_http_data_only: + return (return_data) + else: + return (return_data, response_data.status, + response_data.getheaders()) + + def parameters_to_multipart(self, params, collection_types): + """Get parameters as list of tuples, formatting as json if value is collection_types + + :param params: Parameters as list of two-tuples + :param dict collection_types: Parameter collection types + :return: Parameters as list of tuple or urllib3.fields.RequestField + """ + new_params = [] + if collection_types is None: + collection_types = (dict) + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if isinstance( + v, collection_types): # v is instance of collection_type, formatting as application/json + v = json.dumps(v, ensure_ascii=False).encode("utf-8") + field = RequestField(k, v) + field.make_multipart(content_type="application/json; charset=utf-8") + new_params.append(field) + else: + new_params.append((k, v)) + return new_params + + @classmethod + def sanitize_for_serialization(cls, obj): + """Prepares data for transmission before it is sent with the rest client + If obj is None, return None. + If obj is str, int, long, float, bool, return directly. + If obj is datetime.datetime, datetime.date + convert to string in iso8601 format. + If obj is list, sanitize each element in the list. + If obj is dict, return the dict. + If obj is OpenAPI model, return the properties dict. + If obj is io.IOBase, return the bytes + :param obj: The data to serialize. + :return: The serialized form of data. + """ + if isinstance(obj, (ModelNormal, ModelComposed)): + return { + key: cls.sanitize_for_serialization(val) for key, + val in model_to_dict( + obj, + serialize=True).items()} + elif isinstance(obj, io.IOBase): + return cls.get_file_data_and_close_file(obj) + elif isinstance(obj, (str, int, float, none_type, bool)): + return obj + elif isinstance(obj, (datetime, date)): + return obj.isoformat() + elif isinstance(obj, ModelSimple): + return cls.sanitize_for_serialization(obj.value) + elif isinstance(obj, list): + return [cls.sanitize_for_serialization(item) for item in obj] + elif isinstance(obj, tuple): + return tuple(cls.sanitize_for_serialization(item) for item in obj) + if isinstance(obj, dict): + return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} + raise ApiValueError( + 'Unable to prepare type {} for serialization'.format( + obj.__class__.__name__)) + + def deserialize(self, response, response_type, _check_type): + """Deserializes response into an object. + + :param response: RESTResponse object to be deserialized. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param _check_type: boolean, whether to check the types of the data + received from the server + :type _check_type: bool + + :return: deserialized object. + """ + # handle file downloading + # save response body into a tmp file and return the instance + if response_type == (file_type,): + content_disposition = response.getheader("Content-Disposition") + return deserialize_file(response.data, self.configuration, + content_disposition=content_disposition) + + # fetch data from response object + try: + received_data = json.loads(response.data) + except ValueError: + received_data = response.data + + # store our data under the key of 'received_data' so users have some + # context if they are deserializing a string and the data type is wrong + deserialized_data = validate_and_convert_types( + received_data, + response_type, + ['received_data'], + True, + _check_type, + configuration=self.configuration + ) + return deserialized_data + + def call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + async_req: typing.Optional[bool] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None, + _request_auths: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None + ): + """Makes the HTTP request (synchronous) and returns deserialized data. + + To make an async_req request, set the async_req parameter. + + :param resource_path: Path to method endpoint. + :param method: Method to call. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param files: key -> field name, value -> a list of open file + objects for `multipart/form-data`. + :type files: dict + :param async_req bool: execute request asynchronously + :type async_req: bool, optional + :param _return_http_data_only: response data without head status code + and headers + :type _return_http_data_only: bool, optional + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :type collection_formats: dict, optional + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :type _preload_content: bool, optional + :param _request_timeout: 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. + :param _check_type: boolean describing if the data back from the server + should have its type checked. + :type _check_type: bool, optional + :param _request_auths: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auths: list, optional + :return: + If async_req parameter is True, + the request will be called asynchronously. + The method will return the request thread. + If parameter async_req is False or missing, + then the method will return the response directly. + """ + if not async_req: + return self.__call_api(resource_path, method, + path_params, query_params, header_params, + body, post_params, files, + response_type, auth_settings, + _return_http_data_only, collection_formats, + _preload_content, _request_timeout, _host, + _check_type, _request_auths=_request_auths) + + return self.pool.apply_async(self.__call_api, (resource_path, + method, path_params, + query_params, + header_params, body, + post_params, files, + response_type, + auth_settings, + _return_http_data_only, + collection_formats, + _preload_content, + _request_timeout, + _host, _check_type, None, _request_auths)) + + def request(self, method, url, query_params=None, headers=None, + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + """Makes the HTTP request using RESTClient.""" + if method == "GET": + return self.rest_client.GET(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "HEAD": + return self.rest_client.HEAD(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "OPTIONS": + return self.rest_client.OPTIONS(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "POST": + return self.rest_client.POST(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PUT": + return self.rest_client.PUT(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PATCH": + return self.rest_client.PATCH(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "DELETE": + return self.rest_client.DELETE(url, + query_params=query_params, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + else: + raise ApiValueError( + "http method must be `GET`, `HEAD`, `OPTIONS`," + " `POST`, `PATCH`, `PUT` or `DELETE`." + ) + + def parameters_to_tuples(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: Parameters as list of tuples, collections formatted + """ + new_params = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, value) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(str(value) for value in v))) + else: + new_params.append((k, v)) + return new_params + + @staticmethod + def get_file_data_and_close_file(file_instance: io.IOBase) -> bytes: + file_data = file_instance.read() + file_instance.close() + return file_data + + def files_parameters(self, + files: typing.Optional[typing.Dict[str, + typing.List[io.IOBase]]] = None): + """Builds form parameters. + + :param files: None or a dict with key=param_name and + value is a list of open file objects + :return: List of tuples of form parameters with file data + """ + if files is None: + return [] + + params = [] + for param_name, file_instances in files.items(): + if file_instances is None: + # if the file field is nullable, skip None values + continue + for file_instance in file_instances: + if file_instance is None: + # if the file field is nullable, skip None values + continue + if file_instance.closed is True: + raise ApiValueError( + "Cannot read a closed file. The passed in file_type " + "for %s must be open." % param_name + ) + filename = os.path.basename(file_instance.name) + filedata = self.get_file_data_and_close_file(file_instance) + mimetype = (mimetypes.guess_type(filename)[0] or + 'application/octet-stream') + params.append( + tuple([param_name, tuple([filename, filedata, mimetype])])) + + return params + + def select_header_accept(self, accepts): + """Returns `Accept` based on an array of accepts provided. + + :param accepts: List of headers. + :return: Accept (e.g. application/json). + """ + if not accepts: + return + + accepts = [x.lower() for x in accepts] + + if 'application/json' in accepts: + return 'application/json' + else: + return ', '.join(accepts) + + def select_header_content_type(self, content_types, method=None, body=None): + """Returns `Content-Type` based on an array of content_types provided. + + :param content_types: List of content-types. + :param method: http method (e.g. POST, PATCH). + :param body: http body to send. + :return: Content-Type (e.g. application/json). + """ + if not content_types: + return None + + content_types = [x.lower() for x in content_types] + + if (method == 'PATCH' and + 'application/json-patch+json' in content_types and + isinstance(body, list)): + return 'application/json-patch+json' + + if 'application/json' in content_types or '*/*' in content_types: + return 'application/json' + else: + return content_types[0] + + def update_params_for_auth(self, headers, queries, auth_settings, + resource_path, method, body, request_auths=None): + """Updates header and query params based on authentication setting. + + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :param auth_settings: Authentication setting identifiers list. + :param resource_path: A string representation of the HTTP request resource path. + :param method: A string representation of the HTTP request method. + :param body: A object representing the body of the HTTP request. + The object type is the return value of _encoder.default(). + :param request_auths: if set, the provided settings will + override the token in the configuration. + """ + if not auth_settings: + return + + if request_auths: + for auth_setting in request_auths: + self._apply_auth_params( + headers, queries, resource_path, method, body, auth_setting) + return + + for auth in auth_settings: + auth_setting = self.configuration.auth_settings().get(auth) + if auth_setting: + self._apply_auth_params( + headers, queries, resource_path, method, body, auth_setting) + + def _apply_auth_params(self, headers, queries, resource_path, method, body, auth_setting): + if auth_setting['in'] == 'cookie': + headers['Cookie'] = auth_setting['key'] + "=" + auth_setting['value'] + elif auth_setting['in'] == 'header': + if auth_setting['type'] != 'http-signature': + headers[auth_setting['key']] = auth_setting['value'] + elif auth_setting['in'] == 'query': + queries.append((auth_setting['key'], auth_setting['value'])) + else: + raise ApiValueError( + 'Authentication token must be in `query` or `header`' + ) + + +class Endpoint(object): + def __init__(self, settings=None, params_map=None, root_map=None, + headers_map=None, api_client=None, callable=None): + """Creates an endpoint + + Args: + settings (dict): see below key value pairs + 'response_type' (tuple/None): response type + 'auth' (list): a list of auth type keys + 'endpoint_path' (str): the endpoint path + 'operation_id' (str): endpoint string identifier + 'http_method' (str): POST/PUT/PATCH/GET etc + 'servers' (list): list of str servers that this endpoint is at + params_map (dict): see below key value pairs + 'all' (list): list of str endpoint parameter names + 'required' (list): list of required parameter names + 'nullable' (list): list of nullable parameter names + 'enum' (list): list of parameters with enum values + 'validation' (list): list of parameters with validations + root_map + 'validations' (dict): the dict mapping endpoint parameter tuple + paths to their validation dictionaries + 'allowed_values' (dict): the dict mapping endpoint parameter + tuple paths to their allowed_values (enum) dictionaries + 'openapi_types' (dict): param_name to openapi type + 'attribute_map' (dict): param_name to camelCase name + 'location_map' (dict): param_name to 'body', 'file', 'form', + 'header', 'path', 'query' + collection_format_map (dict): param_name to `csv` etc. + headers_map (dict): see below key value pairs + 'accept' (list): list of Accept header strings + 'content_type' (list): list of Content-Type header strings + api_client (ApiClient) api client instance + callable (function): the function which is invoked when the + Endpoint is called + """ + self.settings = settings + self.params_map = params_map + self.params_map['all'].extend([ + 'async_req', + '_host_index', + '_preload_content', + '_request_timeout', + '_return_http_data_only', + '_check_input_type', + '_check_return_type', + '_content_type', + '_spec_property_naming', + '_request_auths' + ]) + self.params_map['nullable'].extend(['_request_timeout']) + self.validations = root_map['validations'] + self.allowed_values = root_map['allowed_values'] + self.openapi_types = root_map['openapi_types'] + extra_types = { + 'async_req': (bool,), + '_host_index': (none_type, int), + '_preload_content': (bool,), + '_request_timeout': (none_type, float, (float,), [float], int, (int,), [int]), + '_return_http_data_only': (bool,), + '_check_input_type': (bool,), + '_check_return_type': (bool,), + '_spec_property_naming': (bool,), + '_content_type': (none_type, str), + '_request_auths': (none_type, list) + } + self.openapi_types.update(extra_types) + self.attribute_map = root_map['attribute_map'] + self.location_map = root_map['location_map'] + self.collection_format_map = root_map['collection_format_map'] + self.headers_map = headers_map + self.api_client = api_client + self.callable = callable + + def __validate_inputs(self, kwargs): + for param in self.params_map['enum']: + if param in kwargs: + check_allowed_values( + self.allowed_values, + (param,), + kwargs[param] + ) + + for param in self.params_map['validation']: + if param in kwargs: + check_validations( + self.validations, + (param,), + kwargs[param], + configuration=self.api_client.configuration + ) + + if kwargs['_check_input_type'] is False: + return + + for key, value in kwargs.items(): + fixed_val = validate_and_convert_types( + value, + self.openapi_types[key], + [key], + kwargs['_spec_property_naming'], + kwargs['_check_input_type'], + configuration=self.api_client.configuration + ) + kwargs[key] = fixed_val + + def __gather_params(self, kwargs): + params = { + 'body': None, + 'collection_format': {}, + 'file': {}, + 'form': [], + 'header': {}, + 'path': {}, + 'query': [] + } + + for param_name, param_value in kwargs.items(): + param_location = self.location_map.get(param_name) + if param_location is None: + continue + if param_location: + if param_location == 'body': + params['body'] = param_value + continue + base_name = self.attribute_map[param_name] + if (param_location == 'form' and + self.openapi_types[param_name] == (file_type,)): + params['file'][base_name] = [param_value] + elif (param_location == 'form' and + self.openapi_types[param_name] == ([file_type],)): + # param_value is already a list + params['file'][base_name] = param_value + elif param_location in {'form', 'query'}: + param_value_full = (base_name, param_value) + params[param_location].append(param_value_full) + if param_location not in {'form', 'query'}: + params[param_location][base_name] = param_value + collection_format = self.collection_format_map.get(param_name) + if collection_format: + params['collection_format'][base_name] = collection_format + + return params + + def __call__(self, *args, **kwargs): + """ This method is invoked when endpoints are called + Example: + + api_instance = AccountsApi() + 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.add_brands.callable or self.callable in this class + + """ + return self.callable(self, *args, **kwargs) + + def call_with_http_info(self, **kwargs): + + try: + index = self.api_client.configuration.server_operation_index.get( + self.settings['operation_id'], self.api_client.configuration.server_index + ) if kwargs['_host_index'] is None else kwargs['_host_index'] + server_variables = self.api_client.configuration.server_operation_variables.get( + self.settings['operation_id'], self.api_client.configuration.server_variables + ) + _host = self.api_client.configuration.get_host_from_settings( + index, variables=server_variables, servers=self.settings['servers'] + ) + except IndexError: + if self.settings['servers']: + raise ApiValueError( + "Invalid host index. Must be 0 <= index < %s" % + len(self.settings['servers']) + ) + _host = None + + for key, value in kwargs.items(): + if key not in self.params_map['all']: + raise ApiTypeError( + "Got an unexpected parameter '%s'" + " to method `%s`" % + (key, self.settings['operation_id']) + ) + # only throw this nullable ApiValueError if _check_input_type + # is False, if _check_input_type==True we catch this case + # in self.__validate_inputs + if (key not in self.params_map['nullable'] and value is None + and kwargs['_check_input_type'] is False): + raise ApiValueError( + "Value may not be None for non-nullable parameter `%s`" + " when calling `%s`" % + (key, self.settings['operation_id']) + ) + + for key in self.params_map['required']: + if key not in kwargs.keys(): + raise ApiValueError( + "Missing the required parameter `%s` when calling " + "`%s`" % (key, self.settings['operation_id']) + ) + + self.__validate_inputs(kwargs) + + params = self.__gather_params(kwargs) + + accept_headers_list = self.headers_map['accept'] + if accept_headers_list: + params['header']['Accept'] = self.api_client.select_header_accept( + accept_headers_list) + + if kwargs.get('_content_type'): + params['header']['Content-Type'] = kwargs['_content_type'] + else: + content_type_headers_list = self.headers_map['content_type'] + if content_type_headers_list: + if params['body'] != "": + content_types_list = self.api_client.select_header_content_type( + content_type_headers_list, self.settings['http_method'], + params['body']) + if content_types_list: + params['header']['Content-Type'] = content_types_list + + return self.api_client.call_api( + self.settings['endpoint_path'], self.settings['http_method'], + params['path'], + params['query'], + params['header'], + body=params['body'], + post_params=params['form'], + files=params['file'], + response_type=self.settings['response_type'], + auth_settings=self.settings['auth'], + async_req=kwargs['async_req'], + _check_type=kwargs['_check_return_type'], + _return_http_data_only=kwargs['_return_http_data_only'], + _preload_content=kwargs['_preload_content'], + _request_timeout=kwargs['_request_timeout'], + _host=_host, + _request_auths=kwargs['_request_auths'], + collection_formats=params['collection_format']) diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api_client_builder.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api_client_builder.py new file mode 100644 index 00000000..3493df41 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/api_client_builder.py @@ -0,0 +1,37 @@ +from criteo_api_retailmedia_v2024_04.configuration import Configuration +from criteo_api_retailmedia_v2024_04.criteo_api_client import CriteoApiClient +from criteo_api_retailmedia_v2024_04 import flow_constants + +class ApiClientBuilder : + + @staticmethod + def WithClientCredentials(clientId, clientSecret, host=None): + configuration = Configuration(username=clientId, password=clientSecret, host=host) + + return CriteoApiClient(configuration) + + @staticmethod + def WithNoAuthorization(): + + return CriteoApiClient() + + @staticmethod + def WithAuthorizationCode(clientId, clientSecret, authorization_code, redirect_uri, host=None): + configuration = Configuration(username=clientId, password=clientSecret, host=host) + additional_parameters = { + 'flow' : flow_constants.AUTHORIZATION_CODE_FLOW, + 'authorization_code': authorization_code, + 'redirect_uri': redirect_uri + } + + return CriteoApiClient(configuration = configuration, additional_parameters = additional_parameters) + + @staticmethod + def WithRefreshToken(clientId, clientSecret, refreshToken, host=None): + configuration = Configuration(username=clientId, password=clientSecret, host=host) + additional_parameters = { + 'flow' : flow_constants.REFRESH_TOKEN_FLOW, + 'refresh_token': refreshToken + } + + return CriteoApiClient(configuration = configuration, additional_parameters = additional_parameters) \ No newline at end of file diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/apis/__init__.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/apis/__init__.py new file mode 100644 index 00000000..cb6ee139 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/apis/__init__.py @@ -0,0 +1,21 @@ + +# flake8: noqa + +# Import all APIs into this package. +# If you have many APIs here with many many models used in each API this may +# raise a `RecursionError`. +# In order to avoid this, import only the API that you directly need like: +# +# from criteo_api_retailmedia_v2024_04.api.accounts_api import AccountsApi +# +# or import this package, but before doing it, use: +# +# import sys +# sys.setrecursionlimit(n) + +# Import APIs into API package: +from criteo_api_retailmedia_v2024_04.api.accounts_api import AccountsApi +from criteo_api_retailmedia_v2024_04.api.analytics_api import AnalyticsApi +from criteo_api_retailmedia_v2024_04.api.audience_api import AudienceApi +from criteo_api_retailmedia_v2024_04.api.campaign_api import CampaignApi +from criteo_api_retailmedia_v2024_04.api.gateway_api import GatewayApi diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/configuration.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/configuration.py new file mode 100644 index 00000000..05d2300c --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/configuration.py @@ -0,0 +1,461 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import copy +import logging +import multiprocessing +import sys +import urllib3 + +from http import client as http_client +from criteo_api_retailmedia_v2024_04.exceptions import ApiValueError + + +JSON_SCHEMA_VALIDATION_KEYWORDS = { + 'multipleOf', 'maximum', 'exclusiveMaximum', + 'minimum', 'exclusiveMinimum', 'maxLength', + 'minLength', 'pattern', 'maxItems', 'minItems' +} + +class Configuration(object): + """NOTE: This class is auto generated by OpenAPI Generator + + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param host: Base url + :param api_key: Dict to store API key(s). + Each entry in the dict specifies an API key. + The dict key is the name of the security scheme in the OAS specification. + The dict value is the API key secret. + :param api_key_prefix: Dict to store API prefix (e.g. Bearer) + The dict key is the name of the security scheme in the OAS specification. + The dict value is an API key prefix when generating the auth data. + :param username: Username for HTTP basic authentication + :param password: Password for HTTP basic authentication + :param discard_unknown_keys: Boolean value indicating whether to discard + unknown properties. A server may send a response that includes additional + properties that are not known by the client in the following scenarios: + 1. The OpenAPI document is incomplete, i.e. it does not match the server + implementation. + 2. The client was generated using an older version of the OpenAPI document + and the server has been upgraded since then. + If a schema in the OpenAPI document defines the additionalProperties attribute, + then all undeclared properties received by the server are injected into the + additional properties map. In that case, there are undeclared properties, and + nothing to discard. + :param disabled_client_side_validations (string): Comma-separated list of + JSON schema validation keywords to disable JSON schema structural validation + rules. The following keywords may be specified: multipleOf, maximum, + exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, + maxItems, minItems. + By default, the validation is performed for data generated locally by the client + and data received from the server, independent of any validation performed by + the server side. If the input data does not satisfy the JSON schema validation + rules specified in the OpenAPI document, an exception is raised. + If disabled_client_side_validations is set, structural validation is + disabled. This can be useful to troubleshoot data validation problem, such as + when the OpenAPI document validation rules do not match the actual API data + received by the server. + :param server_index: Index to servers configuration. + :param server_variables: Mapping with string values to replace variables in + templated server configuration. The validation of enums is performed for + variables with defined enum values before. + :param server_operation_index: Mapping from operation ID to an index to server + configuration. + :param server_operation_variables: Mapping from operation ID to a mapping with + string values to replace variables in templated server configuration. + The validation of enums is performed for variables with defined enum values before. + :param ssl_ca_cert: str - the path to a file of concatenated CA certificates + in PEM format + + :Example: + """ + + _default = None + + def __init__(self, host=None, + api_key=None, api_key_prefix=None, + access_token=None, + username=None, password=None, + discard_unknown_keys=False, + disabled_client_side_validations="", + server_index=None, server_variables=None, + server_operation_index=None, server_operation_variables=None, + ssl_ca_cert=None, + ): + """Constructor + """ + self._base_path = "https://api.criteo.com" if host is None else host + """Default Base url + """ + self.server_index = 0 if server_index is None and host is None else server_index + self.server_operation_index = server_operation_index or {} + """Default server index + """ + self.server_variables = server_variables or {} + self.server_operation_variables = server_operation_variables or {} + """Default server variables + """ + self.temp_folder_path = None + """Temp file folder for downloading files + """ + # Authentication Settings + self.access_token = access_token + self.api_key = {} + if api_key: + self.api_key = api_key + """dict to store API key(s) + """ + self.api_key_prefix = {} + if api_key_prefix: + self.api_key_prefix = api_key_prefix + """dict to store API prefix (e.g. Bearer) + """ + self.refresh_api_key_hook = None + """function hook to refresh API key if expired + """ + self.username = username + """Username for HTTP basic authentication + """ + self.password = password + """Password for HTTP basic authentication + """ + self.discard_unknown_keys = discard_unknown_keys + self.disabled_client_side_validations = disabled_client_side_validations + self.logger = {} + """Logging Settings + """ + self.logger["package_logger"] = logging.getLogger("criteo_api_retailmedia_v2024_04") + self.logger["urllib3_logger"] = logging.getLogger("urllib3") + self.logger_format = '%(asctime)s %(levelname)s %(message)s' + """Log format + """ + self.logger_stream_handler = None + """Log stream handler + """ + self.logger_file_handler = None + """Log file handler + """ + self.logger_file = None + """Debug file location + """ + self.debug = False + """Debug switch + """ + + self.verify_ssl = True + """SSL/TLS verification + Set this to false to skip verifying SSL certificate when calling API + from https server. + """ + self.ssl_ca_cert = ssl_ca_cert + """Set this to customize the certificate file to verify the peer. + """ + self.cert_file = None + """client certificate file + """ + self.key_file = None + """client key file + """ + self.assert_hostname = None + """Set this to True/False to enable/disable SSL hostname verification. + """ + + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + """urllib3 connection pool's maximum number of connections saved + per pool. urllib3 uses 1 connection as default value, but this is + not the best value when you are making a lot of possibly parallel + requests to the same host, which is often the case here. + cpu_count * 5 is used as default value to increase performance. + """ + + self.proxy = None + """Proxy URL + """ + self.no_proxy = None + """bypass proxy for host in the no_proxy list. + """ + self.proxy_headers = None + """Proxy headers + """ + self.safe_chars_for_path_param = '' + """Safe chars for path_param + """ + self.retries = None + """Adding retries to override urllib3 default value 3 + """ + # Enable client side validation + self.client_side_validation = True + + # Options to pass down to the underlying urllib3 socket + self.socket_options = None + + def __deepcopy__(self, memo): + cls = self.__class__ + result = cls.__new__(cls) + memo[id(self)] = result + for k, v in self.__dict__.items(): + if k not in ('logger', 'logger_file_handler'): + setattr(result, k, copy.deepcopy(v, memo)) + # shallow copy of loggers + result.logger = copy.copy(self.logger) + # use setters to configure loggers + result.logger_file = self.logger_file + result.debug = self.debug + return result + + def __setattr__(self, name, value): + object.__setattr__(self, name, value) + if name == 'disabled_client_side_validations': + s = set(filter(None, value.split(','))) + for v in s: + if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: + raise ApiValueError( + "Invalid keyword: '{0}''".format(v)) + self._disabled_client_side_validations = s + + @classmethod + def set_default(cls, default): + """Set default instance of configuration. + + It stores default configuration, which can be + returned by get_default_copy method. + + :param default: object of Configuration + """ + cls._default = copy.deepcopy(default) + + @classmethod + def get_default_copy(cls): + """Return new instance of configuration. + + This method returns newly created, based on default constructor, + object of Configuration class or returns a copy of default + configuration passed by the set_default method. + + :return: The configuration object. + """ + if cls._default is not None: + return copy.deepcopy(cls._default) + return Configuration() + + @property + def logger_file(self): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + return self.__logger_file + + @logger_file.setter + def logger_file(self, value): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + self.__logger_file = value + if self.__logger_file: + # If set logging file, + # then add file handler and remove stream handler. + self.logger_file_handler = logging.FileHandler(self.__logger_file) + self.logger_file_handler.setFormatter(self.logger_formatter) + for _, logger in self.logger.items(): + logger.addHandler(self.logger_file_handler) + + @property + def debug(self): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + return self.__debug + + @debug.setter + def debug(self, value): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + self.__debug = value + if self.__debug: + # if debug status is True, turn on debug logging + for _, logger in self.logger.items(): + logger.setLevel(logging.DEBUG) + # turn on http_client debug + http_client.HTTPConnection.debuglevel = 1 + else: + # if debug status is False, turn off debug logging, + # setting log level to default `logging.WARNING` + for _, logger in self.logger.items(): + logger.setLevel(logging.WARNING) + # turn off http_client debug + http_client.HTTPConnection.debuglevel = 0 + + @property + def logger_format(self): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + return self.__logger_format + + @logger_format.setter + def logger_format(self, value): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + self.__logger_format = value + self.logger_formatter = logging.Formatter(self.__logger_format) + + def get_api_key_with_prefix(self, identifier, alias=None): + """Gets API key (with prefix if set). + + :param identifier: The identifier of apiKey. + :param alias: The alternative identifier of apiKey. + :return: The token for api key authentication. + """ + if self.refresh_api_key_hook is not None: + self.refresh_api_key_hook(self) + key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) + if key: + prefix = self.api_key_prefix.get(identifier) + if prefix: + return "%s %s" % (prefix, key) + else: + return key + + def get_basic_auth_token(self): + """Gets HTTP basic authentication header (string). + + :return: The token for basic HTTP authentication. + """ + username = "" + if self.username is not None: + username = self.username + password = "" + if self.password is not None: + password = self.password + return urllib3.util.make_headers( + basic_auth=username + ':' + password + ).get('authorization') + + def auth_settings(self): + """Gets Auth Settings dict for api client. + + :return: The Auth Settings information dict. + """ + auth = {} + if self.access_token is not None: + auth['oauth'] = { + 'type': 'oauth2', + 'in': 'header', + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } + if self.access_token is not None: + auth['oauth'] = { + 'type': 'oauth2', + 'in': 'header', + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } + return auth + + def to_debug_report(self): + """Gets the essential information for debugging. + + :return: The report for debugging. + """ + return "Python SDK Debug Report:\n"\ + "OS: {env}\n"\ + "Python Version: {pyversion}\n"\ + "Version of the API: 2024-04\n"\ + "SDK Package Version: 2024.04.0.240515".\ + format(env=sys.platform, pyversion=sys.version) + + def get_host_settings(self): + """Gets an array of host settings + + :return: An array of host settings + """ + return [ + { + 'url': "https://api.criteo.com", + 'description': "No description provided", + } + ] + + def get_host_from_settings(self, index, variables=None, servers=None): + """Gets host URL based on the index and variables + :param index: array index of the host settings + :param variables: hash of variable and the corresponding value + :param servers: an array of host settings or None + :return: URL based on host settings + """ + if index is None: + return self._base_path + + variables = {} if variables is None else variables + servers = self.get_host_settings() if servers is None else servers + + try: + server = servers[index] + except IndexError: + raise ValueError( + "Invalid index {0} when selecting the host settings. " + "Must be less than {1}".format(index, len(servers))) + + url = server['url'] + + # go through variables and replace placeholders + for variable_name, variable in server.get('variables', {}).items(): + used_value = variables.get( + variable_name, variable['default_value']) + + if 'enum_values' in variable \ + and used_value not in variable['enum_values']: + raise ValueError( + "The variable `{0}` in the host URL has invalid value " + "{1}. Must be {2}.".format( + variable_name, variables[variable_name], + variable['enum_values'])) + + url = url.replace("{" + variable_name + "}", used_value) + + return url + + @property + def host(self): + """Return generated host.""" + return self.get_host_from_settings(self.server_index, variables=self.server_variables) + + @host.setter + def host(self, value): + """Fix base path.""" + self._base_path = value + self.server_index = None diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_api_client.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_api_client.py new file mode 100644 index 00000000..e6bc7d9d --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_api_client.py @@ -0,0 +1,11 @@ +from criteo_api_retailmedia_v2024_04.api_client import ApiClient +from criteo_api_retailmedia_v2024_04.criteo_rest import CriteoRESTClientObject + +class CriteoApiClient(ApiClient): + def __init__(self, configuration=None, header_name=None, header_value=None, + cookie=None, pool_threads=1, additional_parameters= {}): + super().__init__(configuration=configuration,header_name=header_name, header_value=header_value, cookie=cookie, pool_threads=pool_threads) + self.rest_client = CriteoRESTClientObject(self.configuration, additional_parameters) + + def get_refresh_token(self): + return self.rest_client.get_refresh_token() \ No newline at end of file diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_auth.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_auth.py new file mode 100644 index 00000000..32842ac4 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_auth.py @@ -0,0 +1,121 @@ +import json +from datetime import datetime, timedelta +from criteo_api_retailmedia_v2024_04.exceptions import ApiException +from criteo_api_retailmedia_v2024_04.api_client import ApiClient +from criteo_api_retailmedia_v2024_04 import flow_constants + +class Token(object): + + def __init__(self, token_string , expiration_date = None): + self.expiration_date = expiration_date + self.token_string = token_string + + def has_expired(self): + if not self.expiration_date: + return False + return self.expiration_date > datetime.utcnow() + +class BasicAuth(object): + + def __init__(self, token_string): + self.token = Token(token_string) + + def get_token(self, client : ApiClient, headers) -> str: + return self.token + +class RetryingOAuth(object): + + def __init__(self, grant_type, client_id, client_secret): + self.grant_type = grant_type + self.client_id = client_id + self.client_secret = client_secret + self.token = None + self.refreshToken = None + + def get_token(self, client : ApiClient, headers) -> str: + if self.token and not self.token.has_expired(): + self.token = None + if self.grant_type == flow_constants.AUTHORIZATION_CODE_FLOW: + self.grant_type = flow_constants.REFRESH_TOKEN_FLOW + + if self.token is None: + self.refresh_token(client, headers) + + return self.token + + def refresh_token(self, client : ApiClient, headers, parameters_dict= {}): + oauth_url = client.host + '/oauth2/token' + new_headers = {'Accept': 'application/json', + 'Content-Type': 'application/x-www-form-urlencoded', + 'User-Agent': headers['User-Agent']} + params = dict(parameters_dict, **{ + 'client_id': self.client_id, + 'client_secret': self.client_secret, + 'grant_type' : self.grant_type + }) + try: + if self.grant_type == flow_constants.REFRESH_TOKEN_FLOW: + params['refresh_token'] = self.refreshToken + + response = client.request('POST', oauth_url, + headers=new_headers, + query_params=[], + post_params=list(params.items()), + _preload_content=True, + _request_timeout=None, + body=None, + no_auth=True) + data = json.loads(response.data) + self.token = Token('Bearer '+ (data['access_token'] or ''), + RetryingOAuth.compute_expiration_date(data['expires_in'])) + self.refreshToken = data['refresh_token'] + + return self.token + except ApiException as e: + raise self._enrich_exception_message(e, oauth_url) + + def get_refresh_token(self): + return self.refreshToken + + def _enrich_exception_message(self, e, url): + try: + data = json.loads(e.body or {}) + except ValueError: + data = {} + data['token_error'] = "Cannot refresh token by calling '" + url + "'" + e.body = json.dumps(data).encode() + return e + + @staticmethod + def compute_expiration_date(expires_in): + return datetime.utcnow() + timedelta(seconds=int(expires_in) + 15) + +class RetryingClientCredentials(RetryingOAuth): + + def __init__(self, client_id, client_secret): + super().__init__(flow_constants.CLIENT_CREDENTIALS_FLOW, client_id, client_secret) + +class RetryingAuthorizationCode(RetryingOAuth): + def __init__(self, client_id, client_secret, code, redirect_uri): + super().__init__(flow_constants.AUTHORIZATION_CODE_FLOW, client_id, client_secret) + self.authorization_code = code + self.redirect_uri = redirect_uri + + def refresh_token(self, client : ApiClient, headers, parameters_dict= {}): + params = dict(parameters_dict, **{ + 'code' : self.authorization_code, + 'redirect_uri' : self.redirect_uri + }) + return super().refresh_token(client, headers, params) + +class RetryingRefreshToken(RetryingOAuth): + + def __init__(self, client_id, client_secret, refresh_token): + super().__init__(flow_constants.REFRESH_TOKEN_FLOW, client_id, client_secret) + self.refreshToken = refresh_token + + def refresh_token(self, client: ApiClient, headers, parameters_dict = {}): + params = dict(parameters_dict, **{ + 'refresh_token' : self.refreshToken + }) + return super().refresh_token(client, headers,params) diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_rest.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_rest.py new file mode 100644 index 00000000..fcca7f1c --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/criteo_rest.py @@ -0,0 +1,75 @@ +from criteo_api_retailmedia_v2024_04.rest import RESTClientObject +from criteo_api_retailmedia_v2024_04.criteo_auth import * +from criteo_api_retailmedia_v2024_04 import flow_constants + + +class CriteoRESTClientObject(RESTClientObject): + + def __init__(self, configuration, additional_parameters = {}, pools_size=4, maxsize=None): + super().__init__(configuration, pools_size, maxsize) + + self.host = configuration.host + client_id = configuration.username + client_secret = configuration.password + + grant_type = additional_parameters.get('flow', 'client_credentials') + if grant_type == flow_constants.AUTHORIZATION_CODE_FLOW : + self.authorization = RetryingAuthorizationCode( + client_id, + client_secret, + additional_parameters.get('authorization_code',''), + additional_parameters.get('redirect_uri','') + ) + elif grant_type == flow_constants.REFRESH_TOKEN_FLOW : + self.authorization = RetryingRefreshToken( + client_id, + client_secret, + additional_parameters.get('refresh_token', '') + ) + else: + self.authorization = RetryingClientCredentials( + client_id, + client_secret + ) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + return self.request(method, url, query_params, headers, body,post_params, _preload_content, _request_timeout, no_auth=False) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None, no_auth=False): + """Perform requests. + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param no_auth: if True, token is not refreshed + and authorization header is not set + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: 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. + """ + + headers = headers or {} + if not no_auth: + token = self.authorization.get_token(self, headers) + headers['Authorization'] = token.token_string + + if 'Content-Type' not in headers: + headers['Content-Type'] = 'application/json' + + return super().request(method, url, query_params, headers, body, post_params, _preload_content, _request_timeout) + + def get_refresh_token(self): + return self.authorization.get_refresh_token() \ No newline at end of file diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/exceptions.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/exceptions.py new file mode 100644 index 00000000..0eceb800 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/exceptions.py @@ -0,0 +1,158 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +class OpenApiException(Exception): + """The base exception class for all OpenAPIExceptions""" + + +class ApiTypeError(OpenApiException, TypeError): + def __init__(self, msg, path_to_item=None, valid_classes=None, + key_type=None): + """ Raises an exception for TypeErrors + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list): a list of keys an indices to get to the + current_item + None if unset + valid_classes (tuple): the primitive classes that current item + should be an instance of + None if unset + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + None if unset + """ + self.path_to_item = path_to_item + self.valid_classes = valid_classes + self.key_type = key_type + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiTypeError, self).__init__(full_msg) + + +class ApiValueError(OpenApiException, ValueError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list) the path to the exception in the + received_data dict. None if unset + """ + + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiValueError, self).__init__(full_msg) + + +class ApiAttributeError(OpenApiException, AttributeError): + def __init__(self, msg, path_to_item=None): + """ + Raised when an attribute reference or assignment fails. + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiAttributeError, self).__init__(full_msg) + + +class ApiKeyError(OpenApiException, KeyError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiKeyError, self).__init__(full_msg) + + +class ApiException(OpenApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + if http_resp: + self.status = http_resp.status + self.reason = http_resp.reason + self.body = http_resp.data + self.headers = http_resp.getheaders() + else: + self.status = status + self.reason = reason + self.body = None + self.headers = None + + def __str__(self): + """Custom error messages for exception""" + error_message = "Status Code: {0}\n"\ + "Reason: {1}\n".format(self.status, self.reason) + if self.headers: + error_message += "HTTP response headers: {0}\n".format( + self.headers) + + if self.body: + error_message += "HTTP response body: {0}\n".format(self.body) + + return error_message + + +class NotFoundException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(NotFoundException, self).__init__(status, reason, http_resp) + + +class UnauthorizedException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(UnauthorizedException, self).__init__(status, reason, http_resp) + + +class ForbiddenException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ForbiddenException, self).__init__(status, reason, http_resp) + + +class ServiceException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ServiceException, self).__init__(status, reason, http_resp) + + +def render_path(path_to_item): + """Returns a string representation of a path""" + result = "" + for pth in path_to_item: + if isinstance(pth, int): + result += "[{0}]".format(pth) + else: + result += "['{0}']".format(pth) + return result diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/flow_constants.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/flow_constants.py similarity index 100% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/flow_constants.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/flow_constants.py diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/__init__.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/__init__.py new file mode 100644 index 00000000..af3eb715 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/__init__.py @@ -0,0 +1,5 @@ +# we can not import model classes here because that would create a circular +# reference which would not work in python2 +# do not import all models into this module because that uses a lot of memory and stack frames +# if you need the ability to import all models from one package, import them with +# from criteo_api_retailmedia_v2024_04.models import ModelA, ModelB diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_funds_to_balance_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_funds_to_balance_request.py new file mode 100644 index 00000000..b070b691 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_funds_to_balance_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.resource_of_add_funds_to_balance import ResourceOfAddFundsToBalance + globals()['ResourceOfAddFundsToBalance'] = ResourceOfAddFundsToBalance + + +class AddFundsToBalanceRequest(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': (ResourceOfAddFundsToBalance,), # 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 + """AddFundsToBalanceRequest - 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 (ResourceOfAddFundsToBalance): [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 + """AddFundsToBalanceRequest - 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 (ResourceOfAddFundsToBalance): [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_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keyword_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keyword_model.py new file mode 100644 index 00000000..b950128c --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keyword_model.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.match_type_model import MatchTypeModel + globals()['MatchTypeModel'] = MatchTypeModel + + +class AddRemoveKeywordModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'is_deleted': (bool, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'is_deleted': 'isDeleted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model.py new file mode 100644 index 00000000..4e55dd30 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.add_remove_keyword_model import AddRemoveKeywordModel + globals()['AddRemoveKeywordModel'] = AddRemoveKeywordModel + + +class AddRemoveKeywordsModel(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 { + 'keywords': ([AddRemoveKeywordModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model_request.py new file mode 100644 index 00000000..1cbc0b40 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource + globals()['AddRemoveKeywordsModelResource'] = AddRemoveKeywordsModelResource + + +class AddRemoveKeywordsModelRequest(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': (AddRemoveKeywordsModelResource,), # 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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model_resource.py new file mode 100644 index 00000000..7fc49d9e --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_remove_keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.add_remove_keywords_model import AddRemoveKeywordsModel + globals()['AddRemoveKeywordsModel'] = AddRemoveKeywordsModel + + +class AddRemoveKeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (AddRemoveKeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_ids_update_model202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_ids_update_model202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_ids_update_model202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_ids_update_model202110_request.py index 0d8f8fa1..097ba268 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_ids_update_model202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_ids_update_model202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_add_to_basket_ids_update_model202110 import ValueTypeResourceOfAddToBasketIdsUpdateModel202110 + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_add_to_basket_ids_update_model202110 import ValueTypeResourceOfAddToBasketIdsUpdateModel202110 globals()['ValueTypeResourceOfAddToBasketIdsUpdateModel202110'] = ValueTypeResourceOfAddToBasketIdsUpdateModel202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_target202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_target202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_target202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_target202110_request.py index 42997ec3..de12f21a 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_target202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_target202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_add_to_basket_target202110 import ValueTypeResourceOfAddToBasketTarget202110 + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_add_to_basket_target202110 import ValueTypeResourceOfAddToBasketTarget202110 globals()['ValueTypeResourceOfAddToBasketTarget202110'] = ValueTypeResourceOfAddToBasketTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_target202110_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_target202110_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_target202110_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_target202110_response.py index b0457a38..708e8d61 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/add_to_basket_target202110_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/add_to_basket_target202110_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_add_to_basket_target202110 import ValueTypeResourceOfAddToBasketTarget202110 + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_add_to_basket_target202110 import ValueTypeResourceOfAddToBasketTarget202110 globals()['ProblemDetails'] = ProblemDetails globals()['ValueTypeResourceOfAddToBasketTarget202110'] = ValueTypeResourceOfAddToBasketTarget202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model.py new file mode 100644 index 00000000..eaa35199 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model.py @@ -0,0 +1,279 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ApplicationSummaryModel(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 { + 'application_id': (int, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'organization_id': (int, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'criteo_service': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'application_id': 'applicationId', # noqa: E501 + 'name': 'name', # noqa: E501 + 'organization_id': 'organizationId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'criteo_service': 'criteoService', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApplicationSummaryModel - 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,) + application_id (int, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + organization_id (int, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + criteo_service (str, 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 + """ApplicationSummaryModel - 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,) + application_id (int, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + organization_id (int, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + criteo_service (str, 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_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model_resource.py new file mode 100644 index 00000000..d9a1cfbd --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.application_summary_model import ApplicationSummaryModel + globals()['ApplicationSummaryModel'] = ApplicationSummaryModel + + +class ApplicationSummaryModelResource(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': (ApplicationSummaryModel,), # 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 + """ApplicationSummaryModelResource - 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 (ApplicationSummaryModel): [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 + """ApplicationSummaryModelResource - 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 (ApplicationSummaryModel): [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_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model_response.py new file mode 100644 index 00000000..83f009be --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/application_summary_model_response.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.application_summary_model_resource import ApplicationSummaryModelResource + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + globals()['ApplicationSummaryModelResource'] = ApplicationSummaryModelResource + globals()['CommonProblem'] = CommonProblem + + +class ApplicationSummaryModelResponse(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 = { + ('warnings',): { + }, + ('errors',): { + }, + } + + @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': (ApplicationSummaryModelResource,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """ApplicationSummaryModelResponse - 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 (ApplicationSummaryModelResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """ApplicationSummaryModelResponse - 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 (ApplicationSummaryModelResource): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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_2024-04/criteo_api_retailmedia_v2024_04/model/approval_status_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/approval_status_model.py new file mode 100644 index 00000000..0efd9fc9 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/approval_status_model.py @@ -0,0 +1,292 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ApprovalStatusModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'NOTSUBMITTED': "NotSubmitted", + 'SUBMITTED': "Submitted", + 'REJECTED': "Rejected", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset.py index c0b05c3a..ced51b40 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset_resource.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset_resource.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset_resource.py index 3a4c6c1b..59988b7b 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset_resource.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset_resource.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.asset import Asset + from criteo_api_retailmedia_v2024_04.model.asset import Asset globals()['Asset'] = Asset diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset_response.py index 4dc4dce1..3ea293f2 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/asset_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/asset_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.asset_resource import AssetResource - from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.asset_resource import AssetResource + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem globals()['AssetResource'] = AssetResource globals()['CommonProblem'] = CommonProblem diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report.py similarity index 94% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report.py index 70079920..fef34430 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError @@ -57,11 +57,13 @@ class AsyncCampaignsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncCampaignsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncCampaignsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncCampaignsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report_request.py index 3af276dd..076cee28 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.async_campaigns_report_resource import AsyncCampaignsReportResource + from criteo_api_retailmedia_v2024_04.model.async_campaigns_report_resource import AsyncCampaignsReportResource globals()['AsyncCampaignsReportResource'] = AsyncCampaignsReportResource diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report_resource.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report_resource.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report_resource.py index 2772df00..480bb13b 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_campaigns_report_resource.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_campaigns_report_resource.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.async_campaigns_report import AsyncCampaignsReport + from criteo_api_retailmedia_v2024_04.model.async_campaigns_report import AsyncCampaignsReport globals()['AsyncCampaignsReport'] = AsyncCampaignsReport diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report.py similarity index 94% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report.py index d51cdbc3..8918ac87 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError @@ -57,11 +57,13 @@ class AsyncLineItemsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncLineItemsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncLineItemsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncLineItemsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report_request.py index bacc0f01..d33d67e0 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.async_line_items_report_resource import AsyncLineItemsReportResource + from criteo_api_retailmedia_v2024_04.model.async_line_items_report_resource import AsyncLineItemsReportResource globals()['AsyncLineItemsReportResource'] = AsyncLineItemsReportResource diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report_resource.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report_resource.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report_resource.py index f076d82a..f2a400e2 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_line_items_report_resource.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_line_items_report_resource.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.async_line_items_report import AsyncLineItemsReport + from criteo_api_retailmedia_v2024_04.model.async_line_items_report import AsyncLineItemsReport globals()['AsyncLineItemsReport'] = AsyncLineItemsReport diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_report_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_report_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_report_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_report_response.py index 044082ea..de858efe 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/async_report_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_report_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem - from criteo_api_retailmedia_v2023_01.model.status_response_resource import StatusResponseResource + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.status_response_resource import StatusResponseResource globals()['CommonProblem'] = CommonProblem globals()['StatusResponseResource'] = StatusResponseResource diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report.py new file mode 100644 index 00000000..2ac4fbdc --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report.py @@ -0,0 +1,493 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class AsyncRevenueReport(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 = { + ('report_type',): { + 'None': None, + 'ADVERTISER': "advertiser", + 'ENVIRONMENT': "environment", + 'PAGETYPE': "pageType", + 'PRODUCTCATEGORY': "productCategory", + 'BRAND': "brand", + }, + ('revenue_type',): { + 'None': None, + 'AUCTION': "auction", + 'PREFERRED': "preferred", + }, + ('sold_by',): { + 'None': None, + 'DIRECTSOLD': "directSold", + 'INDIRECTSOLD': "indirectSold", + 'PRIVATEMARKET': "privateMarket", + }, + ('buy_type',): { + 'None': None, + 'AUCTION': "auction", + 'PREFERREDDEALS': "preferredDeals", + 'SPONSORSHIP': "sponsorship", + }, + ('sku_relations',): { + 'None': None, + 'SAMESKU': "sameSku", + 'SAMEPARENTSKU': "sameParentSku", + 'SAMECATEGORY': "sameCategory", + 'SAMEBRAND': "sameBrand", + 'SAMESELLER': "sameSeller", + }, + ('format',): { + 'None': None, + 'JSON': "json", + 'JSON-COMPACT': "json-compact", + 'JSON-NEWLINE': "json-newline", + 'CSV': "csv", + }, + ('campaign_type',): { + 'None': None, + 'ALL': "all", + 'SPONSOREDPRODUCTS': "sponsoredProducts", + 'ONSITEDISPLAYS': "onSiteDisplays", + }, + ('sales_channel',): { + 'None': None, + 'ALL': "all", + 'OFFLINE': "offline", + 'ONLINE': "online", + }, + ('click_attribution_window',): { + 'None': None, + 'NONE': "none", + '7D': "7D", + '14D': "14D", + '30D': "30D", + }, + ('view_attribution_window',): { + 'None': None, + 'NONE': "none", + '1D': "1D", + '7D': "7D", + '14D': "14D", + '30D': "30D", + }, + ('dimensions',): { + 'None': None, + 'DATE': "date", + 'HOUR': "hour", + 'PARENTACCOUNT': "parentAccount", + 'ACCOUNTID': "accountId", + 'ACCOUNTNAME': "accountName", + 'ACCOUNTTYPENAME': "accountTypeName", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'CAMPAIGNTYPENAME': "campaignTypeName", + 'CAMPAIGNSTARTDATE': "campaignStartDate", + 'CAMPAIGNENDDATE': "campaignEndDate", + 'LINEITEMID': "lineItemId", + 'LINEITEMNAME': "lineItemName", + 'LINEITEMSTARTDATE': "lineItemStartDate", + 'LINEITEMENDDATE': "lineItemEndDate", + 'LINEITEMSTATUS': "lineItemStatus", + 'RETAILERID': "retailerId", + 'RETAILERNAME': "retailerName", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'PLACEMENTID': "placementId", + 'PLACEMENTNAME': "placementName", + 'PAGETYPENAME': "pageTypeName", + 'ENVIRONMENT': "environment", + 'PAGECATEGORY': "pageCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", + 'ADVPRODUCTGTIN': "advProductGtin", + 'ADVPRODUCTMPN': "advProductMpn", + 'SOLDBY': "soldBy", + 'SALECHANNEL': "saleChannel", + 'ATTRIBUTIONSETTINGS': "attributionSettings", + 'ACTIVITYTYPE': "activityType", + 'KEYWORD': "keyword", + 'SKURELATION': "skuRelation", + 'RETAILERCATEGORYID': "retailerCategoryId", + 'RETAILERCATEGORYNAME': "retailerCategoryName", + 'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb", + 'TAXONOMY1ID': "taxonomy1Id", + 'TAXONOMY1NAME': "taxonomy1Name", + 'TAXONOMY2ID': "taxonomy2Id", + 'TAXONOMY2NAME': "taxonomy2Name", + 'TAXONOMY3ID': "taxonomy3Id", + 'TAXONOMY3NAME': "taxonomy3Name", + 'TAXONOMY4ID': "taxonomy4Id", + 'TAXONOMY4NAME': "taxonomy4Name", + 'TAXONOMY5ID': "taxonomy5Id", + 'TAXONOMY5NAME': "taxonomy5Name", + 'TAXONOMY6ID': "taxonomy6Id", + 'TAXONOMY6NAME': "taxonomy6Name", + 'TAXONOMY7ID': "taxonomy7Id", + 'TAXONOMY7NAME': "taxonomy7Name", + }, + ('metrics',): { + 'None': None, + 'NUMBEROFCAMPAIGNS': "numberOfCampaigns", + 'NUMBEROFLINEITEMS': "numberOfLineItems", + 'NUMBEROFSKUS': "numberOfSkus", + 'SKUPRICE': "skuPrice", + 'PAGEVIEWS': "pageViews", + 'IMPRESSIONS': "impressions", + 'PRODUCTCLICKS': "productClicks", + 'PLACEMENTCLICKS': "placementClicks", + 'CLICKS': "clicks", + 'SALES': "sales", + 'UNITS': "units", + 'TRANSACTIONS': "transactions", + 'ASSISTEDSALES': "assistedSales", + 'ASSISTEDUNITS': "assistedUnits", + 'OPENAUCTIONREVENUE': "openAuctionRevenue", + 'PREFERREDDEALSREVENUE': "preferredDealsRevenue", + 'CTR': "ctr", + 'CR': "cr", + 'CPC': "cpc", + 'CPM': "cpm", + 'ROAS': "roas", + 'WORKINGMEDIA': "workingMedia", + 'NETREVENUE': "netRevenue", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", + 'UNIQUEVISITORS': "uniqueVisitors", + 'FREQUENCY': "frequency", + }, + } + + 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 { + 'start_date': (datetime,), # noqa: E501 + 'end_date': (datetime,), # noqa: E501 + 'ids': ([str], none_type,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'report_type': (str, none_type,), # noqa: E501 + 'revenue_type': (str, none_type,), # noqa: E501 + 'sold_by': (str, none_type,), # noqa: E501 + 'buy_type': (str, none_type,), # noqa: E501 + 'sku_relations': ([str], none_type,), # noqa: E501 + 'format': (str, none_type,), # noqa: E501 + 'campaign_type': (str, none_type,), # noqa: E501 + 'sales_channel': (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 + def discriminator(): + return None + + + attribute_map = { + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'ids': 'ids', # noqa: E501 + 'id': 'id', # noqa: E501 + 'report_type': 'reportType', # noqa: E501 + 'revenue_type': 'revenueType', # noqa: E501 + 'sold_by': 'soldBy', # noqa: E501 + 'buy_type': 'buyType', # noqa: E501 + 'sku_relations': 'skuRelations', # noqa: E501 + 'format': 'format', # noqa: E501 + 'campaign_type': 'campaignType', # noqa: E501 + 'sales_channel': 'salesChannel', # 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 = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E501 + """AsyncRevenueReport - a model defined in OpenAPI + + Args: + start_date (datetime): Start date + end_date (datetime): End date + + 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,) + 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 + sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional] # noqa: E501 + buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional] # noqa: E501 + sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [optional] # noqa: E501 + format (str, none_type): Format of the output. [optional] # noqa: E501 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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) + _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.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 \ + 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, start_date, end_date, *args, **kwargs): # noqa: E501 + """AsyncRevenueReport - a model defined in OpenAPI + + Args: + start_date (datetime): Start date + end_date (datetime): End date + + 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,) + 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 + sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional] # noqa: E501 + buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional] # noqa: E501 + sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [optional] # noqa: E501 + format (str, none_type): Format of the output. [optional] # noqa: E501 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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) + _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.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 \ + 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_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report_request.py new file mode 100644 index 00000000..8b0a6149 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.async_revenue_report_resource import AsyncRevenueReportResource + globals()['AsyncRevenueReportResource'] = AsyncRevenueReportResource + + +class AsyncRevenueReportRequest(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': (AsyncRevenueReportResource,), # 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 + """AsyncRevenueReportRequest - 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 (AsyncRevenueReportResource): [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 + """AsyncRevenueReportRequest - 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 (AsyncRevenueReportResource): [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_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report_resource.py new file mode 100644 index 00000000..e07bdb5d --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/async_revenue_report_resource.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.async_revenue_report import AsyncRevenueReport + globals()['AsyncRevenueReport'] = AsyncRevenueReport + + +class AsyncRevenueReportResource(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': (AsyncRevenueReport,), # 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 + """AsyncRevenueReportResource - 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 (AsyncRevenueReport): [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 + """AsyncRevenueReportResource - 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 (AsyncRevenueReport): [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_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_create_model_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_create_model_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_create_model_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_create_model_request.py index eb482572..3548fe9c 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_create_model_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_create_model_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.input_resource_of_auction_line_item_create_model import InputResourceOfAuctionLineItemCreateModel + from criteo_api_retailmedia_v2024_04.model.input_resource_of_auction_line_item_create_model import InputResourceOfAuctionLineItemCreateModel globals()['InputResourceOfAuctionLineItemCreateModel'] = InputResourceOfAuctionLineItemCreateModel diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_paged_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_paged_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_paged_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_paged_list_response.py index 6747b452..42b8063d 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_paged_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_paged_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_auction_line_item import ResourceOfAuctionLineItem + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_auction_line_item import ResourceOfAuctionLineItem globals()['PageMetadata'] = PageMetadata globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfAuctionLineItem'] = ResourceOfAuctionLineItem diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_response.py index 1369ece7..c0b6ae64 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_auction_line_item import ResourceOfAuctionLineItem + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_auction_line_item import ResourceOfAuctionLineItem globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfAuctionLineItem'] = ResourceOfAuctionLineItem diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_update_model_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_update_model_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_update_model_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_update_model_request.py index 55b04188..b30c66d6 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/auction_line_item_update_model_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/auction_line_item_update_model_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.resource_of_auction_line_item_update_model import ResourceOfAuctionLineItemUpdateModel + from criteo_api_retailmedia_v2024_04.model.resource_of_auction_line_item_update_model import ResourceOfAuctionLineItemUpdateModel globals()['ResourceOfAuctionLineItemUpdateModel'] = ResourceOfAuctionLineItemUpdateModel diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_ids_update_model202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_ids_update_model202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_ids_update_model202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_ids_update_model202110_request.py index c6e4e6f0..ce4f0b4c 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_ids_update_model202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_ids_update_model202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_audience_ids_update_model202110 import ValueTypeResourceOfAudienceIdsUpdateModel202110 + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_audience_ids_update_model202110 import ValueTypeResourceOfAudienceIdsUpdateModel202110 globals()['ValueTypeResourceOfAudienceIdsUpdateModel202110'] = ValueTypeResourceOfAudienceIdsUpdateModel202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_target202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_target202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_target202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_target202110_request.py index caf3ee03..01ad7746 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_target202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_target202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_audience_target202110 import ValueTypeResourceOfAudienceTarget202110 + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_audience_target202110 import ValueTypeResourceOfAudienceTarget202110 globals()['ValueTypeResourceOfAudienceTarget202110'] = ValueTypeResourceOfAudienceTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_target202110_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_target202110_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_target202110_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_target202110_response.py index 8cf7ce93..239843bf 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/audience_target202110_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/audience_target202110_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_audience_target202110 import ValueTypeResourceOfAudienceTarget202110 + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_audience_target202110 import ValueTypeResourceOfAudienceTarget202110 globals()['ProblemDetails'] = ProblemDetails globals()['ValueTypeResourceOfAudienceTarget202110'] = ValueTypeResourceOfAudienceTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/balance_campaign202110_list_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_campaign202110_list_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/balance_campaign202110_list_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_campaign202110_list_request.py index da93e600..9deb7e89 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/balance_campaign202110_list_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_campaign202110_list_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.resource_of_balance_campaign202110 import ResourceOfBalanceCampaign202110 + from criteo_api_retailmedia_v2024_04.model.resource_of_balance_campaign202110 import ResourceOfBalanceCampaign202110 globals()['ResourceOfBalanceCampaign202110'] = ResourceOfBalanceCampaign202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/balance_campaign202110_paged_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_campaign202110_paged_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/balance_campaign202110_paged_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_campaign202110_paged_list_response.py index 5fb730d9..ded053ff 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/balance_campaign202110_paged_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_campaign202110_paged_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_balance_campaign202110 import ResourceOfBalanceCampaign202110 + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_balance_campaign202110 import ResourceOfBalanceCampaign202110 globals()['PageMetadata'] = PageMetadata globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfBalanceCampaign202110'] = ResourceOfBalanceCampaign202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_response.py new file mode 100644 index 00000000..6bad42ff --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.resource_of_balance_response import ResourceOfBalanceResponse + globals()['CommonProblem'] = CommonProblem + globals()['ResourceOfBalanceResponse'] = ResourceOfBalanceResponse + + +class BalanceResponse(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': (ResourceOfBalanceResponse,), # noqa: E501 + 'warnings': ([CommonProblem],), # noqa: E501 + 'errors': ([CommonProblem],), # 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 + """BalanceResponse - 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 (ResourceOfBalanceResponse): [optional] # noqa: E501 + warnings ([CommonProblem]): [optional] # noqa: E501 + errors ([CommonProblem]): [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 + """BalanceResponse - 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 (ResourceOfBalanceResponse): [optional] # noqa: E501 + warnings ([CommonProblem]): [optional] # noqa: E501 + errors ([CommonProblem]): [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_2024-04/criteo_api_retailmedia_v2024_04/model/balance_response_paged_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_response_paged_list_response.py new file mode 100644 index 00000000..e683fbca --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/balance_response_paged_list_response.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.resource_of_balance_response import ResourceOfBalanceResponse + globals()['CommonProblem'] = CommonProblem + globals()['PageMetadata'] = PageMetadata + globals()['ResourceOfBalanceResponse'] = ResourceOfBalanceResponse + + +class BalanceResponsePagedListResponse(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 { + 'metadata': (PageMetadata,), # noqa: E501 + 'data': ([ResourceOfBalanceResponse],), # noqa: E501 + 'warnings': ([CommonProblem],), # noqa: E501 + 'errors': ([CommonProblem],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'metadata': 'metadata', # noqa: E501 + '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 + """BalanceResponsePagedListResponse - 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,) + metadata (PageMetadata): [optional] # noqa: E501 + data ([ResourceOfBalanceResponse]): [optional] # noqa: E501 + warnings ([CommonProblem]): [optional] # noqa: E501 + errors ([CommonProblem]): [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 + """BalanceResponsePagedListResponse - 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,) + metadata (PageMetadata): [optional] # noqa: E501 + data ([ResourceOfBalanceResponse]): [optional] # noqa: E501 + warnings ([CommonProblem]): [optional] # noqa: E501 + errors ([CommonProblem]): [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_2023-01/criteo_api_retailmedia_v2023_01/model/campaign_attributes_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_attributes_v202301.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/campaign_attributes_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_attributes_v202301.py index 822d2188..c9412b2e 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/campaign_attributes_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_attributes_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_budget_overrides.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_budget_overrides.py new file mode 100644 index 00000000..e8ded57e --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_budget_overrides.py @@ -0,0 +1,276 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.campaign_daily_budget_override import CampaignDailyBudgetOverride + from criteo_api_retailmedia_v2024_04.model.campaign_monthly_budget_override import CampaignMonthlyBudgetOverride + globals()['CampaignDailyBudgetOverride'] = CampaignDailyBudgetOverride + globals()['CampaignMonthlyBudgetOverride'] = CampaignMonthlyBudgetOverride + + +class CampaignBudgetOverrides(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 { + 'monthly_budget_overrides': ([CampaignMonthlyBudgetOverride],), # noqa: E501 + 'daily_budget_overrides': ([CampaignDailyBudgetOverride],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'monthly_budget_overrides': 'monthlyBudgetOverrides', # noqa: E501 + 'daily_budget_overrides': 'dailyBudgetOverrides', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, monthly_budget_overrides, daily_budget_overrides, *args, **kwargs): # noqa: E501 + """CampaignBudgetOverrides - a model defined in OpenAPI + + Args: + monthly_budget_overrides ([CampaignMonthlyBudgetOverride]): Campaign budget override monthly part, chronological order restricted. + daily_budget_overrides ([CampaignDailyBudgetOverride]): Campaign budget override daily part, chronological order restricted. + + 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.monthly_budget_overrides = monthly_budget_overrides + self.daily_budget_overrides = daily_budget_overrides + 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, monthly_budget_overrides, daily_budget_overrides, *args, **kwargs): # noqa: E501 + """CampaignBudgetOverrides - a model defined in OpenAPI + + Args: + monthly_budget_overrides ([CampaignMonthlyBudgetOverride]): Campaign budget override monthly part, chronological order restricted. + daily_budget_overrides ([CampaignDailyBudgetOverride]): Campaign budget override daily part, chronological order restricted. + + 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.monthly_budget_overrides = monthly_budget_overrides + self.daily_budget_overrides = daily_budget_overrides + 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_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_daily_budget_override.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_daily_budget_override.py new file mode 100644 index 00000000..b9051170 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_daily_budget_override.py @@ -0,0 +1,283 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class CampaignDailyBudgetOverride(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 = { + ('status',): { + 'None': None, + 'EXPIRED': "Expired", + 'ACTIVE': "Active", + 'UPCOMING': "Upcoming", + }, + } + + 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 { + 'duration': (str,), # noqa: E501 + 'max_daily_spend': (float,), # noqa: E501 + 'start_date': (datetime, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'duration': 'duration', # noqa: E501 + 'max_daily_spend': 'maxDailySpend', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, duration, max_daily_spend, *args, **kwargs): # noqa: E501 + """CampaignDailyBudgetOverride - a model defined in OpenAPI + + Args: + duration (str): The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'. + max_daily_spend (float): Daily budget override maximum daily spend amount. + + 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,) + start_date (datetime, none_type): Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence.. [optional] # noqa: E501 + status (str, none_type): Daily budget override computed status.. [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.duration = duration + self.max_daily_spend = max_daily_spend + 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, duration, max_daily_spend, *args, **kwargs): # noqa: E501 + """CampaignDailyBudgetOverride - a model defined in OpenAPI + + Args: + duration (str): The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'. + max_daily_spend (float): Daily budget override maximum daily spend amount. + + 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,) + start_date (datetime, none_type): Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence.. [optional] # noqa: E501 + status (str, none_type): Daily budget override computed status.. [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.duration = duration + self.max_daily_spend = max_daily_spend + 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_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_monthly_budget_override.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_monthly_budget_override.py new file mode 100644 index 00000000..21e087f3 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_monthly_budget_override.py @@ -0,0 +1,283 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class CampaignMonthlyBudgetOverride(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 = { + ('status',): { + 'None': None, + 'EXPIRED': "Expired", + 'ACTIVE': "Active", + 'UPCOMING': "Upcoming", + }, + } + + 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 { + 'duration': (str,), # noqa: E501 + 'max_monthly_spend': (float,), # noqa: E501 + 'start_month': (datetime, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'duration': 'duration', # noqa: E501 + 'max_monthly_spend': 'maxMonthlySpend', # noqa: E501 + 'start_month': 'startMonth', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, duration, max_monthly_spend, *args, **kwargs): # noqa: E501 + """CampaignMonthlyBudgetOverride - a model defined in OpenAPI + + Args: + duration (str): The number of MONTHs that the override is active from StartMonth, e.g. \"1M\". Must end with 'M' or 'm'. + max_monthly_spend (float): Monthly budget override maximum monthly spend amount. + + 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,) + start_month (datetime, none_type): Monthly budget override start month, format \"yyyy-MM\". If it is null, the StartMonth would be the following month of the last item in the override sequence.. [optional] # noqa: E501 + status (str, none_type): Monthly budget override computed status.. [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.duration = duration + self.max_monthly_spend = max_monthly_spend + 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, duration, max_monthly_spend, *args, **kwargs): # noqa: E501 + """CampaignMonthlyBudgetOverride - a model defined in OpenAPI + + Args: + duration (str): The number of MONTHs that the override is active from StartMonth, e.g. \"1M\". Must end with 'M' or 'm'. + max_monthly_spend (float): Monthly budget override maximum monthly spend amount. + + 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,) + start_month (datetime, none_type): Monthly budget override start month, format \"yyyy-MM\". If it is null, the StartMonth would be the following month of the last item in the override sequence.. [optional] # noqa: E501 + status (str, none_type): Monthly budget override computed status.. [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.duration = duration + self.max_monthly_spend = max_monthly_spend + 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_2023-01/criteo_api_retailmedia_v2023_01/model/campaign_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_v202301.py similarity index 99% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/campaign_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_v202301.py index 0457943b..d624fe44 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/campaign_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/campaign_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/category202204.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/category202204.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/category202204.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/category202204.py index 458a590d..b17592b1 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/category202204.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/category202204.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/category202204_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/category202204_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/category202204_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/category202204_list_response.py index 7a9209aa..be49c88b 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/category202204_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/category202204_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_category202204 import ResourceOfCategory202204 + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_category202204 import ResourceOfCategory202204 globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfCategory202204'] = ResourceOfCategory202204 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/change_dates_of_balance_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/change_dates_of_balance_request.py new file mode 100644 index 00000000..1890d9b6 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/change_dates_of_balance_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.resource_of_change_dates_of_balance import ResourceOfChangeDatesOfBalance + globals()['ResourceOfChangeDatesOfBalance'] = ResourceOfChangeDatesOfBalance + + +class ChangeDatesOfBalanceRequest(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': (ResourceOfChangeDatesOfBalance,), # 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 + """ChangeDatesOfBalanceRequest - 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 (ResourceOfChangeDatesOfBalance): [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 + """ChangeDatesOfBalanceRequest - 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 (ResourceOfChangeDatesOfBalance): [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_2024-04/criteo_api_retailmedia_v2024_04/model/change_details.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/change_details.py new file mode 100644 index 00000000..203f2d4a --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/change_details.py @@ -0,0 +1,275 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ChangeDetails(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 { + 'previous_value': (str, none_type,), # noqa: E501 + 'current_value': (str, none_type,), # noqa: E501 + 'change_value': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'previous_value': 'previousValue', # noqa: E501 + 'current_value': 'currentValue', # noqa: E501 + 'change_value': 'changeValue', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + 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 + 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.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 \ + 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, 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 + 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.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 \ + 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_2023-01/criteo_api_retailmedia_v2023_01/model/choice_option.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_option.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/choice_option.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_option.py index d6e15ffa..dd0d9a5f 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/choice_option.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_option.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.template_variable import TemplateVariable + from criteo_api_retailmedia_v2024_04.model.template_variable import TemplateVariable globals()['TemplateVariable'] = TemplateVariable diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/choice_variable_specification.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_variable_specification.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/choice_variable_specification.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_variable_specification.py index 0ca7483b..f4504687 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/choice_variable_specification.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_variable_specification.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.choice_option import ChoiceOption + from criteo_api_retailmedia_v2024_04.model.choice_option import ChoiceOption globals()['ChoiceOption'] = ChoiceOption diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_variable_value.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_variable_value.py new file mode 100644 index 00000000..d260a6af --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/choice_variable_value.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ChoiceVariableValue(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 { + 'chosen_options': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'chosen_options': 'chosenOptions', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @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 + + 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.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 \ + 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, chosen_options, *args, **kwargs): # noqa: E501 + """ChoiceVariableValue - a model defined in OpenAPI + + Args: + chosen_options ([str]): The chosen options + + 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.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 \ + 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_2024-04/criteo_api_retailmedia_v2024_04/model/color_variable_value.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/color_variable_value.py new file mode 100644 index 00000000..a11184c6 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/color_variable_value.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ColorVariableValue(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 = { + ('color',): { + 'regex': { + 'pattern': r'^#(([0-9a-fA-F]{2}){3}|([0-9a-fA-F]){3})$', # noqa: E501 + }, + }, + } + + @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 { + 'color': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'color': 'color', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @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) + + 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.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 \ + 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, color, *args, **kwargs): # noqa: E501 + """ColorVariableValue - a model defined in OpenAPI + + Args: + color (str): The displayed color (HEX format) + + 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.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 \ + 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_2023-01/criteo_api_retailmedia_v2023_01/model/common_error.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_error.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_error.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_error.py index e5bd740f..57c5f349 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_error.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_error.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_line_item_paged_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_line_item_paged_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_line_item_paged_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_line_item_paged_list_response.py index 179752ec..99013dff 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_line_item_paged_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_line_item_paged_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_common_line_item import ResourceOfCommonLineItem + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_common_line_item import ResourceOfCommonLineItem globals()['PageMetadata'] = PageMetadata globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfCommonLineItem'] = ResourceOfCommonLineItem diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_line_item_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_line_item_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_line_item_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_line_item_response.py index 5cb1390b..f5359bea 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_line_item_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_line_item_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_common_line_item import ResourceOfCommonLineItem + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_common_line_item import ResourceOfCommonLineItem globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfCommonLineItem'] = ResourceOfCommonLineItem diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_problem.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_problem.py new file mode 100644 index 00000000..a6663b69 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_problem.py @@ -0,0 +1,306 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class CommonProblem(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'trace_identifier': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'trace_id': 'traceId', # noqa: E501 + 'trace_identifier': 'traceIdentifier', # noqa: E501 + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, 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 + """CommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, 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_2023-01/criteo_api_retailmedia_v2023_01/model/common_warning.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_warning.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_warning.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_warning.py index 1607c071..07b62c49 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/common_warning.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/common_warning.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/create_balance_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/create_balance_request.py new file mode 100644 index 00000000..786479e8 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/create_balance_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.resource_of_create_balance import ResourceOfCreateBalance + globals()['ResourceOfCreateBalance'] = ResourceOfCreateBalance + + +class CreateBalanceRequest(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': (ResourceOfCreateBalance,), # 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 + """CreateBalanceRequest - 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 (ResourceOfCreateBalance): [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 + """CreateBalanceRequest - 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 (ResourceOfCreateBalance): [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_2023-01/criteo_api_retailmedia_v2023_01/model/creative202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/creative202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202110.py index 82fd872e..989b20de 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/creative202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/creative202110_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202110_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/creative202110_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202110_list_response.py index e31eb8b7..081c813a 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/creative202110_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202110_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_creative202110 import ResourceOfCreative202110 + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_creative202110 import ResourceOfCreative202110 globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfCreative202110'] = ResourceOfCreative202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210.py new file mode 100644 index 00000000..af1bb640 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210.py @@ -0,0 +1,355 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.page_type_environment import PageTypeEnvironment + from criteo_api_retailmedia_v2024_04.model.template_variable_value import TemplateVariableValue + globals()['PageTypeEnvironment'] = PageTypeEnvironment + globals()['TemplateVariableValue'] = TemplateVariableValue + + +class Creative202210(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 = { + ('status',): { + 'READY': "Ready", + 'IN_USE': "In_Use", + 'ARCHIVED': "Archived", + 'DELETED': "Deleted", + }, + ('creative_format_type',): { + 'UNKNOWN': "Unknown", + 'FLAGSHIP': "FlagShip", + 'SHOWCASE': "Showcase", + 'SPONSOREDPRODUCTS': "SponsoredProducts", + 'BUTTERFLY': "Butterfly", + 'BUNDLEBOOST': "BundleBoost", + 'IAB': "IAB", + 'CUSTOM': "CUSTOM", + 'DISPLAYPANEL': "DisplayPanel", + 'DIGITALSHELFTALKER': "DigitalShelfTalker", + }, + } + + 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 { + '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 + } + + @cached_property + def discriminator(): + return None + + + 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 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @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 + + 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 + + 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_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 + """ + + _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.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 + 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, 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 + + 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 + + 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_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 + """ + + _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.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 + 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_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210_list_response.py new file mode 100644 index 00000000..6bb500a4 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210_list_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_creative202210 import ResourceOfCreative202210 + globals()['ProblemDetails'] = ProblemDetails + globals()['ResourceOfCreative202210'] = ResourceOfCreative202210 + + +class Creative202210ListResponse(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': ([ResourceOfCreative202210],), # 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 + """Creative202210ListResponse - 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 ([ResourceOfCreative202210]): [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 + """Creative202210ListResponse - 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 ([ResourceOfCreative202210]): [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_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210_response.py new file mode 100644 index 00000000..99abf791 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative202210_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_creative202210 import ResourceOfCreative202210 + globals()['ProblemDetails'] = ProblemDetails + globals()['ResourceOfCreative202210'] = ResourceOfCreative202210 + + +class Creative202210Response(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': (ResourceOfCreative202210,), # 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 + """Creative202210Response - 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 (ResourceOfCreative202210): [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 + """Creative202210Response - 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 (ResourceOfCreative202210): [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_2024-04/criteo_api_retailmedia_v2024_04/model/creative_create_model202207.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative_create_model202207.py new file mode 100644 index 00000000..efd435bc --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative_create_model202207.py @@ -0,0 +1,297 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.template_variable_value import TemplateVariableValue + globals()['TemplateVariableValue'] = TemplateVariableValue + + +class CreativeCreateModel202207(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 { + '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 + } + + @cached_property + def discriminator(): + return None + + + 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 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @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 + + 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 + + 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_id (int): The brand associated to the creative. [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.name = name + self.retailer_id = retailer_id + self.template_id = template_id + self.template_variable_values = template_variable_values + 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, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 + """CreativeCreateModel202207 - 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 + + 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_id (int): The brand associated to the creative. [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.name = name + self.retailer_id = retailer_id + self.template_id = template_id + self.template_variable_values = template_variable_values + 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_2024-04/criteo_api_retailmedia_v2024_04/model/creative_update_model202207.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative_update_model202207.py new file mode 100644 index 00000000..324f53ea --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/creative_update_model202207.py @@ -0,0 +1,297 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.template_variable_value import TemplateVariableValue + globals()['TemplateVariableValue'] = TemplateVariableValue + + +class CreativeUpdateModel202207(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 { + '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 + } + + @cached_property + def discriminator(): + return None + + + 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 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @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 + + 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 + + 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_id (int): The brand associated to the creative. [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.name = name + self.retailer_id = retailer_id + self.template_id = template_id + self.template_variable_values = template_variable_values + 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, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 + """CreativeUpdateModel202207 - 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 + + 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_id (int): The brand associated to the creative. [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.name = name + self.retailer_id = retailer_id + self.template_id = template_id + self.template_variable_values = template_variable_values + 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_2024-04/criteo_api_retailmedia_v2024_04/model/daily_line_item_budget_override.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/daily_line_item_budget_override.py new file mode 100644 index 00000000..4d979829 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/daily_line_item_budget_override.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class DailyLineItemBudgetOverride(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 = { + ('status',): { + 'None': None, + 'EXPIRED': "Expired", + 'ACTIVE': "Active", + 'UPCOMING': "Upcoming", + }, + } + + 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 { + 'duration': (str,), # noqa: E501 + 'start_date': (datetime, none_type,), # noqa: E501 + 'max_daily_spend': (float, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'duration': 'duration', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'max_daily_spend': 'maxDailySpend', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, duration, *args, **kwargs): # noqa: E501 + """DailyLineItemBudgetOverride - a model defined in OpenAPI + + Args: + duration (str): The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'. + + 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,) + start_date (datetime, none_type): Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence.. [optional] # noqa: E501 + max_daily_spend (float, none_type): Daily budget override maximum daily spend amount.. [optional] # noqa: E501 + status (str, none_type): Daily budget override computed status.. [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.duration = duration + 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, duration, *args, **kwargs): # noqa: E501 + """DailyLineItemBudgetOverride - a model defined in OpenAPI + + Args: + duration (str): The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'. + + 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,) + start_date (datetime, none_type): Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence.. [optional] # noqa: E501 + max_daily_spend (float, none_type): Daily budget override maximum daily spend amount.. [optional] # noqa: E501 + status (str, none_type): Daily budget override computed status.. [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.duration = duration + 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_2023-01/criteo_api_retailmedia_v2023_01/model/editable_campaign_attributes_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/editable_campaign_attributes_v202301.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/editable_campaign_attributes_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/editable_campaign_attributes_v202301.py index a2e70690..04b5a021 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/editable_campaign_attributes_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/editable_campaign_attributes_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_account.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_account.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_account.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_account.py index 56fcc142..92b45899 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_account.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_account.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_funds_to_balance.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_funds_to_balance.py new file mode 100644 index 00000000..f5ef7c5f --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_funds_to_balance.py @@ -0,0 +1,279 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ExternalAddFundsToBalance(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 { + 'delta_amount': (float,), # noqa: E501 + 'memo': (str,), # noqa: E501 + 'po_number': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'delta_amount': 'deltaAmount', # noqa: E501 + 'memo': 'memo', # noqa: E501 + 'po_number': 'poNumber', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, delta_amount, memo, *args, **kwargs): # noqa: E501 + """ExternalAddFundsToBalance - a model defined in OpenAPI + + Args: + delta_amount (float): Amount of billable funds to be added / decreased allotted to the balance. + memo (str): Memo + + 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,) + po_number (str): Purchase Order number.. [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.delta_amount = delta_amount + self.memo = memo + 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, delta_amount, memo, *args, **kwargs): # noqa: E501 + """ExternalAddFundsToBalance - a model defined in OpenAPI + + Args: + delta_amount (float): Amount of billable funds to be added / decreased allotted to the balance. + memo (str): Memo + + 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,) + po_number (str): Purchase Order number.. [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.delta_amount = delta_amount + self.memo = memo + 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_2023-01/criteo_api_retailmedia_v2023_01/model/external_add_to_basket_ids_update_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_to_basket_ids_update_model202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_add_to_basket_ids_update_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_to_basket_ids_update_model202110.py index e8e376b1..9a1b3f6d 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_add_to_basket_ids_update_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_to_basket_ids_update_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_add_to_basket_target202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_to_basket_target202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_add_to_basket_target202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_to_basket_target202110.py index 9b3fede2..16bc9b16 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_add_to_basket_target202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_add_to_basket_target202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item.py index b21b3d04..6dffdcf0 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item_create_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item_create_model.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item_create_model.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item_create_model.py index bedbde3e..a1196c6f 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item_create_model.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item_create_model.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item_update_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item_update_model.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item_update_model.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item_update_model.py index 8000ab7a..228610a5 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_auction_line_item_update_model.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_auction_line_item_update_model.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_audience_ids_update_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_audience_ids_update_model202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_audience_ids_update_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_audience_ids_update_model202110.py index d5757f91..637a0a6a 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_audience_ids_update_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_audience_ids_update_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_audience_target202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_audience_target202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_audience_target202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_audience_target202110.py index 8e9cd0dc..ba9d260e 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_audience_target202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_audience_target202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_balance_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_balance_response.py new file mode 100644 index 00000000..3d0bb794 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_balance_response.py @@ -0,0 +1,363 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ExternalBalanceResponse(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 = { + ('status',): { + 'UNKNOWN': "unknown", + 'SCHEDULED': "scheduled", + 'ACTIVE': "active", + 'ENDED': "ended", + }, + ('balance_type',): { + 'UNKNOWN': "unknown", + 'CAPPED': "capped", + 'UNCAPPED': "uncapped", + }, + ('spend_type',): { + 'ONSITE': "Onsite", + 'OFFSITE': "Offsite", + 'OFFSITEAWARENESS': "OffsiteAwareness", + }, + } + + 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,), # noqa: E501 + 'po_number': (str,), # noqa: E501 + 'memo': (str,), # noqa: E501 + 'deposited': (float, none_type,), # noqa: E501 + 'spent': (float, none_type,), # noqa: E501 + 'remaining': (float, none_type,), # noqa: E501 + 'start_date': (date,), # noqa: E501 + 'end_date': (date,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'balance_type': (str,), # noqa: E501 + 'sales_force_id': (str,), # noqa: E501 + 'spend_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'po_number': 'poNumber', # noqa: E501 + 'memo': 'memo', # noqa: E501 + 'deposited': 'deposited', # noqa: E501 + 'spent': 'spent', # noqa: E501 + 'remaining': 'remaining', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'status': 'status', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + 'balance_type': 'balanceType', # noqa: E501 + 'sales_force_id': 'salesForceId', # noqa: E501 + 'spend_type': 'spendType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, po_number, memo, deposited, spent, remaining, start_date, end_date, status, created_at, updated_at, balance_type, sales_force_id, spend_type, *args, **kwargs): # noqa: E501 + """ExternalBalanceResponse - a model defined in OpenAPI + + Args: + name (str): Name of the balance. + po_number (str): Purchase Order number. + memo (str): Memo + deposited (float, none_type): Amount of billable funds allotted to the balance. + spent (float, none_type): + remaining (float, none_type): + 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): + created_at (datetime): + updated_at (datetime): + balance_type (str): Type of the balance + sales_force_id (str): SalesForceId the balance is linked to. + spend_type (str): Spend Type of the balance. + + 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.name = name + self.po_number = po_number + self.memo = memo + self.deposited = deposited + self.spent = spent + self.remaining = remaining + self.start_date = start_date + self.end_date = end_date + self.status = status + self.created_at = created_at + self.updated_at = updated_at + self.balance_type = balance_type + self.sales_force_id = sales_force_id + self.spend_type = spend_type + 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, name, po_number, memo, deposited, spent, remaining, start_date, end_date, status, created_at, updated_at, balance_type, sales_force_id, spend_type, *args, **kwargs): # noqa: E501 + """ExternalBalanceResponse - a model defined in OpenAPI + + Args: + name (str): Name of the balance. + po_number (str): Purchase Order number. + memo (str): Memo + deposited (float, none_type): Amount of billable funds allotted to the balance. + spent (float, none_type): + remaining (float, none_type): + 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): + created_at (datetime): + updated_at (datetime): + balance_type (str): Type of the balance + sales_force_id (str): SalesForceId the balance is linked to. + spend_type (str): Spend Type of the balance. + + 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.name = name + self.po_number = po_number + self.memo = memo + self.deposited = deposited + self.spent = spent + self.remaining = remaining + self.start_date = start_date + self.end_date = end_date + self.status = status + self.created_at = created_at + self.updated_at = updated_at + self.balance_type = balance_type + self.sales_force_id = sales_force_id + self.spend_type = spend_type + 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_2023-01/criteo_api_retailmedia_v2023_01/model/external_brand.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_brand.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_brand.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_brand.py index ddcd20dd..845c7da8 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_brand.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_brand.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_catalog_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_catalog_request.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_catalog_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_catalog_request.py index 5cb9c4e0..b1193361 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_catalog_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_catalog_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_catalog_status.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_catalog_status.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_catalog_status.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_catalog_status.py index 4a5c9d7f..f1a31e45 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_catalog_status.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_catalog_status.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_change_dates_of_balance.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_change_dates_of_balance.py new file mode 100644 index 00000000..e54a43c0 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_change_dates_of_balance.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ExternalChangeDatesOfBalance(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 { + 'start_date': (date,), # noqa: E501 + 'end_date': (date,), # noqa: E501 + 'memo': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'memo': 'memo', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, start_date, end_date, memo, *args, **kwargs): # noqa: E501 + """ExternalChangeDatesOfBalance - a model defined in OpenAPI + + Args: + 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 + memo (str): Memo + + 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.start_date = start_date + self.end_date = end_date + self.memo = memo + 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, start_date, end_date, memo, *args, **kwargs): # noqa: E501 + """ExternalChangeDatesOfBalance - a model defined in OpenAPI + + Args: + 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 + memo (str): Memo + + 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.start_date = start_date + self.end_date = end_date + self.memo = memo + 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_2023-01/criteo_api_retailmedia_v2023_01/model/external_common_line_item.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_common_line_item.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_common_line_item.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_common_line_item.py index c0743426..8f57aa09 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_common_line_item.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_common_line_item.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_create_balance.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_create_balance.py new file mode 100644 index 00000000..08202e73 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_create_balance.py @@ -0,0 +1,314 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ExternalCreateBalance(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 = { + ('spend_type',): { + 'ONSITE': "Onsite", + 'OFFSITE': "Offsite", + 'OFFSITEAWARENESS': "OffsiteAwareness", + }, + } + + 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,), # noqa: E501 + 'deposited': (float, none_type,), # noqa: E501 + 'start_date': (date,), # noqa: E501 + 'end_date': (date,), # noqa: E501 + 'spend_type': (str,), # noqa: E501 + 'memo': (str,), # noqa: E501 + 'sales_force_id': (str,), # noqa: E501 + 'po_number': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'deposited': 'deposited', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'spend_type': 'spendType', # noqa: E501 + 'memo': 'memo', # noqa: E501 + 'sales_force_id': 'salesForceId', # noqa: E501 + 'po_number': 'poNumber', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, deposited, start_date, end_date, spend_type, memo, sales_force_id, *args, **kwargs): # noqa: E501 + """ExternalCreateBalance - a model defined in OpenAPI + + Args: + name (str): Name of the balance. + deposited (float, none_type): Amount of billable funds allotted to the balance. + 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 + spend_type (str): Type of the balance spend. + memo (str): Memo + sales_force_id (str): SalesForceId the balance is linked to. + + 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,) + po_number (str): Purchase Order number.. [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.name = name + self.deposited = deposited + self.start_date = start_date + self.end_date = end_date + self.spend_type = spend_type + self.memo = memo + self.sales_force_id = sales_force_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, name, deposited, start_date, end_date, spend_type, memo, sales_force_id, *args, **kwargs): # noqa: E501 + """ExternalCreateBalance - a model defined in OpenAPI + + Args: + name (str): Name of the balance. + deposited (float, none_type): Amount of billable funds allotted to the balance. + 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 + spend_type (str): Type of the balance spend. + memo (str): Memo + sales_force_id (str): SalesForceId the balance is linked to. + + 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,) + po_number (str): Purchase Order number.. [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.name = name + self.deposited = deposited + self.start_date = start_date + self.end_date = end_date + self.spend_type = spend_type + self.memo = memo + self.sales_force_id = sales_force_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_2023-01/criteo_api_retailmedia_v2023_01/model/external_keyword_target202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_keyword_target202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_keyword_target202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_keyword_target202110.py index d70b6a3e..c527d47f 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_keyword_target202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_keyword_target202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_capping202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_capping202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_capping202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_capping202110.py index d74c57a1..007d7710 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_capping202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_capping202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_page202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_page202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_page202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_page202110.py index 6b989bd9..e3dc53f9 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_page202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_page202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_line_item_page_category202110 import ExternalLineItemPageCategory202110 + from criteo_api_retailmedia_v2024_04.model.external_line_item_page_category202110 import ExternalLineItemPageCategory202110 globals()['ExternalLineItemPageCategory202110'] = ExternalLineItemPageCategory202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_page_category202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_page_category202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_page_category202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_page_category202110.py index 85692774..34678755 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_line_item_page_category202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_line_item_page_category202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item202110.py index 327600dd..7d60afde 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_line_item_capping202110 import ExternalLineItemCapping202110 - from criteo_api_retailmedia_v2023_01.model.external_line_item_page202110 import ExternalLineItemPage202110 + from criteo_api_retailmedia_v2024_04.model.external_line_item_capping202110 import ExternalLineItemCapping202110 + from criteo_api_retailmedia_v2024_04.model.external_line_item_page202110 import ExternalLineItemPage202110 globals()['ExternalLineItemCapping202110'] = ExternalLineItemCapping202110 globals()['ExternalLineItemPage202110'] = ExternalLineItemPage202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item_create_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item_create_model202110.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item_create_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item_create_model202110.py index 2b19ce2f..027644cb 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item_create_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item_create_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_line_item_capping202110 import ExternalLineItemCapping202110 - from criteo_api_retailmedia_v2023_01.model.external_line_item_page202110 import ExternalLineItemPage202110 + from criteo_api_retailmedia_v2024_04.model.external_line_item_capping202110 import ExternalLineItemCapping202110 + from criteo_api_retailmedia_v2024_04.model.external_line_item_page202110 import ExternalLineItemPage202110 globals()['ExternalLineItemCapping202110'] = ExternalLineItemCapping202110 globals()['ExternalLineItemPage202110'] = ExternalLineItemPage202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item_update_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item_update_model202110.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item_update_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item_update_model202110.py index c1b21c6c..ad79ef69 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_preferred_line_item_update_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_preferred_line_item_update_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_line_item_capping202110 import ExternalLineItemCapping202110 - from criteo_api_retailmedia_v2023_01.model.external_line_item_page202110 import ExternalLineItemPage202110 + from criteo_api_retailmedia_v2024_04.model.external_line_item_capping202110 import ExternalLineItemCapping202110 + from criteo_api_retailmedia_v2024_04.model.external_line_item_page202110 import ExternalLineItemPage202110 globals()['ExternalLineItemCapping202110'] = ExternalLineItemCapping202110 globals()['ExternalLineItemPage202110'] = ExternalLineItemPage202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_promoted_product202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_promoted_product202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_promoted_product202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_promoted_product202110.py index 70b569bd..9cf09115 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_promoted_product202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_promoted_product202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_retailer.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_retailer.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_retailer.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_retailer.py index dfa960c1..210fe7cb 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_retailer.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_retailer.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_retailer_pages202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_retailer_pages202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_retailer_pages202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_retailer_pages202110.py index f6b23b54..ad56ee64 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_retailer_pages202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_retailer_pages202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_store_ids_update_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_store_ids_update_model202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_store_ids_update_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_store_ids_update_model202110.py index fa3c0606..8d046c59 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_store_ids_update_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_store_ids_update_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_store_target202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_store_target202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_store_target202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_store_target202110.py index 6f183a1c..a221f495 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/external_store_target202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_store_target202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_update_balance_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_update_balance_model.py new file mode 100644 index 00000000..26b0150f --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/external_update_balance_model.py @@ -0,0 +1,283 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ExternalUpdateBalanceModel(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,), # noqa: E501 + 'po_number': (str,), # noqa: E501 + 'sales_force_id': (str,), # noqa: E501 + 'start_date': (date, none_type,), # noqa: E501 + 'end_date': (date, none_type,), # noqa: E501 + 'memo': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'po_number': 'poNumber', # noqa: E501 + 'sales_force_id': 'salesForceId', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'memo': 'memo', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ExternalUpdateBalanceModel - 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): Name of the balance.. [optional] # noqa: E501 + po_number (str): Purchase Order number.. [optional] # noqa: E501 + sales_force_id (str): SalesForceId the balance is linked to.. [optional] # noqa: E501 + start_date (date, none_type): Represents the Date as a year, month, and day in the format YYYY-MM-DD. [optional] # noqa: E501 + end_date (date, none_type): Represents the Date as a year, month, and day in the format YYYY-MM-DD. [optional] # noqa: E501 + memo (str): Memo. [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 + """ExternalUpdateBalanceModel - 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): Name of the balance.. [optional] # noqa: E501 + po_number (str): Purchase Order number.. [optional] # noqa: E501 + sales_force_id (str): SalesForceId the balance is linked to.. [optional] # noqa: E501 + start_date (date, none_type): Represents the Date as a year, month, and day in the format YYYY-MM-DD. [optional] # noqa: E501 + end_date (date, none_type): Represents the Date as a year, month, and day in the format YYYY-MM-DD. [optional] # noqa: E501 + memo (str): Memo. [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_2024-04/criteo_api_retailmedia_v2024_04/model/files_variable_value.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/files_variable_value.py new file mode 100644 index 00000000..2a1e4c64 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/files_variable_value.py @@ -0,0 +1,271 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class FilesVariableValue(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 = { + ('asset_ids',): { + }, + } + + @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 { + 'asset_ids': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'asset_ids': 'assetIds', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, asset_ids, *args, **kwargs): # noqa: E501 + """FilesVariableValue - a model defined in OpenAPI + + Args: + asset_ids ([str]): The assets representing the images to be displayed + + 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.asset_ids = asset_ids + 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, asset_ids, *args, **kwargs): # noqa: E501 + """FilesVariableValue - a model defined in OpenAPI + + Args: + asset_ids ([str]): The assets representing the images to be displayed + + 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.asset_ids = asset_ids + 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_2023-01/criteo_api_retailmedia_v2023_01/model/files_variables_specification.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/files_variables_specification.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/files_variables_specification.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/files_variables_specification.py index c247c048..c20deddf 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/files_variables_specification.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/files_variables_specification.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/hyperlink_variable_value.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/hyperlink_variable_value.py new file mode 100644 index 00000000..d1b0c73a --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/hyperlink_variable_value.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class HyperlinkVariableValue(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 { + 'url': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'url': 'url', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501 + """HyperlinkVariableValue - a model defined in OpenAPI + + Args: + url (str): The url to redirect to + + 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.url = url + 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, url, *args, **kwargs): # noqa: E501 + """HyperlinkVariableValue - a model defined in OpenAPI + + Args: + url (str): The url to redirect to + + 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.url = url + 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_2024-04/criteo_api_retailmedia_v2024_04/model/input_keywords_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/input_keywords_model.py new file mode 100644 index 00000000..63a08447 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/input_keywords_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class InputKeywordsModel(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 { + 'negative_broad': ([str], none_type,), # noqa: E501 + 'negative_exact': ([str], none_type,), # noqa: E501 + 'positive_exact': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negative_broad': 'negativeBroad', # noqa: E501 + 'negative_exact': 'negativeExact', # noqa: E501 + 'positive_exact': 'positiveExact', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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_2023-01/criteo_api_retailmedia_v2023_01/model/input_resource_of_auction_line_item_create_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/input_resource_of_auction_line_item_create_model.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/input_resource_of_auction_line_item_create_model.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/input_resource_of_auction_line_item_create_model.py index 175a9e30..7f388b44 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/input_resource_of_auction_line_item_create_model.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/input_resource_of_auction_line_item_create_model.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_auction_line_item_create_model import ExternalAuctionLineItemCreateModel + from criteo_api_retailmedia_v2024_04.model.external_auction_line_item_create_model import ExternalAuctionLineItemCreateModel globals()['ExternalAuctionLineItemCreateModel'] = ExternalAuctionLineItemCreateModel diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/input_resource_of_preferred_line_item_create_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/input_resource_of_preferred_line_item_create_model202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/input_resource_of_preferred_line_item_create_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/input_resource_of_preferred_line_item_create_model202110.py index b5706004..8eae28db 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/input_resource_of_preferred_line_item_create_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/input_resource_of_preferred_line_item_create_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_preferred_line_item_create_model202110 import ExternalPreferredLineItemCreateModel202110 + from criteo_api_retailmedia_v2024_04.model.external_preferred_line_item_create_model202110 import ExternalPreferredLineItemCreateModel202110 globals()['ExternalPreferredLineItemCreateModel202110'] = ExternalPreferredLineItemCreateModel202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/insertion_order_history_change_data_capture.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/insertion_order_history_change_data_capture.py new file mode 100644 index 00000000..220f556e --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/insertion_order_history_change_data_capture.py @@ -0,0 +1,303 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.change_details import ChangeDetails + globals()['ChangeDetails'] = ChangeDetails + + +class InsertionOrderHistoryChangeDataCapture(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 = { + ('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 = { + } + + 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 { + '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 + def discriminator(): + return None + + + attribute_map = { + '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 = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + 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: + 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 + 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,) + memo (str, none_type): Memo associate with the insertion order modification.. [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.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 \ + 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, date_of_modification, modified_by_user, change_type, change_details, *args, **kwargs): # noqa: E501 + """InsertionOrderHistoryChangeDataCapture - a model defined in OpenAPI + + Args: + 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 + 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,) + memo (str, none_type): Memo associate with the insertion order modification.. [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.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 \ + 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_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py index 6124523d..1cf8b904 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.editable_campaign_attributes_v202301 import EditableCampaignAttributesV202301 + from criteo_api_retailmedia_v2024_04.model.editable_campaign_attributes_v202301 import EditableCampaignAttributesV202301 globals()['EditableCampaignAttributesV202301'] = EditableCampaignAttributesV202301 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_account_and_account.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_account_and_account.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_account_and_account.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_account_and_account.py index 9c4e1b91..b49acacc 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_account_and_account.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_account_and_account.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_account import ExternalAccount + from criteo_api_retailmedia_v2024_04.model.external_account import ExternalAccount globals()['ExternalAccount'] = ExternalAccount diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_brand_and_brand.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_brand_and_brand.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_brand_and_brand.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_brand_and_brand.py index 867d1615..5dd11916 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_brand_and_brand.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_brand_and_brand.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_brand import ExternalBrand + from criteo_api_retailmedia_v2024_04.model.external_brand import ExternalBrand globals()['ExternalBrand'] = ExternalBrand diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py index 09f04752..62a4214c 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.campaign_v202301 import CampaignV202301 + from criteo_api_retailmedia_v2024_04.model.campaign_v202301 import CampaignV202301 globals()['CampaignV202301'] = CampaignV202301 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py index 3b87881f..c85d2495 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_catalog_status import ExternalCatalogStatus + from criteo_api_retailmedia_v2024_04.model.external_catalog_status import ExternalCatalogStatus globals()['ExternalCatalogStatus'] = ExternalCatalogStatus diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py new file mode 100644 index 00000000..6e66fed5 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py @@ -0,0 +1,285 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers import LineItemBidMultipliers + globals()['LineItemBidMultipliers'] = LineItemBidMultipliers + + +class JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers(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 { + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'attributes': (LineItemBidMultipliers,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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, id, type, *args, **kwargs): # noqa: E501 + """JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - a model defined in OpenAPI + + Args: + id (str): + type (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,) + attributes (LineItemBidMultipliers): [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.id = id + 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 \ + 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, type, *args, **kwargs): # noqa: E501 + """JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - a model defined in OpenAPI + + Args: + id (str): + type (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,) + attributes (LineItemBidMultipliers): [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.id = id + 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 \ + 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_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py index 1a3479c5..5a09e807 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_retailer import ExternalRetailer + from criteo_api_retailmedia_v2024_04.model.external_retailer import ExternalRetailer globals()['ExternalRetailer'] = ExternalRetailer diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py index 5d7d4f83..4e17da85 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.campaign_attributes_v202301 import CampaignAttributesV202301 + from criteo_api_retailmedia_v2024_04.model.campaign_attributes_v202301 import CampaignAttributesV202301 globals()['CampaignAttributesV202301'] = CampaignAttributesV202301 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py index 135ff562..f0e37d23 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_body_without_id_of_catalog_request_and_catalog_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_catalog_request import ExternalCatalogRequest + from criteo_api_retailmedia_v2024_04.model.external_catalog_request import ExternalCatalogRequest globals()['ExternalCatalogRequest'] = ExternalCatalogRequest diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_account.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_account.py similarity index 96% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_account.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_account.py index 771cf65d..551bdb4d 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_account.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_account.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,14 +26,14 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_error import CommonError - from criteo_api_retailmedia_v2023_01.model.common_warning import CommonWarning - from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_account_and_account import JsonApiBodyWithIdOfInt64AndAccountAndAccount - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.common_error import CommonError + from criteo_api_retailmedia_v2024_04.model.common_warning import CommonWarning + from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_account_and_account import JsonApiBodyWithIdOfInt64AndAccountAndAccount + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata globals()['CommonError'] = CommonError globals()['CommonWarning'] = CommonWarning globals()['JsonApiBodyWithIdOfInt64AndAccountAndAccount'] = JsonApiBodyWithIdOfInt64AndAccountAndAccount diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_brand.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_brand.py similarity index 96% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_brand.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_brand.py index a2ec96cd..bef58498 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_brand.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_brand.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,14 +26,14 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_error import CommonError - from criteo_api_retailmedia_v2023_01.model.common_warning import CommonWarning - from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_brand_and_brand import JsonApiBodyWithIdOfInt64AndBrandAndBrand - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.common_error import CommonError + from criteo_api_retailmedia_v2024_04.model.common_warning import CommonWarning + from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_brand_and_brand import JsonApiBodyWithIdOfInt64AndBrandAndBrand + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata globals()['CommonError'] = CommonError globals()['CommonWarning'] = CommonWarning globals()['JsonApiBodyWithIdOfInt64AndBrandAndBrand'] = JsonApiBodyWithIdOfInt64AndBrandAndBrand diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_campaign_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_campaign_v202301.py similarity index 96% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_campaign_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_campaign_v202301.py index 3f5562f3..6445d979 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_campaign_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_campaign_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,14 +26,14 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_error import CommonError - from criteo_api_retailmedia_v2023_01.model.common_warning import CommonWarning - from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301 import JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301 - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.common_error import CommonError + from criteo_api_retailmedia_v2024_04.model.common_warning import CommonWarning + from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301 import JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301 + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata globals()['CommonError'] = CommonError globals()['CommonWarning'] = CommonWarning globals()['JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301'] = JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_retailer.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_retailer.py similarity index 96% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_retailer.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_retailer.py index 552100f2..ad9d3089 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_page_response_of_retailer.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_retailer.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,14 +26,14 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_error import CommonError - from criteo_api_retailmedia_v2023_01.model.common_warning import CommonWarning - from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_retailer_and_retailer import JsonApiBodyWithIdOfInt64AndRetailerAndRetailer - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.common_error import CommonError + from criteo_api_retailmedia_v2024_04.model.common_warning import CommonWarning + from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_retailer_and_retailer import JsonApiBodyWithIdOfInt64AndRetailerAndRetailer + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata globals()['CommonError'] = CommonError globals()['CommonWarning'] = CommonWarning globals()['JsonApiBodyWithIdOfInt64AndRetailerAndRetailer'] = JsonApiBodyWithIdOfInt64AndRetailerAndRetailer diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_request_of_catalog_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_request_of_catalog_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_request_of_catalog_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_request_of_catalog_request.py index f8fff47a..5a989eed 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_request_of_catalog_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_request_of_catalog_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.json_api_body_without_id_of_catalog_request_and_catalog_request import JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest + from criteo_api_retailmedia_v2024_04.model.json_api_body_without_id_of_catalog_request_and_catalog_request import JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest globals()['JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest'] = JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_campaign_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_campaign_v202301.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_campaign_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_campaign_v202301.py index a8524d9f..c035c972 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_campaign_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_campaign_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_error import CommonError - from criteo_api_retailmedia_v2023_01.model.common_warning import CommonWarning - from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301 import JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301 + from criteo_api_retailmedia_v2024_04.model.common_error import CommonError + from criteo_api_retailmedia_v2024_04.model.common_warning import CommonWarning + from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301 import JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301 globals()['CommonError'] = CommonError globals()['CommonWarning'] = CommonWarning globals()['JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301'] = JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_catalog_status.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_catalog_status.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_catalog_status.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_catalog_status.py index a1e0b28a..5422a932 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/json_api_single_response_of_catalog_status.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_catalog_status.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_error import CommonError - from criteo_api_retailmedia_v2023_01.model.common_warning import CommonWarning - from criteo_api_retailmedia_v2023_01.model.json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status import JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus + from criteo_api_retailmedia_v2024_04.model.common_error import CommonError + from criteo_api_retailmedia_v2024_04.model.common_warning import CommonWarning + from criteo_api_retailmedia_v2024_04.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 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_line_item_bid_multipliers.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_line_item_bid_multipliers.py new file mode 100644 index 00000000..f5e24781 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/json_api_single_response_of_line_item_bid_multipliers.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.common_error import CommonError + from criteo_api_retailmedia_v2024_04.model.common_warning import CommonWarning + from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers import JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers + globals()['CommonError'] = CommonError + globals()['CommonWarning'] = CommonWarning + globals()['JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers'] = JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers + + +class JsonApiSingleResponseOfLineItemBidMultipliers(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': (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers,), # 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 + """JsonApiSingleResponseOfLineItemBidMultipliers - a model defined in OpenAPI + + Args: + data (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers): + + 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 + """JsonApiSingleResponseOfLineItemBidMultipliers - a model defined in OpenAPI + + Args: + data (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers): + + 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_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_data_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_data_model.py new file mode 100644 index 00000000..d115643c --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_data_model.py @@ -0,0 +1,286 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.input_keywords_model import InputKeywordsModel + from criteo_api_retailmedia_v2024_04.model.match_type_model import MatchTypeModel + from criteo_api_retailmedia_v2024_04.model.review_state_model import ReviewStateModel + globals()['InputKeywordsModel'] = InputKeywordsModel + globals()['MatchTypeModel'] = MatchTypeModel + globals()['ReviewStateModel'] = ReviewStateModel + + +class KeywordDataModel(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 { + 'review_state': (ReviewStateModel,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + 'input_keywords': (InputKeywordsModel,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'review_state': 'reviewState', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'bid': 'bid', # noqa: E501 + 'input_keywords': 'inputKeywords', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2023-01/criteo_api_retailmedia_v2023_01/model/keyword_target202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_target202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/keyword_target202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_target202110_request.py index bc105757..6e816df0 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/keyword_target202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_target202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_keyword_target202110 import ValueTypeResourceOfKeywordTarget202110 + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_keyword_target202110 import ValueTypeResourceOfKeywordTarget202110 globals()['ValueTypeResourceOfKeywordTarget202110'] = ValueTypeResourceOfKeywordTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/keyword_target202110_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_target202110_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/keyword_target202110_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_target202110_response.py index 462b43b0..876c7fc4 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/keyword_target202110_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keyword_target202110_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_keyword_target202110 import ValueTypeResourceOfKeywordTarget202110 + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_keyword_target202110 import ValueTypeResourceOfKeywordTarget202110 globals()['ProblemDetails'] = ProblemDetails globals()['ValueTypeResourceOfKeywordTarget202110'] = ValueTypeResourceOfKeywordTarget202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model.py new file mode 100644 index 00000000..1384ba9a --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.keyword_data_model import KeywordDataModel + globals()['KeywordDataModel'] = KeywordDataModel + + +class KeywordsModel(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 { + 'keywords': ({str: (KeywordDataModel,)}, none_type,), # noqa: E501 + 'rank': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + 'rank': 'rank', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model_resource.py new file mode 100644 index 00000000..65dbc1af --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.keywords_model import KeywordsModel + globals()['KeywordsModel'] = KeywordsModel + + +class KeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (KeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model_response.py new file mode 100644 index 00000000..5512e86b --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/keywords_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.keywords_model_resource import KeywordsModelResource + from criteo_api_retailmedia_v2024_04.model.rmca_common_problem import RmcaCommonProblem + globals()['KeywordsModelResource'] = KeywordsModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class KeywordsModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (KeywordsModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers.py new file mode 100644 index 00000000..8f1832b5 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers.py @@ -0,0 +1,291 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class LineItemBidMultipliers(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 { + 'search': (float,), # noqa: E501 + 'homepage': (float,), # noqa: E501 + 'categories': (float,), # noqa: E501 + 'product_detail': (float,), # noqa: E501 + 'confirmation': (float,), # noqa: E501 + 'merchandising': (float,), # noqa: E501 + 'deals': (float,), # noqa: E501 + 'checkout': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'search': 'search', # noqa: E501 + 'homepage': 'homepage', # noqa: E501 + 'categories': 'categories', # noqa: E501 + 'product_detail': 'productDetail', # noqa: E501 + 'confirmation': 'confirmation', # noqa: E501 + 'merchandising': 'merchandising', # noqa: E501 + 'deals': 'deals', # noqa: E501 + 'checkout': 'checkout', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LineItemBidMultipliers - 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,) + search (float): [optional] # noqa: E501 + homepage (float): [optional] # noqa: E501 + categories (float): [optional] # noqa: E501 + product_detail (float): [optional] # noqa: E501 + confirmation (float): [optional] # noqa: E501 + merchandising (float): [optional] # noqa: E501 + deals (float): [optional] # noqa: E501 + checkout (float): [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 + """LineItemBidMultipliers - 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,) + search (float): [optional] # noqa: E501 + homepage (float): [optional] # noqa: E501 + categories (float): [optional] # noqa: E501 + product_detail (float): [optional] # noqa: E501 + confirmation (float): [optional] # noqa: E501 + merchandising (float): [optional] # noqa: E501 + deals (float): [optional] # noqa: E501 + checkout (float): [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_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers_request.py new file mode 100644 index 00000000..8f40cd24 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.resource_of_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers + globals()['ResourceOfLineItemBidMultipliers'] = ResourceOfLineItemBidMultipliers + + +class LineItemBidMultipliersRequest(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': (ResourceOfLineItemBidMultipliers,), # 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 + """LineItemBidMultipliersRequest - 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 (ResourceOfLineItemBidMultipliers): [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 + """LineItemBidMultipliersRequest - 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 (ResourceOfLineItemBidMultipliers): [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_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers_response.py new file mode 100644 index 00000000..38f0e6e2 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_bid_multipliers_response.py @@ -0,0 +1,281 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers + globals()['ProblemDetails'] = ProblemDetails + globals()['ResourceOfLineItemBidMultipliers'] = ResourceOfLineItemBidMultipliers + + +class LineItemBidMultipliersResponse(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': (ResourceOfLineItemBidMultipliers,), # 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 + """LineItemBidMultipliersResponse - 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 (ResourceOfLineItemBidMultipliers): [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 + """LineItemBidMultipliersResponse - 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 (ResourceOfLineItemBidMultipliers): [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_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_budget_overrides.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_budget_overrides.py new file mode 100644 index 00000000..d5915e4c --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/line_item_budget_overrides.py @@ -0,0 +1,276 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.daily_line_item_budget_override import DailyLineItemBudgetOverride + from criteo_api_retailmedia_v2024_04.model.monthly_line_item_budeget_override import MonthlyLineItemBudegetOverride + globals()['DailyLineItemBudgetOverride'] = DailyLineItemBudgetOverride + globals()['MonthlyLineItemBudegetOverride'] = MonthlyLineItemBudegetOverride + + +class LineItemBudgetOverrides(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 { + 'monthly_line_item_budget_overrides': ([MonthlyLineItemBudegetOverride],), # noqa: E501 + 'daily_line_item_budget_overrides': ([DailyLineItemBudgetOverride],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'monthly_line_item_budget_overrides': 'monthlyLineItemBudgetOverrides', # noqa: E501 + 'daily_line_item_budget_overrides': 'dailyLineItemBudgetOverrides', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, monthly_line_item_budget_overrides, daily_line_item_budget_overrides, *args, **kwargs): # noqa: E501 + """LineItemBudgetOverrides - a model defined in OpenAPI + + Args: + monthly_line_item_budget_overrides ([MonthlyLineItemBudegetOverride]): Line item budget override monthly part, chronological order restricted. + daily_line_item_budget_overrides ([DailyLineItemBudgetOverride]): Line item budget override daily part, chronological order restricted. + + 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.monthly_line_item_budget_overrides = monthly_line_item_budget_overrides + self.daily_line_item_budget_overrides = daily_line_item_budget_overrides + 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, monthly_line_item_budget_overrides, daily_line_item_budget_overrides, *args, **kwargs): # noqa: E501 + """LineItemBudgetOverrides - a model defined in OpenAPI + + Args: + monthly_line_item_budget_overrides ([MonthlyLineItemBudegetOverride]): Line item budget override monthly part, chronological order restricted. + daily_line_item_budget_overrides ([DailyLineItemBudgetOverride]): Line item budget override daily part, chronological order restricted. + + 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.monthly_line_item_budget_overrides = monthly_line_item_budget_overrides + self.daily_line_item_budget_overrides = daily_line_item_budget_overrides + 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_2024-04/criteo_api_retailmedia_v2024_04/model/match_type_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/match_type_model.py new file mode 100644 index 00000000..405cefac --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/match_type_model.py @@ -0,0 +1,291 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class MatchTypeModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'POSITIVEEXACTMATCH': "PositiveExactMatch", + 'NEGATIVEEXACTMATCH': "NegativeExactMatch", + 'NEGATIVEBROADMATCH': "NegativeBroadMatch", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/metadata.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/metadata.py new file mode 100644 index 00000000..863936da --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/metadata.py @@ -0,0 +1,273 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.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_2024-04/criteo_api_retailmedia_v2024_04/model/monthly_line_item_budeget_override.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/monthly_line_item_budeget_override.py new file mode 100644 index 00000000..b1492e93 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/monthly_line_item_budeget_override.py @@ -0,0 +1,283 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class MonthlyLineItemBudegetOverride(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 = { + ('status',): { + 'None': None, + 'EXPIRED': "Expired", + 'ACTIVE': "Active", + 'UPCOMING': "Upcoming", + }, + } + + 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 { + 'duration': (str,), # noqa: E501 + 'max_monthly_spend': (float,), # noqa: E501 + 'start_month': (datetime, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'duration': 'duration', # noqa: E501 + 'max_monthly_spend': 'maxMonthlySpend', # noqa: E501 + 'start_month': 'startMonth', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, duration, max_monthly_spend, *args, **kwargs): # noqa: E501 + """MonthlyLineItemBudegetOverride - a model defined in OpenAPI + + Args: + duration (str): The number of MONTHs that the override is active from StartMonth, e.g. \"1M\". Must end with 'M' or 'm'. + max_monthly_spend (float): Monthly budget override maximum monthly spend amount. + + 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,) + start_month (datetime, none_type): Monthly budget override start month, format \"yyyy-MM\". If it is null, the StartMonth would be the following month of the last item in the override sequence.. [optional] # noqa: E501 + status (str, none_type): Monthly budget override computed status.. [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.duration = duration + self.max_monthly_spend = max_monthly_spend + 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, duration, max_monthly_spend, *args, **kwargs): # noqa: E501 + """MonthlyLineItemBudegetOverride - a model defined in OpenAPI + + Args: + duration (str): The number of MONTHs that the override is active from StartMonth, e.g. \"1M\". Must end with 'M' or 'm'. + max_monthly_spend (float): Monthly budget override maximum monthly spend amount. + + 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,) + start_month (datetime, none_type): Monthly budget override start month, format \"yyyy-MM\". If it is null, the StartMonth would be the following month of the last item in the override sequence.. [optional] # noqa: E501 + status (str, none_type): Monthly budget override computed status.. [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.duration = duration + self.max_monthly_spend = max_monthly_spend + 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_2024-04/criteo_api_retailmedia_v2024_04/model/negotiation_state_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/negotiation_state_model.py new file mode 100644 index 00000000..7c061829 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/negotiation_state_model.py @@ -0,0 +1,293 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class NegotiationStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INVALID': "Invalid", + 'MODIFIED': "Modified", + 'SUBMITTED': "Submitted", + 'REVIEWED': "Reviewed", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/page_metadata.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/page_metadata.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/page_metadata.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/page_metadata.py index 95b7bf72..2d6f2e66 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/page_metadata.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/page_metadata.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/page_of_insertion_order_history_change_data_capture.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/page_of_insertion_order_history_change_data_capture.py new file mode 100644 index 00000000..f026130a --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/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: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.insertion_order_history_change_data_capture import InsertionOrderHistoryChangeDataCapture + from criteo_api_retailmedia_v2024_04.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_2024-04/criteo_api_retailmedia_v2024_04/model/page_type_environment.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/page_type_environment.py new file mode 100644 index 00000000..9b62a566 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/page_type_environment.py @@ -0,0 +1,287 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class PageTypeEnvironment(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 = { + ('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", + }, + } + + 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 { + 'page_type': (str,), # noqa: E501 + 'environments': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'page_type': 'pageType', # noqa: E501 + 'environments': 'environments', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PageTypeEnvironment - 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,) + page_type (str): Creative PageType. [optional] # noqa: E501 + environments ([str]): List of environments per PageType. [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 + """PageTypeEnvironment - 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,) + page_type (str): Creative PageType. [optional] # noqa: E501 + environments ([str]): List of environments per PageType. [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_2023-01/criteo_api_retailmedia_v2023_01/model/post_campaign_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/post_campaign_v202301.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/post_campaign_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/post_campaign_v202301.py index 41af0a4d..ab5a9aa7 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/post_campaign_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/post_campaign_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301 + from criteo_api_retailmedia_v2024_04.model.json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301 globals()['JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301'] = JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item202110_paged_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item202110_paged_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item202110_paged_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item202110_paged_list_response.py index 3dde4d01..56e64ed2 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item202110_paged_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item202110_paged_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_preferred_line_item202110 import ResourceOfPreferredLineItem202110 + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_preferred_line_item202110 import ResourceOfPreferredLineItem202110 globals()['PageMetadata'] = PageMetadata globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfPreferredLineItem202110'] = ResourceOfPreferredLineItem202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item202110_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item202110_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item202110_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item202110_response.py index b032b9f4..fb4efb43 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item202110_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item202110_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_preferred_line_item202110 import ResourceOfPreferredLineItem202110 + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_preferred_line_item202110 import ResourceOfPreferredLineItem202110 globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfPreferredLineItem202110'] = ResourceOfPreferredLineItem202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item_create_model202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item_create_model202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item_create_model202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item_create_model202110_request.py index 4f1843f3..7ef86836 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item_create_model202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item_create_model202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.input_resource_of_preferred_line_item_create_model202110 import InputResourceOfPreferredLineItemCreateModel202110 + from criteo_api_retailmedia_v2024_04.model.input_resource_of_preferred_line_item_create_model202110 import InputResourceOfPreferredLineItemCreateModel202110 globals()['InputResourceOfPreferredLineItemCreateModel202110'] = InputResourceOfPreferredLineItemCreateModel202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item_update_model202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item_update_model202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item_update_model202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item_update_model202110_request.py index 3001895b..aa8098c2 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/preferred_line_item_update_model202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/preferred_line_item_update_model202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.resource_of_preferred_line_item_update_model202110 import ResourceOfPreferredLineItemUpdateModel202110 + from criteo_api_retailmedia_v2024_04.model.resource_of_preferred_line_item_update_model202110 import ResourceOfPreferredLineItemUpdateModel202110 globals()['ResourceOfPreferredLineItemUpdateModel202110'] = ResourceOfPreferredLineItemUpdateModel202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/problem_details.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/problem_details.py new file mode 100644 index 00000000..335fc4b1 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/problem_details.py @@ -0,0 +1,305 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ProblemDetails(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 = { + ('type',): { + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'trace_identifier': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'instance': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 + 'source': ({str: (str,)},), # noqa: E501 + 'stack_trace': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'trace_id': 'traceId', # noqa: E501 + 'trace_identifier': 'traceIdentifier', # noqa: E501 + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProblemDetails - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 + type (str): The problem's category.. [optional] # noqa: E501 + code (str): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str): Technical information, only used in non-prod environments. [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 + """ProblemDetails - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional] # noqa: E501 + type (str): The problem's category.. [optional] # noqa: E501 + code (str): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str): Technical information, only used in non-prod environments. [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_2023-01/criteo_api_retailmedia_v2023_01/model/promoted_product202110_list_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/promoted_product202110_list_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/promoted_product202110_list_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/promoted_product202110_list_request.py index d57e3231..6aa05657 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/promoted_product202110_list_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/promoted_product202110_list_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 + from criteo_api_retailmedia_v2024_04.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 globals()['ResourceOfPromotedProduct202110'] = ResourceOfPromotedProduct202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/promoted_product202110_paged_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/promoted_product202110_paged_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/promoted_product202110_paged_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/promoted_product202110_paged_list_response.py index 8f5c56a7..241f192e 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/promoted_product202110_paged_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/promoted_product202110_paged_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.page_metadata import PageMetadata - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 + from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 globals()['PageMetadata'] = PageMetadata globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfPromotedProduct202110'] = ResourceOfPromotedProduct202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model.py new file mode 100644 index 00000000..79eb0c7f --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model.py @@ -0,0 +1,284 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.approval_status_model import ApprovalStatusModel + from criteo_api_retailmedia_v2024_04.model.negotiation_state_model import NegotiationStateModel + globals()['ApprovalStatusModel'] = ApprovalStatusModel + globals()['NegotiationStateModel'] = NegotiationStateModel + + +class ProposalStatusModel(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 { + 'negotiation_state': (NegotiationStateModel,), # noqa: E501 + 'booking_status': (ApprovalStatusModel,), # noqa: E501 + 'runnable_status': (ApprovalStatusModel,), # noqa: E501 + 'comment': (str, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negotiation_state': 'negotiationState', # noqa: E501 + 'booking_status': 'bookingStatus', # noqa: E501 + 'runnable_status': 'runnableStatus', # noqa: E501 + 'comment': 'comment', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model_resource.py new file mode 100644 index 00000000..0caacd67 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.proposal_status_model import ProposalStatusModel + globals()['ProposalStatusModel'] = ProposalStatusModel + + +class ProposalStatusModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (ProposalStatusModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model_response.py new file mode 100644 index 00000000..f154d465 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/proposal_status_model_response.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.proposal_status_model_resource import ProposalStatusModelResource + from criteo_api_retailmedia_v2024_04.model.rmca_common_problem import RmcaCommonProblem + globals()['ProposalStatusModelResource'] = ProposalStatusModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ProposalStatusModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (ProposalStatusModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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_2023-01/criteo_api_retailmedia_v2023_01/model/put_campaign_v202301.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/put_campaign_v202301.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/put_campaign_v202301.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/put_campaign_v202301.py index 3112a851..bd03a6a9 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/put_campaign_v202301.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/put_campaign_v202301.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 + from criteo_api_retailmedia_v2024_04.model.json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 globals()['JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301'] = JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/report_outcome.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/report_outcome.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/report_outcome.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/report_outcome.py index d84c2aa2..7c7a969f 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/report_outcome.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/report_outcome.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem globals()['CommonProblem'] = CommonProblem diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_add_funds_to_balance.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_add_funds_to_balance.py new file mode 100644 index 00000000..82c9b5eb --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_add_funds_to_balance.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.external_add_funds_to_balance import ExternalAddFundsToBalance + globals()['ExternalAddFundsToBalance'] = ExternalAddFundsToBalance + + +class ResourceOfAddFundsToBalance(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 { + 'attributes': (ExternalAddFundsToBalance,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfAddFundsToBalance - 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,) + attributes (ExternalAddFundsToBalance): [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 + """ + + _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 + """ResourceOfAddFundsToBalance - 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,) + attributes (ExternalAddFundsToBalance): [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 + """ + + _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_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_auction_line_item.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_auction_line_item.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_auction_line_item.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_auction_line_item.py index 6edcefc2..4d93db4b 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_auction_line_item.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_auction_line_item.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_auction_line_item import ExternalAuctionLineItem + from criteo_api_retailmedia_v2024_04.model.external_auction_line_item import ExternalAuctionLineItem globals()['ExternalAuctionLineItem'] = ExternalAuctionLineItem diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_auction_line_item_update_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_auction_line_item_update_model.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_auction_line_item_update_model.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_auction_line_item_update_model.py index ed290876..4360c16c 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_auction_line_item_update_model.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_auction_line_item_update_model.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_auction_line_item_update_model import ExternalAuctionLineItemUpdateModel + from criteo_api_retailmedia_v2024_04.model.external_auction_line_item_update_model import ExternalAuctionLineItemUpdateModel globals()['ExternalAuctionLineItemUpdateModel'] = ExternalAuctionLineItemUpdateModel diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_balance_campaign202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_balance_campaign202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_balance_campaign202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_balance_campaign202110.py index 70b9939d..2ff75470 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_balance_campaign202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_balance_campaign202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_balance_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_balance_response.py new file mode 100644 index 00000000..ff0b169f --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_balance_response.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.external_balance_response import ExternalBalanceResponse + globals()['ExternalBalanceResponse'] = ExternalBalanceResponse + + +class ResourceOfBalanceResponse(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 { + 'attributes': (ExternalBalanceResponse,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfBalanceResponse - 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,) + attributes (ExternalBalanceResponse): [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 + """ + + _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 + """ResourceOfBalanceResponse - 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,) + attributes (ExternalBalanceResponse): [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 + """ + + _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_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_category202204.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_category202204.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_category202204.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_category202204.py index a6554081..c366e2e9 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_category202204.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_category202204.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.category202204 import Category202204 + from criteo_api_retailmedia_v2024_04.model.category202204 import Category202204 globals()['Category202204'] = Category202204 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_change_dates_of_balance.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_change_dates_of_balance.py new file mode 100644 index 00000000..64774aa7 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_change_dates_of_balance.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.external_change_dates_of_balance import ExternalChangeDatesOfBalance + globals()['ExternalChangeDatesOfBalance'] = ExternalChangeDatesOfBalance + + +class ResourceOfChangeDatesOfBalance(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 { + 'attributes': (ExternalChangeDatesOfBalance,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfChangeDatesOfBalance - 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,) + attributes (ExternalChangeDatesOfBalance): [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 + """ + + _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 + """ResourceOfChangeDatesOfBalance - 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,) + attributes (ExternalChangeDatesOfBalance): [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 + """ + + _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_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_common_line_item.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_common_line_item.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_common_line_item.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_common_line_item.py index ab6b3a45..c950413c 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_common_line_item.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_common_line_item.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_common_line_item import ExternalCommonLineItem + from criteo_api_retailmedia_v2024_04.model.external_common_line_item import ExternalCommonLineItem globals()['ExternalCommonLineItem'] = ExternalCommonLineItem diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_create_balance.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_create_balance.py new file mode 100644 index 00000000..1fd20ef9 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_create_balance.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.external_create_balance import ExternalCreateBalance + globals()['ExternalCreateBalance'] = ExternalCreateBalance + + +class ResourceOfCreateBalance(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 { + 'attributes': (ExternalCreateBalance,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfCreateBalance - 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,) + attributes (ExternalCreateBalance): [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 + """ + + _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 + """ResourceOfCreateBalance - 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,) + attributes (ExternalCreateBalance): [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 + """ + + _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_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_creative202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_creative202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_creative202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_creative202110.py index 0216d984..facdbb61 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_creative202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_creative202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.creative202110 import Creative202110 + from criteo_api_retailmedia_v2024_04.model.creative202110 import Creative202110 globals()['Creative202110'] = Creative202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_creative202210.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_creative202210.py new file mode 100644 index 00000000..b34900d2 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_creative202210.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.creative202210 import Creative202210 + globals()['Creative202210'] = Creative202210 + + +class ResourceOfCreative202210(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 { + 'attributes': (Creative202210,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfCreative202210 - 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,) + 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 + """ + + _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 + """ResourceOfCreative202210 - 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,) + 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 + """ + + _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_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_line_item_bid_multipliers.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_line_item_bid_multipliers.py new file mode 100644 index 00000000..b57d0968 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_line_item_bid_multipliers.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers import LineItemBidMultipliers + globals()['LineItemBidMultipliers'] = LineItemBidMultipliers + + +class ResourceOfLineItemBidMultipliers(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 { + 'attributes': (LineItemBidMultipliers,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfLineItemBidMultipliers - 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,) + attributes (LineItemBidMultipliers): [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 + """ + + _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 + """ResourceOfLineItemBidMultipliers - 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,) + attributes (LineItemBidMultipliers): [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 + """ + + _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_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_preferred_line_item202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_preferred_line_item202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_preferred_line_item202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_preferred_line_item202110.py index 3c3453ab..f70070f7 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_preferred_line_item202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_preferred_line_item202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_preferred_line_item202110 import ExternalPreferredLineItem202110 + from criteo_api_retailmedia_v2024_04.model.external_preferred_line_item202110 import ExternalPreferredLineItem202110 globals()['ExternalPreferredLineItem202110'] = ExternalPreferredLineItem202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_preferred_line_item_update_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_preferred_line_item_update_model202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_preferred_line_item_update_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_preferred_line_item_update_model202110.py index 646db091..a89e1218 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_preferred_line_item_update_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_preferred_line_item_update_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_preferred_line_item_update_model202110 import ExternalPreferredLineItemUpdateModel202110 + from criteo_api_retailmedia_v2024_04.model.external_preferred_line_item_update_model202110 import ExternalPreferredLineItemUpdateModel202110 globals()['ExternalPreferredLineItemUpdateModel202110'] = ExternalPreferredLineItemUpdateModel202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_promoted_product202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_promoted_product202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_promoted_product202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_promoted_product202110.py index 9dad23c9..5d844203 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_promoted_product202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_promoted_product202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_promoted_product202110 import ExternalPromotedProduct202110 + from criteo_api_retailmedia_v2024_04.model.external_promoted_product202110 import ExternalPromotedProduct202110 globals()['ExternalPromotedProduct202110'] = ExternalPromotedProduct202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_retail_media_account.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_retail_media_account.py new file mode 100644 index 00000000..fd455633 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_retail_media_account.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.retail_media_account import RetailMediaAccount + globals()['RetailMediaAccount'] = RetailMediaAccount + + +class ResourceOfRetailMediaAccount(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 { + 'attributes': (RetailMediaAccount,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfRetailMediaAccount - 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,) + attributes (RetailMediaAccount): [optional] # noqa: E501 + id (str, none_type): Unique identifier of this resource.. [optional] # noqa: E501 + type (str, 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 + """ResourceOfRetailMediaAccount - 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,) + attributes (RetailMediaAccount): [optional] # noqa: E501 + id (str, none_type): Unique identifier of this resource.. [optional] # noqa: E501 + type (str, 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_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_template.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_template.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_template.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_template.py index 654db438..02d2c73c 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/resource_of_template.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_template.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.template import Template + from criteo_api_retailmedia_v2024_04.model.template import Template globals()['Template'] = Template diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_update_balance_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_update_balance_model.py new file mode 100644 index 00000000..d68cc4a0 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_of_update_balance_model.py @@ -0,0 +1,277 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.external_update_balance_model import ExternalUpdateBalanceModel + globals()['ExternalUpdateBalanceModel'] = ExternalUpdateBalanceModel + + +class ResourceOfUpdateBalanceModel(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 { + 'attributes': (ExternalUpdateBalanceModel,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfUpdateBalanceModel - 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,) + attributes (ExternalUpdateBalanceModel): [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 + """ + + _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 + """ResourceOfUpdateBalanceModel - 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,) + attributes (ExternalUpdateBalanceModel): [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 + """ + + _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_2024-04/criteo_api_retailmedia_v2024_04/model/resource_outcome.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_outcome.py new file mode 100644 index 00000000..dfc80501 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_outcome.py @@ -0,0 +1,268 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.rmca_common_problem import RmcaCommonProblem + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ResourceOutcome(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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_2024-04/criteo_api_retailmedia_v2024_04/model/resource_outcome_of_retail_media_account.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_outcome_of_retail_media_account.py new file mode 100644 index 00000000..b37e07da --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/resource_outcome_of_retail_media_account.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.resource_of_retail_media_account import ResourceOfRetailMediaAccount + globals()['CommonProblem'] = CommonProblem + globals()['ResourceOfRetailMediaAccount'] = ResourceOfRetailMediaAccount + + +class ResourceOutcomeOfRetailMediaAccount(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': (ResourceOfRetailMediaAccount,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """ResourceOutcomeOfRetailMediaAccount - 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 (ResourceOfRetailMediaAccount): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """ResourceOutcomeOfRetailMediaAccount - 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 (ResourceOfRetailMediaAccount): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_account.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_account.py new file mode 100644 index 00000000..fa1b6913 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_account.py @@ -0,0 +1,297 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class RetailMediaAccount(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'SUPPLY': "Supply", + 'DEMAND': "Demand", + }, + ('sub_type',): { + 'None': None, + 'UNKNOWN': "Unknown", + 'BRAND': "Brand", + 'SELLER': "Seller", + }, + } + + 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 { + 'name': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'sub_type': (str, none_type,), # noqa: E501 + 'country_ids': ([str], none_type,), # noqa: E501 + 'currency_id': (str, none_type,), # noqa: E501 + 'parent_account_label': (str, none_type,), # noqa: E501 + 'time_zone': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'company_name': 'companyName', # noqa: E501 + 'type': 'type', # noqa: E501 + 'sub_type': 'subType', # noqa: E501 + 'country_ids': 'countryIds', # noqa: E501 + 'currency_id': 'currencyId', # noqa: E501 + 'parent_account_label': 'parentAccountLabel', # noqa: E501 + 'time_zone': 'timeZone', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RetailMediaAccount - 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): account name. [optional] # noqa: E501 + company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501 + type (str, none_type): Type for the account. [optional] # noqa: E501 + sub_type (str, none_type): subtype for the account. [optional] # noqa: E501 + country_ids ([str], none_type): list of countries associated with the account. [optional] # noqa: E501 + currency_id (str, none_type): the currency for the account. [optional] # noqa: E501 + parent_account_label (str, none_type): parent account label for the account. [optional] # noqa: E501 + time_zone (str, none_type): the timezone for the account. [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 + """RetailMediaAccount - 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): account name. [optional] # noqa: E501 + company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501 + type (str, none_type): Type for the account. [optional] # noqa: E501 + sub_type (str, none_type): subtype for the account. [optional] # noqa: E501 + country_ids ([str], none_type): list of countries associated with the account. [optional] # noqa: E501 + currency_id (str, none_type): the currency for the account. [optional] # noqa: E501 + parent_account_label (str, none_type): parent account label for the account. [optional] # noqa: E501 + time_zone (str, none_type): the timezone for the account. [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_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_brand_account_creation.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_brand_account_creation.py new file mode 100644 index 00000000..9cde578a --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_brand_account_creation.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class RetailMediaBrandAccountCreation(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 { + 'name': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'brands': ([int], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'company_name': 'companyName', # noqa: E501 + 'brands': 'brands', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RetailMediaBrandAccountCreation - 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): the name of the account, must be unique across all accounts. [optional] # noqa: E501 + company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501 + brands ([int], none_type): list of brands to link to the new account. [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 + """RetailMediaBrandAccountCreation - 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): the name of the account, must be unique across all accounts. [optional] # noqa: E501 + company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501 + brands ([int], none_type): list of brands to link to the new account. [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_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_brands.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_brands.py new file mode 100644 index 00000000..de133464 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/retail_media_brands.py @@ -0,0 +1,257 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.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_2024-04/criteo_api_retailmedia_v2024_04/model/review_state_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/review_state_model.py new file mode 100644 index 00000000..25540a5a --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/review_state_model.py @@ -0,0 +1,294 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class ReviewStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INREVIEW': "InReview", + 'RECOMMENDED': "Recommended", + 'APPROVED': "Approved", + 'AUTOAPPROVED': "AutoApproved", + 'REJECTED': "Rejected", + 'AUTOREJECTED': "AutoRejected", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1.py index d25ce1c1..8ede1f1f 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1_resource.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1_resource.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1_resource.py index 67664d5e..507e5fe8 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1_resource.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1 globals()['RmLegacyAudienceCreateEntityV1'] = RmLegacyAudienceCreateEntityV1 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1_response.py index 109ac68c..4d798c9b 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v1_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v1_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource globals()['CommonProblem'] = CommonProblem globals()['RmLegacyAudienceCreateEntityV1Resource'] = RmLegacyAudienceCreateEntityV1Resource diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2.py index 62ccd6d1..915622a0 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_user_behavior_create_v2 import RmLegacyAudienceUserBehaviorCreateV2 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_user_behavior_create_v2 import RmLegacyAudienceUserBehaviorCreateV2 globals()['RmLegacyAudienceUserBehaviorCreateV2'] = RmLegacyAudienceUserBehaviorCreateV2 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2_resource.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2_resource.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2_resource.py index abc8055b..6db16709 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2_resource.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2_resource.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v2 import RmLegacyAudienceCreateEntityV2 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v2 import RmLegacyAudienceCreateEntityV2 globals()['RmLegacyAudienceCreateEntityV2'] = RmLegacyAudienceCreateEntityV2 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2_response.py index 03be8a1f..e3db9058 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_entity_v2_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_entity_v2_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v2_resource import RmLegacyAudienceCreateEntityV2Resource + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v2_resource import RmLegacyAudienceCreateEntityV2Resource globals()['CommonProblem'] = CommonProblem globals()['RmLegacyAudienceCreateEntityV2Resource'] = RmLegacyAudienceCreateEntityV2Resource diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_input_entity_v1.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_input_entity_v1.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_input_entity_v1.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_input_entity_v1.py index d57cf9da..eca32f46 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_input_entity_v1.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_input_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource globals()['RmLegacyAudienceCreateEntityV1Resource'] = RmLegacyAudienceCreateEntityV1Resource diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_input_entity_v2.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_input_entity_v2.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_input_entity_v2.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_input_entity_v2.py index 8807bcb3..34fa7c73 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_create_input_entity_v2.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_create_input_entity_v2.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_create_entity_v2_resource import RmLegacyAudienceCreateEntityV2Resource + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v2_resource import RmLegacyAudienceCreateEntityV2Resource globals()['RmLegacyAudienceCreateEntityV2Resource'] = RmLegacyAudienceCreateEntityV2Resource diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1.py index fa998472..f1bf5324 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList - from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList + from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 globals()['RmLegacySegmentCustomerList'] = RmLegacySegmentCustomerList globals()['RmLegacySegmentUserBehaviorV1'] = RmLegacySegmentUserBehaviorV1 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1_list_response.py index 86da115e..d0650f05 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v1_resource import RmLegacyAudienceGetEntityV1Resource + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v1_resource import RmLegacyAudienceGetEntityV1Resource globals()['CommonProblem'] = CommonProblem globals()['RmLegacyAudienceGetEntityV1Resource'] = RmLegacyAudienceGetEntityV1Resource diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1_resource.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1_resource.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1_resource.py index c569048a..134a5624 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v1_resource.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v1_resource.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v1 import RmLegacyAudienceGetEntityV1 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v1 import RmLegacyAudienceGetEntityV1 globals()['RmLegacyAudienceGetEntityV1'] = RmLegacyAudienceGetEntityV1 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2.py index 7c947282..85d07134 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_user_behavior_details_v2 import RmLegacyAudienceUserBehaviorDetailsV2 - from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_user_behavior_details_v2 import RmLegacyAudienceUserBehaviorDetailsV2 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList globals()['RmLegacyAudienceUserBehaviorDetailsV2'] = RmLegacyAudienceUserBehaviorDetailsV2 globals()['RmLegacySegmentCustomerList'] = RmLegacySegmentCustomerList diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2_list_response.py index e60def45..ec1f1819 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.common_problem import CommonProblem - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v2_resource import RmLegacyAudienceGetEntityV2Resource + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v2_resource import RmLegacyAudienceGetEntityV2Resource globals()['CommonProblem'] = CommonProblem globals()['RmLegacyAudienceGetEntityV2Resource'] = RmLegacyAudienceGetEntityV2Resource diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2_resource.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2_resource.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2_resource.py index 6f5b1f43..233d4df2 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_get_entity_v2_resource.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_get_entity_v2_resource.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_audience_get_entity_v2 import RmLegacyAudienceGetEntityV2 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v2 import RmLegacyAudienceGetEntityV2 globals()['RmLegacyAudienceGetEntityV2'] = RmLegacyAudienceGetEntityV2 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_user_behavior_create_v2.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_user_behavior_create_v2.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_user_behavior_create_v2.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_user_behavior_create_v2.py index d5c3d1d9..dfdc5da5 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_user_behavior_create_v2.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_user_behavior_create_v2.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2 globals()['RmLegacySegmentUserBehaviorCreateV2'] = RmLegacySegmentUserBehaviorCreateV2 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_user_behavior_details_v2.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_user_behavior_details_v2.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_user_behavior_details_v2.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_user_behavior_details_v2.py index 36549b87..2c73d00c 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_audience_user_behavior_details_v2.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_audience_user_behavior_details_v2.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 + from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 globals()['RmLegacySegmentUserBehaviorV2'] = RmLegacySegmentUserBehaviorV2 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_customer_list.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_customer_list.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_customer_list.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_customer_list.py index 4851f7bf..f9d377e9 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_customer_list.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_customer_list.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_create_v2.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_create_v2.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_create_v2.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_create_v2.py index 52393334..75134b2b 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_create_v2.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_create_v2.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_v1.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_v1.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_v1.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_v1.py index 7629a017..c7328d22 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_v1.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_v1.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_v2.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_v2.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_v2.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_v2.py index e9e5ea66..f13df3e5 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/rm_legacy_segment_user_behavior_v2.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rm_legacy_segment_user_behavior_v2.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rmca_common_problem.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rmca_common_problem.py new file mode 100644 index 00000000..252f67b6 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/rmca_common_problem.py @@ -0,0 +1,306 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class RmcaCommonProblem(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + 'status': (int, none_type,), # 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 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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_2023-01/criteo_api_retailmedia_v2023_01/model/section.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/section.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/section.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/section.py index 59254963..bf830b27 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/section.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/section.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.template_variable import TemplateVariable + from criteo_api_retailmedia_v2024_04.model.template_variable import TemplateVariable globals()['TemplateVariable'] = TemplateVariable diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bid_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bid_model.py new file mode 100644 index 00000000..c2ccaa2e --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bid_model.py @@ -0,0 +1,265 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class SetBidModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'bid': 'bid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model.py new file mode 100644 index 00000000..f923a01d --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.set_bid_model import SetBidModel + globals()['SetBidModel'] = SetBidModel + + +class SetBidsModel(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 { + 'keywords': ([SetBidModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model_request.py new file mode 100644 index 00000000..ce2917fb --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model_request.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.set_bids_model_resource import SetBidsModelResource + globals()['SetBidsModelResource'] = SetBidsModelResource + + +class SetBidsModelRequest(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': (SetBidsModelResource,), # 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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model_resource.py new file mode 100644 index 00000000..56b79af0 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/set_bids_model_resource.py @@ -0,0 +1,270 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.set_bids_model import SetBidsModel + globals()['SetBidsModel'] = SetBidsModel + + +class SetBidsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (SetBidsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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_2023-01/criteo_api_retailmedia_v2023_01/model/status_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/status_response.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/status_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/status_response.py index 190d8ecc..cb2cf9c0 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/status_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/status_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/status_response_resource.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/status_response_resource.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/status_response_resource.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/status_response_resource.py index ff313ebd..a0e1ae10 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/status_response_resource.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/status_response_resource.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.status_response import StatusResponse + from criteo_api_retailmedia_v2024_04.model.status_response import StatusResponse globals()['StatusResponse'] = StatusResponse diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_ids_update_model202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_ids_update_model202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_ids_update_model202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_ids_update_model202110_request.py index 502551c8..b3321827 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_ids_update_model202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_ids_update_model202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_store_ids_update_model202110 import ValueTypeResourceOfStoreIdsUpdateModel202110 + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_store_ids_update_model202110 import ValueTypeResourceOfStoreIdsUpdateModel202110 globals()['ValueTypeResourceOfStoreIdsUpdateModel202110'] = ValueTypeResourceOfStoreIdsUpdateModel202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_target202110_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_target202110_request.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_target202110_request.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_target202110_request.py index 8d4e243b..0c3c795e 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_target202110_request.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_target202110_request.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_store_target202110 import ValueTypeResourceOfStoreTarget202110 + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_store_target202110 import ValueTypeResourceOfStoreTarget202110 globals()['ValueTypeResourceOfStoreTarget202110'] = ValueTypeResourceOfStoreTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_target202110_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_target202110_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_target202110_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_target202110_response.py index 504274c3..8786d053 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/store_target202110_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/store_target202110_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.value_type_resource_of_store_target202110 import ValueTypeResourceOfStoreTarget202110 + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_store_target202110 import ValueTypeResourceOfStoreTarget202110 globals()['ProblemDetails'] = ProblemDetails globals()['ValueTypeResourceOfStoreTarget202110'] = ValueTypeResourceOfStoreTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template.py index fd792529..414be4f7 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.section import Section + from criteo_api_retailmedia_v2024_04.model.section import Section globals()['Section'] = Section diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_list_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_list_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_list_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_list_response.py index 5a136a66..18629cb4 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_list_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_list_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_template import ResourceOfTemplate + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_template import ResourceOfTemplate globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfTemplate'] = ResourceOfTemplate diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_response.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_response.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_response.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_response.py index 982f166c..05474d42 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_response.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_response.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,12 +26,12 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.problem_details import ProblemDetails - from criteo_api_retailmedia_v2023_01.model.resource_of_template import ResourceOfTemplate + from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails + from criteo_api_retailmedia_v2024_04.model.resource_of_template import ResourceOfTemplate globals()['ProblemDetails'] = ProblemDetails globals()['ResourceOfTemplate'] = ResourceOfTemplate diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_variable.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_variable.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_variable.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_variable.py index 607c25fe..95413036 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/template_variable.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_variable.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,13 +26,13 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.choice_variable_specification import ChoiceVariableSpecification - from criteo_api_retailmedia_v2023_01.model.files_variables_specification import FilesVariablesSpecification - from criteo_api_retailmedia_v2023_01.model.text_variable_specification import TextVariableSpecification + from criteo_api_retailmedia_v2024_04.model.choice_variable_specification import ChoiceVariableSpecification + from criteo_api_retailmedia_v2024_04.model.files_variables_specification import FilesVariablesSpecification + from criteo_api_retailmedia_v2024_04.model.text_variable_specification import TextVariableSpecification globals()['ChoiceVariableSpecification'] = ChoiceVariableSpecification globals()['FilesVariablesSpecification'] = FilesVariablesSpecification globals()['TextVariableSpecification'] = TextVariableSpecification diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_variable_value.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_variable_value.py new file mode 100644 index 00000000..c830b3d2 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/template_variable_value.py @@ -0,0 +1,303 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.choice_variable_value import ChoiceVariableValue + from criteo_api_retailmedia_v2024_04.model.color_variable_value import ColorVariableValue + from criteo_api_retailmedia_v2024_04.model.files_variable_value import FilesVariableValue + from criteo_api_retailmedia_v2024_04.model.hyperlink_variable_value import HyperlinkVariableValue + from criteo_api_retailmedia_v2024_04.model.text_variable_value import TextVariableValue + globals()['ChoiceVariableValue'] = ChoiceVariableValue + globals()['ColorVariableValue'] = ColorVariableValue + globals()['FilesVariableValue'] = FilesVariableValue + globals()['HyperlinkVariableValue'] = HyperlinkVariableValue + globals()['TextVariableValue'] = TextVariableValue + + +class TemplateVariableValue(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 { + '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 + } + + @cached_property + def discriminator(): + return None + + + 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 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """TemplateVariableValue - a model defined in OpenAPI + + Args: + id (str): The id of the template variable the value is applied to + + 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,) + 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) + _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 + 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, *args, **kwargs): # noqa: E501 + """TemplateVariableValue - a model defined in OpenAPI + + Args: + id (str): The id of the template variable the value is applied to + + 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,) + 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) + _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 + 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_2023-01/criteo_api_retailmedia_v2023_01/model/text_variable_specification.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/text_variable_specification.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/text_variable_specification.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/text_variable_specification.py index 87d1bfa3..3605a935 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/text_variable_specification.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/text_variable_specification.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,7 +26,7 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/text_variable_value.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/text_variable_value.py new file mode 100644 index 00000000..3b5a626c --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/text_variable_value.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + + +class TextVariableValue(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 { + 'text': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'text': 'text', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, text, *args, **kwargs): # noqa: E501 + """TextVariableValue - a model defined in OpenAPI + + Args: + text (str): The displayed text + + 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.text = text + 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, text, *args, **kwargs): # noqa: E501 + """TextVariableValue - a model defined in OpenAPI + + Args: + text (str): The displayed text + + 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.text = text + 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_2024-04/criteo_api_retailmedia_v2024_04/model/update_balance_model_request.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/update_balance_model_request.py new file mode 100644 index 00000000..2830ee3c --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/update_balance_model_request.py @@ -0,0 +1,269 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.resource_of_update_balance_model import ResourceOfUpdateBalanceModel + globals()['ResourceOfUpdateBalanceModel'] = ResourceOfUpdateBalanceModel + + +class UpdateBalanceModelRequest(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': (ResourceOfUpdateBalanceModel,), # 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 + """UpdateBalanceModelRequest - 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 (ResourceOfUpdateBalanceModel): [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 + """UpdateBalanceModelRequest - 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 (ResourceOfUpdateBalanceModel): [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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_campaign_budget_overrides.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_campaign_budget_overrides.py new file mode 100644 index 00000000..b5e1c87d --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_campaign_budget_overrides.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.value_resource_of_campaign_budget_overrides import ValueResourceOfCampaignBudgetOverrides + globals()['ValueResourceOfCampaignBudgetOverrides'] = ValueResourceOfCampaignBudgetOverrides + + +class ValueResourceInputOfCampaignBudgetOverrides(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': (ValueResourceOfCampaignBudgetOverrides,), # 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 + """ValueResourceInputOfCampaignBudgetOverrides - 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 (ValueResourceOfCampaignBudgetOverrides): [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 + """ValueResourceInputOfCampaignBudgetOverrides - 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 (ValueResourceOfCampaignBudgetOverrides): [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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_line_item_budget_overrides.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_line_item_budget_overrides.py new file mode 100644 index 00000000..64413273 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_line_item_budget_overrides.py @@ -0,0 +1,262 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.value_resource_of_line_item_budget_overrides import ValueResourceOfLineItemBudgetOverrides + globals()['ValueResourceOfLineItemBudgetOverrides'] = ValueResourceOfLineItemBudgetOverrides + + +class ValueResourceInputOfLineItemBudgetOverrides(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': (ValueResourceOfLineItemBudgetOverrides,), # 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 + """ValueResourceInputOfLineItemBudgetOverrides - 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 (ValueResourceOfLineItemBudgetOverrides): [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 + """ValueResourceInputOfLineItemBudgetOverrides - 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 (ValueResourceOfLineItemBudgetOverrides): [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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_retail_media_brand_account_creation.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_retail_media_brand_account_creation.py new file mode 100644 index 00000000..6e92e21e --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/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: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_retail_media_brands.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_input_of_retail_media_brands.py new file mode 100644 index 00000000..512bddc7 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/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: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_campaign_budget_overrides.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_campaign_budget_overrides.py new file mode 100644 index 00000000..81afd80b --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_campaign_budget_overrides.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.campaign_budget_overrides import CampaignBudgetOverrides + globals()['CampaignBudgetOverrides'] = CampaignBudgetOverrides + + +class ValueResourceOfCampaignBudgetOverrides(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': (CampaignBudgetOverrides,), # 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 + """ValueResourceOfCampaignBudgetOverrides - 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 (CampaignBudgetOverrides): [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 + """ValueResourceOfCampaignBudgetOverrides - 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 (CampaignBudgetOverrides): [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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_line_item_budget_overrides.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_line_item_budget_overrides.py new file mode 100644 index 00000000..5b480ae1 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_line_item_budget_overrides.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.line_item_budget_overrides import LineItemBudgetOverrides + globals()['LineItemBudgetOverrides'] = LineItemBudgetOverrides + + +class ValueResourceOfLineItemBudgetOverrides(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': (LineItemBudgetOverrides,), # 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 + """ValueResourceOfLineItemBudgetOverrides - 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 (LineItemBudgetOverrides): [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 + """ValueResourceOfLineItemBudgetOverrides - 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 (LineItemBudgetOverrides): [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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brand_account_creation.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brand_account_creation.py new file mode 100644 index 00000000..d7459c6d --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/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: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brands.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brands.py new file mode 100644 index 00000000..98873f83 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brands.py @@ -0,0 +1,266 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.retail_media_brands import RetailMediaBrands + globals()['RetailMediaBrands'] = RetailMediaBrands + + +class ValueResourceOfRetailMediaBrands(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': (RetailMediaBrands,), # 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 + """ValueResourceOfRetailMediaBrands - 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 (RetailMediaBrands): [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 + """ValueResourceOfRetailMediaBrands - 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 (RetailMediaBrands): [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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_outcome_of_campaign_budget_overrides.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_outcome_of_campaign_budget_overrides.py new file mode 100644 index 00000000..63ff463e --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_outcome_of_campaign_budget_overrides.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.value_resource_of_campaign_budget_overrides import ValueResourceOfCampaignBudgetOverrides + globals()['CommonProblem'] = CommonProblem + globals()['ValueResourceOfCampaignBudgetOverrides'] = ValueResourceOfCampaignBudgetOverrides + + +class ValueResourceOutcomeOfCampaignBudgetOverrides(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': (ValueResourceOfCampaignBudgetOverrides,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """ValueResourceOutcomeOfCampaignBudgetOverrides - 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 (ValueResourceOfCampaignBudgetOverrides): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """ValueResourceOutcomeOfCampaignBudgetOverrides - 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 (ValueResourceOfCampaignBudgetOverrides): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_outcome_of_line_item_budget_overrides.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_outcome_of_line_item_budget_overrides.py new file mode 100644 index 00000000..7f1d96ba --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_resource_outcome_of_line_item_budget_overrides.py @@ -0,0 +1,274 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from criteo_api_retailmedia_v2024_04.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_v2024_04.exceptions import ApiAttributeError + + +def lazy_import(): + from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem + from criteo_api_retailmedia_v2024_04.model.value_resource_of_line_item_budget_overrides import ValueResourceOfLineItemBudgetOverrides + globals()['CommonProblem'] = CommonProblem + globals()['ValueResourceOfLineItemBudgetOverrides'] = ValueResourceOfLineItemBudgetOverrides + + +class ValueResourceOutcomeOfLineItemBudgetOverrides(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': (ValueResourceOfLineItemBudgetOverrides,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """ValueResourceOutcomeOfLineItemBudgetOverrides - 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 (ValueResourceOfLineItemBudgetOverrides): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """ValueResourceOutcomeOfLineItemBudgetOverrides - 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 (ValueResourceOfLineItemBudgetOverrides): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_add_to_basket_ids_update_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_add_to_basket_ids_update_model202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_add_to_basket_ids_update_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_add_to_basket_ids_update_model202110.py index b5e1f631..97062c02 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_add_to_basket_ids_update_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_add_to_basket_ids_update_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_add_to_basket_ids_update_model202110 import ExternalAddToBasketIdsUpdateModel202110 + from criteo_api_retailmedia_v2024_04.model.external_add_to_basket_ids_update_model202110 import ExternalAddToBasketIdsUpdateModel202110 globals()['ExternalAddToBasketIdsUpdateModel202110'] = ExternalAddToBasketIdsUpdateModel202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_add_to_basket_target202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_add_to_basket_target202110.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_add_to_basket_target202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_add_to_basket_target202110.py index 7bc86b94..280b7e38 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_add_to_basket_target202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_add_to_basket_target202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_add_to_basket_target202110 import ExternalAddToBasketTarget202110 + from criteo_api_retailmedia_v2024_04.model.external_add_to_basket_target202110 import ExternalAddToBasketTarget202110 globals()['ExternalAddToBasketTarget202110'] = ExternalAddToBasketTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_audience_ids_update_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_audience_ids_update_model202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_audience_ids_update_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_audience_ids_update_model202110.py index 5454f70b..174592c7 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_audience_ids_update_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_audience_ids_update_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_audience_ids_update_model202110 import ExternalAudienceIdsUpdateModel202110 + from criteo_api_retailmedia_v2024_04.model.external_audience_ids_update_model202110 import ExternalAudienceIdsUpdateModel202110 globals()['ExternalAudienceIdsUpdateModel202110'] = ExternalAudienceIdsUpdateModel202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_audience_target202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_audience_target202110.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_audience_target202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_audience_target202110.py index b44a5c7d..f56ee343 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_audience_target202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_audience_target202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_audience_target202110 import ExternalAudienceTarget202110 + from criteo_api_retailmedia_v2024_04.model.external_audience_target202110 import ExternalAudienceTarget202110 globals()['ExternalAudienceTarget202110'] = ExternalAudienceTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_keyword_target202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_keyword_target202110.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_keyword_target202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_keyword_target202110.py index 61a5b28b..061626ae 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_keyword_target202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_keyword_target202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_keyword_target202110 import ExternalKeywordTarget202110 + from criteo_api_retailmedia_v2024_04.model.external_keyword_target202110 import ExternalKeywordTarget202110 globals()['ExternalKeywordTarget202110'] = ExternalKeywordTarget202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_store_ids_update_model202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_store_ids_update_model202110.py similarity index 98% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_store_ids_update_model202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_store_ids_update_model202110.py index 4dbedf20..1cfe93ca 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_store_ids_update_model202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_store_ids_update_model202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_store_ids_update_model202110 import ExternalStoreIdsUpdateModel202110 + from criteo_api_retailmedia_v2024_04.model.external_store_ids_update_model202110 import ExternalStoreIdsUpdateModel202110 globals()['ExternalStoreIdsUpdateModel202110'] = ExternalStoreIdsUpdateModel202110 diff --git a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_store_target202110.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_store_target202110.py similarity index 97% rename from sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_store_target202110.py rename to sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_store_target202110.py index ed1bfaab..1455adfd 100644 --- a/sdks/retailmedia_2023-01/criteo_api_retailmedia_v2023_01/model/value_type_resource_of_store_target202110.py +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model/value_type_resource_of_store_target202110.py @@ -3,7 +3,7 @@ Criteo API - RetailMedia # noqa: E501 - The version of the OpenAPI document: 2023-01 + The version of the OpenAPI document: 2024-04 Generated by: https://openapi-generator.tech """ @@ -11,7 +11,7 @@ import re # noqa: F401 import sys # noqa: F401 -from criteo_api_retailmedia_v2023_01.model_utils import ( # noqa: F401 +from criteo_api_retailmedia_v2024_04.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, ModelNormal, @@ -26,11 +26,11 @@ validate_get_composed_info, OpenApiModel ) -from criteo_api_retailmedia_v2023_01.exceptions import ApiAttributeError +from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError def lazy_import(): - from criteo_api_retailmedia_v2023_01.model.external_store_target202110 import ExternalStoreTarget202110 + from criteo_api_retailmedia_v2024_04.model.external_store_target202110 import ExternalStoreTarget202110 globals()['ExternalStoreTarget202110'] = ExternalStoreTarget202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model_utils.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model_utils.py new file mode 100644 index 00000000..595038b1 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/model_utils.py @@ -0,0 +1,2058 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +from datetime import date, datetime # noqa: F401 +from copy import deepcopy +import inspect +import io +import os +import pprint +import re +import tempfile +import uuid + +from dateutil.parser import parse + +from criteo_api_retailmedia_v2024_04.exceptions import ( + ApiKeyError, + ApiAttributeError, + ApiTypeError, + ApiValueError, +) + +none_type = type(None) +file_type = io.IOBase + + +def convert_js_args_to_python_args(fn): + from functools import wraps + @wraps(fn) + def wrapped_init(_self, *args, **kwargs): + """ + An attribute named `self` received from the api will conflicts with the reserved `self` + parameter of a class method. During generation, `self` attributes are mapped + to `_self` in models. Here, we name `_self` instead of `self` to avoid conflicts. + """ + spec_property_naming = kwargs.get('_spec_property_naming', False) + if spec_property_naming: + kwargs = change_keys_js_to_python( + kwargs, _self if isinstance( + _self, type) else _self.__class__) + return fn(_self, *args, **kwargs) + return wrapped_init + + +class cached_property(object): + # this caches the result of the function call for fn with no inputs + # use this as a decorator on function methods that you want converted + # into cached properties + result_key = '_results' + + def __init__(self, fn): + self._fn = fn + + def __get__(self, instance, cls=None): + if self.result_key in vars(self): + return vars(self)[self.result_key] + else: + result = self._fn() + setattr(self, self.result_key, result) + return result + + +PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) + + +def allows_single_value_input(cls): + """ + This function returns True if the input composed schema model or any + descendant model allows a value only input + This is true for cases where oneOf contains items like: + oneOf: + - float + - NumberWithValidation + - StringEnum + - ArrayModel + - null + TODO: lru_cache this + """ + if ( + issubclass(cls, ModelSimple) or + cls in PRIMITIVE_TYPES + ): + return True + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return False + return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) + return False + + +def composed_model_input_classes(cls): + """ + This function returns a list of the possible models that can be accepted as + inputs. + TODO: lru_cache this + """ + if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: + return [cls] + elif issubclass(cls, ModelNormal): + if cls.discriminator is None: + return [cls] + else: + return get_discriminated_classes(cls) + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return [] + if cls.discriminator is None: + input_classes = [] + for c in cls._composed_schemas['oneOf']: + input_classes.extend(composed_model_input_classes(c)) + return input_classes + else: + return get_discriminated_classes(cls) + return [] + + +class OpenApiModel(object): + """The base class for all OpenAPIModels""" + + def set_attribute(self, name, value): + # this is only used to set properties on self + + path_to_item = [] + if self._path_to_item: + path_to_item.extend(self._path_to_item) + path_to_item.append(name) + + if name in self.openapi_types: + required_types_mixed = self.openapi_types[name] + elif self.additional_properties_type is None: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + path_to_item + ) + elif self.additional_properties_type is not None: + required_types_mixed = self.additional_properties_type + + if get_simple_class(name) != str: + error_msg = type_error_message( + var_name=name, + var_value=name, + valid_classes=(str,), + key_type=True + ) + raise ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=(str,), + key_type=True + ) + + if self._check_type: + value = validate_and_convert_types( + value, required_types_mixed, path_to_item, self._spec_property_naming, + self._check_type, configuration=self._configuration) + if (name,) in self.allowed_values: + check_allowed_values( + self.allowed_values, + (name,), + value + ) + if (name,) in self.validations: + check_validations( + self.validations, + (name,), + value, + self._configuration + ) + self.__dict__['_data_store'][name] = value + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other + + def __setattr__(self, attr, value): + """set the value of an attribute using dot notation: `instance.attr = val`""" + self[attr] = value + + def __getattr__(self, attr): + """get the value of an attribute using dot notation: `instance.attr`""" + return self.__getitem__(attr) + + def __copy__(self): + cls = self.__class__ + if self.get("_spec_property_naming", False): + return cls._new_from_openapi_data(**self.__dict__) + else: + return cls.__new__(cls, **self.__dict__) + + def __deepcopy__(self, memo): + cls = self.__class__ + + if self.get("_spec_property_naming", False): + new_inst = cls._new_from_openapi_data() + else: + new_inst = cls.__new__(cls, **self.__dict__) + + for k, v in self.__dict__.items(): + setattr(new_inst, k, deepcopy(v, memo)) + return new_inst + + + def __new__(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: 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 the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return super(OpenApiModel, cls).__new__(cls) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return super(OpenApiModel, cls).__new__(cls) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = super(OpenApiModel, cls).__new__(cls) + self_inst.__init__(*args, **kwargs) + + if kwargs.get("_spec_property_naming", False): + # when true, implies new is from deserialization + new_inst = new_cls._new_from_openapi_data(*args, **kwargs) + else: + new_inst = new_cls.__new__(new_cls, *args, **kwargs) + new_inst.__init__(*args, **kwargs) + + return new_inst + + @classmethod + @convert_js_args_to_python_args + def _new_from_openapi_data(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: 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 the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return cls._from_openapi_data(*args, **kwargs) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return cls._from_openapi_data(*args, **kwargs) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = cls._from_openapi_data(*args, **kwargs) + + new_inst = new_cls._new_from_openapi_data(*args, **kwargs) + return new_inst + + +class ModelSimple(OpenApiModel): + """the parent class of models whose type != object in their + swagger/openapi""" + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] + + def to_str(self): + """Returns the string representation of the model""" + return str(self.value) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + this_val = self._data_store['value'] + that_val = other._data_store['value'] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + return vals_equal + + +class ModelNormal(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi""" + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] + + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True + + +class ModelComposed(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi and have oneOf/allOf/anyOf + + When one sets a property we use var_name_to_model_instances to store the value in + the correct class instances + run any type checking + validation code. + When one gets a property we use var_name_to_model_instances to get the value + from the correct class instances. + This allows multiple composed schemas to contain the same property with additive + constraints on the value. + + _composed_schemas (dict) stores the anyOf/allOf/oneOf classes + key (str): allOf/oneOf/anyOf + value (list): the classes in the XOf definition. + Note: none_type can be included when the openapi document version >= 3.1.0 + _composed_instances (list): stores a list of instances of the composed schemas + defined in _composed_schemas. When properties are accessed in the self instance, + they are returned from the self._data_store or the data stores in the instances + in self._composed_schemas + _var_name_to_model_instances (dict): maps between a variable name on self and + the composed instances (self included) which contain that data + key (str): property name + value (list): list of class instances, self or instances in _composed_instances + which contain the value that the key is referring to. + """ + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + """ + Use cases: + 1. additional_properties_type is None (additionalProperties == False in spec) + Check for property presence in self.openapi_types + if not present then throw an error + if present set in self, set attribute + always set on composed schemas + 2. additional_properties_type exists + set attribute on self + always set on composed schemas + """ + if self.additional_properties_type is None: + """ + For an attribute to exist on a composed schema it must: + - fulfill schema_requirements in the self composed schema not considering oneOf/anyOf/allOf schemas AND + - fulfill schema_requirements in each oneOf/anyOf/allOf schemas + + schema_requirements: + For an attribute to exist on a schema it must: + - be present in properties at the schema OR + - have additionalProperties unset (defaults additionalProperties = any type) OR + - have additionalProperties set + """ + if name not in self.openapi_types: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + # attribute must be set on self and composed instances + self.set_attribute(name, value) + for model_instance in self._composed_instances: + setattr(model_instance, name, value) + if name not in self._var_name_to_model_instances: + # we assigned an additional property + self.__dict__['_var_name_to_model_instances'][name] = self._composed_instances + [self] + return None + + __unset_attribute_value__ = object() + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + # get the attribute from the correct instance + model_instances = self._var_name_to_model_instances.get(name) + values = [] + # A composed model stores self and child (oneof/anyOf/allOf) models under + # self._var_name_to_model_instances. + # Any property must exist in self and all model instances + # The value stored in all model instances must be the same + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + v = model_instance._data_store[name] + if v not in values: + values.append(v) + len_values = len(values) + if len_values == 0: + return default + elif len_values == 1: + return values[0] + elif len_values > 1: + raise ApiValueError( + "Values stored for property {0} in {1} differ when looking " + "at self and self's composed instances. All values must be " + "the same".format(name, type(self).__name__), + [e for e in [self._path_to_item, name] if e] + ) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + value = self.get(name, self.__unset_attribute_value__) + if value is self.__unset_attribute_value__: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + return value + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + + if name in self.required_properties: + return name in self.__dict__ + + model_instances = self._var_name_to_model_instances.get( + name, self._additional_properties_model_instances) + + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + return True + + return False + + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True + + +COERCION_INDEX_BY_TYPE = { + ModelComposed: 0, + ModelNormal: 1, + ModelSimple: 2, + none_type: 3, # The type of 'None'. + list: 4, + dict: 5, + float: 6, + int: 7, + bool: 8, + datetime: 9, + date: 10, + str: 11, + file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. +} + +# these are used to limit what type conversions we try to do +# when we have a valid type already and we want to try converting +# to another type +UPCONVERSION_TYPE_PAIRS = ( + (str, datetime), + (str, date), + # A float may be serialized as an integer, e.g. '3' is a valid serialized float. + (int, float), + (list, ModelComposed), + (dict, ModelComposed), + (str, ModelComposed), + (int, ModelComposed), + (float, ModelComposed), + (list, ModelComposed), + (list, ModelNormal), + (dict, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), +) + +COERCIBLE_TYPE_PAIRS = { + False: ( # client instantiation of a model with client data + # (dict, ModelComposed), + # (list, ModelComposed), + # (dict, ModelNormal), + # (list, ModelNormal), + # (str, ModelSimple), + # (int, ModelSimple), + # (float, ModelSimple), + # (list, ModelSimple), + # (str, int), + # (str, float), + # (str, datetime), + # (str, date), + # (int, str), + # (float, str), + ), + True: ( # server -> client data + (dict, ModelComposed), + (list, ModelComposed), + (dict, ModelNormal), + (list, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), + # (str, int), + # (str, float), + (str, datetime), + (str, date), + # (int, str), + # (float, str), + (str, file_type) + ), +} + + +def get_simple_class(input_value): + """Returns an input_value's simple class that we will use for type checking + Python2: + float and int will return int, where int is the python3 int backport + str and unicode will return str, where str is the python3 str backport + Note: float and int ARE both instances of int backport + Note: str_py2 and unicode_py2 are NOT both instances of str backport + + Args: + input_value (class/class_instance): the item for which we will return + the simple class + """ + if isinstance(input_value, type): + # input_value is a class + return input_value + elif isinstance(input_value, tuple): + return tuple + elif isinstance(input_value, list): + return list + elif isinstance(input_value, dict): + return dict + elif isinstance(input_value, none_type): + return none_type + elif isinstance(input_value, file_type): + return file_type + elif isinstance(input_value, bool): + # this must be higher than the int check because + # isinstance(True, int) == True + return bool + elif isinstance(input_value, int): + return int + elif isinstance(input_value, datetime): + # this must be higher than the date check because + # isinstance(datetime_instance, date) == True + return datetime + elif isinstance(input_value, date): + return date + elif isinstance(input_value, str): + return str + return type(input_value) + + +def check_allowed_values(allowed_values, input_variable_path, input_values): + """Raises an exception if the input_values are not allowed + + Args: + allowed_values (dict): the allowed_values dict + input_variable_path (tuple): the path to the input variable + input_values (list/str/int/float/date/datetime): the values that we + are checking to see if they are in allowed_values + """ + these_allowed_values = list(allowed_values[input_variable_path].values()) + if (isinstance(input_values, list) + and not set(input_values).issubset( + set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values) - set(these_allowed_values))), + raise ApiValueError( + "Invalid values for `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (isinstance(input_values, dict) + and not set( + input_values.keys()).issubset(set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values.keys()) - set(these_allowed_values))) + raise ApiValueError( + "Invalid keys in `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (not isinstance(input_values, (list, dict)) + and input_values not in these_allowed_values): + raise ApiValueError( + "Invalid value for `%s` (%s), must be one of %s" % + ( + input_variable_path[0], + input_values, + these_allowed_values + ) + ) + + +def is_json_validation_enabled(schema_keyword, configuration=None): + """Returns true if JSON schema validation is enabled for the specified + validation keyword. This can be used to skip JSON schema structural validation + as requested in the configuration. + + Args: + schema_keyword (string): the name of a JSON schema validation keyword. + configuration (Configuration): the configuration class. + """ + + return (configuration is None or + not hasattr(configuration, '_disabled_client_side_validations') or + schema_keyword not in configuration._disabled_client_side_validations) + + +def check_validations( + validations, input_variable_path, input_values, + configuration=None): + """Raises an exception if the input_values are invalid + + Args: + validations (dict): the validation dictionary. + input_variable_path (tuple): the path to the input variable. + input_values (list/str/int/float/date/datetime): the values that we + are checking. + configuration (Configuration): the configuration class. + """ + + if input_values is None: + return + + current_validations = validations[input_variable_path] + if (is_json_validation_enabled('multipleOf', configuration) and + 'multiple_of' in current_validations and + isinstance(input_values, (int, float)) and + not (float(input_values) / current_validations['multiple_of']).is_integer()): + # Note 'multipleOf' will be as good as the floating point arithmetic. + raise ApiValueError( + "Invalid value for `%s`, value must be a multiple of " + "`%s`" % ( + input_variable_path[0], + current_validations['multiple_of'] + ) + ) + + if (is_json_validation_enabled('maxLength', configuration) and + 'max_length' in current_validations and + len(input_values) > current_validations['max_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['max_length'] + ) + ) + + if (is_json_validation_enabled('minLength', configuration) and + 'min_length' in current_validations and + len(input_values) < current_validations['min_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be greater than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['min_length'] + ) + ) + + if (is_json_validation_enabled('maxItems', configuration) and + 'max_items' in current_validations and + len(input_values) > current_validations['max_items']): + raise ApiValueError( + "Invalid value for `%s`, number of items must be less than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['max_items'] + ) + ) + + if (is_json_validation_enabled('minItems', configuration) and + 'min_items' in current_validations and + len(input_values) < current_validations['min_items']): + raise ValueError( + "Invalid value for `%s`, number of items must be greater than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['min_items'] + ) + ) + + items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', + 'inclusive_minimum') + if (any(item in current_validations for item in items)): + if isinstance(input_values, list): + max_val = max(input_values) + min_val = min(input_values) + elif isinstance(input_values, dict): + max_val = max(input_values.values()) + min_val = min(input_values.values()) + else: + max_val = input_values + min_val = input_values + + if (is_json_validation_enabled('exclusiveMaximum', configuration) and + 'exclusive_maximum' in current_validations and + max_val >= current_validations['exclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than `%s`" % ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('maximum', configuration) and + 'inclusive_maximum' in current_validations and + max_val > current_validations['inclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['inclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('exclusiveMinimum', configuration) and + 'exclusive_minimum' in current_validations and + min_val <= current_validations['exclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than `%s`" % + ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('minimum', configuration) and + 'inclusive_minimum' in current_validations and + min_val < current_validations['inclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than or equal " + "to `%s`" % ( + input_variable_path[0], + current_validations['inclusive_minimum'] + ) + ) + flags = current_validations.get('regex', {}).get('flags', 0) + if (is_json_validation_enabled('pattern', configuration) and + 'regex' in current_validations and + not re.search(current_validations['regex']['pattern'], + input_values, flags=flags)): + err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( + input_variable_path[0], + current_validations['regex']['pattern'] + ) + if flags != 0: + # Don't print the regex flags if the flags are not + # specified in the OAS document. + err_msg = r"%s with flags=`%s`" % (err_msg, flags) + raise ApiValueError(err_msg) + + +def order_response_types(required_types): + """Returns the required types sorted in coercion order + + Args: + required_types (list/tuple): collection of classes or instance of + list or dict with class information inside it. + + Returns: + (list): coercion order sorted collection of classes or instance + of list or dict with class information inside it. + """ + + def index_getter(class_or_instance): + if isinstance(class_or_instance, list): + return COERCION_INDEX_BY_TYPE[list] + elif isinstance(class_or_instance, dict): + return COERCION_INDEX_BY_TYPE[dict] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelComposed)): + return COERCION_INDEX_BY_TYPE[ModelComposed] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelNormal)): + return COERCION_INDEX_BY_TYPE[ModelNormal] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelSimple)): + return COERCION_INDEX_BY_TYPE[ModelSimple] + elif class_or_instance in COERCION_INDEX_BY_TYPE: + return COERCION_INDEX_BY_TYPE[class_or_instance] + raise ApiValueError("Unsupported type: %s" % class_or_instance) + + sorted_types = sorted( + required_types, + key=lambda class_or_instance: index_getter(class_or_instance) + ) + return sorted_types + + +def remove_uncoercible(required_types_classes, current_item, spec_property_naming, + must_convert=True): + """Only keeps the type conversions that are possible + + Args: + required_types_classes (tuple): tuple of classes that are required + these should be ordered by COERCION_INDEX_BY_TYPE + 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 variables names in the input data are python + variable names in PEP-8 snake case. + current_item (any): the current item (input data) to be converted + + Keyword Args: + must_convert (bool): if True the item to convert is of the wrong + type and we want a big list of coercibles + if False, we want a limited list of coercibles + + Returns: + (list): the remaining coercible required types, classes only + """ + current_type_simple = get_simple_class(current_item) + + results_classes = [] + for required_type_class in required_types_classes: + # convert our models to OpenApiModel + required_type_class_simplified = required_type_class + if isinstance(required_type_class_simplified, type): + if issubclass(required_type_class_simplified, ModelComposed): + required_type_class_simplified = ModelComposed + elif issubclass(required_type_class_simplified, ModelNormal): + required_type_class_simplified = ModelNormal + elif issubclass(required_type_class_simplified, ModelSimple): + required_type_class_simplified = ModelSimple + + if required_type_class_simplified == current_type_simple: + # don't consider converting to one's own class + continue + + class_pair = (current_type_simple, required_type_class_simplified) + if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: + results_classes.append(required_type_class) + elif class_pair in UPCONVERSION_TYPE_PAIRS: + results_classes.append(required_type_class) + return results_classes + + +def get_discriminated_classes(cls): + """ + Returns all the classes that a discriminator converts to + TODO: lru_cache this + """ + possible_classes = [] + key = list(cls.discriminator.keys())[0] + if is_type_nullable(cls): + possible_classes.append(cls) + for discr_cls in cls.discriminator[key].values(): + if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: + possible_classes.extend(get_discriminated_classes(discr_cls)) + else: + possible_classes.append(discr_cls) + return possible_classes + + +def get_possible_classes(cls, from_server_context): + # TODO: lru_cache this + possible_classes = [cls] + if from_server_context: + return possible_classes + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + possible_classes = [] + possible_classes.extend(get_discriminated_classes(cls)) + elif issubclass(cls, ModelComposed): + possible_classes.extend(composed_model_input_classes(cls)) + return possible_classes + + +def get_required_type_classes(required_types_mixed, spec_property_naming): + """Converts the tuple required_types into a tuple and a dict described + below + + Args: + required_types_mixed (tuple/list): will contain either classes or + instance of list or dict + spec_property_naming (bool): if True these values came from the + server, and we use the data types in our endpoints. + If False, we are client side and we need to include + oneOf and discriminator classes inside the data types in our endpoints + + Returns: + (valid_classes, dict_valid_class_to_child_types_mixed): + valid_classes (tuple): the valid classes that the current item + should be + dict_valid_class_to_child_types_mixed (dict): + valid_class (class): this is the key + child_types_mixed (list/dict/tuple): describes the valid child + types + """ + valid_classes = [] + child_req_types_by_current_type = {} + for required_type in required_types_mixed: + if isinstance(required_type, list): + valid_classes.append(list) + child_req_types_by_current_type[list] = required_type + elif isinstance(required_type, tuple): + valid_classes.append(tuple) + child_req_types_by_current_type[tuple] = required_type + elif isinstance(required_type, dict): + valid_classes.append(dict) + child_req_types_by_current_type[dict] = required_type[str] + else: + valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) + return tuple(valid_classes), child_req_types_by_current_type + + +def change_keys_js_to_python(input_dict, model_class): + """ + Converts from javascript_key keys in the input_dict to python_keys in + the output dict using the mapping in model_class. + If the input_dict contains a key which does not declared in the model_class, + the key is added to the output dict as is. The assumption is the model_class + may have undeclared properties (additionalProperties attribute in the OAS + document). + """ + + if getattr(model_class, 'attribute_map', None) is None: + return input_dict + output_dict = {} + reversed_attr_map = {value: key for key, value in + model_class.attribute_map.items()} + for javascript_key, value in input_dict.items(): + python_key = reversed_attr_map.get(javascript_key) + if python_key is None: + # if the key is unknown, it is in error or it is an + # additionalProperties variable + python_key = javascript_key + output_dict[python_key] = value + return output_dict + + +def get_type_error(var_value, path_to_item, valid_classes, key_type=False): + error_msg = type_error_message( + var_name=path_to_item[-1], + var_value=var_value, + valid_classes=valid_classes, + key_type=key_type + ) + return ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=valid_classes, + key_type=key_type + ) + + +def deserialize_primitive(data, klass, path_to_item): + """Deserializes string to primitive type. + + :param data: str/int/float + :param klass: str/class the class to convert to + + :return: int, float, str, bool, date, datetime + """ + additional_message = "" + try: + if klass in {datetime, date}: + additional_message = ( + "If you need your parameter to have a fallback " + "string value, please set its type as `type: {}` in your " + "spec. That allows the value to be any type. " + ) + if klass == datetime: + if len(data) < 8: + raise ValueError("This is not a datetime") + # The string should be in iso8601 datetime format. + parsed_datetime = parse(data) + date_only = ( + parsed_datetime.hour == 0 and + parsed_datetime.minute == 0 and + parsed_datetime.second == 0 and + parsed_datetime.tzinfo is None and + 8 <= len(data) <= 10 + ) + if date_only: + raise ValueError("This is a date, not a datetime") + return parsed_datetime + elif klass == date: + if len(data) < 8: + raise ValueError("This is not a date") + return parse(data).date() + else: + converted_value = klass(data) + if isinstance(data, str) and klass == float: + if str(converted_value) != data: + # '7' -> 7.0 -> '7.0' != '7' + raise ValueError('This is not a float') + return converted_value + except (OverflowError, ValueError) as ex: + # parse can raise OverflowError + raise ApiValueError( + "{0}Failed to parse {1} as {2}".format( + additional_message, repr(data), klass.__name__ + ), + path_to_item=path_to_item + ) from ex + + +def get_discriminator_class(model_class, + discr_name, + discr_value, cls_visited): + """Returns the child class specified by the discriminator. + + Args: + model_class (OpenApiModel): the model class. + discr_name (string): the name of the discriminator property. + discr_value (any): the discriminator value. + cls_visited (list): list of model classes that have been visited. + Used to determine the discriminator class without + visiting circular references indefinitely. + + Returns: + used_model_class (class/None): the chosen child class that will be used + to deserialize the data, for example dog.Dog. + If a class is not found, None is returned. + """ + + if model_class in cls_visited: + # The class has already been visited and no suitable class was found. + return None + cls_visited.append(model_class) + used_model_class = None + if discr_name in model_class.discriminator: + class_name_to_discr_class = model_class.discriminator[discr_name] + used_model_class = class_name_to_discr_class.get(discr_value) + if used_model_class is None: + # We didn't find a discriminated class in class_name_to_discr_class. + # So look in the ancestor or descendant discriminators + # The discriminator mapping may exist in a descendant (anyOf, oneOf) + # or ancestor (allOf). + # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat + # hierarchy, the discriminator mappings may be defined at any level + # in the hierarchy. + # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig + # if we try to make BasquePig from mammal, we need to travel through + # the oneOf descendant discriminators to find BasquePig + descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ + model_class._composed_schemas.get('anyOf', ()) + ancestor_classes = model_class._composed_schemas.get('allOf', ()) + possible_classes = descendant_classes + ancestor_classes + for cls in possible_classes: + # Check if the schema has inherited discriminators. + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + used_model_class = get_discriminator_class( + cls, discr_name, discr_value, cls_visited) + if used_model_class is not None: + return used_model_class + return used_model_class + + +def deserialize_model(model_data, model_class, path_to_item, check_type, + configuration, spec_property_naming): + """Deserializes model_data to model instance. + + Args: + model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model + model_class (OpenApiModel): the model class + path_to_item (list): path to the model in the received data + check_type (bool): whether to check the data tupe for the values in + the model + configuration (Configuration): the instance to use to convert files + 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 variables names in the input data are python + variable names in PEP-8 snake case. + + Returns: + model instance + + Raise: + ApiTypeError + ApiValueError + ApiKeyError + """ + + kw_args = dict(_check_type=check_type, + _path_to_item=path_to_item, + _configuration=configuration, + _spec_property_naming=spec_property_naming) + + if issubclass(model_class, ModelSimple): + return model_class._new_from_openapi_data(model_data, **kw_args) + elif isinstance(model_data, list): + return model_class._new_from_openapi_data(*model_data, **kw_args) + if isinstance(model_data, dict): + kw_args.update(model_data) + return model_class._new_from_openapi_data(**kw_args) + elif isinstance(model_data, PRIMITIVE_TYPES): + return model_class._new_from_openapi_data(model_data, **kw_args) + + +def deserialize_file(response_data, configuration, content_disposition=None): + """Deserializes body to file + + Saves response body into a file in a temporary folder, + using the filename from the `Content-Disposition` header if provided. + + Args: + param response_data (str): the file data to write + configuration (Configuration): the instance to use to convert files + + Keyword Args: + content_disposition (str): the value of the Content-Disposition + header + + Returns: + (file_type): the deserialized file which is open + The user is responsible for closing and reading the file + """ + fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) + os.close(fd) + os.remove(path) + + if content_disposition: + filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition, + flags=re.I) + if filename is not None: + filename = filename.group(1) + else: + filename = "default_" + str(uuid.uuid4()) + + path = os.path.join(os.path.dirname(path), filename) + + with open(path, "wb") as f: + if isinstance(response_data, str): + # change str to bytes so we can write it + response_data = response_data.encode('utf-8') + f.write(response_data) + + f = open(path, "rb") + return f + + +def attempt_convert_item(input_value, valid_classes, path_to_item, + configuration, spec_property_naming, key_type=False, + must_convert=False, check_type=True): + """ + Args: + input_value (any): the data to convert + valid_classes (any): the classes that are valid + path_to_item (list): the path to the item to convert + configuration (Configuration): the instance to use to convert files + 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 variables names in the input data are python + variable names in PEP-8 snake case. + key_type (bool): if True we need to convert a key type (not supported) + must_convert (bool): if True we must convert + check_type (bool): if True we check the type or the returned data in + ModelComposed/ModelNormal/ModelSimple instances + + Returns: + instance (any) the fixed item + + Raises: + ApiTypeError + ApiValueError + ApiKeyError + """ + valid_classes_ordered = order_response_types(valid_classes) + valid_classes_coercible = remove_uncoercible( + valid_classes_ordered, input_value, spec_property_naming) + if not valid_classes_coercible or key_type: + # we do not handle keytype errors, json will take care + # of this for us + if configuration is None or not configuration.discard_unknown_keys: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=key_type) + for valid_class in valid_classes_coercible: + try: + if issubclass(valid_class, OpenApiModel): + return deserialize_model(input_value, valid_class, + path_to_item, check_type, + configuration, spec_property_naming) + elif valid_class == file_type: + return deserialize_file(input_value, configuration) + return deserialize_primitive(input_value, valid_class, + path_to_item) + except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: + if must_convert: + raise conversion_exc + # if we have conversion errors when must_convert == False + # we ignore the exception and move on to the next class + continue + # we were unable to convert, must_convert == False + return input_value + + +def is_type_nullable(input_type): + """ + Returns true if None is an allowed value for the specified input_type. + + A type is nullable if at least one of the following conditions is true: + 1. The OAS 'nullable' attribute has been specified, + 1. The type is the 'null' type, + 1. The type is a anyOf/oneOf composed schema, and a child schema is + the 'null' type. + Args: + input_type (type): the class of the input_value that we are + checking + Returns: + bool + """ + if input_type is none_type: + return True + if issubclass(input_type, OpenApiModel) and input_type._nullable: + return True + if issubclass(input_type, ModelComposed): + # If oneOf/anyOf, check if the 'null' type is one of the allowed types. + for t in input_type._composed_schemas.get('oneOf', ()): + if is_type_nullable(t): + return True + for t in input_type._composed_schemas.get('anyOf', ()): + if is_type_nullable(t): + return True + return False + + +def is_valid_type(input_class_simple, valid_classes): + """ + Args: + input_class_simple (class): the class of the input_value that we are + checking + valid_classes (tuple): the valid classes that the current item + should be + Returns: + bool + """ + if issubclass(input_class_simple, OpenApiModel) and \ + valid_classes == (bool, date, datetime, dict, float, int, list, str, none_type,): + return True + valid_type = input_class_simple in valid_classes + if not valid_type and ( + issubclass(input_class_simple, OpenApiModel) or + input_class_simple is none_type): + for valid_class in valid_classes: + if input_class_simple is none_type and is_type_nullable(valid_class): + # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. + return True + if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): + continue + discr_propertyname_py = list(valid_class.discriminator.keys())[0] + discriminator_classes = ( + valid_class.discriminator[discr_propertyname_py].values() + ) + valid_type = is_valid_type(input_class_simple, discriminator_classes) + if valid_type: + return True + return valid_type + + +def validate_and_convert_types(input_value, required_types_mixed, path_to_item, + spec_property_naming, _check_type, configuration=None): + """Raises a TypeError is there is a problem, otherwise returns value + + Args: + input_value (any): the data to validate/convert + required_types_mixed (list/dict/tuple): A list of + valid classes, or a list tuples of valid classes, or a dict where + the value is a tuple of value classes + path_to_item: (list) the path to the data being validated + this stores a list of keys or indices to get to the data being + validated + 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 variables names in the input data are python + variable names in PEP-8 snake case. + _check_type: (boolean) if true, type will be checked and conversion + will be attempted. + configuration: (Configuration): the configuration class to use + when converting file_type items. + If passed, conversion will be attempted when possible + If not passed, no conversions will be attempted and + exceptions will be raised + + Returns: + the correctly typed value + + Raises: + ApiTypeError + """ + results = get_required_type_classes(required_types_mixed, spec_property_naming) + valid_classes, child_req_types_by_current_type = results + + input_class_simple = get_simple_class(input_value) + valid_type = is_valid_type(input_class_simple, valid_classes) + if not valid_type: + if (configuration + or (input_class_simple == dict + and dict not in valid_classes)): + # if input_value is not valid_type try to convert it + converted_instance = attempt_convert_item( + input_value, + valid_classes, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=True, + check_type=_check_type + ) + return converted_instance + else: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=False) + + # input_value's type is in valid_classes + if len(valid_classes) > 1 and configuration: + # there are valid classes which are not the current class + valid_classes_coercible = remove_uncoercible( + valid_classes, input_value, spec_property_naming, must_convert=False) + if valid_classes_coercible: + converted_instance = attempt_convert_item( + input_value, + valid_classes_coercible, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=False, + check_type=_check_type + ) + return converted_instance + + if child_req_types_by_current_type == {}: + # all types are of the required types and there are no more inner + # variables left to look at + return input_value + inner_required_types = child_req_types_by_current_type.get( + type(input_value) + ) + if inner_required_types is None: + # for this type, there are not more inner variables left to look at + return input_value + if isinstance(input_value, list): + if input_value == []: + # allow an empty list + return input_value + for index, inner_value in enumerate(input_value): + inner_path = list(path_to_item) + inner_path.append(index) + input_value[index] = validate_and_convert_types( + inner_value, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + elif isinstance(input_value, dict): + if input_value == {}: + # allow an empty dict + return input_value + for inner_key, inner_val in input_value.items(): + inner_path = list(path_to_item) + inner_path.append(inner_key) + if get_simple_class(inner_key) != str: + raise get_type_error(inner_key, inner_path, valid_classes, + key_type=True) + input_value[inner_key] = validate_and_convert_types( + inner_val, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + return input_value + + +def model_to_dict(model_instance, serialize=True): + """Returns the model properties as a dict + + Args: + model_instance (one of your model instances): the model instance that + will be converted to a dict. + + Keyword Args: + serialize (bool): if True, the keys in the dict will be values from + attribute_map + """ + result = {} + + def extract_item(item): return ( + item[0], model_to_dict( + item[1], serialize=serialize)) if hasattr( + item[1], '_data_store') else item + + model_instances = [model_instance] + if model_instance._composed_schemas: + model_instances.extend(model_instance._composed_instances) + seen_json_attribute_names = set() + used_fallback_python_attribute_names = set() + py_to_json_map = {} + for model_instance in model_instances: + for attr, value in model_instance._data_store.items(): + if serialize: + # we use get here because additional property key names do not + # exist in attribute_map + try: + attr = model_instance.attribute_map[attr] + py_to_json_map.update(model_instance.attribute_map) + seen_json_attribute_names.add(attr) + except KeyError: + used_fallback_python_attribute_names.add(attr) + if isinstance(value, list): + if not value: + # empty list or None + result[attr] = value + else: + res = [] + for v in value: + if isinstance(v, PRIMITIVE_TYPES) or v is None: + res.append(v) + elif isinstance(v, ModelSimple): + res.append(v.value) + elif isinstance(v, dict): + res.append(dict(map( + extract_item, + v.items() + ))) + else: + res.append(model_to_dict(v, serialize=serialize)) + result[attr] = res + elif isinstance(value, dict): + result[attr] = dict(map( + extract_item, + value.items() + )) + elif isinstance(value, ModelSimple): + result[attr] = value.value + elif hasattr(value, '_data_store'): + result[attr] = model_to_dict(value, serialize=serialize) + else: + result[attr] = value + if serialize: + for python_key in used_fallback_python_attribute_names: + json_key = py_to_json_map.get(python_key) + if json_key is None: + continue + if python_key == json_key: + continue + json_key_assigned_no_need_for_python_key = json_key in seen_json_attribute_names + if json_key_assigned_no_need_for_python_key: + del result[python_key] + + return result + + +def type_error_message(var_value=None, var_name=None, valid_classes=None, + key_type=None): + """ + Keyword Args: + var_value (any): the variable which has the type_error + var_name (str): the name of the variable which has the typ error + valid_classes (tuple): the accepted classes for current_item's + value + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + """ + key_or_value = 'value' + if key_type: + key_or_value = 'key' + valid_classes_phrase = get_valid_classes_phrase(valid_classes) + msg = ( + "Invalid type for variable '{0}'. Required {1} type {2} and " + "passed type was {3}".format( + var_name, + key_or_value, + valid_classes_phrase, + type(var_value).__name__, + ) + ) + return msg + + +def get_valid_classes_phrase(input_classes): + """Returns a string phrase describing what types are allowed + """ + all_classes = list(input_classes) + all_classes = sorted(all_classes, key=lambda cls: cls.__name__) + all_class_names = [cls.__name__ for cls in all_classes] + if len(all_class_names) == 1: + return 'is {0}'.format(all_class_names[0]) + return "is one of [{0}]".format(", ".join(all_class_names)) + + +def get_allof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + used to make instances + constant_args (dict): + metadata arguments: + _check_type + _path_to_item + _spec_property_naming + _configuration + _visited_composed_classes + + Returns + composed_instances (list) + """ + composed_instances = [] + for allof_class in self._composed_schemas['allOf']: + + try: + if constant_args.get('_spec_property_naming'): + allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) + else: + allof_instance = allof_class(**model_args, **constant_args) + composed_instances.append(allof_instance) + except Exception as ex: + raise ApiValueError( + "Invalid inputs given to generate an instance of '%s'. The " + "input data was invalid for the allOf schema '%s' in the composed " + "schema '%s'. Error=%s" % ( + allof_class.__name__, + allof_class.__name__, + self.__class__.__name__, + str(ex) + ) + ) from ex + return composed_instances + + +def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): + """ + Find the oneOf schema that matches the input data (e.g. payload). + If exactly one schema matches the input data, an instance of that schema + is returned. + If zero or more than one schema match the input data, an exception is raised. + In OAS 3.x, the payload MUST, by validation, match exactly one of the + schemas described by oneOf. + + Args: + cls: the class we are handling + model_kwargs (dict): var_name to var_value + The input data, e.g. the payload that must match a oneOf schema + in the OpenAPI document. + constant_kwargs (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Kwargs: + model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): + the value to assign to a primitive class or ModelSimple class + Notes: + - this is only passed in when oneOf includes types which are not object + - None is used to suppress handling of model_arg, nullable models are handled in __new__ + + Returns + oneof_instance (instance) + """ + if len(cls._composed_schemas['oneOf']) == 0: + return None + + oneof_instances = [] + # Iterate over each oneOf schema and determine if the input data + # matches the oneOf schemas. + for oneof_class in cls._composed_schemas['oneOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if oneof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + single_value_input = allows_single_value_input(oneof_class) + + try: + if not single_value_input: + if constant_kwargs.get('_spec_property_naming'): + oneof_instance = oneof_class._from_openapi_data( + **model_kwargs, **constant_kwargs) + else: + oneof_instance = oneof_class(**model_kwargs, **constant_kwargs) + else: + if issubclass(oneof_class, ModelSimple): + if constant_kwargs.get('_spec_property_naming'): + oneof_instance = oneof_class._from_openapi_data( + model_arg, **constant_kwargs) + else: + oneof_instance = oneof_class(model_arg, **constant_kwargs) + elif oneof_class in PRIMITIVE_TYPES: + oneof_instance = validate_and_convert_types( + model_arg, + (oneof_class,), + constant_kwargs['_path_to_item'], + constant_kwargs['_spec_property_naming'], + constant_kwargs['_check_type'], + configuration=constant_kwargs['_configuration'] + ) + oneof_instances.append(oneof_instance) + except Exception: + pass + if len(oneof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None " + "of the oneOf schemas matched the input data." % + cls.__name__ + ) + elif len(oneof_instances) > 1: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. Multiple " + "oneOf schemas matched the inputs, but a max of one is allowed." % + cls.__name__ + ) + return oneof_instances[0] + + +def get_anyof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + The input data, e.g. the payload that must match at least one + anyOf child schema in the OpenAPI document. + constant_args (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Returns + anyof_instances (list) + """ + anyof_instances = [] + if len(self._composed_schemas['anyOf']) == 0: + return anyof_instances + + for anyof_class in self._composed_schemas['anyOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if anyof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + try: + if constant_args.get('_spec_property_naming'): + anyof_instance = anyof_class._from_openapi_data(**model_args, **constant_args) + else: + anyof_instance = anyof_class(**model_args, **constant_args) + anyof_instances.append(anyof_instance) + except Exception: + pass + if len(anyof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None of the " + "anyOf schemas matched the inputs." % + self.__class__.__name__ + ) + return anyof_instances + + +def get_discarded_args(self, composed_instances, model_args): + """ + Gathers the args that were discarded by configuration.discard_unknown_keys + """ + model_arg_keys = model_args.keys() + discarded_args = set() + # arguments passed to self were already converted to python names + # before __init__ was called + for instance in composed_instances: + if instance.__class__ in self._composed_schemas['allOf']: + try: + keys = instance.to_dict().keys() + discarded_keys = model_args - keys + discarded_args.update(discarded_keys) + except Exception: + # allOf integer schema will throw exception + pass + else: + try: + all_keys = set(model_to_dict(instance, serialize=False).keys()) + js_keys = model_to_dict(instance, serialize=True).keys() + all_keys.update(js_keys) + discarded_keys = model_arg_keys - all_keys + discarded_args.update(discarded_keys) + except Exception: + # allOf integer schema will throw exception + pass + return discarded_args + + +def validate_get_composed_info(constant_args, model_args, self): + """ + For composed schemas, generate schema instances for + all schemas in the oneOf/anyOf/allOf definition. If additional + properties are allowed, also assign those properties on + all matched schemas that contain additionalProperties. + Openapi schemas are python classes. + + Exceptions are raised if: + - 0 or > 1 oneOf schema matches the model_args input data + - no anyOf schema matches the model_args input data + - any of the allOf schemas do not match the model_args input data + + Args: + constant_args (dict): these are the args that every model requires + model_args (dict): these are the required and optional spec args that + were passed in to make this model + self (class): the class that we are instantiating + This class contains self._composed_schemas + + Returns: + composed_info (list): length three + composed_instances (list): the composed instances which are not + self + var_name_to_model_instances (dict): a dict going from var_name + to the model_instance which holds that var_name + the model_instance may be self or an instance of one of the + classes in self.composed_instances() + additional_properties_model_instances (list): a list of the + model instances which have the property + additional_properties_type. This list can include self + """ + # create composed_instances + composed_instances = [] + allof_instances = get_allof_instances(self, model_args, constant_args) + composed_instances.extend(allof_instances) + oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) + if oneof_instance is not None: + composed_instances.append(oneof_instance) + anyof_instances = get_anyof_instances(self, model_args, constant_args) + composed_instances.extend(anyof_instances) + """ + set additional_properties_model_instances + additional properties must be evaluated at the schema level + so self's additional properties are most important + If self is a composed schema with: + - no properties defined in self + - additionalProperties: False + Then for object payloads every property is an additional property + and they are not allowed, so only empty dict is allowed + + Properties must be set on all matching schemas + so when a property is assigned toa composed instance, it must be set on all + composed instances regardless of additionalProperties presence + keeping it to prevent breaking changes in v5.0.1 + TODO remove cls._additional_properties_model_instances in 6.0.0 + """ + additional_properties_model_instances = [] + if self.additional_properties_type is not None: + additional_properties_model_instances = [self] + + """ + no need to set properties on self in here, they will be set in __init__ + By here all composed schema oneOf/anyOf/allOf instances have their properties set using + model_args + """ + discarded_args = get_discarded_args(self, composed_instances, model_args) + + # map variable names to composed_instances + var_name_to_model_instances = {} + for prop_name in model_args: + if prop_name not in discarded_args: + var_name_to_model_instances[prop_name] = [self] + list( + filter( + lambda x: prop_name in x.openapi_types, composed_instances)) + + return [ + composed_instances, + var_name_to_model_instances, + additional_properties_model_instances, + discarded_args + ] diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/models/__init__.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/models/__init__.py new file mode 100644 index 00000000..080746bf --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/models/__init__.py @@ -0,0 +1,238 @@ +# flake8: noqa + +# import all models into this package +# if you have many models here with many references from one model to another this may +# raise a RecursionError +# to avoid this, import only the models that you directly need like: +# from criteo_api_retailmedia_v2024_04.model.pet import Pet +# or import this package, but before doing it, use: +# import sys +# sys.setrecursionlimit(n) + +from criteo_api_retailmedia_v2024_04.model.add_funds_to_balance_request import AddFundsToBalanceRequest +from criteo_api_retailmedia_v2024_04.model.add_remove_keyword_model import AddRemoveKeywordModel +from criteo_api_retailmedia_v2024_04.model.add_remove_keywords_model import AddRemoveKeywordsModel +from criteo_api_retailmedia_v2024_04.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_v2024_04.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource +from criteo_api_retailmedia_v2024_04.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_request import AddToBasketTarget202110Request +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_response import AddToBasketTarget202110Response +from criteo_api_retailmedia_v2024_04.model.application_summary_model import ApplicationSummaryModel +from criteo_api_retailmedia_v2024_04.model.application_summary_model_resource import ApplicationSummaryModelResource +from criteo_api_retailmedia_v2024_04.model.application_summary_model_response import ApplicationSummaryModelResponse +from criteo_api_retailmedia_v2024_04.model.approval_status_model import ApprovalStatusModel +from criteo_api_retailmedia_v2024_04.model.asset import Asset +from criteo_api_retailmedia_v2024_04.model.asset_resource import AssetResource +from criteo_api_retailmedia_v2024_04.model.asset_response import AssetResponse +from criteo_api_retailmedia_v2024_04.model.async_campaigns_report import AsyncCampaignsReport +from criteo_api_retailmedia_v2024_04.model.async_campaigns_report_request import AsyncCampaignsReportRequest +from criteo_api_retailmedia_v2024_04.model.async_campaigns_report_resource import AsyncCampaignsReportResource +from criteo_api_retailmedia_v2024_04.model.async_line_items_report import AsyncLineItemsReport +from criteo_api_retailmedia_v2024_04.model.async_line_items_report_request import AsyncLineItemsReportRequest +from criteo_api_retailmedia_v2024_04.model.async_line_items_report_resource import AsyncLineItemsReportResource +from criteo_api_retailmedia_v2024_04.model.async_report_response import AsyncReportResponse +from criteo_api_retailmedia_v2024_04.model.async_revenue_report import AsyncRevenueReport +from criteo_api_retailmedia_v2024_04.model.async_revenue_report_request import AsyncRevenueReportRequest +from criteo_api_retailmedia_v2024_04.model.async_revenue_report_resource import AsyncRevenueReportResource +from criteo_api_retailmedia_v2024_04.model.auction_line_item_create_model_request import AuctionLineItemCreateModelRequest +from criteo_api_retailmedia_v2024_04.model.auction_line_item_paged_list_response import AuctionLineItemPagedListResponse +from criteo_api_retailmedia_v2024_04.model.auction_line_item_response import AuctionLineItemResponse +from criteo_api_retailmedia_v2024_04.model.auction_line_item_update_model_request import AuctionLineItemUpdateModelRequest +from criteo_api_retailmedia_v2024_04.model.audience_ids_update_model202110_request import AudienceIdsUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.audience_target202110_request import AudienceTarget202110Request +from criteo_api_retailmedia_v2024_04.model.audience_target202110_response import AudienceTarget202110Response +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_list_request import BalanceCampaign202110ListRequest +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse +from criteo_api_retailmedia_v2024_04.model.balance_response_paged_list_response import BalanceResponsePagedListResponse +from criteo_api_retailmedia_v2024_04.model.campaign_attributes_v202301 import CampaignAttributesV202301 +from criteo_api_retailmedia_v2024_04.model.campaign_budget_overrides import CampaignBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.campaign_daily_budget_override import CampaignDailyBudgetOverride +from criteo_api_retailmedia_v2024_04.model.campaign_monthly_budget_override import CampaignMonthlyBudgetOverride +from criteo_api_retailmedia_v2024_04.model.campaign_v202301 import CampaignV202301 +from criteo_api_retailmedia_v2024_04.model.category202204 import Category202204 +from criteo_api_retailmedia_v2024_04.model.category202204_list_response import Category202204ListResponse +from criteo_api_retailmedia_v2024_04.model.change_dates_of_balance_request import ChangeDatesOfBalanceRequest +from criteo_api_retailmedia_v2024_04.model.change_details import ChangeDetails +from criteo_api_retailmedia_v2024_04.model.choice_option import ChoiceOption +from criteo_api_retailmedia_v2024_04.model.choice_variable_specification import ChoiceVariableSpecification +from criteo_api_retailmedia_v2024_04.model.choice_variable_value import ChoiceVariableValue +from criteo_api_retailmedia_v2024_04.model.color_variable_value import ColorVariableValue +from criteo_api_retailmedia_v2024_04.model.common_error import CommonError +from criteo_api_retailmedia_v2024_04.model.common_line_item_paged_list_response import CommonLineItemPagedListResponse +from criteo_api_retailmedia_v2024_04.model.common_line_item_response import CommonLineItemResponse +from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem +from criteo_api_retailmedia_v2024_04.model.common_warning import CommonWarning +from criteo_api_retailmedia_v2024_04.model.create_balance_request import CreateBalanceRequest +from criteo_api_retailmedia_v2024_04.model.creative202110 import Creative202110 +from criteo_api_retailmedia_v2024_04.model.creative202110_list_response import Creative202110ListResponse +from criteo_api_retailmedia_v2024_04.model.creative202210 import Creative202210 +from criteo_api_retailmedia_v2024_04.model.creative202210_list_response import Creative202210ListResponse +from criteo_api_retailmedia_v2024_04.model.creative202210_response import Creative202210Response +from criteo_api_retailmedia_v2024_04.model.creative_create_model202207 import CreativeCreateModel202207 +from criteo_api_retailmedia_v2024_04.model.creative_update_model202207 import CreativeUpdateModel202207 +from criteo_api_retailmedia_v2024_04.model.daily_line_item_budget_override import DailyLineItemBudgetOverride +from criteo_api_retailmedia_v2024_04.model.editable_campaign_attributes_v202301 import EditableCampaignAttributesV202301 +from criteo_api_retailmedia_v2024_04.model.external_account import ExternalAccount +from criteo_api_retailmedia_v2024_04.model.external_add_funds_to_balance import ExternalAddFundsToBalance +from criteo_api_retailmedia_v2024_04.model.external_add_to_basket_ids_update_model202110 import ExternalAddToBasketIdsUpdateModel202110 +from criteo_api_retailmedia_v2024_04.model.external_add_to_basket_target202110 import ExternalAddToBasketTarget202110 +from criteo_api_retailmedia_v2024_04.model.external_auction_line_item import ExternalAuctionLineItem +from criteo_api_retailmedia_v2024_04.model.external_auction_line_item_create_model import ExternalAuctionLineItemCreateModel +from criteo_api_retailmedia_v2024_04.model.external_auction_line_item_update_model import ExternalAuctionLineItemUpdateModel +from criteo_api_retailmedia_v2024_04.model.external_audience_ids_update_model202110 import ExternalAudienceIdsUpdateModel202110 +from criteo_api_retailmedia_v2024_04.model.external_audience_target202110 import ExternalAudienceTarget202110 +from criteo_api_retailmedia_v2024_04.model.external_balance_response import ExternalBalanceResponse +from criteo_api_retailmedia_v2024_04.model.external_brand import ExternalBrand +from criteo_api_retailmedia_v2024_04.model.external_catalog_request import ExternalCatalogRequest +from criteo_api_retailmedia_v2024_04.model.external_catalog_status import ExternalCatalogStatus +from criteo_api_retailmedia_v2024_04.model.external_change_dates_of_balance import ExternalChangeDatesOfBalance +from criteo_api_retailmedia_v2024_04.model.external_common_line_item import ExternalCommonLineItem +from criteo_api_retailmedia_v2024_04.model.external_create_balance import ExternalCreateBalance +from criteo_api_retailmedia_v2024_04.model.external_keyword_target202110 import ExternalKeywordTarget202110 +from criteo_api_retailmedia_v2024_04.model.external_line_item_capping202110 import ExternalLineItemCapping202110 +from criteo_api_retailmedia_v2024_04.model.external_line_item_page202110 import ExternalLineItemPage202110 +from criteo_api_retailmedia_v2024_04.model.external_line_item_page_category202110 import ExternalLineItemPageCategory202110 +from criteo_api_retailmedia_v2024_04.model.external_preferred_line_item202110 import ExternalPreferredLineItem202110 +from criteo_api_retailmedia_v2024_04.model.external_preferred_line_item_create_model202110 import ExternalPreferredLineItemCreateModel202110 +from criteo_api_retailmedia_v2024_04.model.external_preferred_line_item_update_model202110 import ExternalPreferredLineItemUpdateModel202110 +from criteo_api_retailmedia_v2024_04.model.external_promoted_product202110 import ExternalPromotedProduct202110 +from criteo_api_retailmedia_v2024_04.model.external_retailer import ExternalRetailer +from criteo_api_retailmedia_v2024_04.model.external_retailer_pages202110 import ExternalRetailerPages202110 +from criteo_api_retailmedia_v2024_04.model.external_store_ids_update_model202110 import ExternalStoreIdsUpdateModel202110 +from criteo_api_retailmedia_v2024_04.model.external_store_target202110 import ExternalStoreTarget202110 +from criteo_api_retailmedia_v2024_04.model.external_update_balance_model import ExternalUpdateBalanceModel +from criteo_api_retailmedia_v2024_04.model.files_variable_value import FilesVariableValue +from criteo_api_retailmedia_v2024_04.model.files_variables_specification import FilesVariablesSpecification +from criteo_api_retailmedia_v2024_04.model.hyperlink_variable_value import HyperlinkVariableValue +from criteo_api_retailmedia_v2024_04.model.input_keywords_model import InputKeywordsModel +from criteo_api_retailmedia_v2024_04.model.input_resource_of_auction_line_item_create_model import InputResourceOfAuctionLineItemCreateModel +from criteo_api_retailmedia_v2024_04.model.input_resource_of_preferred_line_item_create_model202110 import InputResourceOfPreferredLineItemCreateModel202110 +from criteo_api_retailmedia_v2024_04.model.insertion_order_history_change_data_capture import InsertionOrderHistoryChangeDataCapture +from criteo_api_retailmedia_v2024_04.model.json_api_body_with_external_id_of_editable_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_account_and_account import JsonApiBodyWithIdOfInt64AndAccountAndAccount +from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_brand_and_brand import JsonApiBodyWithIdOfInt64AndBrandAndBrand +from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_campaign_v202301_and_campaign_v202301 import JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status import JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus +from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers import JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers +from criteo_api_retailmedia_v2024_04.model.json_api_body_with_id_of_int64_and_retailer_and_retailer import JsonApiBodyWithIdOfInt64AndRetailerAndRetailer +from criteo_api_retailmedia_v2024_04.model.json_api_body_without_id_of_campaign_attributes_v202301_and_campaign_v202301 import JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.json_api_body_without_id_of_catalog_request_and_catalog_request import JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_campaign_v202301 import JsonApiPageResponseOfCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer +from criteo_api_retailmedia_v2024_04.model.json_api_request_of_catalog_request import JsonApiRequestOfCatalogRequest +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers +from criteo_api_retailmedia_v2024_04.model.keyword_data_model import KeywordDataModel +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_request import KeywordTarget202110Request +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_response import KeywordTarget202110Response +from criteo_api_retailmedia_v2024_04.model.keywords_model import KeywordsModel +from criteo_api_retailmedia_v2024_04.model.keywords_model_resource import KeywordsModelResource +from criteo_api_retailmedia_v2024_04.model.keywords_model_response import KeywordsModelResponse +from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers import LineItemBidMultipliers +from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest +from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse +from criteo_api_retailmedia_v2024_04.model.line_item_budget_overrides import LineItemBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.match_type_model import MatchTypeModel +from criteo_api_retailmedia_v2024_04.model.metadata import Metadata +from criteo_api_retailmedia_v2024_04.model.monthly_line_item_budeget_override import MonthlyLineItemBudegetOverride +from criteo_api_retailmedia_v2024_04.model.negotiation_state_model import NegotiationStateModel +from criteo_api_retailmedia_v2024_04.model.page_metadata import PageMetadata +from criteo_api_retailmedia_v2024_04.model.page_of_insertion_order_history_change_data_capture import PageOfInsertionOrderHistoryChangeDataCapture +from criteo_api_retailmedia_v2024_04.model.page_type_environment import PageTypeEnvironment +from criteo_api_retailmedia_v2024_04.model.post_campaign_v202301 import PostCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.preferred_line_item202110_paged_list_response import PreferredLineItem202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.preferred_line_item202110_response import PreferredLineItem202110Response +from criteo_api_retailmedia_v2024_04.model.preferred_line_item_create_model202110_request import PreferredLineItemCreateModel202110Request +from criteo_api_retailmedia_v2024_04.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.problem_details import ProblemDetails +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.proposal_status_model import ProposalStatusModel +from criteo_api_retailmedia_v2024_04.model.proposal_status_model_resource import ProposalStatusModelResource +from criteo_api_retailmedia_v2024_04.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_v2024_04.model.put_campaign_v202301 import PutCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.report_outcome import ReportOutcome +from criteo_api_retailmedia_v2024_04.model.resource_of_add_funds_to_balance import ResourceOfAddFundsToBalance +from criteo_api_retailmedia_v2024_04.model.resource_of_auction_line_item import ResourceOfAuctionLineItem +from criteo_api_retailmedia_v2024_04.model.resource_of_auction_line_item_update_model import ResourceOfAuctionLineItemUpdateModel +from criteo_api_retailmedia_v2024_04.model.resource_of_balance_campaign202110 import ResourceOfBalanceCampaign202110 +from criteo_api_retailmedia_v2024_04.model.resource_of_balance_response import ResourceOfBalanceResponse +from criteo_api_retailmedia_v2024_04.model.resource_of_category202204 import ResourceOfCategory202204 +from criteo_api_retailmedia_v2024_04.model.resource_of_change_dates_of_balance import ResourceOfChangeDatesOfBalance +from criteo_api_retailmedia_v2024_04.model.resource_of_common_line_item import ResourceOfCommonLineItem +from criteo_api_retailmedia_v2024_04.model.resource_of_create_balance import ResourceOfCreateBalance +from criteo_api_retailmedia_v2024_04.model.resource_of_creative202110 import ResourceOfCreative202110 +from criteo_api_retailmedia_v2024_04.model.resource_of_creative202210 import ResourceOfCreative202210 +from criteo_api_retailmedia_v2024_04.model.resource_of_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers +from criteo_api_retailmedia_v2024_04.model.resource_of_preferred_line_item202110 import ResourceOfPreferredLineItem202110 +from criteo_api_retailmedia_v2024_04.model.resource_of_preferred_line_item_update_model202110 import ResourceOfPreferredLineItemUpdateModel202110 +from criteo_api_retailmedia_v2024_04.model.resource_of_promoted_product202110 import ResourceOfPromotedProduct202110 +from criteo_api_retailmedia_v2024_04.model.resource_of_retail_media_account import ResourceOfRetailMediaAccount +from criteo_api_retailmedia_v2024_04.model.resource_of_template import ResourceOfTemplate +from criteo_api_retailmedia_v2024_04.model.resource_of_update_balance_model import ResourceOfUpdateBalanceModel +from criteo_api_retailmedia_v2024_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2024_04.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount +from criteo_api_retailmedia_v2024_04.model.retail_media_account import RetailMediaAccount +from criteo_api_retailmedia_v2024_04.model.retail_media_brand_account_creation import RetailMediaBrandAccountCreation +from criteo_api_retailmedia_v2024_04.model.retail_media_brands import RetailMediaBrands +from criteo_api_retailmedia_v2024_04.model.review_state_model import ReviewStateModel +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v1_resource import RmLegacyAudienceCreateEntityV1Resource +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v2 import RmLegacyAudienceCreateEntityV2 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v2_resource import RmLegacyAudienceCreateEntityV2Resource +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v2_response import RmLegacyAudienceCreateEntityV2Response +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_input_entity_v1 import RmLegacyAudienceCreateInputEntityV1 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_input_entity_v2 import RmLegacyAudienceCreateInputEntityV2 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v1 import RmLegacyAudienceGetEntityV1 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v1_resource import RmLegacyAudienceGetEntityV1Resource +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v2 import RmLegacyAudienceGetEntityV2 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v2_resource import RmLegacyAudienceGetEntityV2Resource +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_user_behavior_create_v2 import RmLegacyAudienceUserBehaviorCreateV2 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_user_behavior_details_v2 import RmLegacyAudienceUserBehaviorDetailsV2 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList +from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1 +from criteo_api_retailmedia_v2024_04.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2 +from criteo_api_retailmedia_v2024_04.model.rmca_common_problem import RmcaCommonProblem +from criteo_api_retailmedia_v2024_04.model.section import Section +from criteo_api_retailmedia_v2024_04.model.set_bid_model import SetBidModel +from criteo_api_retailmedia_v2024_04.model.set_bids_model import SetBidsModel +from criteo_api_retailmedia_v2024_04.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2024_04.model.set_bids_model_resource import SetBidsModelResource +from criteo_api_retailmedia_v2024_04.model.status_response import StatusResponse +from criteo_api_retailmedia_v2024_04.model.status_response_resource import StatusResponseResource +from criteo_api_retailmedia_v2024_04.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.store_target202110_request import StoreTarget202110Request +from criteo_api_retailmedia_v2024_04.model.store_target202110_response import StoreTarget202110Response +from criteo_api_retailmedia_v2024_04.model.template import Template +from criteo_api_retailmedia_v2024_04.model.template_list_response import TemplateListResponse +from criteo_api_retailmedia_v2024_04.model.template_response import TemplateResponse +from criteo_api_retailmedia_v2024_04.model.template_variable import TemplateVariable +from criteo_api_retailmedia_v2024_04.model.template_variable_value import TemplateVariableValue +from criteo_api_retailmedia_v2024_04.model.text_variable_specification import TextVariableSpecification +from criteo_api_retailmedia_v2024_04.model.text_variable_value import TextVariableValue +from criteo_api_retailmedia_v2024_04.model.update_balance_model_request import UpdateBalanceModelRequest +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_campaign_budget_overrides import ValueResourceInputOfCampaignBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_line_item_budget_overrides import ValueResourceInputOfLineItemBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_retail_media_brand_account_creation import ValueResourceInputOfRetailMediaBrandAccountCreation +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands +from criteo_api_retailmedia_v2024_04.model.value_resource_of_campaign_budget_overrides import ValueResourceOfCampaignBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_of_line_item_budget_overrides import ValueResourceOfLineItemBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_of_retail_media_brand_account_creation import ValueResourceOfRetailMediaBrandAccountCreation +from criteo_api_retailmedia_v2024_04.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands +from criteo_api_retailmedia_v2024_04.model.value_resource_outcome_of_campaign_budget_overrides import ValueResourceOutcomeOfCampaignBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_outcome_of_line_item_budget_overrides import ValueResourceOutcomeOfLineItemBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_add_to_basket_ids_update_model202110 import ValueTypeResourceOfAddToBasketIdsUpdateModel202110 +from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_add_to_basket_target202110 import ValueTypeResourceOfAddToBasketTarget202110 +from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_audience_ids_update_model202110 import ValueTypeResourceOfAudienceIdsUpdateModel202110 +from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_audience_target202110 import ValueTypeResourceOfAudienceTarget202110 +from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_keyword_target202110 import ValueTypeResourceOfKeywordTarget202110 +from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_store_ids_update_model202110 import ValueTypeResourceOfStoreIdsUpdateModel202110 +from criteo_api_retailmedia_v2024_04.model.value_type_resource_of_store_target202110 import ValueTypeResourceOfStoreTarget202110 diff --git a/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/rest.py b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/rest.py new file mode 100644 index 00000000..932409e6 --- /dev/null +++ b/sdks/retailmedia_2024-04/criteo_api_retailmedia_v2024_04/rest.py @@ -0,0 +1,352 @@ +""" + Criteo API + + Criteo API - RetailMedia # noqa: E501 + + The version of the OpenAPI document: 2024-04 + Generated by: https://openapi-generator.tech +""" + + +import io +import json +import logging +import re +import ssl +from urllib.parse import urlencode +from urllib.parse import urlparse +from urllib.request import proxy_bypass_environment +import urllib3 +import ipaddress + +from criteo_api_retailmedia_v2024_04.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError + + +logger = logging.getLogger(__name__) + + +class RESTResponse(io.IOBase): + + def __init__(self, resp): + self.urllib3_response = resp + self.status = resp.status + self.reason = resp.reason + self.data = resp.data + + def getheaders(self): + """Returns a dictionary of the response headers.""" + return self.urllib3_response.getheaders() + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.urllib3_response.getheader(name, default) + + +class RESTClientObject(object): + + def __init__(self, configuration, pools_size=4, maxsize=None): + # urllib3.PoolManager will pass all kw parameters to connectionpool + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 + + # cert_reqs + if configuration.verify_ssl: + cert_reqs = ssl.CERT_REQUIRED + else: + cert_reqs = ssl.CERT_NONE + + addition_pool_args = {} + if configuration.assert_hostname is not None: + addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 + + if configuration.retries is not None: + addition_pool_args['retries'] = configuration.retries + + if configuration.socket_options is not None: + addition_pool_args['socket_options'] = configuration.socket_options + + if maxsize is None: + if configuration.connection_pool_maxsize is not None: + maxsize = configuration.connection_pool_maxsize + else: + maxsize = 4 + + # https pool manager + if configuration.proxy and not should_bypass_proxies( + configuration.host, no_proxy=configuration.no_proxy or ''): + self.pool_manager = urllib3.ProxyManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + proxy_url=configuration.proxy, + proxy_headers=configuration.proxy_headers, + **addition_pool_args + ) + else: + self.pool_manager = urllib3.PoolManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + **addition_pool_args + ) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + """Perform requests. + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: 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. + """ + method = method.upper() + assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', + 'PATCH', 'OPTIONS'] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + post_params = post_params or {} + headers = headers or {} + + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 + timeout = urllib3.Timeout(total=_request_timeout) + elif (isinstance(_request_timeout, tuple) and + len(_request_timeout) == 2): + timeout = urllib3.Timeout( + connect=_request_timeout[0], read=_request_timeout[1]) + + try: + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + # Only set a default Content-Type for POST, PUT, PATCH and OPTIONS requests + if (method != 'DELETE') and ('Content-Type' not in headers): + headers['Content-Type'] = 'application/json' + if query_params: + url += '?' + urlencode(query_params) + if ('Content-Type' not in headers) or (re.search('json', + headers['Content-Type'], re.IGNORECASE)): + request_body = None + if body is not None: + request_body = json.dumps(body) + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=False, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. + del headers['Content-Type'] + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=True, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + # Pass a `string` parameter directly in the body to support + # other content types than Json when `body` argument is + # provided in serialized form + elif isinstance(body, str) or isinstance(body, bytes): + request_body = body + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + # For `GET`, `HEAD` + else: + r = self.pool_manager.request(method, url, + fields=query_params, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + except urllib3.exceptions.SSLError as e: + msg = "{0}\n{1}".format(type(e).__name__, str(e)) + raise ApiException(status=0, reason=msg) + + if _preload_content: + r = RESTResponse(r) + + # log response body + logger.debug("response body: %s", r.data) + + if not 200 <= r.status <= 299: + if r.status == 401: + raise UnauthorizedException(http_resp=r) + + if r.status == 403: + raise ForbiddenException(http_resp=r) + + if r.status == 404: + raise NotFoundException(http_resp=r) + + if 500 <= r.status <= 599: + raise ServiceException(http_resp=r) + + raise ApiException(http_resp=r) + + return r + + def GET(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("GET", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def HEAD(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("HEAD", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def OPTIONS(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("OPTIONS", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def DELETE(self, url, headers=None, query_params=None, body=None, + _preload_content=True, _request_timeout=None): + return self.request("DELETE", url, + headers=headers, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def POST(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("POST", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PUT(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PUT", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PATCH(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PATCH", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + +# end of class RESTClientObject + + +def is_ipv4(target): + """ Test if IPv4 address or not + """ + try: + chk = ipaddress.IPv4Address(target) + return True + except ipaddress.AddressValueError: + return False + + +def in_ipv4net(target, net): + """ Test if target belongs to given IPv4 network + """ + try: + nw = ipaddress.IPv4Network(net) + ip = ipaddress.IPv4Address(target) + if ip in nw: + return True + return False + except ipaddress.AddressValueError: + return False + except ipaddress.NetmaskValueError: + return False + + +def should_bypass_proxies(url, no_proxy=None): + """ Yet another requests.should_bypass_proxies + Test if proxies should not be used for a particular url. + """ + + parsed = urlparse(url) + + # special cases + if parsed.hostname in [None, '']: + return True + + # special cases + if no_proxy in [None, '']: + return False + if no_proxy == '*': + return True + + no_proxy = no_proxy.lower().replace(' ', ''); + entries = ( + host for host in no_proxy.split(',') if host + ) + + if is_ipv4(parsed.hostname): + for item in entries: + if in_ipv4net(parsed.hostname, item): + return True + return proxy_bypass_environment(parsed.hostname, {'no': no_proxy}) diff --git a/sdks/retailmedia_2024-04/docs/AccountsApi.md b/sdks/retailmedia_2024-04/docs/AccountsApi.md new file mode 100644 index 00000000..a40e8dc1 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AccountsApi.md @@ -0,0 +1,325 @@ +# criteo_api_retailmedia_v2024_04.AccountsApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_brands**](AccountsApi.md#add_brands) | **POST** /2024-04/retail-media/account-management/accounts/{accountId}/brands/add | +[**create_private_market_demand_brand_account**](AccountsApi.md#create_private_market_demand_brand_account) | **POST** /2024-04/retail-media/account-management/accounts/{accountId}/create-brand-account | +[**remove_brands**](AccountsApi.md#remove_brands) | **POST** /2024-04/retail-media/account-management/accounts/{accountId}/brands/remove | + + +# **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_v2024_04 +from criteo_api_retailmedia_v2024_04.api import accounts_api +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands +from criteo_api_retailmedia_v2024_04.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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_v2024_04.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_v2024_04.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) + + + +Creates a new child Demand Brand Account for the provided parent private market account + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import accounts_api +from criteo_api_retailmedia_v2024_04.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount +from criteo_api_retailmedia_v2024_04.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. +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 + 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: + api_response = api_instance.create_private_market_demand_brand_account(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AccountsApi->create_private_market_demand_brand_account: %s\n" % e) + + # 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, 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_v2024_04.ApiException as e: + print("Exception when calling AccountsApi->create_private_market_demand_brand_account: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| Account Id for the parent private market account | + **value_resource_input_of_retail_media_brand_account_creation** | [**ValueResourceInputOfRetailMediaBrandAccountCreation**](ValueResourceInputOfRetailMediaBrandAccountCreation.md)| Initial creation and configuration options for the new account | [optional] + +### Return type + +[**ResourceOutcomeOfRetailMediaAccount**](ResourceOutcomeOfRetailMediaAccount.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 | +|-------------|-------------|------------------| +**201** | 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) + +# **remove_brands** +> ValueResourceOfRetailMediaBrands remove_brands(account_id) + + + +Remove a brand from an account + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import accounts_api +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands +from criteo_api_retailmedia_v2024_04.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.remove_brands(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as 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.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_v2024_04.ApiException as e: + print("Exception when calling AccountsApi->remove_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)| | [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) + diff --git a/sdks/retailmedia_2024-04/docs/AddFundsToBalanceRequest.md b/sdks/retailmedia_2024-04/docs/AddFundsToBalanceRequest.md new file mode 100644 index 00000000..d9b8210c --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AddFundsToBalanceRequest.md @@ -0,0 +1,13 @@ +# AddFundsToBalanceRequest + +Data model for an input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfAddFundsToBalance**](ResourceOfAddFundsToBalance.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_2024-04/docs/AddRemoveKeywordModel.md b/sdks/retailmedia_2024-04/docs/AddRemoveKeywordModel.md new file mode 100644 index 00000000..8546f1f2 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AddRemoveKeywordModel.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordModel + +A single keyword to be added or removed + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**is_deleted** | **bool, 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_2024-04/docs/AddRemoveKeywordsModel.md b/sdks/retailmedia_2024-04/docs/AddRemoveKeywordsModel.md new file mode 100644 index 00000000..27980d2b --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AddRemoveKeywordsModel.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModel + +Data model containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[AddRemoveKeywordModel], none_type**](AddRemoveKeywordModel.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_2024-04/docs/AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_2024-04/docs/AddRemoveKeywordsModelRequest.md new file mode 100644 index 00000000..577c720e --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AddRemoveKeywordsModelRequest.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModelRequest + +Request object to add or remove keywords from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AddRemoveKeywordsModelResource**](AddRemoveKeywordsModelResource.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_2024-04/docs/AddRemoveKeywordsModelResource.md b/sdks/retailmedia_2024-04/docs/AddRemoveKeywordsModelResource.md new file mode 100644 index 00000000..ad36e151 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AddRemoveKeywordsModelResource.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordsModelResource + +Resource object containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**AddRemoveKeywordsModel**](AddRemoveKeywordsModel.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_2023-01/docs/AddToBasketIdsUpdateModel202110Request.md b/sdks/retailmedia_2024-04/docs/AddToBasketIdsUpdateModel202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AddToBasketIdsUpdateModel202110Request.md rename to sdks/retailmedia_2024-04/docs/AddToBasketIdsUpdateModel202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/AddToBasketTarget202110Request.md b/sdks/retailmedia_2024-04/docs/AddToBasketTarget202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AddToBasketTarget202110Request.md rename to sdks/retailmedia_2024-04/docs/AddToBasketTarget202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/AddToBasketTarget202110Response.md b/sdks/retailmedia_2024-04/docs/AddToBasketTarget202110Response.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AddToBasketTarget202110Response.md rename to sdks/retailmedia_2024-04/docs/AddToBasketTarget202110Response.md diff --git a/sdks/retailmedia_2024-04/docs/AnalyticsApi.md b/sdks/retailmedia_2024-04/docs/AnalyticsApi.md new file mode 100644 index 00000000..460abf1f --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AnalyticsApi.md @@ -0,0 +1,531 @@ +# criteo_api_retailmedia_v2024_04.AnalyticsApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**generate_async_campaigns_report**](AnalyticsApi.md#generate_async_campaigns_report) | **POST** /2024-04/retail-media/reports/campaigns | +[**generate_async_line_items_report**](AnalyticsApi.md#generate_async_line_items_report) | **POST** /2024-04/retail-media/reports/line-items | +[**generate_async_revenue_report**](AnalyticsApi.md#generate_async_revenue_report) | **POST** /2024-04/retail-media/reports/revenue | +[**get_async_export_output**](AnalyticsApi.md#get_async_export_output) | **GET** /2024-04/retail-media/reports/{reportId}/output | +[**get_async_export_status**](AnalyticsApi.md#get_async_export_status) | **GET** /2024-04/retail-media/reports/{reportId}/status | + + +# **generate_async_campaigns_report** +> AsyncReportResponse generate_async_campaigns_report(async_campaigns_report_request) + + + +Return an asynchronous Campaigns Report + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import analytics_api +from criteo_api_retailmedia_v2024_04.model.async_report_response import AsyncReportResponse +from criteo_api_retailmedia_v2024_04.model.async_campaigns_report_request import AsyncCampaignsReportRequest +from criteo_api_retailmedia_v2024_04.model.report_outcome import ReportOutcome +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + async_campaigns_report_request = AsyncCampaignsReportRequest( + data=AsyncCampaignsReportResource( + type="type_example", + attributes=AsyncCampaignsReport( + ids=[ + "ids_example", + ], + id="id_example", + campaign_type="all", + sales_channel="all", + format="json-compact", + report_type="summary", + 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", + ), + ), + ) # AsyncCampaignsReportRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_async_campaigns_report(async_campaigns_report_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->generate_async_campaigns_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **async_campaigns_report_request** | [**AsyncCampaignsReportRequest**](AsyncCampaignsReportRequest.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_line_items_report** +> AsyncReportResponse generate_async_line_items_report(async_line_items_report_request) + + + +Returns an asynchronous Line Items Report + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import analytics_api +from criteo_api_retailmedia_v2024_04.model.async_line_items_report_request import AsyncLineItemsReportRequest +from criteo_api_retailmedia_v2024_04.model.async_report_response import AsyncReportResponse +from criteo_api_retailmedia_v2024_04.model.report_outcome import ReportOutcome +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + async_line_items_report_request = AsyncLineItemsReportRequest( + data=AsyncLineItemsReportResource( + type="type_example", + attributes=AsyncLineItemsReport( + ids=[ + "ids_example", + ], + id="id_example", + campaign_type="all", + sales_channel="all", + format="json-compact", + report_type="summary", + 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", + ), + ), + ) # AsyncLineItemsReportRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_async_line_items_report(async_line_items_report_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->generate_async_line_items_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **async_line_items_report_request** | [**AsyncLineItemsReportRequest**](AsyncLineItemsReportRequest.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_revenue_report** +> AsyncReportResponse generate_async_revenue_report(async_revenue_report_request) + + + +Returns an asynchronous Revenue Report + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import analytics_api +from criteo_api_retailmedia_v2024_04.model.async_report_response import AsyncReportResponse +from criteo_api_retailmedia_v2024_04.model.report_outcome import ReportOutcome +from criteo_api_retailmedia_v2024_04.model.async_revenue_report_request import AsyncRevenueReportRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + async_revenue_report_request = AsyncRevenueReportRequest( + data=AsyncRevenueReportResource( + type="type_example", + attributes=AsyncRevenueReport( + ids=[ + "ids_example", + ], + id="id_example", + report_type="advertiser", + revenue_type="auction", + sold_by="directSold", + buy_type="auction", + sku_relations=[ + "sameSku", + ], + format="json", + campaign_type="all", + sales_channel="all", + click_attribution_window="none", + view_attribution_window="none", + dimensions=[ + "date", + ], + metrics=[ + "numberOfCampaigns", + ], + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="UTC", + ), + ), + ) # AsyncRevenueReportRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.generate_async_revenue_report(async_revenue_report_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->generate_async_revenue_report: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **async_revenue_report_request** | [**AsyncRevenueReportRequest**](AsyncRevenueReportRequest.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) + +# **get_async_export_output** +> str get_async_export_output(report_id) + + + +Returns the output of an async report + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import analytics_api +from criteo_api_retailmedia_v2024_04.model.report_outcome import ReportOutcome +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + report_id = "reportId_example" # str | The ID of the report to retrieve + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_async_export_output(report_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->get_async_export_output: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_id** | **str**| The ID of the report to retrieve | + +### Return type + +**str** + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_async_export_status** +> AsyncReportResponse get_async_export_status(report_id) + + + +Returns the status of an async report + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import analytics_api +from criteo_api_retailmedia_v2024_04.model.async_report_response import AsyncReportResponse +from criteo_api_retailmedia_v2024_04.model.report_outcome import ReportOutcome +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = analytics_api.AnalyticsApi(api_client) + report_id = "reportId_example" # str | The ID of the report to retrieve + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_async_export_status(report_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AnalyticsApi->get_async_export_status: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_id** | **str**| The ID of the report to retrieve | + +### Return type + +[**AsyncReportResponse**](AsyncReportResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + diff --git a/sdks/retailmedia_2023-01/docs/ApplicationSummaryModel.md b/sdks/retailmedia_2024-04/docs/ApplicationSummaryModel.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ApplicationSummaryModel.md rename to sdks/retailmedia_2024-04/docs/ApplicationSummaryModel.md diff --git a/sdks/retailmedia_2023-01/docs/ApplicationSummaryModelResource.md b/sdks/retailmedia_2024-04/docs/ApplicationSummaryModelResource.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ApplicationSummaryModelResource.md rename to sdks/retailmedia_2024-04/docs/ApplicationSummaryModelResource.md diff --git a/sdks/retailmedia_2023-01/docs/ApplicationSummaryModelResponse.md b/sdks/retailmedia_2024-04/docs/ApplicationSummaryModelResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ApplicationSummaryModelResponse.md rename to sdks/retailmedia_2024-04/docs/ApplicationSummaryModelResponse.md diff --git a/sdks/retailmedia_2024-04/docs/ApprovalStatusModel.md b/sdks/retailmedia_2024-04/docs/ApprovalStatusModel.md new file mode 100644 index 00000000..52ab7863 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ApprovalStatusModel.md @@ -0,0 +1,12 @@ +# ApprovalStatusModel + +The status of a booking or runnable in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of a booking or runnable in the context of a line item. | must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] + +[[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_2023-01/docs/Asset.md b/sdks/retailmedia_2024-04/docs/Asset.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/Asset.md rename to sdks/retailmedia_2024-04/docs/Asset.md diff --git a/sdks/retailmedia_2023-01/docs/AssetResource.md b/sdks/retailmedia_2024-04/docs/AssetResource.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AssetResource.md rename to sdks/retailmedia_2024-04/docs/AssetResource.md diff --git a/sdks/retailmedia_2023-01/docs/AssetResponse.md b/sdks/retailmedia_2024-04/docs/AssetResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AssetResponse.md rename to sdks/retailmedia_2024-04/docs/AssetResponse.md diff --git a/sdks/retailmedia_2023-01/docs/AsyncCampaignsReport.md b/sdks/retailmedia_2024-04/docs/AsyncCampaignsReport.md similarity index 92% rename from sdks/retailmedia_2023-01/docs/AsyncCampaignsReport.md rename to sdks/retailmedia_2024-04/docs/AsyncCampaignsReport.md index 21dd57bd..f4385127 100644 --- a/sdks/retailmedia_2023-01/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_2024-04/docs/AsyncCampaignsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **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] -**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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-01/docs/AsyncCampaignsReportRequest.md b/sdks/retailmedia_2024-04/docs/AsyncCampaignsReportRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AsyncCampaignsReportRequest.md rename to sdks/retailmedia_2024-04/docs/AsyncCampaignsReportRequest.md diff --git a/sdks/retailmedia_2023-01/docs/AsyncCampaignsReportResource.md b/sdks/retailmedia_2024-04/docs/AsyncCampaignsReportResource.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AsyncCampaignsReportResource.md rename to sdks/retailmedia_2024-04/docs/AsyncCampaignsReportResource.md diff --git a/sdks/retailmedia_2023-01/docs/AsyncLineItemsReport.md b/sdks/retailmedia_2024-04/docs/AsyncLineItemsReport.md similarity index 92% rename from sdks/retailmedia_2023-01/docs/AsyncLineItemsReport.md rename to sdks/retailmedia_2024-04/docs/AsyncLineItemsReport.md index ccb01090..eece64e3 100644 --- a/sdks/retailmedia_2023-01/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_2024-04/docs/AsyncLineItemsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **end_date** | **datetime** | End date | **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_2023-01/docs/AsyncLineItemsReportRequest.md b/sdks/retailmedia_2024-04/docs/AsyncLineItemsReportRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AsyncLineItemsReportRequest.md rename to sdks/retailmedia_2024-04/docs/AsyncLineItemsReportRequest.md diff --git a/sdks/retailmedia_2023-01/docs/AsyncLineItemsReportResource.md b/sdks/retailmedia_2024-04/docs/AsyncLineItemsReportResource.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AsyncLineItemsReportResource.md rename to sdks/retailmedia_2024-04/docs/AsyncLineItemsReportResource.md diff --git a/sdks/retailmedia_2023-01/docs/AsyncReportResponse.md b/sdks/retailmedia_2024-04/docs/AsyncReportResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AsyncReportResponse.md rename to sdks/retailmedia_2024-04/docs/AsyncReportResponse.md diff --git a/sdks/retailmedia_2024-04/docs/AsyncRevenueReport.md b/sdks/retailmedia_2024-04/docs/AsyncRevenueReport.md new file mode 100644 index 00000000..e7d30dbc --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AsyncRevenueReport.md @@ -0,0 +1,29 @@ +# AsyncRevenueReport + +Async Revenue report body request + +## Properties +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] +**sold_by** | **str, none_type** | Filter on the seller: Indirect Sold, Direct Sold or Private Market | [optional] +**buy_type** | **str, none_type** | Filter on buy type: Auction, Preferred Deals or Sponsorship | [optional] +**sku_relations** | **[str], none_type** | Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller | [optional] +**format** | **str, none_type** | Format of the output | [optional] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" +**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_2024-04/docs/AsyncRevenueReportRequest.md b/sdks/retailmedia_2024-04/docs/AsyncRevenueReportRequest.md new file mode 100644 index 00000000..be978426 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AsyncRevenueReportRequest.md @@ -0,0 +1,13 @@ +# AsyncRevenueReportRequest + +A top-level object that encapsulates a Criteo API request for a single value + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AsyncRevenueReportResource**](AsyncRevenueReportResource.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_2024-04/docs/AsyncRevenueReportResource.md b/sdks/retailmedia_2024-04/docs/AsyncRevenueReportResource.md new file mode 100644 index 00000000..9805f04f --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AsyncRevenueReportResource.md @@ -0,0 +1,14 @@ +# AsyncRevenueReportResource + +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** | [**AsyncRevenueReport**](AsyncRevenueReport.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_2023-01/docs/AuctionLineItemCreateModelRequest.md b/sdks/retailmedia_2024-04/docs/AuctionLineItemCreateModelRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AuctionLineItemCreateModelRequest.md rename to sdks/retailmedia_2024-04/docs/AuctionLineItemCreateModelRequest.md diff --git a/sdks/retailmedia_2023-01/docs/AuctionLineItemPagedListResponse.md b/sdks/retailmedia_2024-04/docs/AuctionLineItemPagedListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AuctionLineItemPagedListResponse.md rename to sdks/retailmedia_2024-04/docs/AuctionLineItemPagedListResponse.md diff --git a/sdks/retailmedia_2023-01/docs/AuctionLineItemResponse.md b/sdks/retailmedia_2024-04/docs/AuctionLineItemResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AuctionLineItemResponse.md rename to sdks/retailmedia_2024-04/docs/AuctionLineItemResponse.md diff --git a/sdks/retailmedia_2023-01/docs/AuctionLineItemUpdateModelRequest.md b/sdks/retailmedia_2024-04/docs/AuctionLineItemUpdateModelRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AuctionLineItemUpdateModelRequest.md rename to sdks/retailmedia_2024-04/docs/AuctionLineItemUpdateModelRequest.md diff --git a/sdks/retailmedia_2024-04/docs/AudienceApi.md b/sdks/retailmedia_2024-04/docs/AudienceApi.md new file mode 100644 index 00000000..c56383b8 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/AudienceApi.md @@ -0,0 +1,448 @@ +# criteo_api_retailmedia_v2024_04.AudienceApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**legacy_create_audience_v1**](AudienceApi.md#legacy_create_audience_v1) | **POST** /2024-04/retail-media/accounts/{accountId}/audiences | +[**legacy_get_audience_v1**](AudienceApi.md#legacy_get_audience_v1) | **GET** /2024-04/retail-media/accounts/{accountId}/audiences | +[**legacy_get_audience_v2**](AudienceApi.md#legacy_get_audience_v2) | **GET** /2024-04/retail-media/v2/accounts/{accountId}/audiences | +[**legacy_update_audience_v2**](AudienceApi.md#legacy_update_audience_v2) | **POST** /2024-04/retail-media/v2/accounts/{accountId}/audiences | + + +# **legacy_create_audience_v1** +> RmLegacyAudienceCreateEntityV1Response legacy_create_audience_v1(account_id, rm_legacy_audience_create_input_entity_v1) + + + +Create an Audience (deprecated Public API) + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import audience_api +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_input_entity_v1 import RmLegacyAudienceCreateInputEntityV1 +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + account_id = 1 # int | ID of the account to which this audience belongs. + rm_legacy_audience_create_input_entity_v1 = RmLegacyAudienceCreateInputEntityV1( + data=RmLegacyAudienceCreateEntityV1Resource( + attributes=RmLegacyAudienceCreateEntityV1( + user_type="viewer", + lookback_window="P7D", + brand_ids=[ + 1, + ], + category_ids=[ + 1, + ], + retailer_id=1, + name="name_example", + ), + id="id_example", + type="type_example", + ), + ) # RmLegacyAudienceCreateInputEntityV1 | Audience creation request. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.legacy_create_audience_v1(account_id, rm_legacy_audience_create_input_entity_v1) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->legacy_create_audience_v1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **int**| ID of the account to which this audience belongs. | + **rm_legacy_audience_create_input_entity_v1** | [**RmLegacyAudienceCreateInputEntityV1**](RmLegacyAudienceCreateInputEntityV1.md)| Audience creation request. | + +### Return type + +[**RmLegacyAudienceCreateEntityV1Response**](RmLegacyAudienceCreateEntityV1Response.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 | - | +**201** | The audience that was just created. | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **legacy_get_audience_v1** +> RmLegacyAudienceGetEntityV1ListResponse legacy_get_audience_v1(account_id) + + + +Get a page of Audiences. (deprecated Public API) + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import audience_api +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + account_id = 1 # int | ID of the account to which this audience belongs. + limit_to_id = [ + 1, + ] # [int] | Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 (optional) + page_size = 1 # int | Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. (optional) + page_index = 1 # int | Returns the specified page of results given a pageSize; pages are 0-indexed. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.legacy_get_audience_v1(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->legacy_get_audience_v1: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.legacy_get_audience_v1(account_id, limit_to_id=limit_to_id, page_size=page_size, page_index=page_index) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->legacy_get_audience_v1: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **int**| ID of the account to which this audience belongs. | + **limit_to_id** | **[int]**| Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 | [optional] + **page_size** | **int**| Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. | [optional] + **page_index** | **int**| Returns the specified page of results given a pageSize; pages are 0-indexed. | [optional] + +### Return type + +[**RmLegacyAudienceGetEntityV1ListResponse**](RmLegacyAudienceGetEntityV1ListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A page of audiences for the supplied account or shared by related retailers. | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **legacy_get_audience_v2** +> RmLegacyAudienceGetEntityV2ListResponse legacy_get_audience_v2(account_id) + + + +Get a page of Audiences. (deprecated Public API) + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import audience_api +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + account_id = 1 # int | ID of the account to which this audience belongs. + limit_to_id = [ + 1, + ] # [int] | Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 (optional) + page_size = 1 # int | Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. (optional) + page_index = 1 # int | Returns the specified page of results given a pageSize; pages are 0-indexed. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.legacy_get_audience_v2(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->legacy_get_audience_v2: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.legacy_get_audience_v2(account_id, limit_to_id=limit_to_id, page_size=page_size, page_index=page_index) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->legacy_get_audience_v2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **int**| ID of the account to which this audience belongs. | + **limit_to_id** | **[int]**| Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 | [optional] + **page_size** | **int**| Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. | [optional] + **page_index** | **int**| Returns the specified page of results given a pageSize; pages are 0-indexed. | [optional] + +### Return type + +[**RmLegacyAudienceGetEntityV2ListResponse**](RmLegacyAudienceGetEntityV2ListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A page of audiences for the supplied account or shared by related retailers. | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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) + +# **legacy_update_audience_v2** +> RmLegacyAudienceCreateEntityV2Response legacy_update_audience_v2(account_id, rm_legacy_audience_create_input_entity_v2) + + + +Create an Audience (deprecated Public API) + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import audience_api +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_entity_v2_response import RmLegacyAudienceCreateEntityV2Response +from criteo_api_retailmedia_v2024_04.model.rm_legacy_audience_create_input_entity_v2 import RmLegacyAudienceCreateInputEntityV2 +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = audience_api.AudienceApi(api_client) + account_id = 1 # int | ID of the account to which this audience belongs. + rm_legacy_audience_create_input_entity_v2 = RmLegacyAudienceCreateInputEntityV2( + data=RmLegacyAudienceCreateEntityV2Resource( + attributes=RmLegacyAudienceCreateEntityV2( + retailer_id=1, + user_behavior_details=RmLegacyAudienceUserBehaviorCreateV2( + inclusive_segment=RmLegacySegmentUserBehaviorCreateV2( + user_action="buy", + lookback_window="P7D", + category_ids=[ + 1, + ], + brand_ids=[ + 1, + ], + ), + exclusive_segment=RmLegacySegmentUserBehaviorCreateV2( + user_action="buy", + lookback_window="P7D", + category_ids=[ + 1, + ], + brand_ids=[ + 1, + ], + ), + ), + name="name_example", + ), + id="id_example", + type="type_example", + ), + ) # RmLegacyAudienceCreateInputEntityV2 | Audience creation request. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.legacy_update_audience_v2(account_id, rm_legacy_audience_create_input_entity_v2) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling AudienceApi->legacy_update_audience_v2: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **int**| ID of the account to which this audience belongs. | + **rm_legacy_audience_create_input_entity_v2** | [**RmLegacyAudienceCreateInputEntityV2**](RmLegacyAudienceCreateInputEntityV2.md)| Audience creation request. | + +### Return type + +[**RmLegacyAudienceCreateEntityV2Response**](RmLegacyAudienceCreateEntityV2Response.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 | - | +**201** | The audience that was just created. | - | +**400** | Bad request | - | +**401** | The API client is not properly authenticated. | - | +**403** | The API client is not authorized to access this resource. | - | + +[[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_2023-01/docs/AudienceIdsUpdateModel202110Request.md b/sdks/retailmedia_2024-04/docs/AudienceIdsUpdateModel202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AudienceIdsUpdateModel202110Request.md rename to sdks/retailmedia_2024-04/docs/AudienceIdsUpdateModel202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/AudienceTarget202110Request.md b/sdks/retailmedia_2024-04/docs/AudienceTarget202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AudienceTarget202110Request.md rename to sdks/retailmedia_2024-04/docs/AudienceTarget202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/AudienceTarget202110Response.md b/sdks/retailmedia_2024-04/docs/AudienceTarget202110Response.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/AudienceTarget202110Response.md rename to sdks/retailmedia_2024-04/docs/AudienceTarget202110Response.md diff --git a/sdks/retailmedia_2023-01/docs/BalanceCampaign202110ListRequest.md b/sdks/retailmedia_2024-04/docs/BalanceCampaign202110ListRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/BalanceCampaign202110ListRequest.md rename to sdks/retailmedia_2024-04/docs/BalanceCampaign202110ListRequest.md diff --git a/sdks/retailmedia_2023-01/docs/BalanceCampaign202110PagedListResponse.md b/sdks/retailmedia_2024-04/docs/BalanceCampaign202110PagedListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/BalanceCampaign202110PagedListResponse.md rename to sdks/retailmedia_2024-04/docs/BalanceCampaign202110PagedListResponse.md diff --git a/sdks/retailmedia_2024-04/docs/BalanceResponse.md b/sdks/retailmedia_2024-04/docs/BalanceResponse.md new file mode 100644 index 00000000..cd206467 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/BalanceResponse.md @@ -0,0 +1,15 @@ +# BalanceResponse + +Data model for response resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfBalanceResponse**](ResourceOfBalanceResponse.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_2024-04/docs/BalanceResponsePagedListResponse.md b/sdks/retailmedia_2024-04/docs/BalanceResponsePagedListResponse.md new file mode 100644 index 00000000..bbdc9788 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/BalanceResponsePagedListResponse.md @@ -0,0 +1,16 @@ +# BalanceResponsePagedListResponse + +Data model for a paged list of response resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metadata** | [**PageMetadata**](PageMetadata.md) | | [optional] +**data** | [**[ResourceOfBalanceResponse]**](ResourceOfBalanceResponse.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_2024-04/docs/CampaignApi.md b/sdks/retailmedia_2024-04/docs/CampaignApi.md new file mode 100644 index 00000000..01d910d7 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/CampaignApi.md @@ -0,0 +1,7252 @@ +# criteo_api_retailmedia_v2024_04.CampaignApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_remove_keywords**](CampaignApi.md#add_remove_keywords) | **POST** /2024-04/retail-media/line-items/{id}/keywords/add-remove | +[**create_asset**](CampaignApi.md#create_asset) | **POST** /2024-04/retail-media/assets | +[**fetch_keywords**](CampaignApi.md#fetch_keywords) | **GET** /2024-04/retail-media/line-items/{id}/keywords | +[**fetch_proposal**](CampaignApi.md#fetch_proposal) | **GET** /2024-04/retail-media/preferred-deal-line-items/{id}/proposal | +[**get_api202110_external_account_creatives_by_account_id**](CampaignApi.md#get_api202110_external_account_creatives_by_account_id) | **GET** /2024-04/retail-media/accounts/{account-id}/creatives | +[**get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id**](CampaignApi.md#get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id) | **GET** /2024-04/retail-media/auction-line-items/{line-item-id}/targeting/keywords | +[**get_api202110_external_balance_campaigns_by_balance_id**](CampaignApi.md#get_api202110_external_balance_campaigns_by_balance_id) | **GET** /2024-04/retail-media/balances/{balance-id}/campaigns | +[**get_api202110_external_campaign_preferred_line_items_by_campaign_id**](CampaignApi.md#get_api202110_external_campaign_preferred_line_items_by_campaign_id) | **GET** /2024-04/retail-media/campaigns/{campaign-id}/preferred-line-items | +[**get_api202110_external_line_item_products_by_line_item_id**](CampaignApi.md#get_api202110_external_line_item_products_by_line_item_id) | **GET** /2024-04/retail-media/line-items/{line-item-id}/products | +[**get_api202110_external_preferred_line_item_by_line_item_id**](CampaignApi.md#get_api202110_external_preferred_line_item_by_line_item_id) | **GET** /2024-04/retail-media/preferred-line-items/{line-item-id} | +[**get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id**](CampaignApi.md#get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id) | **GET** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket | +[**get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id**](CampaignApi.md#get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id) | **GET** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/audiences | +[**get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id**](CampaignApi.md#get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id) | **GET** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/stores | +[**get_api202110_external_retailer_pages_by_retailer_id**](CampaignApi.md#get_api202110_external_retailer_pages_by_retailer_id) | **GET** /2024-04/retail-media/retailers/{retailerId}/pages | +[**get_api202204_external_categorie_by_category_id**](CampaignApi.md#get_api202204_external_categorie_by_category_id) | **GET** /2024-04/retail-media/categories/{categoryId} | +[**get_api202204_external_categories**](CampaignApi.md#get_api202204_external_categories) | **GET** /2024-04/retail-media/categories | +[**get_api202207_external_retailer_by_retailer_id_templatestemplate_id**](CampaignApi.md#get_api202207_external_retailer_by_retailer_id_templatestemplate_id) | **GET** /2024-04/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** /2024-04/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** /2024-04/retail-media/accounts/{account-id}/creatives/{creative-id} | +[**get_api202301_external_account_campaigns_by_account_id**](CampaignApi.md#get_api202301_external_account_campaigns_by_account_id) | **GET** /2024-04/retail-media/accounts/{account-id}/campaigns | +[**get_api202301_external_campaign_by_campaign_id**](CampaignApi.md#get_api202301_external_campaign_by_campaign_id) | **GET** /2024-04/retail-media/campaigns/{campaignId} | +[**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** /2024-04/retail-media/line-items/{line-item-id}/bid-multipliers | +[**get_api_v1_external_account_balances_by_account_id**](CampaignApi.md#get_api_v1_external_account_balances_by_account_id) | **GET** /2024-04/retail-media/accounts/{account-id}/balances | +[**get_api_v1_external_account_brands_by_account_id**](CampaignApi.md#get_api_v1_external_account_brands_by_account_id) | **GET** /2024-04/retail-media/accounts/{accountId}/brands | +[**get_api_v1_external_account_by_account_id_and_balance_id**](CampaignApi.md#get_api_v1_external_account_by_account_id_and_balance_id) | **GET** /2024-04/retail-media/accounts/{account-id}/balances/{balanceId} | +[**get_api_v1_external_account_retailers_by_account_id**](CampaignApi.md#get_api_v1_external_account_retailers_by_account_id) | **GET** /2024-04/retail-media/accounts/{accountId}/retailers | +[**get_api_v1_external_accounts**](CampaignApi.md#get_api_v1_external_accounts) | **GET** /2024-04/retail-media/accounts | +[**get_api_v1_external_catalog_output_by_catalog_id**](CampaignApi.md#get_api_v1_external_catalog_output_by_catalog_id) | **GET** /2024-04/retail-media/catalogs/{catalogId}/output | +[**get_api_v1_external_catalog_status_by_catalog_id**](CampaignApi.md#get_api_v1_external_catalog_status_by_catalog_id) | **GET** /2024-04/retail-media/catalogs/{catalogId}/status | +[**get_api_v2_external_account_line_items_by_account_id**](CampaignApi.md#get_api_v2_external_account_line_items_by_account_id) | **GET** /2024-04/retail-media/accounts/{account-id}/line-items | +[**get_api_v2_external_auction_line_item_by_line_item_id**](CampaignApi.md#get_api_v2_external_auction_line_item_by_line_item_id) | **GET** /2024-04/retail-media/auction-line-items/{line-item-id} | +[**get_api_v2_external_campaign_auction_line_items_by_campaign_id**](CampaignApi.md#get_api_v2_external_campaign_auction_line_items_by_campaign_id) | **GET** /2024-04/retail-media/campaigns/{campaign-id}/auction-line-items | +[**get_api_v2_external_line_item_by_line_item_id**](CampaignApi.md#get_api_v2_external_line_item_by_line_item_id) | **GET** /2024-04/retail-media/line-items/{line-item-id} | +[**get_campaign_budget_overrides**](CampaignApi.md#get_campaign_budget_overrides) | **GET** /2024-04/retail-media/campaigns/{campaignId}/campaign-budget-overrides | +[**get_insertion_order_history_change_data_capture**](CampaignApi.md#get_insertion_order_history_change_data_capture) | **GET** /2024-04/retail-media/insertion-order-history/{insertionOrderId}/change-data-capture | +[**get_line_item_budget_overrides**](CampaignApi.md#get_line_item_budget_overrides) | **GET** /2024-04/retail-media/line-items/{lineItemId}/line-item-budget-overrides | +[**patch_api_v1_external_account_by_account_id_and_balance_id**](CampaignApi.md#patch_api_v1_external_account_by_account_id_and_balance_id) | **PATCH** /2024-04/retail-media/accounts/{account-id}/balances/{balanceId} | +[**post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id**](CampaignApi.md#post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id) | **POST** /2024-04/retail-media/auction-line-items/{line-item-id}/targeting/keywords/append | +[**post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id) | **POST** /2024-04/retail-media/auction-line-items/{line-item-id}/targeting/keywords/delete | +[**post_api202110_external_balance_campaigns_append_by_balance_id**](CampaignApi.md#post_api202110_external_balance_campaigns_append_by_balance_id) | **POST** /2024-04/retail-media/balances/{balance-id}/campaigns/append | +[**post_api202110_external_balance_campaigns_delete_by_balance_id**](CampaignApi.md#post_api202110_external_balance_campaigns_delete_by_balance_id) | **POST** /2024-04/retail-media/balances/{balance-id}/campaigns/delete | +[**post_api202110_external_campaign_preferred_line_items_by_campaign_id**](CampaignApi.md#post_api202110_external_campaign_preferred_line_items_by_campaign_id) | **POST** /2024-04/retail-media/campaigns/{campaign-id}/preferred-line-items | +[**post_api202110_external_line_item_products_append_by_line_item_id**](CampaignApi.md#post_api202110_external_line_item_products_append_by_line_item_id) | **POST** /2024-04/retail-media/line-items/{line-item-id}/products/append | +[**post_api202110_external_line_item_products_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_line_item_products_delete_by_line_item_id) | **POST** /2024-04/retail-media/line-items/{line-item-id}/products/delete | +[**post_api202110_external_line_item_products_pause_by_line_item_id**](CampaignApi.md#post_api202110_external_line_item_products_pause_by_line_item_id) | **POST** /2024-04/retail-media/line-items/{line-item-id}/products/pause | +[**post_api202110_external_line_item_products_unpause_by_line_item_id**](CampaignApi.md#post_api202110_external_line_item_products_unpause_by_line_item_id) | **POST** /2024-04/retail-media/line-items/{line-item-id}/products/unpause | +[**post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id) | **POST** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append | +[**post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id) | **POST** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete | +[**post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id) | **POST** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append | +[**post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id) | **POST** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete | +[**post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id) | **POST** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append | +[**post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id**](CampaignApi.md#post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id) | **POST** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete | +[**post_api202210_external_account_creatives_by_account_id**](CampaignApi.md#post_api202210_external_account_creatives_by_account_id) | **POST** /2024-04/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** /2024-04/retail-media/accounts/{account-id}/creatives/search | +[**post_api202301_external_account_campaigns_by_account_id**](CampaignApi.md#post_api202301_external_account_campaigns_by_account_id) | **POST** /2024-04/retail-media/accounts/{account-id}/campaigns | +[**post_api_v1_external_account_add_funds_by_account_id_and_balance_id**](CampaignApi.md#post_api_v1_external_account_add_funds_by_account_id_and_balance_id) | **POST** /2024-04/retail-media/accounts/{account-id}/balances/{balanceId}/add-funds | +[**post_api_v1_external_account_balances_by_account_id**](CampaignApi.md#post_api_v1_external_account_balances_by_account_id) | **POST** /2024-04/retail-media/accounts/{account-id}/balances | +[**post_api_v1_external_account_catalogs_by_account_id**](CampaignApi.md#post_api_v1_external_account_catalogs_by_account_id) | **POST** /2024-04/retail-media/accounts/{accountId}/catalogs | +[**post_api_v1_external_account_change_dates_by_account_id_and_balance_id**](CampaignApi.md#post_api_v1_external_account_change_dates_by_account_id_and_balance_id) | **POST** /2024-04/retail-media/accounts/{account-id}/balances/{balanceId}/change-dates | +[**post_api_v2_external_campaign_auction_line_items_by_campaign_id**](CampaignApi.md#post_api_v2_external_campaign_auction_line_items_by_campaign_id) | **POST** /2024-04/retail-media/campaigns/{campaign-id}/auction-line-items | +[**put_api202110_external_preferred_line_item_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_by_line_item_id) | **PUT** /2024-04/retail-media/preferred-line-items/{line-item-id} | +[**put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id) | **PUT** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket | +[**put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id) | **PUT** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/audiences | +[**put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id**](CampaignApi.md#put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id) | **PUT** /2024-04/retail-media/preferred-line-items/{line-item-id}/targeting/stores | +[**put_api202210_external_account_by_account_id_creativescreative_id**](CampaignApi.md#put_api202210_external_account_by_account_id_creativescreative_id) | **PUT** /2024-04/retail-media/accounts/{account-id}/creatives/{creative-id} | +[**put_api202301_external_campaign_by_campaign_id**](CampaignApi.md#put_api202301_external_campaign_by_campaign_id) | **PUT** /2024-04/retail-media/campaigns/{campaignId} | +[**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** /2024-04/retail-media/line-items/{line-item-id}/bid-multipliers | +[**put_api_v2_external_auction_line_item_by_line_item_id**](CampaignApi.md#put_api_v2_external_auction_line_item_by_line_item_id) | **PUT** /2024-04/retail-media/auction-line-items/{line-item-id} | +[**set_keyword_bids**](CampaignApi.md#set_keyword_bids) | **POST** /2024-04/retail-media/line-items/{id}/keywords/set-bid | +[**submit_proposal**](CampaignApi.md#submit_proposal) | **POST** /2024-04/retail-media/preferred-deal-line-items/{id}/proposal/submit | +[**update_campaign_budget_overrides**](CampaignApi.md#update_campaign_budget_overrides) | **PUT** /2024-04/retail-media/campaigns/{campaignId}/campaign-budget-overrides | +[**update_line_item_budget_overrides**](CampaignApi.md#update_line_item_budget_overrides) | **PUT** /2024-04/retail-media/line-items/{lineItemId}/line-item-budget-overrides | + + +# **add_remove_keywords** +> ResourceOutcome add_remove_keywords(id) + + + +Add or Remove keywords from the line item in bulk + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2024_04.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + id = "id_example" # str | ID of the line item + add_remove_keywords_model_request = AddRemoveKeywordsModelRequest( + data=AddRemoveKeywordsModelResource( + id="id_example", + type="type_example", + attributes=AddRemoveKeywordsModel( + keywords=[ + AddRemoveKeywordModel( + phrase="phrase_example", + match_type=MatchTypeModel("PositiveExactMatch"), + is_deleted=True, + ), + ], + ), + ), + ) # AddRemoveKeywordsModelRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.add_remove_keywords(id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->add_remove_keywords: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.add_remove_keywords(id, add_remove_keywords_model_request=add_remove_keywords_model_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->add_remove_keywords: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the line item | + **add_remove_keywords_model_request** | [**AddRemoveKeywordsModelRequest**](AddRemoveKeywordsModelRequest.md)| | [optional] + +### Return type + +[**ResourceOutcome**](ResourceOutcome.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** | 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) + +# **create_asset** +> AssetResponse create_asset(asset_file) + + + +Creates an asset + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.asset_response import AssetResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + asset_file = open('/path/to/file', 'rb') # file_type | The asset binary content + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_asset(asset_file) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->create_asset: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **asset_file** | **file_type**| The asset binary content | + +### Return type + +[**AssetResponse**](AssetResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **fetch_keywords** +> KeywordsModelResponse fetch_keywords(id) + + + +Fetch keywords associated with the specified line item + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_v2024_04.model.keywords_model_response import KeywordsModelResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + id = "id_example" # str | ID of the line item + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.fetch_keywords(id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->fetch_keywords: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the line item | + +### Return type + +[**KeywordsModelResponse**](KeywordsModelResponse.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** | 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) + +# **fetch_proposal** +> ProposalStatusModelResponse fetch_proposal(id) + + + +Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_v2024_04.model.resource_outcome import ResourceOutcome +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + id = "id_example" # str | ID of the line item + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.fetch_proposal(id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->fetch_proposal: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the line item | + +### Return type + +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.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** | 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) + +# **get_api202110_external_account_creatives_by_account_id** +> Creative202110ListResponse get_api202110_external_account_creatives_by_account_id(account_id) + + + +Get account creatives + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.creative202110_list_response import Creative202110ListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202110_external_account_creatives_by_account_id(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_account_creatives_by_account_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| External account id to retrieve creatives for | + +### Return type + +[**Creative202110ListResponse**](Creative202110ListResponse.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 | - | + +[[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_api202110_external_auction_line_item_targeting_keywords_by_line_item_id** +> KeywordTarget202110Response get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id(line_item_id) + + + +This endpoint gets the keyword target on the specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_response import KeywordTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_auction_line_item_targeting_keywords_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + +### Return type + +[**KeywordTarget202110Response**](KeywordTarget202110Response.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** | 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_api202110_external_balance_campaigns_by_balance_id** +> BalanceCampaign202110PagedListResponse get_api202110_external_balance_campaigns_by_balance_id(balance_id) + + + +Gets page of campaigns for the given balanceId + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + balance_id = "balance-id_example" # str | The balance to get campaigns from + 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_api202110_external_balance_campaigns_by_balance_id(balance_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_balance_campaigns_by_balance_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_api202110_external_balance_campaigns_by_balance_id(balance_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_balance_campaigns_by_balance_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **balance_id** | **str**| The balance to get campaigns from | + **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 + +[**BalanceCampaign202110PagedListResponse**](BalanceCampaign202110PagedListResponse.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** | 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_api202110_external_campaign_preferred_line_items_by_campaign_id** +> PreferredLineItem202110PagedListResponse get_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id) + + + +Gets page of preferred line item objects for the given campaign id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.preferred_line_item202110_paged_list_response import PreferredLineItem202110PagedListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + 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_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_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_api202110_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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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 + +[**PreferredLineItem202110PagedListResponse**](PreferredLineItem202110PagedListResponse.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** | 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_api202110_external_line_item_products_by_line_item_id** +> PromotedProduct202110PagedListResponse get_api202110_external_line_item_products_by_line_item_id(line_item_id) + + + +This endpoint gets the promoted products on the specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + 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_api202110_external_line_item_products_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_line_item_products_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_api202110_external_line_item_products_by_line_item_id(line_item_id, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_line_item_products_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **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 + +[**PromotedProduct202110PagedListResponse**](PromotedProduct202110PagedListResponse.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** | 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_api202110_external_preferred_line_item_by_line_item_id** +> PreferredLineItem202110Response get_api202110_external_preferred_line_item_by_line_item_id(line_item_id) + + + +Gets the preferred line item for the given line item id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.preferred_line_item202110_response import PreferredLineItem202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The given line item id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202110_external_preferred_line_item_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_preferred_line_item_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The given line item id | + +### Return type + +[**PreferredLineItem202110Response**](PreferredLineItem202110Response.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** | 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_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id** +> AddToBasketTarget202110Response get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id) + + + +This endpoint gets the add to basket target on the specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_response import AddToBasketTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + +### Return type + +[**AddToBasketTarget202110Response**](AddToBasketTarget202110Response.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** | 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_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id** +> AudienceTarget202110Response get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id) + + + +This endpoint gets the audience target on the specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.audience_target202110_response import AudienceTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + +### Return type + +[**AudienceTarget202110Response**](AudienceTarget202110Response.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** | 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_api202110_external_preferred_line_item_targeting_stores_by_line_item_id** +> StoreTarget202110Response get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id) + + + +This endpoint gets the store target on the specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.store_target202110_response import StoreTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_preferred_line_item_targeting_stores_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + +### Return type + +[**StoreTarget202110Response**](StoreTarget202110Response.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** | 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_api202110_external_retailer_pages_by_retailer_id** +> ExternalRetailerPages202110 get_api202110_external_retailer_pages_by_retailer_id(retailer_id) + + + +Get the page types available for the given retailer + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.external_retailer_pages202110 import ExternalRetailerPages202110 +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + retailer_id = 1 # int | The retailers to fetch pages for + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202110_external_retailer_pages_by_retailer_id(retailer_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202110_external_retailer_pages_by_retailer_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **retailer_id** | **int**| The retailers to fetch pages for | + +### Return type + +[**ExternalRetailerPages202110**](ExternalRetailerPages202110.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** | Pages fetched successfully | - | + +[[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_api202204_external_categorie_by_category_id** +> Category202204 get_api202204_external_categorie_by_category_id(category_id) + + + +Endpoint to search for a specific category by categoryId. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.category202204 import Category202204 +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + category_id = 1 # int | ID of the desired category + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202204_external_categorie_by_category_id(category_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202204_external_categorie_by_category_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **category_id** | **int**| ID of the desired category | + +### Return type + +[**Category202204**](Category202204.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** | Retrieval completed and category is returned. | - | +**400** | No IDs were passed in. | - | +**500** | A non-request input based error occurred in the server. | - | + +[[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_api202204_external_categories** +> Category202204ListResponse get_api202204_external_categories() + + + +Endpoint to search categories by text and retailer. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.category202204_list_response import Category202204ListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 Categories fetched (optional) + text_substring = "textSubstring_example" # str | Query string to search across Categories (optional) + page_index = 0 # int | The start position in the overall list of matches. Must be zero or greater. (optional) if omitted the server will use the default value of 0 + page_size = 100 # int | The maximum number of results to return with each call. Must be greater than zero. (optional) if omitted the server will use the default value of 100 + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.get_api202204_external_categories(retailer_id=retailer_id, text_substring=text_substring, page_index=page_index, page_size=page_size) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202204_external_categories: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **retailer_id** | **int**| The retailer id for which Categories fetched | [optional] + **text_substring** | **str**| Query string to search across Categories | [optional] + **page_index** | **int**| The start position in the overall list of matches. Must be zero or greater. | [optional] if omitted the server will use the default value of 0 + **page_size** | **int**| The maximum number of results to return with each call. Must be greater than zero. | [optional] if omitted the server will use the default value of 100 + +### Return type + +[**Category202204ListResponse**](Category202204ListResponse.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** | Categories 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_api202207_external_retailer_by_retailer_id_templatestemplate_id** +> TemplateResponse get_api202207_external_retailer_by_retailer_id_templatestemplate_id(retailer_id, template_id) + + + +Gets the template for the specified retailer id and template id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.template_response import TemplateResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 + + # 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) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202207_external_retailer_by_retailer_id_templatestemplate_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **retailer_id** | **int**| Retailer Id | + **template_id** | **int**| Template Id | + +### Return type + +[**TemplateResponse**](TemplateResponse.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** | Template found for the retailer | - | + +[[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 retailer creative templates + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.template_list_response import TemplateListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 + + # 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) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202207_external_retailer_templates_by_retailer_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **retailer_id** | **int**| External retailer id to retrieve creative templates for | + +### Return type + +[**TemplateListResponse**](TemplateListResponse.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** | Templates 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_api202210_external_account_by_account_id_creativescreative_id** +> Creative202210Response get_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id) + + + +Get the specified creative + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.creative202210_response import Creative202210Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 + + # 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) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202210_external_account_by_account_id_creativescreative_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| External account id to retrieve creatives for | + **creative_id** | **str**| Creative to get | + +### Return type + +[**Creative202210Response**](Creative202210Response.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 | - | + +[[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_account_campaigns_by_account_id** +> JsonApiPageResponseOfCampaignV202301 get_api202301_external_account_campaigns_by_account_id(account_id) + + + +Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign ids. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.json_api_page_response_of_campaign_v202301 import JsonApiPageResponseOfCampaignV202301 +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The account to request the campaign for. + limit_to_id = [ + "limitToId_example", + ] # [str] | The ids that you would like to limit your result set to (optional) + page_index = 0 # int | The 0 indexed page index you would like to receive given the page size (optional) if omitted the server will use the default value of 0 + page_size = 25 # int | The maximum number of items you would like to receive in this request (optional) if omitted the server will use the default value of 25 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202301_external_account_campaigns_by_account_id(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202301_external_account_campaigns_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_api202301_external_account_campaigns_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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202301_external_account_campaigns_by_account_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The account to request the campaign for. | + **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] if omitted the server will use the default value of 0 + **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] if omitted the server will use the default value of 25 + +### Return type + +[**JsonApiPageResponseOfCampaignV202301**](JsonApiPageResponseOfCampaignV202301.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** | 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_api202301_external_campaign_by_campaign_id** +> JsonApiSingleResponseOfCampaignV202301 get_api202301_external_campaign_by_campaign_id(campaign_id) + + + +Get all the editable and creatable campaign attributes including all types of budgets given the campaign id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + campaign_id = "campaignId_example" # str | Campaign Id of the campaign detail + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api202301_external_campaign_by_campaign_id(campaign_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202301_external_campaign_by_campaign_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_id** | **str**| Campaign Id of the campaign detail | + +### Return type + +[**JsonApiSingleResponseOfCampaignV202301**](JsonApiSingleResponseOfCampaignV202301.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** | 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_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 bid multipliers by line item + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.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. +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 + + # example passing only required values which don't have defaults set + try: + 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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| Long external id of the associated line item | + +### Return type + +[**JsonApiSingleResponseOfLineItemBidMultipliers**](JsonApiSingleResponseOfLineItemBidMultipliers.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/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) + +# **get_api_v1_external_account_balances_by_account_id** +> BalanceResponsePagedListResponse get_api_v1_external_account_balances_by_account_id(account_id) + + + +Get page of balances for the given accountId. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.balance_response_paged_list_response import BalanceResponsePagedListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The account to get page of balances for + limit_to_id = [ + "limitToId_example", + ] # [str] | The ids that you would like to limit your result set to (optional) + page_index = 0 # int | The 0 indexed page index you would like to receive given the page size (optional) if omitted the server will use the default value of 0 + page_size = 25 # int | The maximum number of items you would like to receive in this request (optional) if omitted the server will use the default value of 25 + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api_v1_external_account_balances_by_account_id(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_account_balances_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_balances_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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_account_balances_by_account_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The account to get page of balances for | + **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] if omitted the server will use the default value of 0 + **page_size** | **int**| The maximum number of items you would like to receive in this request | [optional] if omitted the server will use the default value of 25 + +### Return type + +[**BalanceResponsePagedListResponse**](BalanceResponsePagedListResponse.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** | 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_api_v1_external_account_brands_by_account_id** +> JsonApiPageResponseOfBrand get_api_v1_external_account_brands_by_account_id(account_id) + + + +Gets page of retailer objects that are associated with the given account + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.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. +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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_v2024_04.ApiException as 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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_account_brands_by_account_id: %s\n" % e) +``` + + +### Parameters + +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] + +### Return type + +[**JsonApiPageResponseOfBrand**](JsonApiPageResponseOfBrand.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** | 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_api_v1_external_account_by_account_id_and_balance_id** +> BalanceResponse get_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id) + + + +Get a balance for the given account id and balance id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The account of the balance + balance_id = "balanceId_example" # str | The balance id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_account_by_account_id_and_balance_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The account of the balance | + **balance_id** | **str**| The balance id | + +### Return type + +[**BalanceResponse**](BalanceResponse.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** | 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_api_v1_external_account_retailers_by_account_id** +> JsonApiPageResponseOfRetailer get_api_v1_external_account_retailers_by_account_id(account_id) + + + +Gets page of retailer objects that are associated with the given account + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.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. +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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_retailers_by_account_id(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as 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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_account_retailers_by_account_id: %s\n" % e) +``` + + +### Parameters + +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] + +### Return type + +[**JsonApiPageResponseOfRetailer**](JsonApiPageResponseOfRetailer.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** | 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_api_v1_external_accounts** +> JsonApiPageResponseOfAccount get_api_v1_external_accounts() + + + +Gets page of account objects that the current user can access + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.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. +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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) + + # 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) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_accounts: %s\n" % e) +``` + + +### Parameters + +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] + +### Return type + +[**JsonApiPageResponseOfAccount**](JsonApiPageResponseOfAccount.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** | 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_api_v1_external_catalog_output_by_catalog_id** +> get_api_v1_external_catalog_output_by_catalog_id(catalog_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 v2021_07 CatalogProduct json objects. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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. + + # example passing only required values which don't have defaults set + try: + api_instance.get_api_v1_external_catalog_output_by_catalog_id(catalog_id) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_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_v1_external_catalog_status_by_catalog_id** +> JsonApiSingleResponseOfCatalogStatus get_api_v1_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_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api_v1_external_catalog_status_by_catalog_id(catalog_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v1_external_catalog_status_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 + +[**JsonApiSingleResponseOfCatalogStatus**](JsonApiSingleResponseOfCatalogStatus.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** | Catalog request 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_v2_external_account_line_items_by_account_id** +> CommonLineItemPagedListResponse get_api_v2_external_account_line_items_by_account_id(account_id) + + + +Gets page of line item objects for the given account id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.common_line_item_paged_list_response import CommonLineItemPagedListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The given account id + limit_to_campaign_id = [ + "limitToCampaignId_example", + ] # [str] | The campaign ids that you would like to limit your result set to (optional) + limit_to_type = "Unknown" # str | The campaign types that you would like to limit your result set to (optional) + 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_v2_external_account_line_items_by_account_id(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v2_external_account_line_items_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_v2_external_account_line_items_by_account_id(account_id, limit_to_campaign_id=limit_to_campaign_id, limit_to_type=limit_to_type, limit_to_id=limit_to_id, page_index=page_index, page_size=page_size) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v2_external_account_line_items_by_account_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The given account id | + **limit_to_campaign_id** | **[str]**| The campaign ids that you would like to limit your result set to | [optional] + **limit_to_type** | **str**| The campaign types that you would like to limit your result set to | [optional] + **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 + +[**CommonLineItemPagedListResponse**](CommonLineItemPagedListResponse.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** | 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_api_v2_external_auction_line_item_by_line_item_id** +> AuctionLineItemResponse get_api_v2_external_auction_line_item_by_line_item_id(line_item_id) + + + +Gets the auction line item for the given line item id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.auction_line_item_response import AuctionLineItemResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The given line item id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api_v2_external_auction_line_item_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v2_external_auction_line_item_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The given line item id | + +### Return type + +[**AuctionLineItemResponse**](AuctionLineItemResponse.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** | 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_v2_external_campaign_auction_line_items_by_campaign_id** +> AuctionLineItemPagedListResponse get_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id) + + + +Gets page of auction line item objects for the given campaign id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.auction_line_item_paged_list_response import AuctionLineItemPagedListResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + 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_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v2_external_campaign_auction_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_v2_external_campaign_auction_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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v2_external_campaign_auction_line_items_by_campaign_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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 + +[**AuctionLineItemPagedListResponse**](AuctionLineItemPagedListResponse.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** | 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_v2_external_line_item_by_line_item_id** +> CommonLineItemResponse get_api_v2_external_line_item_by_line_item_id(line_item_id) + + + +Gets the line item for the given line item id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.common_line_item_response import CommonLineItemResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The given line item id + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api_v2_external_line_item_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_api_v2_external_line_item_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The given line item id | + +### Return type + +[**CommonLineItemResponse**](CommonLineItemResponse.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** | 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 current campaign budget overrides by given external campaign id. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.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. +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_campaign_budget_overrides(campaign_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_campaign_budget_overrides: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_id** | **int**| External campaign id. | + +### Return type + +[**ValueResourceOutcomeOfCampaignBudgetOverrides**](ValueResourceOutcomeOfCampaignBudgetOverrides.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** | 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_insertion_order_history_change_data_capture** +> PageOfInsertionOrderHistoryChangeDataCapture get_insertion_order_history_change_data_capture(insertion_order_id) + + + +Gets the balance's historical data change capture. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.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. +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + 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_insertion_order_history_change_data_capture(insertion_order_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as 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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_insertion_order_history_change_data_capture: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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 + +[**PageOfInsertionOrderHistoryChangeDataCapture**](PageOfInsertionOrderHistoryChangeDataCapture.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** | 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_line_item_budget_overrides** +> ValueResourceOutcomeOfLineItemBudgetOverrides get_line_item_budget_overrides(line_item_id) + + + +Gets a collection of monthly and daily budget overrides for the provided line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.value_resource_outcome_of_line_item_budget_overrides import ValueResourceOutcomeOfLineItemBudgetOverrides +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + line_item_id = "lineItemId_example" # str | The line item id to get budget overrides for. + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_line_item_budget_overrides(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->get_line_item_budget_overrides: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item id to get budget overrides for. | + +### Return type + +[**ValueResourceOutcomeOfLineItemBudgetOverrides**](ValueResourceOutcomeOfLineItemBudgetOverrides.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** | 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) + +# **patch_api_v1_external_account_by_account_id_and_balance_id** +> BalanceResponse patch_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id) + + + +Modify a balance for the given account id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.update_balance_model_request import UpdateBalanceModelRequest +from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The account of the balance + balance_id = "balanceId_example" # str | The balance to change the dates + update_balance_model_request = UpdateBalanceModelRequest( + data=ResourceOfUpdateBalanceModel( + attributes=ExternalUpdateBalanceModel( + name="name_example", + po_number="po_number_example", + sales_force_id="sales_force_id_example", + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + memo="memo_example", + ), + id="id_example", + type="type_example", + ), + ) # UpdateBalanceModelRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.patch_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->patch_api_v1_external_account_by_account_id_and_balance_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.patch_api_v1_external_account_by_account_id_and_balance_id(account_id, balance_id, update_balance_model_request=update_balance_model_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->patch_api_v1_external_account_by_account_id_and_balance_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The account of the balance | + **balance_id** | **str**| The balance to change the dates | + **update_balance_model_request** | [**UpdateBalanceModelRequest**](UpdateBalanceModelRequest.md)| | [optional] + +### Return type + +[**BalanceResponse**](BalanceResponse.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** | 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) + +# **post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id** +> KeywordTarget202110Response post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id(line_item_id) + + + +This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_request import KeywordTarget202110Request +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_response import KeywordTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + keyword_target202110_request = KeywordTarget202110Request( + data=ValueTypeResourceOfKeywordTarget202110( + type="type_example", + attributes=ExternalKeywordTarget202110( + keywords={ + "unknown": "unknown", + }, + ), + ), + ) # KeywordTarget202110Request | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id(line_item_id, keyword_target202110_request=keyword_target202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_auction_line_item_targeting_keywords_append_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **keyword_target202110_request** | [**KeywordTarget202110Request**](KeywordTarget202110Request.md)| | [optional] + +### Return type + +[**KeywordTarget202110Response**](KeywordTarget202110Response.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** | 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) + +# **post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id** +> KeywordTarget202110Response post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id(line_item_id) + + + +This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_request import KeywordTarget202110Request +from criteo_api_retailmedia_v2024_04.model.keyword_target202110_response import KeywordTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + keyword_target202110_request = KeywordTarget202110Request( + data=ValueTypeResourceOfKeywordTarget202110( + type="type_example", + attributes=ExternalKeywordTarget202110( + keywords={ + "unknown": "unknown", + }, + ), + ), + ) # KeywordTarget202110Request | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id(line_item_id, keyword_target202110_request=keyword_target202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_auction_line_item_targeting_keywords_delete_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **keyword_target202110_request** | [**KeywordTarget202110Request**](KeywordTarget202110Request.md)| | [optional] + +### Return type + +[**KeywordTarget202110Response**](KeywordTarget202110Response.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** | 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) + +# **post_api202110_external_balance_campaigns_append_by_balance_id** +> BalanceCampaign202110PagedListResponse post_api202110_external_balance_campaigns_append_by_balance_id(balance_id) + + + +appends one or more campaigns to the specified balance + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_list_request import BalanceCampaign202110ListRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + balance_id = "balance-id_example" # str | The balance to add campaigns from + balance_campaign202110_list_request = BalanceCampaign202110ListRequest( + data=[ + ResourceOfBalanceCampaign202110( + id="id_example", + type="type_example", + attributes={}, + ), + ], + ) # BalanceCampaign202110ListRequest | The campaigns to append (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_balance_campaigns_append_by_balance_id(balance_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_balance_campaigns_append_by_balance_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_balance_campaigns_append_by_balance_id(balance_id, balance_campaign202110_list_request=balance_campaign202110_list_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_balance_campaigns_append_by_balance_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **balance_id** | **str**| The balance to add campaigns from | + **balance_campaign202110_list_request** | [**BalanceCampaign202110ListRequest**](BalanceCampaign202110ListRequest.md)| The campaigns to append | [optional] + +### Return type + +[**BalanceCampaign202110PagedListResponse**](BalanceCampaign202110PagedListResponse.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** | 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) + +# **post_api202110_external_balance_campaigns_delete_by_balance_id** +> BalanceCampaign202110PagedListResponse post_api202110_external_balance_campaigns_delete_by_balance_id(balance_id) + + + +Removes one or more campaigns on the specified balance + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_list_request import BalanceCampaign202110ListRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + balance_id = "balance-id_example" # str | The balance to remove campaigns from + balance_campaign202110_list_request = BalanceCampaign202110ListRequest( + data=[ + ResourceOfBalanceCampaign202110( + id="id_example", + type="type_example", + attributes={}, + ), + ], + ) # BalanceCampaign202110ListRequest | The campaigns to append (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_balance_campaigns_delete_by_balance_id(balance_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_balance_campaigns_delete_by_balance_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_balance_campaigns_delete_by_balance_id(balance_id, balance_campaign202110_list_request=balance_campaign202110_list_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_balance_campaigns_delete_by_balance_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **balance_id** | **str**| The balance to remove campaigns from | + **balance_campaign202110_list_request** | [**BalanceCampaign202110ListRequest**](BalanceCampaign202110ListRequest.md)| The campaigns to append | [optional] + +### Return type + +[**BalanceCampaign202110PagedListResponse**](BalanceCampaign202110PagedListResponse.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** | 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) + +# **post_api202110_external_campaign_preferred_line_items_by_campaign_id** +> PreferredLineItem202110Response post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id) + + + +Creates a new preferred line item with the specified settings + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.preferred_line_item_create_model202110_request import PreferredLineItemCreateModel202110Request +from criteo_api_retailmedia_v2024_04.model.preferred_line_item202110_response import PreferredLineItem202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + campaign_id = "campaign-id_example" # str | The given campaign id + preferred_line_item_create_model202110_request = PreferredLineItemCreateModel202110Request( + data=InputResourceOfPreferredLineItemCreateModel202110( + type="type_example", + attributes=ExternalPreferredLineItemCreateModel202110( + name="name_example", + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + status="unknown", + pacing="unknown", + capping=ExternalLineItemCapping202110( + type="unknown", + count=1, + ), + page=ExternalLineItemPage202110( + page_type="search", + categories=[ + ExternalLineItemPageCategory202110( + category_id="category_id_example", + include_children=True, + ), + ], + search_keywords=[ + "search_keywords_example", + ], + ), + target_retailer_id="target_retailer_id_example", + budget=3.14, + creative_id="creative_id_example", + ), + ), + ) # PreferredLineItemCreateModel202110Request | The line item settings to create a line item with (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_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.post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, preferred_line_item_create_model202110_request=preferred_line_item_create_model202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_id** | **str**| The given campaign id | + **preferred_line_item_create_model202110_request** | [**PreferredLineItemCreateModel202110Request**](PreferredLineItemCreateModel202110Request.md)| The line item settings to create a line item with | [optional] + +### Return type + +[**PreferredLineItem202110Response**](PreferredLineItem202110Response.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 | +|-------------|-------------|------------------| +**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) + +# **post_api202110_external_line_item_products_append_by_line_item_id** +> PromotedProduct202110PagedListResponse post_api202110_external_line_item_products_append_by_line_item_id(line_item_id) + + + +This endpoint appends one or more products to promote on the specified line item. The resulting state of the line item is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + promoted_product202110_list_request = PromotedProduct202110ListRequest( + data=[ + ResourceOfPromotedProduct202110( + id="id_example", + type="type_example", + attributes=ExternalPromotedProduct202110( + bid_override=3.14, + ), + ), + ], + ) # PromotedProduct202110ListRequest | the products to append to this line item (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_line_item_products_append_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_line_item_products_append_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_line_item_products_append_by_line_item_id(line_item_id, promoted_product202110_list_request=promoted_product202110_list_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_line_item_products_append_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **promoted_product202110_list_request** | [**PromotedProduct202110ListRequest**](PromotedProduct202110ListRequest.md)| the products to append to this line item | [optional] + +### Return type + +[**PromotedProduct202110PagedListResponse**](PromotedProduct202110PagedListResponse.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** | 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) + +# **post_api202110_external_line_item_products_delete_by_line_item_id** +> PromotedProduct202110PagedListResponse post_api202110_external_line_item_products_delete_by_line_item_id(line_item_id) + + + +This endpoint removes one or more products from promotion on the specified line item. The resulting state of the line item is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + promoted_product202110_list_request = PromotedProduct202110ListRequest( + data=[ + ResourceOfPromotedProduct202110( + id="id_example", + type="type_example", + attributes=ExternalPromotedProduct202110( + bid_override=3.14, + ), + ), + ], + ) # PromotedProduct202110ListRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_line_item_products_delete_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_line_item_products_delete_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_line_item_products_delete_by_line_item_id(line_item_id, promoted_product202110_list_request=promoted_product202110_list_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_line_item_products_delete_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **promoted_product202110_list_request** | [**PromotedProduct202110ListRequest**](PromotedProduct202110ListRequest.md)| | [optional] + +### Return type + +[**PromotedProduct202110PagedListResponse**](PromotedProduct202110PagedListResponse.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** | 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) + +# **post_api202110_external_line_item_products_pause_by_line_item_id** +> post_api202110_external_line_item_products_pause_by_line_item_id(line_item_id) + + + +This endpoint pauses one or more promoted products on a specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with. + promoted_product202110_list_request = PromotedProduct202110ListRequest( + data=[ + ResourceOfPromotedProduct202110( + id="id_example", + type="type_example", + attributes=ExternalPromotedProduct202110( + bid_override=3.14, + ), + ), + ], + ) # PromotedProduct202110ListRequest | The products from which their IDs will be used to pause. (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.post_api202110_external_line_item_products_pause_by_line_item_id(line_item_id) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_line_item_products_pause_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.post_api202110_external_line_item_products_pause_by_line_item_id(line_item_id, promoted_product202110_list_request=promoted_product202110_list_request) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_line_item_products_pause_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with. | + **promoted_product202110_list_request** | [**PromotedProduct202110ListRequest**](PromotedProduct202110ListRequest.md)| The products from which their IDs will be used to pause. | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### 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) + +# **post_api202110_external_line_item_products_unpause_by_line_item_id** +> post_api202110_external_line_item_products_unpause_by_line_item_id(line_item_id) + + + +This endpoint unpauses one or more promoted products on a specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with. + promoted_product202110_list_request = PromotedProduct202110ListRequest( + data=[ + ResourceOfPromotedProduct202110( + id="id_example", + type="type_example", + attributes=ExternalPromotedProduct202110( + bid_override=3.14, + ), + ), + ], + ) # PromotedProduct202110ListRequest | The products from which their IDs will be used to unpause. (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.post_api202110_external_line_item_products_unpause_by_line_item_id(line_item_id) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_line_item_products_unpause_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.post_api202110_external_line_item_products_unpause_by_line_item_id(line_item_id, promoted_product202110_list_request=promoted_product202110_list_request) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_line_item_products_unpause_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with. | + **promoted_product202110_list_request** | [**PromotedProduct202110ListRequest**](PromotedProduct202110ListRequest.md)| The products from which their IDs will be used to unpause. | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### 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) + +# **post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id** +> AddToBasketTarget202110Response post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id(line_item_id) + + + +This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_response import AddToBasketTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + add_to_basket_ids_update_model202110_request = AddToBasketIdsUpdateModel202110Request( + data=ValueTypeResourceOfAddToBasketIdsUpdateModel202110( + type="type_example", + attributes=ExternalAddToBasketIdsUpdateModel202110( + product_ids=[ + "product_ids_example", + ], + category_ids=[ + "category_ids_example", + ], + ), + ), + ) # AddToBasketIdsUpdateModel202110Request | Ids to append to the target (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id(line_item_id, add_to_basket_ids_update_model202110_request=add_to_basket_ids_update_model202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_add_to_basket_append_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **add_to_basket_ids_update_model202110_request** | [**AddToBasketIdsUpdateModel202110Request**](AddToBasketIdsUpdateModel202110Request.md)| Ids to append to the target | [optional] + +### Return type + +[**AddToBasketTarget202110Response**](AddToBasketTarget202110Response.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** | 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) + +# **post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id** +> AddToBasketTarget202110Response post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id(line_item_id) + + + +This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.add_to_basket_ids_update_model202110_request import AddToBasketIdsUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_response import AddToBasketTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + add_to_basket_ids_update_model202110_request = AddToBasketIdsUpdateModel202110Request( + data=ValueTypeResourceOfAddToBasketIdsUpdateModel202110( + type="type_example", + attributes=ExternalAddToBasketIdsUpdateModel202110( + product_ids=[ + "product_ids_example", + ], + category_ids=[ + "category_ids_example", + ], + ), + ), + ) # AddToBasketIdsUpdateModel202110Request | Ids to remove from the target (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id(line_item_id, add_to_basket_ids_update_model202110_request=add_to_basket_ids_update_model202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_add_to_basket_delete_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **add_to_basket_ids_update_model202110_request** | [**AddToBasketIdsUpdateModel202110Request**](AddToBasketIdsUpdateModel202110Request.md)| Ids to remove from the target | [optional] + +### Return type + +[**AddToBasketTarget202110Response**](AddToBasketTarget202110Response.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** | 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) + +# **post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id** +> AudienceTarget202110Response post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id(line_item_id) + + + +This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.audience_target202110_response import AudienceTarget202110Response +from criteo_api_retailmedia_v2024_04.model.audience_ids_update_model202110_request import AudienceIdsUpdateModel202110Request +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + audience_ids_update_model202110_request = AudienceIdsUpdateModel202110Request( + data=ValueTypeResourceOfAudienceIdsUpdateModel202110( + type="type_example", + attributes=ExternalAudienceIdsUpdateModel202110( + audience_ids=[ + "audience_ids_example", + ], + ), + ), + ) # AudienceIdsUpdateModel202110Request | Audience ids to append to the target (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id(line_item_id, audience_ids_update_model202110_request=audience_ids_update_model202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_audiences_append_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **audience_ids_update_model202110_request** | [**AudienceIdsUpdateModel202110Request**](AudienceIdsUpdateModel202110Request.md)| Audience ids to append to the target | [optional] + +### Return type + +[**AudienceTarget202110Response**](AudienceTarget202110Response.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** | 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) + +# **post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id** +> AudienceTarget202110Response post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id(line_item_id) + + + +This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.audience_target202110_response import AudienceTarget202110Response +from criteo_api_retailmedia_v2024_04.model.audience_ids_update_model202110_request import AudienceIdsUpdateModel202110Request +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + audience_ids_update_model202110_request = AudienceIdsUpdateModel202110Request( + data=ValueTypeResourceOfAudienceIdsUpdateModel202110( + type="type_example", + attributes=ExternalAudienceIdsUpdateModel202110( + audience_ids=[ + "audience_ids_example", + ], + ), + ), + ) # AudienceIdsUpdateModel202110Request | Audience ids to remove from the target (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id(line_item_id, audience_ids_update_model202110_request=audience_ids_update_model202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_audiences_delete_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **audience_ids_update_model202110_request** | [**AudienceIdsUpdateModel202110Request**](AudienceIdsUpdateModel202110Request.md)| Audience ids to remove from the target | [optional] + +### Return type + +[**AudienceTarget202110Response**](AudienceTarget202110Response.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** | 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) + +# **post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id** +> StoreTarget202110Response post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id(line_item_id) + + + +This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.store_target202110_response import StoreTarget202110Response +from criteo_api_retailmedia_v2024_04.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + store_ids_update_model202110_request = StoreIdsUpdateModel202110Request( + data=ValueTypeResourceOfStoreIdsUpdateModel202110( + type="type_example", + attributes=ExternalStoreIdsUpdateModel202110( + store_ids=[ + "store_ids_example", + ], + ), + ), + ) # StoreIdsUpdateModel202110Request | Store ids to append to the target (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id(line_item_id, store_ids_update_model202110_request=store_ids_update_model202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_stores_append_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **store_ids_update_model202110_request** | [**StoreIdsUpdateModel202110Request**](StoreIdsUpdateModel202110Request.md)| Store ids to append to the target | [optional] + +### Return type + +[**StoreTarget202110Response**](StoreTarget202110Response.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** | 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) + +# **post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id** +> StoreTarget202110Response post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id(line_item_id) + + + +This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.store_target202110_response import StoreTarget202110Response +from criteo_api_retailmedia_v2024_04.model.store_ids_update_model202110_request import StoreIdsUpdateModel202110Request +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + store_ids_update_model202110_request = StoreIdsUpdateModel202110Request( + data=ValueTypeResourceOfStoreIdsUpdateModel202110( + type="type_example", + attributes=ExternalStoreIdsUpdateModel202110( + store_ids=[ + "store_ids_example", + ], + ), + ), + ) # StoreIdsUpdateModel202110Request | Store ids to remove from the target (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id(line_item_id, store_ids_update_model202110_request=store_ids_update_model202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202110_external_preferred_line_item_targeting_stores_delete_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **store_ids_update_model202110_request** | [**StoreIdsUpdateModel202110Request**](StoreIdsUpdateModel202110Request.md)| Store ids to remove from the target | [optional] + +### Return type + +[**StoreTarget202110Response**](StoreTarget202110Response.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** | 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) + +# **post_api202210_external_account_creatives_by_account_id** +> Creative202210Response post_api202210_external_account_creatives_by_account_id(account_id) + + + +Create a creative for an account + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.creative_create_model202207 import CreativeCreateModel202207 +from criteo_api_retailmedia_v2024_04.model.creative202210_response import Creative202210Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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", + ), + choice_variable_value=ChoiceVariableValue( + chosen_options=[ + "chosen_options_example", + ], + ), + color_variable_value=ColorVariableValue( + color="#2EC", + ), + files_variable_value=FilesVariableValue( + asset_ids=[ + "asset_ids_example", + ], + ), + hyperlink_variable_value=HyperlinkVariableValue( + url="url_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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202210_external_account_creatives_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_by_account_id(account_id, creative_create_model202207=creative_create_model202207) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202210_external_account_creatives_by_account_id: %s\n" % e) +``` + + +### Parameters + +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] + +### Return type + +[**Creative202210Response**](Creative202210Response.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 | +|-------------|-------------|------------------| +**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_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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_v2024_04.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_v2024_04.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 | - | + +[[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_api202301_external_account_campaigns_by_account_id** +> JsonApiSingleResponseOfCampaignV202301 post_api202301_external_account_campaigns_by_account_id(account_id) + + + +Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.post_campaign_v202301 import PostCampaignV202301 +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The account to request the campaign for. + post_campaign_v202301 = PostCampaignV202301( + data=JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301( + type="type_example", + attributes=CampaignAttributesV202301( + type="auction", + drawable_balance_ids=[ + "drawable_balance_ids_example", + ], + click_attribution_window="30D", + view_attribution_window="None", + name="name_example", + budget=3.14, + monthly_pacing=3.14, + daily_pacing=3.14, + is_auto_daily_pacing=True, + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + click_attribution_scope="unknown", + view_attribution_scope="unknown", + company_name="company_name_example", + ), + ), + ) # PostCampaignV202301 | Creatable campaign attributes (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api202301_external_account_campaigns_by_account_id(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202301_external_account_campaigns_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_api202301_external_account_campaigns_by_account_id(account_id, post_campaign_v202301=post_campaign_v202301) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api202301_external_account_campaigns_by_account_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The account to request the campaign for. | + **post_campaign_v202301** | [**PostCampaignV202301**](PostCampaignV202301.md)| Creatable campaign attributes | [optional] + +### Return type + +[**JsonApiSingleResponseOfCampaignV202301**](JsonApiSingleResponseOfCampaignV202301.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 | +|-------------|-------------|------------------| +**201** | 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) + +# **post_api_v1_external_account_add_funds_by_account_id_and_balance_id** +> BalanceResponse post_api_v1_external_account_add_funds_by_account_id_and_balance_id(account_id, balance_id) + + + +Add funds to a balance for the given account id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.add_funds_to_balance_request import AddFundsToBalanceRequest +from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The account of the balance + balance_id = "balanceId_example" # str | The balance to add funds to + add_funds_to_balance_request = AddFundsToBalanceRequest( + data=ResourceOfAddFundsToBalance( + attributes=ExternalAddFundsToBalance( + delta_amount=3.14, + po_number="po_number_example", + memo="memo_example", + ), + id="id_example", + type="type_example", + ), + ) # AddFundsToBalanceRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api_v1_external_account_add_funds_by_account_id_and_balance_id(account_id, balance_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v1_external_account_add_funds_by_account_id_and_balance_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_v1_external_account_add_funds_by_account_id_and_balance_id(account_id, balance_id, add_funds_to_balance_request=add_funds_to_balance_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v1_external_account_add_funds_by_account_id_and_balance_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The account of the balance | + **balance_id** | **str**| The balance to add funds to | + **add_funds_to_balance_request** | [**AddFundsToBalanceRequest**](AddFundsToBalanceRequest.md)| | [optional] + +### Return type + +[**BalanceResponse**](BalanceResponse.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** | 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) + +# **post_api_v1_external_account_balances_by_account_id** +> BalanceResponse post_api_v1_external_account_balances_by_account_id(account_id) + + + +Create balance for the given account id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.create_balance_request import CreateBalanceRequest +from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The account to create balances for + create_balance_request = CreateBalanceRequest( + data=ResourceOfCreateBalance( + attributes=ExternalCreateBalance( + name="name_example", + po_number="po_number_example", + deposited=3.14, + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + spend_type="Onsite", + memo="memo_example", + sales_force_id="sales_force_id_example", + ), + id="id_example", + type="type_example", + ), + ) # CreateBalanceRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api_v1_external_account_balances_by_account_id(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v1_external_account_balances_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_v1_external_account_balances_by_account_id(account_id, create_balance_request=create_balance_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v1_external_account_balances_by_account_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The account to create balances for | + **create_balance_request** | [**CreateBalanceRequest**](CreateBalanceRequest.md)| | [optional] + +### Return type + +[**BalanceResponse**](BalanceResponse.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 | +|-------------|-------------|------------------| +**201** | 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) + +# **post_api_v1_external_account_catalogs_by_account_id** +> JsonApiSingleResponseOfCatalogStatus post_api_v1_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_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.json_api_request_of_catalog_request import JsonApiRequestOfCatalogRequest +from criteo_api_retailmedia_v2024_04.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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 = JsonApiRequestOfCatalogRequest( + data=JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest( + type="type_example", + attributes=ExternalCatalogRequest( + format="json-newline", + brand_id_filter=[ + "brand_id_filter_example", + ], + ), + ), + ) # JsonApiRequestOfCatalogRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api_v1_external_account_catalogs_by_account_id(account_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v1_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_v1_external_account_catalogs_by_account_id(account_id, json_api_request_of_catalog_request=json_api_request_of_catalog_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v1_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** | [**JsonApiRequestOfCatalogRequest**](JsonApiRequestOfCatalogRequest.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_account_change_dates_by_account_id_and_balance_id** +> BalanceResponse post_api_v1_external_account_change_dates_by_account_id_and_balance_id(account_id, balance_id) + + + +Change dates of a balance for the given account id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.change_dates_of_balance_request import ChangeDatesOfBalanceRequest +from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The account of the balance + balance_id = "balanceId_example" # str | The balance to change the dates + change_dates_of_balance_request = ChangeDatesOfBalanceRequest( + data=ResourceOfChangeDatesOfBalance( + attributes=ExternalChangeDatesOfBalance( + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + memo="memo_example", + ), + id="id_example", + type="type_example", + ), + ) # ChangeDatesOfBalanceRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api_v1_external_account_change_dates_by_account_id_and_balance_id(account_id, balance_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v1_external_account_change_dates_by_account_id_and_balance_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_v1_external_account_change_dates_by_account_id_and_balance_id(account_id, balance_id, change_dates_of_balance_request=change_dates_of_balance_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v1_external_account_change_dates_by_account_id_and_balance_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| The account of the balance | + **balance_id** | **str**| The balance to change the dates | + **change_dates_of_balance_request** | [**ChangeDatesOfBalanceRequest**](ChangeDatesOfBalanceRequest.md)| | [optional] + +### Return type + +[**BalanceResponse**](BalanceResponse.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** | 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) + +# **post_api_v2_external_campaign_auction_line_items_by_campaign_id** +> AuctionLineItemResponse post_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id) + + + +Creates new auction line item with the specified settings + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.auction_line_item_create_model_request import AuctionLineItemCreateModelRequest +from criteo_api_retailmedia_v2024_04.model.auction_line_item_response import AuctionLineItemResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + campaign_id = "campaign-id_example" # str | The given campaign id + auction_line_item_create_model_request = AuctionLineItemCreateModelRequest( + data=InputResourceOfAuctionLineItemCreateModel( + type="type_example", + attributes=ExternalAuctionLineItemCreateModel( + name="name_example", + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + status="unknown", + target_retailer_id="target_retailer_id_example", + budget=3.14, + target_bid=3.14, + max_bid=3.14, + monthly_pacing=3.14, + daily_pacing=3.14, + is_auto_daily_pacing=False, + bid_strategy="conversion", + ), + ), + ) # AuctionLineItemCreateModelRequest | The line item settings to create a line item with (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v2_external_campaign_auction_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.post_api_v2_external_campaign_auction_line_items_by_campaign_id(campaign_id, auction_line_item_create_model_request=auction_line_item_create_model_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->post_api_v2_external_campaign_auction_line_items_by_campaign_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_id** | **str**| The given campaign id | + **auction_line_item_create_model_request** | [**AuctionLineItemCreateModelRequest**](AuctionLineItemCreateModelRequest.md)| The line item settings to create a line item with | [optional] + +### Return type + +[**AuctionLineItemResponse**](AuctionLineItemResponse.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 | +|-------------|-------------|------------------| +**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) + +# **put_api202110_external_preferred_line_item_by_line_item_id** +> PreferredLineItem202110Response put_api202110_external_preferred_line_item_by_line_item_id(line_item_id) + + + +Updates the preferred line item for the given line item id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request +from criteo_api_retailmedia_v2024_04.model.preferred_line_item202110_response import PreferredLineItem202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The given line item id + preferred_line_item_update_model202110_request = PreferredLineItemUpdateModel202110Request( + data=ResourceOfPreferredLineItemUpdateModel202110( + id="id_example", + type="type_example", + attributes=ExternalPreferredLineItemUpdateModel202110( + name="name_example", + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + status="unknown", + pacing="accelerated", + capping=ExternalLineItemCapping202110( + type="unknown", + count=1, + ), + page=ExternalLineItemPage202110( + page_type="search", + categories=[ + ExternalLineItemPageCategory202110( + category_id="category_id_example", + include_children=True, + ), + ], + search_keywords=[ + "search_keywords_example", + ], + ), + budget=3.14, + creative_id="creative_id_example", + ), + ), + ) # PreferredLineItemUpdateModel202110Request | The line item settings to create a line item with (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.put_api202110_external_preferred_line_item_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.put_api202110_external_preferred_line_item_by_line_item_id(line_item_id, preferred_line_item_update_model202110_request=preferred_line_item_update_model202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The given line item id | + **preferred_line_item_update_model202110_request** | [**PreferredLineItemUpdateModel202110Request**](PreferredLineItemUpdateModel202110Request.md)| The line item settings to create a line item with | [optional] + +### Return type + +[**PreferredLineItem202110Response**](PreferredLineItem202110Response.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** | 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) + +# **put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id** +> AddToBasketTarget202110Response put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id) + + + +This endpoint sets the scope of the add to basket target on the specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_request import AddToBasketTarget202110Request +from criteo_api_retailmedia_v2024_04.model.add_to_basket_target202110_response import AddToBasketTarget202110Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + add_to_basket_target202110_request = AddToBasketTarget202110Request( + data=ValueTypeResourceOfAddToBasketTarget202110( + type="type_example", + attributes=ExternalAddToBasketTarget202110( + scope="unknown", + product_ids=[ + "product_ids_example", + ], + category_ids=[ + "category_ids_example", + ], + ), + ), + ) # AddToBasketTarget202110Request | The add to basket target to set the scope for (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id(line_item_id, add_to_basket_target202110_request=add_to_basket_target202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_add_to_basket_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **add_to_basket_target202110_request** | [**AddToBasketTarget202110Request**](AddToBasketTarget202110Request.md)| The add to basket target to set the scope for | [optional] + +### Return type + +[**AddToBasketTarget202110Response**](AddToBasketTarget202110Response.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** | 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) + +# **put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id** +> AudienceTarget202110Response put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id) + + + +This endpoint sets the scope of the audience target on the specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.audience_target202110_response import AudienceTarget202110Response +from criteo_api_retailmedia_v2024_04.model.audience_target202110_request import AudienceTarget202110Request +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + audience_target202110_request = AudienceTarget202110Request( + data=ValueTypeResourceOfAudienceTarget202110( + type="type_example", + attributes=ExternalAudienceTarget202110( + scope="unknown", + audience_ids=[ + "audience_ids_example", + ], + ), + ), + ) # AudienceTarget202110Request | The audience target to set the scope for (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id(line_item_id, audience_target202110_request=audience_target202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_audiences_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **audience_target202110_request** | [**AudienceTarget202110Request**](AudienceTarget202110Request.md)| The audience target to set the scope for | [optional] + +### Return type + +[**AudienceTarget202110Response**](AudienceTarget202110Response.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** | 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) + +# **put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id** +> StoreTarget202110Response put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id) + + + +This endpoint sets the scope of the store target on the specified line item. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.store_target202110_response import StoreTarget202110Response +from criteo_api_retailmedia_v2024_04.model.store_target202110_request import StoreTarget202110Request +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The line item to interact with + store_target202110_request = StoreTarget202110Request( + data=ValueTypeResourceOfStoreTarget202110( + type="type_example", + attributes=ExternalStoreTarget202110( + scope="unknown", + store_ids=[ + "store_ids_example", + ], + ), + ), + ) # StoreTarget202110Request | The store target to set the scope for (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id(line_item_id, store_target202110_request=store_target202110_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202110_external_preferred_line_item_targeting_stores_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The line item to interact with | + **store_target202110_request** | [**StoreTarget202110Request**](StoreTarget202110Request.md)| The store target to set the scope for | [optional] + +### Return type + +[**StoreTarget202110Response**](StoreTarget202110Response.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** | 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) + +# **put_api202210_external_account_by_account_id_creativescreative_id** +> Creative202210Response put_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id) + + + +Update a creative + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.creative_update_model202207 import CreativeUpdateModel202207 +from criteo_api_retailmedia_v2024_04.model.creative202210_response import Creative202210Response +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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", + ), + choice_variable_value=ChoiceVariableValue( + chosen_options=[ + "chosen_options_example", + ], + ), + color_variable_value=ColorVariableValue( + color="#2EC", + ), + files_variable_value=FilesVariableValue( + asset_ids=[ + "asset_ids_example", + ], + ), + hyperlink_variable_value=HyperlinkVariableValue( + url="url_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_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202210_external_account_by_account_id_creativescreative_id: %s\n" % e) + + # 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) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202210_external_account_by_account_id_creativescreative_id: %s\n" % e) +``` + + +### Parameters + +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] + +### Return type + +[**Creative202210Response**](Creative202210Response.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** | Success | - | +**204** | Creative updated | - | + +[[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_api202301_external_campaign_by_campaign_id** +> JsonApiSingleResponseOfCampaignV202301 put_api202301_external_campaign_by_campaign_id(campaign_id) + + + +Edit a campaign for the given campaign id with a given editable attributes. This will return updated creatable and editable attributes of the campaign as the result of the operation. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.put_campaign_v202301 import PutCampaignV202301 +from criteo_api_retailmedia_v2024_04.model.json_api_single_response_of_campaign_v202301 import JsonApiSingleResponseOfCampaignV202301 +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + campaign_id = "campaignId_example" # str | Campaign Id of the updating campaign + put_campaign_v202301 = PutCampaignV202301( + data=JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301( + id="id_example", + type="type_example", + attributes=EditableCampaignAttributesV202301( + name="name_example", + budget=3.14, + monthly_pacing=3.14, + daily_pacing=3.14, + is_auto_daily_pacing=True, + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + end_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + click_attribution_window="7D", + view_attribution_window="None", + click_attribution_scope="unknown", + view_attribution_scope="unknown", + company_name="company_name_example", + ), + ), + ) # PutCampaignV202301 | Editable campaign attributes (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.put_api202301_external_campaign_by_campaign_id(campaign_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202301_external_campaign_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.put_api202301_external_campaign_by_campaign_id(campaign_id, put_campaign_v202301=put_campaign_v202301) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202301_external_campaign_by_campaign_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_id** | **str**| Campaign Id of the updating campaign | + **put_campaign_v202301** | [**PutCampaignV202301**](PutCampaignV202301.md)| Editable campaign attributes | [optional] + +### Return type + +[**JsonApiSingleResponseOfCampaignV202301**](JsonApiSingleResponseOfCampaignV202301.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** | 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) + +# **put_api202301_external_line_item_bid_multipliers_by_line_item_id** +> LineItemBidMultipliersResponse put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) + + + +Replace bid multipliers on a line item + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse +from criteo_api_retailmedia_v2024_04.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 + line_item_bid_multipliers_request = LineItemBidMultipliersRequest( + data=ResourceOfLineItemBidMultipliers( + attributes=LineItemBidMultipliers( + search=3.14, + homepage=3.14, + categories=3.14, + product_detail=3.14, + confirmation=3.14, + merchandising=3.14, + deals=3.14, + checkout=3.14, + ), + id="id_example", + type="type_example", + ), + ) # LineItemBidMultipliersRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id, line_item_bid_multipliers_request=line_item_bid_multipliers_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| Long external id of the associated line item | + **line_item_bid_multipliers_request** | [**LineItemBidMultipliersRequest**](LineItemBidMultipliersRequest.md)| | [optional] + +### Return type + +[**LineItemBidMultipliersResponse**](LineItemBidMultipliersResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: text/plain, application/json, text/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) + +# **put_api_v2_external_auction_line_item_by_line_item_id** +> AuctionLineItemResponse put_api_v2_external_auction_line_item_by_line_item_id(line_item_id) + + + +Updates the auction line item for the given line item id + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.auction_line_item_update_model_request import AuctionLineItemUpdateModelRequest +from criteo_api_retailmedia_v2024_04.model.auction_line_item_response import AuctionLineItemResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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 | The given line item id + auction_line_item_update_model_request = AuctionLineItemUpdateModelRequest( + data=ResourceOfAuctionLineItemUpdateModel( + id="id_example", + type="type_example", + attributes=ExternalAuctionLineItemUpdateModel( + name="name_example", + start_date=dateutil_parser('1970-01-01').date(), + end_date=dateutil_parser('1970-01-01').date(), + status="unknown", + budget=3.14, + target_bid=3.14, + max_bid=3.14, + monthly_pacing=3.14, + daily_pacing=3.14, + is_auto_daily_pacing=True, + bid_strategy="conversion", + ), + ), + ) # AuctionLineItemUpdateModelRequest | The line item settings to create a line item with (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.put_api_v2_external_auction_line_item_by_line_item_id(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api_v2_external_auction_line_item_by_line_item_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.put_api_v2_external_auction_line_item_by_line_item_id(line_item_id, auction_line_item_update_model_request=auction_line_item_update_model_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->put_api_v2_external_auction_line_item_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| The given line item id | + **auction_line_item_update_model_request** | [**AuctionLineItemUpdateModelRequest**](AuctionLineItemUpdateModelRequest.md)| The line item settings to create a line item with | [optional] + +### Return type + +[**AuctionLineItemResponse**](AuctionLineItemResponse.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** | 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) + +# **set_keyword_bids** +> ResourceOutcome set_keyword_bids(id) + + + +Set bid overrides for associated keywords to the given line item in bulk + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_v2024_04.model.resource_outcome import ResourceOutcome +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + id = "id_example" # str | ID of the line item + set_bids_model_request = SetBidsModelRequest( + data=SetBidsModelResource( + id="id_example", + type="type_example", + attributes=SetBidsModel( + keywords=[ + SetBidModel( + phrase="phrase_example", + bid=3.14, + ), + ], + ), + ), + ) # SetBidsModelRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.set_keyword_bids(id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->set_keyword_bids: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.set_keyword_bids(id, set_bids_model_request=set_bids_model_request) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->set_keyword_bids: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the line item | + **set_bids_model_request** | [**SetBidsModelRequest**](SetBidsModelRequest.md)| | [optional] + +### Return type + +[**ResourceOutcome**](ResourceOutcome.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** | 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) + +# **submit_proposal** +> ProposalStatusModelResponse submit_proposal(id) + + + +Only the components of the Line Item that are in a valid state will be reviewed. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_v2024_04.model.resource_outcome import ResourceOutcome +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + id = "id_example" # str | ID of the line item + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.submit_proposal(id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->submit_proposal: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the line item | + +### Return type + +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.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** | 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) + +# **update_campaign_budget_overrides** +> ValueResourceOutcomeOfCampaignBudgetOverrides update_campaign_budget_overrides(campaign_id) + + + +Update campaign budget overrides by given external campaign id and new campaign budget overrides settings. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_campaign_budget_overrides import ValueResourceInputOfCampaignBudgetOverrides +from criteo_api_retailmedia_v2024_04.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. +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.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. + value_resource_input_of_campaign_budget_overrides = ValueResourceInputOfCampaignBudgetOverrides( + data=ValueResourceOfCampaignBudgetOverrides( + type="type_example", + attributes=CampaignBudgetOverrides( + monthly_budget_overrides=[ + CampaignMonthlyBudgetOverride( + start_month=dateutil_parser('1970-01-01T00:00:00.00Z'), + duration="duration_example", + max_monthly_spend=3.14, + status="Expired", + ), + ], + daily_budget_overrides=[ + CampaignDailyBudgetOverride( + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + duration="duration_example", + max_daily_spend=3.14, + status="Expired", + ), + ], + ), + ), + ) # ValueResourceInputOfCampaignBudgetOverrides | New campaign budget overrides settings value resource input. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_campaign_budget_overrides(campaign_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->update_campaign_budget_overrides: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_campaign_budget_overrides(campaign_id, value_resource_input_of_campaign_budget_overrides=value_resource_input_of_campaign_budget_overrides) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->update_campaign_budget_overrides: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_id** | **int**| External campaign id. | + **value_resource_input_of_campaign_budget_overrides** | [**ValueResourceInputOfCampaignBudgetOverrides**](ValueResourceInputOfCampaignBudgetOverrides.md)| New campaign budget overrides settings value resource input. | [optional] + +### Return type + +[**ValueResourceOutcomeOfCampaignBudgetOverrides**](ValueResourceOutcomeOfCampaignBudgetOverrides.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 | +|-------------|-------------|------------------| +**201** | 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) + +# **update_line_item_budget_overrides** +> ValueResourceOutcomeOfLineItemBudgetOverrides update_line_item_budget_overrides(line_item_id) + + + +Update line item budget overrides by given external line item id and new line item budget overrides settings. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import campaign_api +from criteo_api_retailmedia_v2024_04.model.value_resource_outcome_of_line_item_budget_overrides import ValueResourceOutcomeOfLineItemBudgetOverrides +from criteo_api_retailmedia_v2024_04.model.value_resource_input_of_line_item_budget_overrides import ValueResourceInputOfLineItemBudgetOverrides +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = campaign_api.CampaignApi(api_client) + line_item_id = "lineItemId_example" # str | Line item external id. + value_resource_input_of_line_item_budget_overrides = ValueResourceInputOfLineItemBudgetOverrides( + data=ValueResourceOfLineItemBudgetOverrides( + type="type_example", + attributes=LineItemBudgetOverrides( + monthly_line_item_budget_overrides=[ + MonthlyLineItemBudegetOverride( + start_month=dateutil_parser('1970-01-01T00:00:00.00Z'), + duration="duration_example", + max_monthly_spend=3.14, + status="Expired", + ), + ], + daily_line_item_budget_overrides=[ + DailyLineItemBudgetOverride( + start_date=dateutil_parser('1970-01-01T00:00:00.00Z'), + duration="duration_example", + max_daily_spend=3.14, + status="Expired", + ), + ], + ), + ), + ) # ValueResourceInputOfLineItemBudgetOverrides | New line item budget overrides settings value resource input. (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_line_item_budget_overrides(line_item_id) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->update_line_item_budget_overrides: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.update_line_item_budget_overrides(line_item_id, value_resource_input_of_line_item_budget_overrides=value_resource_input_of_line_item_budget_overrides) + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling CampaignApi->update_line_item_budget_overrides: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| Line item external id. | + **value_resource_input_of_line_item_budget_overrides** | [**ValueResourceInputOfLineItemBudgetOverrides**](ValueResourceInputOfLineItemBudgetOverrides.md)| New line item budget overrides settings value resource input. | [optional] + +### Return type + +[**ValueResourceOutcomeOfLineItemBudgetOverrides**](ValueResourceOutcomeOfLineItemBudgetOverrides.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 | +|-------------|-------------|------------------| +**201** | 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) + diff --git a/sdks/retailmedia_2023-01/docs/CampaignAttributesV202301.md b/sdks/retailmedia_2024-04/docs/CampaignAttributesV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/CampaignAttributesV202301.md rename to sdks/retailmedia_2024-04/docs/CampaignAttributesV202301.md diff --git a/sdks/retailmedia_2024-04/docs/CampaignBudgetOverrides.md b/sdks/retailmedia_2024-04/docs/CampaignBudgetOverrides.md new file mode 100644 index 00000000..14912f71 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/CampaignBudgetOverrides.md @@ -0,0 +1,13 @@ +# CampaignBudgetOverrides + +Campaign budget overrides including Monthly and Daily budget overrides. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**monthly_budget_overrides** | [**[CampaignMonthlyBudgetOverride]**](CampaignMonthlyBudgetOverride.md) | Campaign budget override monthly part, chronological order restricted. | +**daily_budget_overrides** | [**[CampaignDailyBudgetOverride]**](CampaignDailyBudgetOverride.md) | Campaign budget override daily part, chronological order restricted. | + +[[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_2024-04/docs/CampaignDailyBudgetOverride.md b/sdks/retailmedia_2024-04/docs/CampaignDailyBudgetOverride.md new file mode 100644 index 00000000..b544ef9a --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/CampaignDailyBudgetOverride.md @@ -0,0 +1,15 @@ +# CampaignDailyBudgetOverride + +Campaign daily budget override. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration** | **str** | The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'. | +**max_daily_spend** | **float** | Daily budget override maximum daily spend amount. | +**start_date** | **datetime, none_type** | Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence. | [optional] +**status** | **str, none_type** | Daily budget override computed status. | [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_2024-04/docs/CampaignMonthlyBudgetOverride.md b/sdks/retailmedia_2024-04/docs/CampaignMonthlyBudgetOverride.md new file mode 100644 index 00000000..53f223d9 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/CampaignMonthlyBudgetOverride.md @@ -0,0 +1,15 @@ +# CampaignMonthlyBudgetOverride + +Campaign monthly budget override. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration** | **str** | The number of MONTHs that the override is active from StartMonth, e.g. \"1M\". Must end with 'M' or 'm'. | +**max_monthly_spend** | **float** | Monthly budget override maximum monthly spend amount. | +**start_month** | **datetime, none_type** | Monthly budget override start month, format \"yyyy-MM\". If it is null, the StartMonth would be the following month of the last item in the override sequence. | [optional] +**status** | **str, none_type** | Monthly budget override computed status. | [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_2023-01/docs/CampaignV202301.md b/sdks/retailmedia_2024-04/docs/CampaignV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/CampaignV202301.md rename to sdks/retailmedia_2024-04/docs/CampaignV202301.md diff --git a/sdks/retailmedia_2023-01/docs/Category202204.md b/sdks/retailmedia_2024-04/docs/Category202204.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/Category202204.md rename to sdks/retailmedia_2024-04/docs/Category202204.md diff --git a/sdks/retailmedia_2023-01/docs/Category202204ListResponse.md b/sdks/retailmedia_2024-04/docs/Category202204ListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/Category202204ListResponse.md rename to sdks/retailmedia_2024-04/docs/Category202204ListResponse.md diff --git a/sdks/retailmedia_2024-04/docs/ChangeDatesOfBalanceRequest.md b/sdks/retailmedia_2024-04/docs/ChangeDatesOfBalanceRequest.md new file mode 100644 index 00000000..373fa90a --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ChangeDatesOfBalanceRequest.md @@ -0,0 +1,13 @@ +# ChangeDatesOfBalanceRequest + +Data model for an input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfChangeDatesOfBalance**](ResourceOfChangeDatesOfBalance.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_2024-04/docs/ChangeDetails.md b/sdks/retailmedia_2024-04/docs/ChangeDetails.md new file mode 100644 index 00000000..04e5fe97 --- /dev/null +++ b/sdks/retailmedia_2024-04/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_2023-01/docs/ChoiceOption.md b/sdks/retailmedia_2024-04/docs/ChoiceOption.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ChoiceOption.md rename to sdks/retailmedia_2024-04/docs/ChoiceOption.md diff --git a/sdks/retailmedia_2023-01/docs/ChoiceVariableSpecification.md b/sdks/retailmedia_2024-04/docs/ChoiceVariableSpecification.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ChoiceVariableSpecification.md rename to sdks/retailmedia_2024-04/docs/ChoiceVariableSpecification.md diff --git a/sdks/retailmedia_2024-04/docs/ChoiceVariableValue.md b/sdks/retailmedia_2024-04/docs/ChoiceVariableValue.md new file mode 100644 index 00000000..182abe3e --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ChoiceVariableValue.md @@ -0,0 +1,13 @@ +# ChoiceVariableValue + +A value of a template choice variable (among different accepted options) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**chosen_options** | **[str]** | The chosen options | +**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_2024-04/docs/ColorVariableValue.md b/sdks/retailmedia_2024-04/docs/ColorVariableValue.md new file mode 100644 index 00000000..b8eb6e74 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ColorVariableValue.md @@ -0,0 +1,13 @@ +# ColorVariableValue + +A value of a template color variable + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**color** | **str** | The displayed color (HEX format) | +**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_2023-01/docs/CommonError.md b/sdks/retailmedia_2024-04/docs/CommonError.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/CommonError.md rename to sdks/retailmedia_2024-04/docs/CommonError.md diff --git a/sdks/retailmedia_2023-01/docs/CommonLineItemPagedListResponse.md b/sdks/retailmedia_2024-04/docs/CommonLineItemPagedListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/CommonLineItemPagedListResponse.md rename to sdks/retailmedia_2024-04/docs/CommonLineItemPagedListResponse.md diff --git a/sdks/retailmedia_2023-01/docs/CommonLineItemResponse.md b/sdks/retailmedia_2024-04/docs/CommonLineItemResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/CommonLineItemResponse.md rename to sdks/retailmedia_2024-04/docs/CommonLineItemResponse.md diff --git a/sdks/retailmedia_2023-01/docs/CommonProblem.md b/sdks/retailmedia_2024-04/docs/CommonProblem.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/CommonProblem.md rename to sdks/retailmedia_2024-04/docs/CommonProblem.md diff --git a/sdks/retailmedia_2023-01/docs/CommonWarning.md b/sdks/retailmedia_2024-04/docs/CommonWarning.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/CommonWarning.md rename to sdks/retailmedia_2024-04/docs/CommonWarning.md diff --git a/sdks/retailmedia_2024-04/docs/CreateBalanceRequest.md b/sdks/retailmedia_2024-04/docs/CreateBalanceRequest.md new file mode 100644 index 00000000..cada2d97 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/CreateBalanceRequest.md @@ -0,0 +1,13 @@ +# CreateBalanceRequest + +Data model for an input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfCreateBalance**](ResourceOfCreateBalance.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_2023-01/docs/Creative202110.md b/sdks/retailmedia_2024-04/docs/Creative202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/Creative202110.md rename to sdks/retailmedia_2024-04/docs/Creative202110.md diff --git a/sdks/retailmedia_2023-01/docs/Creative202110ListResponse.md b/sdks/retailmedia_2024-04/docs/Creative202110ListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/Creative202110ListResponse.md rename to sdks/retailmedia_2024-04/docs/Creative202110ListResponse.md diff --git a/sdks/retailmedia_2024-04/docs/Creative202210.md b/sdks/retailmedia_2024-04/docs/Creative202210.md new file mode 100644 index 00000000..8557f68a --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/Creative202210.md @@ -0,0 +1,24 @@ +# 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_2024-04/docs/Creative202210ListResponse.md b/sdks/retailmedia_2024-04/docs/Creative202210ListResponse.md new file mode 100644 index 00000000..31ab557e --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/Creative202210ListResponse.md @@ -0,0 +1,15 @@ +# Creative202210ListResponse + +Data model for a 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] +**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_2024-04/docs/Creative202210Response.md b/sdks/retailmedia_2024-04/docs/Creative202210Response.md new file mode 100644 index 00000000..1a9c0135 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/Creative202210Response.md @@ -0,0 +1,15 @@ +# Creative202210Response + +Data model for response resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfCreative202210**](ResourceOfCreative202210.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_2024-04/docs/CreativeCreateModel202207.md b/sdks/retailmedia_2024-04/docs/CreativeCreateModel202207.md new file mode 100644 index 00000000..09881dc5 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/CreativeCreateModel202207.md @@ -0,0 +1,17 @@ +# 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_2024-04/docs/CreativeUpdateModel202207.md b/sdks/retailmedia_2024-04/docs/CreativeUpdateModel202207.md new file mode 100644 index 00000000..bcee4a2f --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/CreativeUpdateModel202207.md @@ -0,0 +1,17 @@ +# 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_2024-04/docs/DailyLineItemBudgetOverride.md b/sdks/retailmedia_2024-04/docs/DailyLineItemBudgetOverride.md new file mode 100644 index 00000000..6ee78b17 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/DailyLineItemBudgetOverride.md @@ -0,0 +1,15 @@ +# DailyLineItemBudgetOverride + +The details for a daily budget override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration** | **str** | The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'. | +**start_date** | **datetime, none_type** | Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence. | [optional] +**max_daily_spend** | **float, none_type** | Daily budget override maximum daily spend amount. | [optional] +**status** | **str, none_type** | Daily budget override computed status. | [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_2023-01/docs/EditableCampaignAttributesV202301.md b/sdks/retailmedia_2024-04/docs/EditableCampaignAttributesV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/EditableCampaignAttributesV202301.md rename to sdks/retailmedia_2024-04/docs/EditableCampaignAttributesV202301.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalAccount.md b/sdks/retailmedia_2024-04/docs/ExternalAccount.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalAccount.md rename to sdks/retailmedia_2024-04/docs/ExternalAccount.md diff --git a/sdks/retailmedia_2024-04/docs/ExternalAddFundsToBalance.md b/sdks/retailmedia_2024-04/docs/ExternalAddFundsToBalance.md new file mode 100644 index 00000000..8c174fc6 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ExternalAddFundsToBalance.md @@ -0,0 +1,15 @@ +# ExternalAddFundsToBalance + +An object that represents the available options of adding funds to a balance. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**delta_amount** | **float** | Amount of billable funds to be added / decreased allotted to the balance. | +**memo** | **str** | Memo | +**po_number** | **str** | Purchase Order number. | [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_2023-01/docs/ExternalAddToBasketIdsUpdateModel202110.md b/sdks/retailmedia_2024-04/docs/ExternalAddToBasketIdsUpdateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalAddToBasketIdsUpdateModel202110.md rename to sdks/retailmedia_2024-04/docs/ExternalAddToBasketIdsUpdateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalAddToBasketTarget202110.md b/sdks/retailmedia_2024-04/docs/ExternalAddToBasketTarget202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalAddToBasketTarget202110.md rename to sdks/retailmedia_2024-04/docs/ExternalAddToBasketTarget202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalAuctionLineItem.md b/sdks/retailmedia_2024-04/docs/ExternalAuctionLineItem.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalAuctionLineItem.md rename to sdks/retailmedia_2024-04/docs/ExternalAuctionLineItem.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalAuctionLineItemCreateModel.md b/sdks/retailmedia_2024-04/docs/ExternalAuctionLineItemCreateModel.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalAuctionLineItemCreateModel.md rename to sdks/retailmedia_2024-04/docs/ExternalAuctionLineItemCreateModel.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalAuctionLineItemUpdateModel.md b/sdks/retailmedia_2024-04/docs/ExternalAuctionLineItemUpdateModel.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalAuctionLineItemUpdateModel.md rename to sdks/retailmedia_2024-04/docs/ExternalAuctionLineItemUpdateModel.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalAudienceIdsUpdateModel202110.md b/sdks/retailmedia_2024-04/docs/ExternalAudienceIdsUpdateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalAudienceIdsUpdateModel202110.md rename to sdks/retailmedia_2024-04/docs/ExternalAudienceIdsUpdateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalAudienceTarget202110.md b/sdks/retailmedia_2024-04/docs/ExternalAudienceTarget202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalAudienceTarget202110.md rename to sdks/retailmedia_2024-04/docs/ExternalAudienceTarget202110.md diff --git a/sdks/retailmedia_2024-04/docs/ExternalBalanceResponse.md b/sdks/retailmedia_2024-04/docs/ExternalBalanceResponse.md new file mode 100644 index 00000000..022aff32 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ExternalBalanceResponse.md @@ -0,0 +1,26 @@ +# ExternalBalanceResponse + +A Retail Media Balance used to determine the funds available for any or all campaigns in an account + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the balance. | +**po_number** | **str** | Purchase Order number. | +**memo** | **str** | Memo | +**deposited** | **float, none_type** | Amount of billable funds allotted to the balance. | +**spent** | **float, none_type** | | +**remaining** | **float, none_type** | | +**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** | | +**created_at** | **datetime** | | +**updated_at** | **datetime** | | +**balance_type** | **str** | Type of the balance | +**sales_force_id** | **str** | SalesForceId the balance is linked to. | +**spend_type** | **str** | Spend Type of the balance. | +**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_2023-01/docs/ExternalBrand.md b/sdks/retailmedia_2024-04/docs/ExternalBrand.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalBrand.md rename to sdks/retailmedia_2024-04/docs/ExternalBrand.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalCatalogRequest.md b/sdks/retailmedia_2024-04/docs/ExternalCatalogRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalCatalogRequest.md rename to sdks/retailmedia_2024-04/docs/ExternalCatalogRequest.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalCatalogStatus.md b/sdks/retailmedia_2024-04/docs/ExternalCatalogStatus.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalCatalogStatus.md rename to sdks/retailmedia_2024-04/docs/ExternalCatalogStatus.md diff --git a/sdks/retailmedia_2024-04/docs/ExternalChangeDatesOfBalance.md b/sdks/retailmedia_2024-04/docs/ExternalChangeDatesOfBalance.md new file mode 100644 index 00000000..aea1551a --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ExternalChangeDatesOfBalance.md @@ -0,0 +1,15 @@ +# ExternalChangeDatesOfBalance + +An object that represents the available options to modify schedule of a balance. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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 | +**memo** | **str** | Memo | +**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_2023-01/docs/ExternalCommonLineItem.md b/sdks/retailmedia_2024-04/docs/ExternalCommonLineItem.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalCommonLineItem.md rename to sdks/retailmedia_2024-04/docs/ExternalCommonLineItem.md diff --git a/sdks/retailmedia_2024-04/docs/ExternalCreateBalance.md b/sdks/retailmedia_2024-04/docs/ExternalCreateBalance.md new file mode 100644 index 00000000..33d7a367 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ExternalCreateBalance.md @@ -0,0 +1,20 @@ +# ExternalCreateBalance + +An object that represents the available options to set when creating a Retail Media Balance + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the balance. | +**deposited** | **float, none_type** | Amount of billable funds allotted to the balance. | +**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 | +**spend_type** | **str** | Type of the balance spend. | +**memo** | **str** | Memo | +**sales_force_id** | **str** | SalesForceId the balance is linked to. | +**po_number** | **str** | Purchase Order number. | [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_2023-01/docs/ExternalKeywordTarget202110.md b/sdks/retailmedia_2024-04/docs/ExternalKeywordTarget202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalKeywordTarget202110.md rename to sdks/retailmedia_2024-04/docs/ExternalKeywordTarget202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalLineItemCapping202110.md b/sdks/retailmedia_2024-04/docs/ExternalLineItemCapping202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalLineItemCapping202110.md rename to sdks/retailmedia_2024-04/docs/ExternalLineItemCapping202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalLineItemPage202110.md b/sdks/retailmedia_2024-04/docs/ExternalLineItemPage202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalLineItemPage202110.md rename to sdks/retailmedia_2024-04/docs/ExternalLineItemPage202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalLineItemPageCategory202110.md b/sdks/retailmedia_2024-04/docs/ExternalLineItemPageCategory202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalLineItemPageCategory202110.md rename to sdks/retailmedia_2024-04/docs/ExternalLineItemPageCategory202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalPreferredLineItem202110.md b/sdks/retailmedia_2024-04/docs/ExternalPreferredLineItem202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalPreferredLineItem202110.md rename to sdks/retailmedia_2024-04/docs/ExternalPreferredLineItem202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalPreferredLineItemCreateModel202110.md b/sdks/retailmedia_2024-04/docs/ExternalPreferredLineItemCreateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalPreferredLineItemCreateModel202110.md rename to sdks/retailmedia_2024-04/docs/ExternalPreferredLineItemCreateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalPreferredLineItemUpdateModel202110.md b/sdks/retailmedia_2024-04/docs/ExternalPreferredLineItemUpdateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalPreferredLineItemUpdateModel202110.md rename to sdks/retailmedia_2024-04/docs/ExternalPreferredLineItemUpdateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalPromotedProduct202110.md b/sdks/retailmedia_2024-04/docs/ExternalPromotedProduct202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalPromotedProduct202110.md rename to sdks/retailmedia_2024-04/docs/ExternalPromotedProduct202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalRetailer.md b/sdks/retailmedia_2024-04/docs/ExternalRetailer.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalRetailer.md rename to sdks/retailmedia_2024-04/docs/ExternalRetailer.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalRetailerPages202110.md b/sdks/retailmedia_2024-04/docs/ExternalRetailerPages202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalRetailerPages202110.md rename to sdks/retailmedia_2024-04/docs/ExternalRetailerPages202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalStoreIdsUpdateModel202110.md b/sdks/retailmedia_2024-04/docs/ExternalStoreIdsUpdateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalStoreIdsUpdateModel202110.md rename to sdks/retailmedia_2024-04/docs/ExternalStoreIdsUpdateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ExternalStoreTarget202110.md b/sdks/retailmedia_2024-04/docs/ExternalStoreTarget202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ExternalStoreTarget202110.md rename to sdks/retailmedia_2024-04/docs/ExternalStoreTarget202110.md diff --git a/sdks/retailmedia_2024-04/docs/ExternalUpdateBalanceModel.md b/sdks/retailmedia_2024-04/docs/ExternalUpdateBalanceModel.md new file mode 100644 index 00000000..870b0d54 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ExternalUpdateBalanceModel.md @@ -0,0 +1,18 @@ +# ExternalUpdateBalanceModel + +An object that represents the available options to set when updating a Retail Media Balance + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the balance. | [optional] +**po_number** | **str** | Purchase Order number. | [optional] +**sales_force_id** | **str** | SalesForceId the balance is linked to. | [optional] +**start_date** | **date, none_type** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | [optional] +**end_date** | **date, none_type** | Represents the Date as a year, month, and day in the format YYYY-MM-DD | [optional] +**memo** | **str** | Memo | [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_2024-04/docs/FilesVariableValue.md b/sdks/retailmedia_2024-04/docs/FilesVariableValue.md new file mode 100644 index 00000000..ed5ebecb --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/FilesVariableValue.md @@ -0,0 +1,13 @@ +# FilesVariableValue + +A value of a template file variable (one or several files), like images in a creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**asset_ids** | **[str]** | The assets representing the images to be displayed | +**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_2023-01/docs/FilesVariablesSpecification.md b/sdks/retailmedia_2024-04/docs/FilesVariablesSpecification.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/FilesVariablesSpecification.md rename to sdks/retailmedia_2024-04/docs/FilesVariablesSpecification.md diff --git a/sdks/retailmedia_2024-04/docs/GatewayApi.md b/sdks/retailmedia_2024-04/docs/GatewayApi.md new file mode 100644 index 00000000..8aa8ca33 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/GatewayApi.md @@ -0,0 +1,90 @@ +# criteo_api_retailmedia_v2024_04.GatewayApi + +All URIs are relative to *https://api.criteo.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_current_application**](GatewayApi.md#get_current_application) | **GET** /2024-04/retail-media/me | + + +# **get_current_application** +> ApplicationSummaryModelResponse get_current_application() + + + +Get information about the currently logged application + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_v2024_04 +from criteo_api_retailmedia_v2024_04.api import gateway_api +from criteo_api_retailmedia_v2024_04.model.application_summary_model_response import ApplicationSummaryModelResponse +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_v2024_04.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_v2024_04.Configuration( + host = "https://api.criteo.com" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' + +# Configure OAuth2 access token for authorization: oauth +configuration = criteo_api_retailmedia_v2024_04.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_v2024_04.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = gateway_api.GatewayApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.get_current_application() + pprint(api_response) + except criteo_api_retailmedia_v2024_04.ApiException as e: + print("Exception when calling GatewayApi->get_current_application: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ApplicationSummaryModelResponse**](ApplicationSummaryModelResponse.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** | Success | - | +**404** | Not 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) + diff --git a/sdks/retailmedia_2024-04/docs/HyperlinkVariableValue.md b/sdks/retailmedia_2024-04/docs/HyperlinkVariableValue.md new file mode 100644 index 00000000..a2f66734 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/HyperlinkVariableValue.md @@ -0,0 +1,13 @@ +# HyperlinkVariableValue + +A value of a template hyperlink variable + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | The url to redirect to | +**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_2024-04/docs/InputKeywordsModel.md b/sdks/retailmedia_2024-04/docs/InputKeywordsModel.md new file mode 100644 index 00000000..9a080793 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/InputKeywordsModel.md @@ -0,0 +1,14 @@ +# InputKeywordsModel + +The keywords to be added or removed from a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negative_broad** | **[str], none_type** | | [optional] +**negative_exact** | **[str], none_type** | | [optional] +**positive_exact** | **[str], 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_2023-01/docs/InputResourceOfAuctionLineItemCreateModel.md b/sdks/retailmedia_2024-04/docs/InputResourceOfAuctionLineItemCreateModel.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/InputResourceOfAuctionLineItemCreateModel.md rename to sdks/retailmedia_2024-04/docs/InputResourceOfAuctionLineItemCreateModel.md diff --git a/sdks/retailmedia_2023-01/docs/InputResourceOfPreferredLineItemCreateModel202110.md b/sdks/retailmedia_2024-04/docs/InputResourceOfPreferredLineItemCreateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/InputResourceOfPreferredLineItemCreateModel202110.md rename to sdks/retailmedia_2024-04/docs/InputResourceOfPreferredLineItemCreateModel202110.md diff --git a/sdks/retailmedia_2024-04/docs/InsertionOrderHistoryChangeDataCapture.md b/sdks/retailmedia_2024-04/docs/InsertionOrderHistoryChangeDataCapture.md new file mode 100644 index 00000000..24868cd3 --- /dev/null +++ b/sdks/retailmedia_2024-04/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_2023-01/docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest.md b/sdks/retailmedia_2024-04/docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest.md rename to sdks/retailmedia_2024-04/docs/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiPageResponseOfAccount.md b/sdks/retailmedia_2024-04/docs/JsonApiPageResponseOfAccount.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiPageResponseOfAccount.md rename to sdks/retailmedia_2024-04/docs/JsonApiPageResponseOfAccount.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiPageResponseOfBrand.md b/sdks/retailmedia_2024-04/docs/JsonApiPageResponseOfBrand.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiPageResponseOfBrand.md rename to sdks/retailmedia_2024-04/docs/JsonApiPageResponseOfBrand.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiPageResponseOfCampaignV202301.md b/sdks/retailmedia_2024-04/docs/JsonApiPageResponseOfCampaignV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiPageResponseOfCampaignV202301.md rename to sdks/retailmedia_2024-04/docs/JsonApiPageResponseOfCampaignV202301.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiPageResponseOfRetailer.md b/sdks/retailmedia_2024-04/docs/JsonApiPageResponseOfRetailer.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiPageResponseOfRetailer.md rename to sdks/retailmedia_2024-04/docs/JsonApiPageResponseOfRetailer.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiRequestOfCatalogRequest.md b/sdks/retailmedia_2024-04/docs/JsonApiRequestOfCatalogRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiRequestOfCatalogRequest.md rename to sdks/retailmedia_2024-04/docs/JsonApiRequestOfCatalogRequest.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiSingleResponseOfCampaignV202301.md b/sdks/retailmedia_2024-04/docs/JsonApiSingleResponseOfCampaignV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiSingleResponseOfCampaignV202301.md rename to sdks/retailmedia_2024-04/docs/JsonApiSingleResponseOfCampaignV202301.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiSingleResponseOfCatalogStatus.md b/sdks/retailmedia_2024-04/docs/JsonApiSingleResponseOfCatalogStatus.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiSingleResponseOfCatalogStatus.md rename to sdks/retailmedia_2024-04/docs/JsonApiSingleResponseOfCatalogStatus.md diff --git a/sdks/retailmedia_2023-01/docs/JsonApiSingleResponseOfLineItemBidMultipliers.md b/sdks/retailmedia_2024-04/docs/JsonApiSingleResponseOfLineItemBidMultipliers.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/JsonApiSingleResponseOfLineItemBidMultipliers.md rename to sdks/retailmedia_2024-04/docs/JsonApiSingleResponseOfLineItemBidMultipliers.md diff --git a/sdks/retailmedia_2024-04/docs/KeywordDataModel.md b/sdks/retailmedia_2024-04/docs/KeywordDataModel.md new file mode 100644 index 00000000..fca58d73 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/KeywordDataModel.md @@ -0,0 +1,17 @@ +# KeywordDataModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**review_state** | [**ReviewStateModel**](ReviewStateModel.md) | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**bid** | **float, none_type** | | [optional] +**input_keywords** | [**InputKeywordsModel**](InputKeywordsModel.md) | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2023-01/docs/KeywordTarget202110Request.md b/sdks/retailmedia_2024-04/docs/KeywordTarget202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/KeywordTarget202110Request.md rename to sdks/retailmedia_2024-04/docs/KeywordTarget202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/KeywordTarget202110Response.md b/sdks/retailmedia_2024-04/docs/KeywordTarget202110Response.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/KeywordTarget202110Response.md rename to sdks/retailmedia_2024-04/docs/KeywordTarget202110Response.md diff --git a/sdks/retailmedia_2024-04/docs/KeywordsModel.md b/sdks/retailmedia_2024-04/docs/KeywordsModel.md new file mode 100644 index 00000000..d31dabad --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/KeywordsModel.md @@ -0,0 +1,13 @@ +# KeywordsModel + +The keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**{str: (KeywordDataModel,)}, none_type**](KeywordDataModel.md) | | [optional] +**rank** | **[str], 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_2024-04/docs/KeywordsModelResource.md b/sdks/retailmedia_2024-04/docs/KeywordsModelResource.md new file mode 100644 index 00000000..9a26bd3a --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/KeywordsModelResource.md @@ -0,0 +1,14 @@ +# KeywordsModelResource + +Resource object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**KeywordsModel**](KeywordsModel.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_2024-04/docs/KeywordsModelResponse.md b/sdks/retailmedia_2024-04/docs/KeywordsModelResponse.md new file mode 100644 index 00000000..2d24cc4e --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/KeywordsModelResponse.md @@ -0,0 +1,14 @@ +# KeywordsModelResponse + +Response object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**KeywordsModelResource**](KeywordsModelResource.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_2023-01/docs/LineItemBidMultipliers.md b/sdks/retailmedia_2024-04/docs/LineItemBidMultipliers.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/LineItemBidMultipliers.md rename to sdks/retailmedia_2024-04/docs/LineItemBidMultipliers.md diff --git a/sdks/retailmedia_2023-01/docs/LineItemBidMultipliersRequest.md b/sdks/retailmedia_2024-04/docs/LineItemBidMultipliersRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/LineItemBidMultipliersRequest.md rename to sdks/retailmedia_2024-04/docs/LineItemBidMultipliersRequest.md diff --git a/sdks/retailmedia_2023-01/docs/LineItemBidMultipliersResponse.md b/sdks/retailmedia_2024-04/docs/LineItemBidMultipliersResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/LineItemBidMultipliersResponse.md rename to sdks/retailmedia_2024-04/docs/LineItemBidMultipliersResponse.md diff --git a/sdks/retailmedia_2024-04/docs/LineItemBudgetOverrides.md b/sdks/retailmedia_2024-04/docs/LineItemBudgetOverrides.md new file mode 100644 index 00000000..89cddb7c --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/LineItemBudgetOverrides.md @@ -0,0 +1,13 @@ +# LineItemBudgetOverrides + +Line item budget overrides including Monthly and Daily budget overrides. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**monthly_line_item_budget_overrides** | [**[MonthlyLineItemBudegetOverride]**](MonthlyLineItemBudegetOverride.md) | Line item budget override monthly part, chronological order restricted. | +**daily_line_item_budget_overrides** | [**[DailyLineItemBudgetOverride]**](DailyLineItemBudgetOverride.md) | Line item budget override daily part, chronological order restricted. | + +[[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_2024-04/docs/MatchTypeModel.md b/sdks/retailmedia_2024-04/docs/MatchTypeModel.md new file mode 100644 index 00000000..9406306f --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/MatchTypeModel.md @@ -0,0 +1,12 @@ +# MatchTypeModel + +The match type of a keyword. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The match type of a keyword. | must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] + +[[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_2024-04/docs/Metadata.md b/sdks/retailmedia_2024-04/docs/Metadata.md new file mode 100644 index 00000000..84035cd2 --- /dev/null +++ b/sdks/retailmedia_2024-04/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_2024-04/docs/MonthlyLineItemBudegetOverride.md b/sdks/retailmedia_2024-04/docs/MonthlyLineItemBudegetOverride.md new file mode 100644 index 00000000..1b842fc3 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/MonthlyLineItemBudegetOverride.md @@ -0,0 +1,15 @@ +# MonthlyLineItemBudegetOverride + +The details for a monthly budget override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration** | **str** | The number of MONTHs that the override is active from StartMonth, e.g. \"1M\". Must end with 'M' or 'm'. | +**max_monthly_spend** | **float** | Monthly budget override maximum monthly spend amount. | +**start_month** | **datetime, none_type** | Monthly budget override start month, format \"yyyy-MM\". If it is null, the StartMonth would be the following month of the last item in the override sequence. | [optional] +**status** | **str, none_type** | Monthly budget override computed status. | [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_2024-04/docs/NegotiationStateModel.md b/sdks/retailmedia_2024-04/docs/NegotiationStateModel.md new file mode 100644 index 00000000..e34ddbf4 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/NegotiationStateModel.md @@ -0,0 +1,12 @@ +# NegotiationStateModel + +The state of a negotiation in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a negotiation in the context of a line item. | must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] + +[[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_2023-01/docs/PageMetadata.md b/sdks/retailmedia_2024-04/docs/PageMetadata.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PageMetadata.md rename to sdks/retailmedia_2024-04/docs/PageMetadata.md diff --git a/sdks/retailmedia_2024-04/docs/PageOfInsertionOrderHistoryChangeDataCapture.md b/sdks/retailmedia_2024-04/docs/PageOfInsertionOrderHistoryChangeDataCapture.md new file mode 100644 index 00000000..cec70092 --- /dev/null +++ b/sdks/retailmedia_2024-04/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_2024-04/docs/PageTypeEnvironment.md b/sdks/retailmedia_2024-04/docs/PageTypeEnvironment.md new file mode 100644 index 00000000..66571a9a --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/PageTypeEnvironment.md @@ -0,0 +1,14 @@ +# 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_2023-01/docs/PostCampaignV202301.md b/sdks/retailmedia_2024-04/docs/PostCampaignV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PostCampaignV202301.md rename to sdks/retailmedia_2024-04/docs/PostCampaignV202301.md diff --git a/sdks/retailmedia_2023-01/docs/PreferredLineItem202110PagedListResponse.md b/sdks/retailmedia_2024-04/docs/PreferredLineItem202110PagedListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PreferredLineItem202110PagedListResponse.md rename to sdks/retailmedia_2024-04/docs/PreferredLineItem202110PagedListResponse.md diff --git a/sdks/retailmedia_2023-01/docs/PreferredLineItem202110Response.md b/sdks/retailmedia_2024-04/docs/PreferredLineItem202110Response.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PreferredLineItem202110Response.md rename to sdks/retailmedia_2024-04/docs/PreferredLineItem202110Response.md diff --git a/sdks/retailmedia_2023-01/docs/PreferredLineItemCreateModel202110Request.md b/sdks/retailmedia_2024-04/docs/PreferredLineItemCreateModel202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PreferredLineItemCreateModel202110Request.md rename to sdks/retailmedia_2024-04/docs/PreferredLineItemCreateModel202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/PreferredLineItemUpdateModel202110Request.md b/sdks/retailmedia_2024-04/docs/PreferredLineItemUpdateModel202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PreferredLineItemUpdateModel202110Request.md rename to sdks/retailmedia_2024-04/docs/PreferredLineItemUpdateModel202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/ProblemDetails.md b/sdks/retailmedia_2024-04/docs/ProblemDetails.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ProblemDetails.md rename to sdks/retailmedia_2024-04/docs/ProblemDetails.md diff --git a/sdks/retailmedia_2023-01/docs/PromotedProduct202110ListRequest.md b/sdks/retailmedia_2024-04/docs/PromotedProduct202110ListRequest.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PromotedProduct202110ListRequest.md rename to sdks/retailmedia_2024-04/docs/PromotedProduct202110ListRequest.md diff --git a/sdks/retailmedia_2023-01/docs/PromotedProduct202110PagedListResponse.md b/sdks/retailmedia_2024-04/docs/PromotedProduct202110PagedListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PromotedProduct202110PagedListResponse.md rename to sdks/retailmedia_2024-04/docs/PromotedProduct202110PagedListResponse.md diff --git a/sdks/retailmedia_2024-04/docs/ProposalStatusModel.md b/sdks/retailmedia_2024-04/docs/ProposalStatusModel.md new file mode 100644 index 00000000..49d39c19 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ProposalStatusModel.md @@ -0,0 +1,17 @@ +# ProposalStatusModel + +The state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negotiation_state** | [**NegotiationStateModel**](NegotiationStateModel.md) | | [optional] +**booking_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**runnable_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**comment** | **str, none_type** | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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_2024-04/docs/ProposalStatusModelResource.md b/sdks/retailmedia_2024-04/docs/ProposalStatusModelResource.md new file mode 100644 index 00000000..f89ca4eb --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ProposalStatusModelResource.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResource + +Resource object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**ProposalStatusModel**](ProposalStatusModel.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_2024-04/docs/ProposalStatusModelResponse.md b/sdks/retailmedia_2024-04/docs/ProposalStatusModelResponse.md new file mode 100644 index 00000000..2e87ff0d --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ProposalStatusModelResponse.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResponse + +Response object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**ProposalStatusModelResource**](ProposalStatusModelResource.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_2023-01/docs/PutCampaignV202301.md b/sdks/retailmedia_2024-04/docs/PutCampaignV202301.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/PutCampaignV202301.md rename to sdks/retailmedia_2024-04/docs/PutCampaignV202301.md diff --git a/sdks/retailmedia_2023-01/docs/ReportOutcome.md b/sdks/retailmedia_2024-04/docs/ReportOutcome.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ReportOutcome.md rename to sdks/retailmedia_2024-04/docs/ReportOutcome.md diff --git a/sdks/retailmedia_2024-04/docs/ResourceOfAddFundsToBalance.md b/sdks/retailmedia_2024-04/docs/ResourceOfAddFundsToBalance.md new file mode 100644 index 00000000..13a813fc --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOfAddFundsToBalance.md @@ -0,0 +1,15 @@ +# ResourceOfAddFundsToBalance + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**ExternalAddFundsToBalance**](ExternalAddFundsToBalance.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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_2023-01/docs/ResourceOfAuctionLineItem.md b/sdks/retailmedia_2024-04/docs/ResourceOfAuctionLineItem.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfAuctionLineItem.md rename to sdks/retailmedia_2024-04/docs/ResourceOfAuctionLineItem.md diff --git a/sdks/retailmedia_2023-01/docs/ResourceOfAuctionLineItemUpdateModel.md b/sdks/retailmedia_2024-04/docs/ResourceOfAuctionLineItemUpdateModel.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfAuctionLineItemUpdateModel.md rename to sdks/retailmedia_2024-04/docs/ResourceOfAuctionLineItemUpdateModel.md diff --git a/sdks/retailmedia_2023-01/docs/ResourceOfBalanceCampaign202110.md b/sdks/retailmedia_2024-04/docs/ResourceOfBalanceCampaign202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfBalanceCampaign202110.md rename to sdks/retailmedia_2024-04/docs/ResourceOfBalanceCampaign202110.md diff --git a/sdks/retailmedia_2024-04/docs/ResourceOfBalanceResponse.md b/sdks/retailmedia_2024-04/docs/ResourceOfBalanceResponse.md new file mode 100644 index 00000000..1e6ce1a6 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOfBalanceResponse.md @@ -0,0 +1,15 @@ +# ResourceOfBalanceResponse + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**ExternalBalanceResponse**](ExternalBalanceResponse.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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_2023-01/docs/ResourceOfCategory202204.md b/sdks/retailmedia_2024-04/docs/ResourceOfCategory202204.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfCategory202204.md rename to sdks/retailmedia_2024-04/docs/ResourceOfCategory202204.md diff --git a/sdks/retailmedia_2024-04/docs/ResourceOfChangeDatesOfBalance.md b/sdks/retailmedia_2024-04/docs/ResourceOfChangeDatesOfBalance.md new file mode 100644 index 00000000..dab65856 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOfChangeDatesOfBalance.md @@ -0,0 +1,15 @@ +# ResourceOfChangeDatesOfBalance + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**ExternalChangeDatesOfBalance**](ExternalChangeDatesOfBalance.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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_2023-01/docs/ResourceOfCommonLineItem.md b/sdks/retailmedia_2024-04/docs/ResourceOfCommonLineItem.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfCommonLineItem.md rename to sdks/retailmedia_2024-04/docs/ResourceOfCommonLineItem.md diff --git a/sdks/retailmedia_2024-04/docs/ResourceOfCreateBalance.md b/sdks/retailmedia_2024-04/docs/ResourceOfCreateBalance.md new file mode 100644 index 00000000..273b5b35 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOfCreateBalance.md @@ -0,0 +1,15 @@ +# ResourceOfCreateBalance + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**ExternalCreateBalance**](ExternalCreateBalance.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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_2023-01/docs/ResourceOfCreative202110.md b/sdks/retailmedia_2024-04/docs/ResourceOfCreative202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfCreative202110.md rename to sdks/retailmedia_2024-04/docs/ResourceOfCreative202110.md diff --git a/sdks/retailmedia_2024-04/docs/ResourceOfCreative202210.md b/sdks/retailmedia_2024-04/docs/ResourceOfCreative202210.md new file mode 100644 index 00000000..271e4580 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOfCreative202210.md @@ -0,0 +1,15 @@ +# ResourceOfCreative202210 + +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] +**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_2023-01/docs/ResourceOfLineItemBidMultipliers.md b/sdks/retailmedia_2024-04/docs/ResourceOfLineItemBidMultipliers.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfLineItemBidMultipliers.md rename to sdks/retailmedia_2024-04/docs/ResourceOfLineItemBidMultipliers.md diff --git a/sdks/retailmedia_2023-01/docs/ResourceOfPreferredLineItem202110.md b/sdks/retailmedia_2024-04/docs/ResourceOfPreferredLineItem202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfPreferredLineItem202110.md rename to sdks/retailmedia_2024-04/docs/ResourceOfPreferredLineItem202110.md diff --git a/sdks/retailmedia_2023-01/docs/ResourceOfPreferredLineItemUpdateModel202110.md b/sdks/retailmedia_2024-04/docs/ResourceOfPreferredLineItemUpdateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfPreferredLineItemUpdateModel202110.md rename to sdks/retailmedia_2024-04/docs/ResourceOfPreferredLineItemUpdateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ResourceOfPromotedProduct202110.md b/sdks/retailmedia_2024-04/docs/ResourceOfPromotedProduct202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfPromotedProduct202110.md rename to sdks/retailmedia_2024-04/docs/ResourceOfPromotedProduct202110.md diff --git a/sdks/retailmedia_2024-04/docs/ResourceOfRetailMediaAccount.md b/sdks/retailmedia_2024-04/docs/ResourceOfRetailMediaAccount.md new file mode 100644 index 00000000..09defaca --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOfRetailMediaAccount.md @@ -0,0 +1,14 @@ +# ResourceOfRetailMediaAccount + +A class that represents a domain entity exposed by an API. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**RetailMediaAccount**](RetailMediaAccount.md) | | [optional] +**id** | **str, none_type** | Unique identifier of this resource. | [optional] +**type** | **str, 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_2023-01/docs/ResourceOfTemplate.md b/sdks/retailmedia_2024-04/docs/ResourceOfTemplate.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ResourceOfTemplate.md rename to sdks/retailmedia_2024-04/docs/ResourceOfTemplate.md diff --git a/sdks/retailmedia_2024-04/docs/ResourceOfUpdateBalanceModel.md b/sdks/retailmedia_2024-04/docs/ResourceOfUpdateBalanceModel.md new file mode 100644 index 00000000..c9356e7b --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOfUpdateBalanceModel.md @@ -0,0 +1,15 @@ +# ResourceOfUpdateBalanceModel + +Data model for a Resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**ExternalUpdateBalanceModel**](ExternalUpdateBalanceModel.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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_2024-04/docs/ResourceOutcome.md b/sdks/retailmedia_2024-04/docs/ResourceOutcome.md new file mode 100644 index 00000000..3bf8a5e5 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOutcome.md @@ -0,0 +1,13 @@ +# ResourceOutcome + +Outcome object containing errors and warnings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.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_2024-04/docs/ResourceOutcomeOfRetailMediaAccount.md b/sdks/retailmedia_2024-04/docs/ResourceOutcomeOfRetailMediaAccount.md new file mode 100644 index 00000000..cb033b34 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ResourceOutcomeOfRetailMediaAccount.md @@ -0,0 +1,14 @@ +# ResourceOutcomeOfRetailMediaAccount + +A top-level object that encapsulates a Criteo API response for a single entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfRetailMediaAccount**](ResourceOfRetailMediaAccount.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_2024-04/docs/RetailMediaAccount.md b/sdks/retailmedia_2024-04/docs/RetailMediaAccount.md new file mode 100644 index 00000000..efc008b5 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/RetailMediaAccount.md @@ -0,0 +1,19 @@ +# RetailMediaAccount + +The details for a newly created account + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | account name | [optional] +**company_name** | **str, none_type** | Display name for reporting the owning entity of ads for the Digital Services Act in the European Union | [optional] +**type** | **str, none_type** | Type for the account | [optional] +**sub_type** | **str, none_type** | subtype for the account | [optional] +**country_ids** | **[str], none_type** | list of countries associated with the account | [optional] +**currency_id** | **str, none_type** | the currency for the account | [optional] +**parent_account_label** | **str, none_type** | parent account label for the account | [optional] +**time_zone** | **str, none_type** | the timezone for the account | [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_2024-04/docs/RetailMediaBrandAccountCreation.md b/sdks/retailmedia_2024-04/docs/RetailMediaBrandAccountCreation.md new file mode 100644 index 00000000..3d80fbce --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/RetailMediaBrandAccountCreation.md @@ -0,0 +1,14 @@ +# RetailMediaBrandAccountCreation + +the initial set up and configuration options for a new private market demand brand account + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | the name of the account, must be unique across all accounts | [optional] +**company_name** | **str, none_type** | Display name for reporting the owning entity of ads for the Digital Services Act in the European Union | [optional] +**brands** | **[int], none_type** | list of brands to link to the new account | [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_2024-04/docs/RetailMediaBrands.md b/sdks/retailmedia_2024-04/docs/RetailMediaBrands.md new file mode 100644 index 00000000..b9adf29b --- /dev/null +++ b/sdks/retailmedia_2024-04/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_2024-04/docs/ReviewStateModel.md b/sdks/retailmedia_2024-04/docs/ReviewStateModel.md new file mode 100644 index 00000000..e905d467 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ReviewStateModel.md @@ -0,0 +1,12 @@ +# ReviewStateModel + +The state of a keyword in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a keyword in the context of a line item. | must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] + +[[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_2023-01/docs/RmLegacyAudienceCreateEntityV1.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV1.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV1.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV1.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV1Resource.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV1Resource.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV1Resource.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV1Resource.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV1Response.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV1Response.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV1Response.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV1Response.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV2.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV2.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV2.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV2.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV2Resource.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV2Resource.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV2Resource.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV2Resource.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV2Response.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV2Response.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateEntityV2Response.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateEntityV2Response.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateInputEntityV1.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateInputEntityV1.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateInputEntityV1.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateInputEntityV1.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateInputEntityV2.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateInputEntityV2.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceCreateInputEntityV2.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceCreateInputEntityV2.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV1.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV1.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV1.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV1.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV1ListResponse.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV1ListResponse.md similarity index 89% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV1ListResponse.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV1ListResponse.md index a086fc52..177bd87b 100644 --- a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV1ListResponse.md +++ b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV1ListResponse.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1ListResponse -List of responses +A top-level object that encapsulates a Criteo API response for several entities and metadata ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV1Resource.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV1Resource.md similarity index 92% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV1Resource.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV1Resource.md index 7d4b9798..dad0c799 100644 --- a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV1Resource.md +++ b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV1Resource.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1Resource -Legacy resource +A class that represents a domain entity exposed by an API ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV2.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV2.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV2.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV2.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV2ListResponse.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV2ListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV2ListResponse.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV2ListResponse.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV2Resource.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV2Resource.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceGetEntityV2Resource.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceGetEntityV2Resource.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceUserBehaviorCreateV2.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceUserBehaviorCreateV2.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceUserBehaviorCreateV2.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceUserBehaviorCreateV2.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacyAudienceUserBehaviorDetailsV2.md b/sdks/retailmedia_2024-04/docs/RmLegacyAudienceUserBehaviorDetailsV2.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacyAudienceUserBehaviorDetailsV2.md rename to sdks/retailmedia_2024-04/docs/RmLegacyAudienceUserBehaviorDetailsV2.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacySegmentCustomerList.md b/sdks/retailmedia_2024-04/docs/RmLegacySegmentCustomerList.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacySegmentCustomerList.md rename to sdks/retailmedia_2024-04/docs/RmLegacySegmentCustomerList.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacySegmentUserBehaviorCreateV2.md b/sdks/retailmedia_2024-04/docs/RmLegacySegmentUserBehaviorCreateV2.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacySegmentUserBehaviorCreateV2.md rename to sdks/retailmedia_2024-04/docs/RmLegacySegmentUserBehaviorCreateV2.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacySegmentUserBehaviorV1.md b/sdks/retailmedia_2024-04/docs/RmLegacySegmentUserBehaviorV1.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacySegmentUserBehaviorV1.md rename to sdks/retailmedia_2024-04/docs/RmLegacySegmentUserBehaviorV1.md diff --git a/sdks/retailmedia_2023-01/docs/RmLegacySegmentUserBehaviorV2.md b/sdks/retailmedia_2024-04/docs/RmLegacySegmentUserBehaviorV2.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/RmLegacySegmentUserBehaviorV2.md rename to sdks/retailmedia_2024-04/docs/RmLegacySegmentUserBehaviorV2.md diff --git a/sdks/retailmedia_2024-04/docs/RmcaCommonProblem.md b/sdks/retailmedia_2024-04/docs/RmcaCommonProblem.md new file mode 100644 index 00000000..fba2c66b --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/RmcaCommonProblem.md @@ -0,0 +1,21 @@ +# RmcaCommonProblem + +Common problem object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trace_id** | **str, none_type** | The request correlation ID this problem comes from. | [optional] +**type** | **str, none_type** | The problem's category. | [optional] +**code** | **str, none_type** | A machine-readable error code, expressed as a string value. | [optional] +**instance** | **str, none_type** | A URI that identifies the specific occurrence of the problem. | [optional] +**title** | **str, none_type** | A short human-readable description of the problem type | [optional] +**detail** | **str, none_type** | A human-readable explanation specific to this occurrence of the problem | [optional] +**source** | **{str: (str,)}, none_type** | A machine-readable structure to reference to the exact location(s) causing the error(s) | [optional] +**stack_trace** | **str, none_type** | | [optional] +**status** | **int, none_type** | The problem's HTTP Status code. | [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_2023-01/docs/Section.md b/sdks/retailmedia_2024-04/docs/Section.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/Section.md rename to sdks/retailmedia_2024-04/docs/Section.md diff --git a/sdks/retailmedia_2024-04/docs/SetBidModel.md b/sdks/retailmedia_2024-04/docs/SetBidModel.md new file mode 100644 index 00000000..979e91d0 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/SetBidModel.md @@ -0,0 +1,13 @@ +# SetBidModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**bid** | **float, 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_2024-04/docs/SetBidsModel.md b/sdks/retailmedia_2024-04/docs/SetBidsModel.md new file mode 100644 index 00000000..e5e1b0c8 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/SetBidsModel.md @@ -0,0 +1,12 @@ +# SetBidsModel + +Data model containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[SetBidModel], none_type**](SetBidModel.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_2024-04/docs/SetBidsModelRequest.md b/sdks/retailmedia_2024-04/docs/SetBidsModelRequest.md new file mode 100644 index 00000000..9c19c9c2 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/SetBidsModelRequest.md @@ -0,0 +1,12 @@ +# SetBidsModelRequest + +Request object to set bid overrides for keywords associated with a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SetBidsModelResource**](SetBidsModelResource.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_2024-04/docs/SetBidsModelResource.md b/sdks/retailmedia_2024-04/docs/SetBidsModelResource.md new file mode 100644 index 00000000..6e436263 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/SetBidsModelResource.md @@ -0,0 +1,14 @@ +# SetBidsModelResource + +Resource object containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**SetBidsModel**](SetBidsModel.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_2023-01/docs/StatusResponse.md b/sdks/retailmedia_2024-04/docs/StatusResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/StatusResponse.md rename to sdks/retailmedia_2024-04/docs/StatusResponse.md diff --git a/sdks/retailmedia_2023-01/docs/StatusResponseResource.md b/sdks/retailmedia_2024-04/docs/StatusResponseResource.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/StatusResponseResource.md rename to sdks/retailmedia_2024-04/docs/StatusResponseResource.md diff --git a/sdks/retailmedia_2023-01/docs/StoreIdsUpdateModel202110Request.md b/sdks/retailmedia_2024-04/docs/StoreIdsUpdateModel202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/StoreIdsUpdateModel202110Request.md rename to sdks/retailmedia_2024-04/docs/StoreIdsUpdateModel202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/StoreTarget202110Request.md b/sdks/retailmedia_2024-04/docs/StoreTarget202110Request.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/StoreTarget202110Request.md rename to sdks/retailmedia_2024-04/docs/StoreTarget202110Request.md diff --git a/sdks/retailmedia_2023-01/docs/StoreTarget202110Response.md b/sdks/retailmedia_2024-04/docs/StoreTarget202110Response.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/StoreTarget202110Response.md rename to sdks/retailmedia_2024-04/docs/StoreTarget202110Response.md diff --git a/sdks/retailmedia_2023-01/docs/Template.md b/sdks/retailmedia_2024-04/docs/Template.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/Template.md rename to sdks/retailmedia_2024-04/docs/Template.md diff --git a/sdks/retailmedia_2023-01/docs/TemplateListResponse.md b/sdks/retailmedia_2024-04/docs/TemplateListResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/TemplateListResponse.md rename to sdks/retailmedia_2024-04/docs/TemplateListResponse.md diff --git a/sdks/retailmedia_2023-01/docs/TemplateResponse.md b/sdks/retailmedia_2024-04/docs/TemplateResponse.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/TemplateResponse.md rename to sdks/retailmedia_2024-04/docs/TemplateResponse.md diff --git a/sdks/retailmedia_2023-01/docs/TemplateVariable.md b/sdks/retailmedia_2024-04/docs/TemplateVariable.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/TemplateVariable.md rename to sdks/retailmedia_2024-04/docs/TemplateVariable.md diff --git a/sdks/retailmedia_2024-04/docs/TemplateVariableValue.md b/sdks/retailmedia_2024-04/docs/TemplateVariableValue.md new file mode 100644 index 00000000..117bd4dc --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/TemplateVariableValue.md @@ -0,0 +1,18 @@ +# 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_2023-01/docs/TextVariableSpecification.md b/sdks/retailmedia_2024-04/docs/TextVariableSpecification.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/TextVariableSpecification.md rename to sdks/retailmedia_2024-04/docs/TextVariableSpecification.md diff --git a/sdks/retailmedia_2024-04/docs/TextVariableValue.md b/sdks/retailmedia_2024-04/docs/TextVariableValue.md new file mode 100644 index 00000000..76d1425b --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/TextVariableValue.md @@ -0,0 +1,13 @@ +# TextVariableValue + +A value of a template text variable + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **str** | The displayed text | +**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_2024-04/docs/UpdateBalanceModelRequest.md b/sdks/retailmedia_2024-04/docs/UpdateBalanceModelRequest.md new file mode 100644 index 00000000..827b24f9 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/UpdateBalanceModelRequest.md @@ -0,0 +1,13 @@ +# UpdateBalanceModelRequest + +Data model for an input resource + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfUpdateBalanceModel**](ResourceOfUpdateBalanceModel.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_2024-04/docs/ValueResourceInputOfCampaignBudgetOverrides.md b/sdks/retailmedia_2024-04/docs/ValueResourceInputOfCampaignBudgetOverrides.md new file mode 100644 index 00000000..068a79ae --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ValueResourceInputOfCampaignBudgetOverrides.md @@ -0,0 +1,12 @@ +# ValueResourceInputOfCampaignBudgetOverrides + +A top-level object that encapsulates a Criteo API request for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ValueResourceOfCampaignBudgetOverrides**](ValueResourceOfCampaignBudgetOverrides.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_2024-04/docs/ValueResourceInputOfLineItemBudgetOverrides.md b/sdks/retailmedia_2024-04/docs/ValueResourceInputOfLineItemBudgetOverrides.md new file mode 100644 index 00000000..43c73838 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ValueResourceInputOfLineItemBudgetOverrides.md @@ -0,0 +1,12 @@ +# ValueResourceInputOfLineItemBudgetOverrides + +A top-level object that encapsulates a Criteo API request for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ValueResourceOfLineItemBudgetOverrides**](ValueResourceOfLineItemBudgetOverrides.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_2024-04/docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md b/sdks/retailmedia_2024-04/docs/ValueResourceInputOfRetailMediaBrandAccountCreation.md new file mode 100644 index 00000000..c36494ce --- /dev/null +++ b/sdks/retailmedia_2024-04/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_2024-04/docs/ValueResourceInputOfRetailMediaBrands.md b/sdks/retailmedia_2024-04/docs/ValueResourceInputOfRetailMediaBrands.md new file mode 100644 index 00000000..bc448e22 --- /dev/null +++ b/sdks/retailmedia_2024-04/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_2024-04/docs/ValueResourceOfCampaignBudgetOverrides.md b/sdks/retailmedia_2024-04/docs/ValueResourceOfCampaignBudgetOverrides.md new file mode 100644 index 00000000..558786b9 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ValueResourceOfCampaignBudgetOverrides.md @@ -0,0 +1,13 @@ +# ValueResourceOfCampaignBudgetOverrides + +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** | [**CampaignBudgetOverrides**](CampaignBudgetOverrides.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_2024-04/docs/ValueResourceOfLineItemBudgetOverrides.md b/sdks/retailmedia_2024-04/docs/ValueResourceOfLineItemBudgetOverrides.md new file mode 100644 index 00000000..4e3b78dc --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ValueResourceOfLineItemBudgetOverrides.md @@ -0,0 +1,13 @@ +# ValueResourceOfLineItemBudgetOverrides + +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** | [**LineItemBudgetOverrides**](LineItemBudgetOverrides.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_2024-04/docs/ValueResourceOfRetailMediaBrandAccountCreation.md b/sdks/retailmedia_2024-04/docs/ValueResourceOfRetailMediaBrandAccountCreation.md new file mode 100644 index 00000000..4f96750f --- /dev/null +++ b/sdks/retailmedia_2024-04/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_2024-04/docs/ValueResourceOfRetailMediaBrands.md b/sdks/retailmedia_2024-04/docs/ValueResourceOfRetailMediaBrands.md new file mode 100644 index 00000000..a13d9bc9 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ValueResourceOfRetailMediaBrands.md @@ -0,0 +1,13 @@ +# ValueResourceOfRetailMediaBrands + +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** | [**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_2024-04/docs/ValueResourceOutcomeOfCampaignBudgetOverrides.md b/sdks/retailmedia_2024-04/docs/ValueResourceOutcomeOfCampaignBudgetOverrides.md new file mode 100644 index 00000000..c342f9a5 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ValueResourceOutcomeOfCampaignBudgetOverrides.md @@ -0,0 +1,14 @@ +# ValueResourceOutcomeOfCampaignBudgetOverrides + +A top-level object that encapsulates a Criteo API response for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ValueResourceOfCampaignBudgetOverrides**](ValueResourceOfCampaignBudgetOverrides.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_2024-04/docs/ValueResourceOutcomeOfLineItemBudgetOverrides.md b/sdks/retailmedia_2024-04/docs/ValueResourceOutcomeOfLineItemBudgetOverrides.md new file mode 100644 index 00000000..1ea50409 --- /dev/null +++ b/sdks/retailmedia_2024-04/docs/ValueResourceOutcomeOfLineItemBudgetOverrides.md @@ -0,0 +1,14 @@ +# ValueResourceOutcomeOfLineItemBudgetOverrides + +A top-level object that encapsulates a Criteo API response for a single value. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ValueResourceOfLineItemBudgetOverrides**](ValueResourceOfLineItemBudgetOverrides.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_2023-01/docs/ValueTypeResourceOfAddToBasketIdsUpdateModel202110.md b/sdks/retailmedia_2024-04/docs/ValueTypeResourceOfAddToBasketIdsUpdateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ValueTypeResourceOfAddToBasketIdsUpdateModel202110.md rename to sdks/retailmedia_2024-04/docs/ValueTypeResourceOfAddToBasketIdsUpdateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ValueTypeResourceOfAddToBasketTarget202110.md b/sdks/retailmedia_2024-04/docs/ValueTypeResourceOfAddToBasketTarget202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ValueTypeResourceOfAddToBasketTarget202110.md rename to sdks/retailmedia_2024-04/docs/ValueTypeResourceOfAddToBasketTarget202110.md diff --git a/sdks/retailmedia_2023-01/docs/ValueTypeResourceOfAudienceIdsUpdateModel202110.md b/sdks/retailmedia_2024-04/docs/ValueTypeResourceOfAudienceIdsUpdateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ValueTypeResourceOfAudienceIdsUpdateModel202110.md rename to sdks/retailmedia_2024-04/docs/ValueTypeResourceOfAudienceIdsUpdateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ValueTypeResourceOfAudienceTarget202110.md b/sdks/retailmedia_2024-04/docs/ValueTypeResourceOfAudienceTarget202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ValueTypeResourceOfAudienceTarget202110.md rename to sdks/retailmedia_2024-04/docs/ValueTypeResourceOfAudienceTarget202110.md diff --git a/sdks/retailmedia_2023-01/docs/ValueTypeResourceOfKeywordTarget202110.md b/sdks/retailmedia_2024-04/docs/ValueTypeResourceOfKeywordTarget202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ValueTypeResourceOfKeywordTarget202110.md rename to sdks/retailmedia_2024-04/docs/ValueTypeResourceOfKeywordTarget202110.md diff --git a/sdks/retailmedia_2023-01/docs/ValueTypeResourceOfStoreIdsUpdateModel202110.md b/sdks/retailmedia_2024-04/docs/ValueTypeResourceOfStoreIdsUpdateModel202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ValueTypeResourceOfStoreIdsUpdateModel202110.md rename to sdks/retailmedia_2024-04/docs/ValueTypeResourceOfStoreIdsUpdateModel202110.md diff --git a/sdks/retailmedia_2023-01/docs/ValueTypeResourceOfStoreTarget202110.md b/sdks/retailmedia_2024-04/docs/ValueTypeResourceOfStoreTarget202110.md similarity index 100% rename from sdks/retailmedia_2023-01/docs/ValueTypeResourceOfStoreTarget202110.md rename to sdks/retailmedia_2024-04/docs/ValueTypeResourceOfStoreTarget202110.md diff --git a/sdks/retailmedia_2023-01/requirements.txt b/sdks/retailmedia_2024-04/requirements.txt similarity index 100% rename from sdks/retailmedia_2023-01/requirements.txt rename to sdks/retailmedia_2024-04/requirements.txt diff --git a/sdks/retailmedia_2023-01/setup.cfg b/sdks/retailmedia_2024-04/setup.cfg similarity index 100% rename from sdks/retailmedia_2023-01/setup.cfg rename to sdks/retailmedia_2024-04/setup.cfg diff --git a/sdks/retailmedia_2024-04/setup.py b/sdks/retailmedia_2024-04/setup.py new file mode 100644 index 00000000..a2f85f81 --- /dev/null +++ b/sdks/retailmedia_2024-04/setup.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +from setuptools import setup, find_packages # noqa: H301 + +NAME = "criteo-api-retailmedia-sdk" +VERSION = "2024.04.0.240515" +# To install the library, run the following +# +# python setup.py install +# +# prerequisite: setuptools +# http://pypi.python.org/pypi/setuptools + +REQUIRES = ["urllib3 >= 1.25.3", "python-dateutil"] + +AUTHOR='Criteo' +README_CONTENT_TYPE='text/markdown' +PACKAGE_LONG_DESCRIPTION = """# Criteo API SDK for Python + +IMPORTANT: This Python package links to Criteo production environment. Any test applied here will thus impact real data. + +## Installation & Usage +### pip install + + +```sh +pip install criteo-api-retailmedia-sdk==2024.04.0.240515 +``` +(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.04.0.240515`) + +Then import the package: +```python +import criteo_api_retailmedia_v2024_04 +``` + +Full documentation on [Github](https://github.com/criteo/criteo-api-python-sdk). + +## Disclaimer + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +""" + +setup( + name=NAME, + version=VERSION, + description="Criteo API SDK", + author_email="", + author=AUTHOR, + url="https://github.com/criteo/criteo-api-python-sdk", + keywords=[AUTHOR, "OpenAPI-Generator", "Criteo API SDK"], + install_requires=REQUIRES, + packages=find_packages(), + include_package_data=True, + long_description_content_type=README_CONTENT_TYPE, + long_description=PACKAGE_LONG_DESCRIPTION, + classifiers=[ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Natural Language :: English", + "Operating System :: OS Independent", + "Topic :: Software Development :: Libraries", + ], + python_requires=">=3.6", +) diff --git a/sdks/retailmedia_2023-01/test-requirements.txt b/sdks/retailmedia_2024-04/test-requirements.txt similarity index 100% rename from sdks/retailmedia_2023-01/test-requirements.txt rename to sdks/retailmedia_2024-04/test-requirements.txt diff --git a/sdks/retailmedia_2024-04/test/example_application_with_auth_code.py b/sdks/retailmedia_2024-04/test/example_application_with_auth_code.py new file mode 100644 index 00000000..644c9145 --- /dev/null +++ b/sdks/retailmedia_2024-04/test/example_application_with_auth_code.py @@ -0,0 +1,27 @@ +from criteo_api_retailmedia_v2024_04.api.gateway_api import GatewayApi +from criteo_api_retailmedia_v2024_04 import ApiClientBuilder + +class ExampleApplication: + + def call_then_application_endpoint(self, clientId, clientSecret, authorization_code, redirect_uri): + # Create a client using your choosen OAuth flow, Authorization Code in this case. The client will handle the token generation/renewal for you + client = ApiClientBuilder.WithAuthorizationCode(clientId, clientSecret, authorization_code, redirect_uri) + + # The Gateway API regroups common technical endpoints that exists for all versions + # You can find the other endpoints in the other *Api + # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials + api = GatewayApi(client) + + # Perform the call to the application introspection endpoint + response = api.get_current_application() + + # Most of Criteo's API response follow the same structure: + # The response consists of a Data, Errors and Warnings fields + # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object + myApplication = response.data.attributes + print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') + + # You will need to save the refresh_token to use it in the refresh_token flow + # You can fetch the refresh token like this: + refreshToken = client.get_refresh_token() + print('The refresh token to be saved is ', refreshToken) \ No newline at end of file diff --git a/sdks/retailmedia_2024-04/test/example_application_with_client_credentials.py b/sdks/retailmedia_2024-04/test/example_application_with_client_credentials.py new file mode 100644 index 00000000..f820ce9a --- /dev/null +++ b/sdks/retailmedia_2024-04/test/example_application_with_client_credentials.py @@ -0,0 +1,22 @@ +from criteo_api_retailmedia_v2024_04.api.gateway_api import GatewayApi +from criteo_api_retailmedia_v2024_04 import ApiClientBuilder + +class ExampleApplication: + + def call_then_application_endpoint(self, clientId, clientSecret): + # Create a client using your choosen OAuth flow, Client Credentials in this case. The client will handle the token generation/renewal for you + client = ApiClientBuilder.WithClientCredentials(clientId=clientId, clientSecret=clientSecret) + + # The Gateway API regroups common technical endpoints that exists for all versions + # You can find the other endpoints in the other *Api + # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials + api = GatewayApi(client) + + # Perform the call to the application introspection endpoint + response = api.get_current_application() + + # Most of Criteo's API response follow the same structure: + # The response consists of a Data, Errors and Warnings fields + # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object + myApplication = response.data.attributes + print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') \ No newline at end of file diff --git a/sdks/retailmedia_2024-04/test/example_application_with_refresh_token.py b/sdks/retailmedia_2024-04/test/example_application_with_refresh_token.py new file mode 100644 index 00000000..6f14041a --- /dev/null +++ b/sdks/retailmedia_2024-04/test/example_application_with_refresh_token.py @@ -0,0 +1,27 @@ +from criteo_api_retailmedia_v2024_04.api.gateway_api import GatewayApi +from criteo_api_retailmedia_v2024_04 import ApiClientBuilder + +class ExampleApplication: + + def call_then_application_endpoint(self, clientId, clientSecret, refresh_token): + # Create a client using your choosen OAuth flow, Refresh Token in this case. The client will handle the token generation/renewal for you + client = ApiClientBuilder.WithRefreshToken(clientId, clientSecret, refresh_token) + + # The Gateway API regroups common technical endpoints that exists for all versions + # You can find the other endpoints in the other *Api + # You can reuse the same client with several Apis, but be careful, as they will then use the same token and credentials + api = GatewayApi(client) + + # Perform the call to the application introspection endpoint + response = api.get_current_application() + + # Most of Criteo's API response follow the same structure: + # The response consists of a Data, Errors and Warnings fields + # The Data fields contains an Id (if applicable), a Type, and an Attributes field that contains the business object + myApplication = response.data.attributes + print(f'Hello, I\'m using Criteo API and I\'m connected as {myApplication.name}') + + # You will need to save the new refresh_token to use it again in the future + # You can fetch the refresh token like this: + refreshToken = client.get_refresh_token() + print('The refresh token to be saved is ', refreshToken) \ No newline at end of file diff --git a/sdks/retailmedia_2024-04/test/test_gateway_api.py b/sdks/retailmedia_2024-04/test/test_gateway_api.py new file mode 100644 index 00000000..3a2b0ef3 --- /dev/null +++ b/sdks/retailmedia_2024-04/test/test_gateway_api.py @@ -0,0 +1,62 @@ +import pytest +import os + +from criteo_api_retailmedia_v2024_04.api.gateway_api import GatewayApi +from criteo_api_retailmedia_v2024_04.api_client_builder import ApiClientBuilder +from criteo_api_retailmedia_v2024_04.rest import ApiException +from example_application_with_client_credentials import ExampleApplication + +class TestGatewayApi: + @pytest.fixture(autouse=True) + def before_each(self): + self.client_id = os.environ.get("TEST_CLIENT_ID") + self.client_secret = os.environ.get("TEST_CLIENT_SECRET") + self.application_id = int(os.environ.get("TEST_APPLICATION_ID")) + + self.client = ApiClientBuilder.WithClientCredentials(clientId=self.client_id, clientSecret=self.client_secret) + + def test_environment_variables(self): + assert len(self.client_id) > 0, "Environment variable \"TEST_CLIENT_ID\" not found." + assert len(self.client_secret) > 0, "Environment variable \"TEST_CLIENT_SECRET\" not found." + assert self.application_id > 0, "Environment variable \"TEST_APPLICATION_ID\" not found." + + def test_example_works(self): + # Arrange + exampleApplication = ExampleApplication() + exampleApplication.call_then_application_endpoint(self.client_id, self.client_secret) + + def test_get_current_application_should_succeed_with_valid_token(self): + # Arrange + api = GatewayApi(self.client) + + # Act + http_response = api.get_current_application() + + # Assert + assert self.application_id == http_response.data.attributes.application_id + + + def test_get_current_application_should_succeed_with_renewed_invalid_token(self): + # Arrange + invalid_token = "invalid.access.token" + self.client.configuration.access_token = invalid_token + api = GatewayApi(self.client) + + # Act + http_response = api.get_current_application() + + # Assert + assert self.application_id == http_response.data.attributes.application_id + + + def test_get_current_application_should_fail_without_token(self): + # Arrange + api = GatewayApi(ApiClientBuilder.WithNoAuthorization()) + + # Act + try: + api.get_current_application() + + # Assert + except ApiException as exception: + assert exception.status == 401 diff --git a/sdks/retailmedia_2024-04/tox.ini b/sdks/retailmedia_2024-04/tox.ini new file mode 100644 index 00000000..317969e8 --- /dev/null +++ b/sdks/retailmedia_2024-04/tox.ini @@ -0,0 +1,9 @@ +[tox] +envlist = py3 + +[testenv] +deps=-r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +commands= + pytest --cov=criteo_api_retailmedia_v2024_04 diff --git a/sdks/retailmedia_preview/.openapi-generator/FILES b/sdks/retailmedia_preview/.openapi-generator/FILES index da0c4c9c..f03148d4 100644 --- a/sdks/retailmedia_preview/.openapi-generator/FILES +++ b/sdks/retailmedia_preview/.openapi-generator/FILES @@ -21,9 +21,14 @@ criteo_api_retailmedia_preview/criteo_rest.py criteo_api_retailmedia_preview/exceptions.py criteo_api_retailmedia_preview/flow_constants.py criteo_api_retailmedia_preview/model/__init__.py +criteo_api_retailmedia_preview/model/add_remove_keyword_model.py +criteo_api_retailmedia_preview/model/add_remove_keywords_model.py +criteo_api_retailmedia_preview/model/add_remove_keywords_model_request.py +criteo_api_retailmedia_preview/model/add_remove_keywords_model_resource.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/approval_status_model.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 @@ -34,6 +39,8 @@ 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/audience_error.py +criteo_api_retailmedia_preview/model/audience_warning.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 @@ -49,45 +56,67 @@ 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/creative_v2_list_response.py +criteo_api_retailmedia_preview/model/creative_v2_response.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/error_code_response.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_choice_variable_value.py +criteo_api_retailmedia_preview/model/external_color_variable_value.py +criteo_api_retailmedia_preview/model/external_creative_create_model_v2.py +criteo_api_retailmedia_preview/model/external_creative_update_model_v2.py +criteo_api_retailmedia_preview/model/external_creative_v2.py +criteo_api_retailmedia_preview/model/external_files_variable_value.py +criteo_api_retailmedia_preview/model/external_hyperlink_variable_value.py +criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.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_page_type_environment.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/external_template_variable_value.py +criteo_api_retailmedia_preview/model/external_text_variable_value.py +criteo_api_retailmedia_preview/model/external_video_variable_value.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/input_keywords.py +criteo_api_retailmedia_preview/model/input_keywords_model.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_line_item_bid_multipliers_and_line_item_bid_multipliers.py +criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.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_single_response_of_line_item_bid_multipliers.py +criteo_api_retailmedia_preview/model/json_api_single_response_of_line_item_bid_multipliers_v2.py +criteo_api_retailmedia_preview/model/keyword_data_model.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/keywords_model.py +criteo_api_retailmedia_preview/model/keywords_model_resource.py +criteo_api_retailmedia_preview/model/keywords_model_response.py +criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_request.py +criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py criteo_api_retailmedia_preview/model/line_item_budget_overrides.py +criteo_api_retailmedia_preview/model/line_item_product_status.py criteo_api_retailmedia_preview/model/loyalty_points.py +criteo_api_retailmedia_preview/model/match_type_model.py criteo_api_retailmedia_preview/model/metadata.py criteo_api_retailmedia_preview/model/monthly_line_item_budeget_override.py +criteo_api_retailmedia_preview/model/negotiation_state_model.py criteo_api_retailmedia_preview/model/page_metadata.py criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py criteo_api_retailmedia_preview/model/placement_preview.py @@ -104,6 +133,8 @@ 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_metadata.py +criteo_api_retailmedia_preview/model/product_resource_outcome.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 @@ -112,6 +143,13 @@ 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/promoted_product.py +criteo_api_retailmedia_preview/model/promoted_product_resource.py +criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.py +criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py +criteo_api_retailmedia_preview/model/proposal_status_model.py +criteo_api_retailmedia_preview/model/proposal_status_model_resource.py +criteo_api_retailmedia_preview/model/proposal_status_model_response.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 @@ -122,7 +160,8 @@ 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_line_item_bid_multipliers.py +criteo_api_retailmedia_preview/model/resource_of_creative_v2.py +criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.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 @@ -137,30 +176,20 @@ 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_outcome.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 -criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model_resource.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_input_keywords_model.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_keyword_data_model.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model_resource.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model_response.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_problem_details.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_resource.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_response.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_resource_outcome.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bid_model.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model_request.py -criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model_resource.py +criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py +criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_attributes.py +criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_request.py +criteo_api_retailmedia_preview/model/retail_media_contactlist_operation.py +criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes.py +criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes_attributes.py criteo_api_retailmedia_preview/model/retail_media_seller.py criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +criteo_api_retailmedia_preview/model/review_state_model.py criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v1.py criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v1_list_response.py criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v1_resource.py @@ -171,8 +200,13 @@ 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/rmca_common_problem.py criteo_api_retailmedia_preview/model/seller_preview.py criteo_api_retailmedia_preview/model/seller_preview_response.py +criteo_api_retailmedia_preview/model/set_bid_model.py +criteo_api_retailmedia_preview/model/set_bids_model.py +criteo_api_retailmedia_preview/model/set_bids_model_request.py +criteo_api_retailmedia_preview/model/set_bids_model_resource.py criteo_api_retailmedia_preview/model/sku_data_preview.py criteo_api_retailmedia_preview/model/sku_data_preview_list_response.py criteo_api_retailmedia_preview/model/sku_search_request.py @@ -220,10 +254,15 @@ criteo_api_retailmedia_preview/model_utils.py criteo_api_retailmedia_preview/models/__init__.py criteo_api_retailmedia_preview/rest.py docs/AccountsApi.md +docs/AddRemoveKeywordModel.md +docs/AddRemoveKeywordsModel.md +docs/AddRemoveKeywordsModelRequest.md +docs/AddRemoveKeywordsModelResource.md docs/AnalyticsApi.md docs/ApplicationSummaryModel.md docs/ApplicationSummaryModelResource.md docs/ApplicationSummaryModelResponse.md +docs/ApprovalStatusModel.md docs/AsyncAccountsReport.md docs/AsyncAccountsReportRequest.md docs/AsyncAccountsReportResource.md @@ -235,6 +274,8 @@ docs/AsyncLineItemsReportRequest.md docs/AsyncLineItemsReportResource.md docs/AsyncReportResponse.md docs/AudienceApi.md +docs/AudienceError.md +docs/AudienceWarning.md docs/BatchAcceptedResponse.md docs/Brand.md docs/BrandPreview.md @@ -252,46 +293,68 @@ docs/CommonProblem.md docs/CommonWarning.md docs/CpcRateCardPreview.md docs/CpcRateCardPreviewResponse.md +docs/CreativeV2ListResponse.md +docs/CreativeV2Response.md docs/CustomAttribute.md docs/DailyLineItemBudgetOverride.md +docs/ErrorCodeResponse.md docs/ExportReportColumn.md docs/ExportReportMetaData.md docs/ExternalAccount.md docs/ExternalBrand.md +docs/ExternalChoiceVariableValue.md +docs/ExternalColorVariableValue.md +docs/ExternalCreativeCreateModelV2.md +docs/ExternalCreativeUpdateModelV2.md +docs/ExternalCreativeV2.md +docs/ExternalFilesVariableValue.md +docs/ExternalHyperlinkVariableValue.md +docs/ExternalLineItemBidMultipliersV2.md docs/ExternalLineItemCappingV2.md docs/ExternalLineItemPageCategoryV2.md docs/ExternalLineItemPageV2.md +docs/ExternalPageTypeEnvironment.md docs/ExternalPreferredLineItemCreateModelV2.md docs/ExternalPreferredLineItemUpdateModelV2.md docs/ExternalPreferredLineItemV2.md docs/ExternalProductButtonRequest.md docs/ExternalProductButtonResponse.md docs/ExternalRetailer.md +docs/ExternalTemplateVariableValue.md +docs/ExternalTextVariableValue.md +docs/ExternalVideoVariableValue.md docs/FailResponse.md docs/GatewayApi.md docs/GrantConsentInput.md docs/GrantConsentModel.md docs/GrantConsentModelValueResource.md docs/InputKeywords.md +docs/InputKeywordsModel.md docs/InputResourceOfPreferredLineItemCreateModelV2.md docs/InsertionOrderHistoryChangeDataCapture.md docs/Installment.md docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md -docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md +docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2.md docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md docs/JsonApiPageResponseOfAccount.md docs/JsonApiPageResponseOfBrand.md docs/JsonApiPageResponseOfRetailer.md -docs/JsonApiSingleResponseOfLineItemBidMultipliers.md +docs/JsonApiSingleResponseOfLineItemBidMultipliersV2.md +docs/KeywordDataModel.md docs/Keywords.md -docs/LineItemBidMultipliers.md -docs/LineItemBidMultipliersRequest.md -docs/LineItemBidMultipliersResponse.md +docs/KeywordsModel.md +docs/KeywordsModelResource.md +docs/KeywordsModelResponse.md +docs/LineItemBidMultipliersV2Request.md +docs/LineItemBidMultipliersV2Response.md docs/LineItemBudgetOverrides.md +docs/LineItemProductStatus.md docs/LoyaltyPoints.md +docs/MatchTypeModel.md docs/Metadata.md docs/MonthlyLineItemBudegetOverride.md +docs/NegotiationStateModel.md docs/PageMetadata.md docs/PageOfInsertionOrderHistoryChangeDataCapture.md docs/PlacementPreview.md @@ -308,6 +371,8 @@ docs/ProductButtonListResponse.md docs/ProductButtonRequest.md docs/ProductImporterError.md docs/ProductImporterWarning.md +docs/ProductMetadata.md +docs/ProductResourceOutcome.md docs/ProductShipping.md docs/ProductShippingDimension.md docs/ProductShippingWeight.md @@ -316,6 +381,13 @@ docs/ProductUnitPricingBaseMeasure.md docs/ProductUnitPricingMeasure.md docs/ProductsCustomBatchRequest.md docs/ProductsCustomBatchRequestEntry.md +docs/PromotedProduct.md +docs/PromotedProductResource.md +docs/PromotedProductResourceCollectionInput.md +docs/PromotedProductResourceCollectionOutcome.md +docs/ProposalStatusModel.md +docs/ProposalStatusModelResource.md +docs/ProposalStatusModelResponse.md docs/RecommendedKeywordsResult.md docs/ReportDataResponseResource.md docs/ReportDetailError.md @@ -326,7 +398,8 @@ docs/ReportResponse.md docs/ResourceCollectionOutcomeOfSkuSearchResult.md docs/ResourceOfBrandPreview.md docs/ResourceOfCpcRateCardPreview.md -docs/ResourceOfLineItemBidMultipliers.md +docs/ResourceOfCreativeV2.md +docs/ResourceOfLineItemBidMultipliersV2.md docs/ResourceOfPlacementPreview.md docs/ResourceOfPreferredLineItemUpdateModelV2.md docs/ResourceOfPreferredLineItemV2.md @@ -341,30 +414,20 @@ docs/ResourceOfSkuSearchRequestSlimV2Preview.md docs/ResourceOfSkuSearchResult.md docs/ResourceOfSkuSlimDataPreview.md docs/ResourceOfSkuSlimDataV2.md +docs/ResourceOutcome.md docs/ResourceOutcomeOfRetailMediaAccount.md docs/RetailMediaAccount.md docs/RetailMediaBrandAccountCreation.md docs/RetailMediaBrands.md -docs/RetailMediaExternalv1AddRemoveKeywordModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModel.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md -docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md -docs/RetailMediaExternalv1InputKeywordsModel.md -docs/RetailMediaExternalv1KeywordDataModel.md -docs/RetailMediaExternalv1KeywordsModel.md -docs/RetailMediaExternalv1KeywordsModelResource.md -docs/RetailMediaExternalv1KeywordsModelResponse.md -docs/RetailMediaExternalv1ProblemDetails.md -docs/RetailMediaExternalv1ProposalStatusModel.md -docs/RetailMediaExternalv1ProposalStatusModelResource.md -docs/RetailMediaExternalv1ProposalStatusModelResponse.md -docs/RetailMediaExternalv1ResourceOutcome.md -docs/RetailMediaExternalv1SetBidModel.md -docs/RetailMediaExternalv1SetBidsModel.md -docs/RetailMediaExternalv1SetBidsModelRequest.md -docs/RetailMediaExternalv1SetBidsModelResource.md +docs/RetailMediaContactlistAmendment.md +docs/RetailMediaContactlistAmendmentAttributes.md +docs/RetailMediaContactlistAmendmentRequest.md +docs/RetailMediaContactlistOperation.md +docs/RetailMediaContactlistOperationResponseAttributes.md +docs/RetailMediaContactlistOperationResponseAttributesAttributes.md docs/RetailMediaSeller.md docs/RetailMediaSellerAccountCreation.md +docs/ReviewStateModel.md docs/RmLegacyAudienceGetEntityV1.md docs/RmLegacyAudienceGetEntityV1ListResponse.md docs/RmLegacyAudienceGetEntityV1Resource.md @@ -375,8 +438,13 @@ docs/RmLegacyAudienceUserBehaviorDetailsV2.md docs/RmLegacySegmentCustomerList.md docs/RmLegacySegmentUserBehaviorV1.md docs/RmLegacySegmentUserBehaviorV2.md +docs/RmcaCommonProblem.md docs/SellerPreview.md docs/SellerPreviewResponse.md +docs/SetBidModel.md +docs/SetBidsModel.md +docs/SetBidsModelRequest.md +docs/SetBidsModelResource.md docs/SkuDataPreview.md docs/SkuDataPreviewListResponse.md docs/SkuSearchRequest.md diff --git a/sdks/retailmedia_preview/README.md b/sdks/retailmedia_preview/README.md index 1b526104..7b9576c0 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.240404 +- Package version: 0.0.240515 ## Requirements @@ -18,9 +18,9 @@ Python 2.7 and 3.5+ ### pip install ```sh -pip install criteo-api-retailmedia-sdk==0.0.240404 +pip install criteo-api-retailmedia-sdk==0.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python @@ -60,9 +60,14 @@ Class | Method | HTTP request | Description ## Documentation For Models + - [AddRemoveKeywordModel](docs/AddRemoveKeywordModel.md) + - [AddRemoveKeywordsModel](docs/AddRemoveKeywordsModel.md) + - [AddRemoveKeywordsModelRequest](docs/AddRemoveKeywordsModelRequest.md) + - [AddRemoveKeywordsModelResource](docs/AddRemoveKeywordsModelResource.md) - [ApplicationSummaryModel](docs/ApplicationSummaryModel.md) - [ApplicationSummaryModelResource](docs/ApplicationSummaryModelResource.md) - [ApplicationSummaryModelResponse](docs/ApplicationSummaryModelResponse.md) + - [ApprovalStatusModel](docs/ApprovalStatusModel.md) - [AsyncAccountsReport](docs/AsyncAccountsReport.md) - [AsyncAccountsReportRequest](docs/AsyncAccountsReportRequest.md) - [AsyncAccountsReportResource](docs/AsyncAccountsReportResource.md) @@ -73,6 +78,8 @@ Class | Method | HTTP request | Description - [AsyncLineItemsReportRequest](docs/AsyncLineItemsReportRequest.md) - [AsyncLineItemsReportResource](docs/AsyncLineItemsReportResource.md) - [AsyncReportResponse](docs/AsyncReportResponse.md) + - [AudienceError](docs/AudienceError.md) + - [AudienceWarning](docs/AudienceWarning.md) - [BatchAcceptedResponse](docs/BatchAcceptedResponse.md) - [Brand](docs/Brand.md) - [BrandPreview](docs/BrandPreview.md) @@ -88,45 +95,67 @@ Class | Method | HTTP request | Description - [CommonWarning](docs/CommonWarning.md) - [CpcRateCardPreview](docs/CpcRateCardPreview.md) - [CpcRateCardPreviewResponse](docs/CpcRateCardPreviewResponse.md) + - [CreativeV2ListResponse](docs/CreativeV2ListResponse.md) + - [CreativeV2Response](docs/CreativeV2Response.md) - [CustomAttribute](docs/CustomAttribute.md) - [DailyLineItemBudgetOverride](docs/DailyLineItemBudgetOverride.md) + - [ErrorCodeResponse](docs/ErrorCodeResponse.md) - [ExportReportColumn](docs/ExportReportColumn.md) - [ExportReportMetaData](docs/ExportReportMetaData.md) - [ExternalAccount](docs/ExternalAccount.md) - [ExternalBrand](docs/ExternalBrand.md) + - [ExternalChoiceVariableValue](docs/ExternalChoiceVariableValue.md) + - [ExternalColorVariableValue](docs/ExternalColorVariableValue.md) + - [ExternalCreativeCreateModelV2](docs/ExternalCreativeCreateModelV2.md) + - [ExternalCreativeUpdateModelV2](docs/ExternalCreativeUpdateModelV2.md) + - [ExternalCreativeV2](docs/ExternalCreativeV2.md) + - [ExternalFilesVariableValue](docs/ExternalFilesVariableValue.md) + - [ExternalHyperlinkVariableValue](docs/ExternalHyperlinkVariableValue.md) + - [ExternalLineItemBidMultipliersV2](docs/ExternalLineItemBidMultipliersV2.md) - [ExternalLineItemCappingV2](docs/ExternalLineItemCappingV2.md) - [ExternalLineItemPageCategoryV2](docs/ExternalLineItemPageCategoryV2.md) - [ExternalLineItemPageV2](docs/ExternalLineItemPageV2.md) + - [ExternalPageTypeEnvironment](docs/ExternalPageTypeEnvironment.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) + - [ExternalTemplateVariableValue](docs/ExternalTemplateVariableValue.md) + - [ExternalTextVariableValue](docs/ExternalTextVariableValue.md) + - [ExternalVideoVariableValue](docs/ExternalVideoVariableValue.md) - [FailResponse](docs/FailResponse.md) - [GrantConsentInput](docs/GrantConsentInput.md) - [GrantConsentModel](docs/GrantConsentModel.md) - [GrantConsentModelValueResource](docs/GrantConsentModelValueResource.md) - [InputKeywords](docs/InputKeywords.md) + - [InputKeywordsModel](docs/InputKeywordsModel.md) - [InputResourceOfPreferredLineItemCreateModelV2](docs/InputResourceOfPreferredLineItemCreateModelV2.md) - [InsertionOrderHistoryChangeDataCapture](docs/InsertionOrderHistoryChangeDataCapture.md) - [Installment](docs/Installment.md) - [JsonApiBodyWithIdOfInt64AndAccountAndAccount](docs/JsonApiBodyWithIdOfInt64AndAccountAndAccount.md) - [JsonApiBodyWithIdOfInt64AndBrandAndBrand](docs/JsonApiBodyWithIdOfInt64AndBrandAndBrand.md) - - [JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers](docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md) + - [JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2](docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2.md) - [JsonApiBodyWithIdOfInt64AndRetailerAndRetailer](docs/JsonApiBodyWithIdOfInt64AndRetailerAndRetailer.md) - [JsonApiPageResponseOfAccount](docs/JsonApiPageResponseOfAccount.md) - [JsonApiPageResponseOfBrand](docs/JsonApiPageResponseOfBrand.md) - [JsonApiPageResponseOfRetailer](docs/JsonApiPageResponseOfRetailer.md) - - [JsonApiSingleResponseOfLineItemBidMultipliers](docs/JsonApiSingleResponseOfLineItemBidMultipliers.md) + - [JsonApiSingleResponseOfLineItemBidMultipliersV2](docs/JsonApiSingleResponseOfLineItemBidMultipliersV2.md) + - [KeywordDataModel](docs/KeywordDataModel.md) - [Keywords](docs/Keywords.md) - - [LineItemBidMultipliers](docs/LineItemBidMultipliers.md) - - [LineItemBidMultipliersRequest](docs/LineItemBidMultipliersRequest.md) - - [LineItemBidMultipliersResponse](docs/LineItemBidMultipliersResponse.md) + - [KeywordsModel](docs/KeywordsModel.md) + - [KeywordsModelResource](docs/KeywordsModelResource.md) + - [KeywordsModelResponse](docs/KeywordsModelResponse.md) + - [LineItemBidMultipliersV2Request](docs/LineItemBidMultipliersV2Request.md) + - [LineItemBidMultipliersV2Response](docs/LineItemBidMultipliersV2Response.md) - [LineItemBudgetOverrides](docs/LineItemBudgetOverrides.md) + - [LineItemProductStatus](docs/LineItemProductStatus.md) - [LoyaltyPoints](docs/LoyaltyPoints.md) + - [MatchTypeModel](docs/MatchTypeModel.md) - [Metadata](docs/Metadata.md) - [MonthlyLineItemBudegetOverride](docs/MonthlyLineItemBudegetOverride.md) + - [NegotiationStateModel](docs/NegotiationStateModel.md) - [PageMetadata](docs/PageMetadata.md) - [PageOfInsertionOrderHistoryChangeDataCapture](docs/PageOfInsertionOrderHistoryChangeDataCapture.md) - [PlacementPreview](docs/PlacementPreview.md) @@ -143,6 +172,8 @@ Class | Method | HTTP request | Description - [ProductButtonRequest](docs/ProductButtonRequest.md) - [ProductImporterError](docs/ProductImporterError.md) - [ProductImporterWarning](docs/ProductImporterWarning.md) + - [ProductMetadata](docs/ProductMetadata.md) + - [ProductResourceOutcome](docs/ProductResourceOutcome.md) - [ProductShipping](docs/ProductShipping.md) - [ProductShippingDimension](docs/ProductShippingDimension.md) - [ProductShippingWeight](docs/ProductShippingWeight.md) @@ -151,6 +182,13 @@ Class | Method | HTTP request | Description - [ProductUnitPricingMeasure](docs/ProductUnitPricingMeasure.md) - [ProductsCustomBatchRequest](docs/ProductsCustomBatchRequest.md) - [ProductsCustomBatchRequestEntry](docs/ProductsCustomBatchRequestEntry.md) + - [PromotedProduct](docs/PromotedProduct.md) + - [PromotedProductResource](docs/PromotedProductResource.md) + - [PromotedProductResourceCollectionInput](docs/PromotedProductResourceCollectionInput.md) + - [PromotedProductResourceCollectionOutcome](docs/PromotedProductResourceCollectionOutcome.md) + - [ProposalStatusModel](docs/ProposalStatusModel.md) + - [ProposalStatusModelResource](docs/ProposalStatusModelResource.md) + - [ProposalStatusModelResponse](docs/ProposalStatusModelResponse.md) - [RecommendedKeywordsResult](docs/RecommendedKeywordsResult.md) - [ReportDataResponseResource](docs/ReportDataResponseResource.md) - [ReportDetailError](docs/ReportDetailError.md) @@ -161,7 +199,8 @@ Class | Method | HTTP request | Description - [ResourceCollectionOutcomeOfSkuSearchResult](docs/ResourceCollectionOutcomeOfSkuSearchResult.md) - [ResourceOfBrandPreview](docs/ResourceOfBrandPreview.md) - [ResourceOfCpcRateCardPreview](docs/ResourceOfCpcRateCardPreview.md) - - [ResourceOfLineItemBidMultipliers](docs/ResourceOfLineItemBidMultipliers.md) + - [ResourceOfCreativeV2](docs/ResourceOfCreativeV2.md) + - [ResourceOfLineItemBidMultipliersV2](docs/ResourceOfLineItemBidMultipliersV2.md) - [ResourceOfPlacementPreview](docs/ResourceOfPlacementPreview.md) - [ResourceOfPreferredLineItemUpdateModelV2](docs/ResourceOfPreferredLineItemUpdateModelV2.md) - [ResourceOfPreferredLineItemV2](docs/ResourceOfPreferredLineItemV2.md) @@ -176,30 +215,20 @@ Class | Method | HTTP request | Description - [ResourceOfSkuSearchResult](docs/ResourceOfSkuSearchResult.md) - [ResourceOfSkuSlimDataPreview](docs/ResourceOfSkuSlimDataPreview.md) - [ResourceOfSkuSlimDataV2](docs/ResourceOfSkuSlimDataV2.md) + - [ResourceOutcome](docs/ResourceOutcome.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) - - [RetailMediaExternalv1AddRemoveKeywordsModelResource](docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md) - - [RetailMediaExternalv1InputKeywordsModel](docs/RetailMediaExternalv1InputKeywordsModel.md) - - [RetailMediaExternalv1KeywordDataModel](docs/RetailMediaExternalv1KeywordDataModel.md) - - [RetailMediaExternalv1KeywordsModel](docs/RetailMediaExternalv1KeywordsModel.md) - - [RetailMediaExternalv1KeywordsModelResource](docs/RetailMediaExternalv1KeywordsModelResource.md) - - [RetailMediaExternalv1KeywordsModelResponse](docs/RetailMediaExternalv1KeywordsModelResponse.md) - - [RetailMediaExternalv1ProblemDetails](docs/RetailMediaExternalv1ProblemDetails.md) - - [RetailMediaExternalv1ProposalStatusModel](docs/RetailMediaExternalv1ProposalStatusModel.md) - - [RetailMediaExternalv1ProposalStatusModelResource](docs/RetailMediaExternalv1ProposalStatusModelResource.md) - - [RetailMediaExternalv1ProposalStatusModelResponse](docs/RetailMediaExternalv1ProposalStatusModelResponse.md) - - [RetailMediaExternalv1ResourceOutcome](docs/RetailMediaExternalv1ResourceOutcome.md) - - [RetailMediaExternalv1SetBidModel](docs/RetailMediaExternalv1SetBidModel.md) - - [RetailMediaExternalv1SetBidsModel](docs/RetailMediaExternalv1SetBidsModel.md) - - [RetailMediaExternalv1SetBidsModelRequest](docs/RetailMediaExternalv1SetBidsModelRequest.md) - - [RetailMediaExternalv1SetBidsModelResource](docs/RetailMediaExternalv1SetBidsModelResource.md) + - [RetailMediaContactlistAmendment](docs/RetailMediaContactlistAmendment.md) + - [RetailMediaContactlistAmendmentAttributes](docs/RetailMediaContactlistAmendmentAttributes.md) + - [RetailMediaContactlistAmendmentRequest](docs/RetailMediaContactlistAmendmentRequest.md) + - [RetailMediaContactlistOperation](docs/RetailMediaContactlistOperation.md) + - [RetailMediaContactlistOperationResponseAttributes](docs/RetailMediaContactlistOperationResponseAttributes.md) + - [RetailMediaContactlistOperationResponseAttributesAttributes](docs/RetailMediaContactlistOperationResponseAttributesAttributes.md) - [RetailMediaSeller](docs/RetailMediaSeller.md) - [RetailMediaSellerAccountCreation](docs/RetailMediaSellerAccountCreation.md) + - [ReviewStateModel](docs/ReviewStateModel.md) - [RmLegacyAudienceGetEntityV1](docs/RmLegacyAudienceGetEntityV1.md) - [RmLegacyAudienceGetEntityV1ListResponse](docs/RmLegacyAudienceGetEntityV1ListResponse.md) - [RmLegacyAudienceGetEntityV1Resource](docs/RmLegacyAudienceGetEntityV1Resource.md) @@ -210,8 +239,13 @@ Class | Method | HTTP request | Description - [RmLegacySegmentCustomerList](docs/RmLegacySegmentCustomerList.md) - [RmLegacySegmentUserBehaviorV1](docs/RmLegacySegmentUserBehaviorV1.md) - [RmLegacySegmentUserBehaviorV2](docs/RmLegacySegmentUserBehaviorV2.md) + - [RmcaCommonProblem](docs/RmcaCommonProblem.md) - [SellerPreview](docs/SellerPreview.md) - [SellerPreviewResponse](docs/SellerPreviewResponse.md) + - [SetBidModel](docs/SetBidModel.md) + - [SetBidsModel](docs/SetBidsModel.md) + - [SetBidsModelRequest](docs/SetBidsModelRequest.md) + - [SetBidsModelResource](docs/SetBidsModelResource.md) - [SkuDataPreview](docs/SkuDataPreview.md) - [SkuDataPreviewListResponse](docs/SkuDataPreviewListResponse.md) - [SkuSearchRequest](docs/SkuSearchRequest.md) diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/__init__.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/__init__.py index 462480cb..d42199eb 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.240404" +__version__ = "0.0.240515" # import ApiClient from criteo_api_retailmedia_preview.api_client import ApiClient diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/audience_api.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/audience_api.py index 39f4a6c2..1dd3ee32 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/audience_api.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/api/audience_api.py @@ -21,6 +21,9 @@ none_type, validate_and_convert_types ) +from criteo_api_retailmedia_preview.model.error_code_response import ErrorCodeResponse +from criteo_api_retailmedia_preview.model.retail_media_contactlist_amendment_request import RetailMediaContactlistAmendmentRequest +from criteo_api_retailmedia_preview.model.retail_media_contactlist_operation import RetailMediaContactlistOperation from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse @@ -36,6 +39,58 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client + self.delete_contact_list_identifiers_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/audience-segments/{audience-segment-id}/contact-list/clear', + 'operation_id': 'delete_contact_list_identifiers', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_id', + ], + 'required': [ + 'audience_segment_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_id': + (int,), + }, + 'attribute_map': { + 'audience_segment_id': 'audience-segment-id', + }, + 'location_map': { + 'audience_segment_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.legacy_get_audience_v1_endpoint = _Endpoint( settings={ 'response_type': (RmLegacyAudienceGetEntityV1ListResponse,), @@ -176,6 +231,148 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_contact_list_identifiers_endpoint = _Endpoint( + settings={ + 'response_type': (RetailMediaContactlistOperation,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove', + 'operation_id': 'update_contact_list_identifiers', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'audience_segment_id', + 'retail_media_contactlist_amendment_request', + ], + 'required': [ + 'audience_segment_id', + 'retail_media_contactlist_amendment_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'audience_segment_id': + (int,), + 'retail_media_contactlist_amendment_request': + (RetailMediaContactlistAmendmentRequest,), + }, + 'attribute_map': { + 'audience_segment_id': 'audience-segment-id', + }, + 'location_map': { + 'audience_segment_id': 'path', + 'retail_media_contactlist_amendment_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def delete_contact_list_identifiers( + self, + audience_segment_id, + **kwargs + ): + """delete_contact_list_identifiers # noqa: E501 + + Delete all identifiers from a retail-media contact list audience-segment, with external audience segment 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.delete_contact_list_identifiers(audience_segment_id, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_id (int): The id of the contact list audience-segment to amend, we only accept external Id here + + 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: + None + 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['audience_segment_id'] = \ + audience_segment_id + return self.delete_contact_list_identifiers_endpoint.call_with_http_info(**kwargs) def legacy_get_audience_v1( self, @@ -349,3 +546,90 @@ def legacy_get_audience_v2( account_id return self.legacy_get_audience_v2_endpoint.call_with_http_info(**kwargs) + def update_contact_list_identifiers( + self, + audience_segment_id, + retail_media_contactlist_amendment_request, + **kwargs + ): + """update_contact_list_identifiers # noqa: E501 + + Add/remove identifiers to or from a retail-media contact list audience-segment, with external audience segment 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.update_contact_list_identifiers(audience_segment_id, retail_media_contactlist_amendment_request, async_req=True) + >>> result = thread.get() + + Args: + audience_segment_id (int): The id of the contact list audience-segment to amend, we only accept external Id here + retail_media_contactlist_amendment_request (RetailMediaContactlistAmendmentRequest): + + 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: + RetailMediaContactlistOperation + 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['audience_segment_id'] = \ + audience_segment_id + kwargs['retail_media_contactlist_amendment_request'] = \ + retail_media_contactlist_amendment_request + return self.update_contact_list_identifiers_endpoint.call_with_http_info(**kwargs) + 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 6277222a..77706747 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 @@ -21,14 +21,20 @@ none_type, validate_and_convert_types ) +from criteo_api_retailmedia_preview.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest 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.creative_v2_list_response import CreativeV2ListResponse +from criteo_api_retailmedia_preview.model.creative_v2_response import CreativeV2Response +from criteo_api_retailmedia_preview.model.external_creative_create_model_v2 import ExternalCreativeCreateModelV2 +from criteo_api_retailmedia_preview.model.external_creative_update_model_v2 import ExternalCreativeUpdateModelV2 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_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.json_api_single_response_of_line_item_bid_multipliers_v2 import JsonApiSingleResponseOfLineItemBidMultipliersV2 +from criteo_api_retailmedia_preview.model.keywords_model_response import KeywordsModelResponse +from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_v2_request import LineItemBidMultipliersV2Request +from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_v2_response import LineItemBidMultipliersV2Response 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 @@ -38,13 +44,14 @@ 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_resource_outcome import ProductResourceOutcome +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_outcome import PromotedProductResourceCollectionOutcome +from criteo_api_retailmedia_preview.model.proposal_status_model_response import ProposalStatusModelResponse from criteo_api_retailmedia_preview.model.resource_collection_outcome_of_sku_search_result import ResourceCollectionOutcomeOfSkuSearchResult -from criteo_api_retailmedia_preview.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest -from criteo_api_retailmedia_preview.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_preview.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_preview.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_preview.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_preview.model.resource_outcome import ResourceOutcome from criteo_api_retailmedia_preview.model.seller_preview_response import SellerPreviewResponse +from criteo_api_retailmedia_preview.model.set_bids_model_request import SetBidsModelRequest from criteo_api_retailmedia_preview.model.sku_data_preview_list_response import SkuDataPreviewListResponse from criteo_api_retailmedia_preview.model.sku_search_request import SkuSearchRequest from criteo_api_retailmedia_preview.model.sku_search_request_preview_request import SkuSearchRequestPreviewRequest @@ -72,7 +79,7 @@ def __init__(self, api_client=None): self.api_client = api_client self.add_remove_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' @@ -85,7 +92,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'id', - 'retail_media_externalv1_add_remove_keywords_model_request', + 'add_remove_keywords_model_request', ], 'required': [ 'id', @@ -105,24 +112,80 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'retail_media_externalv1_add_remove_keywords_model_request': - (RetailMediaExternalv1AddRemoveKeywordsModelRequest,), + 'add_remove_keywords_model_request': + (AddRemoveKeywordsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', - 'retail_media_externalv1_add_remove_keywords_model_request': 'body', + 'add_remove_keywords_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.append_promoted_products_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products/append', + 'operation_id': 'append_promoted_products', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'promoted_product_resource_collection_input', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'promoted_product_resource_collection_input': + (PromotedProductResourceCollectionInput,), + }, + 'attribute_map': { + 'line_item_id': 'lineItemId', + }, + 'location_map': { + 'line_item_id': 'path', + 'promoted_product_resource_collection_input': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' ], 'content_type': [ 'application/json' @@ -186,9 +249,67 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_promoted_products_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products/delete', + 'operation_id': 'delete_promoted_products', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'promoted_product_resource_collection_input', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'promoted_product_resource_collection_input': + (PromotedProductResourceCollectionInput,), + }, + 'attribute_map': { + 'line_item_id': 'lineItemId', + }, + 'location_map': { + 'line_item_id': 'path', + 'promoted_product_resource_collection_input': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.fetch_keywords_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1KeywordsModelResponse,), + 'response_type': (KeywordsModelResponse,), 'auth': [ 'oauth', 'oauth' @@ -232,32 +353,33 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, api_client=api_client ) - self.fetch_proposal_endpoint = _Endpoint( + self.fetch_promoted_products_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (PromotedProductResourceCollectionOutcome,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/preferred-deal-line-items/{id}/proposal', - 'operation_id': 'fetch_proposal', + 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products', + 'operation_id': 'fetch_promoted_products', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', + 'line_item_id', + 'offset', + 'limit', + 'fields', ], 'required': [ - 'id', + 'line_item_id', ], 'nullable': [ ], @@ -272,46 +394,56 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'id': + 'line_item_id': + (str,), + 'offset': + (int,), + 'limit': + (int,), + 'fields': (str,), }, 'attribute_map': { - 'id': 'id', + 'line_item_id': 'lineItemId', + 'offset': 'offset', + 'limit': 'limit', + 'fields': 'fields', }, 'location_map': { - 'id': 'path', + 'line_item_id': 'path', + 'offset': 'query', + 'limit': 'query', + 'fields': 'query', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, api_client=api_client ) - self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint = _Endpoint( + self.fetch_proposal_endpoint = _Endpoint( settings={ - 'response_type': (ProductButtonListResponse,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons', - 'operation_id': 'get_api202210_external_line_item_product_buttons_by_line_item_id', + 'endpoint_path': '/preview/retail-media/preferred-deal-line-items/{id}/proposal', + 'operation_id': 'fetch_proposal', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'line_item_id', + 'id', ], 'required': [ - 'line_item_id', + 'id', ], 'nullable': [ ], @@ -326,14 +458,14 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'line_item_id': + 'id': (str,), }, 'attribute_map': { - 'line_item_id': 'line-item-id', + 'id': 'id', }, 'location_map': { - 'line_item_id': 'path', + 'id': 'path', }, 'collection_format_map': { } @@ -346,26 +478,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint = _Endpoint( + self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint = _Endpoint( settings={ 'response_type': (ProductButtonListResponse,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}', - 'operation_id': 'get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id', + 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons', + 'operation_id': 'get_api202210_external_line_item_product_buttons_by_line_item_id', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'line_item_id', - 'product_button_id', ], 'required': [ 'line_item_id', - 'product_button_id', ], 'nullable': [ ], @@ -382,16 +512,12 @@ def __init__(self, api_client=None): 'openapi_types': { 'line_item_id': (str,), - 'product_button_id': - (str,), }, 'attribute_map': { 'line_item_id': 'line-item-id', - 'product_button_id': 'product-button-id', }, 'location_map': { 'line_item_id': 'path', - 'product_button_id': 'path', }, 'collection_format_map': { } @@ -404,24 +530,26 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint( + self.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiSingleResponseOfLineItemBidMultipliers,), + 'response_type': (ProductButtonListResponse,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/bid-multipliers', - 'operation_id': 'get_api202301_external_line_item_bid_multipliers_by_line_item_id', + 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}', + 'operation_id': 'get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'line_item_id', + 'product_button_id', ], 'required': [ 'line_item_id', + 'product_button_id', ], 'nullable': [ ], @@ -438,21 +566,23 @@ def __init__(self, api_client=None): 'openapi_types': { 'line_item_id': (str,), + 'product_button_id': + (str,), }, 'attribute_map': { 'line_item_id': 'line-item-id', + 'product_button_id': 'product-button-id', }, 'location_map': { 'line_item_id': 'path', + 'product_button_id': 'path', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -899,6 +1029,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint( + settings={ + 'response_type': (CreativeV2Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}', + 'operation_id': 'get_api_v2_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': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint( settings={ 'response_type': (PreferredLineItemV2PagedListResponse,), @@ -967,15 +1157,15 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( + self.get_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint( settings={ - 'response_type': (PreferredLineItemV2Response,), + 'response_type': (JsonApiSingleResponseOfLineItemBidMultipliersV2,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}', - 'operation_id': 'get_api_v2_external_preferred_line_item_by_line_item_id', + 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/bid-multipliers', + 'operation_id': 'get_api_v2_external_line_item_bid_multipliers_by_line_item_id', 'http_method': 'GET', 'servers': None, }, @@ -1013,27 +1203,81 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, api_client=api_client ) - self.get_campaign_budget_overrides_endpoint = _Endpoint( + self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( settings={ - 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,), + 'response_type': (PreferredLineItemV2Response,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides', - 'operation_id': 'get_campaign_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, }, params_map={ 'all': [ - 'campaign_id', + 'line_item_id', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + }, + 'attribute_map': { + 'line_item_id': 'line-item-id', + }, + 'location_map': { + 'line_item_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_campaign_budget_overrides_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides', + 'operation_id': 'get_campaign_budget_overrides', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'campaign_id', ], 'required': [ 'campaign_id', @@ -1356,6 +1600,64 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.pause_promoted_products_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products/pause', + 'operation_id': 'pause_promoted_products', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'promoted_product_resource_collection_input', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'promoted_product_resource_collection_input': + (PromotedProductResourceCollectionInput,), + }, + 'attribute_map': { + 'line_item_id': 'lineItemId', + }, + 'location_map': { + 'line_item_id': 'path', + 'promoted_product_resource_collection_input': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint( settings={ 'response_type': (PreferredLineItemV2Response,), @@ -1782,6 +2084,126 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.post_api_v2_external_account_creatives_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (CreativeV2Response,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives', + 'operation_id': 'post_api_v2_external_account_creatives_by_account_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'external_creative_create_model_v2', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'external_creative_create_model_v2': + (ExternalCreativeCreateModelV2,), + }, + 'attribute_map': { + 'account_id': 'account-id', + }, + 'location_map': { + 'account_id': 'path', + 'external_creative_create_model_v2': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.post_api_v2_external_account_creatives_search_by_account_id_endpoint = _Endpoint( + settings={ + 'response_type': (CreativeV2ListResponse,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/search', + 'operation_id': 'post_api_v2_external_account_creatives_search_by_account_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_id', + 'creative_ids', + ], + 'required': [ + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'account_id': + (str,), + 'creative_ids': + ([str],), + }, + 'attribute_map': { + 'account_id': 'account-id', + 'creative_ids': 'creative-ids', + }, + 'location_map': { + 'account_id': 'path', + 'creative_ids': 'query', + }, + 'collection_format_map': { + 'creative_ids': 'multi', + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint( settings={ 'response_type': (PreferredLineItemV2Response,), @@ -1905,25 +2327,27 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.put_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint( + self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint( settings={ - 'response_type': (LineItemBidMultipliersResponse,), + 'response_type': (CreativeV2Response,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/bid-multipliers', - 'operation_id': 'put_api202301_external_line_item_bid_multipliers_by_line_item_id', + 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}', + 'operation_id': 'put_api_v2_external_account_by_account_id_creativescreative_id', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'line_item_id', - 'line_item_bid_multipliers_request', + 'account_id', + 'creative_id', + 'external_creative_update_model_v2', ], 'required': [ - 'line_item_id', + 'account_id', + 'creative_id', ], 'nullable': [ ], @@ -1938,17 +2362,21 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'line_item_id': + 'account_id': + (str,), + 'creative_id': (str,), - 'line_item_bid_multipliers_request': - (LineItemBidMultipliersRequest,), + 'external_creative_update_model_v2': + (ExternalCreativeUpdateModelV2,), }, 'attribute_map': { - 'line_item_id': 'line-item-id', + 'account_id': 'account-id', + 'creative_id': 'creative-id', }, 'location_map': { - 'line_item_id': 'path', - 'line_item_bid_multipliers_request': 'body', + 'account_id': 'path', + 'creative_id': 'path', + 'external_creative_update_model_v2': 'body', }, 'collection_format_map': { } @@ -1965,25 +2393,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.set_keyword_bids_endpoint = _Endpoint( + self.put_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ResourceOutcome,), + 'response_type': (LineItemBidMultipliersV2Response,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/line-items/{id}/keywords/set-bid', - 'operation_id': 'set_keyword_bids', - 'http_method': 'POST', + 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/bid-multipliers', + 'operation_id': 'put_api_v2_external_line_item_bid_multipliers_by_line_item_id', + 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'id', - 'retail_media_externalv1_set_bids_model_request', + 'line_item_id', + 'line_item_bid_multipliers_v2_request', ], 'required': [ - 'id', + 'line_item_id', ], 'nullable': [ ], @@ -1998,17 +2426,17 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'id': + 'line_item_id': (str,), - 'retail_media_externalv1_set_bids_model_request': - (RetailMediaExternalv1SetBidsModelRequest,), + 'line_item_bid_multipliers_v2_request': + (LineItemBidMultipliersV2Request,), }, 'attribute_map': { - 'id': 'id', + 'line_item_id': 'line-item-id', }, 'location_map': { - 'id': 'path', - 'retail_media_externalv1_set_bids_model_request': 'body', + 'line_item_id': 'path', + 'line_item_bid_multipliers_v2_request': 'body', }, 'collection_format_map': { } @@ -2025,21 +2453,22 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.submit_proposal_endpoint = _Endpoint( + self.set_keyword_bids_endpoint = _Endpoint( settings={ - 'response_type': (RetailMediaExternalv1ProposalStatusModelResponse,), + 'response_type': (ResourceOutcome,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/preferred-deal-line-items/{id}/proposal/submit', - 'operation_id': 'submit_proposal', + 'endpoint_path': '/preview/retail-media/line-items/{id}/keywords/set-bid', + 'operation_id': 'set_keyword_bids', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'id', + 'set_bids_model_request', ], 'required': [ 'id', @@ -2059,38 +2488,151 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), + 'set_bids_model_request': + (SetBidsModelRequest,), }, 'attribute_map': { 'id': 'id', }, 'location_map': { 'id': 'path', + 'set_bids_model_request': 'body', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], - 'content_type': [], + 'content_type': [ + 'application/json' + ] }, api_client=api_client ) - self.update_campaign_budget_overrides_endpoint = _Endpoint( + self.submit_proposal_endpoint = _Endpoint( settings={ - 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,), + 'response_type': (ProposalStatusModelResponse,), 'auth': [ 'oauth', 'oauth' ], - 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides', - 'operation_id': 'update_campaign_budget_overrides', - 'http_method': 'PUT', - 'servers': None, - }, + 'endpoint_path': '/preview/retail-media/preferred-deal-line-items/{id}/proposal/submit', + 'operation_id': 'submit_proposal', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.unpause_promoted_products_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products/unpause', + 'operation_id': 'unpause_promoted_products', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'line_item_id', + 'promoted_product_resource_collection_input', + ], + 'required': [ + 'line_item_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'line_item_id': + (str,), + 'promoted_product_resource_collection_input': + (PromotedProductResourceCollectionInput,), + }, + 'attribute_map': { + 'line_item_id': 'lineItemId', + }, + 'location_map': { + 'line_item_id': 'path', + 'promoted_product_resource_collection_input': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_campaign_budget_overrides_endpoint = _Endpoint( + settings={ + 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,), + 'auth': [ + 'oauth', + 'oauth' + ], + 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides', + 'operation_id': 'update_campaign_budget_overrides', + 'http_method': 'PUT', + 'servers': None, + }, params_map={ 'all': [ 'campaign_id', @@ -2209,7 +2751,7 @@ def add_remove_keywords( ): """add_remove_keywords # noqa: E501 - Add or Remove keywords from the associated line item in bulk # noqa: E501 + Add or Remove keywords from the line item in bulk # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2217,10 +2759,10 @@ def add_remove_keywords( >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_add_remove_keywords_model_request (RetailMediaExternalv1AddRemoveKeywordsModelRequest): Object containing keywords to be added or removed. [optional] + add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [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 @@ -2253,7 +2795,7 @@ def add_remove_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -2286,6 +2828,90 @@ def add_remove_keywords( id return self.add_remove_keywords_endpoint.call_with_http_info(**kwargs) + def append_promoted_products( + self, + line_item_id, + **kwargs + ): + """append_promoted_products # noqa: E501 + + Append a collection of promoted products 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.append_promoted_products(line_item_id, async_req=True) + >>> result = thread.get() + + Args: + line_item_id (str): ID of the line item + + Keyword Args: + promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [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: + None + 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.append_promoted_products_endpoint.call_with_http_info(**kwargs) + def delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id( self, line_item_id, @@ -2373,24 +2999,25 @@ def delete_api202210_external_line_item_product_buttons_by_line_item_id_product_ product_button_id return self.delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs) - def fetch_keywords( + def delete_promoted_products( self, - id, + line_item_id, **kwargs ): - """fetch_keywords # noqa: E501 + """delete_promoted_products # noqa: E501 - Fetch keywords associated with the specified line item # noqa: E501 + Remove a collection of promoted products from 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.fetch_keywords(id, async_req=True) + >>> thread = api.delete_promoted_products(line_item_id, async_req=True) >>> result = thread.get() Args: - id (str): Long external id of the associated line item + line_item_id (str): ID of the line item Keyword Args: + promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [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 @@ -2423,7 +3050,7 @@ def fetch_keywords( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1KeywordsModelResponse + None If the method is called asynchronously, returns the request thread. """ @@ -2452,26 +3079,26 @@ def fetch_keywords( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.fetch_keywords_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + return self.delete_promoted_products_endpoint.call_with_http_info(**kwargs) - def fetch_proposal( + def fetch_keywords( self, id, **kwargs ): - """fetch_proposal # noqa: E501 + """fetch_keywords # noqa: E501 - Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501 + Fetch keywords associated with the specified 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) + >>> thread = api.fetch_keywords(id, async_req=True) >>> result = thread.get() Args: - id (str): The external id of a line item. + id (str): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -2506,7 +3133,7 @@ def fetch_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + KeywordsModelResponse If the method is called asynchronously, returns the request thread. """ @@ -2537,26 +3164,29 @@ def fetch_proposal( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.fetch_proposal_endpoint.call_with_http_info(**kwargs) + return self.fetch_keywords_endpoint.call_with_http_info(**kwargs) - def get_api202210_external_line_item_product_buttons_by_line_item_id( + def fetch_promoted_products( self, line_item_id, **kwargs ): - """get_api202210_external_line_item_product_buttons_by_line_item_id # noqa: E501 + """fetch_promoted_products # noqa: E501 - Get all the product buttons associated with a line item # noqa: E501 + Retrieve a page of promoted products 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_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id, async_req=True) + >>> thread = api.fetch_promoted_products(line_item_id, async_req=True) >>> result = thread.get() Args: - line_item_id (str): Long external id of the associated line item + line_item_id (str): ID of the line item. Keyword Args: + offset (int): Offset of the first item to fetch. Defaults to zero.. [optional] + limit (int): Maximum page size to fetch. Defaults to 500.. [optional] + fields (str): A comma separated list of attribute names from the response model to compute and return. Valid values are `status` and `bidOverride` in any order. Defaults to `status`.. [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 @@ -2589,7 +3219,7 @@ def get_api202210_external_line_item_product_buttons_by_line_item_id( async_req (bool): execute request asynchronously Returns: - ProductButtonListResponse + PromotedProductResourceCollectionOutcome If the method is called asynchronously, returns the request thread. """ @@ -2620,26 +3250,24 @@ def get_api202210_external_line_item_product_buttons_by_line_item_id( 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) + return self.fetch_promoted_products_endpoint.call_with_http_info(**kwargs) - def get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id( + def fetch_proposal( self, - line_item_id, - product_button_id, + 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 + Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. # 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): ID of the line item Keyword Args: _return_http_data_only (bool): response data without head status @@ -2674,7 +3302,686 @@ def get_api202210_external_line_item_product_buttons_by_line_item_id_product_but async_req (bool): execute request asynchronously Returns: - ProductButtonListResponse + ProposalStatusModelResponse + 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_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, + **kwargs + ): + """get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id # 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_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: + 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 + 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 + 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_v1_external_account_brands_by_account_id( + self, + account_id, + **kwargs + ): + """get_api_v1_external_account_brands_by_account_id # noqa: E501 + + Gets page of retailer objects that are associated with the given 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.get_api_v1_external_account_brands_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The given account 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 + 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: + JsonApiPageResponseOfBrand + 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.get_api_v1_external_account_brands_by_account_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_account_retailers_by_account_id( + self, + account_id, + **kwargs + ): + """get_api_v1_external_account_retailers_by_account_id # noqa: E501 + + Gets page of retailer objects that are associated with the given 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.get_api_v1_external_account_retailers_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + Args: + account_id (str): The given account 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 + 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: + JsonApiPageResponseOfRetailer + 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.get_api_v1_external_account_retailers_by_account_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_accounts( + self, + **kwargs + ): + """get_api_v1_external_accounts # noqa: E501 + + Gets page of account objects that the current user can access # 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_v1_external_accounts(async_req=True) + >>> result = thread.get() + + + 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 + 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: + JsonApiPageResponseOfAccount + 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) + return self.get_api_v1_external_accounts_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_retailer_brands_by_retailer_id( + self, + retailer_id, + **kwargs + ): + """get_api_v1_external_retailer_brands_by_retailer_id # noqa: E501 + + Gets the brands for the given retailer # 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_v1_external_retailer_brands_by_retailer_id(retailer_id, async_req=True) + >>> result = thread.get() + + Args: + retailer_id (int): The retailer id for which brands should be fetched. + + Keyword Args: + 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_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: + BrandPreviewListResponse + 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_api_v1_external_retailer_brands_by_retailer_id_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_retailer_by_retailer_id_seller_by_seller( + self, + retailer_id, + seller, + **kwargs + ): + """get_api_v1_external_retailer_by_retailer_id_seller_by_seller # noqa: E501 + + Endpoint to get market place seller id and name # 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_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller, async_req=True) + >>> result = thread.get() + + Args: + retailer_id (int): The retailer id for which seller should be fetched. + seller (str): The seller id or seller name which should be validated. + + 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: + SellerPreviewResponse + 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['seller'] = \ + seller + return self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_endpoint.call_with_http_info(**kwargs) + + def get_api_v1_external_retailer_category_cpc_rates_by_retailer_id( + self, + retailer_id, + **kwargs + ): + """get_api_v1_external_retailer_category_cpc_rates_by_retailer_id # noqa: E501 + + Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer # 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_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id, async_req=True) + >>> result = thread.get() + + Args: + retailer_id (str): The retailer id + + Keyword Args: + fields ([str]): The fields in the response that is to be included. [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: + CpcRateCardPreviewResponse If the method is called asynchronously, returns the request thread. """ @@ -2703,28 +4010,26 @@ 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['retailer_id'] = \ + retailer_id + return self.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id_endpoint.call_with_http_info(**kwargs) - def get_api202301_external_line_item_bid_multipliers_by_line_item_id( + def get_api_v1_external_retailer_placements_by_retailer_id( self, - line_item_id, + retailer_id, **kwargs ): - """get_api202301_external_line_item_bid_multipliers_by_line_item_id # noqa: E501 + """get_api_v1_external_retailer_placements_by_retailer_id # noqa: E501 - Get bid multipliers by line item # noqa: E501 + Gets all placement information for the given retailer # 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_api_v1_external_retailer_placements_by_retailer_id(retailer_id, async_req=True) >>> result = thread.get() Args: - line_item_id (str): Long external id of the associated line item + retailer_id (str): The retailer id for which placements should be fetched. Keyword Args: _return_http_data_only (bool): response data without head status @@ -2759,7 +4064,7 @@ def get_api202301_external_line_item_bid_multipliers_by_line_item_id( async_req (bool): execute request asynchronously Returns: - JsonApiSingleResponseOfLineItemBidMultipliers + PlacementPreviewListResponse If the method is called asynchronously, returns the request thread. """ @@ -2788,31 +4093,30 @@ def get_api202301_external_line_item_bid_multipliers_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.get_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) + kwargs['retailer_id'] = \ + retailer_id + return self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint.call_with_http_info(**kwargs) - def get_api_v1_external_account_brands_by_account_id( + def get_api_v2_external_account_by_account_id_creativescreative_id( self, account_id, + creative_id, **kwargs ): - """get_api_v1_external_account_brands_by_account_id # noqa: E501 + """get_api_v2_external_account_by_account_id_creativescreative_id # noqa: E501 - Gets page of retailer objects that are associated with the given account # 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_api_v1_external_account_brands_by_account_id(account_id, async_req=True) + >>> thread = api.get_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True) >>> result = thread.get() Args: - account_id (str): The given account id + account_id (str): External account id to retrieve creatives for + creative_id (str): Creative to get 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 @@ -2845,7 +4149,7 @@ def get_api_v1_external_account_brands_by_account_id( async_req (bool): execute request asynchronously Returns: - JsonApiPageResponseOfBrand + CreativeV2Response If the method is called asynchronously, returns the request thread. """ @@ -2876,24 +4180,26 @@ def get_api_v1_external_account_brands_by_account_id( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['account_id'] = \ account_id - return self.get_api_v1_external_account_brands_by_account_id_endpoint.call_with_http_info(**kwargs) + kwargs['creative_id'] = \ + creative_id + return self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs) - def get_api_v1_external_account_retailers_by_account_id( + def get_api_v2_external_campaign_preferred_line_items_by_campaign_id( self, - account_id, + campaign_id, **kwargs ): - """get_api_v1_external_account_retailers_by_account_id # noqa: E501 + """get_api_v2_external_campaign_preferred_line_items_by_campaign_id # noqa: E501 - Gets page of retailer objects that are associated with the given account # 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_api_v1_external_account_retailers_by_account_id(account_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: - account_id (str): The given account 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] @@ -2931,7 +4237,7 @@ def get_api_v1_external_account_retailers_by_account_id( async_req (bool): execute request asynchronously Returns: - JsonApiPageResponseOfRetailer + PreferredLineItemV2PagedListResponse If the method is called asynchronously, returns the request thread. """ @@ -2960,28 +4266,28 @@ def get_api_v1_external_account_retailers_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.get_api_v1_external_account_retailers_by_account_id_endpoint.call_with_http_info(**kwargs) + kwargs['campaign_id'] = \ + campaign_id + return self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) - def get_api_v1_external_accounts( + def get_api_v2_external_line_item_bid_multipliers_by_line_item_id( self, + line_item_id, **kwargs ): - """get_api_v1_external_accounts # noqa: E501 + """get_api_v2_external_line_item_bid_multipliers_by_line_item_id # noqa: E501 - Gets page of account objects that the current user can access # noqa: E501 + Fetch all bid multipliers for a given 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_v1_external_accounts(async_req=True) + >>> thread = api.get_api_v2_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True) >>> result = thread.get() + Args: + line_item_id (str): External LineItemId for bid multiplier retrieval 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 @@ -3014,7 +4320,7 @@ def get_api_v1_external_accounts( async_req (bool): execute request asynchronously Returns: - JsonApiPageResponseOfAccount + JsonApiSingleResponseOfLineItemBidMultipliersV2 If the method is called asynchronously, returns the request thread. """ @@ -3043,28 +4349,28 @@ def get_api_v1_external_accounts( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_api_v1_external_accounts_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + return self.get_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) - def get_api_v1_external_retailer_brands_by_retailer_id( + def get_api_v2_external_preferred_line_item_by_line_item_id( self, - retailer_id, + line_item_id, **kwargs ): - """get_api_v1_external_retailer_brands_by_retailer_id # noqa: E501 + """get_api_v2_external_preferred_line_item_by_line_item_id # noqa: E501 - Gets the brands for the given retailer # 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_api_v1_external_retailer_brands_by_retailer_id(retailer_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: - retailer_id (int): The retailer id for which brands should be fetched. + line_item_id (str): The given line item id Keyword Args: - 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_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -3097,7 +4403,7 @@ def get_api_v1_external_retailer_brands_by_retailer_id( async_req (bool): execute request asynchronously Returns: - BrandPreviewListResponse + PreferredLineItemV2Response If the method is called asynchronously, returns the request thread. """ @@ -3126,28 +4432,26 @@ def get_api_v1_external_retailer_brands_by_retailer_id( '_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_api_v1_external_retailer_brands_by_retailer_id_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + return self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) - def get_api_v1_external_retailer_by_retailer_id_seller_by_seller( + def get_campaign_budget_overrides( self, - retailer_id, - seller, + campaign_id, **kwargs ): - """get_api_v1_external_retailer_by_retailer_id_seller_by_seller # noqa: E501 + """get_campaign_budget_overrides # noqa: E501 - Endpoint to get market place seller id and name # 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_api_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller, async_req=True) + >>> thread = api.get_campaign_budget_overrides(campaign_id, async_req=True) >>> result = thread.get() Args: - 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 (int): External campaign id. Keyword Args: _return_http_data_only (bool): response data without head status @@ -3182,7 +4486,7 @@ def get_api_v1_external_retailer_by_retailer_id_seller_by_seller( async_req (bool): execute request asynchronously Returns: - SellerPreviewResponse + ValueResourceOutcomeOfCampaignBudgetOverrides If the method is called asynchronously, returns the request thread. """ @@ -3211,31 +4515,31 @@ def get_api_v1_external_retailer_by_retailer_id_seller_by_seller( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['retailer_id'] = \ - retailer_id - kwargs['seller'] = \ - seller - return self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_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_api_v1_external_retailer_category_cpc_rates_by_retailer_id( + def get_insertion_order_history_change_data_capture( self, - retailer_id, + insertion_order_id, **kwargs ): - """get_api_v1_external_retailer_category_cpc_rates_by_retailer_id # noqa: E501 + """get_insertion_order_history_change_data_capture # noqa: E501 - Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer # 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_api_v1_external_retailer_category_cpc_rates_by_retailer_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: - retailer_id (str): The retailer id + insertion_order_id (str): External insertion order id. Keyword Args: - fields ([str]): The fields in the response that is to be included. [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 @@ -3268,7 +4572,7 @@ def get_api_v1_external_retailer_category_cpc_rates_by_retailer_id( async_req (bool): execute request asynchronously Returns: - CpcRateCardPreviewResponse + PageOfInsertionOrderHistoryChangeDataCapture If the method is called asynchronously, returns the request thread. """ @@ -3297,26 +4601,26 @@ def get_api_v1_external_retailer_category_cpc_rates_by_retailer_id( '_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_api_v1_external_retailer_category_cpc_rates_by_retailer_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 get_api_v1_external_retailer_placements_by_retailer_id( + def get_line_item_budget_overrides( self, - retailer_id, + line_item_id, **kwargs ): - """get_api_v1_external_retailer_placements_by_retailer_id # noqa: E501 + """get_line_item_budget_overrides # noqa: E501 - Gets all placement information for the given retailer # 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.get_api_v1_external_retailer_placements_by_retailer_id(retailer_id, async_req=True) + >>> thread = api.get_line_item_budget_overrides(line_item_id, async_req=True) >>> result = thread.get() Args: - retailer_id (str): The retailer id for which placements should be fetched. + line_item_id (str): The line item id to get budget overrides for. Keyword Args: _return_http_data_only (bool): response data without head status @@ -3351,7 +4655,7 @@ def get_api_v1_external_retailer_placements_by_retailer_id( async_req (bool): execute request asynchronously Returns: - PlacementPreviewListResponse + ValueResourceOutcomeOfLineItemBudgetOverrides If the method is called asynchronously, returns the request thread. """ @@ -3380,31 +4684,28 @@ def get_api_v1_external_retailer_placements_by_retailer_id( '_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_api_v1_external_retailer_placements_by_retailer_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_api_v2_external_campaign_preferred_line_items_by_campaign_id( + def get_recommended_keywords( self, - campaign_id, + external_line_item_id, **kwargs ): - """get_api_v2_external_campaign_preferred_line_items_by_campaign_id # noqa: E501 + """get_recommended_keywords # noqa: E501 - Gets page of preferred line item objects for the given campaign id # 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_api_v2_external_campaign_preferred_line_items_by_campaign_id(campaign_id, async_req=True) + >>> thread = api.get_recommended_keywords(external_line_item_id, async_req=True) >>> result = thread.get() Args: - campaign_id (str): The given campaign id + external_line_item_id (str): The external line item identifier 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 @@ -3437,7 +4738,7 @@ def get_api_v2_external_campaign_preferred_line_items_by_campaign_id( async_req (bool): execute request asynchronously Returns: - PreferredLineItemV2PagedListResponse + ValueResourceOutcomeOfRecommendedKeywordsResult If the method is called asynchronously, returns the request thread. """ @@ -3466,28 +4767,33 @@ def get_api_v2_external_campaign_preferred_line_items_by_campaign_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['campaign_id'] = \ - campaign_id - return self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs) + kwargs['external_line_item_id'] = \ + external_line_item_id + return self.get_recommended_keywords_endpoint.call_with_http_info(**kwargs) - def get_api_v2_external_preferred_line_item_by_line_item_id( + def get_sku_by_product_id( self, - line_item_id, + account_id, + retailer_id, **kwargs ): - """get_api_v2_external_preferred_line_item_by_line_item_id # noqa: E501 + """get_sku_by_product_id # noqa: E501 - Gets the preferred line item for the given line item id # 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.get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True) + >>> thread = api.get_sku_by_product_id(account_id, retailer_id, async_req=True) >>> result = thread.get() Args: - line_item_id (str): The given line item id + account_id (str): account id + retailer_id (int): retailer 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] _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 @@ -3520,7 +4826,7 @@ def get_api_v2_external_preferred_line_item_by_line_item_id( async_req (bool): execute request asynchronously Returns: - PreferredLineItemV2Response + ResourceCollectionOutcomeOfSkuSearchResult If the method is called asynchronously, returns the request thread. """ @@ -3549,28 +4855,31 @@ def get_api_v2_external_preferred_line_item_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.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs) + kwargs['account_id'] = \ + account_id + kwargs['retailer_id'] = \ + retailer_id + return self.get_sku_by_product_id_endpoint.call_with_http_info(**kwargs) - def get_campaign_budget_overrides( + def pause_promoted_products( self, - campaign_id, + line_item_id, **kwargs ): - """get_campaign_budget_overrides # noqa: E501 + """pause_promoted_products # noqa: E501 - Get current campaign budget overrides by given external campaign id. # noqa: E501 + Pause a collection of promoted products 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_campaign_budget_overrides(campaign_id, async_req=True) + >>> thread = api.pause_promoted_products(line_item_id, async_req=True) >>> result = thread.get() Args: - campaign_id (int): External campaign id. + line_item_id (str): ID of the line item Keyword Args: + promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [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 @@ -3603,7 +4912,7 @@ def get_campaign_budget_overrides( async_req (bool): execute request asynchronously Returns: - ValueResourceOutcomeOfCampaignBudgetOverrides + None If the method is called asynchronously, returns the request thread. """ @@ -3632,31 +4941,30 @@ def get_campaign_budget_overrides( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') 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) + kwargs['line_item_id'] = \ + line_item_id + return self.pause_promoted_products_endpoint.call_with_http_info(**kwargs) - def get_insertion_order_history_change_data_capture( + def post_api202110_external_campaign_preferred_line_items_by_campaign_id( self, - insertion_order_id, + campaign_id, + preferred_line_item_create_model_v2_request, **kwargs ): - """get_insertion_order_history_change_data_capture # noqa: E501 + """post_api202110_external_campaign_preferred_line_items_by_campaign_id # noqa: E501 - Gets the balance's historical data change capture. # 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.get_insertion_order_history_change_data_capture(insertion_order_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: - insertion_order_id (str): External insertion order id. + 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: - 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 @@ -3689,7 +4997,7 @@ def get_insertion_order_history_change_data_capture( async_req (bool): execute request asynchronously Returns: - PageOfInsertionOrderHistoryChangeDataCapture + PreferredLineItemV2Response If the method is called asynchronously, returns the request thread. """ @@ -3718,28 +5026,31 @@ def get_insertion_order_history_change_data_capture( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['insertion_order_id'] = \ - insertion_order_id - return self.get_insertion_order_history_change_data_capture_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 get_line_item_budget_overrides( + def post_api202210_external_line_item_product_buttons_create_by_line_item_id( self, line_item_id, **kwargs ): - """get_line_item_budget_overrides # noqa: E501 + """post_api202210_external_line_item_product_buttons_create_by_line_item_id # noqa: E501 - Gets a collection of monthly and daily budget overrides for the provided line item. # 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.get_line_item_budget_overrides(line_item_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: - line_item_id (str): The line item id to get budget overrides for. + line_item_id (str): Long external id of the associated line item 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 @@ -3772,7 +5083,7 @@ def get_line_item_budget_overrides( async_req (bool): execute request asynchronously Returns: - ValueResourceOutcomeOfLineItemBudgetOverrides + ProductButtonListResponse If the method is called asynchronously, returns the request thread. """ @@ -3803,26 +5114,26 @@ 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.post_api202210_external_line_item_product_buttons_create_by_line_item_id_endpoint.call_with_http_info(**kwargs) - def get_recommended_keywords( + def post_api_v1_external_catalogs_sku_retrieval( self, - external_line_item_id, **kwargs ): - """get_recommended_keywords # noqa: E501 + """post_api_v1_external_catalogs_sku_retrieval # noqa: E501 - Retrieves a collection of recommended keywords for a line item # noqa: E501 + Endpoint to search skus by text, retailer and sellers/brands. # 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.post_api_v1_external_catalogs_sku_retrieval(async_req=True) >>> result = thread.get() - Args: - external_line_item_id (str): The external line item identifier Keyword Args: + page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 + page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100 + request_body ([str]): The list of SKU keys to retrieve sku information. [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 @@ -3855,7 +5166,7 @@ def get_recommended_keywords( async_req (bool): execute request asynchronously Returns: - ValueResourceOutcomeOfRecommendedKeywordsResult + SkuDataPreviewListResponse If the method is called asynchronously, returns the request thread. """ @@ -3884,33 +5195,26 @@ 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) + return self.post_api_v1_external_catalogs_sku_retrieval_endpoint.call_with_http_info(**kwargs) - def get_sku_by_product_id( + def post_api_v1_external_catalogs_sku_search( self, - account_id, - retailer_id, **kwargs ): - """get_sku_by_product_id # noqa: E501 + """post_api_v1_external_catalogs_sku_search # noqa: E501 - Gets a list of SKUs based on a privided list of Product Ids # noqa: E501 + Endpoint to search skus by text, retailer and sellers/brands. # 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.post_api_v1_external_catalogs_sku_search(async_req=True) >>> result = thread.get() - Args: - account_id (str): account id - retailer_id (int): retailer 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] + page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 + page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100 + sku_search_request_preview_request (SkuSearchRequestPreviewRequest): . [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 @@ -3943,7 +5247,7 @@ def get_sku_by_product_id( async_req (bool): execute request asynchronously Returns: - ResourceCollectionOutcomeOfSkuSearchResult + SkuDataPreviewListResponse If the method is called asynchronously, returns the request thread. """ @@ -3972,32 +5276,31 @@ 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) + return self.post_api_v1_external_catalogs_sku_search_endpoint.call_with_http_info(**kwargs) - def post_api202110_external_campaign_preferred_line_items_by_campaign_id( + def post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id( self, - campaign_id, - preferred_line_item_create_model_v2_request, + account_id, + retailer_id, **kwargs ): - """post_api202110_external_campaign_preferred_line_items_by_campaign_id # noqa: E501 + """post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id # noqa: E501 - Creates a new preferred line item with the specified settings # noqa: E501 + Endpoint to search skus by text, account and retailer with an option to filter by brands id's. # 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_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, preferred_line_item_create_model_v2_request, async_req=True) + >>> thread = api.post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id(account_id, retailer_id, async_req=True) >>> result = thread.get() Args: - 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 + account_id (str): The account for which skus should be searched for. + retailer_id (str): The client id/retailer id for which skus should be searched for. Keyword Args: + offset (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 + limit (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100 + sku_search_request_slim_preview_request (SkuSearchRequestSlimPreviewRequest): . [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 @@ -4030,7 +5333,7 @@ def post_api202110_external_campaign_preferred_line_items_by_campaign_id( async_req (bool): execute request asynchronously Returns: - PreferredLineItemV2Response + SkuSlimDataPreviewListResponse If the method is called asynchronously, returns the request thread. """ @@ -4059,31 +5362,34 @@ def post_api202110_external_campaign_preferred_line_items_by_campaign_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - 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) + kwargs['account_id'] = \ + account_id + kwargs['retailer_id'] = \ + retailer_id + return self.post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id_endpoint.call_with_http_info(**kwargs) - def post_api202210_external_line_item_product_buttons_create_by_line_item_id( + def post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id( self, - line_item_id, + retailer_id, **kwargs ): - """post_api202210_external_line_item_product_buttons_create_by_line_item_id # noqa: E501 + """post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id # noqa: E501 - Append new product buttons to a line item # noqa: E501 + Endpoint to search skus by text for a retailer with an option to filter by brands id's. # 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_api_v1_external_catalogs_sku_search_retailer_by_retailer_id(retailer_id, async_req=True) >>> result = thread.get() Args: - line_item_id (str): Long external id of the associated line item + retailer_id (str): The client id/retailer id for which skus should be searched for. Keyword Args: - product_button_list_request (ProductButtonListRequest): List of product buttons to append to the specified line item. [optional] + x_origin_account (str): The account id of the initiator of the call.. [optional] + offset (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 + limit (int): The maximum number of results to return with each call. Must be greater than zero and less than 1500. 10,000 records deep is the max limit.. [optional] if omitted the server will use the default value of 100 + sku_search_request_slim_v2_preview_request (SkuSearchRequestSlimV2PreviewRequest): . [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 @@ -4116,7 +5422,7 @@ def post_api202210_external_line_item_product_buttons_create_by_line_item_id( async_req (bool): execute request asynchronously Returns: - ProductButtonListResponse + SkuSlimDataV2ListResponse If the method is called asynchronously, returns the request thread. """ @@ -4145,28 +5451,29 @@ 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['retailer_id'] = \ + retailer_id + return self.post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id_endpoint.call_with_http_info(**kwargs) - def post_api_v1_external_catalogs_sku_retrieval( + def post_api_v2_external_account_creatives_by_account_id( self, + account_id, **kwargs ): - """post_api_v1_external_catalogs_sku_retrieval # noqa: E501 + """post_api_v2_external_account_creatives_by_account_id # noqa: E501 - Endpoint to search skus by text, retailer and sellers/brands. # noqa: E501 + Create a creative for 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.post_api_v1_external_catalogs_sku_retrieval(async_req=True) + >>> thread = api.post_api_v2_external_account_creatives_by_account_id(account_id, async_req=True) >>> result = thread.get() + Args: + account_id (str): External account id to create a creative for Keyword Args: - page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 - page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100 - request_body ([str]): The list of SKU keys to retrieve sku information. [optional] + external_creative_create_model_v2 (ExternalCreativeCreateModelV2): 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 @@ -4199,7 +5506,7 @@ def post_api_v1_external_catalogs_sku_retrieval( async_req (bool): execute request asynchronously Returns: - SkuDataPreviewListResponse + CreativeV2Response If the method is called asynchronously, returns the request thread. """ @@ -4228,26 +5535,29 @@ def post_api_v1_external_catalogs_sku_retrieval( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.post_api_v1_external_catalogs_sku_retrieval_endpoint.call_with_http_info(**kwargs) + kwargs['account_id'] = \ + account_id + return self.post_api_v2_external_account_creatives_by_account_id_endpoint.call_with_http_info(**kwargs) - def post_api_v1_external_catalogs_sku_search( + def post_api_v2_external_account_creatives_search_by_account_id( self, + account_id, **kwargs ): - """post_api_v1_external_catalogs_sku_search # noqa: E501 + """post_api_v2_external_account_creatives_search_by_account_id # noqa: E501 - Endpoint to search skus by text, retailer and sellers/brands. # noqa: E501 + Get account creatives # 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_v1_external_catalogs_sku_search(async_req=True) + >>> thread = api.post_api_v2_external_account_creatives_search_by_account_id(account_id, async_req=True) >>> result = thread.get() + Args: + account_id (str): External account id to retrieve creatives for Keyword Args: - page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 - page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100 - sku_search_request_preview_request (SkuSearchRequestPreviewRequest): . [optional] + creative_ids ([str]): Creatives to filter by. [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 @@ -4280,7 +5590,7 @@ def post_api_v1_external_catalogs_sku_search( async_req (bool): execute request asynchronously Returns: - SkuDataPreviewListResponse + CreativeV2ListResponse If the method is called asynchronously, returns the request thread. """ @@ -4309,31 +5619,30 @@ def post_api_v1_external_catalogs_sku_search( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.post_api_v1_external_catalogs_sku_search_endpoint.call_with_http_info(**kwargs) + kwargs['account_id'] = \ + account_id + return self.post_api_v2_external_account_creatives_search_by_account_id_endpoint.call_with_http_info(**kwargs) - def post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id( + def put_api202110_external_preferred_line_item_by_line_item_id( self, - account_id, - retailer_id, + line_item_id, + preferred_line_item_update_model_v2_request, **kwargs ): - """post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id # noqa: E501 + """put_api202110_external_preferred_line_item_by_line_item_id # noqa: E501 - Endpoint to search skus by text, account and retailer with an option to filter by brands id's. # 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.post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id(account_id, retailer_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): The account for which skus should be searched for. - retailer_id (str): The client id/retailer id for which skus should be searched for. + 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: - offset (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 - limit (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100 - sku_search_request_slim_preview_request (SkuSearchRequestSlimPreviewRequest): . [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 @@ -4366,7 +5675,7 @@ def post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id( async_req (bool): execute request asynchronously Returns: - SkuSlimDataPreviewListResponse + PreferredLineItemV2Response If the method is called asynchronously, returns the request thread. """ @@ -4395,34 +5704,33 @@ def post_api_v1_external_catalogs_sku_search_account_id_and_retailer_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.post_api_v1_external_catalogs_sku_search_account_id_and_retailer_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 post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id( + def put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id( self, - retailer_id, + line_item_id, + product_button_id, **kwargs ): - """post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id # noqa: E501 + """put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id # noqa: E501 - Endpoint to search skus by text for a retailer with an option to filter by brands id's. # noqa: E501 + Update a 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.post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id(retailer_id, async_req=True) + >>> thread = api.put_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: - retailer_id (str): The client id/retailer id for which skus should be searched for. + line_item_id (str): Long external id of the associated line item + product_button_id (str): Sequential id of the product button Keyword Args: - x_origin_account (str): The account id of the initiator of the call.. [optional] - offset (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0 - limit (int): The maximum number of results to return with each call. Must be greater than zero and less than 1500. 10,000 records deep is the max limit.. [optional] if omitted the server will use the default value of 100 - sku_search_request_slim_v2_preview_request (SkuSearchRequestSlimV2PreviewRequest): . [optional] + product_button_request (ProductButtonRequest): Details of the updated product button. [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 @@ -4455,7 +5763,7 @@ def post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id( async_req (bool): execute request asynchronously Returns: - SkuSlimDataV2ListResponse + ProductButtonListResponse If the method is called asynchronously, returns the request thread. """ @@ -4484,30 +5792,33 @@ def post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['retailer_id'] = \ - retailer_id - return self.post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + kwargs['product_button_id'] = \ + product_button_id + return self.put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs) - def put_api202110_external_preferred_line_item_by_line_item_id( + def put_api_v2_external_account_by_account_id_creativescreative_id( self, - line_item_id, - preferred_line_item_update_model_v2_request, + account_id, + creative_id, **kwargs ): - """put_api202110_external_preferred_line_item_by_line_item_id # noqa: E501 + """put_api_v2_external_account_by_account_id_creativescreative_id # noqa: E501 - Updates the preferred line item for the given line item id # noqa: E501 + Update a 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.put_api202110_external_preferred_line_item_by_line_item_id(line_item_id, preferred_line_item_update_model_v2_request, async_req=True) + >>> thread = api.put_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True) >>> result = thread.get() Args: - 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 + account_id (str): External account id containing the creative + creative_id (str): Creative to update Keyword Args: + external_creative_update_model_v2 (ExternalCreativeUpdateModelV2): 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 @@ -4540,7 +5851,7 @@ def put_api202110_external_preferred_line_item_by_line_item_id( async_req (bool): execute request asynchronously Returns: - PreferredLineItemV2Response + CreativeV2Response If the method is called asynchronously, returns the request thread. """ @@ -4569,33 +5880,31 @@ def put_api202110_external_preferred_line_item_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 - 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) + kwargs['account_id'] = \ + account_id + kwargs['creative_id'] = \ + creative_id + return self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs) - def put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id( + def put_api_v2_external_line_item_bid_multipliers_by_line_item_id( self, line_item_id, - product_button_id, **kwargs ): - """put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id # noqa: E501 + """put_api_v2_external_line_item_bid_multipliers_by_line_item_id # noqa: E501 - Update a product button # noqa: E501 + Updates the bid multipliers for a given 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.put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id, async_req=True) + >>> thread = api.put_api_v2_external_line_item_bid_multipliers_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 - product_button_id (str): Sequential id of the product button + line_item_id (str): External LineItemId for bid multiplier retrieval Keyword Args: - product_button_request (ProductButtonRequest): Details of the updated product button. [optional] + line_item_bid_multipliers_v2_request (LineItemBidMultipliersV2Request): New Bid Multipliers to be set. [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 @@ -4628,7 +5937,7 @@ def put_api202210_external_line_item_product_buttons_by_line_item_id_product_but async_req (bool): execute request asynchronously Returns: - ProductButtonListResponse + LineItemBidMultipliersV2Response If the method is called asynchronously, returns the request thread. """ @@ -4659,29 +5968,27 @@ def put_api202210_external_line_item_product_buttons_by_line_item_id_product_but kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['line_item_id'] = \ line_item_id - kwargs['product_button_id'] = \ - product_button_id - return self.put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs) + return self.put_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) - def put_api202301_external_line_item_bid_multipliers_by_line_item_id( + def set_keyword_bids( self, - line_item_id, + id, **kwargs ): - """put_api202301_external_line_item_bid_multipliers_by_line_item_id # noqa: E501 + """set_keyword_bids # noqa: E501 - Replace bid multipliers on a line item # noqa: E501 + Set bid overrides for associated keywords to the given line item in bulk # 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_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True) + >>> thread = api.set_keyword_bids(id, async_req=True) >>> result = thread.get() Args: - line_item_id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - line_item_bid_multipliers_request (LineItemBidMultipliersRequest): [optional] + set_bids_model_request (SetBidsModelRequest): [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 @@ -4714,7 +6021,7 @@ def put_api202301_external_line_item_bid_multipliers_by_line_item_id( async_req (bool): execute request asynchronously Returns: - LineItemBidMultipliersResponse + ResourceOutcome If the method is called asynchronously, returns the request thread. """ @@ -4743,29 +6050,28 @@ def put_api202301_external_line_item_bid_multipliers_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.put_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs) - def set_keyword_bids( + def submit_proposal( self, id, **kwargs ): - """set_keyword_bids # noqa: E501 + """submit_proposal # noqa: E501 - Set bid overrides for associated keywords to the given line item in bulk # noqa: E501 + Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.set_keyword_bids(id, async_req=True) + >>> thread = api.submit_proposal(id, async_req=True) >>> result = thread.get() Args: - id (str): Long external id of the associated line item + id (str): ID of the line item Keyword Args: - retail_media_externalv1_set_bids_model_request (RetailMediaExternalv1SetBidsModelRequest): Object containing a list of bid overrides for associated keywords. [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 @@ -4798,7 +6104,7 @@ def set_keyword_bids( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ResourceOutcome + ProposalStatusModelResponse If the method is called asynchronously, returns the request thread. """ @@ -4829,26 +6135,27 @@ def set_keyword_bids( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs) + return self.submit_proposal_endpoint.call_with_http_info(**kwargs) - def submit_proposal( + def unpause_promoted_products( self, - id, + line_item_id, **kwargs ): - """submit_proposal # noqa: E501 + """unpause_promoted_products # noqa: E501 - Submit a proposal to modify a Preferred Deal Line Item for review. # noqa: E501 + Un-pause a collection of promoted products 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.submit_proposal(id, async_req=True) + >>> thread = api.unpause_promoted_products(line_item_id, async_req=True) >>> result = thread.get() Args: - id (str): The external id of a line item. + line_item_id (str): ID of the line item Keyword Args: + promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [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 @@ -4881,7 +6188,7 @@ def submit_proposal( async_req (bool): execute request asynchronously Returns: - RetailMediaExternalv1ProposalStatusModelResponse + None If the method is called asynchronously, returns the request thread. """ @@ -4910,9 +6217,9 @@ def submit_proposal( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.submit_proposal_endpoint.call_with_http_info(**kwargs) + kwargs['line_item_id'] = \ + line_item_id + return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs) def update_campaign_budget_overrides( self, 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 d8104c55..fcd032e3 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.240404/python' + self.user_agent = 'OpenAPI-Generator/0.0.240515/python' def __enter__(self): return self diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/configuration.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/configuration.py index 3964e44c..8168115f 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.240404".\ + "SDK Package Version: 0.0.240515".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keyword_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keyword_model.py new file mode 100644 index 00000000..93605ddf --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keyword_model.py @@ -0,0 +1,274 @@ +""" + 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.match_type_model import MatchTypeModel + globals()['MatchTypeModel'] = MatchTypeModel + + +class AddRemoveKeywordModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'is_deleted': (bool, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'is_deleted': 'isDeleted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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 + """AddRemoveKeywordModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + is_deleted (bool, 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/add_remove_keywords_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keywords_model.py new file mode 100644 index 00000000..0641d33d --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keywords_model.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.add_remove_keyword_model import AddRemoveKeywordModel + globals()['AddRemoveKeywordModel'] = AddRemoveKeywordModel + + +class AddRemoveKeywordsModel(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 { + 'keywords': ([AddRemoveKeywordModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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 + """AddRemoveKeywordsModel - 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,) + keywords ([AddRemoveKeywordModel], 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/add_remove_keywords_model_request.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keywords_model_request.py new file mode 100644 index 00000000..3be3628c --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keywords_model_request.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.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource + globals()['AddRemoveKeywordsModelResource'] = AddRemoveKeywordsModelResource + + +class AddRemoveKeywordsModelRequest(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': (AddRemoveKeywordsModelResource,), # 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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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 + """AddRemoveKeywordsModelRequest - 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 (AddRemoveKeywordsModelResource): [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/add_remove_keywords_model_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keywords_model_resource.py new file mode 100644 index 00000000..3b8831eb --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/add_remove_keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + 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.add_remove_keywords_model import AddRemoveKeywordsModel + globals()['AddRemoveKeywordsModel'] = AddRemoveKeywordsModel + + +class AddRemoveKeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (AddRemoveKeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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 + """AddRemoveKeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (AddRemoveKeywordsModel): [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/approval_status_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/approval_status_model.py new file mode 100644 index 00000000..98865a06 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/approval_status_model.py @@ -0,0 +1,292 @@ +""" + 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 ApprovalStatusModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'NOTSUBMITTED': "NotSubmitted", + 'SUBMITTED': "Submitted", + 'REJECTED': "Rejected", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ApprovalStatusModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report.py index 1dc6a35c..fa1dafe5 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/async_accounts_report.py @@ -55,16 +55,6 @@ class AsyncAccountsReport(ModelNormal): """ allowed_values = { - ('report_type',): { - 'None': None, - 'SUMMARY': "summary", - 'PAGETYPE': "pageType", - 'KEYWORD': "keyword", - 'PRODUCTCATEGORY': "productCategory", - 'PRODUCT': "product", - 'ENVIRONMENT': "environment", - 'SERVEDCATEGORY': "servedCategory", - }, ('aggregation_level',): { 'None': None, 'CAMPAIGN': "campaign", @@ -72,11 +62,13 @@ class AsyncAccountsReport(ModelNormal): }, ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -87,20 +79,31 @@ class AsyncAccountsReport(ModelNormal): 'JSON-NEWLINE': "json-newline", 'CSV': "csv", }, + ('report_type',): { + 'None': None, + 'SUMMARY': "summary", + 'PAGETYPE': "pageType", + 'KEYWORD': "keyword", + 'PRODUCTCATEGORY': "productCategory", + 'PRODUCT': "product", + 'ATTRIBUTEDTRANSACTIONS': "attributedTransactions", + 'ENVIRONMENT': "environment", + 'SERVEDCATEGORY': "servedCategory", + }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -111,19 +114,20 @@ class AsyncAccountsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -140,6 +144,14 @@ class AsyncAccountsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -172,11 +184,11 @@ def openapi_types(): '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 + 'report_type': (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 @@ -193,11 +205,11 @@ def discriminator(): '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 + 'report_type': 'reportType', # noqa: E501 'click_attribution_window': 'clickAttributionWindow', # noqa: E501 'view_attribution_window': 'viewAttributionWindow', # noqa: E501 'dimensions': 'dimensions', # noqa: E501 @@ -251,11 +263,11 @@ def _from_openapi_data(cls, account_ids, 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,) - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 @@ -354,11 +366,11 @@ def __init__(self, account_ids, 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,) - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501 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 98848333..4de19f5c 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 @@ -57,11 +57,13 @@ class AsyncCampaignsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncCampaignsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncCampaignsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncCampaignsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _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 - 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 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 3cf9c092..e65e1bc3 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 @@ -57,11 +57,13 @@ class AsyncLineItemsReport(ModelNormal): allowed_values = { ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -85,18 +87,18 @@ class AsyncLineItemsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('dimensions',): { 'None': None, @@ -107,19 +109,20 @@ class AsyncLineItemsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -136,6 +139,14 @@ class AsyncLineItemsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -248,8 +259,8 @@ def _from_openapi_data(cls, start_date, end_date, *args, **kwargs): # noqa: E50 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -350,8 +361,8 @@ def __init__(self, start_date, end_date, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/audience_error.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/audience_error.py new file mode 100644 index 00000000..b6671aa8 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/audience_error.py @@ -0,0 +1,310 @@ +""" + 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 AudienceError(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 = { + ('type',): { + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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 { + 'type': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'instance': (str,), # noqa: E501 + 'trace_id': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'stack_trace': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'trace_id': 'traceId', # noqa: E501 + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, code, instance, *args, **kwargs): # noqa: E501 + """AudienceError - a model defined in OpenAPI + + Args: + type (str): (REQUIRED) The classification of the error + code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. + instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem + + 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,) + trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 + detail (str, none_type): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type + self.code = code + self.instance = instance + 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, type, code, instance, *args, **kwargs): # noqa: E501 + """AudienceError - a model defined in OpenAPI + + Args: + type (str): (REQUIRED) The classification of the error + code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. + instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem + + 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,) + trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 + detail (str, none_type): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type + self.code = code + self.instance = instance + 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/audience_warning.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/audience_warning.py new file mode 100644 index 00000000..312ffaae --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/audience_warning.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.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 AudienceWarning(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 = { + ('type',): { + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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 { + 'type': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'instance': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 + 'trace_id': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'source': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'stack_trace': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'instance': 'instance', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'trace_id': 'traceId', # noqa: E501 + 'title': 'title', # noqa: E501 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, code, instance, detail, *args, **kwargs): # noqa: E501 + """AudienceWarning - a model defined in OpenAPI + + Args: + type (str): (REQUIRED) The classification of the error + code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. + instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem + detail (str): (REQUIRED) A human-readable explanation specific to this occurrence of the problem + + 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,) + trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 + source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type + self.code = code + self.instance = instance + 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, type, code, instance, detail, *args, **kwargs): # noqa: E501 + """AudienceWarning - a model defined in OpenAPI + + Args: + type (str): (REQUIRED) The classification of the error + code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. + instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem + detail (str): (REQUIRED) A human-readable explanation specific to this occurrence of the problem + + 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,) + trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional] # noqa: E501 + source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [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.type = type + self.code = code + self.instance = instance + 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/creative_v2_list_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_v2_list_response.py new file mode 100644 index 00000000..e0223870 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_v2_list_response.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.common_problem import CommonProblem + from criteo_api_retailmedia_preview.model.resource_of_creative_v2 import ResourceOfCreativeV2 + globals()['CommonProblem'] = CommonProblem + globals()['ResourceOfCreativeV2'] = ResourceOfCreativeV2 + + +class CreativeV2ListResponse(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': ([ResourceOfCreativeV2], none_type,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CreativeV2ListResponse - 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 ([ResourceOfCreativeV2], 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) + _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 + """CreativeV2ListResponse - 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 ([ResourceOfCreativeV2], 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) + _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/creative_v2_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_v2_response.py new file mode 100644 index 00000000..ba3fb683 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/creative_v2_response.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.common_problem import CommonProblem + from criteo_api_retailmedia_preview.model.resource_of_creative_v2 import ResourceOfCreativeV2 + globals()['CommonProblem'] = CommonProblem + globals()['ResourceOfCreativeV2'] = ResourceOfCreativeV2 + + +class CreativeV2Response(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': (ResourceOfCreativeV2,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """CreativeV2Response - 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 (ResourceOfCreativeV2): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """CreativeV2Response - 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 (ResourceOfCreativeV2): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/error_code_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/error_code_response.py new file mode 100644 index 00000000..6904d0e7 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/error_code_response.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.audience_error import AudienceError + from criteo_api_retailmedia_preview.model.audience_warning import AudienceWarning + globals()['AudienceError'] = AudienceError + globals()['AudienceWarning'] = AudienceWarning + + +class ErrorCodeResponse(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 { + 'errors': ([AudienceError],), # noqa: E501 + 'warnings': ([AudienceWarning], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '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, errors, *args, **kwargs): # noqa: E501 + """ErrorCodeResponse - a model defined in OpenAPI + + Args: + errors ([AudienceError]): + + 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,) + warnings ([AudienceWarning], 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.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, errors, *args, **kwargs): # noqa: E501 + """ErrorCodeResponse - a model defined in OpenAPI + + Args: + errors ([AudienceError]): + + 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,) + warnings ([AudienceWarning], 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.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/external_choice_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_choice_variable_value.py new file mode 100644 index 00000000..34467426 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_choice_variable_value.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 + + + +class ExternalChoiceVariableValue(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 { + 'chosen_options': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'chosen_options': 'chosenOptions', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, chosen_options, *args, **kwargs): # noqa: E501 + """ExternalChoiceVariableValue - a model defined in OpenAPI + + Args: + chosen_options ([str]): The chosen options + + 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.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 \ + 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, chosen_options, *args, **kwargs): # noqa: E501 + """ExternalChoiceVariableValue - a model defined in OpenAPI + + Args: + chosen_options ([str]): The chosen options + + 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.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 \ + 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/external_color_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_color_variable_value.py new file mode 100644 index 00000000..140d5e19 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_color_variable_value.py @@ -0,0 +1,268 @@ +""" + 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 ExternalColorVariableValue(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 = { + ('color',): { + 'regex': { + 'pattern': r'^#(([0-9a-fA-F]{2}){3}|([0-9a-fA-F]){3})$', # noqa: E501 + }, + }, + } + + @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 { + 'color': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'color': 'color', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ExternalColorVariableValue - 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,) + color (str, none_type): The displayed color (HEX format). [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 + """ExternalColorVariableValue - 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,) + color (str, none_type): The displayed color (HEX format). [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/external_creative_create_model_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_creative_create_model_v2.py new file mode 100644 index 00000000..dab1f6b7 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_creative_create_model_v2.py @@ -0,0 +1,297 @@ +""" + 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.external_template_variable_value import ExternalTemplateVariableValue + globals()['ExternalTemplateVariableValue'] = ExternalTemplateVariableValue + + +class ExternalCreativeCreateModelV2(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 { + 'name': (str,), # noqa: E501 + 'retailer_id': (int,), # noqa: E501 + 'template_id': (int,), # noqa: E501 + 'template_variable_values': ([ExternalTemplateVariableValue],), # noqa: E501 + 'brand_id': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + 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 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 + """ExternalCreativeCreateModelV2 - 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 ([ExternalTemplateVariableValue]): The template chosen values + + 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_id (int, none_type): The brand associated to the creative. [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.name = name + self.retailer_id = retailer_id + self.template_id = template_id + self.template_variable_values = template_variable_values + 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, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 + """ExternalCreativeCreateModelV2 - 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 ([ExternalTemplateVariableValue]): The template chosen values + + 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_id (int, none_type): The brand associated to the creative. [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.name = name + self.retailer_id = retailer_id + self.template_id = template_id + self.template_variable_values = template_variable_values + 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/external_creative_update_model_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_creative_update_model_v2.py new file mode 100644 index 00000000..f834978d --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_creative_update_model_v2.py @@ -0,0 +1,297 @@ +""" + 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.external_template_variable_value import ExternalTemplateVariableValue + globals()['ExternalTemplateVariableValue'] = ExternalTemplateVariableValue + + +class ExternalCreativeUpdateModelV2(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 { + 'name': (str,), # noqa: E501 + 'retailer_id': (int,), # noqa: E501 + 'template_id': (int,), # noqa: E501 + 'template_variable_values': ([ExternalTemplateVariableValue],), # noqa: E501 + 'brand_id': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + 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 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 + """ExternalCreativeUpdateModelV2 - 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 ([ExternalTemplateVariableValue]): The template chosen values + + 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_id (int, none_type): The brand associated to the creative. [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.name = name + self.retailer_id = retailer_id + self.template_id = template_id + self.template_variable_values = template_variable_values + 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, name, retailer_id, template_id, template_variable_values, *args, **kwargs): # noqa: E501 + """ExternalCreativeUpdateModelV2 - 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 ([ExternalTemplateVariableValue]): The template chosen values + + 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_id (int, none_type): The brand associated to the creative. [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.name = name + self.retailer_id = retailer_id + self.template_id = template_id + self.template_variable_values = template_variable_values + 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/external_creative_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_creative_v2.py new file mode 100644 index 00000000..bab528ff --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_creative_v2.py @@ -0,0 +1,361 @@ +""" + 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.external_page_type_environment import ExternalPageTypeEnvironment + from criteo_api_retailmedia_preview.model.external_template_variable_value import ExternalTemplateVariableValue + globals()['ExternalPageTypeEnvironment'] = ExternalPageTypeEnvironment + globals()['ExternalTemplateVariableValue'] = ExternalTemplateVariableValue + + +class ExternalCreativeV2(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 = { + ('status',): { + 'READY': "Ready", + 'INUSE': "InUse", + 'ARCHIVED': "Archived", + 'DELETED': "Deleted", + }, + ('creative_format_type',): { + 'UNKNOWN': "Unknown", + 'FLAGSHIP': "FlagShip", + 'SHOWCASE': "Showcase", + 'SPONSOREDPRODUCTS': "SponsoredProducts", + 'BUTTERFLY': "Butterfly", + 'BUNDLEBOOST': "BundleBoost", + 'IAB': "IAB", + 'CUSTOM': "Custom", + 'DISPLAYPANEL': "DisplayPanel", + 'DIGITALSHELFTALKER': "DigitalShelfTalker", + }, + } + + 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 { + 'name': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'brand_id': (int,), # noqa: E501 + 'retailer_id': (int,), # noqa: E501 + 'template_id': (int,), # noqa: E501 + 'template_name': (str,), # noqa: E501 + 'format_id': (int,), # noqa: E501 + 'associated_line_item_ids': ([str],), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'creative_format_type': (str,), # noqa: E501 + 'environments': ([ExternalPageTypeEnvironment],), # noqa: E501 + 'template_variable_values': ([ExternalTemplateVariableValue],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'status': 'status', # noqa: E501 + 'brand_id': 'brandId', # noqa: E501 + 'retailer_id': 'retailerId', # noqa: E501 + 'template_id': 'templateId', # noqa: E501 + 'template_name': 'templateName', # noqa: E501 + 'format_id': 'formatId', # noqa: E501 + 'associated_line_item_ids': 'associatedLineItemIds', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + 'creative_format_type': 'creativeFormatType', # noqa: E501 + 'environments': 'environments', # noqa: E501 + 'template_variable_values': 'templateVariableValues', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, status, brand_id, retailer_id, template_id, template_name, format_id, associated_line_item_ids, updated_at, creative_format_type, environments, template_variable_values, *args, **kwargs): # noqa: E501 + """ExternalCreativeV2 - a model defined in OpenAPI + + Args: + name (str): Name + status (str): Creative Status + brand_id (int): Brand Id + retailer_id (int): Retailer Id + template_id (int): Template Id + template_name (str): Template Name + format_id (int): Format Id + associated_line_item_ids ([str]): Associated Line Item Ids + updated_at (datetime): Updated at time + creative_format_type (str): Creative format type + environments ([ExternalPageTypeEnvironment]): Environment type (e.g. mobile, web, app) + template_variable_values ([ExternalTemplateVariableValue]): The template chosen values + + 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.name = name + self.status = status + self.brand_id = brand_id + self.retailer_id = retailer_id + self.template_id = template_id + self.template_name = template_name + self.format_id = format_id + self.associated_line_item_ids = associated_line_item_ids + self.updated_at = updated_at + self.creative_format_type = creative_format_type + self.environments = environments + self.template_variable_values = template_variable_values + 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, name, status, brand_id, retailer_id, template_id, template_name, format_id, associated_line_item_ids, updated_at, creative_format_type, environments, template_variable_values, *args, **kwargs): # noqa: E501 + """ExternalCreativeV2 - a model defined in OpenAPI + + Args: + name (str): Name + status (str): Creative Status + brand_id (int): Brand Id + retailer_id (int): Retailer Id + template_id (int): Template Id + template_name (str): Template Name + format_id (int): Format Id + associated_line_item_ids ([str]): Associated Line Item Ids + updated_at (datetime): Updated at time + creative_format_type (str): Creative format type + environments ([ExternalPageTypeEnvironment]): Environment type (e.g. mobile, web, app) + template_variable_values ([ExternalTemplateVariableValue]): The template chosen values + + 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.name = name + self.status = status + self.brand_id = brand_id + self.retailer_id = retailer_id + self.template_id = template_id + self.template_name = template_name + self.format_id = format_id + self.associated_line_item_ids = associated_line_item_ids + self.updated_at = updated_at + self.creative_format_type = creative_format_type + self.environments = environments + self.template_variable_values = template_variable_values + 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/external_files_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_files_variable_value.py new file mode 100644 index 00000000..6851fbf7 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_files_variable_value.py @@ -0,0 +1,272 @@ +""" + 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 ExternalFilesVariableValue(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 = { + ('asset_ids',): { + 'min_items': 1, + }, + } + + @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 { + 'asset_ids': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'asset_ids': 'assetIds', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, asset_ids, *args, **kwargs): # noqa: E501 + """ExternalFilesVariableValue - a model defined in OpenAPI + + Args: + asset_ids ([str]): The assets representing the images to be displayed + + 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.asset_ids = asset_ids + 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, asset_ids, *args, **kwargs): # noqa: E501 + """ExternalFilesVariableValue - a model defined in OpenAPI + + Args: + asset_ids ([str]): The assets representing the images to be displayed + + 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.asset_ids = asset_ids + 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/external_hyperlink_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_hyperlink_variable_value.py new file mode 100644 index 00000000..9079573e --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_hyperlink_variable_value.py @@ -0,0 +1,263 @@ +""" + 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 ExternalHyperlinkVariableValue(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 { + 'url': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'url': 'url', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ExternalHyperlinkVariableValue - 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,) + url (str, none_type): The url to redirect to. [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 + """ExternalHyperlinkVariableValue - 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,) + url (str, none_type): The url to redirect to. [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/external_line_item_bid_multipliers_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py new file mode 100644 index 00000000..054ede3a --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py @@ -0,0 +1,303 @@ +""" + 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 ExternalLineItemBidMultipliersV2(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 { + 'search': (float, none_type,), # noqa: E501 + 'home': (float, none_type,), # noqa: E501 + 'category': (float, none_type,), # noqa: E501 + 'product_detail': (float, none_type,), # noqa: E501 + 'confirmation': (float, none_type,), # noqa: E501 + 'merchandising': (float, none_type,), # noqa: E501 + 'deals': (float, none_type,), # noqa: E501 + 'checkout': (float, none_type,), # noqa: E501 + 'favorites': (float, none_type,), # noqa: E501 + 'search_bar': (float, none_type,), # noqa: E501 + 'category_menu': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'search': 'search', # noqa: E501 + 'home': 'home', # noqa: E501 + 'category': 'category', # noqa: E501 + 'product_detail': 'productDetail', # noqa: E501 + 'confirmation': 'confirmation', # noqa: E501 + 'merchandising': 'merchandising', # noqa: E501 + 'deals': 'deals', # noqa: E501 + 'checkout': 'checkout', # noqa: E501 + 'favorites': 'favorites', # noqa: E501 + 'search_bar': 'searchBar', # noqa: E501 + 'category_menu': 'categoryMenu', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ExternalLineItemBidMultipliersV2 - 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,) + search (float, none_type): Search Page Type Bid Multiplier. [optional] # noqa: E501 + home (float, none_type): Home Page Type Bid Multiplier. [optional] # noqa: E501 + category (float, none_type): Categories Page Type Bid Multiplier. [optional] # noqa: E501 + product_detail (float, none_type): ProductDetail Page Type Bid Multiplier. [optional] # noqa: E501 + confirmation (float, none_type): Confirmation Page Type Bid Multiplier. [optional] # noqa: E501 + merchandising (float, none_type): Merchandising Page Type Bid Multiplier. [optional] # noqa: E501 + deals (float, none_type): Deals Page Type Bid Multiplier. [optional] # noqa: E501 + checkout (float, none_type): Checkout Page Type Bid Multiplier. [optional] # noqa: E501 + favorites (float, none_type): Favorites Page Type Bid Multiplier. [optional] # noqa: E501 + search_bar (float, none_type): SearchBar Page Type Bid Multiplier. [optional] # noqa: E501 + category_menu (float, none_type): CategoryMenu Page Type Bid Multiplier. [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 + """ExternalLineItemBidMultipliersV2 - 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,) + search (float, none_type): Search Page Type Bid Multiplier. [optional] # noqa: E501 + home (float, none_type): Home Page Type Bid Multiplier. [optional] # noqa: E501 + category (float, none_type): Categories Page Type Bid Multiplier. [optional] # noqa: E501 + product_detail (float, none_type): ProductDetail Page Type Bid Multiplier. [optional] # noqa: E501 + confirmation (float, none_type): Confirmation Page Type Bid Multiplier. [optional] # noqa: E501 + merchandising (float, none_type): Merchandising Page Type Bid Multiplier. [optional] # noqa: E501 + deals (float, none_type): Deals Page Type Bid Multiplier. [optional] # noqa: E501 + checkout (float, none_type): Checkout Page Type Bid Multiplier. [optional] # noqa: E501 + favorites (float, none_type): Favorites Page Type Bid Multiplier. [optional] # noqa: E501 + search_bar (float, none_type): SearchBar Page Type Bid Multiplier. [optional] # noqa: E501 + category_menu (float, none_type): CategoryMenu Page Type Bid Multiplier. [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/external_page_type_environment.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_page_type_environment.py new file mode 100644 index 00000000..b1254c37 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_page_type_environment.py @@ -0,0 +1,293 @@ +""" + 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 ExternalPageTypeEnvironment(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 = { + ('page_type',): { + 'None': None, + '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", + }, + ('environments',): { + 'None': None, + 'WEB': "Web", + 'MOBILE': "Mobile", + 'APP': "App", + 'LOCKOUT': "Lockout", + 'MIXED': "Mixed", + 'IOS': "iOS", + 'ANDROID': "Android", + }, + } + + 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 { + 'page_type': (str, none_type,), # noqa: E501 + 'environments': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'page_type': 'pageType', # noqa: E501 + 'environments': 'environments', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ExternalPageTypeEnvironment - 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,) + page_type (str, none_type): Creative PageType. [optional] # noqa: E501 + environments ([str], none_type): List of environments per PageType. [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 + """ExternalPageTypeEnvironment - 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,) + page_type (str, none_type): Creative PageType. [optional] # noqa: E501 + environments ([str], none_type): List of environments per PageType. [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/external_template_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_template_variable_value.py new file mode 100644 index 00000000..11345218 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_template_variable_value.py @@ -0,0 +1,309 @@ +""" + 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.external_choice_variable_value import ExternalChoiceVariableValue + from criteo_api_retailmedia_preview.model.external_color_variable_value import ExternalColorVariableValue + from criteo_api_retailmedia_preview.model.external_files_variable_value import ExternalFilesVariableValue + from criteo_api_retailmedia_preview.model.external_hyperlink_variable_value import ExternalHyperlinkVariableValue + from criteo_api_retailmedia_preview.model.external_text_variable_value import ExternalTextVariableValue + from criteo_api_retailmedia_preview.model.external_video_variable_value import ExternalVideoVariableValue + globals()['ExternalChoiceVariableValue'] = ExternalChoiceVariableValue + globals()['ExternalColorVariableValue'] = ExternalColorVariableValue + globals()['ExternalFilesVariableValue'] = ExternalFilesVariableValue + globals()['ExternalHyperlinkVariableValue'] = ExternalHyperlinkVariableValue + globals()['ExternalTextVariableValue'] = ExternalTextVariableValue + globals()['ExternalVideoVariableValue'] = ExternalVideoVariableValue + + +class ExternalTemplateVariableValue(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 { + 'id': (str,), # noqa: E501 + 'text_variable_value': (ExternalTextVariableValue,), # noqa: E501 + 'choice_variable_value': (ExternalChoiceVariableValue,), # noqa: E501 + 'color_variable_value': (ExternalColorVariableValue,), # noqa: E501 + 'files_variable_value': (ExternalFilesVariableValue,), # noqa: E501 + 'hyperlink_variable_value': (ExternalHyperlinkVariableValue,), # noqa: E501 + 'video_variable_value': (ExternalVideoVariableValue,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + 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 + 'video_variable_value': 'videoVariableValue', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """ExternalTemplateVariableValue - a model defined in OpenAPI + + Args: + id (str): The id of the template variable the value is applied to + + 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,) + text_variable_value (ExternalTextVariableValue): [optional] # noqa: E501 + choice_variable_value (ExternalChoiceVariableValue): [optional] # noqa: E501 + color_variable_value (ExternalColorVariableValue): [optional] # noqa: E501 + files_variable_value (ExternalFilesVariableValue): [optional] # noqa: E501 + hyperlink_variable_value (ExternalHyperlinkVariableValue): [optional] # noqa: E501 + video_variable_value (ExternalVideoVariableValue): [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.id = 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, id, *args, **kwargs): # noqa: E501 + """ExternalTemplateVariableValue - a model defined in OpenAPI + + Args: + id (str): The id of the template variable the value is applied to + + 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,) + text_variable_value (ExternalTextVariableValue): [optional] # noqa: E501 + choice_variable_value (ExternalChoiceVariableValue): [optional] # noqa: E501 + color_variable_value (ExternalColorVariableValue): [optional] # noqa: E501 + files_variable_value (ExternalFilesVariableValue): [optional] # noqa: E501 + hyperlink_variable_value (ExternalHyperlinkVariableValue): [optional] # noqa: E501 + video_variable_value (ExternalVideoVariableValue): [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.id = 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/external_text_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_text_variable_value.py new file mode 100644 index 00000000..e84dae1b --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_text_variable_value.py @@ -0,0 +1,263 @@ +""" + 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 ExternalTextVariableValue(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 { + 'text': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'text': 'text', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ExternalTextVariableValue - 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,) + text (str, none_type): The displayed text. [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 + """ExternalTextVariableValue - 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,) + text (str, none_type): The displayed text. [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/external_video_variable_value.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_video_variable_value.py new file mode 100644 index 00000000..62e0ce56 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/external_video_variable_value.py @@ -0,0 +1,293 @@ +""" + 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 ExternalVideoVariableValue(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 = { + ('url',): { + 'min_length': 1, + }, + ('duration',): { + 'min_length': 1, + }, + } + + @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 { + 'url': (str,), # noqa: E501 + 'width': (int,), # noqa: E501 + 'height': (int,), # noqa: E501 + 'duration': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'url': 'url', # noqa: E501 + 'width': 'width', # noqa: E501 + 'height': 'height', # noqa: E501 + 'duration': 'duration', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, url, width, height, duration, *args, **kwargs): # noqa: E501 + """ExternalVideoVariableValue - a model defined in OpenAPI + + Args: + url (str): The vast video url + width (int): The video's width + height (int): The video's height + duration (str): The video's duration + + 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.url = url + self.width = width + self.height = height + self.duration = duration + 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, url, width, height, duration, *args, **kwargs): # noqa: E501 + """ExternalVideoVariableValue - a model defined in OpenAPI + + Args: + url (str): The vast video url + width (int): The video's width + height (int): The video's height + duration (str): The video's duration + + 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.url = url + self.width = width + self.height = height + self.duration = duration + 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/input_keywords_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/input_keywords_model.py new file mode 100644 index 00000000..c55f89bd --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/input_keywords_model.py @@ -0,0 +1,265 @@ +""" + 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 InputKeywordsModel(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 { + 'negative_broad': ([str], none_type,), # noqa: E501 + 'negative_exact': ([str], none_type,), # noqa: E501 + 'positive_exact': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negative_broad': 'negativeBroad', # noqa: E501 + 'negative_exact': 'negativeExact', # noqa: E501 + 'positive_exact': 'positiveExact', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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 + """InputKeywordsModel - 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,) + negative_broad ([str], none_type): [optional] # noqa: E501 + negative_exact ([str], none_type): [optional] # noqa: E501 + positive_exact ([str], 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/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py deleted file mode 100644 index a1fc608d..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py +++ /dev/null @@ -1,285 +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.line_item_bid_multipliers import LineItemBidMultipliers - globals()['LineItemBidMultipliers'] = LineItemBidMultipliers - - -class JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers(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 { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'attributes': (LineItemBidMultipliers,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - '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, id, type, *args, **kwargs): # noqa: E501 - """JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - a model defined in OpenAPI - - Args: - id (str): - type (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,) - attributes (LineItemBidMultipliers): [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.id = id - 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 \ - 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, type, *args, **kwargs): # noqa: E501 - """JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - a model defined in OpenAPI - - Args: - id (str): - type (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,) - attributes (LineItemBidMultipliers): [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.id = id - 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 \ - 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_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py new file mode 100644 index 00000000..765c7f89 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py @@ -0,0 +1,285 @@ +""" + 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.external_line_item_bid_multipliers_v2 import ExternalLineItemBidMultipliersV2 + globals()['ExternalLineItemBidMultipliersV2'] = ExternalLineItemBidMultipliersV2 + + +class JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2(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 { + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'attributes': (ExternalLineItemBidMultipliersV2,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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, id, type, *args, **kwargs): # noqa: E501 + """JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2 - a model defined in OpenAPI + + Args: + id (str): + type (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,) + attributes (ExternalLineItemBidMultipliersV2): [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.id = id + 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 \ + 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, type, *args, **kwargs): # noqa: E501 + """JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2 - a model defined in OpenAPI + + Args: + id (str): + type (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,) + attributes (ExternalLineItemBidMultipliersV2): [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.id = id + 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 \ + 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_line_item_bid_multipliers.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_single_response_of_line_item_bid_multipliers.py deleted file mode 100644 index 336581b6..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_single_response_of_line_item_bid_multipliers.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_line_item_bid_multipliers_and_line_item_bid_multipliers import JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - globals()['CommonError'] = CommonError - globals()['CommonWarning'] = CommonWarning - globals()['JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers'] = JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - - -class JsonApiSingleResponseOfLineItemBidMultipliers(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': (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers,), # 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 - """JsonApiSingleResponseOfLineItemBidMultipliers - a model defined in OpenAPI - - Args: - data (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers): - - 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 - """JsonApiSingleResponseOfLineItemBidMultipliers - a model defined in OpenAPI - - Args: - data (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers): - - 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/json_api_single_response_of_line_item_bid_multipliers_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_single_response_of_line_item_bid_multipliers_v2.py new file mode 100644 index 00000000..ba19ba48 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/json_api_single_response_of_line_item_bid_multipliers_v2.py @@ -0,0 +1,287 @@ +""" + 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_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2 import JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2 + globals()['CommonError'] = CommonError + globals()['CommonWarning'] = CommonWarning + globals()['JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2'] = JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2 + + +class JsonApiSingleResponseOfLineItemBidMultipliersV2(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': (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2,), # noqa: E501 + 'errors': ([CommonError], none_type,), # noqa: E501 + 'warnings': ([CommonWarning], none_type,), # 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 + """JsonApiSingleResponseOfLineItemBidMultipliersV2 - a model defined in OpenAPI + + Args: + data (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2): + + 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], none_type): [optional] # noqa: E501 + warnings ([CommonWarning], 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.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 + """JsonApiSingleResponseOfLineItemBidMultipliersV2 - a model defined in OpenAPI + + Args: + data (JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2): + + 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], none_type): [optional] # noqa: E501 + warnings ([CommonWarning], 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.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/keyword_data_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/keyword_data_model.py new file mode 100644 index 00000000..1a588018 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/keyword_data_model.py @@ -0,0 +1,286 @@ +""" + 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.input_keywords_model import InputKeywordsModel + from criteo_api_retailmedia_preview.model.match_type_model import MatchTypeModel + from criteo_api_retailmedia_preview.model.review_state_model import ReviewStateModel + globals()['InputKeywordsModel'] = InputKeywordsModel + globals()['MatchTypeModel'] = MatchTypeModel + globals()['ReviewStateModel'] = ReviewStateModel + + +class KeywordDataModel(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 { + 'review_state': (ReviewStateModel,), # noqa: E501 + 'match_type': (MatchTypeModel,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + 'input_keywords': (InputKeywordsModel,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'review_state': 'reviewState', # noqa: E501 + 'match_type': 'matchType', # noqa: E501 + 'bid': 'bid', # noqa: E501 + 'input_keywords': 'inputKeywords', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """KeywordDataModel - 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,) + review_state (ReviewStateModel): [optional] # noqa: E501 + match_type (MatchTypeModel): [optional] # noqa: E501 + bid (float, none_type): [optional] # noqa: E501 + input_keywords (InputKeywordsModel): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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/keywords_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/keywords_model.py new file mode 100644 index 00000000..6ea5b7a1 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/keywords_model.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.keyword_data_model import KeywordDataModel + globals()['KeywordDataModel'] = KeywordDataModel + + +class KeywordsModel(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 { + 'keywords': ({str: (KeywordDataModel,)}, none_type,), # noqa: E501 + 'rank': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + 'rank': 'rank', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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 + """KeywordsModel - 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,) + keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501 + rank ([str], 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/keywords_model_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/keywords_model_resource.py new file mode 100644 index 00000000..ec9bd0a4 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/keywords_model_resource.py @@ -0,0 +1,270 @@ +""" + 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.keywords_model import KeywordsModel + globals()['KeywordsModel'] = KeywordsModel + + +class KeywordsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (KeywordsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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 + """KeywordsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (KeywordsModel): [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/keywords_model_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/keywords_model_response.py new file mode 100644 index 00000000..9dbf9ff0 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/keywords_model_response.py @@ -0,0 +1,274 @@ +""" + 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.keywords_model_resource import KeywordsModelResource + from criteo_api_retailmedia_preview.model.rmca_common_problem import RmcaCommonProblem + globals()['KeywordsModelResource'] = KeywordsModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class KeywordsModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (KeywordsModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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 + """KeywordsModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (KeywordsModelResource): [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/line_item_bid_multipliers.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers.py deleted file mode 100644 index a97fa2df..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers.py +++ /dev/null @@ -1,291 +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 LineItemBidMultipliers(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 { - 'search': (float,), # noqa: E501 - 'homepage': (float,), # noqa: E501 - 'categories': (float,), # noqa: E501 - 'product_detail': (float,), # noqa: E501 - 'confirmation': (float,), # noqa: E501 - 'merchandising': (float,), # noqa: E501 - 'deals': (float,), # noqa: E501 - 'checkout': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'search': 'search', # noqa: E501 - 'homepage': 'homepage', # noqa: E501 - 'categories': 'categories', # noqa: E501 - 'product_detail': 'productDetail', # noqa: E501 - 'confirmation': 'confirmation', # noqa: E501 - 'merchandising': 'merchandising', # noqa: E501 - 'deals': 'deals', # noqa: E501 - 'checkout': 'checkout', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """LineItemBidMultipliers - 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,) - search (float): [optional] # noqa: E501 - homepage (float): [optional] # noqa: E501 - categories (float): [optional] # noqa: E501 - product_detail (float): [optional] # noqa: E501 - confirmation (float): [optional] # noqa: E501 - merchandising (float): [optional] # noqa: E501 - deals (float): [optional] # noqa: E501 - checkout (float): [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 - """LineItemBidMultipliers - 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,) - search (float): [optional] # noqa: E501 - homepage (float): [optional] # noqa: E501 - categories (float): [optional] # noqa: E501 - product_detail (float): [optional] # noqa: E501 - confirmation (float): [optional] # noqa: E501 - merchandising (float): [optional] # noqa: E501 - deals (float): [optional] # noqa: E501 - checkout (float): [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/line_item_bid_multipliers_request.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers_request.py deleted file mode 100644 index 4676de8b..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers_request.py +++ /dev/null @@ -1,269 +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.resource_of_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers - globals()['ResourceOfLineItemBidMultipliers'] = ResourceOfLineItemBidMultipliers - - -class LineItemBidMultipliersRequest(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': (ResourceOfLineItemBidMultipliers,), # 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 - """LineItemBidMultipliersRequest - 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 (ResourceOfLineItemBidMultipliers): [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 - """LineItemBidMultipliersRequest - 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 (ResourceOfLineItemBidMultipliers): [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/line_item_bid_multipliers_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers_response.py deleted file mode 100644 index 70c4206f..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers_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_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers - globals()['ProblemDetails'] = ProblemDetails - globals()['ResourceOfLineItemBidMultipliers'] = ResourceOfLineItemBidMultipliers - - -class LineItemBidMultipliersResponse(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': (ResourceOfLineItemBidMultipliers,), # 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 - """LineItemBidMultipliersResponse - 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 (ResourceOfLineItemBidMultipliers): [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 - """LineItemBidMultipliersResponse - 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 (ResourceOfLineItemBidMultipliers): [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/line_item_bid_multipliers_v2_request.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_request.py new file mode 100644 index 00000000..4cdcb3e9 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers_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_line_item_bid_multipliers_v2 import ResourceOfLineItemBidMultipliersV2 + globals()['ResourceOfLineItemBidMultipliersV2'] = ResourceOfLineItemBidMultipliersV2 + + +class LineItemBidMultipliersV2Request(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': (ResourceOfLineItemBidMultipliersV2,), # 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 + """LineItemBidMultipliersV2Request - 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 (ResourceOfLineItemBidMultipliersV2): [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 + """LineItemBidMultipliersV2Request - 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 (ResourceOfLineItemBidMultipliersV2): [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/line_item_bid_multipliers_v2_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py new file mode 100644 index 00000000..f4e436ff --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.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.common_problem import CommonProblem + from criteo_api_retailmedia_preview.model.resource_of_line_item_bid_multipliers_v2 import ResourceOfLineItemBidMultipliersV2 + globals()['CommonProblem'] = CommonProblem + globals()['ResourceOfLineItemBidMultipliersV2'] = ResourceOfLineItemBidMultipliersV2 + + +class LineItemBidMultipliersV2Response(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': (ResourceOfLineItemBidMultipliersV2,), # noqa: E501 + 'warnings': ([CommonProblem], none_type,), # noqa: E501 + 'errors': ([CommonProblem], none_type,), # 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 + """LineItemBidMultipliersV2Response - 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 (ResourceOfLineItemBidMultipliersV2): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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 + """LineItemBidMultipliersV2Response - 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 (ResourceOfLineItemBidMultipliersV2): [optional] # noqa: E501 + warnings ([CommonProblem], none_type): [optional] # noqa: E501 + errors ([CommonProblem], 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/line_item_product_status.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_product_status.py new file mode 100644 index 00000000..938528dd --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/line_item_product_status.py @@ -0,0 +1,291 @@ +""" + 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 LineItemProductStatus(ModelSimple): + """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. + 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 = { + ('value',): { + 'UNKNOWN': "Unknown", + 'ACTIVE': "Active", + 'PAUSED': "Paused", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """LineItemProductStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ] # noqa: E501 + + Keyword Args: + value (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """LineItemProductStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ] # noqa: E501 + + Keyword Args: + value (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/match_type_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/match_type_model.py new file mode 100644 index 00000000..6cd04bc9 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/match_type_model.py @@ -0,0 +1,291 @@ +""" + 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 MatchTypeModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'POSITIVEEXACTMATCH': "PositiveExactMatch", + 'NEGATIVEEXACTMATCH': "NegativeExactMatch", + 'NEGATIVEBROADMATCH': "NegativeBroadMatch", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """MatchTypeModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # noqa: E501 + + Keyword Args: + value (str): The match type of a keyword.., must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/negotiation_state_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/negotiation_state_model.py new file mode 100644 index 00000000..fcb1eec9 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/negotiation_state_model.py @@ -0,0 +1,293 @@ +""" + 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 NegotiationStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INVALID': "Invalid", + 'MODIFIED': "Modified", + 'SUBMITTED': "Submitted", + 'REVIEWED': "Reviewed", + 'APPROVED': "Approved", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """NegotiationStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # noqa: E501 + + Keyword Args: + value (str): The state of a negotiation in the context of a line item.., must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_metadata.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_metadata.py new file mode 100644 index 00000000..e551537b --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_metadata.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 + + + +class ProductMetadata(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, none_type,), # noqa: E501 + 'limit': (int, none_type,), # noqa: E501 + 'count': (int, none_type,), # noqa: E501 + 'response_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 + 'response_count': 'responseCount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProductMetadata - 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,) + offset (int, none_type): Zero based offset of the first item in the response.. [optional] # noqa: E501 + limit (int, none_type): Maximum number of items in the response.. [optional] # noqa: E501 + count (int, none_type): Total number of items available.. [optional] # noqa: E501 + response_count (int, none_type): Number of items in the response.. [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 + """ProductMetadata - 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,) + offset (int, none_type): Zero based offset of the first item in the response.. [optional] # noqa: E501 + limit (int, none_type): Maximum number of items in the response.. [optional] # noqa: E501 + count (int, none_type): Total number of items available.. [optional] # noqa: E501 + response_count (int, none_type): Number of items in the response.. [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_resource_outcome.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_resource_outcome.py new file mode 100644 index 00000000..b0c3efd2 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/product_resource_outcome.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.rmca_common_problem import RmcaCommonProblem + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ProductResourceOutcome(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '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, *args, **kwargs): # noqa: E501 + """ProductResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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 + """ProductResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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/promoted_product.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/promoted_product.py new file mode 100644 index 00000000..53ac0f98 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/promoted_product.py @@ -0,0 +1,270 @@ +""" + 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.line_item_product_status import LineItemProductStatus + globals()['LineItemProductStatus'] = LineItemProductStatus + + +class PromotedProduct(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 { + 'id': (str, none_type,), # noqa: E501 + 'bid_override': (float, none_type,), # noqa: E501 + 'status': (LineItemProductStatus,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'bid_override': 'bidOverride', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PromotedProduct - 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,) + id (str, none_type): A retailer defined SKU ID for the promoted product.. [optional] # noqa: E501 + bid_override (float, none_type): The bid override for the promoted product for this line item. Ignored unless adding a product.. [optional] # noqa: E501 + status (LineItemProductStatus): [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 + """PromotedProduct - 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,) + id (str, none_type): A retailer defined SKU ID for the promoted product.. [optional] # noqa: E501 + bid_override (float, none_type): The bid override for the promoted product for this line item. Ignored unless adding a product.. [optional] # noqa: E501 + status (LineItemProductStatus): [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/promoted_product_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/promoted_product_resource.py new file mode 100644 index 00000000..2cfef1b8 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/promoted_product_resource.py @@ -0,0 +1,270 @@ +""" + 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.promoted_product import PromotedProduct + globals()['PromotedProduct'] = PromotedProduct + + +class PromotedProductResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (PromotedProduct,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """PromotedProductResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (PromotedProduct): [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 + """PromotedProductResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (PromotedProduct): [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/promoted_product_resource_collection_input.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.py new file mode 100644 index 00000000..aa344bd4 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.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.promoted_product_resource import PromotedProductResource + globals()['PromotedProductResource'] = PromotedProductResource + + +class PromotedProductResourceCollectionInput(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': ([PromotedProductResource], 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 + """PromotedProductResourceCollectionInput - 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 ([PromotedProductResource], 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 + """PromotedProductResourceCollectionInput - 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 ([PromotedProductResource], 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/promoted_product_resource_collection_outcome.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py new file mode 100644 index 00000000..b35bc258 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py @@ -0,0 +1,278 @@ +""" + 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.product_metadata import ProductMetadata + from criteo_api_retailmedia_preview.model.promoted_product_resource import PromotedProductResource + from criteo_api_retailmedia_preview.model.rmca_common_problem import RmcaCommonProblem + globals()['ProductMetadata'] = ProductMetadata + globals()['PromotedProductResource'] = PromotedProductResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class PromotedProductResourceCollectionOutcome(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'meta': (ProductMetadata,), # noqa: E501 + 'data': ([PromotedProductResource], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + '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, *args, **kwargs): # noqa: E501 + """PromotedProductResourceCollectionOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + meta (ProductMetadata): [optional] # noqa: E501 + data ([PromotedProductResource], 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 + """PromotedProductResourceCollectionOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + meta (ProductMetadata): [optional] # noqa: E501 + data ([PromotedProductResource], 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/proposal_status_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/proposal_status_model.py new file mode 100644 index 00000000..4937d865 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/proposal_status_model.py @@ -0,0 +1,284 @@ +""" + 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.approval_status_model import ApprovalStatusModel + from criteo_api_retailmedia_preview.model.negotiation_state_model import NegotiationStateModel + globals()['ApprovalStatusModel'] = ApprovalStatusModel + globals()['NegotiationStateModel'] = NegotiationStateModel + + +class ProposalStatusModel(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 { + 'negotiation_state': (NegotiationStateModel,), # noqa: E501 + 'booking_status': (ApprovalStatusModel,), # noqa: E501 + 'runnable_status': (ApprovalStatusModel,), # noqa: E501 + 'comment': (str, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negotiation_state': 'negotiationState', # noqa: E501 + 'booking_status': 'bookingStatus', # noqa: E501 + 'runnable_status': 'runnableStatus', # noqa: E501 + 'comment': 'comment', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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 + """ProposalStatusModel - 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,) + negotiation_state (NegotiationStateModel): [optional] # noqa: E501 + booking_status (ApprovalStatusModel): [optional] # noqa: E501 + runnable_status (ApprovalStatusModel): [optional] # noqa: E501 + comment (str, none_type): [optional] # noqa: E501 + created_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime, 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/proposal_status_model_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/proposal_status_model_resource.py new file mode 100644 index 00000000..1d167710 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/proposal_status_model_resource.py @@ -0,0 +1,270 @@ +""" + 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.proposal_status_model import ProposalStatusModel + globals()['ProposalStatusModel'] = ProposalStatusModel + + +class ProposalStatusModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (ProposalStatusModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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 + """ProposalStatusModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (ProposalStatusModel): [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/proposal_status_model_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/proposal_status_model_response.py new file mode 100644 index 00000000..f79b3141 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/proposal_status_model_response.py @@ -0,0 +1,274 @@ +""" + 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.proposal_status_model_resource import ProposalStatusModelResource + from criteo_api_retailmedia_preview.model.rmca_common_problem import RmcaCommonProblem + globals()['ProposalStatusModelResource'] = ProposalStatusModelResource + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ProposalStatusModelResponse(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'data': (ProposalStatusModelResource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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 + """ProposalStatusModelResponse - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + data (ProposalStatusModelResource): [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/resource_of_creative_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_creative_v2.py new file mode 100644 index 00000000..f175b0c1 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_creative_v2.py @@ -0,0 +1,277 @@ +""" + 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.external_creative_v2 import ExternalCreativeV2 + globals()['ExternalCreativeV2'] = ExternalCreativeV2 + + +class ResourceOfCreativeV2(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 { + 'attributes': (ExternalCreativeV2,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfCreativeV2 - 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,) + attributes (ExternalCreativeV2): [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 + """ + + _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 + """ResourceOfCreativeV2 - 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,) + attributes (ExternalCreativeV2): [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 + """ + + _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/resource_of_line_item_bid_multipliers.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers.py deleted file mode 100644 index 29321f35..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers.py +++ /dev/null @@ -1,277 +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.line_item_bid_multipliers import LineItemBidMultipliers - globals()['LineItemBidMultipliers'] = LineItemBidMultipliers - - -class ResourceOfLineItemBidMultipliers(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 { - 'attributes': (LineItemBidMultipliers,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResourceOfLineItemBidMultipliers - 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,) - attributes (LineItemBidMultipliers): [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 - """ - - _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 - """ResourceOfLineItemBidMultipliers - 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,) - attributes (LineItemBidMultipliers): [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 - """ - - _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/resource_of_line_item_bid_multipliers_v2.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.py new file mode 100644 index 00000000..9c7aa3a1 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.py @@ -0,0 +1,277 @@ +""" + 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.external_line_item_bid_multipliers_v2 import ExternalLineItemBidMultipliersV2 + globals()['ExternalLineItemBidMultipliersV2'] = ExternalLineItemBidMultipliersV2 + + +class ResourceOfLineItemBidMultipliersV2(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 { + 'attributes': (ExternalLineItemBidMultipliersV2,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOfLineItemBidMultipliersV2 - 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,) + attributes (ExternalLineItemBidMultipliersV2): [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 + """ + + _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 + """ResourceOfLineItemBidMultipliersV2 - 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,) + attributes (ExternalLineItemBidMultipliersV2): [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 + """ + + _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/resource_outcome.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_outcome.py new file mode 100644 index 00000000..957309df --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/resource_outcome.py @@ -0,0 +1,268 @@ +""" + 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.rmca_common_problem import RmcaCommonProblem + globals()['RmcaCommonProblem'] = RmcaCommonProblem + + +class ResourceOutcome(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 { + 'errors': ([RmcaCommonProblem], none_type,), # noqa: E501 + 'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + 'warnings': 'warnings', # noqa: E501 + } + + read_only_vars = { + 'errors', # noqa: E501 + 'warnings', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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 + """ResourceOutcome - 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,) + errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501 + warnings ([RmcaCommonProblem], 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/retail_media_account.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_account.py index fbe18032..70903507 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_account.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_account.py @@ -91,8 +91,8 @@ def openapi_types(): 'company_name': (str, none_type,), # noqa: E501 'type': (str, none_type,), # noqa: E501 'sub_type': (str, none_type,), # noqa: E501 - 'country_ids': ([int], none_type,), # noqa: E501 - 'currency_id': (int, none_type,), # noqa: E501 + 'country_ids': ([str], none_type,), # noqa: E501 + 'currency_id': (str, none_type,), # noqa: E501 'parent_account_label': (str, none_type,), # noqa: E501 'time_zone': (str, none_type,), # noqa: E501 } @@ -158,8 +158,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501 type (str, none_type): Type for the account. [optional] # noqa: E501 sub_type (str, none_type): subtype for the account. [optional] # noqa: E501 - country_ids ([int], none_type): list of countries associated with the account. [optional] # noqa: E501 - currency_id (int, none_type): the currency for the account. [optional] # noqa: E501 + country_ids ([str], none_type): list of countries associated with the account. [optional] # noqa: E501 + currency_id (str, none_type): the currency for the account. [optional] # noqa: E501 parent_account_label (str, none_type): parent account label for the account. [optional] # noqa: E501 time_zone (str, none_type): the timezone for the account. [optional] # noqa: E501 """ @@ -251,8 +251,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501 type (str, none_type): Type for the account. [optional] # noqa: E501 sub_type (str, none_type): subtype for the account. [optional] # noqa: E501 - country_ids ([int], none_type): list of countries associated with the account. [optional] # noqa: E501 - currency_id (int, none_type): the currency for the account. [optional] # noqa: E501 + country_ids ([str], none_type): list of countries associated with the account. [optional] # noqa: E501 + currency_id (str, none_type): the currency for the account. [optional] # noqa: E501 parent_account_label (str, none_type): parent account label for the account. [optional] # noqa: E501 time_zone (str, none_type): the timezone for the account. [optional] # noqa: E501 """ diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py new file mode 100644 index 00000000..8b387a7f --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py @@ -0,0 +1,279 @@ +""" + 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_contactlist_amendment_attributes import RetailMediaContactlistAmendmentAttributes + globals()['RetailMediaContactlistAmendmentAttributes'] = RetailMediaContactlistAmendmentAttributes + + +class RetailMediaContactlistAmendment(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 { + 'attributes': (RetailMediaContactlistAmendmentAttributes,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistAmendment - a model defined in OpenAPI + + Args: + attributes (RetailMediaContactlistAmendmentAttributes): + + 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): User List. [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.attributes = attributes + 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, attributes, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistAmendment - a model defined in OpenAPI + + Args: + attributes (RetailMediaContactlistAmendmentAttributes): + + 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): User List. [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.attributes = attributes + 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/retail_media_contactlist_amendment_attributes.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_attributes.py new file mode 100644 index 00000000..52465c4f --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_attributes.py @@ -0,0 +1,292 @@ +""" + 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 RetailMediaContactlistAmendmentAttributes(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 = { + ('operation',): { + 'ADD': "add", + 'REMOVE': "remove", + }, + ('identifier_type',): { + 'None': None, + 'EMAIL': "email", + 'MADID': "madid", + 'IDENTITYLINK': "identityLink", + 'GUM': "gum", + 'CUSTOMERID': "customerid", + 'PHONENUMBER': "phoneNumber", + }, + } + + 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 { + 'operation': (str,), # noqa: E501 + 'identifiers': ([str],), # noqa: E501 + 'identifier_type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'operation': 'operation', # noqa: E501 + 'identifiers': 'identifiers', # noqa: E501 + 'identifier_type': 'identifierType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, operation, identifiers, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistAmendmentAttributes - a model defined in OpenAPI + + Args: + operation (str): Whether to add or remove users + identifiers ([str]): The users to add or remove, each in the schema specified + + 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,) + identifier_type (str, none_type): What type of identifiers are used. [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.operation = operation + self.identifiers = identifiers + 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, operation, identifiers, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistAmendmentAttributes - a model defined in OpenAPI + + Args: + operation (str): Whether to add or remove users + identifiers ([str]): The users to add or remove, each in the schema specified + + 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,) + identifier_type (str, none_type): What type of identifiers are used. [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.operation = operation + self.identifiers = identifiers + 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/retail_media_contactlist_amendment_request.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_request.py new file mode 100644 index 00000000..3926d076 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_request.py @@ -0,0 +1,275 @@ +""" + 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_contactlist_amendment import RetailMediaContactlistAmendment + globals()['RetailMediaContactlistAmendment'] = RetailMediaContactlistAmendment + + +class RetailMediaContactlistAmendmentRequest(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': (RetailMediaContactlistAmendment,), # 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, data, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistAmendmentRequest - a model defined in OpenAPI + + Args: + data (RetailMediaContactlistAmendment): + + 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.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 + """RetailMediaContactlistAmendmentRequest - a model defined in OpenAPI + + Args: + data (RetailMediaContactlistAmendment): + + 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.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/retail_media_contactlist_operation.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_operation.py new file mode 100644 index 00000000..d15b6296 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_operation.py @@ -0,0 +1,291 @@ +""" + 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.audience_error import AudienceError + from criteo_api_retailmedia_preview.model.audience_warning import AudienceWarning + from criteo_api_retailmedia_preview.model.retail_media_contactlist_operation_response_attributes import RetailMediaContactlistOperationResponseAttributes + globals()['AudienceError'] = AudienceError + globals()['AudienceWarning'] = AudienceWarning + globals()['RetailMediaContactlistOperationResponseAttributes'] = RetailMediaContactlistOperationResponseAttributes + + +class RetailMediaContactlistOperation(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': (RetailMediaContactlistOperationResponseAttributes,), # noqa: E501 + 'errors': ([AudienceError],), # noqa: E501 + 'warnings': ([AudienceWarning],), # 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, errors, warnings, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistOperation - a model defined in OpenAPI + + Args: + data (RetailMediaContactlistOperationResponseAttributes): + errors ([AudienceError]): + warnings ([AudienceWarning]): + + 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.data = data + 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 \ + 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, errors, warnings, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistOperation - a model defined in OpenAPI + + Args: + data (RetailMediaContactlistOperationResponseAttributes): + errors ([AudienceError]): + warnings ([AudienceWarning]): + + 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.data = data + 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 \ + 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/retail_media_contactlist_operation_response_attributes.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes.py new file mode 100644 index 00000000..4d10863d --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes.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.retail_media_contactlist_operation_response_attributes_attributes import RetailMediaContactlistOperationResponseAttributesAttributes + globals()['RetailMediaContactlistOperationResponseAttributesAttributes'] = RetailMediaContactlistOperationResponseAttributesAttributes + + +class RetailMediaContactlistOperationResponseAttributes(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,), # noqa: E501 + 'attributes': (RetailMediaContactlistOperationResponseAttributesAttributes,), # 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, type, attributes, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistOperationResponseAttributes - a model defined in OpenAPI + + Args: + type (str): the name of the entity type + attributes (RetailMediaContactlistOperationResponseAttributesAttributes): + + 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.type = type + self.attributes = attributes + 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, type, attributes, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistOperationResponseAttributes - a model defined in OpenAPI + + Args: + type (str): the name of the entity type + attributes (RetailMediaContactlistOperationResponseAttributesAttributes): + + 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.type = type + self.attributes = attributes + 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/retail_media_contactlist_operation_response_attributes_attributes.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes_attributes.py new file mode 100644 index 00000000..e4d227b8 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes_attributes.py @@ -0,0 +1,297 @@ +""" + 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 RetailMediaContactlistOperationResponseAttributesAttributes(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 { + 'contact_list_id': (int,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'request_date': (datetime,), # noqa: E501 + 'identifier_type': (str, none_type,), # noqa: E501 + 'nb_invalid_identifiers': (int, none_type,), # noqa: E501 + 'nb_valid_identifiers': (int, none_type,), # noqa: E501 + 'sample_invalid_identifiers': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'contact_list_id': 'contactListId', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'request_date': 'requestDate', # noqa: E501 + 'identifier_type': 'identifierType', # noqa: E501 + 'nb_invalid_identifiers': 'nbInvalidIdentifiers', # noqa: E501 + 'nb_valid_identifiers': 'nbValidIdentifiers', # noqa: E501 + 'sample_invalid_identifiers': 'sampleInvalidIdentifiers', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, contact_list_id, operation, request_date, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistOperationResponseAttributesAttributes - a model defined in OpenAPI + + Args: + contact_list_id (int): The affected user list id + operation (str): The action recorded + request_date (datetime): When the action was recorded + + 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,) + identifier_type (str, none_type): The schema specified for of the identifiers. [optional] # noqa: E501 + nb_invalid_identifiers (int, none_type): How many identifiers were invalid for the specified schema. [optional] # noqa: E501 + nb_valid_identifiers (int, none_type): How many identifiers were valid for the specified schema. [optional] # noqa: E501 + sample_invalid_identifiers ([str], none_type): A sample of invalid identifiers if there is some. [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.contact_list_id = contact_list_id + self.operation = operation + self.request_date = request_date + 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, contact_list_id, operation, request_date, *args, **kwargs): # noqa: E501 + """RetailMediaContactlistOperationResponseAttributesAttributes - a model defined in OpenAPI + + Args: + contact_list_id (int): The affected user list id + operation (str): The action recorded + request_date (datetime): When the action was recorded + + 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,) + identifier_type (str, none_type): The schema specified for of the identifiers. [optional] # noqa: E501 + nb_invalid_identifiers (int, none_type): How many identifiers were invalid for the specified schema. [optional] # noqa: E501 + nb_valid_identifiers (int, none_type): How many identifiers were valid for the specified schema. [optional] # noqa: E501 + sample_invalid_identifiers ([str], none_type): A sample of invalid identifiers if there is some. [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.contact_list_id = contact_list_id + self.operation = operation + self.request_date = request_date + 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/retail_media_externalv1_add_remove_keyword_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keyword_model.py deleted file mode 100644 index aeeb1849..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keyword_model.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 - - - -class RetailMediaExternalv1AddRemoveKeywordModel(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 = { - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - validations = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'is_deleted': (bool, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'is_deleted': 'isDeleted', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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 - """RetailMediaExternalv1AddRemoveKeywordModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - is_deleted (bool, 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/retail_media_externalv1_add_remove_keywords_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model.py deleted file mode 100644 index 4d0e01c9..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model.py +++ /dev/null @@ -1,271 +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.retail_media_externalv1_add_remove_keyword_model import RetailMediaExternalv1AddRemoveKeywordModel - globals()['RetailMediaExternalv1AddRemoveKeywordModel'] = RetailMediaExternalv1AddRemoveKeywordModel - - -class RetailMediaExternalv1AddRemoveKeywordsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1AddRemoveKeywordModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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 - """RetailMediaExternalv1AddRemoveKeywordsModel - 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,) - keywords ([RetailMediaExternalv1AddRemoveKeywordModel], 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/retail_media_externalv1_add_remove_keywords_model_request.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model_request.py deleted file mode 100644 index e9a66fde..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model_request.py +++ /dev/null @@ -1,269 +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.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource - globals()['RetailMediaExternalv1AddRemoveKeywordsModelResource'] = RetailMediaExternalv1AddRemoveKeywordsModelResource - - -class RetailMediaExternalv1AddRemoveKeywordsModelRequest(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': (RetailMediaExternalv1AddRemoveKeywordsModelResource,), # 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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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 - """RetailMediaExternalv1AddRemoveKeywordsModelRequest - 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 (RetailMediaExternalv1AddRemoveKeywordsModelResource): [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/retail_media_externalv1_add_remove_keywords_model_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model_resource.py deleted file mode 100644 index 28e23baf..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_add_remove_keywords_model_resource.py +++ /dev/null @@ -1,283 +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.retail_media_externalv1_add_remove_keywords_model import RetailMediaExternalv1AddRemoveKeywordsModel - globals()['RetailMediaExternalv1AddRemoveKeywordsModel'] = RetailMediaExternalv1AddRemoveKeywordsModel - - -class RetailMediaExternalv1AddRemoveKeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1AddRemoveKeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1AddRemoveKeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1AddRemoveKeywordsModel): [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.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 \ - 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/retail_media_externalv1_input_keywords_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_input_keywords_model.py deleted file mode 100644 index 973de85d..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_input_keywords_model.py +++ /dev/null @@ -1,277 +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 RetailMediaExternalv1InputKeywordsModel(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 = { - ('negative_broad',): { - }, - ('negative_exact',): { - }, - ('positive_exact',): { - }, - } - - @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 { - 'negative_broad': ([str], none_type,), # noqa: E501 - 'negative_exact': ([str], none_type,), # noqa: E501 - 'positive_exact': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negative_broad': 'negativeBroad', # noqa: E501 - 'negative_exact': 'negativeExact', # noqa: E501 - 'positive_exact': 'positiveExact', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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 - """RetailMediaExternalv1InputKeywordsModel - 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,) - negative_broad ([str], none_type): [optional] # noqa: E501 - negative_exact ([str], none_type): [optional] # noqa: E501 - positive_exact ([str], 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/retail_media_externalv1_keyword_data_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_keyword_data_model.py deleted file mode 100644 index 493aec7c..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_keyword_data_model.py +++ /dev/null @@ -1,304 +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.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel - globals()['RetailMediaExternalv1InputKeywordsModel'] = RetailMediaExternalv1InputKeywordsModel - - -class RetailMediaExternalv1KeywordDataModel(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 = { - ('review_state',): { - 'None': None, - 'INREVIEW': "InReview", - 'RECOMMENDED': "Recommended", - 'APPROVED': "Approved", - 'AUTOAPPROVED': "AutoApproved", - 'REJECTED': "Rejected", - 'AUTOREJECTED': "AutoRejected", - }, - ('match_type',): { - 'None': None, - 'POSITIVEEXACTMATCH': "PositiveExactMatch", - 'NEGATIVEEXACTMATCH': "NegativeExactMatch", - 'NEGATIVEBROADMATCH': "NegativeBroadMatch", - }, - } - - 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 { - 'review_state': (str, none_type,), # noqa: E501 - 'match_type': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - 'input_keywords': (RetailMediaExternalv1InputKeywordsModel,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'review_state': 'reviewState', # noqa: E501 - 'match_type': 'matchType', # noqa: E501 - 'bid': 'bid', # noqa: E501 - 'input_keywords': 'inputKeywords', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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 - """RetailMediaExternalv1KeywordDataModel - 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,) - review_state (str, none_type): [optional] # noqa: E501 - match_type (str, none_type): [optional] # noqa: E501 - bid (float, none_type): [optional] # noqa: E501 - input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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/retail_media_externalv1_keywords_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model.py deleted file mode 100644 index db51e72b..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model.py +++ /dev/null @@ -1,275 +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.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel - globals()['RetailMediaExternalv1KeywordDataModel'] = RetailMediaExternalv1KeywordDataModel - - -class RetailMediaExternalv1KeywordsModel(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 = { - ('rank',): { - }, - } - - @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 { - 'keywords': (RetailMediaExternalv1KeywordDataModel,), # noqa: E501 - 'rank': ([str], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - 'rank': 'rank', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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 - """RetailMediaExternalv1KeywordsModel - 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,) - keywords (RetailMediaExternalv1KeywordDataModel): [optional] # noqa: E501 - rank ([str], 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/retail_media_externalv1_keywords_model_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model_resource.py deleted file mode 100644 index d9f6b438..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model_resource.py +++ /dev/null @@ -1,283 +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.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel - globals()['RetailMediaExternalv1KeywordsModel'] = RetailMediaExternalv1KeywordsModel - - -class RetailMediaExternalv1KeywordsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1KeywordsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1KeywordsModel): [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.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 \ - 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/retail_media_externalv1_keywords_model_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model_response.py deleted file mode 100644 index 4fb23fcc..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model_response.py +++ /dev/null @@ -1,285 +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.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource - from criteo_api_retailmedia_preview.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1KeywordsModelResource'] = RetailMediaExternalv1KeywordsModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1KeywordsModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1KeywordsModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1KeywordsModelResponse - 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 (RetailMediaExternalv1KeywordsModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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/retail_media_externalv1_problem_details.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_problem_details.py deleted file mode 100644 index b538106d..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_problem_details.py +++ /dev/null @@ -1,295 +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 RetailMediaExternalv1ProblemDetails(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 ({str: (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_identifier': (str, none_type,), # noqa: E501 - 'code': (str, none_type,), # noqa: E501 - 'source': ({str: (str,)}, none_type,), # noqa: E501 - 'stack_trace': (str, none_type,), # noqa: E501 - 'type': (str, none_type,), # noqa: E501 - 'title': (str, none_type,), # noqa: E501 - 'status': (int, none_type,), # noqa: E501 - 'detail': (str, none_type,), # noqa: E501 - 'instance': (str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'trace_identifier': 'traceIdentifier', # noqa: E501 - 'code': 'code', # noqa: E501 - 'source': 'source', # noqa: E501 - 'stack_trace': 'stackTrace', # noqa: E501 - 'type': 'type', # noqa: E501 - 'title': 'title', # noqa: E501 - 'status': 'status', # noqa: E501 - 'detail': 'detail', # noqa: E501 - 'instance': 'instance', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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 - """RetailMediaExternalv1ProblemDetails - 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,) - trace_identifier (str, none_type): [optional] # noqa: E501 - code (str, none_type): [optional] # noqa: E501 - source ({str: (str,)}, none_type): [optional] # noqa: E501 - stack_trace (str, none_type): [optional] # noqa: E501 - type (str, none_type): [optional] # noqa: E501 - title (str, none_type): [optional] # noqa: E501 - status (int, none_type): [optional] # noqa: E501 - detail (str, none_type): [optional] # noqa: E501 - instance (str, 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/retail_media_externalv1_proposal_status_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model.py deleted file mode 100644 index d43ef1d8..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model.py +++ /dev/null @@ -1,312 +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 RetailMediaExternalv1ProposalStatusModel(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 = { - ('negotiation_state',): { - 'INVALID': "Invalid", - 'MODIFIED': "Modified", - 'SUBMITTED': "Submitted", - 'REVIEWED': "Reviewed", - 'APPROVED': "Approved", - }, - ('booking_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - ('runnable_status',): { - 'NOTSUBMITTED': "NotSubmitted", - 'SUBMITTED': "Submitted", - 'REJECTED': "Rejected", - 'APPROVED': "Approved", - }, - } - - 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 { - 'negotiation_state': (str,), # noqa: E501 - 'booking_status': (str,), # noqa: E501 - 'runnable_status': (str,), # noqa: E501 - 'comment': (str, none_type,), # noqa: E501 - 'created_at': (datetime, none_type,), # noqa: E501 - 'updated_at': (datetime, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'negotiation_state': 'negotiationState', # noqa: E501 - 'booking_status': 'bookingStatus', # noqa: E501 - 'runnable_status': 'runnableStatus', # noqa: E501 - 'comment': 'comment', # noqa: E501 - 'created_at': 'createdAt', # noqa: E501 - 'updated_at': 'updatedAt', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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, negotiation_state, booking_status, runnable_status, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModel - a model defined in OpenAPI - - Args: - negotiation_state (str): - booking_status (str): - runnable_status (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,) - comment (str, none_type): [optional] # noqa: E501 - created_at (datetime, none_type): [optional] # noqa: E501 - updated_at (datetime, 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.negotiation_state = negotiation_state - self.booking_status = booking_status - self.runnable_status = runnable_status - 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/retail_media_externalv1_proposal_status_model_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_resource.py deleted file mode 100644 index ff8ea8ef..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_resource.py +++ /dev/null @@ -1,283 +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.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel - globals()['RetailMediaExternalv1ProposalStatusModel'] = RetailMediaExternalv1ProposalStatusModel - - -class RetailMediaExternalv1ProposalStatusModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1ProposalStatusModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1ProposalStatusModel): [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.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 \ - 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/retail_media_externalv1_proposal_status_model_response.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_response.py deleted file mode 100644 index ec4f61fd..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_response.py +++ /dev/null @@ -1,285 +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.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - from criteo_api_retailmedia_preview.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProposalStatusModelResource'] = RetailMediaExternalv1ProposalStatusModelResource - - -class RetailMediaExternalv1ProposalStatusModelResponse(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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': (RetailMediaExternalv1ProposalStatusModelResource,), # noqa: E501 - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # 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 = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ProposalStatusModelResponse - 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 (RetailMediaExternalv1ProposalStatusModelResource): [optional] # noqa: E501 - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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/retail_media_externalv1_resource_outcome.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_resource_outcome.py deleted file mode 100644 index 82b41a89..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_resource_outcome.py +++ /dev/null @@ -1,279 +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.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails - globals()['RetailMediaExternalv1ProblemDetails'] = RetailMediaExternalv1ProblemDetails - - -class RetailMediaExternalv1ResourceOutcome(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 = { - ('errors',): { - }, - ('warnings',): { - }, - } - - @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 { - 'errors': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - 'warnings': ([RetailMediaExternalv1ProblemDetails], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'errors': 'errors', # noqa: E501 - 'warnings': 'warnings', # noqa: E501 - } - - read_only_vars = { - 'errors', # noqa: E501 - 'warnings', # noqa: E501 - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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 - """RetailMediaExternalv1ResourceOutcome - 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,) - errors ([RetailMediaExternalv1ProblemDetails], none_type): [optional] # noqa: E501 - warnings ([RetailMediaExternalv1ProblemDetails], 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/retail_media_externalv1_set_bid_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bid_model.py deleted file mode 100644 index f196c7ad..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bid_model.py +++ /dev/null @@ -1,271 +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 RetailMediaExternalv1SetBidModel(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 = { - ('phrase',): { - 'max_length': 255, - 'min_length': 0, - }, - } - - @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 { - 'phrase': (str, none_type,), # noqa: E501 - 'bid': (float, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'phrase': 'phrase', # noqa: E501 - 'bid': 'bid', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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 - """RetailMediaExternalv1SetBidModel - 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,) - phrase (str, none_type): [optional] # noqa: E501 - bid (float, 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/retail_media_externalv1_set_bids_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model.py deleted file mode 100644 index a451561f..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model.py +++ /dev/null @@ -1,271 +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.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel - globals()['RetailMediaExternalv1SetBidModel'] = RetailMediaExternalv1SetBidModel - - -class RetailMediaExternalv1SetBidsModel(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 = { - ('keywords',): { - }, - } - - @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 { - 'keywords': ([RetailMediaExternalv1SetBidModel], none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'keywords': 'keywords', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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 - """RetailMediaExternalv1SetBidsModel - 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,) - keywords ([RetailMediaExternalv1SetBidModel], 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/retail_media_externalv1_set_bids_model_request.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model_request.py deleted file mode 100644 index 0c63c8a7..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model_request.py +++ /dev/null @@ -1,269 +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.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource - globals()['RetailMediaExternalv1SetBidsModelResource'] = RetailMediaExternalv1SetBidsModelResource - - -class RetailMediaExternalv1SetBidsModelRequest(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': (RetailMediaExternalv1SetBidsModelResource,), # 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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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 - """RetailMediaExternalv1SetBidsModelRequest - 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 (RetailMediaExternalv1SetBidsModelResource): [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/retail_media_externalv1_set_bids_model_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model_resource.py deleted file mode 100644 index 5c051c67..00000000 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/retail_media_externalv1_set_bids_model_resource.py +++ /dev/null @@ -1,283 +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.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel - globals()['RetailMediaExternalv1SetBidsModel'] = RetailMediaExternalv1SetBidsModel - - -class RetailMediaExternalv1SetBidsModelResource(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,), # noqa: E501 - 'id': (str, none_type,), # noqa: E501 - 'attributes': (RetailMediaExternalv1SetBidsModel,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'id': 'id', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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, type, *args, **kwargs): # noqa: E501 - """RetailMediaExternalv1SetBidsModelResource - a model defined in OpenAPI - - Args: - type (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,) - id (str, none_type): [optional] # noqa: E501 - attributes (RetailMediaExternalv1SetBidsModel): [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.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 \ - 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/review_state_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/review_state_model.py new file mode 100644 index 00000000..2ad6be94 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/review_state_model.py @@ -0,0 +1,294 @@ +""" + 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 ReviewStateModel(ModelSimple): + """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. + 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 = { + ('value',): { + 'INREVIEW': "InReview", + 'RECOMMENDED': "Recommended", + 'APPROVED': "Approved", + 'AUTOAPPROVED': "AutoApproved", + 'REJECTED': "Rejected", + 'AUTOREJECTED': "AutoRejected", + }, + } + + 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 { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ReviewStateModel - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # noqa: E501 + + Keyword Args: + value (str): The state of a keyword in the context of a line item.., must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/rmca_common_problem.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/rmca_common_problem.py new file mode 100644 index 00000000..88fc8f3e --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/rmca_common_problem.py @@ -0,0 +1,306 @@ +""" + 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 RmcaCommonProblem(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 = { + ('type',): { + 'None': None, + 'UNKNOWN': "unknown", + 'ACCESS-CONTROL': "access-control", + 'AUTHENTICATION': "authentication", + 'AUTHORIZATION': "authorization", + 'AVAILABILITY': "availability", + 'DEPRECATION': "deprecation", + 'QUOTA': "quota", + 'VALIDATION': "validation", + }, + } + + 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, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'instance': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'detail': (str, none_type,), # noqa: E501 + 'source': ({str: (str,)}, none_type,), # noqa: E501 + 'stack_trace': (str, none_type,), # noqa: E501 + 'status': (int, none_type,), # 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 + 'source': 'source', # noqa: E501 + 'stack_trace': 'stackTrace', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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 + """RmcaCommonProblem - 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,) + trace_id (str, none_type): The request correlation ID this problem comes from.. [optional] # noqa: E501 + type (str, none_type): The problem's category.. [optional] # noqa: E501 + code (str, none_type): A machine-readable error code, expressed as a string value.. [optional] # noqa: E501 + instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional] # noqa: E501 + title (str, none_type): A short human-readable description of the problem type. [optional] # noqa: E501 + detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional] # noqa: E501 + source ({str: (str,)}, none_type): A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501 + stack_trace (str, none_type): [optional] # noqa: E501 + status (int, none_type): The problem's HTTP Status code.. [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/set_bid_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/set_bid_model.py new file mode 100644 index 00000000..59234901 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/set_bid_model.py @@ -0,0 +1,265 @@ +""" + 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 SetBidModel(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 = { + ('phrase',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + 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 { + 'phrase': (str, none_type,), # noqa: E501 + 'bid': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'phrase': 'phrase', # noqa: E501 + 'bid': 'bid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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 + """SetBidModel - 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,) + phrase (str, none_type): [optional] # noqa: E501 + bid (float, 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/set_bids_model.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/set_bids_model.py new file mode 100644 index 00000000..48c6e18a --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/set_bids_model.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.set_bid_model import SetBidModel + globals()['SetBidModel'] = SetBidModel + + +class SetBidsModel(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 { + 'keywords': ([SetBidModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'keywords': 'keywords', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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 + """SetBidsModel - 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,) + keywords ([SetBidModel], 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/set_bids_model_request.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/set_bids_model_request.py new file mode 100644 index 00000000..2b3b748b --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/set_bids_model_request.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.set_bids_model_resource import SetBidsModelResource + globals()['SetBidsModelResource'] = SetBidsModelResource + + +class SetBidsModelRequest(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': (SetBidsModelResource,), # 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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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 + """SetBidsModelRequest - 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 (SetBidsModelResource): [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/set_bids_model_resource.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/set_bids_model_resource.py new file mode 100644 index 00000000..2f882356 --- /dev/null +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/model/set_bids_model_resource.py @@ -0,0 +1,270 @@ +""" + 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.set_bids_model import SetBidsModel + globals()['SetBidsModel'] = SetBidsModel + + +class SetBidsModelResource(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 { + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'attributes': (SetBidsModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + '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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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 + """SetBidsModelResource - 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,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + attributes (SetBidsModel): [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 47e3deb0..ab63a80a 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 @@ -57,39 +57,41 @@ class SyncAttributedTransactionsReport(ModelNormal): allowed_values = { ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, ('dimensions',): { 'None': None, - 'CAMPAIGNNAME': "campaignName", - 'CAMPAIGNID': "campaignId", - 'LINEITEMID': "lineItemId", 'PURCHASEDDATE': "purchasedDate", 'PURCHASEDHOUR': "purchasedHour", 'ADVDATE': "advDate", 'ADVHOUR': "advHour", 'DAYSDIFFERENCE': "daysDifference", + 'CAMPAIGNID': "campaignId", + 'CAMPAIGNNAME': "campaignName", + 'LINEITEMID': "lineItemId", 'LINEITEMNAME': "lineItemName", 'ADVPRODUCTID': "advProductId", 'ADVPRODUCTGTIN': "advProductGtin", @@ -104,8 +106,8 @@ class SyncAttributedTransactionsReport(ModelNormal): 'ADVENGAGEMENT': "advEngagement", 'ADVTOPURCHASEDPRODUCTRELATIONSHIP': "advToPurchasedProductRelationship", 'SALESCHANNEL': "salesChannel", - 'PAGETYPENAME': "pageTypeName", 'RETAILERNAME': "retailerName", + 'PAGETYPENAME': "pageTypeName", 'KEYWORD': "keyword", 'ATTRIBUTIONWINDOW': "attributionWindow", }, @@ -224,8 +226,8 @@ def _from_openapi_data(cls, account_id, start_date, end_date, *args, **kwargs): 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -326,8 +328,8 @@ def __init__(self, account_id, start_date, end_date, *args, **kwargs): # noqa: 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 34890112..09a4f046 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 @@ -67,26 +67,28 @@ class SyncCampaignsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -99,19 +101,20 @@ class SyncCampaignsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -128,6 +131,14 @@ class SyncCampaignsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -241,8 +252,8 @@ def _from_openapi_data(cls, account_id, start_date, end_date, *args, **kwargs): 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -343,8 +354,8 @@ def __init__(self, account_id, start_date, end_date, *args, **kwargs): # noqa: 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 cfd5a62d..2b732c86 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 @@ -67,26 +67,28 @@ class SyncLineItemsReport(ModelNormal): }, ('click_attribution_window',): { 'None': None, + 'NONE': "none", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('view_attribution_window',): { 'None': None, + 'NONE': "none", '1D': "1D", '7D': "7D", '14D': "14D", '30D': "30D", - 'NONE': "none", }, ('campaign_type',): { 'None': None, + 'ALL': "all", 'SPONSOREDPRODUCTS': "sponsoredProducts", 'ONSITEDISPLAYS': "onSiteDisplays", }, ('sales_channel',): { 'None': None, + 'ALL': "all", 'OFFLINE': "offline", 'ONLINE': "online", }, @@ -99,19 +101,20 @@ class SyncLineItemsReport(ModelNormal): '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", + 'BRANDID': "brandId", + 'BRANDNAME': "brandName", + 'ADVPRODUCTCATEGORY': "advProductCategory", + 'ADVPRODUCTID': "advProductId", + 'ADVPRODUCTNAME': "advProductName", 'SALESCHANNEL': "salesChannel", 'ENVIRONMENT': "environment", + 'PAGETYPENAME': "pageTypeName", + 'KEYWORD': "keyword", + 'SEARCHTERM': "searchTerm", }, ('metrics',): { 'None': None, @@ -128,6 +131,14 @@ class SyncLineItemsReport(ModelNormal): 'CPO': "cpo", 'CPM': "cpm", 'ROAS': "roas", + 'VIDEOVIEWS': "videoViews", + 'VIDEOSSTARTED': "videosStarted", + 'VIDEOSPLAYEDTO25': "videosPlayedTo25", + 'VIDEOSPLAYEDTO50': "videosPlayedTo50", + 'VIDEOSPLAYEDTO75': "videosPlayedTo75", + 'VIDEOSPLAYEDTO100': "videosPlayedTo100", + 'VIDEOPLAYINGRATE': "videoPlayingRate", + 'VIDEOCOMPLETIONRATE': "videoCompletionRate", 'UNIQUEVISITORS': "uniqueVisitors", 'FREQUENCY': "frequency", }, @@ -244,8 +255,8 @@ def _from_openapi_data(cls, account_id, start_date, end_date, *args, **kwargs): 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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 @@ -347,8 +358,8 @@ def __init__(self, account_id, start_date, end_date, *args, **kwargs): # noqa: 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 + campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501 + sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # 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/models/__init__.py b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/models/__init__.py index 0cdd0e52..32b58e14 100644 --- a/sdks/retailmedia_preview/criteo_api_retailmedia_preview/models/__init__.py +++ b/sdks/retailmedia_preview/criteo_api_retailmedia_preview/models/__init__.py @@ -9,9 +9,14 @@ # import sys # sys.setrecursionlimit(n) +from criteo_api_retailmedia_preview.model.add_remove_keyword_model import AddRemoveKeywordModel +from criteo_api_retailmedia_preview.model.add_remove_keywords_model import AddRemoveKeywordsModel +from criteo_api_retailmedia_preview.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_preview.model.add_remove_keywords_model_resource import AddRemoveKeywordsModelResource 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.approval_status_model import ApprovalStatusModel 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 @@ -22,6 +27,8 @@ 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.audience_error import AudienceError +from criteo_api_retailmedia_preview.model.audience_warning import AudienceWarning 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 @@ -37,45 +44,67 @@ 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.creative_v2_list_response import CreativeV2ListResponse +from criteo_api_retailmedia_preview.model.creative_v2_response import CreativeV2Response 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.error_code_response import ErrorCodeResponse 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_choice_variable_value import ExternalChoiceVariableValue +from criteo_api_retailmedia_preview.model.external_color_variable_value import ExternalColorVariableValue +from criteo_api_retailmedia_preview.model.external_creative_create_model_v2 import ExternalCreativeCreateModelV2 +from criteo_api_retailmedia_preview.model.external_creative_update_model_v2 import ExternalCreativeUpdateModelV2 +from criteo_api_retailmedia_preview.model.external_creative_v2 import ExternalCreativeV2 +from criteo_api_retailmedia_preview.model.external_files_variable_value import ExternalFilesVariableValue +from criteo_api_retailmedia_preview.model.external_hyperlink_variable_value import ExternalHyperlinkVariableValue +from criteo_api_retailmedia_preview.model.external_line_item_bid_multipliers_v2 import ExternalLineItemBidMultipliersV2 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_page_type_environment import ExternalPageTypeEnvironment 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.external_template_variable_value import ExternalTemplateVariableValue +from criteo_api_retailmedia_preview.model.external_text_variable_value import ExternalTextVariableValue +from criteo_api_retailmedia_preview.model.external_video_variable_value import ExternalVideoVariableValue 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.input_keywords import InputKeywords +from criteo_api_retailmedia_preview.model.input_keywords_model import InputKeywordsModel 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_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_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2 import JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2 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_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_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers +from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers_v2 import JsonApiSingleResponseOfLineItemBidMultipliersV2 +from criteo_api_retailmedia_preview.model.keyword_data_model import KeywordDataModel 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.keywords_model import KeywordsModel +from criteo_api_retailmedia_preview.model.keywords_model_resource import KeywordsModelResource +from criteo_api_retailmedia_preview.model.keywords_model_response import KeywordsModelResponse +from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_v2_request import LineItemBidMultipliersV2Request +from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_v2_response import LineItemBidMultipliersV2Response from criteo_api_retailmedia_preview.model.line_item_budget_overrides import LineItemBudgetOverrides +from criteo_api_retailmedia_preview.model.line_item_product_status import LineItemProductStatus from criteo_api_retailmedia_preview.model.loyalty_points import LoyaltyPoints +from criteo_api_retailmedia_preview.model.match_type_model import MatchTypeModel 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.negotiation_state_model import NegotiationStateModel from criteo_api_retailmedia_preview.model.page_metadata import PageMetadata 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 @@ -92,6 +121,8 @@ 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_metadata import ProductMetadata +from criteo_api_retailmedia_preview.model.product_resource_outcome import ProductResourceOutcome 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 @@ -100,6 +131,13 @@ 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.promoted_product import PromotedProduct +from criteo_api_retailmedia_preview.model.promoted_product_resource import PromotedProductResource +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_outcome import PromotedProductResourceCollectionOutcome +from criteo_api_retailmedia_preview.model.proposal_status_model import ProposalStatusModel +from criteo_api_retailmedia_preview.model.proposal_status_model_resource import ProposalStatusModelResource +from criteo_api_retailmedia_preview.model.proposal_status_model_response import ProposalStatusModelResponse 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 @@ -110,7 +148,8 @@ 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_line_item_bid_multipliers import ResourceOfLineItemBidMultipliers +from criteo_api_retailmedia_preview.model.resource_of_creative_v2 import ResourceOfCreativeV2 +from criteo_api_retailmedia_preview.model.resource_of_line_item_bid_multipliers_v2 import ResourceOfLineItemBidMultipliersV2 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 @@ -125,30 +164,20 @@ 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_outcome import ResourceOutcome 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 -from criteo_api_retailmedia_preview.model.retail_media_externalv1_add_remove_keywords_model_resource import RetailMediaExternalv1AddRemoveKeywordsModelResource -from criteo_api_retailmedia_preview.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel -from criteo_api_retailmedia_preview.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel -from criteo_api_retailmedia_preview.model.retail_media_externalv1_keywords_model import RetailMediaExternalv1KeywordsModel -from criteo_api_retailmedia_preview.model.retail_media_externalv1_keywords_model_resource import RetailMediaExternalv1KeywordsModelResource -from criteo_api_retailmedia_preview.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse -from criteo_api_retailmedia_preview.model.retail_media_externalv1_problem_details import RetailMediaExternalv1ProblemDetails -from criteo_api_retailmedia_preview.model.retail_media_externalv1_proposal_status_model import RetailMediaExternalv1ProposalStatusModel -from criteo_api_retailmedia_preview.model.retail_media_externalv1_proposal_status_model_resource import RetailMediaExternalv1ProposalStatusModelResource -from criteo_api_retailmedia_preview.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse -from criteo_api_retailmedia_preview.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_preview.model.retail_media_externalv1_set_bid_model import RetailMediaExternalv1SetBidModel -from criteo_api_retailmedia_preview.model.retail_media_externalv1_set_bids_model import RetailMediaExternalv1SetBidsModel -from criteo_api_retailmedia_preview.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest -from criteo_api_retailmedia_preview.model.retail_media_externalv1_set_bids_model_resource import RetailMediaExternalv1SetBidsModelResource +from criteo_api_retailmedia_preview.model.retail_media_contactlist_amendment import RetailMediaContactlistAmendment +from criteo_api_retailmedia_preview.model.retail_media_contactlist_amendment_attributes import RetailMediaContactlistAmendmentAttributes +from criteo_api_retailmedia_preview.model.retail_media_contactlist_amendment_request import RetailMediaContactlistAmendmentRequest +from criteo_api_retailmedia_preview.model.retail_media_contactlist_operation import RetailMediaContactlistOperation +from criteo_api_retailmedia_preview.model.retail_media_contactlist_operation_response_attributes import RetailMediaContactlistOperationResponseAttributes +from criteo_api_retailmedia_preview.model.retail_media_contactlist_operation_response_attributes_attributes import RetailMediaContactlistOperationResponseAttributesAttributes 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.review_state_model import ReviewStateModel from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1 import RmLegacyAudienceGetEntityV1 from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1_resource import RmLegacyAudienceGetEntityV1Resource @@ -159,8 +188,13 @@ 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.rmca_common_problem import RmcaCommonProblem 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.set_bid_model import SetBidModel +from criteo_api_retailmedia_preview.model.set_bids_model import SetBidsModel +from criteo_api_retailmedia_preview.model.set_bids_model_request import SetBidsModelRequest +from criteo_api_retailmedia_preview.model.set_bids_model_resource import SetBidsModelResource from criteo_api_retailmedia_preview.model.sku_data_preview import SkuDataPreview from criteo_api_retailmedia_preview.model.sku_data_preview_list_response import SkuDataPreviewListResponse from criteo_api_retailmedia_preview.model.sku_search_request import SkuSearchRequest diff --git a/sdks/retailmedia_preview/docs/AddRemoveKeywordModel.md b/sdks/retailmedia_preview/docs/AddRemoveKeywordModel.md new file mode 100644 index 00000000..8546f1f2 --- /dev/null +++ b/sdks/retailmedia_preview/docs/AddRemoveKeywordModel.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordModel + +A single keyword to be added or removed + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**is_deleted** | **bool, 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/AddRemoveKeywordsModel.md b/sdks/retailmedia_preview/docs/AddRemoveKeywordsModel.md new file mode 100644 index 00000000..27980d2b --- /dev/null +++ b/sdks/retailmedia_preview/docs/AddRemoveKeywordsModel.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModel + +Data model containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[AddRemoveKeywordModel], none_type**](AddRemoveKeywordModel.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/AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_preview/docs/AddRemoveKeywordsModelRequest.md new file mode 100644 index 00000000..577c720e --- /dev/null +++ b/sdks/retailmedia_preview/docs/AddRemoveKeywordsModelRequest.md @@ -0,0 +1,12 @@ +# AddRemoveKeywordsModelRequest + +Request object to add or remove keywords from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AddRemoveKeywordsModelResource**](AddRemoveKeywordsModelResource.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/AddRemoveKeywordsModelResource.md b/sdks/retailmedia_preview/docs/AddRemoveKeywordsModelResource.md new file mode 100644 index 00000000..ad36e151 --- /dev/null +++ b/sdks/retailmedia_preview/docs/AddRemoveKeywordsModelResource.md @@ -0,0 +1,14 @@ +# AddRemoveKeywordsModelResource + +Resource object containing keywords to be added or removed from a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**AddRemoveKeywordsModel**](AddRemoveKeywordsModel.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/AnalyticsApi.md b/sdks/retailmedia_preview/docs/AnalyticsApi.md index dce83c97..debf6c91 100644 --- a/sdks/retailmedia_preview/docs/AnalyticsApi.md +++ b/sdks/retailmedia_preview/docs/AnalyticsApi.md @@ -68,11 +68,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: account_ids=[ "account_ids_example", ], - report_type="summary", aggregation_level="campaign", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", + report_type="summary", click_attribution_window="none", view_attribution_window="none", dimensions=[ @@ -182,8 +182,8 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", @@ -295,8 +295,8 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: "ids_example", ], id="id_example", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", format="json-compact", report_type="summary", click_attribution_window="none", @@ -413,10 +413,10 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: account_id="account_id_example", click_attribution_window="none", view_attribution_window="none", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", dimensions=[ - "campaignName", + "purchasedDate", ], metrics=[ "attributedUnits", @@ -525,8 +525,8 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: account_id="account_id_example", click_attribution_window="none", view_attribution_window="none", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", dimensions=[ "date", ], @@ -640,8 +640,8 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: account_id="account_id_example", click_attribution_window="none", view_attribution_window="none", - campaign_type="sponsoredProducts", - sales_channel="offline", + campaign_type="all", + sales_channel="all", dimensions=[ "date", ], diff --git a/sdks/retailmedia_preview/docs/ApprovalStatusModel.md b/sdks/retailmedia_preview/docs/ApprovalStatusModel.md new file mode 100644 index 00000000..52ab7863 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ApprovalStatusModel.md @@ -0,0 +1,12 @@ +# ApprovalStatusModel + +The status of a booking or runnable in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of a booking or runnable in the context of a line item. | must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ] + +[[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/AsyncAccountsReport.md b/sdks/retailmedia_preview/docs/AsyncAccountsReport.md index 309cb4fc..1fb9bb48 100644 --- a/sdks/retailmedia_preview/docs/AsyncAccountsReport.md +++ b/sdks/retailmedia_preview/docs/AsyncAccountsReport.md @@ -8,11 +8,11 @@ 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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" **dimensions** | **[str], none_type** | List of dimensions to report on | [optional] diff --git a/sdks/retailmedia_preview/docs/AsyncCampaignsReport.md b/sdks/retailmedia_preview/docs/AsyncCampaignsReport.md index 21dd57bd..f4385127 100644 --- a/sdks/retailmedia_preview/docs/AsyncCampaignsReport.md +++ b/sdks/retailmedia_preview/docs/AsyncCampaignsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **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] -**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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_preview/docs/AsyncLineItemsReport.md b/sdks/retailmedia_preview/docs/AsyncLineItemsReport.md index ccb01090..eece64e3 100644 --- a/sdks/retailmedia_preview/docs/AsyncLineItemsReport.md +++ b/sdks/retailmedia_preview/docs/AsyncLineItemsReport.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **end_date** | **datetime** | End date | **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_preview/docs/AudienceApi.md b/sdks/retailmedia_preview/docs/AudienceApi.md index 5ca8fe17..b28e005b 100644 --- a/sdks/retailmedia_preview/docs/AudienceApi.md +++ b/sdks/retailmedia_preview/docs/AudienceApi.md @@ -4,10 +4,96 @@ All URIs are relative to *https://api.criteo.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**delete_contact_list_identifiers**](AudienceApi.md#delete_contact_list_identifiers) | **POST** /preview/retail-media/audience-segments/{audience-segment-id}/contact-list/clear | [**legacy_get_audience_v1**](AudienceApi.md#legacy_get_audience_v1) | **GET** /preview/retail-media/accounts/{accountId}/audiences | [**legacy_get_audience_v2**](AudienceApi.md#legacy_get_audience_v2) | **GET** /preview/retail-media/v2/accounts/{accountId}/audiences | +[**update_contact_list_identifiers**](AudienceApi.md#update_contact_list_identifiers) | **POST** /preview/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove | +# **delete_contact_list_identifiers** +> delete_contact_list_identifiers(audience_segment_id) + + + +Delete all identifiers from a retail-media contact list audience-segment, with external audience segment id. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_preview +from criteo_api_retailmedia_preview.api import audience_api +from criteo_api_retailmedia_preview.model.error_code_response import ErrorCodeResponse +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 = audience_api.AudienceApi(api_client) + audience_segment_id = 1 # int | The id of the contact list audience-segment to amend, we only accept external Id here + + # example passing only required values which don't have defaults set + try: + api_instance.delete_contact_list_identifiers(audience_segment_id) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling AudienceApi->delete_contact_list_identifiers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_id** | **int**| The id of the contact list audience-segment to amend, we only accept external Id here | + +### Return type + +void (empty response body) + +### 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 | +|-------------|-------------|------------------| +**204** | The Contact List identifiers were deleted | - | +**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) + # **legacy_get_audience_v1** > RmLegacyAudienceGetEntityV1ListResponse legacy_get_audience_v1(account_id) @@ -214,3 +300,103 @@ 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) +# **update_contact_list_identifiers** +> RetailMediaContactlistOperation update_contact_list_identifiers(audience_segment_id, retail_media_contactlist_amendment_request) + + + +Add/remove identifiers to or from a retail-media contact list audience-segment, with external audience segment id. + +### Example + +* OAuth Authentication (oauth): +* OAuth Authentication (oauth): + +```python +import time +import criteo_api_retailmedia_preview +from criteo_api_retailmedia_preview.api import audience_api +from criteo_api_retailmedia_preview.model.retail_media_contactlist_amendment_request import RetailMediaContactlistAmendmentRequest +from criteo_api_retailmedia_preview.model.retail_media_contactlist_operation import RetailMediaContactlistOperation +from criteo_api_retailmedia_preview.model.error_code_response import ErrorCodeResponse +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 = audience_api.AudienceApi(api_client) + audience_segment_id = 1 # int | The id of the contact list audience-segment to amend, we only accept external Id here + retail_media_contactlist_amendment_request = RetailMediaContactlistAmendmentRequest( + data=RetailMediaContactlistAmendment( + type="AddRemoveContactlist", + attributes=RetailMediaContactlistAmendmentAttributes( + operation="add", + identifier_type="email", + identifiers=[ + "identifiers_example", + ], + ), + ), + ) # RetailMediaContactlistAmendmentRequest | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.update_contact_list_identifiers(audience_segment_id, retail_media_contactlist_amendment_request) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling AudienceApi->update_contact_list_identifiers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **audience_segment_id** | **int**| The id of the contact list audience-segment to amend, we only accept external Id here | + **retail_media_contactlist_amendment_request** | [**RetailMediaContactlistAmendmentRequest**](RetailMediaContactlistAmendmentRequest.md)| | + +### Return type + +[**RetailMediaContactlistOperation**](RetailMediaContactlistOperation.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** | Summary of created 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) + diff --git a/sdks/retailmedia_preview/docs/AudienceError.md b/sdks/retailmedia_preview/docs/AudienceError.md new file mode 100644 index 00000000..a395df9a --- /dev/null +++ b/sdks/retailmedia_preview/docs/AudienceError.md @@ -0,0 +1,20 @@ +# AudienceError + +Definition of an audience error + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | (REQUIRED) The classification of the error | +**code** | **str** | (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. | +**instance** | **str** | (REQUIRED) A URI reference that identifies the specific occurrence of the problem | +**trace_id** | **str, none_type** | (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem. | [optional] +**title** | **str, none_type** | (RECOMMENDED) A short, human-readable summary of the problem type | [optional] +**detail** | **str, none_type** | (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem | [optional] +**source** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s) | [optional] +**stack_trace** | **[str], none_type** | (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology | [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/AudienceWarning.md b/sdks/retailmedia_preview/docs/AudienceWarning.md new file mode 100644 index 00000000..3272f2e8 --- /dev/null +++ b/sdks/retailmedia_preview/docs/AudienceWarning.md @@ -0,0 +1,20 @@ +# AudienceWarning + +Definition of the warning + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | (REQUIRED) The classification of the error | +**code** | **str** | (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case. | +**instance** | **str** | (REQUIRED) A URI reference that identifies the specific occurrence of the problem | +**detail** | **str** | (REQUIRED) A human-readable explanation specific to this occurrence of the problem | +**trace_id** | **str, none_type** | (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem. | [optional] +**title** | **str, none_type** | (RECOMMENDED) A short, human-readable summary of the problem type | [optional] +**source** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s) | [optional] +**stack_trace** | **[str], none_type** | (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology | [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/CampaignApi.md b/sdks/retailmedia_preview/docs/CampaignApi.md index b855b119..758653ec 100644 --- a/sdks/retailmedia_preview/docs/CampaignApi.md +++ b/sdks/retailmedia_preview/docs/CampaignApi.md @@ -5,12 +5,14 @@ All URIs are relative to *https://api.criteo.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**add_remove_keywords**](CampaignApi.md#add_remove_keywords) | **POST** /preview/retail-media/line-items/{id}/keywords/add-remove | +[**append_promoted_products**](CampaignApi.md#append_promoted_products) | **POST** /preview/retail-media/line-items/{lineItemId}/products/append | [**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} | +[**delete_promoted_products**](CampaignApi.md#delete_promoted_products) | **POST** /preview/retail-media/line-items/{lineItemId}/products/delete | [**fetch_keywords**](CampaignApi.md#fetch_keywords) | **GET** /preview/retail-media/line-items/{id}/keywords | +[**fetch_promoted_products**](CampaignApi.md#fetch_promoted_products) | **GET** /preview/retail-media/line-items/{lineItemId}/products | [**fetch_proposal**](CampaignApi.md#fetch_proposal) | **GET** /preview/retail-media/preferred-deal-line-items/{id}/proposal | [**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_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 | @@ -18,34 +20,41 @@ 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_account_by_account_id_creativescreative_id**](CampaignApi.md#get_api_v2_external_account_by_account_id_creativescreative_id) | **GET** /preview/retail-media/accounts/{account-id}/creatives/{creative-id} | [**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_line_item_bid_multipliers_by_line_item_id**](CampaignApi.md#get_api_v2_external_line_item_bid_multipliers_by_line_item_id) | **GET** /preview/retail-media/line-items/{line-item-id}/bid-multipliers | [**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 | +[**pause_promoted_products**](CampaignApi.md#pause_promoted_products) | **POST** /preview/retail-media/line-items/{lineItemId}/products/pause | [**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_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} | +[**post_api_v2_external_account_creatives_by_account_id**](CampaignApi.md#post_api_v2_external_account_creatives_by_account_id) | **POST** /preview/retail-media/accounts/{account-id}/creatives | +[**post_api_v2_external_account_creatives_search_by_account_id**](CampaignApi.md#post_api_v2_external_account_creatives_search_by_account_id) | **POST** /preview/retail-media/accounts/{account-id}/creatives/search | [**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 | +[**put_api_v2_external_account_by_account_id_creativescreative_id**](CampaignApi.md#put_api_v2_external_account_by_account_id_creativescreative_id) | **PUT** /preview/retail-media/accounts/{account-id}/creatives/{creative-id} | +[**put_api_v2_external_line_item_bid_multipliers_by_line_item_id**](CampaignApi.md#put_api_v2_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 | [**submit_proposal**](CampaignApi.md#submit_proposal) | **POST** /preview/retail-media/preferred-deal-line-items/{id}/proposal/submit | +[**unpause_promoted_products**](CampaignApi.md#unpause_promoted_products) | **POST** /preview/retail-media/line-items/{lineItemId}/products/unpause | [**update_campaign_budget_overrides**](CampaignApi.md#update_campaign_budget_overrides) | **PUT** /preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides | [**update_line_item_budget_overrides**](CampaignApi.md#update_line_item_budget_overrides) | **PUT** /preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides | # **add_remove_keywords** -> RetailMediaExternalv1ResourceOutcome add_remove_keywords(id) +> ResourceOutcome add_remove_keywords(id) -Add or Remove keywords from the associated line item in bulk +Add or Remove keywords from the line item in bulk ### Example @@ -56,8 +65,8 @@ Add or Remove keywords from the associated line item in bulk import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_preview.model.retail_media_externalv1_add_remove_keywords_model_request import RetailMediaExternalv1AddRemoveKeywordsModelRequest +from criteo_api_retailmedia_preview.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_preview.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest 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. @@ -86,22 +95,22 @@ 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) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_add_remove_keywords_model_request = RetailMediaExternalv1AddRemoveKeywordsModelRequest( - data=RetailMediaExternalv1AddRemoveKeywordsModelResource( + id = "id_example" # str | ID of the line item + add_remove_keywords_model_request = AddRemoveKeywordsModelRequest( + data=AddRemoveKeywordsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1AddRemoveKeywordsModel( + attributes=AddRemoveKeywordsModel( keywords=[ - RetailMediaExternalv1AddRemoveKeywordModel( + AddRemoveKeywordModel( phrase="phrase_example", - match_type="PositiveExactMatch", + match_type=MatchTypeModel("PositiveExactMatch"), is_deleted=True, ), ], ), ), - ) # RetailMediaExternalv1AddRemoveKeywordsModelRequest | Object containing keywords to be added or removed (optional) + ) # AddRemoveKeywordsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -113,7 +122,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.add_remove_keywords(id, retail_media_externalv1_add_remove_keywords_model_request=retail_media_externalv1_add_remove_keywords_model_request) + api_response = api_instance.add_remove_keywords(id, add_remove_keywords_model_request=add_remove_keywords_model_request) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: print("Exception when calling CampaignApi->add_remove_keywords: %s\n" % e) @@ -124,12 +133,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_add_remove_keywords_model_request** | [**RetailMediaExternalv1AddRemoveKeywordsModelRequest**](RetailMediaExternalv1AddRemoveKeywordsModelRequest.md)| Object containing keywords to be added or removed | [optional] + **id** | **str**| ID of the line item | + **add_remove_keywords_model_request** | [**AddRemoveKeywordsModelRequest**](AddRemoveKeywordsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -138,7 +147,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -150,6 +159,113 @@ 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) +# **append_promoted_products** +> append_promoted_products(line_item_id) + + + +Append a collection of promoted products to a line item + +### 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.product_resource_outcome import ProductResourceOutcome +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput +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) + line_item_id = "lineItemId_example" # str | ID of the line item + promoted_product_resource_collection_input = PromotedProductResourceCollectionInput( + data=[ + PromotedProductResource( + id="id_example", + type="type_example", + attributes=PromotedProduct( + id="id_example", + bid_override=3.14, + status=LineItemProductStatus("Unknown"), + ), + ), + ], + ) # PromotedProductResourceCollectionInput | Request body whose {data} contains an array of promoted products. (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.append_promoted_products(line_item_id) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->append_promoted_products: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.append_promoted_products(line_item_id, promoted_product_resource_collection_input=promoted_product_resource_collection_input) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->append_promoted_products: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| ID of the line item | + **promoted_product_resource_collection_input** | [**PromotedProductResourceCollectionInput**](PromotedProductResourceCollectionInput.md)| Request body whose {data} contains an array of promoted products. | [optional] + +### Return type + +void (empty response body) + +### 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 | +|-------------|-------------|------------------| +**204** | Promoted products appended to the line item | - | +**400** | Invalid request body | - | +**403** | Invalid external line item ID | - | + +[[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) + # **delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id** > delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id) @@ -234,8 +350,115 @@ 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) +# **delete_promoted_products** +> delete_promoted_products(line_item_id) + + + +Remove a collection of promoted products from a line item + +### 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.product_resource_outcome import ProductResourceOutcome +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput +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) + line_item_id = "lineItemId_example" # str | ID of the line item + promoted_product_resource_collection_input = PromotedProductResourceCollectionInput( + data=[ + PromotedProductResource( + id="id_example", + type="type_example", + attributes=PromotedProduct( + id="id_example", + bid_override=3.14, + status=LineItemProductStatus("Unknown"), + ), + ), + ], + ) # PromotedProductResourceCollectionInput | Request body whose {data} contains an array of promoted products. (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.delete_promoted_products(line_item_id) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->delete_promoted_products: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.delete_promoted_products(line_item_id, promoted_product_resource_collection_input=promoted_product_resource_collection_input) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->delete_promoted_products: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| ID of the line item | + **promoted_product_resource_collection_input** | [**PromotedProductResourceCollectionInput**](PromotedProductResourceCollectionInput.md)| Request body whose {data} contains an array of promoted products. | [optional] + +### Return type + +void (empty response body) + +### 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 | +|-------------|-------------|------------------| +**204** | Promoted products removed from the line item | - | +**400** | Invalid request body | - | +**403** | Invalid external line item ID | - | + +[[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) + # **fetch_keywords** -> RetailMediaExternalv1KeywordsModelResponse fetch_keywords(id) +> KeywordsModelResponse fetch_keywords(id) @@ -250,7 +473,8 @@ Fetch keywords associated with the specified line item import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse +from criteo_api_retailmedia_preview.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_preview.model.keywords_model_response import KeywordsModelResponse 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. @@ -279,7 +503,7 @@ 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) - id = "id_example" # str | Long external id of the associated line item + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -294,11 +518,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1KeywordsModelResponse**](RetailMediaExternalv1KeywordsModelResponse.md) +[**KeywordsModelResponse**](KeywordsModelResponse.md) ### Authorization @@ -307,7 +531,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 @@ -319,12 +543,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) -# **fetch_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse fetch_proposal(id) +# **fetch_promoted_products** +> PromotedProductResourceCollectionOutcome fetch_promoted_products(line_item_id) -Fetch the status of a proposal to modify a Preferred Deal Line Item. +Retrieve a page of promoted products for a line item ### Example @@ -335,7 +559,8 @@ Fetch the status of a proposal to modify a Preferred Deal Line Item. import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_outcome import PromotedProductResourceCollectionOutcome +from criteo_api_retailmedia_preview.model.product_resource_outcome import ProductResourceOutcome 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. @@ -364,14 +589,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) - id = "id_example" # str | The external id of a line item. + line_item_id = "lineItemId_example" # str | ID of the line item. + offset = 1 # int | Offset of the first item to fetch. Defaults to zero. (optional) + limit = 1 # int | Maximum page size to fetch. Defaults to 500. (optional) + fields = "fields_example" # str | A comma separated list of attribute names from the response model to compute and return. Valid values are `status` and `bidOverride` in any order. Defaults to `status`. (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.fetch_proposal(id) + api_response = api_instance.fetch_promoted_products(line_item_id) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->fetch_proposal: %s\n" % e) + print("Exception when calling CampaignApi->fetch_promoted_products: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.fetch_promoted_products(line_item_id, offset=offset, limit=limit, fields=fields) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->fetch_promoted_products: %s\n" % e) ``` @@ -379,11 +615,14 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **line_item_id** | **str**| ID of the line item. | + **offset** | **int**| Offset of the first item to fetch. Defaults to zero. | [optional] + **limit** | **int**| Maximum page size to fetch. Defaults to 500. | [optional] + **fields** | **str**| A comma separated list of attribute names from the response model to compute and return. Valid values are `status` and `bidOverride` in any order. Defaults to `status`. | [optional] ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**PromotedProductResourceCollectionOutcome**](PromotedProductResourceCollectionOutcome.md) ### Authorization @@ -392,26 +631,24 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | -**400** | Bad Request | - | -**500** | Server Error | - | -**403** | Forbidden | - | +**200** | Promoted products associated with the line item | - | +**403** | Invalid external line item ID | - | [[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) +# **fetch_proposal** +> ProposalStatusModelResponse fetch_proposal(id) -Get all the product buttons associated with a line item +Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. ### Example @@ -422,7 +659,8 @@ 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.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_preview.model.resource_outcome import ResourceOutcome 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. @@ -451,14 +689,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) - line_item_id = "line-item-id_example" # str | Long external id of the associated line item + id = "id_example" # str | ID of the line item # 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.fetch_proposal(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->fetch_proposal: %s\n" % e) ``` @@ -466,11 +704,11 @@ 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 | + **id** | **str**| ID of the line item | ### Return type -[**ProductButtonListResponse**](ProductButtonListResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -487,15 +725,17 @@ Name | Type | Description | Notes | 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) -# **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_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 a single product button +Get all the product buttons associated with a line item ### Example @@ -536,14 +776,13 @@ 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 # 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_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_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api202210_external_line_item_product_buttons_by_line_item_id: %s\n" % e) ``` @@ -552,7 +791,6 @@ 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 | ### Return type @@ -576,12 +814,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_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 bid multipliers by line item +Get a single product button ### Example @@ -592,7 +830,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.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. @@ -622,13 +860,14 @@ 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 # example passing only required values which don't have defaults set try: - api_response = api_instance.get_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_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_api202301_external_line_item_bid_multipliers_by_line_item_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) ``` @@ -637,10 +876,11 @@ 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 | ### Return type -[**JsonApiSingleResponseOfLineItemBidMultipliers**](JsonApiSingleResponseOfLineItemBidMultipliers.md) +[**ProductButtonListResponse**](ProductButtonListResponse.md) ### Authorization @@ -649,7 +889,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 @@ -1315,12 +1555,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_v2_external_campaign_preferred_line_items_by_campaign_id** -> PreferredLineItemV2PagedListResponse get_api_v2_external_campaign_preferred_line_items_by_campaign_id(campaign_id) +# **get_api_v2_external_account_by_account_id_creativescreative_id** +> CreativeV2Response get_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id) -Gets page of preferred line item objects for the given campaign id +Get the specified creative ### Example @@ -1331,7 +1571,7 @@ Gets page of preferred line item objects for the given campaign id import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.preferred_line_item_v2_paged_list_response import PreferredLineItemV2PagedListResponse +from criteo_api_retailmedia_preview.model.creative_v2_response import CreativeV2Response 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. @@ -1360,27 +1600,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) - 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_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_v2_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) + account_id = "account-id_example" # str | External account id to retrieve creatives for + creative_id = "creative-id_example" # str | Creative to get # example passing only required values which don't have defaults set - # and optional values try: - 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) + api_response = api_instance.get_api_v2_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->get_api_v2_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) + print("Exception when calling CampaignApi->get_api_v2_external_account_by_account_id_creativescreative_id: %s\n" % e) ``` @@ -1388,14 +1616,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **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] + **account_id** | **str**| External account id to retrieve creatives for | + **creative_id** | **str**| Creative to get | ### Return type -[**PreferredLineItemV2PagedListResponse**](PreferredLineItemV2PagedListResponse.md) +[**CreativeV2Response**](CreativeV2Response.md) ### Authorization @@ -1404,20 +1630,204 @@ 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** | Success | - | -**400** | Bad Request | - | +**200** | Creatives 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_v2_external_preferred_line_item_by_line_item_id** -> PreferredLineItemV2Response get_api_v2_external_preferred_line_item_by_line_item_id(line_item_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 page of preferred line item objects for the given campaign id + +### 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.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. +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) + 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_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_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_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_v2_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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 + +[**PreferredLineItemV2PagedListResponse**](PreferredLineItemV2PagedListResponse.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** | 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_v2_external_line_item_bid_multipliers_by_line_item_id** +> JsonApiSingleResponseOfLineItemBidMultipliersV2 get_api_v2_external_line_item_bid_multipliers_by_line_item_id(line_item_id) + + + +Fetch all bid multipliers for a given line item + +### 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_line_item_bid_multipliers_v2 import JsonApiSingleResponseOfLineItemBidMultipliersV2 +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) + line_item_id = "line-item-id_example" # str | External LineItemId for bid multiplier retrieval + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_api_v2_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_api_v2_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| External LineItemId for bid multiplier retrieval | + +### Return type + +[**JsonApiSingleResponseOfLineItemBidMultipliersV2**](JsonApiSingleResponseOfLineItemBidMultipliersV2.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | BidMultipliers 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_v2_external_preferred_line_item_by_line_item_id** +> PreferredLineItemV2Response get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id) @@ -1959,12 +2369,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_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) +# **pause_promoted_products** +> pause_promoted_products(line_item_id) -Creates a new preferred line item with the specified settings +Pause a collection of promoted products associated with a line item ### Example @@ -1975,8 +2385,8 @@ Creates a new preferred line item with the specified settings import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -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 criteo_api_retailmedia_preview.model.product_resource_outcome import ProductResourceOutcome +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput 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. @@ -2005,45 +2415,33 @@ 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 = "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, - ), - page=ExternalLineItemPageV2( - page_type="unknown", - categories=[ - ExternalLineItemPageCategoryV2( - category_id="category_id_example", - include_children=True, - ), - ], - search_keywords=[ - "search_keywords_example", - ], + line_item_id = "lineItemId_example" # str | ID of the line item + promoted_product_resource_collection_input = PromotedProductResourceCollectionInput( + data=[ + PromotedProductResource( + id="id_example", + type="type_example", + attributes=PromotedProduct( + id="id_example", + bid_override=3.14, + status=LineItemProductStatus("Unknown"), ), - target_retailer_id="target_retailer_id_example", - budget=3.14, - creative_id="creative_id_example", ), - ), - ) # PreferredLineItemCreateModelV2Request | The line item settings to create a line item with + ], + ) # PromotedProductResourceCollectionInput | Request body whose {data} contains an array of promoted products. (optional) # example passing only required values which don't have defaults set try: - 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) + api_instance.pause_promoted_products(line_item_id) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->post_api202110_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) + print("Exception when calling CampaignApi->pause_promoted_products: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.pause_promoted_products(line_item_id, promoted_product_resource_collection_input=promoted_product_resource_collection_input) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->pause_promoted_products: %s\n" % e) ``` @@ -2051,12 +2449,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **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 | + **line_item_id** | **str**| ID of the line item | + **promoted_product_resource_collection_input** | [**PromotedProductResourceCollectionInput**](PromotedProductResourceCollectionInput.md)| Request body whose {data} contains an array of promoted products. | [optional] ### Return type -[**PreferredLineItemV2Response**](PreferredLineItemV2Response.md) +void (empty response body) ### Authorization @@ -2072,17 +2470,18 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Success | - | -**400** | Bad Request | - | +**204** | Promoted products paused | - | +**400** | Invalid request body | - | +**403** | Invalid external line item ID | - | [[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_line_item_product_buttons_create_by_line_item_id** -> ProductButtonListResponse post_api202210_external_line_item_product_buttons_create_by_line_item_id(line_item_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) -Append new product buttons to a line item +Creates a new preferred line item with the specified settings ### Example @@ -2093,8 +2492,8 @@ Append new product buttons to 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.product_button_list_request import ProductButtonListRequest +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. @@ -2123,22 +2522,140 @@ 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_list_request = ProductButtonListRequest( - data=[ - ResourceOfProductButtonRequest( - attributes=ExternalProductButtonRequest( - name="name_example", - background_image="background_image_example", - is_mandatory=1, - skus=[ - "skus_example", - ], - ), - id="id_example", - type="type_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, + ), + page=ExternalLineItemPageV2( + page_type="unknown", + categories=[ + ExternalLineItemPageCategoryV2( + category_id="category_id_example", + include_children=True, + ), + ], + search_keywords=[ + "search_keywords_example", + ], + ), + target_retailer_id="target_retailer_id_example", + budget=3.14, + creative_id="creative_id_example", + ), + ), + ) # PreferredLineItemCreateModelV2Request | The line item settings to create a line item with + + # example passing only required values which don't have defaults set + try: + 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_api202110_external_campaign_preferred_line_items_by_campaign_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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 + +[**PreferredLineItemV2Response**](PreferredLineItemV2Response.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 | +|-------------|-------------|------------------| +**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) + +# **post_api202210_external_line_item_product_buttons_create_by_line_item_id** +> ProductButtonListResponse post_api202210_external_line_item_product_buttons_create_by_line_item_id(line_item_id) + + + +Append new product buttons to a line item + +### 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.product_button_list_response import ProductButtonListResponse +from criteo_api_retailmedia_preview.model.product_button_list_request import ProductButtonListRequest +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) + line_item_id = "line-item-id_example" # str | Long external id of the associated line item + product_button_list_request = ProductButtonListRequest( + data=[ + ResourceOfProductButtonRequest( + attributes=ExternalProductButtonRequest( + name="name_example", + background_image="background_image_example", + is_mandatory=1, + skus=[ + "skus_example", + ], + ), + id="id_example", + type="type_example", + ), + ], ) # ProductButtonListRequest | List of product buttons to append to the specified line item (optional) # example passing only required values which don't have defaults set @@ -2612,6 +3129,232 @@ 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_v2_external_account_creatives_by_account_id** +> CreativeV2Response post_api_v2_external_account_creatives_by_account_id(account_id) + + + +Create a creative for an 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.external_creative_create_model_v2 import ExternalCreativeCreateModelV2 +from criteo_api_retailmedia_preview.model.creative_v2_response import CreativeV2Response +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 create a creative for + external_creative_create_model_v2 = ExternalCreativeCreateModelV2( + name="name_example", + brand_id=1, + retailer_id=1, + template_id=1, + template_variable_values=[ + ExternalTemplateVariableValue( + id="id_example", + text_variable_value=ExternalTextVariableValue( + text="text_example", + ), + choice_variable_value=ExternalChoiceVariableValue( + chosen_options=[ + "chosen_options_example", + ], + ), + color_variable_value=ExternalColorVariableValue( + color="#2EC", + ), + files_variable_value=ExternalFilesVariableValue( + asset_ids=[ + "asset_ids_example", + ], + ), + hyperlink_variable_value=ExternalHyperlinkVariableValue( + url="url_example", + ), + video_variable_value=ExternalVideoVariableValue( + url="url_example", + width=1, + height=1, + duration="duration_example", + ), + ), + ], + ) # ExternalCreativeCreateModelV2 | The creative to create (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.post_api_v2_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_api_v2_external_account_creatives_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_v2_external_account_creatives_by_account_id(account_id, external_creative_create_model_v2=external_creative_create_model_v2) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->post_api_v2_external_account_creatives_by_account_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| External account id to create a creative for | + **external_creative_create_model_v2** | [**ExternalCreativeCreateModelV2**](ExternalCreativeCreateModelV2.md)| The creative to create | [optional] + +### Return type + +[**CreativeV2Response**](CreativeV2Response.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| 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_api_v2_external_account_creatives_search_by_account_id** +> CreativeV2ListResponse post_api_v2_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.creative_v2_list_response import CreativeV2ListResponse +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_api_v2_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_api_v2_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_api_v2_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_api_v2_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 + +[**CreativeV2ListResponse**](CreativeV2ListResponse.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Creatives 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) + # **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) @@ -2840,12 +3583,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_api202301_external_line_item_bid_multipliers_by_line_item_id** -> LineItemBidMultipliersResponse put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) +# **put_api_v2_external_account_by_account_id_creativescreative_id** +> CreativeV2Response put_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id) -Replace bid multipliers on a line item +Update a creative ### Example @@ -2856,8 +3599,8 @@ Replace bid multipliers on 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.line_item_bid_multipliers_response import LineItemBidMultipliersResponse -from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest +from criteo_api_retailmedia_preview.model.external_creative_update_model_v2 import ExternalCreativeUpdateModelV2 +from criteo_api_retailmedia_preview.model.creative_v2_response import CreativeV2Response 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. @@ -2886,38 +3629,174 @@ 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 - line_item_bid_multipliers_request = LineItemBidMultipliersRequest( - data=ResourceOfLineItemBidMultipliers( - attributes=LineItemBidMultipliers( + account_id = "account-id_example" # str | External account id containing the creative + creative_id = "creative-id_example" # str | Creative to update + external_creative_update_model_v2 = ExternalCreativeUpdateModelV2( + name="name_example", + brand_id=1, + retailer_id=1, + template_id=1, + template_variable_values=[ + ExternalTemplateVariableValue( + id="id_example", + text_variable_value=ExternalTextVariableValue( + text="text_example", + ), + choice_variable_value=ExternalChoiceVariableValue( + chosen_options=[ + "chosen_options_example", + ], + ), + color_variable_value=ExternalColorVariableValue( + color="#2EC", + ), + files_variable_value=ExternalFilesVariableValue( + asset_ids=[ + "asset_ids_example", + ], + ), + hyperlink_variable_value=ExternalHyperlinkVariableValue( + url="url_example", + ), + video_variable_value=ExternalVideoVariableValue( + url="url_example", + width=1, + height=1, + duration="duration_example", + ), + ), + ], + ) # ExternalCreativeUpdateModelV2 | The creative to create (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.put_api_v2_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_api_v2_external_account_by_account_id_creativescreative_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.put_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, external_creative_update_model_v2=external_creative_update_model_v2) + pprint(api_response) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->put_api_v2_external_account_by_account_id_creativescreative_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| External account id containing the creative | + **creative_id** | **str**| Creative to update | + **external_creative_update_model_v2** | [**ExternalCreativeUpdateModelV2**](ExternalCreativeUpdateModelV2.md)| The creative to create | [optional] + +### Return type + +[**CreativeV2Response**](CreativeV2Response.md) + +### Authorization + +[oauth](../README.md#oauth), [oauth](../README.md#oauth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**204** | Creative updated | - | + +[[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_api_v2_external_line_item_bid_multipliers_by_line_item_id** +> LineItemBidMultipliersV2Response put_api_v2_external_line_item_bid_multipliers_by_line_item_id(line_item_id) + + + +Updates the bid multipliers for a given line item + +### 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.line_item_bid_multipliers_v2_response import LineItemBidMultipliersV2Response +from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_v2_request import LineItemBidMultipliersV2Request +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) + line_item_id = "line-item-id_example" # str | External LineItemId for bid multiplier retrieval + line_item_bid_multipliers_v2_request = LineItemBidMultipliersV2Request( + data=ResourceOfLineItemBidMultipliersV2( + attributes=ExternalLineItemBidMultipliersV2( search=3.14, - homepage=3.14, - categories=3.14, + home=3.14, + category=3.14, product_detail=3.14, confirmation=3.14, merchandising=3.14, deals=3.14, checkout=3.14, + favorites=3.14, + search_bar=3.14, + category_menu=3.14, ), id="id_example", type="type_example", ), - ) # LineItemBidMultipliersRequest | (optional) + ) # LineItemBidMultipliersV2Request | New Bid Multipliers to be set (optional) # example passing only required values which don't have defaults set try: - api_response = api_instance.put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id) + api_response = api_instance.put_api_v2_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->put_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) + print("Exception when calling CampaignApi->put_api_v2_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.put_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id, line_item_bid_multipliers_request=line_item_bid_multipliers_request) + api_response = api_instance.put_api_v2_external_line_item_bid_multipliers_by_line_item_id(line_item_id, line_item_bid_multipliers_v2_request=line_item_bid_multipliers_v2_request) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: - print("Exception when calling CampaignApi->put_api202301_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) + print("Exception when calling CampaignApi->put_api_v2_external_line_item_bid_multipliers_by_line_item_id: %s\n" % e) ``` @@ -2925,12 +3804,12 @@ 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 | - **line_item_bid_multipliers_request** | [**LineItemBidMultipliersRequest**](LineItemBidMultipliersRequest.md)| | [optional] + **line_item_id** | **str**| External LineItemId for bid multiplier retrieval | + **line_item_bid_multipliers_v2_request** | [**LineItemBidMultipliersV2Request**](LineItemBidMultipliersV2Request.md)| New Bid Multipliers to be set | [optional] ### Return type -[**LineItemBidMultipliersResponse**](LineItemBidMultipliersResponse.md) +[**LineItemBidMultipliersV2Response**](LineItemBidMultipliersV2Response.md) ### Authorization @@ -2946,12 +3825,12 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | BidMultipliers Updated | - | [[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) # **set_keyword_bids** -> RetailMediaExternalv1ResourceOutcome set_keyword_bids(id) +> ResourceOutcome set_keyword_bids(id) @@ -2966,8 +3845,8 @@ Set bid overrides for associated keywords to the given line item in bulk import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome -from criteo_api_retailmedia_preview.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest +from criteo_api_retailmedia_preview.model.resource_outcome import ResourceOutcome +from criteo_api_retailmedia_preview.model.set_bids_model_request import SetBidsModelRequest 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. @@ -2996,21 +3875,21 @@ 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) - id = "id_example" # str | Long external id of the associated line item - retail_media_externalv1_set_bids_model_request = RetailMediaExternalv1SetBidsModelRequest( - data=RetailMediaExternalv1SetBidsModelResource( + id = "id_example" # str | ID of the line item + set_bids_model_request = SetBidsModelRequest( + data=SetBidsModelResource( id="id_example", type="type_example", - attributes=RetailMediaExternalv1SetBidsModel( + attributes=SetBidsModel( keywords=[ - RetailMediaExternalv1SetBidModel( + SetBidModel( phrase="phrase_example", bid=3.14, ), ], ), ), - ) # RetailMediaExternalv1SetBidsModelRequest | Object containing a list of bid overrides for associated keywords (optional) + ) # SetBidsModelRequest | (optional) # example passing only required values which don't have defaults set try: @@ -3022,7 +3901,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.set_keyword_bids(id, retail_media_externalv1_set_bids_model_request=retail_media_externalv1_set_bids_model_request) + api_response = api_instance.set_keyword_bids(id, set_bids_model_request=set_bids_model_request) pprint(api_response) except criteo_api_retailmedia_preview.ApiException as e: print("Exception when calling CampaignApi->set_keyword_bids: %s\n" % e) @@ -3033,12 +3912,12 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Long external id of the associated line item | - **retail_media_externalv1_set_bids_model_request** | [**RetailMediaExternalv1SetBidsModelRequest**](RetailMediaExternalv1SetBidsModelRequest.md)| Object containing a list of bid overrides for associated keywords | [optional] + **id** | **str**| ID of the line item | + **set_bids_model_request** | [**SetBidsModelRequest**](SetBidsModelRequest.md)| | [optional] ### Return type -[**RetailMediaExternalv1ResourceOutcome**](RetailMediaExternalv1ResourceOutcome.md) +[**ResourceOutcome**](ResourceOutcome.md) ### Authorization @@ -3047,7 +3926,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -3060,11 +3939,11 @@ 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) # **submit_proposal** -> RetailMediaExternalv1ProposalStatusModelResponse submit_proposal(id) +> ProposalStatusModelResponse submit_proposal(id) -Submit a proposal to modify a Preferred Deal Line Item for review. +Only the components of the Line Item that are in a valid state will be reviewed. ### Example @@ -3075,7 +3954,8 @@ Submit a proposal to modify a Preferred Deal Line Item for review. import time import criteo_api_retailmedia_preview from criteo_api_retailmedia_preview.api import campaign_api -from criteo_api_retailmedia_preview.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse +from criteo_api_retailmedia_preview.model.proposal_status_model_response import ProposalStatusModelResponse +from criteo_api_retailmedia_preview.model.resource_outcome import ResourceOutcome 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. @@ -3104,7 +3984,7 @@ 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) - id = "id_example" # str | The external id of a line item. + id = "id_example" # str | ID of the line item # example passing only required values which don't have defaults set try: @@ -3119,11 +3999,11 @@ with criteo_api_retailmedia_preview.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The external id of a line item. | + **id** | **str**| ID of the line item | ### Return type -[**RetailMediaExternalv1ProposalStatusModelResponse**](RetailMediaExternalv1ProposalStatusModelResponse.md) +[**ProposalStatusModelResponse**](ProposalStatusModelResponse.md) ### Authorization @@ -3132,7 +4012,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 @@ -3141,11 +4021,117 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | -**500** | Server Error | - | **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) +# **unpause_promoted_products** +> unpause_promoted_products(line_item_id) + + + +Un-pause a collection of promoted products associated with a line item + +### 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.product_resource_outcome import ProductResourceOutcome +from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput +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) + line_item_id = "lineItemId_example" # str | ID of the line item + promoted_product_resource_collection_input = PromotedProductResourceCollectionInput( + data=[ + PromotedProductResource( + id="id_example", + type="type_example", + attributes=PromotedProduct( + id="id_example", + bid_override=3.14, + status=LineItemProductStatus("Unknown"), + ), + ), + ], + ) # PromotedProductResourceCollectionInput | Request body whose {data} contains an array of promoted products. (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.unpause_promoted_products(line_item_id) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->unpause_promoted_products: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.unpause_promoted_products(line_item_id, promoted_product_resource_collection_input=promoted_product_resource_collection_input) + except criteo_api_retailmedia_preview.ApiException as e: + print("Exception when calling CampaignApi->unpause_promoted_products: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **line_item_id** | **str**| ID of the line item | + **promoted_product_resource_collection_input** | [**PromotedProductResourceCollectionInput**](PromotedProductResourceCollectionInput.md)| Request body whose {data} contains an array of promoted products. | [optional] + +### Return type + +void (empty response body) + +### 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 | +|-------------|-------------|------------------| +**204** | Promoted products un-paused | - | +**400** | Invalid request body | - | +**403** | Invalid external line item ID | - | + +[[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_campaign_budget_overrides** > ValueResourceOutcomeOfCampaignBudgetOverrides update_campaign_budget_overrides(campaign_id) diff --git a/sdks/retailmedia_preview/docs/CreativeV2ListResponse.md b/sdks/retailmedia_preview/docs/CreativeV2ListResponse.md new file mode 100644 index 00000000..b50666f8 --- /dev/null +++ b/sdks/retailmedia_preview/docs/CreativeV2ListResponse.md @@ -0,0 +1,15 @@ +# CreativeV2ListResponse + +A top-level object that encapsulates a Criteo API response for several entities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[ResourceOfCreativeV2], none_type**](ResourceOfCreativeV2.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/CreativeV2Response.md b/sdks/retailmedia_preview/docs/CreativeV2Response.md new file mode 100644 index 00000000..d6de8d16 --- /dev/null +++ b/sdks/retailmedia_preview/docs/CreativeV2Response.md @@ -0,0 +1,15 @@ +# CreativeV2Response + +A top-level object that encapsulates a Criteo API response for a single entity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfCreativeV2**](ResourceOfCreativeV2.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/ErrorCodeResponse.md b/sdks/retailmedia_preview/docs/ErrorCodeResponse.md new file mode 100644 index 00000000..369d0712 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ErrorCodeResponse.md @@ -0,0 +1,14 @@ +# ErrorCodeResponse + +Definition of the error code + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[AudienceError]**](AudienceError.md) | | +**warnings** | [**[AudienceWarning], none_type**](AudienceWarning.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/ExternalChoiceVariableValue.md b/sdks/retailmedia_preview/docs/ExternalChoiceVariableValue.md new file mode 100644 index 00000000..b8de67b8 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalChoiceVariableValue.md @@ -0,0 +1,13 @@ +# ExternalChoiceVariableValue + +A value of a template choice variable (among different accepted options) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**chosen_options** | **[str]** | The chosen options | +**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/ExternalColorVariableValue.md b/sdks/retailmedia_preview/docs/ExternalColorVariableValue.md new file mode 100644 index 00000000..6c202a98 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalColorVariableValue.md @@ -0,0 +1,13 @@ +# ExternalColorVariableValue + +A value of a template color variable + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**color** | **str, none_type** | The displayed color (HEX format) | [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/ExternalCreativeCreateModelV2.md b/sdks/retailmedia_preview/docs/ExternalCreativeCreateModelV2.md new file mode 100644 index 00000000..099c6b8b --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalCreativeCreateModelV2.md @@ -0,0 +1,17 @@ +# ExternalCreativeCreateModelV2 + +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** | [**[ExternalTemplateVariableValue]**](ExternalTemplateVariableValue.md) | The template chosen values | +**brand_id** | **int, none_type** | 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/ExternalCreativeUpdateModelV2.md b/sdks/retailmedia_preview/docs/ExternalCreativeUpdateModelV2.md new file mode 100644 index 00000000..220b8ad8 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalCreativeUpdateModelV2.md @@ -0,0 +1,17 @@ +# ExternalCreativeUpdateModelV2 + +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** | [**[ExternalTemplateVariableValue]**](ExternalTemplateVariableValue.md) | The template chosen values | +**brand_id** | **int, none_type** | 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/ExternalCreativeV2.md b/sdks/retailmedia_preview/docs/ExternalCreativeV2.md new file mode 100644 index 00000000..dc7c053c --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalCreativeV2.md @@ -0,0 +1,24 @@ +# ExternalCreativeV2 + +A creative entity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name | +**status** | **str** | Creative Status | +**brand_id** | **int** | Brand Id | +**retailer_id** | **int** | Retailer Id | +**template_id** | **int** | Template Id | +**template_name** | **str** | Template Name | +**format_id** | **int** | Format Id | +**associated_line_item_ids** | **[str]** | Associated Line Item Ids | +**updated_at** | **datetime** | Updated at time | +**creative_format_type** | **str** | Creative format type | +**environments** | [**[ExternalPageTypeEnvironment]**](ExternalPageTypeEnvironment.md) | Environment type (e.g. mobile, web, app) | +**template_variable_values** | [**[ExternalTemplateVariableValue]**](ExternalTemplateVariableValue.md) | The template chosen values | +**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/ExternalFilesVariableValue.md b/sdks/retailmedia_preview/docs/ExternalFilesVariableValue.md new file mode 100644 index 00000000..dd45f9a1 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalFilesVariableValue.md @@ -0,0 +1,13 @@ +# ExternalFilesVariableValue + +A value of a template file variable (one or several files), like images in a creative + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**asset_ids** | **[str]** | The assets representing the images to be displayed | +**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/ExternalHyperlinkVariableValue.md b/sdks/retailmedia_preview/docs/ExternalHyperlinkVariableValue.md new file mode 100644 index 00000000..1eb2cf84 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalHyperlinkVariableValue.md @@ -0,0 +1,13 @@ +# ExternalHyperlinkVariableValue + +A value of a template hyperlink variable + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str, none_type** | The url to redirect to | [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/ExternalLineItemBidMultipliersV2.md b/sdks/retailmedia_preview/docs/ExternalLineItemBidMultipliersV2.md new file mode 100644 index 00000000..b68d86fe --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalLineItemBidMultipliersV2.md @@ -0,0 +1,23 @@ +# ExternalLineItemBidMultipliersV2 + +The Bid Multiplier Entity of a LineItem + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**search** | **float, none_type** | Search Page Type Bid Multiplier | [optional] +**home** | **float, none_type** | Home Page Type Bid Multiplier | [optional] +**category** | **float, none_type** | Categories Page Type Bid Multiplier | [optional] +**product_detail** | **float, none_type** | ProductDetail Page Type Bid Multiplier | [optional] +**confirmation** | **float, none_type** | Confirmation Page Type Bid Multiplier | [optional] +**merchandising** | **float, none_type** | Merchandising Page Type Bid Multiplier | [optional] +**deals** | **float, none_type** | Deals Page Type Bid Multiplier | [optional] +**checkout** | **float, none_type** | Checkout Page Type Bid Multiplier | [optional] +**favorites** | **float, none_type** | Favorites Page Type Bid Multiplier | [optional] +**search_bar** | **float, none_type** | SearchBar Page Type Bid Multiplier | [optional] +**category_menu** | **float, none_type** | CategoryMenu Page Type Bid Multiplier | [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/ExternalPageTypeEnvironment.md b/sdks/retailmedia_preview/docs/ExternalPageTypeEnvironment.md new file mode 100644 index 00000000..62e3483f --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalPageTypeEnvironment.md @@ -0,0 +1,14 @@ +# ExternalPageTypeEnvironment + +The PageType-Environment Tuples for creatives + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page_type** | **str, none_type** | Creative PageType | [optional] +**environments** | **[str], none_type** | 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/ExternalTemplateVariableValue.md b/sdks/retailmedia_preview/docs/ExternalTemplateVariableValue.md new file mode 100644 index 00000000..d3ad6a7d --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalTemplateVariableValue.md @@ -0,0 +1,19 @@ +# ExternalTemplateVariableValue + +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** | [**ExternalTextVariableValue**](ExternalTextVariableValue.md) | | [optional] +**choice_variable_value** | [**ExternalChoiceVariableValue**](ExternalChoiceVariableValue.md) | | [optional] +**color_variable_value** | [**ExternalColorVariableValue**](ExternalColorVariableValue.md) | | [optional] +**files_variable_value** | [**ExternalFilesVariableValue**](ExternalFilesVariableValue.md) | | [optional] +**hyperlink_variable_value** | [**ExternalHyperlinkVariableValue**](ExternalHyperlinkVariableValue.md) | | [optional] +**video_variable_value** | [**ExternalVideoVariableValue**](ExternalVideoVariableValue.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/ExternalTextVariableValue.md b/sdks/retailmedia_preview/docs/ExternalTextVariableValue.md new file mode 100644 index 00000000..af05d90f --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalTextVariableValue.md @@ -0,0 +1,13 @@ +# ExternalTextVariableValue + +A value of a template text variable + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**text** | **str, none_type** | The displayed 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/ExternalVideoVariableValue.md b/sdks/retailmedia_preview/docs/ExternalVideoVariableValue.md new file mode 100644 index 00000000..5e2e9f03 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ExternalVideoVariableValue.md @@ -0,0 +1,16 @@ +# ExternalVideoVariableValue + +A value of a template video variable + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | The vast video url | +**width** | **int** | The video's width | +**height** | **int** | The video's height | +**duration** | **str** | The video's duration | +**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/InputKeywordsModel.md b/sdks/retailmedia_preview/docs/InputKeywordsModel.md new file mode 100644 index 00000000..9a080793 --- /dev/null +++ b/sdks/retailmedia_preview/docs/InputKeywordsModel.md @@ -0,0 +1,14 @@ +# InputKeywordsModel + +The keywords to be added or removed from a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negative_broad** | **[str], none_type** | | [optional] +**negative_exact** | **[str], none_type** | | [optional] +**positive_exact** | **[str], 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/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md b/sdks/retailmedia_preview/docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md deleted file mode 100644 index c7cfd79b..00000000 --- a/sdks/retailmedia_preview/docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.md +++ /dev/null @@ -1,15 +0,0 @@ -# JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers - -Response object for line item bid multiplier calls - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | -**type** | **str** | | -**attributes** | [**LineItemBidMultipliers**](LineItemBidMultipliers.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/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2.md b/sdks/retailmedia_preview/docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2.md new file mode 100644 index 00000000..7efe7dbb --- /dev/null +++ b/sdks/retailmedia_preview/docs/JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2.md @@ -0,0 +1,15 @@ +# JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2 + +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** | [**ExternalLineItemBidMultipliersV2**](ExternalLineItemBidMultipliersV2.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/JsonApiSingleResponseOfLineItemBidMultipliers.md b/sdks/retailmedia_preview/docs/JsonApiSingleResponseOfLineItemBidMultipliers.md deleted file mode 100644 index effec147..00000000 --- a/sdks/retailmedia_preview/docs/JsonApiSingleResponseOfLineItemBidMultipliers.md +++ /dev/null @@ -1,15 +0,0 @@ -# JsonApiSingleResponseOfLineItemBidMultipliers - -Data model for the response of a line item bid multiplier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers**](JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersAndLineItemBidMultipliers.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/JsonApiSingleResponseOfLineItemBidMultipliersV2.md b/sdks/retailmedia_preview/docs/JsonApiSingleResponseOfLineItemBidMultipliersV2.md new file mode 100644 index 00000000..4cb548f9 --- /dev/null +++ b/sdks/retailmedia_preview/docs/JsonApiSingleResponseOfLineItemBidMultipliersV2.md @@ -0,0 +1,15 @@ +# JsonApiSingleResponseOfLineItemBidMultipliersV2 + +A JSON:API wrapper class to add one JSON:API within a data property + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2**](JsonApiBodyWithIdOfInt64AndLineItemBidMultipliersV2AndLineItemBidMultipliersV2.md) | | +**errors** | [**[CommonError], none_type**](CommonError.md) | | [optional] +**warnings** | [**[CommonWarning], none_type**](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/KeywordDataModel.md b/sdks/retailmedia_preview/docs/KeywordDataModel.md new file mode 100644 index 00000000..fca58d73 --- /dev/null +++ b/sdks/retailmedia_preview/docs/KeywordDataModel.md @@ -0,0 +1,17 @@ +# KeywordDataModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**review_state** | [**ReviewStateModel**](ReviewStateModel.md) | | [optional] +**match_type** | [**MatchTypeModel**](MatchTypeModel.md) | | [optional] +**bid** | **float, none_type** | | [optional] +**input_keywords** | [**InputKeywordsModel**](InputKeywordsModel.md) | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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/KeywordsModel.md b/sdks/retailmedia_preview/docs/KeywordsModel.md new file mode 100644 index 00000000..d31dabad --- /dev/null +++ b/sdks/retailmedia_preview/docs/KeywordsModel.md @@ -0,0 +1,13 @@ +# KeywordsModel + +The keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**{str: (KeywordDataModel,)}, none_type**](KeywordDataModel.md) | | [optional] +**rank** | **[str], 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/KeywordsModelResource.md b/sdks/retailmedia_preview/docs/KeywordsModelResource.md new file mode 100644 index 00000000..9a26bd3a --- /dev/null +++ b/sdks/retailmedia_preview/docs/KeywordsModelResource.md @@ -0,0 +1,14 @@ +# KeywordsModelResource + +Resource object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**KeywordsModel**](KeywordsModel.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/KeywordsModelResponse.md b/sdks/retailmedia_preview/docs/KeywordsModelResponse.md new file mode 100644 index 00000000..2d24cc4e --- /dev/null +++ b/sdks/retailmedia_preview/docs/KeywordsModelResponse.md @@ -0,0 +1,14 @@ +# KeywordsModelResponse + +Response object containing keywords associated with a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**KeywordsModelResource**](KeywordsModelResource.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/LineItemBidMultipliers.md b/sdks/retailmedia_preview/docs/LineItemBidMultipliers.md deleted file mode 100644 index b654c293..00000000 --- a/sdks/retailmedia_preview/docs/LineItemBidMultipliers.md +++ /dev/null @@ -1,20 +0,0 @@ -# LineItemBidMultipliers - -Data model representing bid multipliers on a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**search** | **float** | | [optional] -**homepage** | **float** | | [optional] -**categories** | **float** | | [optional] -**product_detail** | **float** | | [optional] -**confirmation** | **float** | | [optional] -**merchandising** | **float** | | [optional] -**deals** | **float** | | [optional] -**checkout** | **float** | | [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/LineItemBidMultipliersRequest.md b/sdks/retailmedia_preview/docs/LineItemBidMultipliersRequest.md deleted file mode 100644 index 83df2f3b..00000000 --- a/sdks/retailmedia_preview/docs/LineItemBidMultipliersRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# LineItemBidMultipliersRequest - -Data model for an input resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**ResourceOfLineItemBidMultipliers**](ResourceOfLineItemBidMultipliers.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/LineItemBidMultipliersResponse.md b/sdks/retailmedia_preview/docs/LineItemBidMultipliersResponse.md deleted file mode 100644 index f5f4f38f..00000000 --- a/sdks/retailmedia_preview/docs/LineItemBidMultipliersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# LineItemBidMultipliersResponse - -Data model for response resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**ResourceOfLineItemBidMultipliers**](ResourceOfLineItemBidMultipliers.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/LineItemBidMultipliersV2Request.md b/sdks/retailmedia_preview/docs/LineItemBidMultipliersV2Request.md new file mode 100644 index 00000000..ab84773b --- /dev/null +++ b/sdks/retailmedia_preview/docs/LineItemBidMultipliersV2Request.md @@ -0,0 +1,13 @@ +# LineItemBidMultipliersV2Request + +A top-level object that encapsulates a Criteo API request for a single entity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfLineItemBidMultipliersV2**](ResourceOfLineItemBidMultipliersV2.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/LineItemBidMultipliersV2Response.md b/sdks/retailmedia_preview/docs/LineItemBidMultipliersV2Response.md new file mode 100644 index 00000000..1e130c25 --- /dev/null +++ b/sdks/retailmedia_preview/docs/LineItemBidMultipliersV2Response.md @@ -0,0 +1,15 @@ +# LineItemBidMultipliersV2Response + +A top-level object that encapsulates a Criteo API response for a single entity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ResourceOfLineItemBidMultipliersV2**](ResourceOfLineItemBidMultipliersV2.md) | | [optional] +**warnings** | [**[CommonProblem], none_type**](CommonProblem.md) | | [optional] [readonly] +**errors** | [**[CommonProblem], none_type**](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/LineItemProductStatus.md b/sdks/retailmedia_preview/docs/LineItemProductStatus.md new file mode 100644 index 00000000..e0c71b80 --- /dev/null +++ b/sdks/retailmedia_preview/docs/LineItemProductStatus.md @@ -0,0 +1,12 @@ +# LineItemProductStatus + +The status of a promoted product in the context of the line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of a promoted product in the context of the line item. | must be one of ["Unknown", "Active", "Paused", ] + +[[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/MatchTypeModel.md b/sdks/retailmedia_preview/docs/MatchTypeModel.md new file mode 100644 index 00000000..9406306f --- /dev/null +++ b/sdks/retailmedia_preview/docs/MatchTypeModel.md @@ -0,0 +1,12 @@ +# MatchTypeModel + +The match type of a keyword. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The match type of a keyword. | must be one of ["PositiveExactMatch", "NegativeExactMatch", "NegativeBroadMatch", ] + +[[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/NegotiationStateModel.md b/sdks/retailmedia_preview/docs/NegotiationStateModel.md new file mode 100644 index 00000000..e34ddbf4 --- /dev/null +++ b/sdks/retailmedia_preview/docs/NegotiationStateModel.md @@ -0,0 +1,12 @@ +# NegotiationStateModel + +The state of a negotiation in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a negotiation in the context of a line item. | must be one of ["Invalid", "Modified", "Submitted", "Reviewed", "Approved", ] + +[[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/ProductMetadata.md b/sdks/retailmedia_preview/docs/ProductMetadata.md new file mode 100644 index 00000000..6b368620 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductMetadata.md @@ -0,0 +1,15 @@ +# ProductMetadata + +Metadata about the response. Used for pagination. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**offset** | **int, none_type** | Zero based offset of the first item in the response. | [optional] +**limit** | **int, none_type** | Maximum number of items in the response. | [optional] +**count** | **int, none_type** | Total number of items available. | [optional] +**response_count** | **int, none_type** | Number of items in the response. | [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/ProductResourceOutcome.md b/sdks/retailmedia_preview/docs/ProductResourceOutcome.md new file mode 100644 index 00000000..2f7e8e35 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProductResourceOutcome.md @@ -0,0 +1,13 @@ +# ProductResourceOutcome + +Outcome object containing errors and warnings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.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/PromotedProduct.md b/sdks/retailmedia_preview/docs/PromotedProduct.md new file mode 100644 index 00000000..a99497cd --- /dev/null +++ b/sdks/retailmedia_preview/docs/PromotedProduct.md @@ -0,0 +1,14 @@ +# PromotedProduct + +A promoted product. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | A retailer defined SKU ID for the promoted product. | [optional] +**bid_override** | **float, none_type** | The bid override for the promoted product for this line item. Ignored unless adding a product. | [optional] +**status** | [**LineItemProductStatus**](LineItemProductStatus.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/PromotedProductResource.md b/sdks/retailmedia_preview/docs/PromotedProductResource.md new file mode 100644 index 00000000..0e0e3432 --- /dev/null +++ b/sdks/retailmedia_preview/docs/PromotedProductResource.md @@ -0,0 +1,14 @@ +# PromotedProductResource + +Resource object containing a promoted product. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**PromotedProduct**](PromotedProduct.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/PromotedProductResourceCollectionInput.md b/sdks/retailmedia_preview/docs/PromotedProductResourceCollectionInput.md new file mode 100644 index 00000000..58a7b857 --- /dev/null +++ b/sdks/retailmedia_preview/docs/PromotedProductResourceCollectionInput.md @@ -0,0 +1,12 @@ +# PromotedProductResourceCollectionInput + +Request object containing promoted products to be appended, deleted, paused or unpaused. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[PromotedProductResource], none_type**](PromotedProductResource.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/PromotedProductResourceCollectionOutcome.md b/sdks/retailmedia_preview/docs/PromotedProductResourceCollectionOutcome.md new file mode 100644 index 00000000..4cba4242 --- /dev/null +++ b/sdks/retailmedia_preview/docs/PromotedProductResourceCollectionOutcome.md @@ -0,0 +1,15 @@ +# PromotedProductResourceCollectionOutcome + +Outcome object containing promoted products. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] +**meta** | [**ProductMetadata**](ProductMetadata.md) | | [optional] +**data** | [**[PromotedProductResource], none_type**](PromotedProductResource.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/ProposalStatusModel.md b/sdks/retailmedia_preview/docs/ProposalStatusModel.md new file mode 100644 index 00000000..49d39c19 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProposalStatusModel.md @@ -0,0 +1,17 @@ +# ProposalStatusModel + +The state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negotiation_state** | [**NegotiationStateModel**](NegotiationStateModel.md) | | [optional] +**booking_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**runnable_status** | [**ApprovalStatusModel**](ApprovalStatusModel.md) | | [optional] +**comment** | **str, none_type** | | [optional] +**created_at** | **datetime, none_type** | | [optional] +**updated_at** | **datetime, 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/ProposalStatusModelResource.md b/sdks/retailmedia_preview/docs/ProposalStatusModelResource.md new file mode 100644 index 00000000..f89ca4eb --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProposalStatusModelResource.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResource + +Resource object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**ProposalStatusModel**](ProposalStatusModel.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/ProposalStatusModelResponse.md b/sdks/retailmedia_preview/docs/ProposalStatusModelResponse.md new file mode 100644 index 00000000..2e87ff0d --- /dev/null +++ b/sdks/retailmedia_preview/docs/ProposalStatusModelResponse.md @@ -0,0 +1,14 @@ +# ProposalStatusModelResponse + +Response object containing the state of a proposal in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**data** | [**ProposalStatusModelResource**](ProposalStatusModelResource.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/ResourceOfCreativeV2.md b/sdks/retailmedia_preview/docs/ResourceOfCreativeV2.md new file mode 100644 index 00000000..08f842c9 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ResourceOfCreativeV2.md @@ -0,0 +1,15 @@ +# ResourceOfCreativeV2 + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**ExternalCreativeV2**](ExternalCreativeV2.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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/ResourceOfLineItemBidMultipliers.md b/sdks/retailmedia_preview/docs/ResourceOfLineItemBidMultipliers.md deleted file mode 100644 index 19ac36e6..00000000 --- a/sdks/retailmedia_preview/docs/ResourceOfLineItemBidMultipliers.md +++ /dev/null @@ -1,15 +0,0 @@ -# ResourceOfLineItemBidMultipliers - -Data model for a Resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attributes** | [**LineItemBidMultipliers**](LineItemBidMultipliers.md) | | [optional] -**id** | **str, none_type** | Id of the entity | [optional] -**type** | **str, none_type** | Canonical type name of the entity | [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/ResourceOfLineItemBidMultipliersV2.md b/sdks/retailmedia_preview/docs/ResourceOfLineItemBidMultipliersV2.md new file mode 100644 index 00000000..7be3f53e --- /dev/null +++ b/sdks/retailmedia_preview/docs/ResourceOfLineItemBidMultipliersV2.md @@ -0,0 +1,15 @@ +# ResourceOfLineItemBidMultipliersV2 + +A class that represents a domain entity exposed by an API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**ExternalLineItemBidMultipliersV2**](ExternalLineItemBidMultipliersV2.md) | | [optional] +**id** | **str, none_type** | Id of the entity | [optional] +**type** | **str, none_type** | Canonical type name of the entity | [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/ResourceOutcome.md b/sdks/retailmedia_preview/docs/ResourceOutcome.md new file mode 100644 index 00000000..3bf8a5e5 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ResourceOutcome.md @@ -0,0 +1,13 @@ +# ResourceOutcome + +Outcome object containing errors and warnings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.md) | | [optional] [readonly] +**warnings** | [**[RmcaCommonProblem], none_type**](RmcaCommonProblem.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/RetailMediaAccount.md b/sdks/retailmedia_preview/docs/RetailMediaAccount.md index 5cdcf5b1..efc008b5 100644 --- a/sdks/retailmedia_preview/docs/RetailMediaAccount.md +++ b/sdks/retailmedia_preview/docs/RetailMediaAccount.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **company_name** | **str, none_type** | Display name for reporting the owning entity of ads for the Digital Services Act in the European Union | [optional] **type** | **str, none_type** | Type for the account | [optional] **sub_type** | **str, none_type** | subtype for the account | [optional] -**country_ids** | **[int], none_type** | list of countries associated with the account | [optional] -**currency_id** | **int, none_type** | the currency for the account | [optional] +**country_ids** | **[str], none_type** | list of countries associated with the account | [optional] +**currency_id** | **str, none_type** | the currency for the account | [optional] **parent_account_label** | **str, none_type** | parent account label for the account | [optional] **time_zone** | **str, none_type** | the timezone for the account | [optional] diff --git a/sdks/retailmedia_preview/docs/RetailMediaContactlistAmendment.md b/sdks/retailmedia_preview/docs/RetailMediaContactlistAmendment.md new file mode 100644 index 00000000..85e70ec4 --- /dev/null +++ b/sdks/retailmedia_preview/docs/RetailMediaContactlistAmendment.md @@ -0,0 +1,14 @@ +# RetailMediaContactlistAmendment + +Request data of retail media contact list amendment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**RetailMediaContactlistAmendmentAttributes**](RetailMediaContactlistAmendmentAttributes.md) | | +**type** | **str, none_type** | User List | [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/RetailMediaContactlistAmendmentAttributes.md b/sdks/retailmedia_preview/docs/RetailMediaContactlistAmendmentAttributes.md new file mode 100644 index 00000000..276c6db9 --- /dev/null +++ b/sdks/retailmedia_preview/docs/RetailMediaContactlistAmendmentAttributes.md @@ -0,0 +1,15 @@ +# RetailMediaContactlistAmendmentAttributes + +Attributes of retail media contact list amendment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **str** | Whether to add or remove users | +**identifiers** | **[str]** | The users to add or remove, each in the schema specified | +**identifier_type** | **str, none_type** | What type of identifiers are used | [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/RetailMediaContactlistAmendmentRequest.md b/sdks/retailmedia_preview/docs/RetailMediaContactlistAmendmentRequest.md new file mode 100644 index 00000000..d51d3177 --- /dev/null +++ b/sdks/retailmedia_preview/docs/RetailMediaContactlistAmendmentRequest.md @@ -0,0 +1,13 @@ +# RetailMediaContactlistAmendmentRequest + +Request of Retail Media contactlist + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**RetailMediaContactlistAmendment**](RetailMediaContactlistAmendment.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/RetailMediaContactlistOperation.md b/sdks/retailmedia_preview/docs/RetailMediaContactlistOperation.md new file mode 100644 index 00000000..37b941b5 --- /dev/null +++ b/sdks/retailmedia_preview/docs/RetailMediaContactlistOperation.md @@ -0,0 +1,15 @@ +# RetailMediaContactlistOperation + +Operation on Retail Media contact list + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**RetailMediaContactlistOperationResponseAttributes**](RetailMediaContactlistOperationResponseAttributes.md) | | +**errors** | [**[AudienceError]**](AudienceError.md) | | +**warnings** | [**[AudienceWarning]**](AudienceWarning.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/RetailMediaContactlistOperationResponseAttributes.md b/sdks/retailmedia_preview/docs/RetailMediaContactlistOperationResponseAttributes.md new file mode 100644 index 00000000..3e51b7a7 --- /dev/null +++ b/sdks/retailmedia_preview/docs/RetailMediaContactlistOperationResponseAttributes.md @@ -0,0 +1,14 @@ +# RetailMediaContactlistOperationResponseAttributes + +Response data of Retail Media contact list operation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | the name of the entity type | +**attributes** | [**RetailMediaContactlistOperationResponseAttributesAttributes**](RetailMediaContactlistOperationResponseAttributesAttributes.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/RetailMediaContactlistOperationResponseAttributesAttributes.md b/sdks/retailmedia_preview/docs/RetailMediaContactlistOperationResponseAttributesAttributes.md new file mode 100644 index 00000000..963db514 --- /dev/null +++ b/sdks/retailmedia_preview/docs/RetailMediaContactlistOperationResponseAttributesAttributes.md @@ -0,0 +1,19 @@ +# RetailMediaContactlistOperationResponseAttributesAttributes + +The attributes of Retaile Media contact list operation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**contact_list_id** | **int** | The affected user list id | +**operation** | **str** | The action recorded | +**request_date** | **datetime** | When the action was recorded | +**identifier_type** | **str, none_type** | The schema specified for of the identifiers | [optional] +**nb_invalid_identifiers** | **int, none_type** | How many identifiers were invalid for the specified schema | [optional] +**nb_valid_identifiers** | **int, none_type** | How many identifiers were valid for the specified schema | [optional] +**sample_invalid_identifiers** | **[str], none_type** | A sample of invalid identifiers if there is some | [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/RetailMediaExternalv1AddRemoveKeywordModel.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1AddRemoveKeywordModel.md deleted file mode 100644 index 98c859cd..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1AddRemoveKeywordModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordModel - -A single keyword to be added or removed - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**is_deleted** | **bool, 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/RetailMediaExternalv1AddRemoveKeywordsModel.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md deleted file mode 100644 index 2d39bd84..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1AddRemoveKeywordsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModel - -Data model containing keywords to be added or removed from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1AddRemoveKeywordModel], none_type**](RetailMediaExternalv1AddRemoveKeywordModel.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/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md deleted file mode 100644 index d623d5f5..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1AddRemoveKeywordsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelRequest - -Request object to add or remove keywords from a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1AddRemoveKeywordsModelResource**](RetailMediaExternalv1AddRemoveKeywordsModelResource.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/RetailMediaExternalv1AddRemoveKeywordsModelResource.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md deleted file mode 100644 index 1abf3809..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1AddRemoveKeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1AddRemoveKeywordsModelResource - -Resource wrapper the keyword add and remove datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1AddRemoveKeywordsModel**](RetailMediaExternalv1AddRemoveKeywordsModel.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/RetailMediaExternalv1InputKeywordsModel.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1InputKeywordsModel.md deleted file mode 100644 index 19807cea..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1InputKeywordsModel.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1InputKeywordsModel - -Input values associated with a keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negative_broad** | **[str], none_type** | | [optional] -**negative_exact** | **[str], none_type** | | [optional] -**positive_exact** | **[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/RetailMediaExternalv1KeywordDataModel.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1KeywordDataModel.md deleted file mode 100644 index d7326d7a..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1KeywordDataModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1KeywordDataModel - -Details for a specific keyword - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**review_state** | **str, none_type** | | [optional] -**match_type** | **str, none_type** | | [optional] -**bid** | **float, none_type** | | [optional] -**input_keywords** | [**RetailMediaExternalv1InputKeywordsModel**](RetailMediaExternalv1InputKeywordsModel.md) | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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/RetailMediaExternalv1KeywordsModel.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1KeywordsModel.md deleted file mode 100644 index 105b25b5..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1KeywordsModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1KeywordsModel - -Datamodel representing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**RetailMediaExternalv1KeywordDataModel**](RetailMediaExternalv1KeywordDataModel.md) | | [optional] -**rank** | **[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/RetailMediaExternalv1KeywordsModelResource.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1KeywordsModelResource.md deleted file mode 100644 index 8aabe795..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1KeywordsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResource - -Resource wrapper of associated keywords with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1KeywordsModel**](RetailMediaExternalv1KeywordsModel.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/RetailMediaExternalv1KeywordsModelResponse.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1KeywordsModelResponse.md deleted file mode 100644 index eb84587c..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1KeywordsModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1KeywordsModelResponse - -Response object containing keywords associated with a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1KeywordsModelResource**](RetailMediaExternalv1KeywordsModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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/RetailMediaExternalv1ProblemDetails.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1ProblemDetails.md deleted file mode 100644 index 32758436..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1ProblemDetails.md +++ /dev/null @@ -1,21 +0,0 @@ -# RetailMediaExternalv1ProblemDetails - -Datamodel for common errors and warnings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**trace_identifier** | **str, none_type** | | [optional] -**code** | **str, none_type** | | [optional] -**source** | **{str: (str,)}, none_type** | | [optional] -**stack_trace** | **str, none_type** | | [optional] -**type** | **str, none_type** | | [optional] -**title** | **str, none_type** | | [optional] -**status** | **int, none_type** | | [optional] -**detail** | **str, none_type** | | [optional] -**instance** | **str, none_type** | | [optional] -**any string name** | **{str: (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/RetailMediaExternalv1ProposalStatusModel.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1ProposalStatusModel.md deleted file mode 100644 index 93cf4401..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1ProposalStatusModel.md +++ /dev/null @@ -1,18 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModel - -The proposal status includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**negotiation_state** | **str** | | -**booking_status** | **str** | | -**runnable_status** | **str** | | -**comment** | **str, none_type** | | [optional] -**created_at** | **datetime, none_type** | | [optional] -**updated_at** | **datetime, 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/RetailMediaExternalv1ProposalStatusModelResource.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1ProposalStatusModelResource.md deleted file mode 100644 index 4c5ebc52..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1ProposalStatusModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResource - -Wrapper for the proposal status - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1ProposalStatusModel**](RetailMediaExternalv1ProposalStatusModel.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/RetailMediaExternalv1ProposalStatusModelResponse.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1ProposalStatusModelResponse.md deleted file mode 100644 index 2550a175..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1ProposalStatusModelResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1ProposalStatusModelResponse - -Wrapper for the proposal status resource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1ProposalStatusModelResource**](RetailMediaExternalv1ProposalStatusModelResource.md) | | [optional] -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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/RetailMediaExternalv1ResourceOutcome.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1ResourceOutcome.md deleted file mode 100644 index 7b1c09f1..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1ResourceOutcome.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1ResourceOutcome - -A response object containing errors or warnings if required - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**errors** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.md) | | [optional] [readonly] -**warnings** | [**[RetailMediaExternalv1ProblemDetails], none_type**](RetailMediaExternalv1ProblemDetails.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/RetailMediaExternalv1SetBidModel.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1SetBidModel.md deleted file mode 100644 index 978f8b12..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1SetBidModel.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetailMediaExternalv1SetBidModel - -A single keyword and associated bid override - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**phrase** | **str, none_type** | | [optional] -**bid** | **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/retailmedia_preview/docs/RetailMediaExternalv1SetBidsModel.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1SetBidsModel.md deleted file mode 100644 index 2b1359ff..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1SetBidsModel.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModel - -Data model containing keywords and bid overrides to associate to them - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keywords** | [**[RetailMediaExternalv1SetBidModel], none_type**](RetailMediaExternalv1SetBidModel.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/RetailMediaExternalv1SetBidsModelRequest.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1SetBidsModelRequest.md deleted file mode 100644 index e40b943e..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1SetBidsModelRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RetailMediaExternalv1SetBidsModelRequest - -Request to set bid overrides for specified keywords on a line item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RetailMediaExternalv1SetBidsModelResource**](RetailMediaExternalv1SetBidsModelResource.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/RetailMediaExternalv1SetBidsModelResource.md b/sdks/retailmedia_preview/docs/RetailMediaExternalv1SetBidsModelResource.md deleted file mode 100644 index 4a4e3082..00000000 --- a/sdks/retailmedia_preview/docs/RetailMediaExternalv1SetBidsModelResource.md +++ /dev/null @@ -1,15 +0,0 @@ -# RetailMediaExternalv1SetBidsModelResource - -Wrapper of the Set Bids datamodel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**id** | **str, none_type** | | [optional] -**attributes** | [**RetailMediaExternalv1SetBidsModel**](RetailMediaExternalv1SetBidsModel.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/ReviewStateModel.md b/sdks/retailmedia_preview/docs/ReviewStateModel.md new file mode 100644 index 00000000..e905d467 --- /dev/null +++ b/sdks/retailmedia_preview/docs/ReviewStateModel.md @@ -0,0 +1,12 @@ +# ReviewStateModel + +The state of a keyword in the context of a line item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The state of a keyword in the context of a line item. | must be one of ["InReview", "Recommended", "Approved", "AutoApproved", "Rejected", "AutoRejected", ] + +[[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/RmLegacyAudienceGetEntityV1ListResponse.md b/sdks/retailmedia_preview/docs/RmLegacyAudienceGetEntityV1ListResponse.md index a086fc52..177bd87b 100644 --- a/sdks/retailmedia_preview/docs/RmLegacyAudienceGetEntityV1ListResponse.md +++ b/sdks/retailmedia_preview/docs/RmLegacyAudienceGetEntityV1ListResponse.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1ListResponse -List of responses +A top-level object that encapsulates a Criteo API response for several entities and metadata ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_preview/docs/RmLegacyAudienceGetEntityV1Resource.md b/sdks/retailmedia_preview/docs/RmLegacyAudienceGetEntityV1Resource.md index 7d4b9798..dad0c799 100644 --- a/sdks/retailmedia_preview/docs/RmLegacyAudienceGetEntityV1Resource.md +++ b/sdks/retailmedia_preview/docs/RmLegacyAudienceGetEntityV1Resource.md @@ -1,6 +1,6 @@ # RmLegacyAudienceGetEntityV1Resource -Legacy resource +A class that represents a domain entity exposed by an API ## Properties Name | Type | Description | Notes diff --git a/sdks/retailmedia_preview/docs/RmcaCommonProblem.md b/sdks/retailmedia_preview/docs/RmcaCommonProblem.md new file mode 100644 index 00000000..fba2c66b --- /dev/null +++ b/sdks/retailmedia_preview/docs/RmcaCommonProblem.md @@ -0,0 +1,21 @@ +# RmcaCommonProblem + +Common problem object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trace_id** | **str, none_type** | The request correlation ID this problem comes from. | [optional] +**type** | **str, none_type** | The problem's category. | [optional] +**code** | **str, none_type** | A machine-readable error code, expressed as a string value. | [optional] +**instance** | **str, none_type** | A URI that identifies the specific occurrence of the problem. | [optional] +**title** | **str, none_type** | A short human-readable description of the problem type | [optional] +**detail** | **str, none_type** | A human-readable explanation specific to this occurrence of the problem | [optional] +**source** | **{str: (str,)}, none_type** | A machine-readable structure to reference to the exact location(s) causing the error(s) | [optional] +**stack_trace** | **str, none_type** | | [optional] +**status** | **int, none_type** | The problem's HTTP Status code. | [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/SetBidModel.md b/sdks/retailmedia_preview/docs/SetBidModel.md new file mode 100644 index 00000000..979e91d0 --- /dev/null +++ b/sdks/retailmedia_preview/docs/SetBidModel.md @@ -0,0 +1,13 @@ +# SetBidModel + +A single keyword and associated bid override + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phrase** | **str, none_type** | | [optional] +**bid** | **float, 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/SetBidsModel.md b/sdks/retailmedia_preview/docs/SetBidsModel.md new file mode 100644 index 00000000..e5e1b0c8 --- /dev/null +++ b/sdks/retailmedia_preview/docs/SetBidsModel.md @@ -0,0 +1,12 @@ +# SetBidsModel + +Data model containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keywords** | [**[SetBidModel], none_type**](SetBidModel.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/SetBidsModelRequest.md b/sdks/retailmedia_preview/docs/SetBidsModelRequest.md new file mode 100644 index 00000000..9c19c9c2 --- /dev/null +++ b/sdks/retailmedia_preview/docs/SetBidsModelRequest.md @@ -0,0 +1,12 @@ +# SetBidsModelRequest + +Request object to set bid overrides for keywords associated with a line item + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SetBidsModelResource**](SetBidsModelResource.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/SetBidsModelResource.md b/sdks/retailmedia_preview/docs/SetBidsModelResource.md new file mode 100644 index 00000000..6e436263 --- /dev/null +++ b/sdks/retailmedia_preview/docs/SetBidsModelResource.md @@ -0,0 +1,14 @@ +# SetBidsModelResource + +Resource object containing keywords and their associated bid overrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**attributes** | [**SetBidsModel**](SetBidsModel.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/SyncAttributedTransactionsReport.md b/sdks/retailmedia_preview/docs/SyncAttributedTransactionsReport.md index 2859ee1a..aa61764e 100644 --- a/sdks/retailmedia_preview/docs/SyncAttributedTransactionsReport.md +++ b/sdks/retailmedia_preview/docs/SyncAttributedTransactionsReport.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_preview/docs/SyncCampaignsReport.md b/sdks/retailmedia_preview/docs/SyncCampaignsReport.md index 8a16b255..313c544d 100644 --- a/sdks/retailmedia_preview/docs/SyncCampaignsReport.md +++ b/sdks/retailmedia_preview/docs/SyncCampaignsReport.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_preview/docs/SyncLineItemsReport.md b/sdks/retailmedia_preview/docs/SyncLineItemsReport.md index c800acf5..8fbaab83 100644 --- a/sdks/retailmedia_preview/docs/SyncLineItemsReport.md +++ b/sdks/retailmedia_preview/docs/SyncLineItemsReport.md @@ -13,8 +13,8 @@ Name | Type | Description | Notes **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] +**campaign_type** | **str, none_type** | Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays | [optional] if omitted the server will use the default value of "all" +**sales_channel** | **str, none_type** | Filter on specific sales channel: offline or online | [optional] if omitted the server will use the default value of "all" **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" diff --git a/sdks/retailmedia_preview/setup.py b/sdks/retailmedia_preview/setup.py index 9e56711d..db13d2b4 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.240404" +VERSION = "0.0.240515" # To install the library, run the following # # python setup.py install @@ -24,9 +24,9 @@ ```sh -pip install criteo-api-retailmedia-sdk==0.0.240404 +pip install criteo-api-retailmedia-sdk==0.0.240515 ``` -(you may need to run `pip` with root permission: `sudo 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.240515`) Then import the package: ```python