python-amazon-ad-api 1.2.1__tar.gz → 1.2.3__tar.gz

{python_amazon_ad_api-1.2.1 → python_amazon_ad_api-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.2.1
+Version: 1.2.3
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -263,10 +263,6 @@ curl \
 * [Profiles](https://python-amazon-ad-api.readthedocs.io/en/latest/api/profiles.html)
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/api/manager_accounts.html)
 
-Warning: [PLANNED DEPRECATION 1/3/2025]
-There is a new version 3 Portfolios API, please check the [migration guide](https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/portfolios-v2-v3).
-
-* [Portfolios](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfolios.html)
 * [PortfoliosV3](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfoliosV3.html)
 * [Invoices](https://python-amazon-ad-api.readthedocs.io/en/latest/api/invoices.html)
 * [Billing](https://python-amazon-ad-api.readthedocs.io/en/latest/api/billing.html)

{python_amazon_ad_api-1.2.1 → python_amazon_ad_api-1.2.3}/README.md

@@ -235,10 +235,6 @@ curl \
 * [Profiles](https://python-amazon-ad-api.readthedocs.io/en/latest/api/profiles.html)
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/api/manager_accounts.html)
 
-Warning: [PLANNED DEPRECATION 1/3/2025]
-There is a new version 3 Portfolios API, please check the [migration guide](https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/portfolios-v2-v3).
-
-* [Portfolios](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfolios.html)
 * [PortfoliosV3](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfoliosV3.html)
 * [Invoices](https://python-amazon-ad-api.readthedocs.io/en/latest/api/invoices.html)
 * [Billing](https://python-amazon-ad-api.readthedocs.io/en/latest/api/billing.html)

python_amazon_ad_api-1.2.3/ad_api/api/portfolios_v3.py

@@ -0,0 +1,152 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class PortfoliosV3(Client):
+    """ """
+
+    @sp_endpoint('/portfolios/list', method='POST')
+    def list_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
+        r"""
+        Lists portfolios. Replaces the retired ``GET /v2/portfolios``.
+
+        Keyword Args
+
+        - ``prefer`` (bool): send ``Prefer: return=representation`` so the answer
+          carries the full portfolio objects rather than only the ids. [optional]
+
+        Request Body (optional)
+
+        - ``portfolioIdFilter`` (object): narrow to those ids. Carries
+          ``include``, a list of portfolio ids.
+        - ``nameFilter`` (object): narrow by name. Carries ``include``, a list of
+          names, and ``queryTermMatchType``, ``BROAD_MATCH`` or ``EXACT_MATCH``.
+        - ``stateFilter`` (object): narrow by state. Carries ``include``, a list
+          of states.
+        - ``includeExtendedDataFields`` (boolean): also return
+          ``creationDateTime``, ``lastUpdateDateTime``, ``servingStatus`` and
+          ``statusReasons``.
+        - ``nextToken`` (string): pagination token from a previous answer.
+
+        Returns
+            ApiResponse with ``portfolios``, ``totalResults`` and ``nextToken``.
+            Answers ``200``.
+
+        """
+
+        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        prefer_value = 'return=representation'
+        if prefer:
+            headers.update({"Prefer": prefer_value})
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+
+
+    @sp_endpoint('/portfolios', method='POST')
+    def create_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
+        r"""
+        Creates portfolios.
+
+        Keyword Args
+
+        - ``prefer`` (bool): send ``Prefer: return=representation`` so the answer
+          carries the created portfolio objects rather than only the ids.
+          [optional]
+
+        Request Body (required)
+
+        - ``portfolios`` (array): the portfolios to create.
+
+          Each one carries:
+
+          - ``name`` (string): required. The portfolio name.
+          - ``state`` (string): required. The contract lists ``ENABLED`` as the
+            only value.
+          - ``budget.amount`` (number): the budget amount. Absent when the policy
+            is ``NO_CAP``.
+          - ``budget.currencyCode`` (string): one of ``AED``, ``AUD``, ``BRL``,
+            ``CAD``, ``CLP``, ``CNY``, ``COP``, ``EGP``, ``EUR``, ``GBP``,
+            ``INR``, ``JPY``, ``MXN``, ``NGN``, ``PLN``, ``SAR``, ``SEK``,
+            ``SGD``, ``TRY``, ``USD``, ``ZAR``.
+          - ``budget.policy`` (string): ``DATE_RANGE``, ``MONTHLY_RECURRING``,
+            ``NO_CAP`` or ``OTHER``.
+          - ``budget.startDate`` (string): ISO 8601. Required when the policy is
+            ``DATE_RANGE``.
+          - ``budget.endDate`` (string): ISO 8601. Optional under either policy.
+          - ``budgetControls.campaignUnspentBudgetSharing.featureState``
+            (string): ``ENABLED`` or ``DISABLED``.
+
+        Returns
+            ApiResponse with ``success`` and ``error`` lists, each item keyed by
+            the ``index`` it held in the body. Answers ``207``, a multi-status,
+            not ``200``.
+
+        """
+        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        prefer_value = 'return=representation'
+        if prefer:
+            headers.update({"Prefer": prefer_value})
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/portfolios', method='PUT')
+    def edit_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
+        r"""
+        Updates portfolios.
+
+        Keyword Args
+
+        - ``prefer`` (bool): send ``Prefer: return=representation`` so the answer
+          carries the updated portfolio objects rather than only the ids.
+          [optional]
+
+        Request Body (required)
+
+        - ``portfolios`` (array): the portfolios to update.
+
+          Each one carries ``portfolioId``, which is required, plus any of the
+          members ``create_portfolios`` accepts. Only what is sent is changed:
+
+          - ``portfolioId`` (string): required. The portfolio to update.
+          - ``name`` (string): the portfolio name.
+          - ``state`` (string): ``ENABLED``.
+          - ``budget.amount``, ``budget.currencyCode``, ``budget.policy``,
+            ``budget.startDate`` and ``budget.endDate`` as above.
+          - ``budgetControls.campaignUnspentBudgetSharing.featureState`` as above.
+
+        Returns
+            ApiResponse with ``success`` and ``error`` lists, each item keyed by
+            the ``index`` it held in the body. Answers ``207``, a multi-status,
+            not ``200``.
+
+        """
+        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        prefer_value = 'return=representation'
+        if prefer:
+            headers.update({"Prefer": prefer_value})
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+
+    @sp_endpoint('/portfolios/budget/usage', method='POST')
+    def get_budget_usage_for_portfolios(self, version: int = 1, **kwargs) -> ApiResponse:
+        r"""
+        Reports how much of each portfolio budget has been spent.
+
+        Request Body (required)
+
+        - ``portfolioIds`` (array): the portfolios to measure.
+
+        Returns
+            ApiResponse split into ``success`` and ``error``. A successful entry
+            carries ``portfolioId``, ``index``, ``budget``,
+            ``budgetUsagePercent`` and ``usageUpdatedTimestamp``. Answers
+            ``207``, a multi-status, not ``200``.
+
+        """
+        schema_version = 'application/vnd.portfoliobudgetusage.v' + str(version) + '+json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

{python_amazon_ad_api-1.2.1 → python_amazon_ad_api-1.2.3}/ad_api/api/validation_configurations.py

@@ -47,9 +47,21 @@ class ValidationConfigurations(Client):
         Retrieves the configuration values used in targeting clause validation for the requested inputted marketplace, entityType, and programType context/contexts.
 
         Request body
-            | **countryCodesList** (Array): [optional] The list of countryCode enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ US, CA, MX, BR, UK, DE, FR, ES, IN, IT, NL, AE, SA, SE, TR, PL, EG, JP, AU, SG, CN ]
-            | **entityTypesList** (Array): [optional] The list of entityType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SELLER, VENDOR ]
-            | **programTypesList** (Array): [optional] The list of programType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SB, SP, SD ]
+
+        - ``countryCodesList`` (Array): [optional] The list of countryCode enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ US, CA, MX, BR, UK, DE, FR, ES, IN,
+          IT, NL, AE, SA, SE, TR, PL, EG, JP, AU, SG, CN ]
+        - ``entityTypesList`` (Array): [optional] The list of entityType enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ SELLER, VENDOR ]
+        - ``programTypesList`` (Array): [optional] The list of programType enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ SB, SP, SD ]
+
         Returns:
             ApiResponse
 

python_amazon_ad_api-1.2.3/ad_api/version.py

@@ -0,0 +1 @@
+__version__ = "1.2.3"

{python_amazon_ad_api-1.2.1 → python_amazon_ad_api-1.2.3}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.2.1
+Version: 1.2.3
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -263,10 +263,6 @@ curl \
 * [Profiles](https://python-amazon-ad-api.readthedocs.io/en/latest/api/profiles.html)
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/api/manager_accounts.html)
 
-Warning: [PLANNED DEPRECATION 1/3/2025]
-There is a new version 3 Portfolios API, please check the [migration guide](https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/portfolios-v2-v3).
-
-* [Portfolios](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfolios.html)
 * [PortfoliosV3](https://python-amazon-ad-api.readthedocs.io/en/latest/api/portfoliosV3.html)
 * [Invoices](https://python-amazon-ad-api.readthedocs.io/en/latest/api/invoices.html)
 * [Billing](https://python-amazon-ad-api.readthedocs.io/en/latest/api/billing.html)

{python_amazon_ad_api-1.2.1 → python_amazon_ad_api-1.2.3}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = python-amazon-ad-api
-version = 1.2.1
+version = 1.2.3
 author = Daniel Alvaro
 author_email = denisneuf@hotmail.com
 description = Python wrapper for the Amazon Advertising API

{python_amazon_ad_api-1.2.1 → python_amazon_ad_api-1.2.3}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='python-amazon-ad-api',
-    version='1.2.1',
+    version='1.2.3',
     install_requires=[
         "requests>=2.27.1,<2.35.0",
         "six>=1.16,<1.18",

python_amazon_ad_api-1.2.1/ad_api/api/portfolios_v3.py

@@ -1,68 +0,0 @@
-from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
-
-
-class PortfoliosV3(Client):
-    """ """
-
-    @sp_endpoint('/portfolios/list', method='POST')
-    def list_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
-        r"""
-
-        list_portfolios(body: (str, dict)) -> ApiResponse
-
-        """
-
-        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
-        headers = {"Accept": schema_version, "Content-Type": schema_version}
-        prefer_value = 'return=representation'
-        if prefer:
-            headers.update({"Prefer": prefer_value})
-
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-
-
-    @sp_endpoint('/portfolios', method='POST')
-    def create_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
-        r"""
-
-        create_portfolios(body: (str, dict)) -> ApiResponse
-
-
-        """
-        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
-        headers = {"Accept": schema_version, "Content-Type": schema_version}
-        prefer_value = 'return=representation'
-        if prefer:
-            headers.update({"Prefer": prefer_value})
-
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-    @sp_endpoint('/portfolios', method='PUT')
-    def edit_portfolios(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
-        r"""
-
-        edit_portfolios(body: (str, dict)) -> ApiResponse
-
-
-        """
-        schema_version = 'application/vnd.spPortfolio.v' + str(version) + '+json'
-        headers = {"Accept": schema_version, "Content-Type": schema_version}
-        prefer_value = 'return=representation'
-        if prefer:
-            headers.update({"Prefer": prefer_value})
-
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-
-    @sp_endpoint('/portfolios/budget/usage', method='POST')
-    def get_budget_usage_for_portfolios(self, version: int = 1, **kwargs) -> ApiResponse:
-        r"""
-
-        get_budget_usage_for_portfolios(body: (str, dict)) -> ApiResponse
-
-
-        """
-        schema_version = 'application/vnd.portfoliobudgetusage.v' + str(version) + '+json'
-        headers = {"Accept": schema_version, "Content-Type": schema_version}
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

python_amazon_ad_api-1.2.1/ad_api/version.py

@@ -1 +0,0 @@
-__version__ = "1.2.1"