criteo-api-retailmedia-sdk 0.0.240808__py3-none-any.whl → 0.0.250129__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +45 -198
  3. criteo_api_retailmedia_preview/api/analytics_api.py +3 -3
  4. criteo_api_retailmedia_preview/api/audience_api.py +89 -232
  5. criteo_api_retailmedia_preview/api/balance_api.py +0 -159
  6. criteo_api_retailmedia_preview/api/campaign_api.py +246 -1604
  7. criteo_api_retailmedia_preview/api/catalog_api.py +161 -0
  8. criteo_api_retailmedia_preview/api/on_site_recommendation_api.py +186 -0
  9. criteo_api_retailmedia_preview/api_client.py +4 -4
  10. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  11. criteo_api_retailmedia_preview/configuration.py +1 -1
  12. criteo_api_retailmedia_preview/model/async_accounts_report.py +40 -0
  13. criteo_api_retailmedia_preview/model/async_campaigns_report.py +40 -0
  14. criteo_api_retailmedia_preview/model/async_line_items_report.py +40 -0
  15. criteo_api_retailmedia_preview/model/balance_response_v2_response.py +1 -1
  16. criteo_api_retailmedia_preview/model/{creative_v2_response.py → bot_message.py} +17 -21
  17. criteo_api_retailmedia_preview/model/botmessage.py +329 -0
  18. criteo_api_retailmedia_preview/model/brand_id_search_request.py +271 -0
  19. criteo_api_retailmedia_preview/model/{external_retailer.py → brand_id_search_result.py} +26 -26
  20. criteo_api_retailmedia_preview/model/category.py +3 -3
  21. criteo_api_retailmedia_preview/model/change_details_v1.py +8 -18
  22. criteo_api_retailmedia_preview/model/{external_choice_variable_value.py → choice_variable_value.py} +4 -10
  23. criteo_api_retailmedia_preview/model/{external_color_variable_value.py → color_variable_value.py} +5 -11
  24. criteo_api_retailmedia_preview/model/{sku_search_request.py → cpc_min_bids_request.py} +11 -16
  25. criteo_api_retailmedia_preview/model/{page_of_insertion_order_history_change_data_capture_v2.py → cpc_min_bids_response.py} +19 -21
  26. criteo_api_retailmedia_preview/model/cpc_rate_card_preview.py +6 -6
  27. criteo_api_retailmedia_preview/model/{external_creative_v2.py → creative2.py} +23 -30
  28. criteo_api_retailmedia_preview/model/{resource_outcome_of_retail_media_account.py → creative2_list_response.py} +9 -9
  29. criteo_api_retailmedia_preview/model/{resource_collection_outcome_of_sku_search_result.py → creative2_response.py} +9 -9
  30. criteo_api_retailmedia_preview/model/{external_creative_create_model_v2.py → creative_create_model2.py} +9 -16
  31. criteo_api_retailmedia_preview/model/{external_creative_update_model_v2.py → creative_update_model2.py} +9 -16
  32. criteo_api_retailmedia_preview/model/{resource_of_retail_media_account.py → entity_resource_brand_id_search_result.py} +13 -13
  33. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_campaign_budget_overrides.py → entity_resource_collection_outcome_brand_id_search_result.py} +16 -16
  34. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_list_response.py → entity_resource_collection_outcome_of_retail_media_child_account.py} +15 -9
  35. criteo_api_retailmedia_preview/model/{resource_of_add_funds_to_balance_v2.py → entity_resource_of_retail_media_child_account.py} +14 -14
  36. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +1 -1
  37. criteo_api_retailmedia_preview/model/{external_account.py → external_retail_media_child_account.py} +39 -56
  38. criteo_api_retailmedia_preview/model/{external_files_variable_value.py → files_variable_value.py} +4 -10
  39. criteo_api_retailmedia_preview/model/http_validation_error.py +269 -0
  40. criteo_api_retailmedia_preview/model/{external_hyperlink_variable_value.py → hyperlink_variable_value.py} +5 -11
  41. criteo_api_retailmedia_preview/model/inbot_discussion.py +272 -0
  42. criteo_api_retailmedia_preview/model/{external_brand.py → inbot_discussion_body_model.py} +17 -15
  43. criteo_api_retailmedia_preview/model/inbot_discussion_data_instance_model.py +279 -0
  44. criteo_api_retailmedia_preview/model/json_api_request_of_seller_catalog_request.py +1 -1
  45. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_request.py +1 -1
  46. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py +1 -1
  47. criteo_api_retailmedia_preview/model/{external_text_variable_value.py → location_inner.py} +3 -7
  48. criteo_api_retailmedia_preview/model/message.py +273 -0
  49. criteo_api_retailmedia_preview/model/message_body_model.py +275 -0
  50. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_retailer_and_retailer.py → message_data_instance_model.py} +16 -22
  51. criteo_api_retailmedia_preview/model/message_error.py +275 -0
  52. criteo_api_retailmedia_preview/model/{rm_legacy_segment_customer_list.py → offset_page_metadata.py} +21 -17
  53. criteo_api_retailmedia_preview/model/{resource_of_sku_search_result.py → outcome.py} +15 -17
  54. criteo_api_retailmedia_preview/model/{external_page_type_environment.py → page_type_environment2.py} +4 -10
  55. criteo_api_retailmedia_preview/model/placement_preview.py +4 -0
  56. criteo_api_retailmedia_preview/model/product.py +4 -0
  57. criteo_api_retailmedia_preview/model/product_recommendation.py +305 -0
  58. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_account_and_account.py → report_detail_warning.py} +21 -21
  59. criteo_api_retailmedia_preview/model/report_detail_warnings.py +281 -0
  60. criteo_api_retailmedia_preview/model/report_ok_response.py +31 -17
  61. criteo_api_retailmedia_preview/model/{proposal_status_model_resource.py → resource_of_creative2.py} +14 -14
  62. criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.py +1 -1
  63. criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py +1 -1
  64. criteo_api_retailmedia_preview/model/retail_media_seller.py +4 -0
  65. criteo_api_retailmedia_preview/model/rm_algebra_node_v1.py +275 -0
  66. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_resource.py → rm_audience_entity_v1.py} +45 -24
  67. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_resource.py → rm_audience_entity_v1_resource.py} +8 -8
  68. criteo_api_retailmedia_preview/model/{creative_v2_list_response.py → rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response.py} +14 -8
  69. criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1.py +271 -0
  70. criteo_api_retailmedia_preview/model/{resource_of_creative_v2.py → rm_audience_search_entity_v1_resource.py} +11 -15
  71. criteo_api_retailmedia_preview/model/{add_funds_to_balance_v2_request.py → rm_audience_search_input_v1.py} +8 -8
  72. criteo_api_retailmedia_preview/model/rm_audience_search_metadata_v1.py +271 -0
  73. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +17 -9
  74. criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1.py +7 -7
  75. criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +1 -1
  76. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +5 -5
  77. criteo_api_retailmedia_preview/model/{rm_user_behavior_v1.py → rm_events_v1.py} +3 -3
  78. criteo_api_retailmedia_preview/model/{retail_media_account.py → sdk_api_rest_common_problem.py} +41 -42
  79. criteo_api_retailmedia_preview/model/seller_catalog_request.py +1 -1
  80. criteo_api_retailmedia_preview/model/{sku_search_request_body.py → seller_search.py} +18 -25
  81. criteo_api_retailmedia_preview/model/sku_data_preview.py +27 -27
  82. criteo_api_retailmedia_preview/model/sku_min_bid.py +269 -0
  83. criteo_api_retailmedia_preview/model/sku_slim_data_v2.py +9 -13
  84. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +4 -0
  85. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +1 -11
  86. criteo_api_retailmedia_preview/model/sync_line_items_report.py +1 -11
  87. criteo_api_retailmedia_preview/model/{external_template_variable_value.py → template_variable_value.py} +36 -43
  88. criteo_api_retailmedia_preview/model/text_variable_value.py +257 -0
  89. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_brand_and_brand.py → validation_error.py} +19 -17
  90. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller_account_creation.py → value_resource_brand_id_search_request.py} +10 -10
  91. criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_retail_media_seller.py +8 -8
  92. criteo_api_retailmedia_preview/model/{value_resource_of_campaign_budget_overrides.py → value_resource_cpc_min_bids_request.py} +10 -10
  93. criteo_api_retailmedia_preview/model/{value_resource_of_line_item_budget_overrides.py → value_resource_cpc_min_bids_response.py} +10 -10
  94. criteo_api_retailmedia_preview/model/{value_resource_input_of_line_item_budget_overrides.py → value_resource_input_brand_id_search_request.py} +8 -8
  95. criteo_api_retailmedia_preview/model/{value_resource_collection_input_of_retail_media_seller.py → value_resource_input_cpc_min_bids_request.py} +8 -8
  96. criteo_api_retailmedia_preview/model/{value_resource_input_of_campaign_budget_overrides.py → value_resource_input_of_seller_search.py} +8 -8
  97. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller.py +2 -2
  98. criteo_api_retailmedia_preview/model/value_resource_of_seller_search.py +266 -0
  99. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_line_item_budget_overrides.py → value_resource_outcome_cpc_min_bids_response.py} +16 -16
  100. criteo_api_retailmedia_preview/model/{external_video_variable_value.py → video_variable_value.py} +4 -10
  101. criteo_api_retailmedia_preview/models/__init__.py +60 -69
  102. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/METADATA +14 -5
  103. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/RECORD +105 -113
  104. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/WHEEL +1 -1
  105. criteo_api_retailmedia_preview/model/add_funds_to_balance_v2.py +0 -277
  106. criteo_api_retailmedia_preview/model/approval_status_model.py +0 -292
  107. criteo_api_retailmedia_preview/model/campaign_budget_overrides.py +0 -276
  108. criteo_api_retailmedia_preview/model/campaign_daily_budget_override.py +0 -283
  109. criteo_api_retailmedia_preview/model/campaign_monthly_budget_override.py +0 -283
  110. criteo_api_retailmedia_preview/model/change_details_v2.py +0 -275
  111. criteo_api_retailmedia_preview/model/daily_line_item_budget_override.py +0 -281
  112. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture_v2.py +0 -303
  113. criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py +0 -295
  114. criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py +0 -295
  115. criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py +0 -295
  116. criteo_api_retailmedia_preview/model/line_item_budget_overrides.py +0 -276
  117. criteo_api_retailmedia_preview/model/monthly_line_item_budeget_override.py +0 -283
  118. criteo_api_retailmedia_preview/model/negotiation_state_model.py +0 -293
  119. criteo_api_retailmedia_preview/model/proposal_status_model.py +0 -284
  120. criteo_api_retailmedia_preview/model/proposal_status_model_response.py +0 -274
  121. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +0 -270
  122. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v1.py +0 -291
  123. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2.py +0 -291
  124. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2_list_response.py +0 -281
  125. criteo_api_retailmedia_preview/model/rm_legacy_audience_user_behavior_details_v2.py +0 -279
  126. criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v1.py +0 -306
  127. criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v2.py +0 -311
  128. criteo_api_retailmedia_preview/model/sku_search_result.py +0 -313
  129. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +0 -262
  130. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/top_level.txt +0 -0
