criteo-api-retailmedia-sdk 2024.7.0.250915__py3-none-any.whl → 2024.7.0.251009__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 (102) hide show
  1. {criteo_api_retailmedia_sdk-2024.7.0.250915.dist-info → criteo_api_retailmedia_sdk-2024.7.0.251009.dist-info}/METADATA +3 -3
  2. {criteo_api_retailmedia_sdk-2024.7.0.250915.dist-info → criteo_api_retailmedia_sdk-2024.7.0.251009.dist-info}/RECORD +60 -102
  3. criteo_api_retailmedia_v2024_07/__init__.py +1 -1
  4. criteo_api_retailmedia_v2024_07/api/accounts_api.py +7 -9
  5. criteo_api_retailmedia_v2024_07/api/analytics_api.py +8 -28
  6. criteo_api_retailmedia_v2024_07/api/balance_api.py +257 -261
  7. criteo_api_retailmedia_v2024_07/api/campaign_api.py +1307 -2452
  8. criteo_api_retailmedia_v2024_07/api_client.py +1 -1
  9. criteo_api_retailmedia_v2024_07/apis/__init__.py +0 -1
  10. criteo_api_retailmedia_v2024_07/configuration.py +1 -1
  11. criteo_api_retailmedia_v2024_07/model/add_funds_to_balance_v2.py +6 -6
  12. criteo_api_retailmedia_v2024_07/model/{external_add_to_basket_ids_update_model202110.py → add_to_basket_ids_update_model202110.py} +3 -3
  13. criteo_api_retailmedia_v2024_07/model/{external_add_to_basket_target202110.py → add_to_basket_target202110.py} +3 -3
  14. criteo_api_retailmedia_v2024_07/model/add_to_basket_target202110_response.py +8 -8
  15. criteo_api_retailmedia_v2024_07/model/async_campaigns_report.py +14 -0
  16. criteo_api_retailmedia_v2024_07/model/async_line_items_report.py +14 -0
  17. criteo_api_retailmedia_v2024_07/model/async_revenue_report.py +11 -0
  18. criteo_api_retailmedia_v2024_07/model/{external_auction_line_item.py → auction_line_item.py} +19 -25
  19. criteo_api_retailmedia_v2024_07/model/{external_auction_line_item_create_model.py → auction_line_item_create_model.py} +3 -3
  20. criteo_api_retailmedia_v2024_07/model/auction_line_item_paged_list_response.py +8 -8
  21. criteo_api_retailmedia_v2024_07/model/auction_line_item_response.py +8 -8
  22. criteo_api_retailmedia_v2024_07/model/{external_auction_line_item_update_model.py → auction_line_item_update_model.py} +6 -6
  23. criteo_api_retailmedia_v2024_07/model/{external_audience_ids_update_model202110.py → audience_ids_update_model202110.py} +3 -3
  24. criteo_api_retailmedia_v2024_07/model/{external_audience_target202110.py → audience_target202110.py} +3 -3
  25. criteo_api_retailmedia_v2024_07/model/audience_target202110_response.py +8 -8
  26. criteo_api_retailmedia_v2024_07/model/balance_campaign202110_paged_list_response.py +8 -8
  27. criteo_api_retailmedia_v2024_07/model/balance_response_v2.py +6 -6
  28. criteo_api_retailmedia_v2024_07/model/{paged_resource_collection_outcome_of_balance_response_v2.py → balance_response_v2_paged_list_response.py} +3 -3
  29. criteo_api_retailmedia_v2024_07/model/campaign_attributes_v202301.py +11 -15
  30. criteo_api_retailmedia_v2024_07/model/campaign_v202301.py +23 -33
  31. criteo_api_retailmedia_v2024_07/model/change_dates_of_balance_v2.py +9 -9
  32. criteo_api_retailmedia_v2024_07/model/{external_common_line_item.py → common_line_item.py} +19 -25
  33. criteo_api_retailmedia_v2024_07/model/common_line_item_paged_list_response.py +8 -8
  34. criteo_api_retailmedia_v2024_07/model/common_line_item_response.py +8 -8
  35. criteo_api_retailmedia_v2024_07/model/create_balance_v2.py +6 -6
  36. criteo_api_retailmedia_v2024_07/model/editable_campaign_attributes_v202301.py +11 -15
  37. criteo_api_retailmedia_v2024_07/model/files_variable_value.py +0 -3
  38. criteo_api_retailmedia_v2024_07/model/input_resource_of_auction_line_item_create_model.py +5 -5
  39. criteo_api_retailmedia_v2024_07/model/{external_keyword_target202110.py → keyword_target202110.py} +3 -3
  40. criteo_api_retailmedia_v2024_07/model/keyword_target202110_response.py +8 -8
  41. criteo_api_retailmedia_v2024_07/model/resource_of_auction_line_item.py +5 -5
  42. criteo_api_retailmedia_v2024_07/model/resource_of_auction_line_item_update_model.py +5 -5
  43. criteo_api_retailmedia_v2024_07/model/resource_of_common_line_item.py +5 -5
  44. criteo_api_retailmedia_v2024_07/model/{external_store_ids_update_model202110.py → store_ids_update_model202110.py} +3 -3
  45. criteo_api_retailmedia_v2024_07/model/{external_store_target202110.py → store_target202110.py} +3 -3
  46. criteo_api_retailmedia_v2024_07/model/store_target202110_response.py +8 -8
  47. criteo_api_retailmedia_v2024_07/model/value_resource_of_campaign_budget_overrides.py +2 -2
  48. criteo_api_retailmedia_v2024_07/model/value_resource_of_line_item_budget_overrides.py +2 -2
  49. criteo_api_retailmedia_v2024_07/model/value_resource_outcome_of_campaign_budget_overrides.py +8 -8
  50. criteo_api_retailmedia_v2024_07/model/value_resource_outcome_of_line_item_budget_overrides.py +8 -8
  51. criteo_api_retailmedia_v2024_07/model/value_type_resource_of_add_to_basket_ids_update_model202110.py +5 -5
  52. criteo_api_retailmedia_v2024_07/model/value_type_resource_of_add_to_basket_target202110.py +5 -5
  53. criteo_api_retailmedia_v2024_07/model/value_type_resource_of_audience_ids_update_model202110.py +5 -5
  54. criteo_api_retailmedia_v2024_07/model/value_type_resource_of_audience_target202110.py +5 -5
  55. criteo_api_retailmedia_v2024_07/model/value_type_resource_of_keyword_target202110.py +5 -5
  56. criteo_api_retailmedia_v2024_07/model/value_type_resource_of_store_ids_update_model202110.py +5 -5
  57. criteo_api_retailmedia_v2024_07/model/value_type_resource_of_store_target202110.py +5 -5
  58. criteo_api_retailmedia_v2024_07/models/__init__.py +12 -53
  59. criteo_api_retailmedia_v2024_07/api/audience_api.py +0 -657
  60. criteo_api_retailmedia_v2024_07/model/creative202210_list_response.py +0 -274
  61. criteo_api_retailmedia_v2024_07/model/external_line_item_capping202110.py +0 -280
  62. criteo_api_retailmedia_v2024_07/model/external_line_item_page202110.py +0 -293
  63. criteo_api_retailmedia_v2024_07/model/external_line_item_page_category202110.py +0 -273
  64. criteo_api_retailmedia_v2024_07/model/external_preferred_line_item202110.py +0 -377
  65. criteo_api_retailmedia_v2024_07/model/external_preferred_line_item_create_model202110.py +0 -345
  66. criteo_api_retailmedia_v2024_07/model/external_preferred_line_item_update_model202110.py +0 -335
  67. criteo_api_retailmedia_v2024_07/model/input_resource_of_preferred_line_item_create_model202110.py +0 -273
  68. criteo_api_retailmedia_v2024_07/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py +0 -285
  69. criteo_api_retailmedia_v2024_07/model/json_api_single_response_of_line_item_bid_multipliers.py +0 -287
  70. criteo_api_retailmedia_v2024_07/model/line_item_bid_multipliers.py +0 -291
  71. criteo_api_retailmedia_v2024_07/model/line_item_bid_multipliers_request.py +0 -269
  72. criteo_api_retailmedia_v2024_07/model/line_item_bid_multipliers_response.py +0 -281
  73. criteo_api_retailmedia_v2024_07/model/preferred_line_item202110_paged_list_response.py +0 -287
  74. criteo_api_retailmedia_v2024_07/model/preferred_line_item202110_response.py +0 -281
  75. criteo_api_retailmedia_v2024_07/model/preferred_line_item_create_model202110_request.py +0 -269
  76. criteo_api_retailmedia_v2024_07/model/preferred_line_item_update_model202110_request.py +0 -269
  77. criteo_api_retailmedia_v2024_07/model/report_outcome.py +0 -275
  78. criteo_api_retailmedia_v2024_07/model/resource_of_line_item_bid_multipliers.py +0 -277
  79. criteo_api_retailmedia_v2024_07/model/resource_of_preferred_line_item202110.py +0 -277
  80. criteo_api_retailmedia_v2024_07/model/resource_of_preferred_line_item_update_model202110.py +0 -277
  81. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v1.py +0 -315
  82. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v1_resource.py +0 -277
  83. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v1_response.py +0 -281
  84. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v2.py +0 -287
  85. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v2_resource.py +0 -277
  86. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_entity_v2_response.py +0 -281
  87. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_input_entity_v1.py +0 -269
  88. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_create_input_entity_v2.py +0 -269
  89. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v1.py +0 -291
  90. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v1_list_response.py +0 -281
  91. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v1_resource.py +0 -286
  92. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v2.py +0 -291
  93. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v2_list_response.py +0 -281
  94. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v2_resource.py +0 -277
  95. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_user_behavior_create_v2.py +0 -279
  96. criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_user_behavior_details_v2.py +0 -279
  97. criteo_api_retailmedia_v2024_07/model/rm_legacy_segment_customer_list.py +0 -275
  98. criteo_api_retailmedia_v2024_07/model/rm_legacy_segment_user_behavior_create_v2.py +0 -303
  99. criteo_api_retailmedia_v2024_07/model/rm_legacy_segment_user_behavior_v1.py +0 -306
  100. criteo_api_retailmedia_v2024_07/model/rm_legacy_segment_user_behavior_v2.py +0 -311
  101. {criteo_api_retailmedia_sdk-2024.7.0.250915.dist-info → criteo_api_retailmedia_sdk-2024.7.0.251009.dist-info}/WHEEL +0 -0
  102. {criteo_api_retailmedia_sdk-2024.7.0.250915.dist-info → criteo_api_retailmedia_sdk-2024.7.0.251009.dist-info}/top_level.txt +0 -0
@@ -1,291 +0,0 @@
1
- """
2
- Criteo API
3
-
4
- Criteo API - RetailMedia # noqa: E501
5
-
6
- The version of the OpenAPI document: 2024-07
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_v2024_07.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_v2024_07.exceptions import ApiAttributeError
30
-
31
-
32
- def lazy_import():
33
- from criteo_api_retailmedia_v2024_07.model.rm_legacy_segment_customer_list import RmLegacySegmentCustomerList
34
- from criteo_api_retailmedia_v2024_07.model.rm_legacy_segment_user_behavior_v1 import RmLegacySegmentUserBehaviorV1
35
- globals()['RmLegacySegmentCustomerList'] = RmLegacySegmentCustomerList
36
- globals()['RmLegacySegmentUserBehaviorV1'] = RmLegacySegmentUserBehaviorV1
37
-
38
-
39
- class RmLegacyAudienceGetEntityV1(ModelNormal):
40
- """NOTE: This class is auto generated by OpenAPI Generator.
41
- Ref: https://openapi-generator.tech
42
-
43
- Do not edit the class manually.
44
-
45
- Attributes:
46
- allowed_values (dict): The key is the tuple path to the attribute
47
- and the for var_name this is (var_name,). The value is a dict
48
- with a capitalized key describing the allowed value and an allowed
49
- value. These dicts store the allowed enum values.
50
- attribute_map (dict): The key is attribute name
51
- and the value is json key in definition.
52
- discriminator_value_class_map (dict): A dict to go from the discriminator
53
- variable value to the discriminator class name.
54
- validations (dict): The key is the tuple path to the attribute
55
- and the for var_name this is (var_name,). The value is a dict
56
- that stores validations for max_length, min_length, max_items,
57
- min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
58
- inclusive_minimum, and regex.
59
- additional_properties_type (tuple): A tuple of classes accepted
60
- as additional properties values.
61
- """
62
-
63
- allowed_values = {
64
- }
65
-
66
- validations = {
67
- }
68
-
69
- @cached_property
70
- def additional_properties_type():
71
- """
72
- This must be a method because a model may have properties that are
73
- of type self, this must run after the class is loaded
74
- """
75
- lazy_import()
76
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
77
-
78
- _nullable = 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
- 'name': (str,), # noqa: E501
93
- 'retailer_id': (str,), # noqa: E501
94
- 'customer_list_details': (RmLegacySegmentCustomerList,), # noqa: E501
95
- 'user_behavior_details': (RmLegacySegmentUserBehaviorV1,), # noqa: E501
96
- }
97
-
98
- @cached_property
99
- def discriminator():
100
- return None
101
-
102
-
103
- attribute_map = {
104
- 'name': 'name', # noqa: E501
105
- 'retailer_id': 'retailerId', # noqa: E501
106
- 'customer_list_details': 'customerListDetails', # noqa: E501
107
- 'user_behavior_details': 'userBehaviorDetails', # noqa: E501
108
- }
109
-
110
- read_only_vars = {
111
- }
112
-
113
- _composed_schemas = {}
114
-
115
- @classmethod
116
- @convert_js_args_to_python_args
117
- def _from_openapi_data(cls, name, retailer_id, *args, **kwargs): # noqa: E501
118
- """RmLegacyAudienceGetEntityV1 - a model defined in OpenAPI
119
-
120
- Args:
121
- name (str): Name of the audience
122
- retailer_id (str): ID of the retailer associated with this audience
123
-
124
- Keyword Args:
125
- _check_type (bool): if True, values for parameters in openapi_types
126
- will be type checked and a TypeError will be
127
- raised if the wrong type is input.
128
- Defaults to True
129
- _path_to_item (tuple/list): This is a list of keys or values to
130
- drill down to the model in received_data
131
- when deserializing a response
132
- _spec_property_naming (bool): True if the variable names in the input data
133
- are serialized names, as specified in the OpenAPI document.
134
- False if the variable names in the input data
135
- are pythonic names, e.g. snake case (default)
136
- _configuration (Configuration): the instance to use when
137
- deserializing a file_type parameter.
138
- If passed, type conversion is attempted
139
- If omitted no type conversion is done.
140
- _visited_composed_classes (tuple): This stores a tuple of
141
- classes that we have traveled through so that
142
- if we see that class again we will not use its
143
- discriminator again.
144
- When traveling through a discriminator, the
145
- composed schema that is
146
- is traveled through is added to this set.
147
- For example if Animal has a discriminator
148
- petType and we pass in "Dog", and the class Dog
149
- allOf includes Animal, we move through Animal
150
- once using the discriminator, and pick Dog.
151
- Then in Dog, we will make an instance of the
152
- Animal class but this time we won't travel
153
- through its discriminator because we passed in
154
- _visited_composed_classes = (Animal,)
155
- customer_list_details (RmLegacySegmentCustomerList): [optional] # noqa: E501
156
- user_behavior_details (RmLegacySegmentUserBehaviorV1): [optional] # noqa: E501
157
- """
158
-
159
- _check_type = kwargs.pop('_check_type', True)
160
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
161
- _path_to_item = kwargs.pop('_path_to_item', ())
162
- _configuration = kwargs.pop('_configuration', None)
163
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
164
-
165
- self = super(OpenApiModel, cls).__new__(cls)
166
-
167
- if args:
168
- for arg in args:
169
- if isinstance(arg, dict):
170
- kwargs.update(arg)
171
- else:
172
- raise ApiTypeError(
173
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
174
- args,
175
- self.__class__.__name__,
176
- ),
177
- path_to_item=_path_to_item,
178
- valid_classes=(self.__class__,),
179
- )
180
-
181
- self._data_store = {}
182
- self._check_type = _check_type
183
- self._spec_property_naming = _spec_property_naming
184
- self._path_to_item = _path_to_item
185
- self._configuration = _configuration
186
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
187
-
188
- self.name = name
189
- self.retailer_id = retailer_id
190
- for var_name, var_value in kwargs.items():
191
- if var_name not in self.attribute_map and \
192
- self._configuration is not None and \
193
- self._configuration.discard_unknown_keys and \
194
- self.additional_properties_type is None:
195
- # discard variable.
196
- continue
197
- setattr(self, var_name, var_value)
198
- return self
199
-
200
- required_properties = set([
201
- '_data_store',
202
- '_check_type',
203
- '_spec_property_naming',
204
- '_path_to_item',
205
- '_configuration',
206
- '_visited_composed_classes',
207
- ])
208
-
209
- @convert_js_args_to_python_args
210
- def __init__(self, name, retailer_id, *args, **kwargs): # noqa: E501
211
- """RmLegacyAudienceGetEntityV1 - a model defined in OpenAPI
212
-
213
- Args:
214
- name (str): Name of the audience
215
- retailer_id (str): ID of the retailer associated with this audience
216
-
217
- Keyword Args:
218
- _check_type (bool): if True, values for parameters in openapi_types
219
- will be type checked and a TypeError will be
220
- raised if the wrong type is input.
221
- Defaults to True
222
- _path_to_item (tuple/list): This is a list of keys or values to
223
- drill down to the model in received_data
224
- when deserializing a response
225
- _spec_property_naming (bool): True if the variable names in the input data
226
- are serialized names, as specified in the OpenAPI document.
227
- False if the variable names in the input data
228
- are pythonic names, e.g. snake case (default)
229
- _configuration (Configuration): the instance to use when
230
- deserializing a file_type parameter.
231
- If passed, type conversion is attempted
232
- If omitted no type conversion is done.
233
- _visited_composed_classes (tuple): This stores a tuple of
234
- classes that we have traveled through so that
235
- if we see that class again we will not use its
236
- discriminator again.
237
- When traveling through a discriminator, the
238
- composed schema that is
239
- is traveled through is added to this set.
240
- For example if Animal has a discriminator
241
- petType and we pass in "Dog", and the class Dog
242
- allOf includes Animal, we move through Animal
243
- once using the discriminator, and pick Dog.
244
- Then in Dog, we will make an instance of the
245
- Animal class but this time we won't travel
246
- through its discriminator because we passed in
247
- _visited_composed_classes = (Animal,)
248
- customer_list_details (RmLegacySegmentCustomerList): [optional] # noqa: E501
249
- user_behavior_details (RmLegacySegmentUserBehaviorV1): [optional] # noqa: E501
250
- """
251
-
252
- _check_type = kwargs.pop('_check_type', True)
253
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
254
- _path_to_item = kwargs.pop('_path_to_item', ())
255
- _configuration = kwargs.pop('_configuration', None)
256
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
257
-
258
- if args:
259
- for arg in args:
260
- if isinstance(arg, dict):
261
- kwargs.update(arg)
262
- else:
263
- raise ApiTypeError(
264
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
265
- args,
266
- self.__class__.__name__,
267
- ),
268
- path_to_item=_path_to_item,
269
- valid_classes=(self.__class__,),
270
- )
271
-
272
- self._data_store = {}
273
- self._check_type = _check_type
274
- self._spec_property_naming = _spec_property_naming
275
- self._path_to_item = _path_to_item
276
- self._configuration = _configuration
277
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
278
-
279
- self.name = name
280
- self.retailer_id = retailer_id
281
- for var_name, var_value in kwargs.items():
282
- if var_name not in self.attribute_map and \
283
- self._configuration is not None and \
284
- self._configuration.discard_unknown_keys and \
285
- self.additional_properties_type is None:
286
- # discard variable.
287
- continue
288
- setattr(self, var_name, var_value)
289
- if var_name in self.read_only_vars:
290
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
291
- f"class with read only attributes.")
@@ -1,281 +0,0 @@
1
- """
2
- Criteo API
3
-
4
- Criteo API - RetailMedia # noqa: E501
5
-
6
- The version of the OpenAPI document: 2024-07
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_v2024_07.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_v2024_07.exceptions import ApiAttributeError
30
-
31
-
32
- def lazy_import():
33
- from criteo_api_retailmedia_v2024_07.model.common_problem import CommonProblem
34
- from criteo_api_retailmedia_v2024_07.model.rm_legacy_audience_get_entity_v1_resource import RmLegacyAudienceGetEntityV1Resource
35
- globals()['CommonProblem'] = CommonProblem
36
- globals()['RmLegacyAudienceGetEntityV1Resource'] = RmLegacyAudienceGetEntityV1Resource
37
-
38
-
39
- class RmLegacyAudienceGetEntityV1ListResponse(ModelNormal):
40
- """NOTE: This class is auto generated by OpenAPI Generator.
41
- Ref: https://openapi-generator.tech
42
-
43
- Do not edit the class manually.
44
-
45
- Attributes:
46
- allowed_values (dict): The key is the tuple path to the attribute
47
- and the for var_name this is (var_name,). The value is a dict
48
- with a capitalized key describing the allowed value and an allowed
49
- value. These dicts store the allowed enum values.
50
- attribute_map (dict): The key is attribute name
51
- and the value is json key in definition.
52
- discriminator_value_class_map (dict): A dict to go from the discriminator
53
- variable value to the discriminator class name.
54
- validations (dict): The key is the tuple path to the attribute
55
- and the for var_name this is (var_name,). The value is a dict
56
- that stores validations for max_length, min_length, max_items,
57
- min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
58
- inclusive_minimum, and regex.
59
- additional_properties_type (tuple): A tuple of classes accepted
60
- as additional properties values.
61
- """
62
-
63
- allowed_values = {
64
- }
65
-
66
- validations = {
67
- }
68
-
69
- @cached_property
70
- def additional_properties_type():
71
- """
72
- This must be a method because a model may have properties that are
73
- of type self, this must run after the class is loaded
74
- """
75
- lazy_import()
76
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
77
-
78
- _nullable = False
79
-
80
- @cached_property
81
- def openapi_types():
82
- """
83
- This must be a method because a model may have properties that are
84
- of type self, this must run after the class is loaded
85
-
86
- Returns
87
- openapi_types (dict): The key is attribute name
88
- and the value is attribute type.
89
- """
90
- lazy_import()
91
- return {
92
- 'data': ([RmLegacyAudienceGetEntityV1Resource], none_type,), # noqa: E501
93
- 'errors': ([CommonProblem], none_type,), # noqa: E501
94
- 'warnings': ([CommonProblem], none_type,), # noqa: E501
95
- }
96
-
97
- @cached_property
98
- def discriminator():
99
- return None
100
-
101
-
102
- attribute_map = {
103
- 'data': 'data', # noqa: E501
104
- 'errors': 'errors', # noqa: E501
105
- 'warnings': 'warnings', # noqa: E501
106
- }
107
-
108
- read_only_vars = {
109
- 'errors', # noqa: E501
110
- 'warnings', # noqa: E501
111
- }
112
-
113
- _composed_schemas = {}
114
-
115
- @classmethod
116
- @convert_js_args_to_python_args
117
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
118
- """RmLegacyAudienceGetEntityV1ListResponse - a model defined in OpenAPI
119
-
120
- Keyword Args:
121
- _check_type (bool): if True, values for parameters in openapi_types
122
- will be type checked and a TypeError will be
123
- raised if the wrong type is input.
124
- Defaults to True
125
- _path_to_item (tuple/list): This is a list of keys or values to
126
- drill down to the model in received_data
127
- when deserializing a response
128
- _spec_property_naming (bool): True if the variable names in the input data
129
- are serialized names, as specified in the OpenAPI document.
130
- False if the variable names in the input data
131
- are pythonic names, e.g. snake case (default)
132
- _configuration (Configuration): the instance to use when
133
- deserializing a file_type parameter.
134
- If passed, type conversion is attempted
135
- If omitted no type conversion is done.
136
- _visited_composed_classes (tuple): This stores a tuple of
137
- classes that we have traveled through so that
138
- if we see that class again we will not use its
139
- discriminator again.
140
- When traveling through a discriminator, the
141
- composed schema that is
142
- is traveled through is added to this set.
143
- For example if Animal has a discriminator
144
- petType and we pass in "Dog", and the class Dog
145
- allOf includes Animal, we move through Animal
146
- once using the discriminator, and pick Dog.
147
- Then in Dog, we will make an instance of the
148
- Animal class but this time we won't travel
149
- through its discriminator because we passed in
150
- _visited_composed_classes = (Animal,)
151
- data ([RmLegacyAudienceGetEntityV1Resource], none_type): [optional] # noqa: E501
152
- errors ([CommonProblem], none_type): [optional] # noqa: E501
153
- warnings ([CommonProblem], none_type): [optional] # noqa: E501
154
- """
155
-
156
- _check_type = kwargs.pop('_check_type', True)
157
- _spec_property_naming = kwargs.pop('_spec_property_naming', True)
158
- _path_to_item = kwargs.pop('_path_to_item', ())
159
- _configuration = kwargs.pop('_configuration', None)
160
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
161
-
162
- self = super(OpenApiModel, cls).__new__(cls)
163
-
164
- if args:
165
- for arg in args:
166
- if isinstance(arg, dict):
167
- kwargs.update(arg)
168
- else:
169
- raise ApiTypeError(
170
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
171
- args,
172
- self.__class__.__name__,
173
- ),
174
- path_to_item=_path_to_item,
175
- valid_classes=(self.__class__,),
176
- )
177
-
178
- self._data_store = {}
179
- self._check_type = _check_type
180
- self._spec_property_naming = _spec_property_naming
181
- self._path_to_item = _path_to_item
182
- self._configuration = _configuration
183
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
184
-
185
- for var_name, var_value in kwargs.items():
186
- if var_name not in self.attribute_map and \
187
- self._configuration is not None and \
188
- self._configuration.discard_unknown_keys and \
189
- self.additional_properties_type is None:
190
- # discard variable.
191
- continue
192
- setattr(self, var_name, var_value)
193
- return self
194
-
195
- required_properties = set([
196
- '_data_store',
197
- '_check_type',
198
- '_spec_property_naming',
199
- '_path_to_item',
200
- '_configuration',
201
- '_visited_composed_classes',
202
- ])
203
-
204
- @convert_js_args_to_python_args
205
- def __init__(self, *args, **kwargs): # noqa: E501
206
- """RmLegacyAudienceGetEntityV1ListResponse - a model defined in OpenAPI
207
-
208
- Keyword Args:
209
- _check_type (bool): if True, values for parameters in openapi_types
210
- will be type checked and a TypeError will be
211
- raised if the wrong type is input.
212
- Defaults to True
213
- _path_to_item (tuple/list): This is a list of keys or values to
214
- drill down to the model in received_data
215
- when deserializing a response
216
- _spec_property_naming (bool): True if the variable names in the input data
217
- are serialized names, as specified in the OpenAPI document.
218
- False if the variable names in the input data
219
- are pythonic names, e.g. snake case (default)
220
- _configuration (Configuration): the instance to use when
221
- deserializing a file_type parameter.
222
- If passed, type conversion is attempted
223
- If omitted no type conversion is done.
224
- _visited_composed_classes (tuple): This stores a tuple of
225
- classes that we have traveled through so that
226
- if we see that class again we will not use its
227
- discriminator again.
228
- When traveling through a discriminator, the
229
- composed schema that is
230
- is traveled through is added to this set.
231
- For example if Animal has a discriminator
232
- petType and we pass in "Dog", and the class Dog
233
- allOf includes Animal, we move through Animal
234
- once using the discriminator, and pick Dog.
235
- Then in Dog, we will make an instance of the
236
- Animal class but this time we won't travel
237
- through its discriminator because we passed in
238
- _visited_composed_classes = (Animal,)
239
- data ([RmLegacyAudienceGetEntityV1Resource], none_type): [optional] # noqa: E501
240
- errors ([CommonProblem], none_type): [optional] # noqa: E501
241
- warnings ([CommonProblem], none_type): [optional] # noqa: E501
242
- """
243
-
244
- _check_type = kwargs.pop('_check_type', True)
245
- _spec_property_naming = kwargs.pop('_spec_property_naming', False)
246
- _path_to_item = kwargs.pop('_path_to_item', ())
247
- _configuration = kwargs.pop('_configuration', None)
248
- _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
249
-
250
- if args:
251
- for arg in args:
252
- if isinstance(arg, dict):
253
- kwargs.update(arg)
254
- else:
255
- raise ApiTypeError(
256
- "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
257
- args,
258
- self.__class__.__name__,
259
- ),
260
- path_to_item=_path_to_item,
261
- valid_classes=(self.__class__,),
262
- )
263
-
264
- self._data_store = {}
265
- self._check_type = _check_type
266
- self._spec_property_naming = _spec_property_naming
267
- self._path_to_item = _path_to_item
268
- self._configuration = _configuration
269
- self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
270
-
271
- for var_name, var_value in kwargs.items():
272
- if var_name not in self.attribute_map and \
273
- self._configuration is not None and \
274
- self._configuration.discard_unknown_keys and \
275
- self.additional_properties_type is None:
276
- # discard variable.
277
- continue
278
- setattr(self, var_name, var_value)
279
- if var_name in self.read_only_vars:
280
- raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
281
- f"class with read only attributes.")