criteo-api-retailmedia-sdk 0.0.241029__py3-none-any.whl → 0.0.250205__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 (99) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +23 -324
  3. criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
  4. criteo_api_retailmedia_preview/api/balance_api.py +0 -159
  5. criteo_api_retailmedia_preview/api/campaign_api.py +226 -859
  6. criteo_api_retailmedia_preview/api/on_site_recommendation_api.py +0 -1
  7. criteo_api_retailmedia_preview/api_client.py +4 -4
  8. criteo_api_retailmedia_preview/configuration.py +1 -1
  9. criteo_api_retailmedia_preview/model/async_accounts_report.py +44 -0
  10. criteo_api_retailmedia_preview/model/async_campaigns_report.py +44 -0
  11. criteo_api_retailmedia_preview/model/{retail_media_contactlist_amendment_attributes.py → async_fill_rate_report.py} +80 -31
  12. criteo_api_retailmedia_preview/model/{add_funds_to_balance_v2_request.py → async_fill_rate_report_request.py} +8 -8
  13. criteo_api_retailmedia_preview/model/{http_validation_error.py → async_fill_rate_report_resource.py} +13 -9
  14. criteo_api_retailmedia_preview/model/async_line_items_report.py +44 -0
  15. criteo_api_retailmedia_preview/model/balance_response_v2_response.py +1 -1
  16. criteo_api_retailmedia_preview/model/{resource_of_sku_search_result.py → brand_id_search_request.py} +21 -20
  17. criteo_api_retailmedia_preview/model/{external_retailer.py → brand_id_search_result.py} +26 -26
  18. criteo_api_retailmedia_preview/model/category.py +3 -3
  19. criteo_api_retailmedia_preview/model/change_details_v1.py +8 -18
  20. criteo_api_retailmedia_preview/model/{external_choice_variable_value.py → choice_variable_value.py} +4 -10
  21. criteo_api_retailmedia_preview/model/{external_color_variable_value.py → color_variable_value.py} +5 -11
  22. criteo_api_retailmedia_preview/model/{sku_search_request.py → cpc_min_bids_request.py} +11 -16
  23. criteo_api_retailmedia_preview/model/{page_of_insertion_order_history_change_data_capture_v2.py → cpc_min_bids_response.py} +19 -21
  24. criteo_api_retailmedia_preview/model/cpc_rate_card_preview.py +6 -6
  25. criteo_api_retailmedia_preview/model/{external_creative_v2.py → creative2.py} +23 -30
  26. criteo_api_retailmedia_preview/model/{resource_outcome_of_retail_media_account.py → creative2_list_response.py} +9 -9
  27. criteo_api_retailmedia_preview/model/{resource_collection_outcome_of_sku_search_result.py → creative2_response.py} +9 -9
  28. criteo_api_retailmedia_preview/model/{external_creative_create_model_v2.py → creative_create_model2.py} +9 -16
  29. criteo_api_retailmedia_preview/model/{external_creative_update_model_v2.py → creative_update_model2.py} +9 -16
  30. criteo_api_retailmedia_preview/model/{resource_of_retail_media_account.py → entity_resource_brand_id_search_result.py} +13 -13
  31. criteo_api_retailmedia_preview/model/{creative_v2_list_response.py → entity_resource_collection_outcome_brand_id_search_result.py} +17 -24
  32. criteo_api_retailmedia_preview/model/{entity_resource_collection_outcome_of_retail_media_account.py → entity_resource_collection_outcome_of_retail_media_child_account.py} +15 -9
  33. criteo_api_retailmedia_preview/model/{entity_resource_of_retail_media_account.py → entity_resource_of_retail_media_child_account.py} +9 -9
  34. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +1 -1
  35. criteo_api_retailmedia_preview/model/{external_retail_media_account.py → external_retail_media_child_account.py} +4 -8
  36. criteo_api_retailmedia_preview/model/{external_files_variable_value.py → files_variable_value.py} +4 -10
  37. criteo_api_retailmedia_preview/model/{external_hyperlink_variable_value.py → hyperlink_variable_value.py} +5 -11
  38. criteo_api_retailmedia_preview/model/json_api_request_of_seller_catalog_request.py +1 -1
  39. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_request.py +1 -1
  40. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py +1 -1
  41. criteo_api_retailmedia_preview/model/message.py +5 -5
  42. criteo_api_retailmedia_preview/model/offset_page_metadata.py +279 -0
  43. criteo_api_retailmedia_preview/model/outcome.py +268 -0
  44. criteo_api_retailmedia_preview/model/{external_page_type_environment.py → page_type_environment2.py} +4 -10
  45. criteo_api_retailmedia_preview/model/placement_preview.py +4 -0
  46. criteo_api_retailmedia_preview/model/report_ok_response.py +18 -18
  47. criteo_api_retailmedia_preview/model/{proposal_status_model_resource.py → resource_of_creative2.py} +14 -14
  48. criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.py +1 -1
  49. criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py +1 -1
  50. criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py +31 -18
  51. criteo_api_retailmedia_preview/model/retail_media_seller.py +4 -0
  52. criteo_api_retailmedia_preview/model/sdk_api_rest_common_problem.py +296 -0
  53. criteo_api_retailmedia_preview/model/seller_catalog_request.py +1 -1
  54. criteo_api_retailmedia_preview/model/{sku_search_request_body.py → seller_search.py} +18 -25
  55. criteo_api_retailmedia_preview/model/sku_data_preview.py +27 -27
  56. criteo_api_retailmedia_preview/model/{external_brand.py → sku_min_bid.py} +18 -22
  57. criteo_api_retailmedia_preview/model/sku_slim_data_v2.py +9 -13
  58. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +4 -0
  59. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +1 -11
  60. criteo_api_retailmedia_preview/model/sync_line_items_report.py +1 -11
  61. criteo_api_retailmedia_preview/model/{external_template_variable_value.py → template_variable_value.py} +36 -43
  62. criteo_api_retailmedia_preview/model/{location_inner.py → text_variable_value.py} +9 -11
  63. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller_account_creation.py → value_resource_brand_id_search_request.py} +10 -10
  64. criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_retail_media_seller.py +8 -8
  65. criteo_api_retailmedia_preview/model/value_resource_cpc_min_bids_request.py +266 -0
  66. criteo_api_retailmedia_preview/model/value_resource_cpc_min_bids_response.py +266 -0
  67. criteo_api_retailmedia_preview/model/value_resource_input_brand_id_search_request.py +262 -0
  68. criteo_api_retailmedia_preview/model/{external_text_variable_value.py → value_resource_input_cpc_min_bids_request.py} +13 -14
  69. criteo_api_retailmedia_preview/model/{value_resource_collection_input_of_retail_media_seller.py → value_resource_input_of_seller_search.py} +8 -8
  70. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller.py +2 -2
  71. criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_seller_account_creation.py → value_resource_of_seller_search.py} +13 -9
  72. criteo_api_retailmedia_preview/model/{proposal_status_model_response.py → value_resource_outcome_cpc_min_bids_response.py} +19 -19
  73. criteo_api_retailmedia_preview/model/{external_video_variable_value.py → video_variable_value.py} +4 -10
  74. criteo_api_retailmedia_preview/models/__init__.py +39 -54
  75. {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250205.dist-info}/METADATA +14 -5
  76. {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250205.dist-info}/RECORD +78 -93
  77. {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250205.dist-info}/WHEEL +1 -1
  78. criteo_api_retailmedia_preview/model/add_funds_to_balance_v2.py +0 -277
  79. criteo_api_retailmedia_preview/model/approval_status_model.py +0 -292
  80. criteo_api_retailmedia_preview/model/botmessage.py +0 -329
  81. criteo_api_retailmedia_preview/model/change_details_v2.py +0 -275
  82. criteo_api_retailmedia_preview/model/creative_v2_response.py +0 -281
  83. criteo_api_retailmedia_preview/model/external_account.py +0 -330
  84. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture_v2.py +0 -303
  85. criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_account_and_account.py +0 -285
  86. criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_brand_and_brand.py +0 -285
  87. criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py +0 -285
  88. criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py +0 -295
  89. criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py +0 -295
  90. criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py +0 -295
  91. criteo_api_retailmedia_preview/model/negotiation_state_model.py +0 -293
  92. criteo_api_retailmedia_preview/model/proposal_status_model.py +0 -284
  93. criteo_api_retailmedia_preview/model/resource_of_add_funds_to_balance_v2.py +0 -277
  94. criteo_api_retailmedia_preview/model/resource_of_creative_v2.py +0 -277
  95. criteo_api_retailmedia_preview/model/retail_media_account.py +0 -301
  96. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +0 -274
  97. criteo_api_retailmedia_preview/model/sku_search_result.py +0 -313
  98. criteo_api_retailmedia_preview/model/validation_error.py +0 -287
  99. {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250205.dist-info}/top_level.txt +0 -0
