criteo-api-retailmedia-sdk 0.0.250425__py3-none-any.whl → 0.0.250618__py3-none-any.whl

criteo_api_retailmedia_preview/model/sponsored_products_line_item.py

@@ -0,0 +1,387 @@
+"""
+    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.flight_schedule import FlightSchedule
+    globals()['FlightSchedule'] = FlightSchedule
+
+
+class SponsoredProductsLineItem(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 = {
+        ('bid_strategy',): {
+            'None': None,
+            'UNKNOWN': "Unknown",
+            'CONVERSION': "Conversion",
+            'CLICKS': "Clicks",
+            'REVENUE': "Revenue",
+        },
+        ('buy_type',): {
+            'None': None,
+            'UNKNOWN': "Unknown",
+            'AUCTION': "Auction",
+            'PREFERRED': "Preferred",
+        },
+        ('status',): {
+            'None': None,
+            'UNKNOWN': "Unknown",
+            'ACTIVE': "Active",
+            'SCHEDULED': "Scheduled",
+            'DRAFT': "Draft",
+            'PAUSED': "Paused",
+            'BUDGETHIT': "BudgetHit",
+            'ENDED': "Ended",
+            'ARCHIVED': "Archived",
+            'NOFUNDS': "NoFunds",
+        },
+    }
+
+    validations = {
+        ('name',): {
+            'max_length': 255,
+            'min_length': 0,
+        },
+    }
+
+    additional_properties_type = None
+
+    _nullable = True
+
+    @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 {
+            'budget_remaining': (float, none_type,),  # noqa: E501
+            'campaign_id': (int,),  # noqa: E501
+            'created_at': (datetime,),  # noqa: E501
+            'external_line_item_id': (int,),  # noqa: E501
+            'name': (str,),  # noqa: E501
+            'start_date': (datetime,),  # noqa: E501
+            'target_retailer_id': (int,),  # noqa: E501
+            'updated_at': (datetime,),  # noqa: E501
+            'bid_strategy': (str, none_type,),  # noqa: E501
+            'budget': (float, none_type,),  # noqa: E501
+            'budget_spent': (float, none_type,),  # noqa: E501
+            'buy_type': (str, none_type,),  # noqa: E501
+            'daily_pacing': (float, none_type,),  # noqa: E501
+            'end_date': (datetime, none_type,),  # noqa: E501
+            'flight_schedule': (FlightSchedule,),  # noqa: E501
+            'is_auto_daily_pacing': (bool, none_type,),  # noqa: E501
+            'max_bid': (float, none_type,),  # noqa: E501
+            'monthly_pacing': (float, none_type,),  # noqa: E501
+            'status': (str, none_type,),  # noqa: E501
+            'target_bid': (float, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'budget_remaining': 'budgetRemaining',  # noqa: E501
+        'campaign_id': 'campaignId',  # noqa: E501
+        'created_at': 'createdAt',  # noqa: E501
+        'external_line_item_id': 'externalLineItemId',  # noqa: E501
+        'name': 'name',  # noqa: E501
+        'start_date': 'startDate',  # noqa: E501
+        'target_retailer_id': 'targetRetailerId',  # noqa: E501
+        'updated_at': 'updatedAt',  # noqa: E501
+        'bid_strategy': 'bidStrategy',  # noqa: E501
+        'budget': 'budget',  # noqa: E501
+        'budget_spent': 'budgetSpent',  # noqa: E501
+        'buy_type': 'buyType',  # noqa: E501
+        'daily_pacing': 'dailyPacing',  # noqa: E501
+        'end_date': 'endDate',  # noqa: E501
+        'flight_schedule': 'flightSchedule',  # noqa: E501
+        'is_auto_daily_pacing': 'isAutoDailyPacing',  # noqa: E501
+        'max_bid': 'maxBid',  # noqa: E501
+        'monthly_pacing': 'monthlyPacing',  # noqa: E501
+        'status': 'status',  # noqa: E501
+        'target_bid': 'targetBid',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, budget_remaining, campaign_id, created_at, external_line_item_id, name, start_date, target_retailer_id, updated_at, *args, **kwargs):  # noqa: E501
+        """SponsoredProductsLineItem - a model defined in OpenAPI
+
+        Args:
+            budget_remaining (float, none_type):
+            campaign_id (int):
+            created_at (datetime):
+            external_line_item_id (int):
+            name (str):
+            start_date (datetime):
+            target_retailer_id (int):
+            updated_at (datetime):
+
+        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,)
+            bid_strategy (str, none_type): [optional]  # noqa: E501
+            budget (float, none_type): [optional]  # noqa: E501
+            budget_spent (float, none_type): [optional]  # noqa: E501
+            buy_type (str, none_type): [optional]  # noqa: E501
+            daily_pacing (float, none_type): [optional]  # noqa: E501
+            end_date (datetime, none_type): [optional]  # noqa: E501
+            flight_schedule (FlightSchedule): [optional]  # noqa: E501
+            is_auto_daily_pacing (bool, none_type): [optional]  # noqa: E501
+            max_bid (float, none_type): [optional]  # noqa: E501
+            monthly_pacing (float, none_type): [optional]  # noqa: E501
+            status (str, none_type): Status of a line item.. [optional]  # noqa: E501
+            target_bid (float, none_type): [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__,)
+
+        self.budget_remaining = budget_remaining
+        self.campaign_id = campaign_id
+        self.created_at = created_at
+        self.external_line_item_id = external_line_item_id
+        self.name = name
+        self.start_date = start_date
+        self.target_retailer_id = target_retailer_id
+        self.updated_at = updated_at
+        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, budget_remaining, campaign_id, created_at, external_line_item_id, name, start_date, target_retailer_id, updated_at, *args, **kwargs):  # noqa: E501
+        """SponsoredProductsLineItem - a model defined in OpenAPI
+
+        Args:
+            budget_remaining (float, none_type):
+            campaign_id (int):
+            created_at (datetime):
+            external_line_item_id (int):
+            name (str):
+            start_date (datetime):
+            target_retailer_id (int):
+            updated_at (datetime):
+
+        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,)
+            bid_strategy (str, none_type): [optional]  # noqa: E501
+            budget (float, none_type): [optional]  # noqa: E501
+            budget_spent (float, none_type): [optional]  # noqa: E501
+            buy_type (str, none_type): [optional]  # noqa: E501
+            daily_pacing (float, none_type): [optional]  # noqa: E501
+            end_date (datetime, none_type): [optional]  # noqa: E501
+            flight_schedule (FlightSchedule): [optional]  # noqa: E501
+            is_auto_daily_pacing (bool, none_type): [optional]  # noqa: E501
+            max_bid (float, none_type): [optional]  # noqa: E501
+            monthly_pacing (float, none_type): [optional]  # noqa: E501
+            status (str, none_type): Status of a line item.. [optional]  # noqa: E501
+            target_bid (float, none_type): [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__,)
+
+        self.budget_remaining = budget_remaining
+        self.campaign_id = campaign_id
+        self.created_at = created_at
+        self.external_line_item_id = external_line_item_id
+        self.name = name
+        self.start_date = start_date
+        self.target_retailer_id = target_retailer_id
+        self.updated_at = updated_at
+        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.")