criteo-api-retailmedia-sdk 2024.4.0.240626__py3-none-any.whl → 2024.4.0.240808__py3-none-any.whl

criteo_api_retailmedia_v2024_04/api_client.py

@@ -76,7 +76,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/2024.04.0.240626/python'
+        self.user_agent = 'OpenAPI-Generator/2024.04.0.240808/python'
 
     def __enter__(self):
         return self

criteo_api_retailmedia_v2024_04/apis/__init__.py

@@ -17,5 +17,6 @@
 from criteo_api_retailmedia_v2024_04.api.accounts_api import AccountsApi
 from criteo_api_retailmedia_v2024_04.api.analytics_api import AnalyticsApi
 from criteo_api_retailmedia_v2024_04.api.audience_api import AudienceApi
+from criteo_api_retailmedia_v2024_04.api.balance_api import BalanceApi
 from criteo_api_retailmedia_v2024_04.api.campaign_api import CampaignApi
 from criteo_api_retailmedia_v2024_04.api.gateway_api import GatewayApi

criteo_api_retailmedia_v2024_04/configuration.py

@@ -395,7 +395,7 @@ class Configuration(object):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2024-04\n"\
-               "SDK Package Version: 2024.04.0.240626".\
+               "SDK Package Version: 2024.04.0.240808".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

criteo_api_retailmedia_v2024_04/model/application_summary_model_response.py

@@ -64,10 +64,6 @@ class ApplicationSummaryModelResponse(ModelNormal):
     }
 
     validations = {
-        ('warnings',): {
-        },
-        ('errors',): {
-        },
     }
 
     @cached_property

criteo_api_retailmedia_v2024_04/model/async_campaigns_report.py

@@ -121,6 +121,8 @@ class AsyncCampaignsReport(ModelNormal):
             'SALESCHANNEL': "salesChannel",
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
+            'PAGECATEGORY': "pageCategory",
+            'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
             'KEYWORD': "keyword",
             'SEARCHTERM': "searchTerm",
         },

criteo_api_retailmedia_v2024_04/model/async_line_items_report.py

@@ -121,6 +121,8 @@ class AsyncLineItemsReport(ModelNormal):
             'SALESCHANNEL': "salesChannel",
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
+            'PAGECATEGORY': "pageCategory",
+            'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
             'KEYWORD': "keyword",
             'SEARCHTERM': "searchTerm",
         },

criteo_api_retailmedia_v2024_04/model/async_revenue_report.py

@@ -80,6 +80,12 @@ class AsyncRevenueReport(ModelNormal):
             'PREFERREDDEALS': "preferredDeals",
             'SPONSORSHIP': "sponsorship",
         },