@@ -1,329 +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.bot_message import BotMessage
34
- from criteo_api_retailmedia_preview.model.product_recommendation import ProductRecommendation
35
- globals()['BotMessage'] = BotMessage
36
- globals()['ProductRecommendation'] = ProductRecommendation
37
-
38
-
39
- class Botmessage(ModelComposed):
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 = True
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
- 'opening': (str, none_type,), # noqa: E501
93
- 'product_recos': ([ProductRecommendation], none_type,), # noqa: E501
94
- 'closing': (str, none_type,), # noqa: E501
95
- }
96
-
97
- @cached_property
98
- def discriminator():
99
- return None
100
-
101
-
102
- attribute_map = {
103
- 'opening': 'opening', # noqa: E501
104
- 'product_recos': 'productRecos', # noqa: E501
105
- 'closing': 'closing', # noqa: E501
106
- }
107
-
108
- read_only_vars = {
109
- }
110
-
111
- @classmethod
112
- @convert_js_args_to_python_args
113
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
114
- """Botmessage - a model defined in OpenAPI
115
-
116
- Keyword Args:
117
- _check_type (bool): if True, values for parameters in openapi_types
118
- will be type checked and a TypeError will be
119
- raised if the wrong type is input.
120
- Defaults to True
121
- _path_to_item (tuple/list): This is a list of keys or values to
122
- drill down to the model in received_data
123
- when deserializing a response
124
- _spec_property_naming (bool): True if the variable names in the input data
125
- are serialized names, as specified in the OpenAPI document.
126
- False if the variable names in the input data
127
- are pythonic names, e.g. snake case (default)
128
- _configuration (Configuration): the instance to use when
129
- deserializing a file_type parameter.
130
- If passed, type conversion is attempted
131
- If omitted no type conversion is done.
132
- _visited_composed_classes (tuple): This stores a tuple of
133
- classes that we have traveled through so that
134
- if we see that class again we will not use its
135
- discriminator again.
136
- When traveling through a discriminator, the
137
- composed schema that is
138
- is traveled through is added to this set.
139
- For example if Animal has a discriminator
140
- petType and we pass in "Dog", and the class Dog
141
- allOf includes Animal, we move through Animal
142
- once using the discriminator, and pick Dog.
143
- Then in Dog, we will make an instance of the
144
- Animal class but this time we won't travel
145
- through its discriminator because we passed in
146
- _visited_composed_classes = (Animal,)
147
- opening (str, none_type): opening comment from the bot, introducing the list of recommended products if relevant.. [optional] # noqa: E501
148
- product_recos ([ProductRecommendation], none_type): list of recommended products. [optional] # noqa: E501
149
- closing (str, none_type): closing remark from the bot. [optional] # noqa: E501
150
- """
151
-
152
- _check_type = kwargs.pop('_check_type', True)
153
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
154
- _path_to_item = kwargs.pop('_path_to_item', ())
155
- _configuration = kwargs.pop('_configuration', None)
156
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
157
-
158
- self = super(OpenApiModel, cls).__new__(cls)
159
-
160
- if args:
161
- for arg in args:
162
- if isinstance(arg, dict):
163
- kwargs.update(arg)
164
- else:
165
- raise ApiTypeError(
166
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
167
- args,
168
- self.__class__.__name__,
169
- ),
170
- path_to_item=_path_to_item,
171
- valid_classes=(self.__class__,),
172
- )
173
-
174
- self._data_store = {}
175
- self._check_type = _check_type
176
- self._spec_property_naming = _spec_property_naming
177
- self._path_to_item = _path_to_item
178
- self._configuration = _configuration
179
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
180
-
181
- constant_args = {
182
- '_check_type': _check_type,
183
- '_path_to_item': _path_to_item,
184
- '_spec_property_naming': _spec_property_naming,
185
- '_configuration': _configuration,
186
- '_visited_composed_classes': self._visited_composed_classes,
187
- }
188
- composed_info = validate_get_composed_info(
189
- constant_args, kwargs, self)
190
- self._composed_instances = composed_info[0]
191
- self._var_name_to_model_instances = composed_info[1]
192
- self._additional_properties_model_instances = composed_info[2]
193
- discarded_args = composed_info[3]
194
-
195
- for var_name, var_value in kwargs.items():
196
- if var_name in discarded_args and \
197
- self._configuration is not None and \
198
- self._configuration.discard_unknown_keys and \
199
- self._additional_properties_model_instances:
200
- # discard variable.
201
- continue
202
- setattr(self, var_name, var_value)
203
-
204
- return self
205
-
206
- required_properties = set([
207
- '_data_store',
208
- '_check_type',
209
- '_spec_property_naming',
210
- '_path_to_item',
211
- '_configuration',
212
- '_visited_composed_classes',
213
- '_composed_instances',
214
- '_var_name_to_model_instances',
215
- '_additional_properties_model_instances',
216
- ])
217
-
218
- @convert_js_args_to_python_args
219
- def __init__(self, *args, **kwargs): # noqa: E501
220
- """Botmessage - 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
- opening (str, none_type): opening comment from the bot, introducing the list of recommended products if relevant.. [optional] # noqa: E501
254
- product_recos ([ProductRecommendation], none_type): list of recommended products. [optional] # noqa: E501
255
- closing (str, none_type): closing remark from the bot. [optional] # noqa: E501
256
- """
257
-
258
- _check_type = kwargs.pop('_check_type', True)
259
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
260
- _path_to_item = kwargs.pop('_path_to_item', ())
261
- _configuration = kwargs.pop('_configuration', None)
262
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
263
-
264
- if args:
265
- for arg in args:
266
- if isinstance(arg, dict):
267
- kwargs.update(arg)
268
- else:
269
- raise ApiTypeError(
270
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
271
- args,
272
- self.__class__.__name__,
273
- ),
274
- path_to_item=_path_to_item,
275
- valid_classes=(self.__class__,),
276
- )
277
-
278
- self._data_store = {}
279
- self._check_type = _check_type
280
- self._spec_property_naming = _spec_property_naming
281
- self._path_to_item = _path_to_item
282
- self._configuration = _configuration
283
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
284
-
285
- constant_args = {
286
- '_check_type': _check_type,
287
- '_path_to_item': _path_to_item,
288
- '_spec_property_naming': _spec_property_naming,
289
- '_configuration': _configuration,
290
- '_visited_composed_classes': self._visited_composed_classes,
291
- }
292
- composed_info = validate_get_composed_info(
293
- constant_args, kwargs, self)
294
- self._composed_instances = composed_info[0]
295
- self._var_name_to_model_instances = composed_info[1]
296
- self._additional_properties_model_instances = composed_info[2]
297
- discarded_args = composed_info[3]
298
-
299
- for var_name, var_value in kwargs.items():
300
- if var_name in discarded_args and \
301
- self._configuration is not None and \
302
- self._configuration.discard_unknown_keys and \
303
- self._additional_properties_model_instances:
304
- # discard variable.
305
- continue
306
- setattr(self, var_name, var_value)
307
- if var_name in self.read_only_vars:
308
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
309
- f"class with read only attributes.")
310
-
311
- @cached_property
312
- def _composed_schemas():
313
- # we need this here to make our import statements work
314
- # we must store _composed_schemas in here so the code is only run
315
- # when we invoke this method. If we kept this at the class
316
- # level we would get an error because the class level
317
- # code would be run when this module is imported, and these composed
318
- # classes don't exist yet because their module has not finished
319
- # loading
320
- lazy_import()
321
- return {
322
- 'anyOf': [
323
- ],
324
- 'allOf': [
325
- BotMessage,
326
- ],
327
- 'oneOf': [
328
- ],
329
- }
@@ -1,275 +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
-
33
- class ChangeDetailsV2(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
- }
59
-
60
- validations = {
61
- }
62
-
63
- additional_properties_type = None
64
-
65
- _nullable = False
66
-
67
- @cached_property
68
- def openapi_types():
69
- """
70
- This must be a method because a model may have properties that are
71
- of type self, this must run after the class is loaded
72
-
73
- Returns
74
- openapi_types (dict): The key is attribute name
75
- and the value is attribute type.
76
- """
77
- return {
78
- 'previous_value': (str, none_type,), # noqa: E501
79
- 'current_value': (str, none_type,), # noqa: E501
80
- 'change_value': (str, none_type,), # noqa: E501
81
- }
82
-
83
- @cached_property
84
- def discriminator():
85
- return None
86
-
87
-
88
- attribute_map = {
89
- 'previous_value': 'previousValue', # noqa: E501
90
- 'current_value': 'currentValue', # noqa: E501
91
- 'change_value': 'changeValue', # noqa: E501
92
- }
93
-
94
- read_only_vars = {
95
- }
96
-
97
- _composed_schemas = {}
98
-
99
- @classmethod
100
- @convert_js_args_to_python_args
101
- def _from_openapi_data(cls, previous_value, current_value, change_value, *args, **kwargs): # noqa: E501
102
- """ChangeDetailsV2 - a model defined in OpenAPI
103
-
104
- Args:
105
- previous_value (str, none_type): Previous value of a property of the insertion order.
106
- current_value (str, none_type): Current value of a property of the insertion order.
107
- change_value (str, none_type): Change detail of a property of the insertion order.
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
- """
141
-
142
- _check_type = kwargs.pop('_check_type', True)
143
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
144
- _path_to_item = kwargs.pop('_path_to_item', ())
145
- _configuration = kwargs.pop('_configuration', None)
146
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
147
-
148
- self = super(OpenApiModel, cls).__new__(cls)
149
-
150
- if args:
151
- for arg in args:
152
- if isinstance(arg, dict):
153
- kwargs.update(arg)
154
- else:
155
- raise ApiTypeError(
156
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
157
- args,
158
- self.__class__.__name__,
159
- ),
160
- path_to_item=_path_to_item,
161
- valid_classes=(self.__class__,),
162
- )
163
-
164
- self._data_store = {}
165
- self._check_type = _check_type
166
- self._spec_property_naming = _spec_property_naming
167
- self._path_to_item = _path_to_item
168
- self._configuration = _configuration
169
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
170
-
171
- self.previous_value = previous_value
172
- self.current_value = current_value
173
- self.change_value = change_value
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, previous_value, current_value, change_value, *args, **kwargs): # noqa: E501
195
- """ChangeDetailsV2 - a model defined in OpenAPI
196
-
197
- Args:
198
- previous_value (str, none_type): Previous value of a property of the insertion order.
199
- current_value (str, none_type): Current value of a property of the insertion order.
200
- change_value (str, none_type): Change detail of a property of the insertion order.
201
-
202
- Keyword Args:
203
- _check_type (bool): if True, values for parameters in openapi_types
204
- will be type checked and a TypeError will be
205
- raised if the wrong type is input.
206
- Defaults to True
207
- _path_to_item (tuple/list): This is a list of keys or values to
208
- drill down to the model in received_data
209
- when deserializing a response
210
- _spec_property_naming (bool): True if the variable names in the input data
211
- are serialized names, as specified in the OpenAPI document.
212
- False if the variable names in the input data
213
- are pythonic names, e.g. snake case (default)
214
- _configuration (Configuration): the instance to use when
215
- deserializing a file_type parameter.
216
- If passed, type conversion is attempted
217
- If omitted no type conversion is done.
218
- _visited_composed_classes (tuple): This stores a tuple of
219
- classes that we have traveled through so that
220
- if we see that class again we will not use its
221
- discriminator again.
222
- When traveling through a discriminator, the
223
- composed schema that is
224
- is traveled through is added to this set.
225
- For example if Animal has a discriminator
226
- petType and we pass in "Dog", and the class Dog
227
- allOf includes Animal, we move through Animal
228
- once using the discriminator, and pick Dog.
229
- Then in Dog, we will make an instance of the
230
- Animal class but this time we won't travel
231
- through its discriminator because we passed in
232
- _visited_composed_classes = (Animal,)
233
- """
234
-
235
- _check_type = kwargs.pop('_check_type', True)
236
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
237
- _path_to_item = kwargs.pop('_path_to_item', ())
238
- _configuration = kwargs.pop('_configuration', None)
239
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
240
-
241
- if args:
242
- for arg in args:
243
- if isinstance(arg, dict):
244
- kwargs.update(arg)
245
- else:
246
- raise ApiTypeError(
247
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
248
- args,
249
- self.__class__.__name__,
250
- ),
251
- path_to_item=_path_to_item,
252
- valid_classes=(self.__class__,),
253
- )
254
-
255
- self._data_store = {}
256
- self._check_type = _check_type
257
- self._spec_property_naming = _spec_property_naming
258
- self._path_to_item = _path_to_item
259
- self._configuration = _configuration
260
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
261
-
262
- self.previous_value = previous_value
263
- self.current_value = current_value
264
- self.change_value = change_value
265
- for var_name, var_value in kwargs.items():
266
- if var_name not in self.attribute_map and \
267
- self._configuration is not None and \
268
- self._configuration.discard_unknown_keys and \
269
- self.additional_properties_type is None:
270
- # discard variable.
271
- continue
272
- setattr(self, var_name, var_value)
273
- if var_name in self.read_only_vars:
274
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
275
- f"class with read only attributes.")