lib-shopware6-api-base 2.1.7__tar.gz → 2.1.8__tar.gz

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/.docs/README_template.rst

@@ -2,7 +2,7 @@ lib_shopware6_api_base
 ======================
 
 
-Version v2.1.7 as of 2023-10-18 see `Changelog`_
+Version v2.1.8 as of 2024-09-29 see `Changelog`_
 
 
 .. include:: ./badges.rst

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/.docs/installation.rst

@@ -1,10 +1,9 @@
-- Before You start, its highly recommended to update pip and setup tools:
+- Before You start, its highly recommended to update pip:
 
 
 .. code-block::
 
     python -m pip --upgrade pip
-    python -m pip --upgrade setuptools
 
 
 .. include:: ./installation_via_pypi.rst

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/.docs/tested_under.rst

@@ -1,3 +1,3 @@
-tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12-dev, pypy-3.9, pypy-3.10 - architectures: amd64
+tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12, pypy-3.9, pypy-3.10 - architectures: amd64
 
 `100% code coverage <https://codeclimate.com/github/bitranox/lib_shopware6_api_base/test_coverage>`_, flake8 style checking ,mypy static type checking ,tested under `Linux <https://github.com/bitranox/lib_shopware6_api_base/actions/workflows/python-package.yml>`_, automatic daily builds and monitoring

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/.github/workflows/python-package.yml

@@ -50,7 +50,7 @@ jobs:
 
         # MYPY tests
         MYPY_DO_TESTS: "True"
-        MYPY_OPTIONS: "--follow-imports=normal --ignore-missing-imports --implicit-reexport --install-types --no-warn-unused-ignores --non-interactive --strict"
+        MYPY_OPTIONS: "--follow-imports=normal --ignore-missing-imports --install-types --no-warn-unused-ignores --non-interactive --strict"
         MYPYPATH: "./.3rd_party_stubs"
 
         # coverage
@@ -70,7 +70,7 @@ jobs:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
         # make PyPi API token available in Environment
         PYPI_UPLOAD_API_TOKEN: ${{ secrets.PYPI_UPLOAD_API_TOKEN }}
-
+        # additional Environment Variables:
 
     strategy:
       matrix:
@@ -124,7 +124,7 @@ jobs:
               DO_CLI_TEST: "True"
 
           - os: ubuntu-latest
-            python-version: "3.12-dev"
+            python-version: "3.12"
             env:
               BUILD_DOCS: "True"
               BUILD: "True"  
@@ -161,11 +161,11 @@ jobs:
 
     steps:
     # see : https://github.com/actions/checkout
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Setting up Python ${{ matrix.python-version }}
       # see: https://github.com/actions/setup-python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/CHANGES.rst

@@ -5,6 +5,11 @@ Changelog
 - new MINOR version for added functionality in a backwards compatible manner
 - new PATCH version for backwards compatible bug fixes
 
+v2.1.8
+---------
+2024-09-29:
+    - add example for /search/order via post request
+
 v2.1.7
 ---------
 2023-10-18:

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 1990-2023 Robert Nowotny
+Copyright (c) 1990-2024 Robert Nowotny
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lib_shopware6_api_base
-Version: 2.1.7
+Version: 2.1.8
 Summary: python3 base API client for shopware6
 Author-email: Robert Nowotny <bitranox@gmail.com>
 License: MIT
@@ -24,7 +24,7 @@ Requires-Dist: click
 Requires-Dist: lib_detect_testenv
 Requires-Dist: oauthlib
 Requires-Dist: requests
-Requires-Dist: requests_oauthlib
+Requires-Dist: requests-oauthlib
 Provides-Extra: test
 Requires-Dist: black; extra == "test"
 Requires-Dist: codecov; extra == "test"
@@ -41,7 +41,7 @@ lib_shopware6_api_base
 ======================
 
 
-Version v2.1.7 as of 2023-10-18 see `Changelog`_
+Version v2.1.8 as of 2024-09-29 see `Changelog`_
 
 |build_badge| |codeql| |license| |pypi|
 |pypi-downloads| |black| |codecov| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