+        ('advertiser_types',): {
+            'None': None,
+            'RETAILER': "retailer",
+            'BRAND': "brand",
+            'SELLER': "seller",
+        },
         ('sku_relations',): {
             'None': None,
             'SAMESKU': "sameSku",
@@ -130,6 +136,7 @@ class AsyncRevenueReport(ModelNormal):
             'ACCOUNTID': "accountId",
             'ACCOUNTNAME': "accountName",
             'ACCOUNTTYPENAME': "accountTypeName",
+            'ADVERTISERTYPE': "advertiserType",
             'CAMPAIGNID': "campaignId",
             'CAMPAIGNNAME': "campaignName",
             'CAMPAIGNTYPENAME': "campaignTypeName",
@@ -153,6 +160,7 @@ class AsyncRevenueReport(ModelNormal):
             'ADVPRODUCTNAME': "advProductName",
             'ADVPRODUCTGTIN': "advProductGtin",
             'ADVPRODUCTMPN': "advProductMpn",
+            'BUYTYPE': "buyType",
             'SOLDBY': "soldBy",
             'SALECHANNEL': "saleChannel",
             'ATTRIBUTIONSETTINGS': "attributionSettings",
@@ -193,6 +201,7 @@ class AsyncRevenueReport(ModelNormal):
             'TRANSACTIONS': "transactions",
             'ASSISTEDSALES': "assistedSales",
             'ASSISTEDUNITS': "assistedUnits",
+            'REVENUE': "revenue",
             'OPENAUCTIONREVENUE': "openAuctionRevenue",
             'PREFERREDDEALSREVENUE': "preferredDealsRevenue",
             'CTR': "ctr",
@@ -247,6 +256,7 @@ class AsyncRevenueReport(ModelNormal):
             'revenue_type': (str, none_type,),  # noqa: E501
             'sold_by': (str, none_type,),  # noqa: E501
             'buy_type': (str, none_type,),  # noqa: E501
+            'advertiser_types': ([str], none_type,),  # noqa: E501
             'sku_relations': ([str], none_type,),  # noqa: E501
             'format': (str, none_type,),  # noqa: E501
             'campaign_type': (str, none_type,),  # noqa: E501
@@ -272,6 +282,7 @@ class AsyncRevenueReport(ModelNormal):
         'revenue_type': 'revenueType',  # noqa: E501
         'sold_by': 'soldBy',  # noqa: E501
         'buy_type': 'buyType',  # noqa: E501
+        'advertiser_types': 'advertiserTypes',  # noqa: E501
         'sku_relations': 'skuRelations',  # noqa: E501
         'format': 'format',  # noqa: E501
         'campaign_type': 'campaignType',  # noqa: E501
@@ -328,12 +339,13 @@ class AsyncRevenueReport(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            ids ([str], none_type): Campaign ids to report on. [optional]  # noqa: E501
-            id (str, none_type): Campaign id to report on. [optional]  # noqa: E501
+            ids ([str], none_type): Supply account ids to report on. [optional]  # noqa: E501
+            id (str, none_type): Supply account id to report on. [optional]  # noqa: E501
             report_type (str, none_type): Type of report. [optional]  # noqa: E501
             revenue_type (str, none_type): Type of revenue. [optional]  # noqa: E501
             sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional]  # noqa: E501
             buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional]  # noqa: E501
+            advertiser_types ([str], none_type): Filter on the type of advertiser: retailer, brand, seller. [optional]  # noqa: E501
             sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [optional]  # noqa: E501
             format (str, none_type): Format of the output. [optional]  # noqa: E501
             campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
@@ -434,12 +446,13 @@ class AsyncRevenueReport(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            ids ([str], none_type): Campaign ids to report on. [optional]  # noqa: E501
-            id (str, none_type): Campaign id to report on. [optional]  # noqa: E501
+            ids ([str], none_type): Supply account ids to report on. [optional]  # noqa: E501
+            id (str, none_type): Supply account id to report on. [optional]  # noqa: E501
             report_type (str, none_type): Type of report. [optional]  # noqa: E501
             revenue_type (str, none_type): Type of revenue. [optional]  # noqa: E501
             sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional]  # noqa: E501
             buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional]  # noqa: E501
+            advertiser_types ([str], none_type): Filter on the type of advertiser: retailer, brand, seller. [optional]  # noqa: E501
             sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [optional]  # noqa: E501
             format (str, none_type): Format of the output. [optional]  # noqa: E501
             campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501

criteo_api_retailmedia_v2024_04/model/common_problem.py

@@ -164,7 +164,7 @@ class CommonProblem(ModelNormal):
             trace_id (str, none_type): The request correlation ID this problem comes from.. [optional]  # noqa: E501
             trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional]  # noqa: E501
             type (str, none_type): The problem's category.. [optional]  # noqa: E501
-            code (str, none_type): A machine-readable  error code, expressed as a string value.. [optional]  # noqa: E501
+            code (str, none_type): A machine-readable error code, expressed as a string value.. [optional]  # noqa: E501
             instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional]  # noqa: E501
             title (str, none_type): A short human-readable description of the problem type. [optional]  # noqa: E501
             detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional]  # noqa: E501
