criteo-api-retailmedia-sdk 0.0.240731__py3-none-any.whl → 0.0.240808__py3-none-any.whl

criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py

@@ -0,0 +1,270 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: Preview
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
+
+
+def lazy_import():
+    from criteo_api_retailmedia_preview.model.retail_media_seller import RetailMediaSeller
+    globals()['RetailMediaSeller'] = RetailMediaSeller
+
+
+class RetailMediaSellerAccountCreation(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+    }
+
+    validations = {
+    }
+
+    additional_properties_type = None
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        lazy_import()
+        return {
+            'name': (str, none_type,),  # noqa: E501
+            'company_name': (str, none_type,),  # noqa: E501
+            'sellers': ([RetailMediaSeller], none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'name': 'name',  # noqa: E501
+        'company_name': 'companyName',  # noqa: E501
+        'sellers': 'sellers',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """RetailMediaSellerAccountCreation - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            name (str, none_type): the name of the account, must be unique across all accounts. [optional]  # noqa: E501
+            company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional]  # noqa: E501
+            sellers ([RetailMediaSeller], none_type): list of sellers to associate to the new account. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """RetailMediaSellerAccountCreation - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            name (str, none_type): the name of the account, must be unique across all accounts. [optional]  # noqa: E501
+            company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional]  # noqa: E501
+            sellers ([RetailMediaSeller], none_type): list of sellers to associate to the new account. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")

criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1.py

@@ -31,7 +31,9 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 def lazy_import():
     from criteo_api_retailmedia_preview.model.rm_contact_list_v1 import RmContactListV1
+    from criteo_api_retailmedia_preview.model.rm_user_behavior_v1 import RmUserBehaviorV1
     globals()['RmContactListV1'] = RmContactListV1
+    globals()['RmUserBehaviorV1'] = RmUserBehaviorV1
 
 
 class RmAudienceSegmentEntityV1(ModelNormal):
@@ -63,6 +65,7 @@ class RmAudienceSegmentEntityV1(ModelNormal):
             'None': None,
             'UNKNOWN': "Unknown",
             'CONTACTLIST': "ContactList",
+            'USERBEHAVIOR': "UserBehavior",
         },
         ('channels',): {
             'None': None,
@@ -105,7 +108,9 @@ class RmAudienceSegmentEntityV1(ModelNormal):
             'type': (str, none_type,),  # noqa: E501
             'created_at': (datetime, none_type,),  # noqa: E501
             'updated_at': (datetime, none_type,),  # noqa: E501
+            'created_by_id': (str, none_type,),  # noqa: E501
             'contact_list': (RmContactListV1,),  # noqa: E501
+            'user_behavior': (RmUserBehaviorV1,),  # noqa: E501
             'channels': ([str], none_type,),  # noqa: E501
         }
 
@@ -122,7 +127,9 @@ class RmAudienceSegmentEntityV1(ModelNormal):
         'type': 'type',  # noqa: E501
         'created_at': 'createdAt',  # noqa: E501
         'updated_at': 'updatedAt',  # noqa: E501
+        'created_by_id': 'createdById',  # noqa: E501
         'contact_list': 'contactList',  # noqa: E501
+        'user_behavior': 'userBehavior',  # noqa: E501
         'channels': 'channels',  # noqa: E501
     }
 
@@ -174,7 +181,9 @@ class RmAudienceSegmentEntityV1(ModelNormal):
             type (str, none_type): Type of segment (read-only). [optional]  # noqa: E501
             created_at (datetime, none_type): ISO-8601 timestamp in UTC of segment creation (read-only). [optional]  # noqa: E501
             updated_at (datetime, none_type): ISO-8601 timestamp in UTC of segment update (read-only). [optional]  # noqa: E501
+            created_by_id (str, none_type): User that created the segment. [optional]  # noqa: E501
             contact_list (RmContactListV1): [optional]  # noqa: E501
+            user_behavior (RmUserBehaviorV1): [optional]  # noqa: E501
             channels ([str], none_type): Channels associated to the segment (read-only). [optional]  # noqa: E501
         """
 
@@ -268,7 +277,9 @@ class RmAudienceSegmentEntityV1(ModelNormal):
             type (str, none_type): Type of segment (read-only). [optional]  # noqa: E501
             created_at (datetime, none_type): ISO-8601 timestamp in UTC of segment creation (read-only). [optional]  # noqa: E501
             updated_at (datetime, none_type): ISO-8601 timestamp in UTC of segment update (read-only). [optional]  # noqa: E501
+            created_by_id (str, none_type): User that created the segment. [optional]  # noqa: E501
             contact_list (RmContactListV1): [optional]  # noqa: E501
+            user_behavior (RmUserBehaviorV1): [optional]  # noqa: E501
             channels ([str], none_type): Channels associated to the segment (read-only). [optional]  # noqa: E501
         """
 

criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py

@@ -55,6 +55,12 @@ class RmAudienceSegmentSearchEntityV1(ModelNormal):
     """
 
     allowed_values = {
+        ('audience_segment_types',): {
+            'None': None,
+            'UNKNOWN': "Unknown",
+            'CONTACTLIST': "ContactList",
+            'USERBEHAVIOR': "UserBehavior",
+        },
     }
 
     validations = {
@@ -83,6 +89,7 @@ class RmAudienceSegmentSearchEntityV1(ModelNormal):
         return {
             'audience_segment_ids': ([str], none_type,),  # noqa: E501
             'retailer_ids': ([str], none_type,),  # noqa: E501
+            'audience_segment_types': ([str], none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -93,6 +100,7 @@ class RmAudienceSegmentSearchEntityV1(ModelNormal):
     attribute_map = {
         'audience_segment_ids': 'audienceSegmentIds',  # noqa: E501
         'retailer_ids': 'retailerIds',  # noqa: E501
+        'audience_segment_types': 'audienceSegmentTypes',  # noqa: E501
     }
 
     read_only_vars = {
@@ -138,6 +146,7 @@ class RmAudienceSegmentSearchEntityV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             audience_segment_ids ([str], none_type): List of segment ids. [optional]  # noqa: E501
             retailer_ids ([str], none_type): List of retailer ids. [optional]  # noqa: E501
+            audience_segment_types ([str], none_type): List of segment types. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -225,6 +234,7 @@ class RmAudienceSegmentSearchEntityV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             audience_segment_ids ([str], none_type): List of segment ids. [optional]  # noqa: E501
             retailer_ids ([str], none_type): List of retailer ids. [optional]  # noqa: E501
+            audience_segment_types ([str], none_type): List of segment types. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_preview/model/rm_contact_list_v1.py

@@ -63,6 +63,13 @@ class RmContactListV1(ModelNormal):
             'IDENTITYLINK': "IdentityLink",
             'CUSTOMERID': "CustomerId",
         },
+        ('sharing_status',): {
+            'None': None,
+            'UNKNOWN': "Unknown",
+            'NOTSHARED': "NotShared",
+            'SHAREDWITHALL': "SharedWithAll",
+            'SHAREDWITHDEMANDACCOUNTS': "SharedWithDemandAccounts",
+        },
     }
 
     validations = {
@@ -91,6 +98,7 @@ class RmContactListV1(ModelNormal):
         return {
             'is_read_only': (bool, none_type,),  # noqa: E501
             'type': (str, none_type,),  # noqa: E501
+            'sharing_status': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -101,6 +109,7 @@ class RmContactListV1(ModelNormal):
     attribute_map = {
         'is_read_only': 'isReadOnly',  # noqa: E501
         'type': 'type',  # noqa: E501
+        'sharing_status': 'sharingStatus',  # noqa: E501
     }
 
     read_only_vars = {
@@ -146,6 +155,7 @@ class RmContactListV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             is_read_only (bool, none_type): Is the segment read-only. [optional]  # noqa: E501
             type (str, none_type): Indicates contact list type. [optional]  # noqa: E501
+            sharing_status (str, none_type): Indicates if the contact list is shared with other accounts. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -233,6 +243,7 @@ class RmContactListV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             is_read_only (bool, none_type): Is the segment read-only. [optional]  # noqa: E501
             type (str, none_type): Indicates contact list type. [optional]  # noqa: E501
+            sharing_status (str, none_type): Indicates if the contact list is shared with other accounts. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)