criteo-api-retailmedia-sdk 0.0.250409__py3-none-any.whl → 0.0.250606__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 (96) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +3 -147
  3. criteo_api_retailmedia_preview/api/analytics_api.py +1 -1
  4. criteo_api_retailmedia_preview/api/audience_api.py +1204 -135
  5. criteo_api_retailmedia_preview/api/campaign_api.py +741 -104
  6. criteo_api_retailmedia_preview/api_client.py +1 -1
  7. criteo_api_retailmedia_preview/configuration.py +1 -1
  8. criteo_api_retailmedia_preview/model/account_fees_update_request.py +4 -0
  9. criteo_api_retailmedia_preview/model/async_accounts_report.py +6 -6
  10. criteo_api_retailmedia_preview/model/async_campaigns_report.py +4 -4
  11. criteo_api_retailmedia_preview/model/async_line_items_report.py +4 -4
  12. criteo_api_retailmedia_preview/model/async_offsite_report.py +25 -18
  13. criteo_api_retailmedia_preview/model/brand_id_search_request.py +7 -1
  14. criteo_api_retailmedia_preview/model/brand_id_search_result.py +7 -1
  15. criteo_api_retailmedia_preview/model/categories_search_request_v1.py +270 -0
  16. criteo_api_retailmedia_preview/model/entity_resource_brand_id_search_result.py +8 -1
  17. criteo_api_retailmedia_preview/model/entity_resource_category202204.py +277 -0
  18. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_brand_id_search_result_paging_offset_limit_metadata.py +8 -1
  19. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204.py +281 -0
  20. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204_metadata.py +287 -0
  21. criteo_api_retailmedia_preview/model/entity_resource_of_sponsored_products_line_item.py +270 -0
  22. criteo_api_retailmedia_preview/model/entity_resource_outcome_of_sponsored_products_line_item.py +274 -0
  23. criteo_api_retailmedia_preview/model/{input_keywords.py → flight_leg.py} +39 -17
  24. criteo_api_retailmedia_preview/model/{recommended_keywords_result.py → flight_schedule.py} +9 -13
  25. criteo_api_retailmedia_preview/model/nillable_decimal.py +263 -0
  26. criteo_api_retailmedia_preview/model/page_of_sponsored_products_line_item.py +276 -0
  27. criteo_api_retailmedia_preview/model/paging_offset_limit_metadata.py +7 -1
  28. criteo_api_retailmedia_preview/model/{grant_consent_model.py → recommended_categories_request_v1.py} +14 -21
  29. criteo_api_retailmedia_preview/model/recommended_keywords_request_v1.py +266 -0
  30. criteo_api_retailmedia_preview/model/recommended_keywords_response_v1.py +263 -0
  31. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_request.py → rm_audience_bulk_create_input_v1.py} +9 -9
  32. criteo_api_retailmedia_preview/model/{grant_consent_input.py → rm_audience_bulk_delete_input_v1.py} +8 -8
  33. criteo_api_retailmedia_preview/model/rm_audience_bulk_update_input_v1.py +269 -0
  34. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1.py +272 -0
  35. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1_resource.py +273 -0
  36. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_input_v1.py +269 -0
  37. criteo_api_retailmedia_preview/model/rm_audience_create_entity_v1.py +291 -0
  38. criteo_api_retailmedia_preview/model/{grant_consent_model_value_resource.py → rm_audience_create_entity_v1_resource.py} +8 -8
  39. criteo_api_retailmedia_preview/model/rm_audience_delete_entity_v1_resource.py +271 -0
  40. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_recommended_keywords_result.py → rm_audience_entity_v1_list_response.py} +16 -9
  41. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1.py +282 -0
  42. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1_resource.py +273 -0
  43. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_input_v1.py +269 -0
  44. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1.py +272 -0
  45. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1_resource.py +273 -0
  46. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_sizes_input_v1.py +269 -0
  47. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +6 -0
  48. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1.py +282 -0
  49. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1_resource.py +273 -0
  50. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_input_v1.py +269 -0
  51. criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1.py +267 -0
  52. criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1_list_response.py +281 -0
  53. criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers_v2.py → rm_audience_segment_size_entity_v1_resource.py} +11 -11
  54. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1.py +267 -0
  55. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_resource.py +273 -0
  56. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_response.py +281 -0
  57. criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1.py +6 -0
  58. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1.py +267 -0
  59. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_list_response.py +281 -0
  60. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_resource.py +277 -0
  61. criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1.py +267 -0
  62. criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1_resource.py +273 -0
  63. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_response.py → rm_audience_size_estimation_v1_response.py} +9 -9
  64. criteo_api_retailmedia_preview/model/rm_audience_update_entity_v1.py +279 -0
  65. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py → rm_audience_update_entity_v1_resource.py} +17 -19
  66. criteo_api_retailmedia_preview/model/rm_events_create_v1.py +305 -0
  67. criteo_api_retailmedia_preview/model/rm_events_estimation_v1.py +305 -0
  68. criteo_api_retailmedia_preview/model/rm_events_update_v1.py +307 -0
  69. criteo_api_retailmedia_preview/model/sku_slim_data_preview.py +6 -6
  70. criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +387 -0
  71. criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers_v2.py → sponsored_products_line_item_create_request_model.py} +81 -33
  72. criteo_api_retailmedia_preview/model/{keywords.py → sponsored_products_line_item_update_request_model.py} +82 -44
  73. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +2 -2
  74. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +4 -4
  75. criteo_api_retailmedia_preview/model/sync_line_items_report.py +4 -4
  76. criteo_api_retailmedia_preview/model/value_resource_brand_id_search_request.py +8 -1
  77. criteo_api_retailmedia_preview/model/value_resource_categories_search_request_v1.py +273 -0
  78. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_private_market_account_fees.py → value_resource_collection_outcome_private_market_account_fees_and_metadata.py} +9 -3
  79. criteo_api_retailmedia_preview/model/value_resource_input_brand_id_search_request.py +8 -1
  80. criteo_api_retailmedia_preview/model/value_resource_input_categories_search_request_v1.py +269 -0
  81. criteo_api_retailmedia_preview/model/value_resource_input_of_sponsored_products_line_item_update_request_model.py +262 -0
  82. criteo_api_retailmedia_preview/model/value_resource_input_recommended_categories_request_v1.py +269 -0
  83. criteo_api_retailmedia_preview/model/value_resource_input_recommended_keywords_request_v1.py +262 -0
  84. criteo_api_retailmedia_preview/model/value_resource_of_sponsored_products_line_item_update_request_model.py +266 -0
  85. criteo_api_retailmedia_preview/model/value_resource_outcome_recommended_keywords_response_v1.py +274 -0
  86. criteo_api_retailmedia_preview/model/value_resource_recommended_categories_request_v1.py +273 -0
  87. criteo_api_retailmedia_preview/model/value_resource_recommended_keywords_request_v1.py +266 -0
  88. criteo_api_retailmedia_preview/model/{value_resource_of_recommended_keywords_result.py → value_resource_recommended_keywords_response_v1.py} +10 -10
  89. criteo_api_retailmedia_preview/models/__init__.py +63 -17
  90. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/METADATA +3 -3
  91. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/RECORD +93 -47
  92. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/WHEEL +1 -1
  93. criteo_api_retailmedia_preview/model/common_error.py +0 -301
  94. criteo_api_retailmedia_preview/model/common_warning.py +0 -301
  95. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +0 -307
  96. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/top_level.txt +0 -0
