criteo-api-retailmedia-sdk 0.0.251015__py3-none-any.whl → 0.0.251028__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of criteo-api-retailmedia-sdk might be problematic. Click here for more details.

Files changed (48) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +1 -1
  3. criteo_api_retailmedia_preview/api/campaign_api.py +332 -1203
  4. criteo_api_retailmedia_preview/api/third_party_accounts_api.py +757 -0
  5. criteo_api_retailmedia_preview/api_client.py +1 -1
  6. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  7. criteo_api_retailmedia_preview/configuration.py +1 -1
  8. criteo_api_retailmedia_preview/model/{set_bid_model.py → display_auction_min_bid_request.py} +17 -14
  9. criteo_api_retailmedia_preview/model/{keywords_model.py → display_auction_min_bid_result.py} +30 -16
  10. criteo_api_retailmedia_preview/model/{entity_resource_line_item_keyword_review_report.py → entity_resource_of_retail_media_account_v2.py} +9 -9
  11. criteo_api_retailmedia_preview/model/{value_resource_outcome_retail_media_keywords_review_result.py → entity_resource_outcome_of_retail_media_account_v2.py} +8 -8
  12. criteo_api_retailmedia_preview/model/external_retail_media_account_v2.py +301 -0
  13. criteo_api_retailmedia_preview/model/{add_remove_keyword_model.py → external_retail_media_brand_account_creation_v2.py} +19 -24
  14. criteo_api_retailmedia_preview/model/{set_bids_model.py → external_retail_media_brands.py} +16 -15
  15. criteo_api_retailmedia_preview/model/{seller_identifier_v2.py → external_retail_media_seller.py} +10 -16
  16. criteo_api_retailmedia_preview/model/{retail_media_keywords_review.py → external_retail_media_seller_account_creation_v2.py} +25 -16
  17. criteo_api_retailmedia_preview/model/{value_resource_input_retail_media_keywords_review.py → value_resource_collection_input_of_retail_media_seller.py} +8 -8
  18. criteo_api_retailmedia_preview/model/{entity_resource_collection_outcome_line_item_keyword_review_report_and_metadata.py → value_resource_collection_outcome_display_auction_min_bid_result.py} +8 -14
  19. criteo_api_retailmedia_preview/model/{resource_outcome.py → value_resource_collection_outcome_of_retail_media_seller.py} +17 -11
  20. criteo_api_retailmedia_preview/model/{keywords_model_resource.py → value_resource_display_auction_min_bid_request.py} +11 -15
  21. criteo_api_retailmedia_preview/model/{set_bids_model_resource.py → value_resource_display_auction_min_bid_result.py} +10 -14
  22. criteo_api_retailmedia_preview/model/{add_remove_keywords_model_request.py → value_resource_input_display_auction_min_bid_request.py} +8 -8
  23. criteo_api_retailmedia_preview/model/{add_remove_keywords_model.py → value_resource_input_of_retail_media_brand_account_creation_v2.py} +9 -9
  24. criteo_api_retailmedia_preview/model/{set_bids_model_request.py → value_resource_input_of_retail_media_brands.py} +8 -8
  25. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation_v2.py +262 -0
  26. criteo_api_retailmedia_preview/model/{add_remove_keywords_model_resource.py → value_resource_of_retail_media_brand_account_creation_v2.py} +10 -14
  27. criteo_api_retailmedia_preview/model/{value_resource_retail_media_keywords_review_result.py → value_resource_of_retail_media_brands.py} +8 -8
  28. criteo_api_retailmedia_preview/model/{value_resource_retail_media_keywords_review.py → value_resource_of_retail_media_seller.py} +8 -8
  29. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation_v2.py +266 -0
  30. criteo_api_retailmedia_preview/model/{keywords_model_response.py → value_resource_outcome_of_retail_media_brands.py} +16 -16
  31. criteo_api_retailmedia_preview/models/__init__.py +23 -33
  32. {criteo_api_retailmedia_sdk-0.0.251015.dist-info → criteo_api_retailmedia_sdk-0.0.251028.dist-info}/METADATA +3 -3
  33. {criteo_api_retailmedia_sdk-0.0.251015.dist-info → criteo_api_retailmedia_sdk-0.0.251028.dist-info}/RECORD +35 -44
  34. criteo_api_retailmedia_preview/model/brand_catalog_request_v2.py +0 -284
  35. criteo_api_retailmedia_preview/model/input_keywords_model.py +0 -265
  36. criteo_api_retailmedia_preview/model/keyword_data_model.py +0 -286
  37. criteo_api_retailmedia_preview/model/line_item_keyword_review_report.py +0 -311
  38. criteo_api_retailmedia_preview/model/match_type_model.py +0 -291
  39. criteo_api_retailmedia_preview/model/retail_media_keywords_review_result.py +0 -271
  40. criteo_api_retailmedia_preview/model/review_set_state.py +0 -278
  41. criteo_api_retailmedia_preview/model/review_state_model.py +0 -294
  42. criteo_api_retailmedia_preview/model/seller_catalog_request_v2.py +0 -286
  43. criteo_api_retailmedia_preview/model/value_resource_input_of_brand_catalog_request_v2.py +0 -269
  44. criteo_api_retailmedia_preview/model/value_resource_input_of_seller_catalog_request_v2.py +0 -269
  45. criteo_api_retailmedia_preview/model/value_resource_of_brand_catalog_request_v2.py +0 -273
  46. criteo_api_retailmedia_preview/model/value_resource_of_seller_catalog_request_v2.py +0 -273
  47. {criteo_api_retailmedia_sdk-0.0.251015.dist-info → criteo_api_retailmedia_sdk-0.0.251028.dist-info}/WHEEL +0 -0
  48. {criteo_api_retailmedia_sdk-0.0.251015.dist-info → criteo_api_retailmedia_sdk-0.0.251028.dist-info}/top_level.txt +0 -0
