dockflow-sdk

Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 3.0.0
• Package version: 1.0.0
• Generator version: 7.27.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.11+

Packaging uses standard [project] metadata and [dependency-groups] (PEP 621/735). Install the package with python -m pip install .; install development dependencies with Poetry 2.2 or newer using poetry install, or pip 25.1 or newer using python -m pip install --group dev. The latter installs the group, not the package.

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/Dockflow/dockflow-sdks.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Dockflow/dockflow-sdks.git)

Then import the package:

import dockflow_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import dockflow_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import dockflow_sdk
from dockflow_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dockflow.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dockflow_sdk.Configuration(
    host = "https://api.dockflow.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: ApiKey
configuration = dockflow_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with dockflow_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dockflow_sdk.DocumentsApi(api_client)
    reference = 'reference_example' # str | 

    try:
        # Delete a document
        api_instance.delete_document(reference)
    except ApiException as e:
        print("Exception when calling DocumentsApi->delete_document: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.dockflow.com

Documentation For Models

• ContainerReference
• CreateTradeflows202Response
• CreateTradeflows202ResponseTradeflowsInner
• DocumentUpdate
• DocumentUpload
• DownstreamTradeflow
• DownstreamTradeflowBillOfLadingReference
• DownstreamTradeflowBookingReference
• DownstreamTradeflowEventsInner
• DownstreamTradeflowFreeTimeOverridesInner
• DownstreamTradeflowMockTracking
• DownstreamTradeflowPartnersInner
• DownstreamTradeflowReferences
• GetDocument200Response
• GetDocument200ResponseDataInner
• GetDocument200ResponseDataInnerDocumentType
• GetUpstream200Response
• GetUpstream400Response
• InlineObject
• ListDocumentTypes200ResponseInner
• UploadDocument202Response
• UploadDocument400Response
• UpstreamRecord
• UpstreamRecordAdditionalReferences
• UpstreamRecordDataQuality
• UpstreamRecordMetadata
• WidgetContainer
• WidgetCountry
• WidgetLeg
• WidgetLocation
• WidgetMilestone
• WidgetPoint
• WidgetSearchResult
• WidgetTrack
• WidgetTrackReading

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

• Type: Bearer authentication

Author

Request headers

Header names are compared case-insensitively in all Python client libraries. Request headers are copied; supplying _headers does not change the caller's dict or the client's shared defaults. The public _headers argument retains its dict validation and existing value serialization. Pydantic can coerce mappings such as HTTPX Headers to a dict, combining repeated fields into a single value; _headers does not provide a repeated-field or list-of-pairs API.

Precedence, from lowest to highest:

1. _headers (within one dict, the last inserted case variant wins).
2. Explicit OpenAPI header parameters and generated Content-Type (or _content_type). Generated Accept is added only when neither _headers nor explicit header parameters contain an Accept case variant.
3. ApiClient.default_headers (including headers set with set_default_header).
4. The client's cookie setting, for Cookie.
5. Authentication headers. A non-empty _request_auth replaces configured authentication for that call; {} retains configured authentication. Cookie authentication appends to the selected Cookie value.

This retains the existing precedence for identically spelled names and extends it to case variants. To override a generated content type, use _content_type; client defaults still take precedence over it. The winning header's spelling and value are retained for replacements. Cookie authentication uses the canonical Cookie spelling and appends its value. Values containing legitimate comma-separated lists are not split or deduplicated. This does not remove duplicate values inside a header or change the handling of repeated fields supplied directly to the transport.