zippendo 1.0.0__tar.gz

zippendo-1.0.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Zippendo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zippendo-1.0.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: zippendo
+Version: 1.0.0
+Summary: Zippendo Public API
+Home-page: 
+Author: Zippendo Support
+Author-email: Zippendo Support <support@zippendo.com>
+License: MIT
+Project-URL: Repository, https://github.com/zippendo/zippendo-python
+Keywords: OpenAPI,OpenAPI-Generator,Zippendo Public API
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: urllib3<3.0.0,>=2.6.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: license-file
+
+# Zippendo Python SDK
+
+Official Python client for the [Zippendo](https://zippendo.com) shipping & logistics API. Models are
+pydantic v2, so requests and responses are both type-hinted and validated at runtime. Requires
+Python 3.8+.
+
+## Install
+
+```sh
+pip install zippendo
+```
+
+## Authentication
+
+Create an API token in your Zippendo dashboard (**Settings → API tokens**) — a Bearer token prefixed
+with `zipp_`. Pass it as `access_token`:
+
+```python
+import os
+import zippendo
+
+config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
+```
+
+The base URL defaults to `https://api.zippendo.com`.
+
+## Resources & clients
+
+The API is split into resource clients — `ShipmentsApi`, `OrdersApi`, `CarriersApi`, `AddressesApi`,
+`RulesApi`, `WebhooksApi`, `TokensApi`, and more. Create an `ApiClient` from your config, then the
+resource clients you need:
+
+```python
+with zippendo.ApiClient(config) as client:
+    shipments = zippendo.ShipmentsApi(client)
+    orders = zippendo.OrdersApi(client)
+```
+
+## The `org_id` parameter
+
+Every call takes an `org_id` (your organization ID, found in the dashboard). It is explicit on each
+call by design: one API token can be granted access to multiple organizations, and `org_id` selects
+which one the request acts on.
+
+## Listing & pagination
+
+List endpoints accept `page` (1-based) and `limit`, and return a page with `data` plus `total`,
+`page`, `limit`, and `total_pages`:
+
+```python
+with zippendo.ApiClient(config) as client:
+    shipments = zippendo.ShipmentsApi(client)
+    result = shipments.list_shipments("org_8f3kd92ld0", page=1, limit=50)
+    print(result.data)                       # list[Shipment]
+    print(result.total, result.total_pages)  # pagination metadata
+```
+
+## Creating resources
+
+```python
+with zippendo.ApiClient(config) as client:
+    orders = zippendo.OrdersApi(client)
+    order = orders.create_order(
+        "org_8f3kd92ld0",
+        zippendo.CreateOrderRequest(
+            order_number="1001",
+            order_channel_id="chan_7d2k1",
+            order_lines=[zippendo.CreateOrderRequestOrderLinesInner(name="T-shirt", quantity=2)],
+        ),
+    )
+    print(order.id)
+```
+
+See [`./docs`](./docs) for the full request/response shape of every operation.
+
+## Error handling
+
+Non-2xx responses raise `ApiException`. The body is Zippendo's canonical `{ code, error, message }` —
+branch on the machine-readable `code`:
+
+```python
+from zippendo.rest import ApiException
+
+try:
+    shipments.get_shipment("org_8f3kd92ld0", "shp_missing")
+except ApiException as e:
+    print(e.status, e.body)   # e.body contains the JSON, e.g. {"code": "SHIPMENT_NOT_FOUND", ...}
+```
+
+## Configuration
+
+Point the client at a different environment by overriding `host`:
+
+```python
+config = zippendo.Configuration(
+    access_token=os.environ["ZIPPENDO_API_TOKEN"],
+    host="https://staging.api.zippendo.com",
+)
+```
+
+## Reference
+
+Full per-endpoint and per-model documentation is in [`./docs`](./docs). Hosted reference:
+<https://www.zippendo.com/docs/api-reference/overview>.
+
+## License
+
+[MIT](./LICENSE.md)

zippendo-1.0.0/README.md

@@ -0,0 +1,108 @@
+# Zippendo Python SDK
+
+Official Python client for the [Zippendo](https://zippendo.com) shipping & logistics API. Models are
+pydantic v2, so requests and responses are both type-hinted and validated at runtime. Requires
+Python 3.8+.
+
+## Install
+
+```sh
+pip install zippendo
+```
+
+## Authentication
+
+Create an API token in your Zippendo dashboard (**Settings → API tokens**) — a Bearer token prefixed
+with `zipp_`. Pass it as `access_token`:
+
+```python
+import os
+import zippendo
+
+config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
+```
+
+The base URL defaults to `https://api.zippendo.com`.
+
+## Resources & clients
+
+The API is split into resource clients — `ShipmentsApi`, `OrdersApi`, `CarriersApi`, `AddressesApi`,
+`RulesApi`, `WebhooksApi`, `TokensApi`, and more. Create an `ApiClient` from your config, then the
+resource clients you need:
+
+```python
+with zippendo.ApiClient(config) as client:
+    shipments = zippendo.ShipmentsApi(client)
+    orders = zippendo.OrdersApi(client)
+```
+
+## The `org_id` parameter
+
+Every call takes an `org_id` (your organization ID, found in the dashboard). It is explicit on each
+call by design: one API token can be granted access to multiple organizations, and `org_id` selects
+which one the request acts on.
+
+## Listing & pagination
+
+List endpoints accept `page` (1-based) and `limit`, and return a page with `data` plus `total`,
+`page`, `limit`, and `total_pages`:
+
+```python
+with zippendo.ApiClient(config) as client:
+    shipments = zippendo.ShipmentsApi(client)
+    result = shipments.list_shipments("org_8f3kd92ld0", page=1, limit=50)
+    print(result.data)                       # list[Shipment]
+    print(result.total, result.total_pages)  # pagination metadata
+```
+
+## Creating resources
+
+```python
+with zippendo.ApiClient(config) as client:
+    orders = zippendo.OrdersApi(client)
+    order = orders.create_order(
+        "org_8f3kd92ld0",
+        zippendo.CreateOrderRequest(
+            order_number="1001",
+            order_channel_id="chan_7d2k1",
+            order_lines=[zippendo.CreateOrderRequestOrderLinesInner(name="T-shirt", quantity=2)],
+        ),
+    )
+    print(order.id)
+```
+
+See [`./docs`](./docs) for the full request/response shape of every operation.
+
+## Error handling
+
+Non-2xx responses raise `ApiException`. The body is Zippendo's canonical `{ code, error, message }` —
+branch on the machine-readable `code`:
+
+```python
+from zippendo.rest import ApiException
+
+try:
+    shipments.get_shipment("org_8f3kd92ld0", "shp_missing")
+except ApiException as e:
+    print(e.status, e.body)   # e.body contains the JSON, e.g. {"code": "SHIPMENT_NOT_FOUND", ...}
+```
+
+## Configuration
+
+Point the client at a different environment by overriding `host`:
+
+```python
+config = zippendo.Configuration(
+    access_token=os.environ["ZIPPENDO_API_TOKEN"],
+    host="https://staging.api.zippendo.com",
+)
+```
+
+## Reference
+
+Full per-endpoint and per-model documentation is in [`./docs`](./docs). Hosted reference:
+<https://www.zippendo.com/docs/api-reference/overview>.
+
+## License
+
+[MIT](./LICENSE.md)

zippendo-1.0.0/pyproject.toml

@@ -0,0 +1,95 @@
+[project]
+name = "zippendo"
+version = "1.0.0"
+description = "Zippendo Public API"
+authors = [
+  {name = "Zippendo Support",email = "support@zippendo.com"},
+]
+license = { text = "MIT" }
+readme = "README.md"
+keywords = ["OpenAPI", "OpenAPI-Generator", "Zippendo Public API"]
+requires-python = ">=3.9"
+
+dependencies = [
+  "urllib3 (>=2.6.3,<3.0.0)",
+  "python-dateutil (>=2.8.2)",
+  "pydantic (>=2.11)",
+  "typing-extensions (>=4.7.1)",
+]
+
+[project.urls]
+Repository = "https://github.com/zippendo/zippendo-python"
+
+[tool.poetry]
+requires-poetry = ">=2.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">= 8.4.2"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "zippendo",
+  #"test",  # auto-generated tests
+  "tests", # hand-written tests
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = [
+  "zippendo.configuration",
+]
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_reexport = true
+warn_return_any = true

zippendo-1.0.0/setup.cfg

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 99
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

zippendo-1.0.0/setup.py

@@ -0,0 +1,49 @@
+"""
+    Zippendo Public API
+
+    Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: support@zippendo.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from setuptools import setup, find_packages  # noqa: H301
+
+# To install the library, run the following
+#
+# python setup.py install
+#
+# prerequisite: setuptools
+# http://pypi.python.org/pypi/setuptools
+NAME = "zippendo"
+VERSION = "1.0.0"
+PYTHON_REQUIRES = ">= 3.10"
+REQUIRES = [
+    "urllib3 >= 2.6.3, < 3.0.0",
+    "python-dateutil >= 2.8.2",
+    "pydantic >= 2.11",
+    "typing-extensions >= 4.7.1",
+]
+
+setup(
+    name=NAME,
+    version=VERSION,
+    description="Zippendo Public API",
+    author="Zippendo Support",
+    author_email="support@zippendo.com",
+    url="",
+    keywords=["OpenAPI", "OpenAPI-Generator", "Zippendo Public API"],
+    install_requires=REQUIRES,
+    packages=find_packages(exclude=["test", "tests"]),
+    include_package_data=True,
+    license="MIT",
+    long_description_content_type='text/markdown',
+    long_description="""\
+    Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+    """,  # noqa: E501
+    package_data={"zippendo": ["py.typed"]},
+)

zippendo-1.0.0/test/test_addresses_api.py

@@ -0,0 +1,67 @@
+# coding: utf-8
+
+"""
+    Zippendo Public API
+
+    Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: support@zippendo.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zippendo.api.addresses_api import AddressesApi
+
+
+class TestAddressesApi(unittest.TestCase):
+    """AddressesApi unit test stubs"""
+
+    def setUp(self) -> None:
+        self.api = AddressesApi()
+
+    def tearDown(self) -> None:
+        pass
+
+    def test_create_address(self) -> None:
+        """Test case for create_address
+
+        Create address
+        """
+        pass
+
+    def test_delete_address(self) -> None:
+        """Test case for delete_address
+
+        Delete address
+        """
+        pass
+
+    def test_get_address(self) -> None:
+        """Test case for get_address
+
+        Get address
+        """
+        pass
+
+    def test_list_addresses(self) -> None:
+        """Test case for list_addresses
+
+        List addresses
+        """
+        pass
+
+    def test_update_address(self) -> None:
+        """Test case for update_address
+
+        Update address
+        """
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

zippendo-1.0.0/test/test_batch_send_shipments200_response.py

@@ -0,0 +1,83 @@
+# coding: utf-8
+
+"""
+    Zippendo Public API
+
+    Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: support@zippendo.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zippendo.models.batch_send_shipments200_response import BatchSendShipments200Response
+
+class TestBatchSendShipments200Response(unittest.TestCase):
+    """BatchSendShipments200Response unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> BatchSendShipments200Response:
+        """Test BatchSendShipments200Response
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `BatchSendShipments200Response`
+        """
+        model = BatchSendShipments200Response()
+        if include_optional:
+            return BatchSendShipments200Response(
+                results = [
+                    zippendo.models.batch_send_shipments_200_response_results_inner.batchSendShipments_200_response_results_inner(
+                        shipment_id = 'shp_01H8XABC123', 
+                        status = 'sent', 
+                        code = 'CARRIER_ERROR', 
+                        message = 'Shipment must be in pending or error status to be sent', 
+                        errors = [
+                            zippendo.models.send_shipment_422_response_errors_inner.sendShipment_422_response_errors_inner(
+                                code = 'INVALID_POSTAL_CODE', 
+                                message = 'Receiver postal code is invalid for the selected product.', )
+                            ], )
+                    ],
+                summary = zippendo.models.batch_send_shipments_200_response_summary.batchSendShipments_200_response_summary(
+                    total = 3, 
+                    sent = 2, 
+                    failed = 1, )
+            )
+        else:
+            return BatchSendShipments200Response(
+                results = [
+                    zippendo.models.batch_send_shipments_200_response_results_inner.batchSendShipments_200_response_results_inner(
+                        shipment_id = 'shp_01H8XABC123', 
+                        status = 'sent', 
+                        code = 'CARRIER_ERROR', 
+                        message = 'Shipment must be in pending or error status to be sent', 
+                        errors = [
+                            zippendo.models.send_shipment_422_response_errors_inner.sendShipment_422_response_errors_inner(
+                                code = 'INVALID_POSTAL_CODE', 
+                                message = 'Receiver postal code is invalid for the selected product.', )
+                            ], )
+                    ],
+                summary = zippendo.models.batch_send_shipments_200_response_summary.batchSendShipments_200_response_summary(
+                    total = 3, 
+                    sent = 2, 
+                    failed = 1, ),
+        )
+        """
+
+    def testBatchSendShipments200Response(self):
+        """Test BatchSendShipments200Response"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

zippendo-1.0.0/test/test_batch_send_shipments200_response_results_inner.py

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+"""
+    Zippendo Public API
+
+    Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: support@zippendo.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zippendo.models.batch_send_shipments200_response_results_inner import BatchSendShipments200ResponseResultsInner
+
+class TestBatchSendShipments200ResponseResultsInner(unittest.TestCase):
+    """BatchSendShipments200ResponseResultsInner unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> BatchSendShipments200ResponseResultsInner:
+        """Test BatchSendShipments200ResponseResultsInner
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `BatchSendShipments200ResponseResultsInner`
+        """
+        model = BatchSendShipments200ResponseResultsInner()
+        if include_optional:
+            return BatchSendShipments200ResponseResultsInner(
+                shipment_id = 'shp_01H8XABC123',
+                status = 'sent',
+                code = 'CARRIER_ERROR',
+                message = 'Shipment must be in pending or error status to be sent',
+                errors = [
+                    zippendo.models.send_shipment_422_response_errors_inner.sendShipment_422_response_errors_inner(
+                        code = 'INVALID_POSTAL_CODE', 
+                        message = 'Receiver postal code is invalid for the selected product.', )
+                    ]
+            )
+        else:
+            return BatchSendShipments200ResponseResultsInner(
+                shipment_id = 'shp_01H8XABC123',
+                status = 'sent',
+        )
+        """
+
+    def testBatchSendShipments200ResponseResultsInner(self):
+        """Test BatchSendShipments200ResponseResultsInner"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

zippendo-1.0.0/test/test_batch_send_shipments200_response_summary.py

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+"""
+    Zippendo Public API
+
+    Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: support@zippendo.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zippendo.models.batch_send_shipments200_response_summary import BatchSendShipments200ResponseSummary
+
+class TestBatchSendShipments200ResponseSummary(unittest.TestCase):
+    """BatchSendShipments200ResponseSummary unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> BatchSendShipments200ResponseSummary:
+        """Test BatchSendShipments200ResponseSummary
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `BatchSendShipments200ResponseSummary`
+        """
+        model = BatchSendShipments200ResponseSummary()
+        if include_optional:
+            return BatchSendShipments200ResponseSummary(
+                total = 3,
+                sent = 2,
+                failed = 1
+            )
+        else:
+            return BatchSendShipments200ResponseSummary(
+                total = 3,
+                sent = 2,
+                failed = 1,
+        )
+        """
+
+    def testBatchSendShipments200ResponseSummary(self):
+        """Test BatchSendShipments200ResponseSummary"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()