@@ -76,7 +76,7 @@ class ApiClient(object):
76
76
  self.default_headers[header_name] = header_value
77
77
  self.cookie = cookie
78
78
  # Set default User-Agent.
79
- self.user_agent = 'OpenAPI-Generator/0.0.251015/python'
79
+ self.user_agent = 'OpenAPI-Generator/0.0.251028/python'
80
80
 
81
81
  def __enter__(self):
82
82
  return self
@@ -23,3 +23,4 @@ from criteo_api_retailmedia_preview.api.campaign_api import CampaignApi
23
23
  from criteo_api_retailmedia_preview.api.catalog_api import CatalogApi
24
24
  from criteo_api_retailmedia_preview.api.gateway_api import GatewayApi
25
25
  from criteo_api_retailmedia_preview.api.on_site_recommendation_api import OnSiteRecommendationApi
26
+ from criteo_api_retailmedia_preview.api.third_party_accounts_api import ThirdPartyAccountsApi
@@ -395,7 +395,7 @@ class Configuration(object):
395
395
  "OS: {env}\n"\
396
396
  "Python Version: {pyversion}\n"\
397
397
  "Version of the API: Preview\n"\
398
- "SDK Package Version: 0.0.251015".\
398
+ "SDK Package Version: 0.0.251028".\
399
399
  format(env=sys.platform, pyversion=sys.version)
400
400
 
401
401
  def get_host_settings(self):
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class SetBidModel(ModelNormal):
33
+ class DisplayAuctionMinBidRequest(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -58,9 +58,12 @@ class SetBidModel(ModelNormal):
58
58
  }
59
59
 