@@ -1,270 +0,0 @@
1
- """
2
- Criteo API
3
-
4
- Criteo API - RetailMedia # noqa: E501
5
-
6
- The version of the OpenAPI document: Preview
7
- Generated by: https://openapi-generator.tech
8
- """
9
-
10
-
11
- import re # noqa: F401
12
- import sys # noqa: F401
13
-
14
- from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
15
- ApiTypeError,
16
- ModelComposed,
17
- ModelNormal,
18
- ModelSimple,
19
- cached_property,
20
- change_keys_js_to_python,
21
- convert_js_args_to_python_args,
22
- date,
23
- datetime,
24
- file_type,
25
- none_type,
26
- validate_get_composed_info,
27
- OpenApiModel
28
- )
29
- from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
-
31
-
32
- def lazy_import():
33
- from criteo_api_retailmedia_preview.model.retail_media_seller import RetailMediaSeller
34
- globals()['RetailMediaSeller'] = RetailMediaSeller
35
-
36
-
37
- class RetailMediaSellerAccountCreation(ModelNormal):
38
- """NOTE: This class is auto generated by OpenAPI Generator.
39
- Ref: https://openapi-generator.tech
40
-
41
- Do not edit the class manually.
42
-
43
- Attributes:
44
- allowed_values (dict): The key is the tuple path to the attribute
45
- and the for var_name this is (var_name,). The value is a dict
46
- with a capitalized key describing the allowed value and an allowed
47
- value. These dicts store the allowed enum values.
48
- attribute_map (dict): The key is attribute name
49
- and the value is json key in definition.
50
- discriminator_value_class_map (dict): A dict to go from the discriminator
51
- variable value to the discriminator class name.
52
- validations (dict): The key is the tuple path to the attribute
53
- and the for var_name this is (var_name,). The value is a dict
54
- that stores validations for max_length, min_length, max_items,
55
- min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
56
- inclusive_minimum, and regex.
57
- additional_properties_type (tuple): A tuple of classes accepted
58
- as additional properties values.
59
- """
60
-
61
- allowed_values = {
62
- }
63
-
64
- validations = {
65
- }
66
-
67
- additional_properties_type = None
68
-
69
- _nullable = False
70
-
71
- @cached_property
72
- def openapi_types():
73
- """
74
- This must be a method because a model may have properties that are
75
- of type self, this must run after the class is loaded
76
-
77
- Returns
78
- openapi_types (dict): The key is attribute name
79
- and the value is attribute type.
80
- """
81
- lazy_import()
82
- return {
83
- 'name': (str, none_type,), # noqa: E501
84
- 'company_name': (str, none_type,), # noqa: E501
85
- 'sellers': ([RetailMediaSeller], none_type,), # noqa: E501
86
- }
87
-
88
- @cached_property
89
- def discriminator():
90
- return None
91
-
92
-
93
- attribute_map = {
94
- 'name': 'name', # noqa: E501
95
- 'company_name': 'companyName', # noqa: E501
96
- 'sellers': 'sellers', # noqa: E501
97
- }
98
-
99
- read_only_vars = {
100
- }
101
-
102
- _composed_schemas = {}
103
-
104
- @classmethod
105
- @convert_js_args_to_python_args
106
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
107
- """RetailMediaSellerAccountCreation - a model defined in OpenAPI
108
-
109
- Keyword Args:
110
- _check_type (bool): if True, values for parameters in openapi_types
111
- will be type checked and a TypeError will be
112
- raised if the wrong type is input.
113
- Defaults to True
114
- _path_to_item (tuple/list): This is a list of keys or values to
115
- drill down to the model in received_data
116
- when deserializing a response
117
- _spec_property_naming (bool): True if the variable names in the input data
118
- are serialized names, as specified in the OpenAPI document.
119
- False if the variable names in the input data
120
- are pythonic names, e.g. snake case (default)
121
- _configuration (Configuration): the instance to use when
122
- deserializing a file_type parameter.
123
- If passed, type conversion is attempted
124
- If omitted no type conversion is done.
125
- _visited_composed_classes (tuple): This stores a tuple of
126
- classes that we have traveled through so that
127
- if we see that class again we will not use its
128
- discriminator again.
129
- When traveling through a discriminator, the
130
- composed schema that is
131
- is traveled through is added to this set.
132
- For example if Animal has a discriminator
133
- petType and we pass in "Dog", and the class Dog
134
- allOf includes Animal, we move through Animal
135
- once using the discriminator, and pick Dog.
136
- Then in Dog, we will make an instance of the
137
- Animal class but this time we won't travel
138
- through its discriminator because we passed in
139
- _visited_composed_classes = (Animal,)
140
- name (str, none_type): the name of the account, must be unique across all accounts. [optional] # noqa: E501
141
- 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
142
- sellers ([RetailMediaSeller], none_type): list of sellers to associate to the new account. [optional] # noqa: E501
143
- """
144
-
145
- _check_type = kwargs.pop('_check_type', True)
146
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
147
- _path_to_item = kwargs.pop('_path_to_item', ())
148
- _configuration = kwargs.pop('_configuration', None)
149
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
150
-
151
- self = super(OpenApiModel, cls).__new__(cls)
152
-
153
- if args:
154
- for arg in args:
155
- if isinstance(arg, dict):
156
- kwargs.update(arg)
157
- else:
158
- raise ApiTypeError(
159
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
160
- args,
161
- self.__class__.__name__,
162
- ),
163
- path_to_item=_path_to_item,
164
- valid_classes=(self.__class__,),
165
- )
166
-
167
- self._data_store = {}
168
- self._check_type = _check_type
169
- self._spec_property_naming = _spec_property_naming
170
- self._path_to_item = _path_to_item
171
- self._configuration = _configuration
172
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
173
-
174
- for var_name, var_value in kwargs.items():
175
- if var_name not in self.attribute_map and \
176
- self._configuration is not None and \
177
- self._configuration.discard_unknown_keys and \
178
- self.additional_properties_type is None:
179
- # discard variable.
180
- continue
181
- setattr(self, var_name, var_value)
182
- return self
183
-
184
- required_properties = set([
185
- '_data_store',
186
- '_check_type',
187
- '_spec_property_naming',
188
- '_path_to_item',
189
- '_configuration',
190
- '_visited_composed_classes',
191
- ])
192
-
193
- @convert_js_args_to_python_args
194
- def __init__(self, *args, **kwargs): # noqa: E501
195
- """RetailMediaSellerAccountCreation - a model defined in OpenAPI
196
-
197
- Keyword Args:
198
- _check_type (bool): if True, values for parameters in openapi_types
199
- will be type checked and a TypeError will be
200
- raised if the wrong type is input.
201
- Defaults to True
202
- _path_to_item (tuple/list): This is a list of keys or values to
203
- drill down to the model in received_data
204
- when deserializing a response
205
- _spec_property_naming (bool): True if the variable names in the input data
206
- are serialized names, as specified in the OpenAPI document.
207
- False if the variable names in the input data
208
- are pythonic names, e.g. snake case (default)
209
- _configuration (Configuration): the instance to use when
210
- deserializing a file_type parameter.
211
- If passed, type conversion is attempted
212
- If omitted no type conversion is done.
213
- _visited_composed_classes (tuple): This stores a tuple of
214
- classes that we have traveled through so that
215
- if we see that class again we will not use its
216
- discriminator again.
217
- When traveling through a discriminator, the
218
- composed schema that is
219
- is traveled through is added to this set.
220
- For example if Animal has a discriminator
221
- petType and we pass in "Dog", and the class Dog
222
- allOf includes Animal, we move through Animal
223
- once using the discriminator, and pick Dog.
224
- Then in Dog, we will make an instance of the
225
- Animal class but this time we won't travel
226
- through its discriminator because we passed in
227
- _visited_composed_classes = (Animal,)
228
- name (str, none_type): the name of the account, must be unique across all accounts. [optional] # noqa: E501
229
- 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
230
- sellers ([RetailMediaSeller], none_type): list of sellers to associate to the new account. [optional] # noqa: E501
231
- """
232
-
233
- _check_type = kwargs.pop('_check_type', True)
234
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
235
- _path_to_item = kwargs.pop('_path_to_item', ())
236
- _configuration = kwargs.pop('_configuration', None)
237
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
238
-
239
- if args:
240
- for arg in args:
241
- if isinstance(arg, dict):
242
- kwargs.update(arg)
243
- else:
244
- raise ApiTypeError(
245
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
246
- args,
247
- self.__class__.__name__,
248
- ),
249
- path_to_item=_path_to_item,
250
- valid_classes=(self.__class__,),
251
- )
252
-
253
- self._data_store = {}
254
- self._check_type = _check_type
255
- self._spec_property_naming = _spec_property_naming
256
- self._path_to_item = _path_to_item
257
- self._configuration = _configuration
258
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
259
-
260
- for var_name, var_value in kwargs.items():
261
- if var_name not in self.attribute_map and \
262
- self._configuration is not None and \
263
- self._configuration.discard_unknown_keys and \
264
- self.additional_properties_type is None:
265
- # discard variable.
266
- continue
267
- setattr(self, var_name, var_value)
268
- if var_name in self.read_only_vars:
269
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
270
- f"class with read only attributes.")
@@ -1,291 +0,0 @@
1
- """
2
- Criteo API
3
-
4
- Criteo API - RetailMedia # noqa: E501
5
-
6
- The version of the OpenAPI document: Preview
7
- Generated by: https://openapi-generator.tech
8
- """
9
-
10
-
11
- import re # noqa: F401
12
- import sys # noqa: F401
13
-
14
- from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
15
- ApiTypeError,
16
- ModelComposed,
17
- ModelNormal,
18
- ModelSimple,
19
- cached_property,
20
- change_keys_js_to_python,
21
- convert_js_args_to_python_args,
22
- date,
23
- datetime,
24
- file_type,
25
- none_type,
26
- validate_get_composed_info,
27
- OpenApiModel
28
- )
29
- from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
-
31
-
32
- def lazy_import():
33
- from criteo_api_retailmedia_preview.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList
34
- from criteo_api_retailmedia_preview.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1
35
- globals()['RmLegacySegmentCustomerList'] = RmLegacySegmentCustomerList
36
- globals()['RmLegacySegmentUserBehaviorV1'] = RmLegacySegmentUserBehaviorV1
37
-
38
-
39
- class RmLegacyAudienceGetEntityV1(ModelNormal):
40
- """NOTE: This class is auto generated by OpenAPI Generator.
41
- Ref: https://openapi-generator.tech
42
-
43
- Do not edit the class manually.
44
-
45
- Attributes:
46
- allowed_values (dict): The key is the tuple path to the attribute
47
- and the for var_name this is (var_name,). The value is a dict
48
- with a capitalized key describing the allowed value and an allowed
49
- value. These dicts store the allowed enum values.
50
- attribute_map (dict): The key is attribute name
51
- and the value is json key in definition.
52
- discriminator_value_class_map (dict): A dict to go from the discriminator
53
- variable value to the discriminator class name.
54
- validations (dict): The key is the tuple path to the attribute
55
- and the for var_name this is (var_name,). The value is a dict
56
- that stores validations for max_length, min_length, max_items,
57
- min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
58
- inclusive_minimum, and regex.
59
- additional_properties_type (tuple): A tuple of classes accepted
60
- as additional properties values.
61
- """
62
-
63
- allowed_values = {
64
- }
65
-
66
- validations = {
67
- }
68
-
69
- @cached_property
70
- def additional_properties_type():
71
- """
72
- This must be a method because a model may have properties that are
73
- of type self, this must run after the class is loaded
74
- """
75
- lazy_import()
76
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
77
-
78
- _nullable = False
79
-
80
- @cached_property
81
- def openapi_types():
82
- """
83
- This must be a method because a model may have properties that are
84
- of type self, this must run after the class is loaded
85
-
86
- Returns
87
- openapi_types (dict): The key is attribute name
88
- and the value is attribute type.
89
- """
90
- lazy_import()
91
- return {
92
- 'name': (str,), # noqa: E501
93
- 'retailer_id': (str,), # noqa: E501
94
- 'user_behavior_details': (RmLegacySegmentUserBehaviorV1,), # noqa: E501
95
- 'customer_list_details': (RmLegacySegmentCustomerList,), # noqa: E501
96
- }
97
-
98
- @cached_property
99
- def discriminator():
100
- return None
101
-
102
-
103
- attribute_map = {
104
- 'name': 'name', # noqa: E501
105
- 'retailer_id': 'retailerId', # noqa: E501
106
- 'user_behavior_details': 'userBehaviorDetails', # noqa: E501
107
- 'customer_list_details': 'customerListDetails', # noqa: E501
108
- }
109
-
110
- read_only_vars = {
111
- }
112
-
113
- _composed_schemas = {}
114
-
115
- @classmethod
116
- @convert_js_args_to_python_args
117
- def _from_openapi_data(cls, name, retailer_id, *args, **kwargs): # noqa: E501
118
- """RmLegacyAudienceGetEntityV1 - a model defined in OpenAPI
119
-
120
- Args:
121
- name (str): Name of the audience
122
- retailer_id (str): ID of the retailer associated with this audience
123
-
124
- Keyword Args:
125
- _check_type (bool): if True, values for parameters in openapi_types
126
- will be type checked and a TypeError will be
127
- raised if the wrong type is input.
128
- Defaults to True
129
- _path_to_item (tuple/list): This is a list of keys or values to
130
- drill down to the model in received_data
131
- when deserializing a response
132
- _spec_property_naming (bool): True if the variable names in the input data
133
- are serialized names, as specified in the OpenAPI document.
134
- False if the variable names in the input data
135
- are pythonic names, e.g. snake case (default)
136
- _configuration (Configuration): the instance to use when
137
- deserializing a file_type parameter.
138
- If passed, type conversion is attempted
139
- If omitted no type conversion is done.
140
- _visited_composed_classes (tuple): This stores a tuple of
141
- classes that we have traveled through so that
142
- if we see that class again we will not use its
143
- discriminator again.
144
- When traveling through a discriminator, the
145
- composed schema that is
146
- is traveled through is added to this set.
147
- For example if Animal has a discriminator
148
- petType and we pass in "Dog", and the class Dog
149
- allOf includes Animal, we move through Animal
150
- once using the discriminator, and pick Dog.
151
- Then in Dog, we will make an instance of the
152
- Animal class but this time we won't travel
153
- through its discriminator because we passed in
154
- _visited_composed_classes = (Animal,)
155
- user_behavior_details (RmLegacySegmentUserBehaviorV1): [optional] # noqa: E501
156
- customer_list_details (RmLegacySegmentCustomerList): [optional] # noqa: E501
157
- """
158
-
159
- _check_type = kwargs.pop('_check_type', True)
160
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
161
- _path_to_item = kwargs.pop('_path_to_item', ())
162
- _configuration = kwargs.pop('_configuration', None)
163
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
164
-
165
- self = super(OpenApiModel, cls).__new__(cls)
166
-
167
- if args:
168
- for arg in args:
169
- if isinstance(arg, dict):
170
- kwargs.update(arg)
171
- else:
172
- raise ApiTypeError(
173
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
174
- args,
175
- self.__class__.__name__,
176
- ),
177
- path_to_item=_path_to_item,
178
- valid_classes=(self.__class__,),
179
- )
180
-
181
- self._data_store = {}
182
- self._check_type = _check_type
183
- self._spec_property_naming = _spec_property_naming
184
- self._path_to_item = _path_to_item
185
- self._configuration = _configuration
186
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
187
-
188
- self.name = name
189
- self.retailer_id = retailer_id
190
- for var_name, var_value in kwargs.items():
191
- if var_name not in self.attribute_map and \
192
- self._configuration is not None and \
193
- self._configuration.discard_unknown_keys and \
194
- self.additional_properties_type is None:
195
- # discard variable.
196
- continue
197
- setattr(self, var_name, var_value)
198
- return self
199
-
200
- required_properties = set([
201
- '_data_store',
202
- '_check_type',
203
- '_spec_property_naming',
204
- '_path_to_item',
205
- '_configuration',
206
- '_visited_composed_classes',
207
- ])
208
-
209
- @convert_js_args_to_python_args
210
- def __init__(self, name, retailer_id, *args, **kwargs): # noqa: E501
211
- """RmLegacyAudienceGetEntityV1 - a model defined in OpenAPI
212
-
213
- Args:
214
- name (str): Name of the audience
215
- retailer_id (str): ID of the retailer associated with this audience
216
-
217
- Keyword Args:
218
- _check_type (bool): if True, values for parameters in openapi_types
219
- will be type checked and a TypeError will be
220
- raised if the wrong type is input.
221
- Defaults to True
222
- _path_to_item (tuple/list): This is a list of keys or values to
223
- drill down to the model in received_data
224
- when deserializing a response
225
- _spec_property_naming (bool): True if the variable names in the input data
226
- are serialized names, as specified in the OpenAPI document.
227
- False if the variable names in the input data
228
- are pythonic names, e.g. snake case (default)
229
- _configuration (Configuration): the instance to use when
230
- deserializing a file_type parameter.
231
- If passed, type conversion is attempted
232
- If omitted no type conversion is done.
233
- _visited_composed_classes (tuple): This stores a tuple of
234
- classes that we have traveled through so that
235
- if we see that class again we will not use its
236
- discriminator again.
237
- When traveling through a discriminator, the
238
- composed schema that is
239
- is traveled through is added to this set.
240
- For example if Animal has a discriminator
241
- petType and we pass in "Dog", and the class Dog
242
- allOf includes Animal, we move through Animal
243
- once using the discriminator, and pick Dog.
244
- Then in Dog, we will make an instance of the
245
- Animal class but this time we won't travel
246
- through its discriminator because we passed in
247
- _visited_composed_classes = (Animal,)
248
- user_behavior_details (RmLegacySegmentUserBehaviorV1): [optional] # noqa: E501
249
- customer_list_details (RmLegacySegmentCustomerList): [optional] # noqa: E501
250
- """
251
-
252
- _check_type = kwargs.pop('_check_type', True)
253
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
254
- _path_to_item = kwargs.pop('_path_to_item', ())
255
- _configuration = kwargs.pop('_configuration', None)
256
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
257
-
258
- if args:
259
- for arg in args:
260
- if isinstance(arg, dict):
261
- kwargs.update(arg)
262
- else:
263
- raise ApiTypeError(
264
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
265
- args,
266
- self.__class__.__name__,
267
- ),
268
- path_to_item=_path_to_item,
269
- valid_classes=(self.__class__,),
270
- )
271
-
272
- self._data_store = {}
273
- self._check_type = _check_type
274
- self._spec_property_naming = _spec_property_naming
275
- self._path_to_item = _path_to_item
276
- self._configuration = _configuration
277
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
278
-
279
- self.name = name
280
- self.retailer_id = retailer_id
281
- for var_name, var_value in kwargs.items():
282
- if var_name not in self.attribute_map and \
283
- self._configuration is not None and \
284
- self._configuration.discard_unknown_keys and \
285
- self.additional_properties_type is None:
286
- # discard variable.
287
- continue
288
- setattr(self, var_name, var_value)
289
- if var_name in self.read_only_vars:
290
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
291
- f"class with read only attributes.")