@@ -109,7 +109,7 @@ automated tests, Github Actions, Documentation, Badges, etc. are managed with `P
 
 Python version required: 3.8.0 or newer
 
-tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12-dev, pypy-3.9, pypy-3.10 - architectures: amd64
+tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12, pypy-3.9, pypy-3.10 - architectures: amd64
 
 `100% code coverage <https://codeclimate.com/github/bitranox/lib_shopware6_api_base/test_coverage>`_, flake8 style checking ,mypy static type checking ,tested under `Linux <https://github.com/bitranox/lib_shopware6_api_base/actions/workflows/python-package.yml>`_, automatic daily builds and monitoring
 
@@ -610,8 +610,6 @@ Admin API
             >>> my_payload=Criteria()
             >>> my_response_dict = my_api_client.request_get_paginated(request_url='product', payload=my_payload, junk_size=10)
             >>> assert 5 < len(my_response_dict['data'])
-
-
             """
 
 - Admin API PATCH
@@ -715,6 +713,36 @@ Admin API
             >>> my_response_dict = my_api_client.request_post_paginated(request_url=my_url, payload=my_payload, junk_size=3)
             >>> assert 4 == len(my_response_dict['data'])
 
+            >>> # search for orders
+            >>> # test https://github.com/bitranox/lib_shopware6_api_base/issues/11
+            >>> import pprint
+            >>> date_from = '2024-09-29T00:00:00.000Z'
+            >>> date_to = '2024-09-29T23:59:59.999Z'
+            >>> my_criteria = Criteria()
+            >>> my_criteria.filter.append(RangeFilter(field="orderDate", parameters = {'gte': date_from, 'lte': date_to}))
+            >>> my_criteria.filter.append(MultiFilter('or', [
+            ...     EqualsFilter(field='documents.documentType.technicalName', value='invoice'),
+            ...     EqualsFilter(field='documents.documentType.technicalName', value='storno')]))
+            >>> pprint_attrs(my_criteria)
+            {'limit': None,
+             'page': None,
+             'filter': [{'type': 'range',
+                         'field': 'orderDate',
+                         'parameters': {'gte': '2024-09-29T00:00:00.000Z',
+                                        'lte': '2024-09-29T23:59:59.999Z'}},
+                        {'type': 'multi',
+                         'operator': 'or',
+                         'queries': [{'type': 'equals',
+                                      'field': 'documents.documentType.technicalName',
+                                      'value': 'invoice'},
+                                     {'type': 'equals',
+                                      'field': 'documents.documentType.technicalName',
+                                      'value': 'storno'}]}],
+             'term': None,
+             'total_count_mode': None}
+            >>> my_response_dict = my_api_client.request_post_paginated(request_url='search/order', payload=my_criteria)
+            >>> pprint.pprint(my_response_dict)
+            {'data': []}
             """
 
 - Admin API PUT
@@ -910,8 +938,8 @@ a search criteria follows the following schema:
         >>> my_criteria = Criteria()
         >>> my_criteria.ids=["012cd563cf8e4f0384eed93b5201cc98", "075fb241b769444bb72431f797fd5776", "090fcc2099794771935acf814e3fdb24"]
         >>> pprint_attrs(my_criteria)