@@ -258,7 +258,7 @@ class CommonProblem(ModelNormal):
             trace_id (str, none_type): The request correlation ID this problem comes from.. [optional]  # noqa: E501
             trace_identifier (str, none_type): The request correlation ID this problem comes from. (deprecated, use traceId instead). [optional]  # noqa: E501
             type (str, none_type): The problem's category.. [optional]  # noqa: E501
-            code (str, none_type): A machine-readable  error code, expressed as a string value.. [optional]  # noqa: E501
+            code (str, none_type): A machine-readable error code, expressed as a string value.. [optional]  # noqa: E501
             instance (str, none_type): A URI that identifies the specific occurrence of the problem.. [optional]  # noqa: E501
             title (str, none_type): A short human-readable description of the problem type. [optional]  # noqa: E501
             detail (str, none_type): A human-readable explanation specific to this occurrence of the problem. [optional]  # noqa: E501

criteo_api_retailmedia_v2024_04/model/external_balance_response.py

@@ -71,6 +71,12 @@ class ExternalBalanceResponse(ModelNormal):
             'OFFSITE': "Offsite",
             'OFFSITEAWARENESS': "OffsiteAwareness",
         },
+        ('private_market_billing_type',): {
+            'NOTAPPLICABLE': "NotApplicable",
+            'BILLBYRETAILER': "BillByRetailer",
+            'BILLBYCRITEO': "BillByCriteo",
+            'UNKNOWN': "Unknown",
+        },
     }
 
     validations = {
@@ -111,6 +117,7 @@ class ExternalBalanceResponse(ModelNormal):
             'balance_type': (str,),  # noqa: E501
             'sales_force_id': (str,),  # noqa: E501
             'spend_type': (str,),  # noqa: E501
+            'private_market_billing_type': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -133,6 +140,7 @@ class ExternalBalanceResponse(ModelNormal):
         'balance_type': 'balanceType',  # noqa: E501
         'sales_force_id': 'salesForceId',  # noqa: E501
         'spend_type': 'spendType',  # noqa: E501
+        'private_market_billing_type': 'privateMarketBillingType',  # noqa: E501
     }
 
     read_only_vars = {
@@ -142,7 +150,7 @@ class ExternalBalanceResponse(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, name, po_number, memo, deposited, spent, remaining, start_date, end_date, status, created_at, updated_at, balance_type, sales_force_id, spend_type, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, name, po_number, memo, deposited, spent, remaining, start_date, end_date, status, created_at, updated_at, balance_type, sales_force_id, spend_type, private_market_billing_type, *args, **kwargs):  # noqa: E501
         """ExternalBalanceResponse - a model defined in OpenAPI
 
         Args:
@@ -160,6 +168,7 @@ class ExternalBalanceResponse(ModelNormal):
             balance_type (str): Type of the balance
             sales_force_id (str): SalesForceId the balance is linked to.
             spend_type (str): Spend Type of the balance.
+            private_market_billing_type (str): Billing type for Private Market.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -237,6 +246,7 @@ class ExternalBalanceResponse(ModelNormal):
         self.balance_type = balance_type
         self.sales_force_id = sales_force_id
         self.spend_type = spend_type
+        self.private_market_billing_type = private_market_billing_type
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -257,7 +267,7 @@ class ExternalBalanceResponse(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, name, po_number, memo, deposited, spent, remaining, start_date, end_date, status, created_at, updated_at, balance_type, sales_force_id, spend_type, *args, **kwargs):  # noqa: E501
+    def __init__(self, name, po_number, memo, deposited, spent, remaining, start_date, end_date, status, created_at, updated_at, balance_type, sales_force_id, spend_type, private_market_billing_type, *args, **kwargs):  # noqa: E501
         """ExternalBalanceResponse - a model defined in OpenAPI
 
         Args:
@@ -275,6 +285,7 @@ class ExternalBalanceResponse(ModelNormal):
             balance_type (str): Type of the balance
             sales_force_id (str): SalesForceId the balance is linked to.
             spend_type (str): Spend Type of the balance.
+            private_market_billing_type (str): Billing type for Private Market.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -350,6 +361,7 @@ class ExternalBalanceResponse(ModelNormal):
         self.balance_type = balance_type
         self.sales_force_id = sales_force_id
         self.spend_type = spend_type
+        self.private_market_billing_type = private_market_billing_type
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \

criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_account.py

@@ -93,10 +93,10 @@ class JsonApiPageResponseOfAccount(ModelNormal):
         """
         lazy_import()
         return {
+            'metadata': (PageMetadata,),  # noqa: E501
             'data': ([JsonApiBodyWithIdOfInt64AndAccountAndAccount],),  # noqa: E501
             'errors': ([CommonError],),  # noqa: E501
             'warnings': ([CommonWarning],),  # noqa: E501
-            'metadata': (PageMetadata,),  # noqa: E501
         }
 
     @cached_property
@@ -105,10 +105,10 @@ class JsonApiPageResponseOfAccount(ModelNormal):
 
 
     attribute_map = {
+        'metadata': 'metadata',  # noqa: E501
         'data': 'data',  # noqa: E501
         'errors': 'errors',  # noqa: E501
         'warnings': 'warnings',  # noqa: E501
-        'metadata': 'metadata',  # noqa: E501
     }
 
     read_only_vars = {
@@ -118,10 +118,11 @@ class JsonApiPageResponseOfAccount(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, data, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, metadata, data, *args, **kwargs):  # noqa: E501
         """JsonApiPageResponseOfAccount - a model defined in OpenAPI
 
         Args:
+            metadata (PageMetadata):
             data ([JsonApiBodyWithIdOfInt64AndAccountAndAccount]):
 
         Keyword Args:
@@ -157,7 +158,6 @@ class JsonApiPageResponseOfAccount(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             errors ([CommonError]): [optional]  # noqa: E501
             warnings ([CommonWarning]): [optional]  # noqa: E501
-            metadata (PageMetadata): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -189,6 +189,7 @@ class JsonApiPageResponseOfAccount(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.metadata = metadata
         self.data = data
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
@@ -210,10 +211,11 @@ class JsonApiPageResponseOfAccount(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, data, *args, **kwargs):  # noqa: E501
+    def __init__(self, metadata, data, *args, **kwargs):  # noqa: E501
         """JsonApiPageResponseOfAccount - a model defined in OpenAPI
 
         Args:
+            metadata (PageMetadata):
             data ([JsonApiBodyWithIdOfInt64AndAccountAndAccount]):
 
         Keyword Args:
@@ -249,7 +251,6 @@ class JsonApiPageResponseOfAccount(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             errors ([CommonError]): [optional]  # noqa: E501
             warnings ([CommonWarning]): [optional]  # noqa: E501
-            metadata (PageMetadata): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -279,6 +280,7 @@ class JsonApiPageResponseOfAccount(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.metadata = metadata
         self.data = data
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \

criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_brand.py

@@ -93,10 +93,10 @@ class JsonApiPageResponseOfBrand(ModelNormal):
         """
         lazy_import()
         return {
+            'metadata': (PageMetadata,),  # noqa: E501
             'data': ([JsonApiBodyWithIdOfInt64AndBrandAndBrand],),  # noqa: E501
             'errors': ([CommonError],),  # noqa: E501
             'warnings': ([CommonWarning],),  # noqa: E501
-            'metadata': (PageMetadata,),  # noqa: E501
         }
 
     @cached_property
@@ -105,10 +105,10 @@ class JsonApiPageResponseOfBrand(ModelNormal):
 
 
     attribute_map = {
+        'metadata': 'metadata',  # noqa: E501
         'data': 'data',  # noqa: E501
         'errors': 'errors',  # noqa: E501
         'warnings': 'warnings',  # noqa: E501
-        'metadata': 'metadata',  # noqa: E501
     }
 
     read_only_vars = {
@@ -118,10 +118,11 @@ class JsonApiPageResponseOfBrand(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, data, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, metadata, data, *args, **kwargs):  # noqa: E501
         """JsonApiPageResponseOfBrand - a model defined in OpenAPI
 
         Args:
+            metadata (PageMetadata):
             data ([JsonApiBodyWithIdOfInt64AndBrandAndBrand]):
 
         Keyword Args:
@@ -157,7 +158,6 @@ class JsonApiPageResponseOfBrand(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             errors ([CommonError]): [optional]  # noqa: E501
             warnings ([CommonWarning]): [optional]  # noqa: E501
-            metadata (PageMetadata): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -189,6 +189,7 @@ class JsonApiPageResponseOfBrand(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.metadata = metadata
         self.data = data
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
@@ -210,10 +211,11 @@ class JsonApiPageResponseOfBrand(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, data, *args, **kwargs):  # noqa: E501
+    def __init__(self, metadata, data, *args, **kwargs):  # noqa: E501
         """JsonApiPageResponseOfBrand - a model defined in OpenAPI
 
         Args:
+            metadata (PageMetadata):
             data ([JsonApiBodyWithIdOfInt64AndBrandAndBrand]):
 
         Keyword Args:
@@ -249,7 +251,6 @@ class JsonApiPageResponseOfBrand(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             errors ([CommonError]): [optional]  # noqa: E501
             warnings ([CommonWarning]): [optional]  # noqa: E501
-            metadata (PageMetadata): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -279,6 +280,7 @@ class JsonApiPageResponseOfBrand(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.metadata = metadata
         self.data = data
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \

criteo_api_retailmedia_v2024_04/model/json_api_page_response_of_retailer.py

@@ -93,10 +93,10 @@ class JsonApiPageResponseOfRetailer(ModelNormal):
         """
         lazy_import()
         return {
+            'metadata': (PageMetadata,),  # noqa: E501
             'data': ([JsonApiBodyWithIdOfInt64AndRetailerAndRetailer],),  # noqa: E501
             'errors': ([CommonError],),  # noqa: E501
             'warnings': ([CommonWarning],),  # noqa: E501
-            'metadata': (PageMetadata,),  # noqa: E501
         }
 
     @cached_property
@@ -105,10 +105,10 @@ class JsonApiPageResponseOfRetailer(ModelNormal):
 
 
     attribute_map = {
+        'metadata': 'metadata',  # noqa: E501
         'data': 'data',  # noqa: E501
         'errors': 'errors',  # noqa: E501
         'warnings': 'warnings',  # noqa: E501
-        'metadata': 'metadata',  # noqa: E501
     }
 
     read_only_vars = {
@@ -118,10 +118,11 @@ class JsonApiPageResponseOfRetailer(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, data, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, metadata, data, *args, **kwargs):  # noqa: E501
         """JsonApiPageResponseOfRetailer - a model defined in OpenAPI
 
         Args:
+            metadata (PageMetadata):
             data ([JsonApiBodyWithIdOfInt64AndRetailerAndRetailer]):
 
         Keyword Args:
@@ -157,7 +158,6 @@ class JsonApiPageResponseOfRetailer(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             errors ([CommonError]): [optional]  # noqa: E501
             warnings ([CommonWarning]): [optional]  # noqa: E501
-            metadata (PageMetadata): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -189,6 +189,7 @@ class JsonApiPageResponseOfRetailer(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.metadata = metadata
         self.data = data
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
@@ -210,10 +211,11 @@ class JsonApiPageResponseOfRetailer(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, data, *args, **kwargs):  # noqa: E501
+    def __init__(self, metadata, data, *args, **kwargs):  # noqa: E501
         """JsonApiPageResponseOfRetailer - a model defined in OpenAPI
 
         Args:
+            metadata (PageMetadata):
             data ([JsonApiBodyWithIdOfInt64AndRetailerAndRetailer]):
 
         Keyword Args:
@@ -249,7 +251,6 @@ class JsonApiPageResponseOfRetailer(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             errors ([CommonError]): [optional]  # noqa: E501
             warnings ([CommonWarning]): [optional]  # noqa: E501
-            metadata (PageMetadata): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -279,6 +280,7 @@ class JsonApiPageResponseOfRetailer(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.metadata = metadata
         self.data = data
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \