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,295 +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.common_error import CommonError
34
- from criteo_api_retailmedia_preview.model.common_warning import CommonWarning
35
- from criteo_api_retailmedia_preview.model.json_api_body_with_id_of_int64_and_account_and_account import JsonApiBodyWithIdOfInt64AndAccountAndAccount
36
- from criteo_api_retailmedia_preview.model.page_metadata import PageMetadata
37
- globals()['CommonError'] = CommonError
38
- globals()['CommonWarning'] = CommonWarning
39
- globals()['JsonApiBodyWithIdOfInt64AndAccountAndAccount'] = JsonApiBodyWithIdOfInt64AndAccountAndAccount
40
- globals()['PageMetadata'] = PageMetadata
41
-
42
-
43
- class JsonApiPageResponseOfAccount(ModelNormal):
44
- """NOTE: This class is auto generated by OpenAPI Generator.
45
- Ref: https://openapi-generator.tech
46
-
47
- Do not edit the class manually.
48
-
49
- Attributes:
50
- allowed_values (dict): The key is the tuple path to the attribute
51
- and the for var_name this is (var_name,). The value is a dict
52
- with a capitalized key describing the allowed value and an allowed
53
- value. These dicts store the allowed enum values.
54
- attribute_map (dict): The key is attribute name
55
- and the value is json key in definition.
56
- discriminator_value_class_map (dict): A dict to go from the discriminator
57
- variable value to the discriminator class name.
58
- validations (dict): The key is the tuple path to the attribute
59
- and the for var_name this is (var_name,). The value is a dict
60
- that stores validations for max_length, min_length, max_items,
61
- min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
62
- inclusive_minimum, and regex.
63
- additional_properties_type (tuple): A tuple of classes accepted
64
- as additional properties values.
65
- """
66
-
67
- allowed_values = {
68
- }
69
-
70
- validations = {
71
- }
72
-
73
- @cached_property
74
- def additional_properties_type():
75
- """
76
- This must be a method because a model may have properties that are
77
- of type self, this must run after the class is loaded
78
- """
79
- lazy_import()
80
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
81
-
82
- _nullable = False
83
-
84
- @cached_property
85
- def openapi_types():
86
- """
87
- This must be a method because a model may have properties that are
88
- of type self, this must run after the class is loaded
89
-
90
- Returns
91
- openapi_types (dict): The key is attribute name
92
- and the value is attribute type.
93
- """
94
- lazy_import()
95
- return {
96
- 'metadata': (PageMetadata,), # noqa: E501
97
- 'data': ([JsonApiBodyWithIdOfInt64AndAccountAndAccount],), # noqa: E501
98
- 'errors': ([CommonError],), # noqa: E501
99
- 'warnings': ([CommonWarning],), # noqa: E501
100
- }
101
-
102
- @cached_property
103
- def discriminator():
104
- return None
105
-
106
-
107
- attribute_map = {
108
- 'metadata': 'metadata', # noqa: E501
109
- 'data': 'data', # noqa: E501
110
- 'errors': 'errors', # noqa: E501
111
- 'warnings': 'warnings', # noqa: E501
112
- }
113
-
114
- read_only_vars = {
115
- }
116
-
117
- _composed_schemas = {}
118
-
119
- @classmethod
120
- @convert_js_args_to_python_args
121
- def _from_openapi_data(cls, metadata, data, *args, **kwargs): # noqa: E501
122
- """JsonApiPageResponseOfAccount - a model defined in OpenAPI
123
-
124
- Args:
125
- metadata (PageMetadata):
126
- data ([JsonApiBodyWithIdOfInt64AndAccountAndAccount]):
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
- errors ([CommonError]): [optional] # noqa: E501
160
- warnings ([CommonWarning]): [optional] # noqa: E501
161
- """
162
-
163
- _check_type = kwargs.pop('_check_type', True)
164
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
165
- _path_to_item = kwargs.pop('_path_to_item', ())
166
- _configuration = kwargs.pop('_configuration', None)
167
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
168
-
169
- self = super(OpenApiModel, cls).__new__(cls)
170
-
171
- if args:
172
- for arg in args:
173
- if isinstance(arg, dict):
174
- kwargs.update(arg)
175
- else:
176
- raise ApiTypeError(
177
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
178
- args,
179
- self.__class__.__name__,
180
- ),
181
- path_to_item=_path_to_item,
182
- valid_classes=(self.__class__,),
183
- )
184
-
185
- self._data_store = {}
186
- self._check_type = _check_type
187
- self._spec_property_naming = _spec_property_naming
188
- self._path_to_item = _path_to_item
189
- self._configuration = _configuration
190
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
191
-
192
- self.metadata = metadata
193
- self.data = data
194
- for var_name, var_value in kwargs.items():
195
- if var_name not in self.attribute_map and \
196
- self._configuration is not None and \
197
- self._configuration.discard_unknown_keys and \
198
- self.additional_properties_type is None:
199
- # discard variable.
200
- continue
201
- setattr(self, var_name, var_value)
202
- return self
203
-
204
- required_properties = set([
205
- '_data_store',
206
- '_check_type',
207
- '_spec_property_naming',
208
- '_path_to_item',
209
- '_configuration',
210
- '_visited_composed_classes',
211
- ])
212
-
213
- @convert_js_args_to_python_args
214
- def __init__(self, metadata, data, *args, **kwargs): # noqa: E501
215
- """JsonApiPageResponseOfAccount - a model defined in OpenAPI
216
-
217
- Args:
218
- metadata (PageMetadata):
219
- data ([JsonApiBodyWithIdOfInt64AndAccountAndAccount]):
220
-
221
- Keyword Args:
222
- _check_type (bool): if True, values for parameters in openapi_types
223
- will be type checked and a TypeError will be
224
- raised if the wrong type is input.
225
- Defaults to True
226
- _path_to_item (tuple/list): This is a list of keys or values to
227
- drill down to the model in received_data
228
- when deserializing a response
229
- _spec_property_naming (bool): True if the variable names in the input data
230
- are serialized names, as specified in the OpenAPI document.
231
- False if the variable names in the input data
232
- are pythonic names, e.g. snake case (default)
233
- _configuration (Configuration): the instance to use when
234
- deserializing a file_type parameter.
235
- If passed, type conversion is attempted
236
- If omitted no type conversion is done.
237
- _visited_composed_classes (tuple): This stores a tuple of
238
- classes that we have traveled through so that
239
- if we see that class again we will not use its
240
- discriminator again.
241
- When traveling through a discriminator, the
242
- composed schema that is
243
- is traveled through is added to this set.
244
- For example if Animal has a discriminator
245
- petType and we pass in "Dog", and the class Dog
246
- allOf includes Animal, we move through Animal
247
- once using the discriminator, and pick Dog.
248
- Then in Dog, we will make an instance of the
249
- Animal class but this time we won't travel
250
- through its discriminator because we passed in
251
- _visited_composed_classes = (Animal,)
252
- errors ([CommonError]): [optional] # noqa: E501
253
- warnings ([CommonWarning]): [optional] # noqa: E501
254
- """
255
-
256
- _check_type = kwargs.pop('_check_type', True)
257
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
258
- _path_to_item = kwargs.pop('_path_to_item', ())
259
- _configuration = kwargs.pop('_configuration', None)
260
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
261
-
262
- if args:
263
- for arg in args:
264
- if isinstance(arg, dict):
265
- kwargs.update(arg)
266
- else:
267
- raise ApiTypeError(
268
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
269
- args,
270
- self.__class__.__name__,
271
- ),
272
- path_to_item=_path_to_item,
273
- valid_classes=(self.__class__,),
274
- )
275
-
276
- self._data_store = {}
277
- self._check_type = _check_type
278
- self._spec_property_naming = _spec_property_naming
279
- self._path_to_item = _path_to_item
280
- self._configuration = _configuration
281
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
282
-
283
- self.metadata = metadata
284
- self.data = data
285
- for var_name, var_value in kwargs.items():
286
- if var_name not in self.attribute_map and \
287
- self._configuration is not None and \
288
- self._configuration.discard_unknown_keys and \
289
- self.additional_properties_type is None:
290
- # discard variable.
291
- continue
292
- setattr(self, var_name, var_value)
293
- if var_name in self.read_only_vars:
294
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
295
- f"class with read only attributes.")
@@ -1,295 +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.common_error import CommonError
34
- from criteo_api_retailmedia_preview.model.common_warning import CommonWarning
35
- from criteo_api_retailmedia_preview.model.json_api_body_with_id_of_int64_and_brand_and_brand import JsonApiBodyWithIdOfInt64AndBrandAndBrand
36
- from criteo_api_retailmedia_preview.model.page_metadata import PageMetadata
37
- globals()['CommonError'] = CommonError
38
- globals()['CommonWarning'] = CommonWarning
39
- globals()['JsonApiBodyWithIdOfInt64AndBrandAndBrand'] = JsonApiBodyWithIdOfInt64AndBrandAndBrand
40
- globals()['PageMetadata'] = PageMetadata
41
-
42
-
43
- class JsonApiPageResponseOfBrand(ModelNormal):
44
- """NOTE: This class is auto generated by OpenAPI Generator.
45
- Ref: https://openapi-generator.tech
46
-
47
- Do not edit the class manually.
48
-
49
- Attributes:
50
- allowed_values (dict): The key is the tuple path to the attribute
51
- and the for var_name this is (var_name,). The value is a dict
52
- with a capitalized key describing the allowed value and an allowed
53
- value. These dicts store the allowed enum values.
54
- attribute_map (dict): The key is attribute name
55
- and the value is json key in definition.
56
- discriminator_value_class_map (dict): A dict to go from the discriminator
57
- variable value to the discriminator class name.
58
- validations (dict): The key is the tuple path to the attribute
59
- and the for var_name this is (var_name,). The value is a dict
60
- that stores validations for max_length, min_length, max_items,
61
- min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
62
- inclusive_minimum, and regex.
63
- additional_properties_type (tuple): A tuple of classes accepted
64
- as additional properties values.
65
- """
66
-
67
- allowed_values = {
68
- }
69
-
70
- validations = {
71
- }
72
-
73
- @cached_property
74
- def additional_properties_type():
75
- """
76
- This must be a method because a model may have properties that are
77
- of type self, this must run after the class is loaded
78
- """
79
- lazy_import()
80
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
81
-
82
- _nullable = False
83
-
84
- @cached_property
85
- def openapi_types():
86
- """
87
- This must be a method because a model may have properties that are
88
- of type self, this must run after the class is loaded
89
-
90
- Returns
91
- openapi_types (dict): The key is attribute name
92
- and the value is attribute type.
93
- """
94
- lazy_import()
95
- return {
96
- 'metadata': (PageMetadata,), # noqa: E501
97
- 'data': ([JsonApiBodyWithIdOfInt64AndBrandAndBrand],), # noqa: E501
98
- 'errors': ([CommonError],), # noqa: E501
99
- 'warnings': ([CommonWarning],), # noqa: E501
100
- }
101
-
102
- @cached_property
103
- def discriminator():
104
- return None
105
-
106
-
107
- attribute_map = {
108
- 'metadata': 'metadata', # noqa: E501
109
- 'data': 'data', # noqa: E501
110
- 'errors': 'errors', # noqa: E501
111
- 'warnings': 'warnings', # noqa: E501
112
- }
113
-
114
- read_only_vars = {
115
- }
116
-
117
- _composed_schemas = {}
118
-
119
- @classmethod
120
- @convert_js_args_to_python_args
121
- def _from_openapi_data(cls, metadata, data, *args, **kwargs): # noqa: E501
122
- """JsonApiPageResponseOfBrand - a model defined in OpenAPI
123
-
124
- Args:
125
- metadata (PageMetadata):
126
- data ([JsonApiBodyWithIdOfInt64AndBrandAndBrand]):
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
- errors ([CommonError]): [optional] # noqa: E501
160
- warnings ([CommonWarning]): [optional] # noqa: E501
161
- """
162
-
163
- _check_type = kwargs.pop('_check_type', True)
164
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
165
- _path_to_item = kwargs.pop('_path_to_item', ())
166
- _configuration = kwargs.pop('_configuration', None)
167
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
168
-
169
- self = super(OpenApiModel, cls).__new__(cls)
170
-
171
- if args:
172
- for arg in args:
173
- if isinstance(arg, dict):
174
- kwargs.update(arg)
175
- else:
176
- raise ApiTypeError(
177
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
178
- args,
179
- self.__class__.__name__,
180
- ),
181
- path_to_item=_path_to_item,
182
- valid_classes=(self.__class__,),
183
- )
184
-
185
- self._data_store = {}
186
- self._check_type = _check_type
187
- self._spec_property_naming = _spec_property_naming
188
- self._path_to_item = _path_to_item
189
- self._configuration = _configuration
190
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
191
-
192
- self.metadata = metadata
193
- self.data = data
194
- for var_name, var_value in kwargs.items():
195
- if var_name not in self.attribute_map and \
196
- self._configuration is not None and \
197
- self._configuration.discard_unknown_keys and \
198
- self.additional_properties_type is None:
199
- # discard variable.
200
- continue
201
- setattr(self, var_name, var_value)
202
- return self
203
-
204
- required_properties = set([
205
- '_data_store',
206
- '_check_type',
207
- '_spec_property_naming',
208
- '_path_to_item',
209
- '_configuration',
210
- '_visited_composed_classes',
211
- ])
212
-
213
- @convert_js_args_to_python_args
214
- def __init__(self, metadata, data, *args, **kwargs): # noqa: E501
215
- """JsonApiPageResponseOfBrand - a model defined in OpenAPI
216
-
217
- Args:
218
- metadata (PageMetadata):
219
- data ([JsonApiBodyWithIdOfInt64AndBrandAndBrand]):
220
-
221
- Keyword Args:
222
- _check_type (bool): if True, values for parameters in openapi_types
223
- will be type checked and a TypeError will be
224
- raised if the wrong type is input.
225
- Defaults to True
226
- _path_to_item (tuple/list): This is a list of keys or values to
227
- drill down to the model in received_data
228
- when deserializing a response
229
- _spec_property_naming (bool): True if the variable names in the input data
230
- are serialized names, as specified in the OpenAPI document.
231
- False if the variable names in the input data
232
- are pythonic names, e.g. snake case (default)
233
- _configuration (Configuration): the instance to use when
234
- deserializing a file_type parameter.
235
- If passed, type conversion is attempted
236
- If omitted no type conversion is done.
237
- _visited_composed_classes (tuple): This stores a tuple of
238
- classes that we have traveled through so that
239
- if we see that class again we will not use its
240
- discriminator again.
241
- When traveling through a discriminator, the
242
- composed schema that is
243
- is traveled through is added to this set.
244
- For example if Animal has a discriminator
245
- petType and we pass in "Dog", and the class Dog
246
- allOf includes Animal, we move through Animal
247
- once using the discriminator, and pick Dog.
248
- Then in Dog, we will make an instance of the
249
- Animal class but this time we won't travel
250
- through its discriminator because we passed in
251
- _visited_composed_classes = (Animal,)
252
- errors ([CommonError]): [optional] # noqa: E501
253
- warnings ([CommonWarning]): [optional] # noqa: E501
254
- """
255
-
256
- _check_type = kwargs.pop('_check_type', True)
257
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
258
- _path_to_item = kwargs.pop('_path_to_item', ())
259
- _configuration = kwargs.pop('_configuration', None)
260
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
261
-
262
- if args:
263
- for arg in args:
264
- if isinstance(arg, dict):
265
- kwargs.update(arg)
266
- else:
267
- raise ApiTypeError(
268
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
269
- args,
270
- self.__class__.__name__,
271
- ),
272
- path_to_item=_path_to_item,
273
- valid_classes=(self.__class__,),
274
- )
275
-
276
- self._data_store = {}
277
- self._check_type = _check_type
278
- self._spec_property_naming = _spec_property_naming
279
- self._path_to_item = _path_to_item
280
- self._configuration = _configuration
281
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
282
-
283
- self.metadata = metadata
284
- self.data = data
285
- for var_name, var_value in kwargs.items():
286
- if var_name not in self.attribute_map and \
287
- self._configuration is not None and \
288
- self._configuration.discard_unknown_keys and \
289
- self.additional_properties_type is None:
290
- # discard variable.
291
- continue
292
- setattr(self, var_name, var_value)
293
- if var_name in self.read_only_vars:
294
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
295
- f"class with read only attributes.")