60
60
  validations = {
61
- ('phrase',): {
62
- 'max_length': 255,
63
- 'min_length': 0,
61
+ ('creative_ids',): {
62
+ 'max_items': 50,
63
+ 'min_items': 1,
64
+ },
65
+ ('product_ids',): {
66
+ 'max_items': 50,
64
67
  },
65
68
  }
66
69
 
@@ -79,8 +82,8 @@ class SetBidModel(ModelNormal):
79
82
  and the value is attribute type.
80
83
  """
81
84
  return {
82
- 'bid': (float, none_type,), # noqa: E501
83
- 'phrase': (str, none_type,), # noqa: E501
85
+ 'creative_ids': ([str],), # noqa: E501
86
+ 'product_ids': ([str], none_type,), # noqa: E501
84
87
  }
85
88
 
86
89
  @cached_property
@@ -89,8 +92,8 @@ class SetBidModel(ModelNormal):
89
92
 
90
93
 
91
94
  attribute_map = {
92
- 'bid': 'bid', # noqa: E501
93
- 'phrase': 'phrase', # noqa: E501
95
+ 'creative_ids': 'creativeIds', # noqa: E501
96
+ 'product_ids': 'productIds', # noqa: E501
94
97
  }
95
98
 
96
99
  read_only_vars = {
@@ -101,7 +104,7 @@ class SetBidModel(ModelNormal):
101
104
  @classmethod
102
105
  @convert_js_args_to_python_args
103
106
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
104
- """SetBidModel - a model defined in OpenAPI
107
+ """DisplayAuctionMinBidRequest - a model defined in OpenAPI
105
108
 
106
109
  Keyword Args:
107
110
  _check_type (bool): if True, values for parameters in openapi_types
@@ -134,8 +137,8 @@ class SetBidModel(ModelNormal):
134
137
  Animal class but this time we won't travel
135
138
  through its discriminator because we passed in
136
139
  _visited_composed_classes = (Animal,)
137
- bid (float, none_type): [optional] # noqa: E501
138
- phrase (str, none_type): [optional] # noqa: E501
140
+ creative_ids ([str]): List of Creatives to use. [optional] # noqa: E501
141
+ product_ids ([str], none_type): List of potential product ids (SkuIds) to put in creatives. [optional] # noqa: E501
139
142
  """
140
143
 
141
144
  _check_type = kwargs.pop('_check_type', True)
@@ -188,7 +191,7 @@ class SetBidModel(ModelNormal):
188
191
 
189
192
  @convert_js_args_to_python_args
190
193
  def __init__(self, *args, **kwargs): # noqa: E501
191
- """SetBidModel - a model defined in OpenAPI
194
+ """DisplayAuctionMinBidRequest - a model defined in OpenAPI
192
195
 
193
196
  Keyword Args:
194
197
  _check_type (bool): if True, values for parameters in openapi_types
@@ -221,8 +224,8 @@ class SetBidModel(ModelNormal):
221
224
  Animal class but this time we won't travel
222
225
  through its discriminator because we passed in
223
226
  _visited_composed_classes = (Animal,)
224
- bid (float, none_type): [optional] # noqa: E501
225
- phrase (str, none_type): [optional] # noqa: E501
227
+ creative_ids ([str]): List of Creatives to use. [optional] # noqa: E501
228
+ product_ids ([str], none_type): List of potential product ids (SkuIds) to put in creatives. [optional] # noqa: E501
226
229
  """
227
230
 
228
231
  _check_type = kwargs.pop('_check_type', True)
@@ -29,12 +29,8 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
29
29
  from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
- def lazy_import():
33
- from criteo_api_retailmedia_preview.model.keyword_data_model import KeywordDataModel
34
- globals()['KeywordDataModel'] = KeywordDataModel
35
32
 
36
-
37
- class KeywordsModel(ModelNormal):
33
+ class DisplayAuctionMinBidResult(ModelNormal):
38
34
  """NOTE: This class is auto generated by OpenAPI Generator.
39
35
  Ref: https://openapi-generator.tech
40
36
 
@@ -59,6 +55,21 @@ class KeywordsModel(ModelNormal):
59
55
  """
60
56
 
61
57
  allowed_values = {
58
+ ('page_type',): {
59
+ 'None': None,
60
+ 'UNKNOWN': "unknown",
61
+ 'SEARCH': "search",
62
+ 'HOME': "home",
63
+ 'CHECKOUT': "checkout",
64
+ 'CATEGORY': "category",
65
+ 'PRODUCTDETAIL': "productDetail",
66
+ 'CONFIRMATION': "confirmation",
67
+ 'MERCHANDISING': "merchandising",
68
+ 'DEALS': "deals",
69
+ 'FAVORITES': "favorites",
70
+ 'SEARCHBAR': "searchBar",
71
+ 'CATEGORYMENU': "categoryMenu",
72
+ },
62
73
  }
63
74
 
64
75
  validations = {
@@ -78,10 +89,10 @@ class KeywordsModel(ModelNormal):
78
89
  openapi_types (dict): The key is attribute name
79
90
  and the value is attribute type.
80
91
  """
81
- lazy_import()
82
92
  return {
83
- 'keywords': ({str: (KeywordDataModel,)}, none_type,), # noqa: E501
84
- 'rank': ([str], none_type,), # noqa: E501
93
+ 'creative_id': (str, none_type,), # noqa: E501
94
+ 'min_bid': (float, none_type,), # noqa: E501
95
+ 'page_type': (str, none_type,), # noqa: E501
85
96
  }
86
97
 
87
98
  @cached_property
@@ -90,8 +101,9 @@ class KeywordsModel(ModelNormal):
90
101
 
91
102
 
92
103
  attribute_map = {
93
- 'keywords': 'keywords', # noqa: E501
94
- 'rank': 'rank', # noqa: E501
104
+ 'creative_id': 'creativeId', # noqa: E501
105
+ 'min_bid': 'minBid', # noqa: E501
106
+ 'page_type': 'pageType', # noqa: E501
95
107
  }
96
108
 
97
109
  read_only_vars = {
@@ -102,7 +114,7 @@ class KeywordsModel(ModelNormal):
102
114
  @classmethod
103
115
  @convert_js_args_to_python_args
104
116
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
105
- """KeywordsModel - a model defined in OpenAPI
117
+ """DisplayAuctionMinBidResult - a model defined in OpenAPI
106
118
 
107
119
  Keyword Args:
108
120
  _check_type (bool): if True, values for parameters in openapi_types
@@ -135,8 +147,9 @@ class KeywordsModel(ModelNormal):
135
147
  Animal class but this time we won't travel
136
148
  through its discriminator because we passed in
137
149
  _visited_composed_classes = (Animal,)
138
- keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501
139
- rank ([str], none_type): [optional] # noqa: E501
150
+ creative_id (str, none_type): The creativeId for the creative. [optional] # noqa: E501
151
+ min_bid (float, none_type): The minimum bid for the combination of page type, creative and categories. [optional] # noqa: E501
152
+ page_type (str, none_type): Page type for the creative to display on. [optional] # noqa: E501
140
153
  """
141
154
 
142
155
  _check_type = kwargs.pop('_check_type', True)
@@ -189,7 +202,7 @@ class KeywordsModel(ModelNormal):
189
202
 
190
203
  @convert_js_args_to_python_args
191
204
  def __init__(self, *args, **kwargs): # noqa: E501
192
- """KeywordsModel - a model defined in OpenAPI
205
+ """DisplayAuctionMinBidResult - a model defined in OpenAPI
193
206
 
194
207
  Keyword Args:
195
208
  _check_type (bool): if True, values for parameters in openapi_types
@@ -222,8 +235,9 @@ class KeywordsModel(ModelNormal):
222
235
  Animal class but this time we won't travel
223
236
  through its discriminator because we passed in
224
237
  _visited_composed_classes = (Animal,)
225
- keywords ({str: (KeywordDataModel,)}, none_type): [optional] # noqa: E501
226
- rank ([str], none_type): [optional] # noqa: E501
238
+ creative_id (str, none_type): The creativeId for the creative. [optional] # noqa: E501
239
+ min_bid (float, none_type): The minimum bid for the combination of page type, creative and categories. [optional] # noqa: E501
240
+ page_type (str, none_type): Page type for the creative to display on. [optional] # noqa: E501
227
241
  """
228
242
 
229
243
  _check_type = kwargs.pop('_check_type', True)
@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
- from criteo_api_retailmedia_preview.model.line_item_keyword_review_report import LineItemKeywordReviewReport
34
- globals()['LineItemKeywordReviewReport'] = LineItemKeywordReviewReport
33
+ from criteo_api_retailmedia_preview.model.external_retail_media_account_v2 import ExternalRetailMediaAccountV2
34
+ globals()['ExternalRetailMediaAccountV2'] = ExternalRetailMediaAccountV2
35
35
 
36
36
 
37
- class EntityResourceLineItemKeywordReviewReport(ModelNormal):
37
+ class EntityResourceOfRetailMediaAccountV2(ModelNormal):
38
38
  """NOTE: This class is auto generated by OpenAPI Generator.
39
39
  Ref: https://openapi-generator.tech
40
40
 
@@ -66,7 +66,7 @@ class EntityResourceLineItemKeywordReviewReport(ModelNormal):
66
66
 
67
67
  additional_properties_type = None
68
68
 
69
- _nullable = False
69
+ _nullable = True
70
70
 
71
71
  @cached_property
72
72
  def openapi_types():
@@ -80,7 +80,7 @@ class EntityResourceLineItemKeywordReviewReport(ModelNormal):
80
80
  """
81
81
  lazy_import()
82
82
  return {
83
- 'attributes': (LineItemKeywordReviewReport,), # noqa: E501
83
+ 'attributes': (ExternalRetailMediaAccountV2,), # noqa: E501
84
84
  'id': (str, none_type,), # noqa: E501
85
85
  'type': (str, none_type,), # noqa: E501
86
86
  }
@@ -104,7 +104,7 @@ class EntityResourceLineItemKeywordReviewReport(ModelNormal):
104
104
  @classmethod
105
105
  @convert_js_args_to_python_args
106
106
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
107
- """EntityResourceLineItemKeywordReviewReport - a model defined in OpenAPI
107
+ """EntityResourceOfRetailMediaAccountV2 - a model defined in OpenAPI
108
108
 
109
109
  Keyword Args:
110
110
  _check_type (bool): if True, values for parameters in openapi_types
@@ -137,7 +137,7 @@ class EntityResourceLineItemKeywordReviewReport(ModelNormal):
137
137
  Animal class but this time we won't travel
138
138
  through its discriminator because we passed in
139
139
  _visited_composed_classes = (Animal,)
140
- attributes (LineItemKeywordReviewReport): [optional] # noqa: E501
140
+ attributes (ExternalRetailMediaAccountV2): [optional] # noqa: E501
141
141
  id (str, none_type): Unique id of the entity.. [optional] # noqa: E501
142
142
  type (str, none_type): Type of the resource.. [optional] # noqa: E501
143
143
  """
@@ -192,7 +192,7 @@ class EntityResourceLineItemKeywordReviewReport(ModelNormal):
192
192
 
193
193
  @convert_js_args_to_python_args
194
194
  def __init__(self, *args, **kwargs): # noqa: E501
195
- """EntityResourceLineItemKeywordReviewReport - a model defined in OpenAPI
195
+ """EntityResourceOfRetailMediaAccountV2 - a model defined in OpenAPI
196
196
 
197
197
  Keyword Args:
198
198
  _check_type (bool): if True, values for parameters in openapi_types
@@ -225,7 +225,7 @@ class EntityResourceLineItemKeywordReviewReport(ModelNormal):
225
225
  Animal class but this time we won't travel
226
226
  through its discriminator because we passed in
227
227
  _visited_composed_classes = (Animal,)
228
- attributes (LineItemKeywordReviewReport): [optional] # noqa: E501
228
+ attributes (ExternalRetailMediaAccountV2): [optional] # noqa: E501
229
229
  id (str, none_type): Unique id of the entity.. [optional] # noqa: E501
230
230
  type (str, none_type): Type of the resource.. [optional] # noqa: E501
231
231
  """
@@ -30,13 +30,13 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
+ from criteo_api_retailmedia_preview.model.entity_resource_of_retail_media_account_v2 import EntityResourceOfRetailMediaAccountV2
33
34
  from criteo_api_retailmedia_preview.model.sdk_api_rest_common_problem import SdkApiRestCommonProblem
34
- from criteo_api_retailmedia_preview.model.value_resource_retail_media_keywords_review_result import ValueResourceRetailMediaKeywordsReviewResult
35
+ globals()['EntityResourceOfRetailMediaAccountV2'] = EntityResourceOfRetailMediaAccountV2
35
36
  globals()['SdkApiRestCommonProblem'] = SdkApiRestCommonProblem
36
- globals()['ValueResourceRetailMediaKeywordsReviewResult'] = ValueResourceRetailMediaKeywordsReviewResult
37
37
 
38
38
 
39
- class ValueResourceOutcomeRetailMediaKeywordsReviewResult(ModelNormal):
39
+ class EntityResourceOutcomeOfRetailMediaAccountV2(ModelNormal):
40
40
  """NOTE: This class is auto generated by OpenAPI Generator.
41
41
  Ref: https://openapi-generator.tech
42
42
 
@@ -82,7 +82,7 @@ class ValueResourceOutcomeRetailMediaKeywordsReviewResult(ModelNormal):
82
82
  """
83
83
  lazy_import()
84
84
  return {
85
- 'data': (ValueResourceRetailMediaKeywordsReviewResult,), # noqa: E501
85
+ 'data': (EntityResourceOfRetailMediaAccountV2,), # noqa: E501
86
86
  'errors': ([SdkApiRestCommonProblem], none_type,), # noqa: E501
87
87
  'warnings': ([SdkApiRestCommonProblem], none_type,), # noqa: E501
88
88
  }
@@ -108,7 +108,7 @@ class ValueResourceOutcomeRetailMediaKeywordsReviewResult(ModelNormal):
108
108
  @classmethod
109
109
  @convert_js_args_to_python_args
110
110
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
111
- """ValueResourceOutcomeRetailMediaKeywordsReviewResult - a model defined in OpenAPI
111
+ """EntityResourceOutcomeOfRetailMediaAccountV2 - a model defined in OpenAPI
112
112
 
113
113
  Keyword Args:
114
114
  _check_type (bool): if True, values for parameters in openapi_types
@@ -141,7 +141,7 @@ class ValueResourceOutcomeRetailMediaKeywordsReviewResult(ModelNormal):
141
141
  Animal class but this time we won't travel
142
142
  through its discriminator because we passed in
143
143
  _visited_composed_classes = (Animal,)
144
- data (ValueResourceRetailMediaKeywordsReviewResult): [optional] # noqa: E501
144
+ data (EntityResourceOfRetailMediaAccountV2): [optional] # noqa: E501
145
145
  errors ([SdkApiRestCommonProblem], none_type): Errors that occured during this call.. [optional] # noqa: E501
146
146
  warnings ([SdkApiRestCommonProblem], none_type): Warnings that occured during this call.. [optional] # noqa: E501
147
147
  """
@@ -196,7 +196,7 @@ class ValueResourceOutcomeRetailMediaKeywordsReviewResult(ModelNormal):
196
196
 
197
197
  @convert_js_args_to_python_args
198
198
  def __init__(self, *args, **kwargs): # noqa: E501
199
- """ValueResourceOutcomeRetailMediaKeywordsReviewResult - a model defined in OpenAPI
199
+ """EntityResourceOutcomeOfRetailMediaAccountV2 - a model defined in OpenAPI
200
200
 
201
201
  Keyword Args:
202
202
  _check_type (bool): if True, values for parameters in openapi_types
@@ -229,7 +229,7 @@ class ValueResourceOutcomeRetailMediaKeywordsReviewResult(ModelNormal):
229
229
  Animal class but this time we won't travel
230
230
  through its discriminator because we passed in
231
231
  _visited_composed_classes = (Animal,)
232
- data (ValueResourceRetailMediaKeywordsReviewResult): [optional] # noqa: E501
232
+ data (EntityResourceOfRetailMediaAccountV2): [optional] # noqa: E501
233
233
  errors ([SdkApiRestCommonProblem], none_type): Errors that occured during this call.. [optional] # noqa: E501
234
234
  warnings ([SdkApiRestCommonProblem], none_type): Warnings that occured during this call.. [optional] # noqa: E501
235
235
  """
@@ -0,0 +1,301 @@
1
+ """
2
+ Criteo API
3
+
4
+ Criteo API - RetailMedia # noqa: E501
5
+
6
+ The version of the OpenAPI document: Preview
7
+ Generated by: https://openapi-generator.tech
8
+ """
9
+
10
+
11
+ import re # noqa: F401
12
+ import sys # noqa: F401
13
+
14
+ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
15
+ ApiTypeError,
16
+ ModelComposed,
17
+ ModelNormal,
18
+ ModelSimple,
19
+ cached_property,
20
+ change_keys_js_to_python,
21
+ convert_js_args_to_python_args,
22
+ date,
23
+ datetime,
24
+ file_type,
25
+ none_type,
26
+ validate_get_composed_info,
27
+ OpenApiModel
28
+ )
29
+ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
+
31
+
32
+
33
+ class ExternalRetailMediaAccountV2(ModelNormal):
34
+ """NOTE: This class is auto generated by OpenAPI Generator.
35
+ Ref: https://openapi-generator.tech
36
+
37
+ Do not edit the class manually.
38
+
39
+ Attributes:
40
+ allowed_values (dict): The key is the tuple path to the attribute
41
+ and the for var_name this is (var_name,). The value is a dict
42
+ with a capitalized key describing the allowed value and an allowed
43
+ value. These dicts store the allowed enum values.
44
+ attribute_map (dict): The key is attribute name
45
+ and the value is json key in definition.
46
+ discriminator_value_class_map (dict): A dict to go from the discriminator
47
+ variable value to the discriminator class name.
48
+ validations (dict): The key is the tuple path to the attribute
49
+ and the for var_name this is (var_name,). The value is a dict
50
+ that stores validations for max_length, min_length, max_items,
51
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
52
+ inclusive_minimum, and regex.
53
+ additional_properties_type (tuple): A tuple of classes accepted
54
+ as additional properties values.
55
+ """
56
+
57
+ allowed_values = {
58
+ ('sub_type',): {
59
+ 'None': None,
60
+ 'UNKNOWN': "unknown",
61
+ 'BRAND': "brand",
62
+ 'SELLER': "seller",
63
+ },
64
+ ('type',): {
65
+ 'None': None,
66
+ 'UNKNOWN': "unknown",
67
+ 'SUPPLY': "supply",
68
+ 'DEMAND': "demand",
69
+ },
70
+ }
71
+
72
+ validations = {
73
+ }
74
+
75
+ additional_properties_type = None
76
+
77
+ _nullable = True
78
+
79
+ @cached_property
80
+ def openapi_types():
81
+ """
82
+ This must be a method because a model may have properties that are
83
+ of type self, this must run after the class is loaded
84
+
85
+ Returns
86
+ openapi_types (dict): The key is attribute name
87
+ and the value is attribute type.
88
+ """
89
+ return {
90
+ 'country_ids': ([str], none_type,), # noqa: E501
91
+ 'currency_id': (str, none_type,), # noqa: E501
92
+ 'name': (str, none_type,), # noqa: E501
93
+ 'on_behalf_company_name': (str, none_type,), # noqa: E501
94
+ 'parent_account_label': (str, none_type,), # noqa: E501
95
+ 'paying_company_name': (str, none_type,), # noqa: E501
96
+ 'sub_type': (str, none_type,), # noqa: E501
97
+ 'time_zone': (str, none_type,), # noqa: E501
98
+ 'type': (str, none_type,), # noqa: E501
99
+ }
100
+
101
+ @cached_property
102
+ def discriminator():
103
+ return None
104
+
105
+
106
+ attribute_map = {
107
+ 'country_ids': 'countryIds', # noqa: E501
108
+ 'currency_id': 'currencyId', # noqa: E501
109
+ 'name': 'name', # noqa: E501
110
+ 'on_behalf_company_name': 'onBehalfCompanyName', # noqa: E501
111
+ 'parent_account_label': 'parentAccountLabel', # noqa: E501
112
+ 'paying_company_name': 'payingCompanyName', # noqa: E501
113
+ 'sub_type': 'subType', # noqa: E501
114
+ 'time_zone': 'timeZone', # noqa: E501
115
+ 'type': 'type', # noqa: E501
116
+ }
117
+
118
+ read_only_vars = {
119
+ }
120
+
121
+ _composed_schemas = {}
122
+
123
+ @classmethod
124
+ @convert_js_args_to_python_args
125
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
126
+ """ExternalRetailMediaAccountV2 - a model defined in OpenAPI
127
+
128
+ Keyword Args:
129
+ _check_type (bool): if True, values for parameters in openapi_types
130
+ will be type checked and a TypeError will be
131
+ raised if the wrong type is input.
132
+ Defaults to True
133
+ _path_to_item (tuple/list): This is a list of keys or values to
134
+ drill down to the model in received_data
135
+ when deserializing a response
136
+ _spec_property_naming (bool): True if the variable names in the input data
137
+ are serialized names, as specified in the OpenAPI document.
138
+ False if the variable names in the input data
139
+ are pythonic names, e.g. snake case (default)
140
+ _configuration (Configuration): the instance to use when
141
+ deserializing a file_type parameter.
142
+ If passed, type conversion is attempted
143
+ If omitted no type conversion is done.
144
+ _visited_composed_classes (tuple): This stores a tuple of
145
+ classes that we have traveled through so that
146
+ if we see that class again we will not use its
147
+ discriminator again.
148
+ When traveling through a discriminator, the
149
+ composed schema that is
150
+ is traveled through is added to this set.
151
+ For example if Animal has a discriminator
152
+ petType and we pass in "Dog", and the class Dog
153
+ allOf includes Animal, we move through Animal
154
+ once using the discriminator, and pick Dog.
155
+ Then in Dog, we will make an instance of the
156
+ Animal class but this time we won't travel
157
+ through its discriminator because we passed in
158
+ _visited_composed_classes = (Animal,)
159
+ country_ids ([str], none_type): list of countries associated with the account. [optional] # noqa: E501
160
+ currency_id (str, none_type): the currency for the account. [optional] # noqa: E501
161
+ name (str, none_type): account name. [optional] # noqa: E501
162
+ on_behalf_company_name (str, none_type): On behalf entity name of ads for the Digital Services Act. [optional] # noqa: E501
163
+ parent_account_label (str, none_type): parent account label for the account. [optional] # noqa: E501
164
+ paying_company_name (str, none_type): Paying entity name of ads for the Digital Services Act. [optional] # noqa: E501
165
+ sub_type (str, none_type): subtype for the account. [optional] # noqa: E501
166
+ time_zone (str, none_type): the timezone for the account. [optional] # noqa: E501
167
+ type (str, none_type): Type for the account. [optional] # noqa: E501
168
+ """
169
+
170
+ _check_type = kwargs.pop('_check_type', True)
171
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
172
+ _path_to_item = kwargs.pop('_path_to_item', ())
173
+ _configuration = kwargs.pop('_configuration', None)
174
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
175
+
176
+ self = super(OpenApiModel, cls).__new__(cls)
177
+
178
+ if args:
179
+ for arg in args:
180
+ if isinstance(arg, dict):
181
+ kwargs.update(arg)
182
+ else:
183
+ raise ApiTypeError(
184
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
185
+ args,
186
+ self.__class__.__name__,
187
+ ),
188
+ path_to_item=_path_to_item,
189
+ valid_classes=(self.__class__,),
190
+ )
191
+
192
+ self._data_store = {}
193
+ self._check_type = _check_type
194
+ self._spec_property_naming = _spec_property_naming
195
+ self._path_to_item = _path_to_item
196
+ self._configuration = _configuration
197
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
198
+
199
+ for var_name, var_value in kwargs.items():
200
+ if var_name not in self.attribute_map and \
201
+ self._configuration is not None and \
202
+ self._configuration.discard_unknown_keys and \
203
+ self.additional_properties_type is None:
204
+ # discard variable.
205
+ continue
206
+ setattr(self, var_name, var_value)
207
+ return self
208
+
209
+ required_properties = set([
210
+ '_data_store',
211
+ '_check_type',
212
+ '_spec_property_naming',
213
+ '_path_to_item',
214
+ '_configuration',
215
+ '_visited_composed_classes',
216
+ ])
217
+
218
+ @convert_js_args_to_python_args
219
+ def __init__(self, *args, **kwargs): # noqa: E501
220
+ """ExternalRetailMediaAccountV2 - a model defined in OpenAPI
221
+
222
+ Keyword Args:
223
+ _check_type (bool): if True, values for parameters in openapi_types
224
+ will be type checked and a TypeError will be
225
+ raised if the wrong type is input.
226
+ Defaults to True
227
+ _path_to_item (tuple/list): This is a list of keys or values to
228
+ drill down to the model in received_data
229
+ when deserializing a response
230
+ _spec_property_naming (bool): True if the variable names in the input data
231
+ are serialized names, as specified in the OpenAPI document.
232
+ False if the variable names in the input data
233
+ are pythonic names, e.g. snake case (default)
234
+ _configuration (Configuration): the instance to use when
235
+ deserializing a file_type parameter.
236
+ If passed, type conversion is attempted
237
+ If omitted no type conversion is done.
238
+ _visited_composed_classes (tuple): This stores a tuple of
239
+ classes that we have traveled through so that
240
+ if we see that class again we will not use its
241
+ discriminator again.
242
+ When traveling through a discriminator, the
243
+ composed schema that is
244
+ is traveled through is added to this set.
245
+ For example if Animal has a discriminator
246
+ petType and we pass in "Dog", and the class Dog
247
+ allOf includes Animal, we move through Animal
248
+ once using the discriminator, and pick Dog.
249
+ Then in Dog, we will make an instance of the
250
+ Animal class but this time we won't travel
251
+ through its discriminator because we passed in
252
+ _visited_composed_classes = (Animal,)
253
+ country_ids ([str], none_type): list of countries associated with the account. [optional] # noqa: E501
254
+ currency_id (str, none_type): the currency for the account. [optional] # noqa: E501
255
+ name (str, none_type): account name. [optional] # noqa: E501
256
+ on_behalf_company_name (str, none_type): On behalf entity name of ads for the Digital Services Act. [optional] # noqa: E501
257
+ parent_account_label (str, none_type): parent account label for the account. [optional] # noqa: E501
258
+ paying_company_name (str, none_type): Paying entity name of ads for the Digital Services Act. [optional] # noqa: E501
259
+ sub_type (str, none_type): subtype for the account. [optional] # noqa: E501
260
+ time_zone (str, none_type): the timezone for the account. [optional] # noqa: E501
261
+ type (str, none_type): Type for the account. [optional] # noqa: E501
262
+ """
263
+
264
+ _check_type = kwargs.pop('_check_type', True)
265
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
266
+ _path_to_item = kwargs.pop('_path_to_item', ())
267
+ _configuration = kwargs.pop('_configuration', None)
268
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
269
+
270
+ if args:
271
+ for arg in args:
272
+ if isinstance(arg, dict):
273
+ kwargs.update(arg)
274
+ else:
275
+ raise ApiTypeError(
276
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
277
+ args,
278
+ self.__class__.__name__,
279
+ ),
280
+ path_to_item=_path_to_item,
281
+ valid_classes=(self.__class__,),
282
+ )
283
+
284
+ self._data_store = {}
285
+ self._check_type = _check_type
286
+ self._spec_property_naming = _spec_property_naming
287
+ self._path_to_item = _path_to_item
288
+ self._configuration = _configuration
289
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
290
+
291
+ for var_name, var_value in kwargs.items():
292
+ if var_name not in self.attribute_map and \
293
+ self._configuration is not None and \
294
+ self._configuration.discard_unknown_keys and \
295
+ self.additional_properties_type is None:
296
+ # discard variable.
297
+ continue
298
+ setattr(self, var_name, var_value)
299
+ if var_name in self.read_only_vars:
300
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
301
+ f"class with read only attributes.")