-        {'limit': 3,
-         'page': 1,
+        {'limit': None,
+         'page': None,
          'ids': ['012cd563cf8e4f0384eed93b5201cc98',
                  '075fb241b769444bb72431f797fd5776',
                  '090fcc2099794771935acf814e3fdb24'],
@@ -1642,8 +1670,8 @@ Please note that as soon as You use ids, limit and page does not apply anymore !
         >>> my_criteria = Criteria()
         >>> my_criteria.ids=["012cd563cf8e4f0384eed93b5201cc98", "075fb241b769444bb72431f797fd5776", "090fcc2099794771935acf814e3fdb24"]
         >>> pprint_attrs(my_criteria)
-        {'limit': 3,
-         'page': 1,
+        {'limit': None,
+         'page': None,
          'ids': ['012cd563cf8e4f0384eed93b5201cc98',
                  '075fb241b769444bb72431f797fd5776',
                  '090fcc2099794771935acf814e3fdb24'],
@@ -1871,13 +1899,12 @@ Usage from Commandline
 Installation and Upgrade
 ------------------------
 
-- Before You start, its highly recommended to update pip and setup tools:
+- Before You start, its highly recommended to update pip:
 
 
 .. code-block::
 
     python -m pip --upgrade pip
-    python -m pip --upgrade setuptools
 
 - to install the latest release from PyPi via pip (recommended):
 
@@ -1959,7 +1986,7 @@ following modules will be automatically installed :
     lib_detect_testenv
     oauthlib
     requests
-    requests_oauthlib
+    requests-oauthlib
 
 Acknowledgements
 ----------------
@@ -1986,6 +2013,11 @@ Changelog
 - new MINOR version for added functionality in a backwards compatible manner
 - new PATCH version for backwards compatible bug fixes
 
+v2.1.8
+---------
+2024-09-29:
+    - add example for /search/order via post request
+
 v2.1.7
 ---------
 2023-10-18:

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/README.rst

@@ -2,7 +2,7 @@ lib_shopware6_api_base
 ======================
 
 
-Version v2.1.7 as of 2023-10-18 see `Changelog`_
+Version v2.1.8 as of 2024-09-29 see `Changelog`_
 
 |build_badge| |codeql| |license| |pypi|
 |pypi-downloads| |black| |codecov| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
@@ -70,7 +70,7 @@ automated tests, Github Actions, Documentation, Badges, etc. are managed with `P
 
 Python version required: 3.8.0 or newer
 
-tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12-dev, pypy-3.9, pypy-3.10 - architectures: amd64
+tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12, pypy-3.9, pypy-3.10 - architectures: amd64
 
 `100% code coverage <https://codeclimate.com/github/bitranox/lib_shopware6_api_base/test_coverage>`_, flake8 style checking ,mypy static type checking ,tested under `Linux <https://github.com/bitranox/lib_shopware6_api_base/actions/workflows/python-package.yml>`_, automatic daily builds and monitoring
 
@@ -571,8 +571,6 @@ Admin API
             >>> my_payload=Criteria()
             >>> my_response_dict = my_api_client.request_get_paginated(request_url='product', payload=my_payload, junk_size=10)
             >>> assert 5 < len(my_response_dict['data'])
-
-
             """
 
 - Admin API PATCH
@@ -676,6 +674,36 @@ Admin API
             >>> my_response_dict = my_api_client.request_post_paginated(request_url=my_url, payload=my_payload, junk_size=3)
             >>> assert 4 == len(my_response_dict['data'])
 
+            >>> # search for orders
+            >>> # test https://github.com/bitranox/lib_shopware6_api_base/issues/11
+            >>> import pprint
+            >>> date_from = '2024-09-29T00:00:00.000Z'
+            >>> date_to = '2024-09-29T23:59:59.999Z'
+            >>> my_criteria = Criteria()
+            >>> my_criteria.filter.append(RangeFilter(field="orderDate", parameters = {'gte': date_from, 'lte': date_to}))
+            >>> my_criteria.filter.append(MultiFilter('or', [
+            ...     EqualsFilter(field='documents.documentType.technicalName', value='invoice'),
+            ...     EqualsFilter(field='documents.documentType.technicalName', value='storno')]))
+            >>> pprint_attrs(my_criteria)
+            {'limit': None,
+             'page': None,
+             'filter': [{'type': 'range',
+                         'field': 'orderDate',
+                         'parameters': {'gte': '2024-09-29T00:00:00.000Z',
+                                        'lte': '2024-09-29T23:59:59.999Z'}},
+                        {'type': 'multi',
+                         'operator': 'or',
+                         'queries': [{'type': 'equals',
+                                      'field': 'documents.documentType.technicalName',
+                                      'value': 'invoice'},
+                                     {'type': 'equals',
+                                      'field': 'documents.documentType.technicalName',
+                                      'value': 'storno'}]}],
+             'term': None,
+             'total_count_mode': None}
+            >>> my_response_dict = my_api_client.request_post_paginated(request_url='search/order', payload=my_criteria)
+            >>> pprint.pprint(my_response_dict)
+            {'data': []}
             """
 
 - Admin API PUT
@@ -871,8 +899,8 @@ a search criteria follows the following schema:
         >>> my_criteria = Criteria()
         >>> my_criteria.ids=["012cd563cf8e4f0384eed93b5201cc98", "075fb241b769444bb72431f797fd5776", "090fcc2099794771935acf814e3fdb24"]
         >>> pprint_attrs(my_criteria)
-        {'limit': 3,
-         'page': 1,
+        {'limit': None,
+         'page': None,
          'ids': ['012cd563cf8e4f0384eed93b5201cc98',
                  '075fb241b769444bb72431f797fd5776',
                  '090fcc2099794771935acf814e3fdb24'],
@@ -1603,8 +1631,8 @@ Please note that as soon as You use ids, limit and page does not apply anymore !
         >>> my_criteria = Criteria()
         >>> my_criteria.ids=["012cd563cf8e4f0384eed93b5201cc98", "075fb241b769444bb72431f797fd5776", "090fcc2099794771935acf814e3fdb24"]
         >>> pprint_attrs(my_criteria)
-        {'limit': 3,
-         'page': 1,
+        {'limit': None,
+         'page': None,
          'ids': ['012cd563cf8e4f0384eed93b5201cc98',
                  '075fb241b769444bb72431f797fd5776',
                  '090fcc2099794771935acf814e3fdb24'],
@@ -1832,13 +1860,12 @@ Usage from Commandline
 Installation and Upgrade
 ------------------------
 
-- Before You start, its highly recommended to update pip and setup tools:
+- Before You start, its highly recommended to update pip:
 
 
 .. code-block::
 
     python -m pip --upgrade pip
-    python -m pip --upgrade setuptools
 
 - to install the latest release from PyPi via pip (recommended):
 
@@ -1920,7 +1947,7 @@ following modules will be automatically installed :
     lib_detect_testenv
     oauthlib
     requests
-    requests_oauthlib
+    requests-oauthlib
 
 Acknowledgements
 ----------------
@@ -1947,6 +1974,11 @@ Changelog
 - new MINOR version for added functionality in a backwards compatible manner
 - new PATCH version for backwards compatible bug fixes
 
+v2.1.8
+---------
+2024-09-29:
+    - add example for /search/order via post request
+
 v2.1.7
 ---------
 2023-10-18:

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/lib_shopware6_api_base/__init__conf__.py

@@ -2,7 +2,7 @@
 
 name = 'lib_shopware6_api_base'
 title = 'python3 base API client for shopware6'
-version = 'v2.1.7'
+version = 'v2.1.8'
 url = 'https://github.com/bitranox/lib_shopware6_api_base'
 author = 'Robert Nowotny'
 author_email = 'bitranox@gmail.com'
@@ -16,7 +16,7 @@ Info for lib_shopware6_api_base:
 
     python3 base API client for shopware6
 
-    Version : v2.1.7
+    Version : v2.1.8
     Url     : https://github.com/bitranox/lib_shopware6_api_base
     Author  : Robert Nowotny
     Email   : bitranox@gmail.com""")

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/lib_shopware6_api_base/lib_shopware6_api_base.py

@@ -313,20 +313,20 @@ class Shopware6StoreFrontClientBase(object):
         """
         if isinstance(payload, Criteria):
             payload = payload.get_dict()
-        formatted_request_url = self._format_storefront_api_url(request_url)
+        storefront_api_url = self._build_storefront_api_url(endpoint=request_url)
         response: requests.Response = requests.Response()
         headers = self._get_headers(update_header_fields=update_header_fields)
 
         if http_method == "get":
-            response = requests.request("GET", formatted_request_url, params=payload, headers=headers)
+            response = requests.request("GET", storefront_api_url, params=payload, headers=headers)
         elif http_method == "patch":
-            response = requests.request("PATCH", formatted_request_url, data=json.dumps(payload), headers=headers)
+            response = requests.request("PATCH", storefront_api_url, data=json.dumps(payload), headers=headers)
         elif http_method == "post":
-            response = requests.request("POST", formatted_request_url, data=json.dumps(payload), headers=headers)
+            response = requests.request("POST", storefront_api_url, data=json.dumps(payload), headers=headers)
         elif http_method == "put":
-            response = requests.request("PUT", formatted_request_url, data=json.dumps(payload), headers=headers)
+            response = requests.request("PUT", storefront_api_url, data=json.dumps(payload), headers=headers)
         elif http_method == "delete":
-            response = requests.request("DELETE", formatted_request_url, headers=headers)
+            response = requests.request("DELETE", storefront_api_url, headers=headers)
 
         try:
             response.raise_for_status()
@@ -373,24 +373,25 @@ class Shopware6StoreFrontClientBase(object):
             headers.update(update_header_fields)
         return headers
 
-    def _format_storefront_api_url(self, request_url: str) -> str:
+    def _build_storefront_api_url(self, endpoint: str) -> str:
         """
-        formatted url to make a request
+        Constructs a fully qualified URL for accessing the Storefront API.
 
-        :parameter
-            request_url:                        the request url, for instance "oauth/token"
-            self.shopware_storefront_api_url:   the api url, for instance https://your.shop-domain.com/store-api
+        Parameters:
+            endpoint: A string representing the specific API endpoint to be accessed, e.g., "oauth/token".
+            self.config.shopware_storefront_api_url: The base URL of the Storefront API, e.g., https://your.shop-domain.com/store-api.
 
-        :returns
-            the formatted url, like  https://your.shop-domain.com/store-api/product
+        Returns:
+            A string containing the fully qualified URL to the specified API endpoint, formatted as https://your.shop-domain.com/store-api/endpoint.
 
+        Example:
         >>> my_api_client = Shopware6StoreFrontClientBase()
-        >>> my_api_client._format_storefront_api_url('test')
+        >>> my_api_client._build_storefront_api_url('test')
         'http.../store-api/test'
 
         """
-        request_url = request_url.lstrip("/")
-        return f"{self.config.shopware_storefront_api_url}/{request_url}"
+        endpoint = endpoint.lstrip("/")
+        return f"{self.config.shopware_storefront_api_url}/{endpoint}"
 
 
 # admin_api{{{
@@ -511,8 +512,6 @@ class Shopware6AdminAPIClientBase(object):
         >>> my_payload=Criteria()
         >>> my_response_dict = my_api_client.request_get_paginated(request_url='product', payload=my_payload, junk_size=10)
         >>> assert 5 < len(my_response_dict['data'])
-
-
         """
         # admin_api_get_paginated}}}
         response_dict = self._request_paginated(
@@ -632,6 +631,36 @@ class Shopware6AdminAPIClientBase(object):
         >>> my_response_dict = my_api_client.request_post_paginated(request_url=my_url, payload=my_payload, junk_size=3)
         >>> assert 4 == len(my_response_dict['data'])
 
+        >>> # search for orders
+        >>> # test https://github.com/bitranox/lib_shopware6_api_base/issues/11
+        >>> import pprint
+        >>> date_from = '2024-09-29T00:00:00.000Z'
+        >>> date_to = '2024-09-29T23:59:59.999Z'
+        >>> my_criteria = Criteria()
+        >>> my_criteria.filter.append(RangeFilter(field="orderDate", parameters = {'gte': date_from, 'lte': date_to}))
+        >>> my_criteria.filter.append(MultiFilter('or', [
+        ...     EqualsFilter(field='documents.documentType.technicalName', value='invoice'),
+        ...     EqualsFilter(field='documents.documentType.technicalName', value='storno')]))
+        >>> pprint_attrs(my_criteria)
+        {'limit': None,
+         'page': None,
+         'filter': [{'type': 'range',
+                     'field': 'orderDate',
+                     'parameters': {'gte': '2024-09-29T00:00:00.000Z',
+                                    'lte': '2024-09-29T23:59:59.999Z'}},
+                    {'type': 'multi',
+                     'operator': 'or',
+                     'queries': [{'type': 'equals',
+                                  'field': 'documents.documentType.technicalName',
+                                  'value': 'invoice'},
+                                 {'type': 'equals',
+                                  'field': 'documents.documentType.technicalName',
+                                  'value': 'storno'}]}],
+         'term': None,
+         'total_count_mode': None}
+        >>> my_response_dict = my_api_client.request_post_paginated(request_url='search/order', payload=my_criteria)
+        >>> pprint.pprint(my_response_dict)
+        {'data': []}
         """
         # admin_api_post_paginated}}}
         response_dict = self._request_paginated(
@@ -710,8 +739,8 @@ class Shopware6AdminAPIClientBase(object):
         self, http_method: str, request_url: str, payload: PayLoad = None, junk_size: int = 100, update_header_fields: Optional[Dict[str, str]] = None
     ) -> Dict[str, Any]:
         """
-        request the data paginated - metadata 'total' and 'totalCountMode' will be updated
-        the paginated request reads those records in junks of junk_size=100 for performance reasons.
+        request the data paginated for performance reasons - metadata 'total' and 'totalCountMode' will be updated
+        the paginated request reads all records in junks of junk_size=100 up to "limit"
 
         payload "limit" will be respected (meaning we deliver only 'limit' results back)
         "page" will be ignored

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/lib_shopware6_api_base/lib_shopware6_api_base_criteria.py

@@ -192,8 +192,8 @@ class Criteria:
     >>> my_criteria = Criteria()
     >>> my_criteria.ids=["012cd563cf8e4f0384eed93b5201cc98", "075fb241b769444bb72431f797fd5776", "090fcc2099794771935acf814e3fdb24"]
     >>> pprint_attrs(my_criteria)
-    {'limit': 3,
-     'page': 1,
+    {'limit': None,
+     'page': None,
      'ids': ['012cd563cf8e4f0384eed93b5201cc98',
              '075fb241b769444bb72431f797fd5776',
              '090fcc2099794771935acf814e3fdb24'],
@@ -291,21 +291,22 @@ class Criteria:
 
 
     @limit.validator      # noqa
-    def on_set_limit_check_if_ids_are_set(self, attribute: attrs.Attribute, value: int) -> None:     # type: ignore  # noqa
-        if value is not None and len(self.ids):
+    def on_set_limit_check_if_ids_are_set(self, attribute: attrs.Attribute, limit: int) -> None:     # type: ignore  # noqa
+        """
+        check "self.ids" if "self.limit" is set
+        """
+        if limit is not None and len(self.ids):
             raise ValueError('You can use either "limit" or "ids", but not both, see : https://github.com/bitranox/lib_shopware6_api_base#ids')
 
 
     @ids.validator      # noqa
-    def set_limit_to_ids_length(self, attribute: attrs.Attribute, value: List[str]) -> None:    # type: ignore  # noqa
+    def on_set_ids_check_if_limit_is_set(self, attribute: attrs.Attribute, ids: List[str]) -> None:    # type: ignore  # noqa
         """
-        set "self.limit" and "self.page" if ids are given.
+        check "self.limit" if "self.ids" is set
         """
-        if len(value):
+        if len(ids):
             if self.limit:
                 raise ValueError('You can use either "limit" or "ids", but not both, see : https://github.com/bitranox/lib_shopware6_api_base#ids')
-            self.limit = len(value)
-            self.page = 1
 
     def get_dict(self) -> Dict[str, Any]:
         """ returns the data of the attrs dataclass as a dictionary.

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/lib_shopware6_api_base.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: lib-shopware6-api-base
-Version: 2.1.7
+Name: lib_shopware6_api_base
+Version: 2.1.8
 Summary: python3 base API client for shopware6
 Author-email: Robert Nowotny <bitranox@gmail.com>
 License: MIT
@@ -24,7 +24,7 @@ Requires-Dist: click
 Requires-Dist: lib_detect_testenv
 Requires-Dist: oauthlib
 Requires-Dist: requests
-Requires-Dist: requests_oauthlib
+Requires-Dist: requests-oauthlib
 Provides-Extra: test
 Requires-Dist: black; extra == "test"
 Requires-Dist: codecov; extra == "test"
@@ -41,7 +41,7 @@ lib_shopware6_api_base
 ======================
 
 
-Version v2.1.7 as of 2023-10-18 see `Changelog`_
+Version v2.1.8 as of 2024-09-29 see `Changelog`_
 
 |build_badge| |codeql| |license| |pypi|
 |pypi-downloads| |black| |codecov| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
@@ -109,7 +109,7 @@ automated tests, Github Actions, Documentation, Badges, etc. are managed with `P
 
 Python version required: 3.8.0 or newer
 
-tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12-dev, pypy-3.9, pypy-3.10 - architectures: amd64
+tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12, pypy-3.9, pypy-3.10 - architectures: amd64
 
 `100% code coverage <https://codeclimate.com/github/bitranox/lib_shopware6_api_base/test_coverage>`_, flake8 style checking ,mypy static type checking ,tested under `Linux <https://github.com/bitranox/lib_shopware6_api_base/actions/workflows/python-package.yml>`_, automatic daily builds and monitoring
 
@@ -610,8 +610,6 @@ Admin API
             >>> my_payload=Criteria()
             >>> my_response_dict = my_api_client.request_get_paginated(request_url='product', payload=my_payload, junk_size=10)
             >>> assert 5 < len(my_response_dict['data'])
-
-
             """
 
 - Admin API PATCH
@@ -715,6 +713,36 @@ Admin API
             >>> my_response_dict = my_api_client.request_post_paginated(request_url=my_url, payload=my_payload, junk_size=3)
             >>> assert 4 == len(my_response_dict['data'])
 
+            >>> # search for orders
+            >>> # test https://github.com/bitranox/lib_shopware6_api_base/issues/11
+            >>> import pprint
+            >>> date_from = '2024-09-29T00:00:00.000Z'
+            >>> date_to = '2024-09-29T23:59:59.999Z'
+            >>> my_criteria = Criteria()
+            >>> my_criteria.filter.append(RangeFilter(field="orderDate", parameters = {'gte': date_from, 'lte': date_to}))
+            >>> my_criteria.filter.append(MultiFilter('or', [
+            ...     EqualsFilter(field='documents.documentType.technicalName', value='invoice'),
+            ...     EqualsFilter(field='documents.documentType.technicalName', value='storno')]))
+            >>> pprint_attrs(my_criteria)
+            {'limit': None,
+             'page': None,
+             'filter': [{'type': 'range',
+                         'field': 'orderDate',
+                         'parameters': {'gte': '2024-09-29T00:00:00.000Z',
+                                        'lte': '2024-09-29T23:59:59.999Z'}},
+                        {'type': 'multi',
+                         'operator': 'or',
+                         'queries': [{'type': 'equals',
+                                      'field': 'documents.documentType.technicalName',
+                                      'value': 'invoice'},
+                                     {'type': 'equals',
+                                      'field': 'documents.documentType.technicalName',
+                                      'value': 'storno'}]}],
+             'term': None,
+             'total_count_mode': None}
+            >>> my_response_dict = my_api_client.request_post_paginated(request_url='search/order', payload=my_criteria)
+            >>> pprint.pprint(my_response_dict)
+            {'data': []}
             """
 
 - Admin API PUT
@@ -910,8 +938,8 @@ a search criteria follows the following schema:
         >>> my_criteria = Criteria()
         >>> my_criteria.ids=["012cd563cf8e4f0384eed93b5201cc98", "075fb241b769444bb72431f797fd5776", "090fcc2099794771935acf814e3fdb24"]
         >>> pprint_attrs(my_criteria)
-        {'limit': 3,
-         'page': 1,
+        {'limit': None,
+         'page': None,
          'ids': ['012cd563cf8e4f0384eed93b5201cc98',
                  '075fb241b769444bb72431f797fd5776',
                  '090fcc2099794771935acf814e3fdb24'],
@@ -1642,8 +1670,8 @@ Please note that as soon as You use ids, limit and page does not apply anymore !
         >>> my_criteria = Criteria()
         >>> my_criteria.ids=["012cd563cf8e4f0384eed93b5201cc98", "075fb241b769444bb72431f797fd5776", "090fcc2099794771935acf814e3fdb24"]
         >>> pprint_attrs(my_criteria)
-        {'limit': 3,
-         'page': 1,
+        {'limit': None,
+         'page': None,
          'ids': ['012cd563cf8e4f0384eed93b5201cc98',
                  '075fb241b769444bb72431f797fd5776',
                  '090fcc2099794771935acf814e3fdb24'],
@@ -1871,13 +1899,12 @@ Usage from Commandline
 Installation and Upgrade
 ------------------------
 
-- Before You start, its highly recommended to update pip and setup tools:
+- Before You start, its highly recommended to update pip:
 
 
 .. code-block::
 
     python -m pip --upgrade pip
-    python -m pip --upgrade setuptools
 
 - to install the latest release from PyPi via pip (recommended):
 
@@ -1959,7 +1986,7 @@ following modules will be automatically installed :
     lib_detect_testenv
     oauthlib
     requests
-    requests_oauthlib
+    requests-oauthlib
 
 Acknowledgements
 ----------------
@@ -1986,6 +2013,11 @@ Changelog
 - new MINOR version for added functionality in a backwards compatible manner
 - new PATCH version for backwards compatible bug fixes
 
+v2.1.8
+---------
+2024-09-29:
+    - add example for /search/order via post request
+
 v2.1.7
 ---------
 2023-10-18:

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/lib_shopware6_api_base.egg-info/requires.txt

@@ -4,7 +4,7 @@ click
 lib_detect_testenv
 oauthlib
 requests
-requests_oauthlib
+requests-oauthlib
 
 [test]
 black

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/pyproject.toml

@@ -32,9 +32,9 @@ dependencies = [
     "lib_detect_testenv",
     "oauthlib",
     "requests",
-    "requests_oauthlib",
+    "requests-oauthlib",
 ]
-version = "v2.1.7"
+version = "v2.1.8"
 # seems to be not allowed anymore
 # zip-save = false
 
@@ -71,7 +71,7 @@ lib_shopware6_api_base = [
 [tool.black]
 line-length = 160
 #You should include all Python versions that you want your code to run under
-target-version = ['py37', 'py38', 'py39', 'py310', 'py311']
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
 # Note that you have to use single-quoted strings in TOML for regular expressions
 include = '\.pyi?$'
 exclude = '/(\.eggs|\.git|\.hg|\.mypy_cache|\.nox|\.tox|\.venv|_build|buck-out|build|dist)/'

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/requirements.txt

@@ -5,4 +5,4 @@ cli_exit_tools
 lib_detect_testenv
 oauthlib
 requests
-requests_oauthlib
+requests-oauthlib

{lib_shopware6_api_base-2.1.7 → lib_shopware6_api_base-2.1.8}/tests/local_testscripts/lib_bash_functions.sh

@@ -147,7 +147,7 @@ function run_flake8_tests() {
 
 function run_mypy_tests() {
   my_banner "mypy tests"
-  if ! /opt/python3/bin/python3 -m mypy "${project_root_dir}" --follow-imports=normal --ignore-missing-imports --implicit-reexport --install-types --no-warn-unused-ignores --non-interactive --strict; then
+  if ! /opt/python3/bin/python3 -m mypy "${project_root_dir}" --follow-imports=normal --ignore-missing-imports --install-types --no-warn-unused-ignores --non-interactive --strict; then
     my_banner_warning "mypy tests ERROR"
     beep
     sleep "${sleeptime_on_error}"