@@ -1,301 +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 CommonError(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
- ('type',): {
59
- 'UNKNOWN': "unknown",
60
- 'ACCESS-CONTROL': "access-control",
61
- 'AUTHENTICATION': "authentication",
62
- 'AUTHORIZATION': "authorization",
63
- 'AVAILABILITY': "availability",
64
- 'DEPRECATION': "deprecation",
65
- 'QUOTA': "quota",
66
- 'VALIDATION': "validation",
67
- },
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
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
80
-
81
- _nullable = False
82
-
83
- @cached_property
84
- def openapi_types():
85
- """
86
- This must be a method because a model may have properties that are
87
- of type self, this must run after the class is loaded
88
-
89
- Returns
90
- openapi_types (dict): The key is attribute name
91
- and the value is attribute type.
92
- """
93
- return {
94
- 'code': (str,), # noqa: E501
95
- 'detail': (str,), # noqa: E501
96
- 'instance': (str,), # noqa: E501
97
- 'source': ({str: (str,)},), # noqa: E501
98
- 'stack_trace': (str,), # noqa: E501
99
- 'title': (str,), # noqa: E501
100
- 'trace_id': (str,), # noqa: E501
101
- 'type': (str,), # noqa: E501
102
- }
103
-
104
- @cached_property
105
- def discriminator():
106
- return None
107
-
108
-
109
- attribute_map = {
110
- 'code': 'code', # noqa: E501
111
- 'detail': 'detail', # noqa: E501
112
- 'instance': 'instance', # noqa: E501
113
- 'source': 'source', # noqa: E501
114
- 'stack_trace': 'stackTrace', # noqa: E501
115
- 'title': 'title', # noqa: E501
116
- 'trace_id': 'traceId', # noqa: E501
117
- 'type': 'type', # noqa: E501
118
- }
119
-
120
- read_only_vars = {
121
- }
122
-
123
- _composed_schemas = {}
124
-
125
- @classmethod
126
- @convert_js_args_to_python_args
127
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
128
- """CommonError - a model defined in OpenAPI
129
-
130
- Keyword Args:
131
- _check_type (bool): if True, values for parameters in openapi_types
132
- will be type checked and a TypeError will be
133
- raised if the wrong type is input.
134
- Defaults to True
135
- _path_to_item (tuple/list): This is a list of keys or values to
136
- drill down to the model in received_data
137
- when deserializing a response
138
- _spec_property_naming (bool): True if the variable names in the input data
139
- are serialized names, as specified in the OpenAPI document.
140
- False if the variable names in the input data
141
- are pythonic names, e.g. snake case (default)
142
- _configuration (Configuration): the instance to use when
143
- deserializing a file_type parameter.
144
- If passed, type conversion is attempted
145
- If omitted no type conversion is done.
146
- _visited_composed_classes (tuple): This stores a tuple of
147
- classes that we have traveled through so that
148
- if we see that class again we will not use its
149
- discriminator again.
150
- When traveling through a discriminator, the
151
- composed schema that is
152
- is traveled through is added to this set.
153
- For example if Animal has a discriminator
154
- petType and we pass in "Dog", and the class Dog
155
- allOf includes Animal, we move through Animal
156
- once using the discriminator, and pick Dog.
157
- Then in Dog, we will make an instance of the
158
- Animal class but this time we won't travel
159
- through its discriminator because we passed in
160
- _visited_composed_classes = (Animal,)
161
- code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kabab-case.. [optional] # noqa: E501
162
- detail (str): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.. [optional] # noqa: E501
163
- instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem.. [optional] # noqa: E501
164
- source ({str: (str,)}): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501
165
- stack_trace (str): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [optional] # noqa: E501
166
- title (str): (RECOMMENDED) A short, human-readable summary of the problem type.. [optional] # noqa: E501
167
- trace_id (str): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501
168
- type (str): (REQUIRED) The classification of the error.. [optional] # noqa: E501
169
- """
170
-
171
- _check_type = kwargs.pop('_check_type', True)
172
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
173
- _path_to_item = kwargs.pop('_path_to_item', ())
174
- _configuration = kwargs.pop('_configuration', None)
175
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
176
-
177
- self = super(OpenApiModel, cls).__new__(cls)
178
-
179
- if args:
180
- for arg in args:
181
- if isinstance(arg, dict):
182
- kwargs.update(arg)
183
- else:
184
- raise ApiTypeError(
185
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
186
- args,
187
- self.__class__.__name__,
188
- ),
189
- path_to_item=_path_to_item,
190
- valid_classes=(self.__class__,),
191
- )
192
-
193
- self._data_store = {}
194
- self._check_type = _check_type
195
- self._spec_property_naming = _spec_property_naming
196
- self._path_to_item = _path_to_item
197
- self._configuration = _configuration
198
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
199
-
200
- for var_name, var_value in kwargs.items():
201
- if var_name not in self.attribute_map and \
202
- self._configuration is not None and \
203
- self._configuration.discard_unknown_keys and \
204
- self.additional_properties_type is None:
205
- # discard variable.
206
- continue
207
- setattr(self, var_name, var_value)
208
- return self
209
-
210
- required_properties = set([
211
- '_data_store',
212
- '_check_type',
213
- '_spec_property_naming',
214
- '_path_to_item',
215
- '_configuration',
216
- '_visited_composed_classes',
217
- ])
218
-
219
- @convert_js_args_to_python_args
220
- def __init__(self, *args, **kwargs): # noqa: E501
221
- """CommonError - a model defined in OpenAPI
222
-
223
- Keyword Args:
224
- _check_type (bool): if True, values for parameters in openapi_types
225
- will be type checked and a TypeError will be
226
- raised if the wrong type is input.
227
- Defaults to True
228
- _path_to_item (tuple/list): This is a list of keys or values to
229
- drill down to the model in received_data
230
- when deserializing a response
231
- _spec_property_naming (bool): True if the variable names in the input data
232
- are serialized names, as specified in the OpenAPI document.
233
- False if the variable names in the input data
234
- are pythonic names, e.g. snake case (default)
235
- _configuration (Configuration): the instance to use when
236
- deserializing a file_type parameter.
237
- If passed, type conversion is attempted
238
- If omitted no type conversion is done.
239
- _visited_composed_classes (tuple): This stores a tuple of
240
- classes that we have traveled through so that
241
- if we see that class again we will not use its
242
- discriminator again.
243
- When traveling through a discriminator, the
244
- composed schema that is
245
- is traveled through is added to this set.
246
- For example if Animal has a discriminator
247
- petType and we pass in "Dog", and the class Dog
248
- allOf includes Animal, we move through Animal
249
- once using the discriminator, and pick Dog.
250
- Then in Dog, we will make an instance of the
251
- Animal class but this time we won't travel
252
- through its discriminator because we passed in
253
- _visited_composed_classes = (Animal,)
254
- code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kabab-case.. [optional] # noqa: E501
255
- detail (str): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.. [optional] # noqa: E501
256
- instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem.. [optional] # noqa: E501
257
- source ({str: (str,)}): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501
258
- stack_trace (str): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [optional] # noqa: E501
259
- title (str): (RECOMMENDED) A short, human-readable summary of the problem type.. [optional] # noqa: E501
260
- trace_id (str): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501
261
- type (str): (REQUIRED) The classification of the error.. [optional] # noqa: E501
262
- """
263
-
264
- _check_type = kwargs.pop('_check_type', True)
265
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
266
- _path_to_item = kwargs.pop('_path_to_item', ())
267
- _configuration = kwargs.pop('_configuration', None)
268
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
269
-
270
- if args:
271
- for arg in args:
272
- if isinstance(arg, dict):
273
- kwargs.update(arg)
274
- else:
275
- raise ApiTypeError(
276
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
277
- args,
278
- self.__class__.__name__,
279
- ),
280
- path_to_item=_path_to_item,
281
- valid_classes=(self.__class__,),
282
- )
283
-
284
- self._data_store = {}
285
- self._check_type = _check_type
286
- self._spec_property_naming = _spec_property_naming
287
- self._path_to_item = _path_to_item
288
- self._configuration = _configuration
289
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
290
-
291
- for var_name, var_value in kwargs.items():
292
- if var_name not in self.attribute_map and \
293
- self._configuration is not None and \
294
- self._configuration.discard_unknown_keys and \
295
- self.additional_properties_type is None:
296
- # discard variable.
297
- continue
298
- setattr(self, var_name, var_value)
299
- if var_name in self.read_only_vars:
300
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
301
- f"class with read only attributes.")
@@ -1,301 +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 CommonWarning(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
- ('type',): {
59
- 'UNKNOWN': "unknown",
60
- 'ACCESS-CONTROL': "access-control",
61
- 'AUTHENTICATION': "authentication",
62
- 'AUTHORIZATION': "authorization",
63
- 'AVAILABILITY': "availability",
64
- 'DEPRECATION': "deprecation",
65
- 'QUOTA': "quota",
66
- 'VALIDATION': "validation",
67
- },
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
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
80
-
81
- _nullable = False
82
-
83
- @cached_property
84
- def openapi_types():
85
- """
86
- This must be a method because a model may have properties that are
87
- of type self, this must run after the class is loaded
88
-
89
- Returns
90
- openapi_types (dict): The key is attribute name
91
- and the value is attribute type.
92
- """
93
- return {
94
- 'code': (str,), # noqa: E501
95
- 'detail': (str,), # noqa: E501
96
- 'instance': (str,), # noqa: E501
97
- 'source': ({str: (str,)},), # noqa: E501
98
- 'stack_trace': (str,), # noqa: E501
99
- 'title': (str,), # noqa: E501
100
- 'trace_id': (str,), # noqa: E501
101
- 'type': (str,), # noqa: E501
102
- }
103
-
104
- @cached_property
105
- def discriminator():
106
- return None
107
-
108
-
109
- attribute_map = {
110
- 'code': 'code', # noqa: E501
111
- 'detail': 'detail', # noqa: E501
112
- 'instance': 'instance', # noqa: E501
113
- 'source': 'source', # noqa: E501
114
- 'stack_trace': 'stackTrace', # noqa: E501
115
- 'title': 'title', # noqa: E501
116
- 'trace_id': 'traceId', # noqa: E501
117
- 'type': 'type', # noqa: E501
118
- }
119
-
120
- read_only_vars = {
121
- }
122
-
123
- _composed_schemas = {}
124
-
125
- @classmethod
126
- @convert_js_args_to_python_args
127
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
128
- """CommonWarning - a model defined in OpenAPI
129
-
130
- Keyword Args:
131
- _check_type (bool): if True, values for parameters in openapi_types
132
- will be type checked and a TypeError will be
133
- raised if the wrong type is input.
134
- Defaults to True
135
- _path_to_item (tuple/list): This is a list of keys or values to
136
- drill down to the model in received_data
137
- when deserializing a response
138
- _spec_property_naming (bool): True if the variable names in the input data
139
- are serialized names, as specified in the OpenAPI document.
140
- False if the variable names in the input data
141
- are pythonic names, e.g. snake case (default)
142
- _configuration (Configuration): the instance to use when
143
- deserializing a file_type parameter.
144
- If passed, type conversion is attempted
145
- If omitted no type conversion is done.
146
- _visited_composed_classes (tuple): This stores a tuple of
147
- classes that we have traveled through so that
148
- if we see that class again we will not use its
149
- discriminator again.
150
- When traveling through a discriminator, the
151
- composed schema that is
152
- is traveled through is added to this set.
153
- For example if Animal has a discriminator
154
- petType and we pass in "Dog", and the class Dog
155
- allOf includes Animal, we move through Animal
156
- once using the discriminator, and pick Dog.
157
- Then in Dog, we will make an instance of the
158
- Animal class but this time we won't travel
159
- through its discriminator because we passed in
160
- _visited_composed_classes = (Animal,)
161
- code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kabab-case.. [optional] # noqa: E501
162
- detail (str): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.. [optional] # noqa: E501
163
- instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem.. [optional] # noqa: E501
164
- source ({str: (str,)}): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501
165
- stack_trace (str): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [optional] # noqa: E501
166
- title (str): (RECOMMENDED) A short, human-readable summary of the problem type.. [optional] # noqa: E501
167
- trace_id (str): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501
168
- type (str): (REQUIRED) The classification of the error.. [optional] # noqa: E501
169
- """
170
-
171
- _check_type = kwargs.pop('_check_type', True)
172
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
173
- _path_to_item = kwargs.pop('_path_to_item', ())
174
- _configuration = kwargs.pop('_configuration', None)
175
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
176
-
177
- self = super(OpenApiModel, cls).__new__(cls)
178
-
179
- if args:
180
- for arg in args:
181
- if isinstance(arg, dict):
182
- kwargs.update(arg)
183
- else:
184
- raise ApiTypeError(
185
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
186
- args,
187
- self.__class__.__name__,
188
- ),
189
- path_to_item=_path_to_item,
190
- valid_classes=(self.__class__,),
191
- )
192
-
193
- self._data_store = {}
194
- self._check_type = _check_type
195
- self._spec_property_naming = _spec_property_naming
196
- self._path_to_item = _path_to_item
197
- self._configuration = _configuration
198
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
199
-
200
- for var_name, var_value in kwargs.items():
201
- if var_name not in self.attribute_map and \
202
- self._configuration is not None and \
203
- self._configuration.discard_unknown_keys and \
204
- self.additional_properties_type is None:
205
- # discard variable.
206
- continue
207
- setattr(self, var_name, var_value)
208
- return self
209
-
210
- required_properties = set([
211
- '_data_store',
212
- '_check_type',
213
- '_spec_property_naming',
214
- '_path_to_item',
215
- '_configuration',
216
- '_visited_composed_classes',
217
- ])
218
-
219
- @convert_js_args_to_python_args
220
- def __init__(self, *args, **kwargs): # noqa: E501
221
- """CommonWarning - a model defined in OpenAPI
222
-
223
- Keyword Args:
224
- _check_type (bool): if True, values for parameters in openapi_types
225
- will be type checked and a TypeError will be
226
- raised if the wrong type is input.
227
- Defaults to True
228
- _path_to_item (tuple/list): This is a list of keys or values to
229
- drill down to the model in received_data
230
- when deserializing a response
231
- _spec_property_naming (bool): True if the variable names in the input data
232
- are serialized names, as specified in the OpenAPI document.
233
- False if the variable names in the input data
234
- are pythonic names, e.g. snake case (default)
235
- _configuration (Configuration): the instance to use when
236
- deserializing a file_type parameter.
237
- If passed, type conversion is attempted
238
- If omitted no type conversion is done.
239
- _visited_composed_classes (tuple): This stores a tuple of
240
- classes that we have traveled through so that
241
- if we see that class again we will not use its
242
- discriminator again.
243
- When traveling through a discriminator, the
244
- composed schema that is
245
- is traveled through is added to this set.
246
- For example if Animal has a discriminator
247
- petType and we pass in "Dog", and the class Dog
248
- allOf includes Animal, we move through Animal
249
- once using the discriminator, and pick Dog.
250
- Then in Dog, we will make an instance of the
251
- Animal class but this time we won't travel
252
- through its discriminator because we passed in
253
- _visited_composed_classes = (Animal,)
254
- code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kabab-case.. [optional] # noqa: E501
255
- detail (str): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.. [optional] # noqa: E501
256
- instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem.. [optional] # noqa: E501
257
- source ({str: (str,)}): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional] # noqa: E501
258
- stack_trace (str): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [optional] # noqa: E501
259
- title (str): (RECOMMENDED) A short, human-readable summary of the problem type.. [optional] # noqa: E501
260
- trace_id (str): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional] # noqa: E501
261
- type (str): (REQUIRED) The classification of the error.. [optional] # noqa: E501
262
- """
263
-
264
- _check_type = kwargs.pop('_check_type', True)
265
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
266
- _path_to_item = kwargs.pop('_path_to_item', ())
267
- _configuration = kwargs.pop('_configuration', None)
268
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
269
-
270
- if args:
271
- for arg in args:
272
- if isinstance(arg, dict):
273
- kwargs.update(arg)
274
- else:
275
- raise ApiTypeError(
276
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
277
- args,
278
- self.__class__.__name__,
279
- ),
280
- path_to_item=_path_to_item,
281
- valid_classes=(self.__class__,),
282
- )
283
-
284
- self._data_store = {}
285
- self._check_type = _check_type
286
- self._spec_property_naming = _spec_property_naming
287
- self._path_to_item = _path_to_item
288
- self._configuration = _configuration
289
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
290
-
291
- for var_name, var_value in kwargs.items():
292
- if var_name not in self.attribute_map and \
293
- self._configuration is not None and \
294
- self._configuration.discard_unknown_keys and \
295
- self.additional_properties_type is None:
296
- # discard variable.
297
- continue
298
- setattr(self, var_name, var_value)
299
- if var_name in self.read_only_vars:
300
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
301
- f"class with read only attributes.")