criteo-api-retailmedia-sdk 0.0.240207__py3-none-any.whl → 0.0.240404__py3-none-any.whl

criteo_api_retailmedia_preview/model/{creative202210.py → async_accounts_report.py}

@@ -29,14 +29,8 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
 from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
-def lazy_import():
-    from criteo_api_retailmedia_preview.model.page_type_environment import PageTypeEnvironment
-    from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue
-    globals()['PageTypeEnvironment'] = PageTypeEnvironment
-    globals()['TemplateVariableValue'] = TemplateVariableValue
 
-
-class Creative202210(ModelNormal):
+class AsyncAccountsReport(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -61,23 +55,93 @@ class Creative202210(ModelNormal):
     """
 
     allowed_values = {
-        ('status',): {
-            'READY': "Ready",
-            'IN_USE': "In_Use",
-            'ARCHIVED': "Archived",
-            'DELETED': "Deleted",
+        ('report_type',): {
+            'None': None,
+            'SUMMARY': "summary",
+            'PAGETYPE': "pageType",
+            'KEYWORD': "keyword",
+            'PRODUCTCATEGORY': "productCategory",
+            'PRODUCT': "product",
+            'ENVIRONMENT': "environment",
+            'SERVEDCATEGORY': "servedCategory",
+        },
+        ('aggregation_level',): {
+            'None': None,
+            'CAMPAIGN': "campaign",
+            'LINEITEM': "lineItem",
+        },
+        ('campaign_type',): {
+            'None': None,
+            'SPONSOREDPRODUCTS': "sponsoredProducts",
+            'ONSITEDISPLAYS': "onSiteDisplays",
+        },
+        ('sales_channel',): {
+            'None': None,
+            'OFFLINE': "offline",
+            'ONLINE': "online",
+        },
+        ('format',): {
+            'None': None,
+            'JSON': "json",
+            'JSON-COMPACT': "json-compact",
+            'JSON-NEWLINE': "json-newline",
+            'CSV': "csv",
+        },
+        ('click_attribution_window',): {
+            'None': None,
+            '7D': "7D",
+            '14D': "14D",
+            '30D': "30D",
+            'NONE': "none",
+        },
+        ('view_attribution_window',): {
+            'None': None,
+            '1D': "1D",
+            '7D': "7D",
+            '14D': "14D",
+            '30D': "30D",
+            'NONE': "none",
+        },
+        ('dimensions',): {
+            'None': None,
+            'DATE': "date",
+            'HOUR': "hour",
+            'ACCOUNTID': "accountId",
+            'ACCOUNTNAME': "accountName",
+            'CAMPAIGNID': "campaignId",
+            'CAMPAIGNNAME': "campaignName",
+            'CAMPAIGNTYPENAME': "campaignTypeName",
+            'ADVPRODUCTCATEGORY': "advProductCategory",
+            'ADVPRODUCTID': "advProductId",
+            'ADVPRODUCTNAME': "advProductName",
+            'BRANDID': "brandId",
+            'BRANDNAME': "brandName",
+            'LINEITEMID': "lineItemId",
+            'LINEITEMNAME': "lineItemName",
+            'RETAILERID': "retailerId",
+            'RETAILERNAME': "retailerName",
+            'KEYWORD': "keyword",
+            'PAGETYPENAME': "pageTypeName",
+            'SALESCHANNEL': "salesChannel",
+            'ENVIRONMENT': "environment",
         },
-        ('creative_format_type',): {
-            'UNKNOWN': "Unknown",
-            'FLAGSHIP': "FlagShip",
-            'SHOWCASE': "Showcase",
-            'SPONSOREDPRODUCTS': "SponsoredProducts",
-            'BUTTERFLY': "Butterfly",
-            'BUNDLEBOOST': "BundleBoost",
-            'IAB': "IAB",
-            'CUSTOM': "CUSTOM",
-            'DISPLAYPANEL': "DisplayPanel",
-            'DIGITALSHELFTALKER': "DigitalShelfTalker",
+        ('metrics',): {
+            'None': None,
+            'IMPRESSIONS': "impressions",
+            'CLICKS': "clicks",
+            'SPEND': "spend",
+            'ATTRIBUTEDSALES': "attributedSales",
+            'ATTRIBUTEDUNITS': "attributedUnits",
+            'ATTRIBUTEDORDERS': "attributedOrders",
+            'ASSISTEDSALES': "assistedSales",
+            'ASSISTEDUNITS': "assistedUnits",
+            'CTR': "ctr",
+            'CPC': "cpc",
+            'CPO': "cpo",
+            'CPM': "cpm",
+            'ROAS': "roas",
+            'UNIQUEVISITORS': "uniqueVisitors",
+            'FREQUENCY': "frequency",
         },
     }
 
@@ -90,7 +154,6 @@ class Creative202210(ModelNormal):
         This must be a method because a model may have properties that are
         of type self, this must run after the class is loaded
         """
-        lazy_import()
         return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
 
     _nullable = False
@@ -105,20 +168,20 @@ class Creative202210(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
-        lazy_import()
         return {
-            'name': (str,),  # noqa: E501
-            'status': (str,),  # noqa: E501
-            'retailer_id': (int,),  # noqa: E501
-            'template_id': (int,),  # noqa: E501
-            'template_name': (str,),  # noqa: E501
-            'format_id': (int,),  # noqa: E501
-            'creative_format_type': (str,),  # noqa: E501
-            'environments': ([PageTypeEnvironment],),  # noqa: E501
-            'template_variable_values': ([TemplateVariableValue],),  # noqa: E501
-            'brand_id': (int, none_type,),  # noqa: E501
-            'associated_line_item_ids': ([str],),  # noqa: E501
-            'updated_at': (datetime,),  # noqa: E501
+            'account_ids': ([str],),  # noqa: E501
+            'start_date': (datetime,),  # noqa: E501
+            'end_date': (datetime,),  # noqa: E501
+            'report_type': (str, none_type,),  # noqa: E501
+            'aggregation_level': (str, none_type,),  # noqa: E501
+            'campaign_type': (str, none_type,),  # noqa: E501
+            'sales_channel': (str, none_type,),  # noqa: E501
+            'format': (str, none_type,),  # noqa: E501
+            'click_attribution_window': (str, none_type,),  # noqa: E501
+            'view_attribution_window': (str, none_type,),  # noqa: E501
+            'dimensions': ([str], none_type,),  # noqa: E501
+            'metrics': ([str], none_type,),  # noqa: E501
+            'timezone': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -127,18 +190,19 @@ class Creative202210(ModelNormal):
 
 
     attribute_map = {
-        'name': 'name',  # noqa: E501
-        'status': 'status',  # noqa: E501
-        'retailer_id': 'retailerId',  # noqa: E501
-        'template_id': 'templateId',  # noqa: E501
-        'template_name': 'templateName',  # noqa: E501
-        'format_id': 'formatId',  # noqa: E501
-        'creative_format_type': 'creativeFormatType',  # noqa: E501
-        'environments': 'environments',  # noqa: E501
-        'template_variable_values': 'templateVariableValues',  # noqa: E501
-        'brand_id': 'brandId',  # noqa: E501
-        'associated_line_item_ids': 'associatedLineItemIds',  # noqa: E501
-        'updated_at': 'updatedAt',  # noqa: E501
+        'account_ids': 'accountIds',  # noqa: E501
+        'start_date': 'startDate',  # noqa: E501
+        'end_date': 'endDate',  # noqa: E501
+        'report_type': 'reportType',  # noqa: E501
+        'aggregation_level': 'aggregationLevel',  # noqa: E501
+        'campaign_type': 'campaignType',  # noqa: E501
+        'sales_channel': 'salesChannel',  # noqa: E501
+        'format': 'format',  # noqa: E501
+        'click_attribution_window': 'clickAttributionWindow',  # noqa: E501
+        'view_attribution_window': 'viewAttributionWindow',  # noqa: E501
+        'dimensions': 'dimensions',  # noqa: E501
+        'metrics': 'metrics',  # noqa: E501
+        'timezone': 'timezone',  # noqa: E501
     }
 
     read_only_vars = {
@@ -148,19 +212,13 @@ class Creative202210(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, name, status, retailer_id, template_id, template_name, format_id, creative_format_type, environments, template_variable_values, *args, **kwargs):  # noqa: E501
-        """Creative202210 - a model defined in OpenAPI
+    def _from_openapi_data(cls, account_ids, start_date, end_date, *args, **kwargs):  # noqa: E501
+        """AsyncAccountsReport - a model defined in OpenAPI
 
         Args:
-            name (str): Name
-            status (str): Creative Status
-            retailer_id (int): Retailer Id
-            template_id (int): Template Id
-            template_name (str): Template Name
-            format_id (int): Format Id
-            creative_format_type (str): Creative format type
-            environments ([PageTypeEnvironment]): Environment type (e.g. mobile, web, app)
-            template_variable_values ([TemplateVariableValue]): The template chosen values
+            account_ids ([str]): Account Ids to report on
+            start_date (datetime): Start date
+            end_date (datetime): End date
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -193,9 +251,16 @@ class Creative202210(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            brand_id (int, none_type): Brand Id. [optional]  # noqa: E501
-            associated_line_item_ids ([str]): Associated Line Item Ids. [optional]  # noqa: E501
-            updated_at (datetime): Updated at time. [optional]  # noqa: E501
+            report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
+            aggregation_level (str, none_type): Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign"  # noqa: E501
+            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional]  # noqa: E501
+            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional]  # noqa: E501
+            format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
+            click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
+            view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
+            dimensions ([str], none_type): List of dimensions to report on. [optional]  # noqa: E501
+            metrics ([str], none_type): List of metrics to report on. [optional]  # noqa: E501
+            timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -227,15 +292,9 @@ class Creative202210(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.name = name
-        self.status = status
-        self.retailer_id = retailer_id
-        self.template_id = template_id
-        self.template_name = template_name
-        self.format_id = format_id
-        self.creative_format_type = creative_format_type
-        self.environments = environments
-        self.template_variable_values = template_variable_values
+        self.account_ids = account_ids
+        self.start_date = start_date
+        self.end_date = end_date
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -256,19 +315,13 @@ class Creative202210(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, name, status, retailer_id, template_id, template_name, format_id, creative_format_type, environments, template_variable_values, *args, **kwargs):  # noqa: E501
-        """Creative202210 - a model defined in OpenAPI
+    def __init__(self, account_ids, start_date, end_date, *args, **kwargs):  # noqa: E501
+        """AsyncAccountsReport - a model defined in OpenAPI
 
         Args:
-            name (str): Name
-            status (str): Creative Status
-            retailer_id (int): Retailer Id
-            template_id (int): Template Id
-            template_name (str): Template Name
-            format_id (int): Format Id
-            creative_format_type (str): Creative format type
-            environments ([PageTypeEnvironment]): Environment type (e.g. mobile, web, app)
-            template_variable_values ([TemplateVariableValue]): The template chosen values
+            account_ids ([str]): Account Ids to report on
+            start_date (datetime): Start date
+            end_date (datetime): End date
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -301,9 +354,16 @@ class Creative202210(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            brand_id (int, none_type): Brand Id. [optional]  # noqa: E501
-            associated_line_item_ids ([str]): Associated Line Item Ids. [optional]  # noqa: E501
-            updated_at (datetime): Updated at time. [optional]  # noqa: E501
+            report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
+            aggregation_level (str, none_type): Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign"  # noqa: E501
+            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional]  # noqa: E501
+            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional]  # noqa: E501
+            format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
+            click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
+            view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
+            dimensions ([str], none_type): List of dimensions to report on. [optional]  # noqa: E501
+            metrics ([str], none_type): List of metrics to report on. [optional]  # noqa: E501
+            timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -333,15 +393,9 @@ class Creative202210(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.name = name
-        self.status = status
-        self.retailer_id = retailer_id
-        self.template_id = template_id
-        self.template_name = template_name
-        self.format_id = format_id
-        self.creative_format_type = creative_format_type
-        self.environments = environments
-        self.template_variable_values = template_variable_values
+        self.account_ids = account_ids
+        self.start_date = start_date
+        self.end_date = end_date
         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_preview/model/{external_catalog_request_preview.py → async_accounts_report_request.py}

@@ -29,8 +29,12 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
 from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
+def lazy_import():
+    from criteo_api_retailmedia_preview.model.async_accounts_report_resource import AsyncAccountsReportResource
+    globals()['AsyncAccountsReportResource'] = AsyncAccountsReportResource
 
-class ExternalCatalogRequestPreview(ModelNormal):
+
+class AsyncAccountsReportRequest(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -55,9 +59,6 @@ class ExternalCatalogRequestPreview(ModelNormal):
     """
 
     allowed_values = {
-        ('format',): {
-            'JSON-NEWLINE': "json-newline",
-        },
     }
 
     validations = {
@@ -69,6 +70,7 @@ class ExternalCatalogRequestPreview(ModelNormal):
         This must be a method because a model may have properties that are
         of type self, this must run after the class is loaded
         """
+        lazy_import()
         return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
 
     _nullable = False
@@ -83,8 +85,9 @@ class ExternalCatalogRequestPreview(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
-            'format': (str,),  # noqa: E501
+            'data': (AsyncAccountsReportResource,),  # noqa: E501
         }
 
     @cached_property
@@ -93,7 +96,7 @@ class ExternalCatalogRequestPreview(ModelNormal):
 
 
     attribute_map = {
-        'format': 'format',  # noqa: E501
+        'data': 'data',  # noqa: E501
     }
 
     read_only_vars = {
@@ -104,7 +107,7 @@ class ExternalCatalogRequestPreview(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """ExternalCatalogRequestPreview - a model defined in OpenAPI
+        """AsyncAccountsReportRequest - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -137,7 +140,7 @@ class ExternalCatalogRequestPreview(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            format (str): [optional] if omitted the server will use the default value of "json-newline"  # noqa: E501
+            data (AsyncAccountsReportResource): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -190,7 +193,7 @@ class ExternalCatalogRequestPreview(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """ExternalCatalogRequestPreview - a model defined in OpenAPI
+        """AsyncAccountsReportRequest - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -223,7 +226,7 @@ class ExternalCatalogRequestPreview(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            format (str): [optional] if omitted the server will use the default value of "json-newline"  # noqa: E501
+            data (AsyncAccountsReportResource): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)