criteo-api-retailmedia-sdk 0.0.250205__py3-none-any.whl → 0.0.250217__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 (25) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +3 -3
  3. criteo_api_retailmedia_preview/api/campaign_api.py +5 -5
  4. criteo_api_retailmedia_preview/api_client.py +1 -1
  5. criteo_api_retailmedia_preview/configuration.py +1 -1
  6. criteo_api_retailmedia_preview/model/balance_response_v2.py +4 -4
  7. criteo_api_retailmedia_preview/model/brand_id_search_request.py +14 -5
  8. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_retail_media_seller.py → entity_resource_collection_outcome_brand_id_search_result_paging_offset_limit_metadata.py} +14 -8
  9. criteo_api_retailmedia_preview/model/external_catalog_status.py +3 -3
  10. criteo_api_retailmedia_preview/model/line_item_product_status.py +7 -7
  11. criteo_api_retailmedia_preview/model/paging_offset_limit_metadata.py +273 -0
  12. criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py +4 -4
  13. criteo_api_retailmedia_preview/model/report_ok_response.py +18 -18
  14. criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py +18 -31
  15. criteo_api_retailmedia_preview/model/{retail_media_contactlist_operation_response_attributes_attributes.py → retail_media_contactlist_amendment_attributes.py} +28 -33
  16. criteo_api_retailmedia_preview/model/retail_media_contactlist_operation.py +4 -0
  17. criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes.py +36 -20
  18. criteo_api_retailmedia_preview/model/seller_search_result.py +266 -0
  19. criteo_api_retailmedia_preview/model/{entity_resource_collection_outcome_brand_id_search_result.py → value_resource_collection_outcome_of_seller_search_result.py} +8 -8
  20. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller.py → value_resource_of_seller_search_result.py} +8 -8
  21. criteo_api_retailmedia_preview/models/__init__.py +6 -4
  22. {criteo_api_retailmedia_sdk-0.0.250205.dist-info → criteo_api_retailmedia_sdk-0.0.250217.dist-info}/METADATA +3 -3
  23. {criteo_api_retailmedia_sdk-0.0.250205.dist-info → criteo_api_retailmedia_sdk-0.0.250217.dist-info}/RECORD +25 -23
  24. {criteo_api_retailmedia_sdk-0.0.250205.dist-info → criteo_api_retailmedia_sdk-0.0.250217.dist-info}/WHEEL +0 -0
  25. {criteo_api_retailmedia_sdk-0.0.250205.dist-info → criteo_api_retailmedia_sdk-0.0.250217.dist-info}/top_level.txt +0 -0
@@ -8,7 +8,7 @@
8
8
  """
9
9
 
10
10
 
11
- __version__ = "0.0.250205"
11
+ __version__ = "0.0.250217"
12
12
 
13
13
  # import ApiClient
14
14
  from criteo_api_retailmedia_preview.api_client import ApiClient
@@ -24,7 +24,7 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
24
24
  from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_retail_media_child_account import EntityResourceCollectionOutcomeOfRetailMediaChildAccount
25
25
  from criteo_api_retailmedia_preview.model.grant_consent_input import GrantConsentInput
26
26
  from criteo_api_retailmedia_preview.model.outcome import Outcome
27
- from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_retail_media_seller import ValueResourceCollectionOutcomeOfRetailMediaSeller
27
+ from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_seller_search_result import ValueResourceCollectionOutcomeOfSellerSearchResult
28
28
  from criteo_api_retailmedia_preview.model.value_resource_input_of_seller_search import ValueResourceInputOfSellerSearch
29
29
 
30
30
 
@@ -162,7 +162,7 @@ class AccountsApi(object):
162
162
  )
163
163
  self.search_sellers_endpoint = _Endpoint(
164
164
  settings={
165
- 'response_type': (ValueResourceCollectionOutcomeOfRetailMediaSeller,),
165
+ 'response_type': (ValueResourceCollectionOutcomeOfSellerSearchResult,),
166
166
  'auth': [
167
167
  'oauth',
168
168
  'oauth'
@@ -434,7 +434,7 @@ class AccountsApi(object):
434
434
  async_req (bool): execute request asynchronously
435
435
 
436
436
  Returns:
437
- ValueResourceCollectionOutcomeOfRetailMediaSeller
437
+ ValueResourceCollectionOutcomeOfSellerSearchResult
438
438
  If the method is called asynchronously, returns the request
439
439
  thread.
440
440
  """
@@ -28,7 +28,7 @@ from criteo_api_retailmedia_preview.model.creative2_list_response import Creativ
28
28
  from criteo_api_retailmedia_preview.model.creative2_response import Creative2Response
29
29
  from criteo_api_retailmedia_preview.model.creative_create_model2 import CreativeCreateModel2
30
30
  from criteo_api_retailmedia_preview.model.creative_update_model2 import CreativeUpdateModel2
31
- from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_brand_id_search_result import EntityResourceCollectionOutcomeBrandIdSearchResult
31
+ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_brand_id_search_result_paging_offset_limit_metadata import EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata
32
32
  from criteo_api_retailmedia_preview.model.json_api_request_of_seller_catalog_request import JsonApiRequestOfSellerCatalogRequest
33
33
  from criteo_api_retailmedia_preview.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus
34
34
  from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers_v2 import JsonApiSingleResponseOfLineItemBidMultipliersV2
@@ -132,7 +132,7 @@ class CampaignApi(object):
132
132
  )
133
133
  self.append_promoted_products_endpoint = _Endpoint(
134
134
  settings={
135
- 'response_type': None,
135
+ 'response_type': (ProductResourceOutcome,),
136
136
  'auth': [
137
137
  'oauth',
138
138
  'oauth'
@@ -2041,7 +2041,7 @@ class CampaignApi(object):
2041
2041
  )
2042
2042
  self.search_brands_by_name_async_v1_endpoint = _Endpoint(
2043
2043
  settings={
2044
- 'response_type': (EntityResourceCollectionOutcomeBrandIdSearchResult,),
2044
+ 'response_type': (EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata,),
2045
2045
  'auth': [
2046
2046
  'oauth',
2047
2047
  'oauth'
@@ -2369,7 +2369,7 @@ class CampaignApi(object):
2369
2369
  async_req (bool): execute request asynchronously
2370
2370
 
2371
2371
  Returns:
2372
- None
2372
+ ProductResourceOutcome
2373
2373
  If the method is called asynchronously, returns the request
2374
2374
  thread.
2375
2375
  """
@@ -5000,7 +5000,7 @@ class CampaignApi(object):
5000
5000
  async_req (bool): execute request asynchronously
5001
5001
 
5002
5002
  Returns:
5003
- EntityResourceCollectionOutcomeBrandIdSearchResult
5003
+ EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata
5004
5004
  If the method is called asynchronously, returns the request
5005
5005
  thread.
5006
5006
  """
@@ -76,7 +76,7 @@ class ApiClient(object):
76
76
  self.default_headers[header_name] = header_value
77
77
  self.cookie = cookie
78
78
  # Set default User-Agent.
79
- self.user_agent = 'OpenAPI-Generator/0.0.250205/python'
79
+ self.user_agent = 'OpenAPI-Generator/0.0.250217/python'
80
80
 
81
81
  def __enter__(self):
82
82
  return self
@@ -395,7 +395,7 @@ class Configuration(object):
395
395
  "OS: {env}\n"\
396
396
  "Python Version: {pyversion}\n"\
397
397
  "Version of the API: Preview\n"\
398
- "SDK Package Version: 0.0.250205".\
398
+ "SDK Package Version: 0.0.250217".\
399
399
  format(env=sys.platform, pyversion=sys.version)
400
400
 
401
401
  def get_host_settings(self):
@@ -66,10 +66,10 @@ class BalanceResponseV2(ModelNormal):
66
66
  'OFFSITEAWARENESS': "OffsiteAwareness",
67
67
  },
68
68
  ('private_market_billing_type',): {
69
- 'NOTAPPLICABLE': "NotApplicable",
70
- 'BILLBYRETAILER': "BillByRetailer",
71
- 'BILLBYCRITEO': "BillByCriteo",
72
- 'UNKNOWN': "Unknown",
69
+ 'NOTAPPLICABLE': "notApplicable",
70
+ 'BILLBYRETAILER': "billByRetailer",
71
+ 'BILLBYCRITEO': "billByCriteo",
72
+ 'UNKNOWN': "unknown",
73
73
  },
74
74
  ('status',): {
75
75
  'UNKNOWN': "unknown",
@@ -64,6 +64,9 @@ class BrandIdSearchRequest(ModelNormal):
64
64
  }
65
65
 
66
66
  validations = {
67
+ ('retailer_ids',): {
68
+ 'min_items': 1,
69
+ },
67
70
  }
68
71
 
69
72
  additional_properties_type = None
@@ -81,7 +84,7 @@ class BrandIdSearchRequest(ModelNormal):
81
84
  and the value is attribute type.
82
85
  """
83
86
  return {
84
- 'retailer_ids': ([int], none_type,), # noqa: E501
87
+ 'retailer_ids': ([int],), # noqa: E501
85
88
  'name': (str, none_type,), # noqa: E501
86
89
  'brand_type': (str, none_type,), # noqa: E501
87
90
  }
@@ -104,9 +107,12 @@ class BrandIdSearchRequest(ModelNormal):
104
107
 
105
108
  @classmethod
106
109
  @convert_js_args_to_python_args
107
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
110
+ def _from_openapi_data(cls, retailer_ids, *args, **kwargs): # noqa: E501
108
111
  """BrandIdSearchRequest - a model defined in OpenAPI
109
112
 
113
+ Args:
114
+ retailer_ids ([int]): IDs of the retailers we want to limit the search to
115
+
110
116
  Keyword Args:
111
117
  _check_type (bool): if True, values for parameters in openapi_types
112
118
  will be type checked and a TypeError will be
@@ -138,7 +144,6 @@ class BrandIdSearchRequest(ModelNormal):
138
144
  Animal class but this time we won't travel
139
145
  through its discriminator because we passed in
140
146
  _visited_composed_classes = (Animal,)
141
- retailer_ids ([int], none_type): IDs of the retailers we want to limit the search to. [optional] # noqa: E501
142
147
  name (str, none_type): The name of the brand(s) to be searched. [optional] # noqa: E501
143
148
  brand_type (str, none_type): The type of brand, primarily where this brand belongs: UC, Retailer or All (both). [optional] # noqa: E501
144
149
  """
@@ -172,6 +177,7 @@ class BrandIdSearchRequest(ModelNormal):
172
177
  self._configuration = _configuration
173
178
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
174
179
 
180
+ self.retailer_ids = retailer_ids
175
181
  for var_name, var_value in kwargs.items():
176
182
  if var_name not in self.attribute_map and \
177
183
  self._configuration is not None and \
@@ -192,9 +198,12 @@ class BrandIdSearchRequest(ModelNormal):
192
198
  ])
193
199
 
194
200
  @convert_js_args_to_python_args
195
- def __init__(self, *args, **kwargs): # noqa: E501
201
+ def __init__(self, retailer_ids, *args, **kwargs): # noqa: E501
196
202
  """BrandIdSearchRequest - a model defined in OpenAPI
197
203
 
204
+ Args:
205
+ retailer_ids ([int]): IDs of the retailers we want to limit the search to
206
+
198
207
  Keyword Args:
199
208
  _check_type (bool): if True, values for parameters in openapi_types
200
209
  will be type checked and a TypeError will be
@@ -226,7 +235,6 @@ class BrandIdSearchRequest(ModelNormal):
226
235
  Animal class but this time we won't travel
227
236
  through its discriminator because we passed in
228
237
  _visited_composed_classes = (Animal,)
229
- retailer_ids ([int], none_type): IDs of the retailers we want to limit the search to. [optional] # noqa: E501
230
238
  name (str, none_type): The name of the brand(s) to be searched. [optional] # noqa: E501
231
239
  brand_type (str, none_type): The type of brand, primarily where this brand belongs: UC, Retailer or All (both). [optional] # noqa: E501
232
240
  """
@@ -258,6 +266,7 @@ class BrandIdSearchRequest(ModelNormal):
258
266
  self._configuration = _configuration
259
267
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
260
268
 
269
+ self.retailer_ids = retailer_ids
261
270
  for var_name, var_value in kwargs.items():
262
271
  if var_name not in self.attribute_map and \
263
272
  self._configuration is not None and \
@@ -30,13 +30,15 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
+ from criteo_api_retailmedia_preview.model.entity_resource_brand_id_search_result import EntityResourceBrandIdSearchResult
34
+ from criteo_api_retailmedia_preview.model.paging_offset_limit_metadata import PagingOffsetLimitMetadata
33
35
  from criteo_api_retailmedia_preview.model.sdk_api_rest_common_problem import SdkApiRestCommonProblem
34
- from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_seller import ValueResourceOfRetailMediaSeller
36
+ globals()['EntityResourceBrandIdSearchResult'] = EntityResourceBrandIdSearchResult
37
+ globals()['PagingOffsetLimitMetadata'] = PagingOffsetLimitMetadata
35
38
  globals()['SdkApiRestCommonProblem'] = SdkApiRestCommonProblem
36
- globals()['ValueResourceOfRetailMediaSeller'] = ValueResourceOfRetailMediaSeller
37
39
 
38
40
 
39
- class ValueResourceCollectionOutcomeOfRetailMediaSeller(ModelNormal):
41
+ class EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata(ModelNormal):
40
42
  """NOTE: This class is auto generated by OpenAPI Generator.
41
43
  Ref: https://openapi-generator.tech
42
44
 
@@ -82,7 +84,8 @@ class ValueResourceCollectionOutcomeOfRetailMediaSeller(ModelNormal):
82
84
  """
83
85
  lazy_import()
84
86
  return {
85
- 'data': ([ValueResourceOfRetailMediaSeller], none_type,), # noqa: E501
87
+ 'metadata': (PagingOffsetLimitMetadata,), # noqa: E501
88
+ 'data': ([EntityResourceBrandIdSearchResult], none_type,), # noqa: E501
86
89
  'warnings': ([SdkApiRestCommonProblem], none_type,), # noqa: E501
87
90
  'errors': ([SdkApiRestCommonProblem], none_type,), # noqa: E501
88
91
  }
@@ -93,6 +96,7 @@ class ValueResourceCollectionOutcomeOfRetailMediaSeller(ModelNormal):
93
96
 
94
97
 
95
98
  attribute_map = {
99
+ 'metadata': 'metadata', # noqa: E501
96
100
  'data': 'data', # noqa: E501
97
101
  'warnings': 'warnings', # noqa: E501
98
102
  'errors': 'errors', # noqa: E501
@@ -108,7 +112,7 @@ class ValueResourceCollectionOutcomeOfRetailMediaSeller(ModelNormal):
108
112
  @classmethod
109
113
  @convert_js_args_to_python_args
110
114
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
111
- """ValueResourceCollectionOutcomeOfRetailMediaSeller - a model defined in OpenAPI
115
+ """EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata - a model defined in OpenAPI
112
116
 
113
117
  Keyword Args:
114
118
  _check_type (bool): if True, values for parameters in openapi_types
@@ -141,7 +145,8 @@ class ValueResourceCollectionOutcomeOfRetailMediaSeller(ModelNormal):
141
145
  Animal class but this time we won't travel
142
146
  through its discriminator because we passed in
143
147
  _visited_composed_classes = (Animal,)
144
- data ([ValueResourceOfRetailMediaSeller], none_type): [optional] # noqa: E501
148
+ metadata (PagingOffsetLimitMetadata): [optional] # noqa: E501
149
+ data ([EntityResourceBrandIdSearchResult], none_type): [optional] # noqa: E501
145
150
  warnings ([SdkApiRestCommonProblem], none_type): Warnings that occured during this call.. [optional] # noqa: E501
146
151
  errors ([SdkApiRestCommonProblem], none_type): Errors that occured during this call.. [optional] # noqa: E501
147
152
  """
@@ -196,7 +201,7 @@ class ValueResourceCollectionOutcomeOfRetailMediaSeller(ModelNormal):
196
201
 
197
202
  @convert_js_args_to_python_args
198
203
  def __init__(self, *args, **kwargs): # noqa: E501
199
- """ValueResourceCollectionOutcomeOfRetailMediaSeller - a model defined in OpenAPI
204
+ """EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata - a model defined in OpenAPI
200
205
 
201
206
  Keyword Args:
202
207
  _check_type (bool): if True, values for parameters in openapi_types
@@ -229,7 +234,8 @@ class ValueResourceCollectionOutcomeOfRetailMediaSeller(ModelNormal):
229
234
  Animal class but this time we won't travel
230
235
  through its discriminator because we passed in
231
236
  _visited_composed_classes = (Animal,)
232
- data ([ValueResourceOfRetailMediaSeller], none_type): [optional] # noqa: E501
237
+ metadata (PagingOffsetLimitMetadata): [optional] # noqa: E501
238
+ data ([EntityResourceBrandIdSearchResult], none_type): [optional] # noqa: E501
233
239
  warnings ([SdkApiRestCommonProblem], none_type): Warnings that occured during this call.. [optional] # noqa: E501
234
240
  errors ([SdkApiRestCommonProblem], none_type): Errors that occured during this call.. [optional] # noqa: E501
235
241
  """
@@ -89,7 +89,7 @@ class ExternalCatalogStatus(ModelNormal):
89
89
  """
90
90
  return {
91
91
  'status': (str,), # noqa: E501
92
- 'currency': (str,), # noqa: E501
92
+ 'currency': (str, none_type,), # noqa: E501
93
93
  'row_count': (int, none_type,), # noqa: E501
94
94
  'file_size_bytes': (int, none_type,), # noqa: E501
95
95
  'md5_checksum': (str, none_type,), # noqa: E501
@@ -124,7 +124,7 @@ class ExternalCatalogStatus(ModelNormal):
124
124
 
125
125
  Args:
126
126
  status (str): An enumeration of the status of the catalog.
127
- currency (str): An ISO4217 representation of the currency products are listed under in this catalog.
127
+ currency (str, none_type): An ISO4217 representation of the currency products are listed under in this catalog.
128
128
  row_count (int, none_type): An indication of the number of products contained in this catalog. Available when this catalog reaches a success status.
129
129
  file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status.
130
130
  md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval. Available when this catalog reaches a success status.
@@ -225,7 +225,7 @@ class ExternalCatalogStatus(ModelNormal):
225
225
 
226
226
  Args:
227
227
  status (str): An enumeration of the status of the catalog.
228
- currency (str): An ISO4217 representation of the currency products are listed under in this catalog.
228
+ currency (str, none_type): An ISO4217 representation of the currency products are listed under in this catalog.
229
229
  row_count (int, none_type): An indication of the number of products contained in this catalog. Available when this catalog reaches a success status.
230
230
  file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status.
231
231
  md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval. Available when this catalog reaches a success status.
@@ -52,9 +52,9 @@ class LineItemProductStatus(ModelSimple):
52
52
 
53
53
  allowed_values = {
54
54
  ('value',): {
55
- 'UNKNOWN': "Unknown",
56
- 'ACTIVE': "Active",
57
- 'PAUSED': "Paused",
55
+ 'UNKNOWN': "unknown",
56
+ 'ACTIVE': "active",
57
+ 'PAUSED': "paused",
58
58
  },
59
59
  }
60
60
 
@@ -106,10 +106,10 @@ class LineItemProductStatus(ModelSimple):
106
106
  Note that value can be passed either in args or in kwargs, but not in both.
107
107
 
108
108
  Args:
109
- args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ] # noqa: E501
109
+ args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["unknown", "active", "paused", ] # noqa: E501
110
110
 
111
111
  Keyword Args:
112
- value (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ] # noqa: E501
112
+ value (str): The status of a promoted product in the context of the line item.., must be one of ["unknown", "active", "paused", ] # noqa: E501
113
113
  _check_type (bool): if True, values for parameters in openapi_types
114
114
  will be type checked and a TypeError will be
115
115
  raised if the wrong type is input.
@@ -200,10 +200,10 @@ class LineItemProductStatus(ModelSimple):
200
200
  Note that value can be passed either in args or in kwargs, but not in both.
201
201
 
202
202
  Args:
203
- args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ] # noqa: E501
203
+ args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["unknown", "active", "paused", ] # noqa: E501
204
204
 
205
205
  Keyword Args:
206
- value (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ] # noqa: E501
206
+ value (str): The status of a promoted product in the context of the line item.., must be one of ["unknown", "active", "paused", ] # noqa: E501
207
207
  _check_type (bool): if True, values for parameters in openapi_types
208
208
  will be type checked and a TypeError will be
209
209
  raised if the wrong type is input.
@@ -0,0 +1,273 @@
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 PagingOffsetLimitMetadata(ModelNormal):
34
+ """NOTE: This class is auto generated by OpenAPI Generator.
35
+ Ref: https://openapi-generator.tech
36
+
37
+ Do not edit the class manually.
38
+
39
+ Attributes:
40
+ allowed_values (dict): The key is the tuple path to the attribute
41
+ and the for var_name this is (var_name,). The value is a dict
42
+ with a capitalized key describing the allowed value and an allowed
43
+ value. These dicts store the allowed enum values.
44
+ attribute_map (dict): The key is attribute name
45
+ and the value is json key in definition.
46
+ discriminator_value_class_map (dict): A dict to go from the discriminator
47
+ variable value to the discriminator class name.
48
+ validations (dict): The key is the tuple path to the attribute
49
+ and the for var_name this is (var_name,). The value is a dict
50
+ that stores validations for max_length, min_length, max_items,
51
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
52
+ inclusive_minimum, and regex.
53
+ additional_properties_type (tuple): A tuple of classes accepted
54
+ as additional properties values.
55
+ """
56
+
57
+ allowed_values = {
58
+ }
59
+
60
+ validations = {
61
+ }
62
+
63
+ additional_properties_type = None
64
+
65
+ _nullable = False
66
+
67
+ @cached_property
68
+ def openapi_types():
69
+ """
70
+ This must be a method because a model may have properties that are
71
+ of type self, this must run after the class is loaded
72
+
73
+ Returns
74
+ openapi_types (dict): The key is attribute name
75
+ and the value is attribute type.
76
+ """
77
+ return {
78
+ 'offset': (int,), # noqa: E501
79
+ 'limit': (int,), # noqa: E501
80
+ 'count': (int, none_type,), # noqa: E501
81
+ }
82
+
83
+ @cached_property
84
+ def discriminator():
85
+ return None
86
+
87
+
88
+ attribute_map = {
89
+ 'offset': 'offset', # noqa: E501
90
+ 'limit': 'limit', # noqa: E501
91
+ 'count': 'count', # noqa: E501
92
+ }
93
+
94
+ read_only_vars = {
95
+ }
96
+
97
+ _composed_schemas = {}
98
+
99
+ @classmethod
100
+ @convert_js_args_to_python_args
101
+ def _from_openapi_data(cls, offset, limit, *args, **kwargs): # noqa: E501
102
+ """PagingOffsetLimitMetadata - a model defined in OpenAPI
103
+
104
+ Args:
105
+ offset (int): The (zero-based) starting offset in the collection.
106
+ limit (int): The number of elements to be returned.
107
+
108
+ Keyword Args:
109
+ _check_type (bool): if True, values for parameters in openapi_types
110
+ will be type checked and a TypeError will be
111
+ raised if the wrong type is input.
112
+ Defaults to True
113
+ _path_to_item (tuple/list): This is a list of keys or values to
114
+ drill down to the model in received_data
115
+ when deserializing a response
116
+ _spec_property_naming (bool): True if the variable names in the input data
117
+ are serialized names, as specified in the OpenAPI document.
118
+ False if the variable names in the input data
119
+ are pythonic names, e.g. snake case (default)
120
+ _configuration (Configuration): the instance to use when
121
+ deserializing a file_type parameter.
122
+ If passed, type conversion is attempted
123
+ If omitted no type conversion is done.
124
+ _visited_composed_classes (tuple): This stores a tuple of
125
+ classes that we have traveled through so that
126
+ if we see that class again we will not use its
127
+ discriminator again.
128
+ When traveling through a discriminator, the
129
+ composed schema that is
130
+ is traveled through is added to this set.
131
+ For example if Animal has a discriminator
132
+ petType and we pass in "Dog", and the class Dog
133
+ allOf includes Animal, we move through Animal
134
+ once using the discriminator, and pick Dog.
135
+ Then in Dog, we will make an instance of the
136
+ Animal class but this time we won't travel
137
+ through its discriminator because we passed in
138
+ _visited_composed_classes = (Animal,)
139
+ count (int, none_type): [optional] # noqa: E501
140
+ """
141
+
142
+ _check_type = kwargs.pop('_check_type', True)
143
+ _spec_property_naming = kwargs.pop('_spec_property_naming', True)
144
+ _path_to_item = kwargs.pop('_path_to_item', ())
145
+ _configuration = kwargs.pop('_configuration', None)
146
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
147
+
148
+ self = super(OpenApiModel, cls).__new__(cls)
149
+
150
+ if args:
151
+ for arg in args:
152
+ if isinstance(arg, dict):
153
+ kwargs.update(arg)
154
+ else:
155
+ raise ApiTypeError(
156
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
157
+ args,
158
+ self.__class__.__name__,
159
+ ),
160
+ path_to_item=_path_to_item,
161
+ valid_classes=(self.__class__,),
162
+ )
163
+
164
+ self._data_store = {}
165
+ self._check_type = _check_type
166
+ self._spec_property_naming = _spec_property_naming
167
+ self._path_to_item = _path_to_item
168
+ self._configuration = _configuration
169
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
170
+
171
+ self.offset = offset
172
+ self.limit = limit
173
+ for var_name, var_value in kwargs.items():
174
+ if var_name not in self.attribute_map and \
175
+ self._configuration is not None and \
176
+ self._configuration.discard_unknown_keys and \
177
+ self.additional_properties_type is None:
178
+ # discard variable.
179
+ continue
180
+ setattr(self, var_name, var_value)
181
+ return self
182
+
183
+ required_properties = set([
184
+ '_data_store',
185
+ '_check_type',
186
+ '_spec_property_naming',
187
+ '_path_to_item',
188
+ '_configuration',
189
+ '_visited_composed_classes',
190
+ ])
191
+
192
+ @convert_js_args_to_python_args
193
+ def __init__(self, offset, limit, *args, **kwargs): # noqa: E501
194
+ """PagingOffsetLimitMetadata - a model defined in OpenAPI
195
+
196
+ Args:
197
+ offset (int): The (zero-based) starting offset in the collection.
198
+ limit (int): The number of elements to be returned.
199
+
200
+ Keyword Args:
201
+ _check_type (bool): if True, values for parameters in openapi_types
202
+ will be type checked and a TypeError will be
203
+ raised if the wrong type is input.
204
+ Defaults to True
205
+ _path_to_item (tuple/list): This is a list of keys or values to
206
+ drill down to the model in received_data
207
+ when deserializing a response
208
+ _spec_property_naming (bool): True if the variable names in the input data
209
+ are serialized names, as specified in the OpenAPI document.
210
+ False if the variable names in the input data
211
+ are pythonic names, e.g. snake case (default)
212
+ _configuration (Configuration): the instance to use when
213
+ deserializing a file_type parameter.
214
+ If passed, type conversion is attempted
215
+ If omitted no type conversion is done.
216
+ _visited_composed_classes (tuple): This stores a tuple of
217
+ classes that we have traveled through so that
218
+ if we see that class again we will not use its
219
+ discriminator again.
220
+ When traveling through a discriminator, the
221
+ composed schema that is
222
+ is traveled through is added to this set.
223
+ For example if Animal has a discriminator
224
+ petType and we pass in "Dog", and the class Dog
225
+ allOf includes Animal, we move through Animal
226
+ once using the discriminator, and pick Dog.
227
+ Then in Dog, we will make an instance of the
228
+ Animal class but this time we won't travel
229
+ through its discriminator because we passed in
230
+ _visited_composed_classes = (Animal,)
231
+ count (int, none_type): [optional] # noqa: E501
232
+ """
233
+
234
+ _check_type = kwargs.pop('_check_type', True)
235
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
236
+ _path_to_item = kwargs.pop('_path_to_item', ())
237
+ _configuration = kwargs.pop('_configuration', None)
238
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
239
+
240
+ if args:
241
+ for arg in args:
242
+ if isinstance(arg, dict):
243
+ kwargs.update(arg)
244
+ else:
245
+ raise ApiTypeError(
246
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
247
+ args,
248
+ self.__class__.__name__,
249
+ ),
250
+ path_to_item=_path_to_item,
251
+ valid_classes=(self.__class__,),
252
+ )
253
+
254
+ self._data_store = {}
255
+ self._check_type = _check_type
256
+ self._spec_property_naming = _spec_property_naming
257
+ self._path_to_item = _path_to_item
258
+ self._configuration = _configuration
259
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
260
+
261
+ self.offset = offset
262
+ self.limit = limit
263
+ for var_name, var_value in kwargs.items():
264
+ if var_name not in self.attribute_map and \
265
+ self._configuration is not None and \
266
+ self._configuration.discard_unknown_keys and \
267
+ self.additional_properties_type is None:
268
+ # discard variable.
269
+ continue
270
+ setattr(self, var_name, var_value)
271
+ if var_name in self.read_only_vars:
272
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
273
+ f"class with read only attributes.")
@@ -86,7 +86,7 @@ class PromotedProductResourceCollectionOutcome(ModelNormal):
86
86
  return {
87
87
  'errors': ([RmcaCommonProblem], none_type,), # noqa: E501
88
88
  'warnings': ([RmcaCommonProblem], none_type,), # noqa: E501
89
- 'metadata': (ProductMetadata,), # noqa: E501
89
+ 'meta': (ProductMetadata,), # noqa: E501
90
90
  'data': ([PromotedProductResource], none_type,), # noqa: E501
91
91
  }
92
92
 
@@ -98,7 +98,7 @@ class PromotedProductResourceCollectionOutcome(ModelNormal):
98
98
  attribute_map = {
99
99
  'errors': 'errors', # noqa: E501
100
100
  'warnings': 'warnings', # noqa: E501
101
- 'metadata': 'metadata', # noqa: E501
101
+ 'meta': 'meta', # noqa: E501
102
102
  'data': 'data', # noqa: E501
103
103
  }
104
104
 
@@ -147,7 +147,7 @@ class PromotedProductResourceCollectionOutcome(ModelNormal):
147
147
  _visited_composed_classes = (Animal,)
148
148
  errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501
149
149
  warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501
150
- metadata (ProductMetadata): [optional] # noqa: E501
150
+ meta (ProductMetadata): [optional] # noqa: E501
151
151
  data ([PromotedProductResource], none_type): [optional] # noqa: E501
152
152
  """
153
153
 
@@ -236,7 +236,7 @@ class PromotedProductResourceCollectionOutcome(ModelNormal):
236
236
  _visited_composed_classes = (Animal,)
237
237
  errors ([RmcaCommonProblem], none_type): [optional] # noqa: E501
238
238
  warnings ([RmcaCommonProblem], none_type): [optional] # noqa: E501
239
- metadata (ProductMetadata): [optional] # noqa: E501
239
+ meta (ProductMetadata): [optional] # noqa: E501
240
240
  data ([PromotedProductResource], none_type): [optional] # noqa: E501
241
241
  """
242
242