dockflow-sdk 0.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dockflow_sdk-0.3.0/PKG-INFO +212 -0
- dockflow_sdk-0.3.0/README.md +194 -0
- dockflow_sdk-0.3.0/dockflow_sdk/__init__.py +124 -0
- dockflow_sdk-0.3.0/dockflow_sdk/api/__init__.py +8 -0
- dockflow_sdk-0.3.0/dockflow_sdk/api/documents_api.py +1382 -0
- dockflow_sdk-0.3.0/dockflow_sdk/api/tradeflows_api.py +615 -0
- dockflow_sdk-0.3.0/dockflow_sdk/api/upstream_api.py +471 -0
- dockflow_sdk-0.3.0/dockflow_sdk/api/widget_api.py +303 -0
- dockflow_sdk-0.3.0/dockflow_sdk/api_client.py +865 -0
- dockflow_sdk-0.3.0/dockflow_sdk/api_response.py +21 -0
- dockflow_sdk-0.3.0/dockflow_sdk/configuration.py +658 -0
- dockflow_sdk-0.3.0/dockflow_sdk/exceptions.py +218 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/__init__.py +51 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/container_reference.py +90 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/create_tradeflows202_response.py +104 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/create_tradeflows202_response_tradeflows_inner.py +90 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/document_update.py +92 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/document_upload.py +105 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/downstream_tradeflow.py +189 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/downstream_tradeflow_bill_of_lading_reference.py +138 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/downstream_tradeflow_booking_reference.py +138 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/downstream_tradeflow_events_inner.py +97 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/downstream_tradeflow_free_time_overrides_inner.py +101 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/downstream_tradeflow_mock_tracking.py +88 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/downstream_tradeflow_partners_inner.py +94 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/downstream_tradeflow_references.py +92 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/get_document200_response.py +100 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/get_document200_response_data_inner.py +133 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/get_document200_response_data_inner_document_type.py +90 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/get_upstream200_response.py +102 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/get_upstream400_response.py +172 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/inline_object.py +90 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/list_document_types200_response_inner.py +90 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/upload_document202_response.py +120 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/upload_document400_response.py +155 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/upstream_record.py +132 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/upstream_record_additional_references.py +90 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/upstream_record_data_quality.py +96 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/upstream_record_metadata.py +105 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_container.py +120 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_country.py +100 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_leg.py +113 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_location.py +129 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_milestone.py +118 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_point.py +90 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_search_result.py +155 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_track.py +102 -0
- dockflow_sdk-0.3.0/dockflow_sdk/models/widget_track_reading.py +92 -0
- dockflow_sdk-0.3.0/dockflow_sdk/py.typed +0 -0
- dockflow_sdk-0.3.0/dockflow_sdk/rest.py +334 -0
- dockflow_sdk-0.3.0/dockflow_sdk.egg-info/PKG-INFO +212 -0
- dockflow_sdk-0.3.0/dockflow_sdk.egg-info/SOURCES.txt +96 -0
- dockflow_sdk-0.3.0/dockflow_sdk.egg-info/dependency_links.txt +1 -0
- dockflow_sdk-0.3.0/dockflow_sdk.egg-info/requires.txt +4 -0
- dockflow_sdk-0.3.0/dockflow_sdk.egg-info/top_level.txt +1 -0
- dockflow_sdk-0.3.0/pyproject.toml +93 -0
- dockflow_sdk-0.3.0/setup.cfg +7 -0
- dockflow_sdk-0.3.0/setup.py +47 -0
- dockflow_sdk-0.3.0/test/test_container_reference.py +53 -0
- dockflow_sdk-0.3.0/test/test_create_tradeflows202_response.py +66 -0
- dockflow_sdk-0.3.0/test/test_create_tradeflows202_response_tradeflows_inner.py +58 -0
- dockflow_sdk-0.3.0/test/test_document_update.py +53 -0
- dockflow_sdk-0.3.0/test/test_document_upload.py +59 -0
- dockflow_sdk-0.3.0/test/test_documents_api.py +66 -0
- dockflow_sdk-0.3.0/test/test_downstream_tradeflow.py +107 -0
- dockflow_sdk-0.3.0/test/test_downstream_tradeflow_bill_of_lading_reference.py +50 -0
- dockflow_sdk-0.3.0/test/test_downstream_tradeflow_booking_reference.py +50 -0
- dockflow_sdk-0.3.0/test/test_downstream_tradeflow_events_inner.py +57 -0
- dockflow_sdk-0.3.0/test/test_downstream_tradeflow_free_time_overrides_inner.py +55 -0
- dockflow_sdk-0.3.0/test/test_downstream_tradeflow_mock_tracking.py +51 -0
- dockflow_sdk-0.3.0/test/test_downstream_tradeflow_partners_inner.py +55 -0
- dockflow_sdk-0.3.0/test/test_downstream_tradeflow_references.py +53 -0
- dockflow_sdk-0.3.0/test/test_get_document200_response.py +82 -0
- dockflow_sdk-0.3.0/test/test_get_document200_response_data_inner.py +72 -0
- dockflow_sdk-0.3.0/test/test_get_document200_response_data_inner_document_type.py +54 -0
- dockflow_sdk-0.3.0/test/test_get_upstream200_response.py +128 -0
- dockflow_sdk-0.3.0/test/test_get_upstream400_response.py +50 -0
- dockflow_sdk-0.3.0/test/test_inline_object.py +62 -0
- dockflow_sdk-0.3.0/test/test_list_document_types200_response_inner.py +54 -0
- dockflow_sdk-0.3.0/test/test_tradeflows_api.py +45 -0
- dockflow_sdk-0.3.0/test/test_upload_document202_response.py +64 -0
- dockflow_sdk-0.3.0/test/test_upload_document400_response.py +50 -0
- dockflow_sdk-0.3.0/test/test_upstream_api.py +38 -0
- dockflow_sdk-0.3.0/test/test_upstream_record.py +107 -0
- dockflow_sdk-0.3.0/test/test_upstream_record_additional_references.py +56 -0
- dockflow_sdk-0.3.0/test/test_upstream_record_data_quality.py +55 -0
- dockflow_sdk-0.3.0/test/test_upstream_record_metadata.py +54 -0
- dockflow_sdk-0.3.0/test/test_widget_api.py +38 -0
- dockflow_sdk-0.3.0/test/test_widget_container.py +68 -0
- dockflow_sdk-0.3.0/test/test_widget_country.py +54 -0
- dockflow_sdk-0.3.0/test/test_widget_leg.py +68 -0
- dockflow_sdk-0.3.0/test/test_widget_location.py +68 -0
- dockflow_sdk-0.3.0/test/test_widget_milestone.py +68 -0
- dockflow_sdk-0.3.0/test/test_widget_point.py +54 -0
- dockflow_sdk-0.3.0/test/test_widget_search_result.py +120 -0
- dockflow_sdk-0.3.0/test/test_widget_track.py +64 -0
- dockflow_sdk-0.3.0/test/test_widget_track_reading.py +56 -0
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: dockflow_sdk
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Dockflow v3 API
|
|
5
|
+
Home-page: https://github.com/Dockflow/dockflow-sdks
|
|
6
|
+
Author: OpenAPI Generator community
|
|
7
|
+
Author-email: OpenAPI Generator Community <team@openapitools.org>
|
|
8
|
+
Project-URL: Repository, https://github.com/Dockflow/dockflow-sdks
|
|
9
|
+
Keywords: OpenAPI,OpenAPI-Generator,Dockflow v3 API
|
|
10
|
+
Requires-Python: >=3.11
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
Requires-Dist: urllib3<3.0.0,>=2.7.0
|
|
13
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
14
|
+
Requires-Dist: pydantic>=2.11
|
|
15
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
16
|
+
Dynamic: author
|
|
17
|
+
Dynamic: home-page
|
|
18
|
+
|
|
19
|
+
# dockflow-sdk
|
|
20
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
21
|
+
|
|
22
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
23
|
+
|
|
24
|
+
- API version: 3.0.0
|
|
25
|
+
- Package version: 0.3.0
|
|
26
|
+
- Generator version: 7.27.0
|
|
27
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
28
|
+
|
|
29
|
+
## Requirements.
|
|
30
|
+
|
|
31
|
+
Python 3.11+
|
|
32
|
+
|
|
33
|
+
Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
|
|
34
|
+
Install the package with `python -m pip install .`; install development dependencies
|
|
35
|
+
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
|
|
36
|
+
`python -m pip install --group dev`. The latter installs the group, not the package.
|
|
37
|
+
|
|
38
|
+
## Installation & Usage
|
|
39
|
+
### pip install
|
|
40
|
+
|
|
41
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
pip install git+https://github.com/Dockflow/dockflow-sdks.git
|
|
45
|
+
```
|
|
46
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/Dockflow/dockflow-sdks.git`)
|
|
47
|
+
|
|
48
|
+
Then import the package:
|
|
49
|
+
```python
|
|
50
|
+
import dockflow_sdk
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Setuptools
|
|
54
|
+
|
|
55
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
56
|
+
|
|
57
|
+
```sh
|
|
58
|
+
python setup.py install --user
|
|
59
|
+
```
|
|
60
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
61
|
+
|
|
62
|
+
Then import the package:
|
|
63
|
+
```python
|
|
64
|
+
import dockflow_sdk
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Tests
|
|
68
|
+
|
|
69
|
+
Execute `pytest` to run the tests.
|
|
70
|
+
|
|
71
|
+
## Getting Started
|
|
72
|
+
|
|
73
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
74
|
+
|
|
75
|
+
```python
|
|
76
|
+
|
|
77
|
+
import dockflow_sdk
|
|
78
|
+
from dockflow_sdk.rest import ApiException
|
|
79
|
+
from pprint import pprint
|
|
80
|
+
|
|
81
|
+
# Defining the host is optional and defaults to https://api.dockflow.com
|
|
82
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
83
|
+
configuration = dockflow_sdk.Configuration(
|
|
84
|
+
host = "https://api.dockflow.com"
|
|
85
|
+
)
|
|
86
|
+
|
|
87
|
+
# The client must configure the authentication and authorization parameters
|
|
88
|
+
# in accordance with the API server security policy.
|
|
89
|
+
# Examples for each auth method are provided below, use the example that
|
|
90
|
+
# satisfies your auth use case.
|
|
91
|
+
|
|
92
|
+
# Configure Bearer authorization: ApiKey
|
|
93
|
+
configuration = dockflow_sdk.Configuration(
|
|
94
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
# Enter a context with an instance of the API client
|
|
99
|
+
with dockflow_sdk.ApiClient(configuration) as api_client:
|
|
100
|
+
# Create an instance of the API class
|
|
101
|
+
api_instance = dockflow_sdk.DocumentsApi(api_client)
|
|
102
|
+
reference = 'reference_example' # str |
|
|
103
|
+
|
|
104
|
+
try:
|
|
105
|
+
# Delete a document
|
|
106
|
+
api_instance.delete_document(reference)
|
|
107
|
+
except ApiException as e:
|
|
108
|
+
print("Exception when calling DocumentsApi->delete_document: %s\n" % e)
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Documentation for API Endpoints
|
|
113
|
+
|
|
114
|
+
All URIs are relative to *https://api.dockflow.com*
|
|
115
|
+
|
|
116
|
+
Class | Method | HTTP request | Description
|
|
117
|
+
------------ | ------------- | ------------- | -------------
|
|
118
|
+
*DocumentsApi* | [**delete_document**](docs/DocumentsApi.md#delete_document) | **DELETE** /v3/downstream/documents/{reference} | Delete a document
|
|
119
|
+
*DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /v3/downstream/documents/{reference} | List the documents of a tradeflow
|
|
120
|
+
*DocumentsApi* | [**list_document_types**](docs/DocumentsApi.md#list_document_types) | **GET** /v3/downstream/documents/types | List document types
|
|
121
|
+
*DocumentsApi* | [**update_document**](docs/DocumentsApi.md#update_document) | **PATCH** /v3/downstream/documents/{reference} | Update a document
|
|
122
|
+
*DocumentsApi* | [**upload_document**](docs/DocumentsApi.md#upload_document) | **POST** /v3/downstream/documents | Upload a document to a tradeflow
|
|
123
|
+
*TradeflowsApi* | [**create_tradeflows**](docs/TradeflowsApi.md#create_tradeflows) | **POST** /v3/downstream/tradeflows | Upsert tradeflows
|
|
124
|
+
*TradeflowsApi* | [**delete_tradeflow**](docs/TradeflowsApi.md#delete_tradeflow) | **DELETE** /v3/downstream/tradeflows/{tradeflow_reference} | Delete a tradeflow
|
|
125
|
+
*UpstreamApi* | [**get_upstream**](docs/UpstreamApi.md#get_upstream) | **GET** /v3/upstream | Poll upstream events
|
|
126
|
+
*WidgetApi* | [**search_widget**](docs/WidgetApi.md#search_widget) | **GET** /v3/widget/search | Search a shipment for the embeddable tracking widget
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
## Documentation For Models
|
|
130
|
+
|
|
131
|
+
- [ContainerReference](docs/ContainerReference.md)
|
|
132
|
+
- [CreateTradeflows202Response](docs/CreateTradeflows202Response.md)
|
|
133
|
+
- [CreateTradeflows202ResponseTradeflowsInner](docs/CreateTradeflows202ResponseTradeflowsInner.md)
|
|
134
|
+
- [DocumentUpdate](docs/DocumentUpdate.md)
|
|
135
|
+
- [DocumentUpload](docs/DocumentUpload.md)
|
|
136
|
+
- [DownstreamTradeflow](docs/DownstreamTradeflow.md)
|
|
137
|
+
- [DownstreamTradeflowBillOfLadingReference](docs/DownstreamTradeflowBillOfLadingReference.md)
|
|
138
|
+
- [DownstreamTradeflowBookingReference](docs/DownstreamTradeflowBookingReference.md)
|
|
139
|
+
- [DownstreamTradeflowEventsInner](docs/DownstreamTradeflowEventsInner.md)
|
|
140
|
+
- [DownstreamTradeflowFreeTimeOverridesInner](docs/DownstreamTradeflowFreeTimeOverridesInner.md)
|
|
141
|
+
- [DownstreamTradeflowMockTracking](docs/DownstreamTradeflowMockTracking.md)
|
|
142
|
+
- [DownstreamTradeflowPartnersInner](docs/DownstreamTradeflowPartnersInner.md)
|
|
143
|
+
- [DownstreamTradeflowReferences](docs/DownstreamTradeflowReferences.md)
|
|
144
|
+
- [GetDocument200Response](docs/GetDocument200Response.md)
|
|
145
|
+
- [GetDocument200ResponseDataInner](docs/GetDocument200ResponseDataInner.md)
|
|
146
|
+
- [GetDocument200ResponseDataInnerDocumentType](docs/GetDocument200ResponseDataInnerDocumentType.md)
|
|
147
|
+
- [GetUpstream200Response](docs/GetUpstream200Response.md)
|
|
148
|
+
- [GetUpstream400Response](docs/GetUpstream400Response.md)
|
|
149
|
+
- [InlineObject](docs/InlineObject.md)
|
|
150
|
+
- [ListDocumentTypes200ResponseInner](docs/ListDocumentTypes200ResponseInner.md)
|
|
151
|
+
- [UploadDocument202Response](docs/UploadDocument202Response.md)
|
|
152
|
+
- [UploadDocument400Response](docs/UploadDocument400Response.md)
|
|
153
|
+
- [UpstreamRecord](docs/UpstreamRecord.md)
|
|
154
|
+
- [UpstreamRecordAdditionalReferences](docs/UpstreamRecordAdditionalReferences.md)
|
|
155
|
+
- [UpstreamRecordDataQuality](docs/UpstreamRecordDataQuality.md)
|
|
156
|
+
- [UpstreamRecordMetadata](docs/UpstreamRecordMetadata.md)
|
|
157
|
+
- [WidgetContainer](docs/WidgetContainer.md)
|
|
158
|
+
- [WidgetCountry](docs/WidgetCountry.md)
|
|
159
|
+
- [WidgetLeg](docs/WidgetLeg.md)
|
|
160
|
+
- [WidgetLocation](docs/WidgetLocation.md)
|
|
161
|
+
- [WidgetMilestone](docs/WidgetMilestone.md)
|
|
162
|
+
- [WidgetPoint](docs/WidgetPoint.md)
|
|
163
|
+
- [WidgetSearchResult](docs/WidgetSearchResult.md)
|
|
164
|
+
- [WidgetTrack](docs/WidgetTrack.md)
|
|
165
|
+
- [WidgetTrackReading](docs/WidgetTrackReading.md)
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<a id="documentation-for-authorization"></a>
|
|
169
|
+
## Documentation For Authorization
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
Authentication schemes defined for the API:
|
|
173
|
+
<a id="ApiKey"></a>
|
|
174
|
+
### ApiKey
|
|
175
|
+
|
|
176
|
+
- **Type**: Bearer authentication
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
## Author
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
## Request headers
|
|
185
|
+
|
|
186
|
+
Header names are compared case-insensitively in all Python client libraries.
|
|
187
|
+
Request headers are copied; supplying `_headers` does not change the caller's dict
|
|
188
|
+
or the client's shared defaults. The public `_headers` argument retains its dict
|
|
189
|
+
validation and existing value serialization. Pydantic can coerce mappings such as HTTPX `Headers` to a dict,
|
|
190
|
+
combining repeated fields into a single value; `_headers` does not provide a
|
|
191
|
+
repeated-field or list-of-pairs API.
|
|
192
|
+
|
|
193
|
+
Precedence, from lowest to highest:
|
|
194
|
+
|
|
195
|
+
1. `_headers` (within one dict, the last inserted case variant wins).
|
|
196
|
+
2. Explicit OpenAPI header parameters and generated `Content-Type` (or `_content_type`).
|
|
197
|
+
Generated `Accept` is added only when neither `_headers` nor explicit header
|
|
198
|
+
parameters contain an `Accept` case variant.
|
|
199
|
+
3. `ApiClient.default_headers` (including headers set with `set_default_header`).
|
|
200
|
+
4. The client's `cookie` setting, for `Cookie`.
|
|
201
|
+
5. Authentication headers. A non-empty `_request_auth` replaces configured
|
|
202
|
+
authentication for that call; `{}` retains configured authentication. Cookie
|
|
203
|
+
authentication appends to the selected `Cookie` value.
|
|
204
|
+
|
|
205
|
+
This retains the existing precedence for identically spelled names and extends it
|
|
206
|
+
to case variants. To override a generated content type, use `_content_type`;
|
|
207
|
+
client defaults still take precedence over it. The winning header's spelling and
|
|
208
|
+
value are retained for replacements. Cookie authentication uses the canonical
|
|
209
|
+
`Cookie` spelling and appends its value. Values containing legitimate
|
|
210
|
+
comma-separated lists are not split or deduplicated. This does not remove
|
|
211
|
+
duplicate values inside a header or change the handling of repeated fields
|
|
212
|
+
supplied directly to the transport.
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
# dockflow-sdk
|
|
2
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3
|
+
|
|
4
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
5
|
+
|
|
6
|
+
- API version: 3.0.0
|
|
7
|
+
- Package version: 0.3.0
|
|
8
|
+
- Generator version: 7.27.0
|
|
9
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
10
|
+
|
|
11
|
+
## Requirements.
|
|
12
|
+
|
|
13
|
+
Python 3.11+
|
|
14
|
+
|
|
15
|
+
Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
|
|
16
|
+
Install the package with `python -m pip install .`; install development dependencies
|
|
17
|
+
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
|
|
18
|
+
`python -m pip install --group dev`. The latter installs the group, not the package.
|
|
19
|
+
|
|
20
|
+
## Installation & Usage
|
|
21
|
+
### pip install
|
|
22
|
+
|
|
23
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
pip install git+https://github.com/Dockflow/dockflow-sdks.git
|
|
27
|
+
```
|
|
28
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/Dockflow/dockflow-sdks.git`)
|
|
29
|
+
|
|
30
|
+
Then import the package:
|
|
31
|
+
```python
|
|
32
|
+
import dockflow_sdk
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Setuptools
|
|
36
|
+
|
|
37
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
python setup.py install --user
|
|
41
|
+
```
|
|
42
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
43
|
+
|
|
44
|
+
Then import the package:
|
|
45
|
+
```python
|
|
46
|
+
import dockflow_sdk
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Tests
|
|
50
|
+
|
|
51
|
+
Execute `pytest` to run the tests.
|
|
52
|
+
|
|
53
|
+
## Getting Started
|
|
54
|
+
|
|
55
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
56
|
+
|
|
57
|
+
```python
|
|
58
|
+
|
|
59
|
+
import dockflow_sdk
|
|
60
|
+
from dockflow_sdk.rest import ApiException
|
|
61
|
+
from pprint import pprint
|
|
62
|
+
|
|
63
|
+
# Defining the host is optional and defaults to https://api.dockflow.com
|
|
64
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
65
|
+
configuration = dockflow_sdk.Configuration(
|
|
66
|
+
host = "https://api.dockflow.com"
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
# The client must configure the authentication and authorization parameters
|
|
70
|
+
# in accordance with the API server security policy.
|
|
71
|
+
# Examples for each auth method are provided below, use the example that
|
|
72
|
+
# satisfies your auth use case.
|
|
73
|
+
|
|
74
|
+
# Configure Bearer authorization: ApiKey
|
|
75
|
+
configuration = dockflow_sdk.Configuration(
|
|
76
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
77
|
+
)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
# Enter a context with an instance of the API client
|
|
81
|
+
with dockflow_sdk.ApiClient(configuration) as api_client:
|
|
82
|
+
# Create an instance of the API class
|
|
83
|
+
api_instance = dockflow_sdk.DocumentsApi(api_client)
|
|
84
|
+
reference = 'reference_example' # str |
|
|
85
|
+
|
|
86
|
+
try:
|
|
87
|
+
# Delete a document
|
|
88
|
+
api_instance.delete_document(reference)
|
|
89
|
+
except ApiException as e:
|
|
90
|
+
print("Exception when calling DocumentsApi->delete_document: %s\n" % e)
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Documentation for API Endpoints
|
|
95
|
+
|
|
96
|
+
All URIs are relative to *https://api.dockflow.com*
|
|
97
|
+
|
|
98
|
+
Class | Method | HTTP request | Description
|
|
99
|
+
------------ | ------------- | ------------- | -------------
|
|
100
|
+
*DocumentsApi* | [**delete_document**](docs/DocumentsApi.md#delete_document) | **DELETE** /v3/downstream/documents/{reference} | Delete a document
|
|
101
|
+
*DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /v3/downstream/documents/{reference} | List the documents of a tradeflow
|
|
102
|
+
*DocumentsApi* | [**list_document_types**](docs/DocumentsApi.md#list_document_types) | **GET** /v3/downstream/documents/types | List document types
|
|
103
|
+
*DocumentsApi* | [**update_document**](docs/DocumentsApi.md#update_document) | **PATCH** /v3/downstream/documents/{reference} | Update a document
|
|
104
|
+
*DocumentsApi* | [**upload_document**](docs/DocumentsApi.md#upload_document) | **POST** /v3/downstream/documents | Upload a document to a tradeflow
|
|
105
|
+
*TradeflowsApi* | [**create_tradeflows**](docs/TradeflowsApi.md#create_tradeflows) | **POST** /v3/downstream/tradeflows | Upsert tradeflows
|
|
106
|
+
*TradeflowsApi* | [**delete_tradeflow**](docs/TradeflowsApi.md#delete_tradeflow) | **DELETE** /v3/downstream/tradeflows/{tradeflow_reference} | Delete a tradeflow
|
|
107
|
+
*UpstreamApi* | [**get_upstream**](docs/UpstreamApi.md#get_upstream) | **GET** /v3/upstream | Poll upstream events
|
|
108
|
+
*WidgetApi* | [**search_widget**](docs/WidgetApi.md#search_widget) | **GET** /v3/widget/search | Search a shipment for the embeddable tracking widget
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
## Documentation For Models
|
|
112
|
+
|
|
113
|
+
- [ContainerReference](docs/ContainerReference.md)
|
|
114
|
+
- [CreateTradeflows202Response](docs/CreateTradeflows202Response.md)
|
|
115
|
+
- [CreateTradeflows202ResponseTradeflowsInner](docs/CreateTradeflows202ResponseTradeflowsInner.md)
|
|
116
|
+
- [DocumentUpdate](docs/DocumentUpdate.md)
|
|
117
|
+
- [DocumentUpload](docs/DocumentUpload.md)
|
|
118
|
+
- [DownstreamTradeflow](docs/DownstreamTradeflow.md)
|
|
119
|
+
- [DownstreamTradeflowBillOfLadingReference](docs/DownstreamTradeflowBillOfLadingReference.md)
|
|
120
|
+
- [DownstreamTradeflowBookingReference](docs/DownstreamTradeflowBookingReference.md)
|
|
121
|
+
- [DownstreamTradeflowEventsInner](docs/DownstreamTradeflowEventsInner.md)
|
|
122
|
+
- [DownstreamTradeflowFreeTimeOverridesInner](docs/DownstreamTradeflowFreeTimeOverridesInner.md)
|
|
123
|
+
- [DownstreamTradeflowMockTracking](docs/DownstreamTradeflowMockTracking.md)
|
|
124
|
+
- [DownstreamTradeflowPartnersInner](docs/DownstreamTradeflowPartnersInner.md)
|
|
125
|
+
- [DownstreamTradeflowReferences](docs/DownstreamTradeflowReferences.md)
|
|
126
|
+
- [GetDocument200Response](docs/GetDocument200Response.md)
|
|
127
|
+
- [GetDocument200ResponseDataInner](docs/GetDocument200ResponseDataInner.md)
|
|
128
|
+
- [GetDocument200ResponseDataInnerDocumentType](docs/GetDocument200ResponseDataInnerDocumentType.md)
|
|
129
|
+
- [GetUpstream200Response](docs/GetUpstream200Response.md)
|
|
130
|
+
- [GetUpstream400Response](docs/GetUpstream400Response.md)
|
|
131
|
+
- [InlineObject](docs/InlineObject.md)
|
|
132
|
+
- [ListDocumentTypes200ResponseInner](docs/ListDocumentTypes200ResponseInner.md)
|
|
133
|
+
- [UploadDocument202Response](docs/UploadDocument202Response.md)
|
|
134
|
+
- [UploadDocument400Response](docs/UploadDocument400Response.md)
|
|
135
|
+
- [UpstreamRecord](docs/UpstreamRecord.md)
|
|
136
|
+
- [UpstreamRecordAdditionalReferences](docs/UpstreamRecordAdditionalReferences.md)
|
|
137
|
+
- [UpstreamRecordDataQuality](docs/UpstreamRecordDataQuality.md)
|
|
138
|
+
- [UpstreamRecordMetadata](docs/UpstreamRecordMetadata.md)
|
|
139
|
+
- [WidgetContainer](docs/WidgetContainer.md)
|
|
140
|
+
- [WidgetCountry](docs/WidgetCountry.md)
|
|
141
|
+
- [WidgetLeg](docs/WidgetLeg.md)
|
|
142
|
+
- [WidgetLocation](docs/WidgetLocation.md)
|
|
143
|
+
- [WidgetMilestone](docs/WidgetMilestone.md)
|
|
144
|
+
- [WidgetPoint](docs/WidgetPoint.md)
|
|
145
|
+
- [WidgetSearchResult](docs/WidgetSearchResult.md)
|
|
146
|
+
- [WidgetTrack](docs/WidgetTrack.md)
|
|
147
|
+
- [WidgetTrackReading](docs/WidgetTrackReading.md)
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<a id="documentation-for-authorization"></a>
|
|
151
|
+
## Documentation For Authorization
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
Authentication schemes defined for the API:
|
|
155
|
+
<a id="ApiKey"></a>
|
|
156
|
+
### ApiKey
|
|
157
|
+
|
|
158
|
+
- **Type**: Bearer authentication
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
## Author
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
## Request headers
|
|
167
|
+
|
|
168
|
+
Header names are compared case-insensitively in all Python client libraries.
|
|
169
|
+
Request headers are copied; supplying `_headers` does not change the caller's dict
|
|
170
|
+
or the client's shared defaults. The public `_headers` argument retains its dict
|
|
171
|
+
validation and existing value serialization. Pydantic can coerce mappings such as HTTPX `Headers` to a dict,
|
|
172
|
+
combining repeated fields into a single value; `_headers` does not provide a
|
|
173
|
+
repeated-field or list-of-pairs API.
|
|
174
|
+
|
|
175
|
+
Precedence, from lowest to highest:
|
|
176
|
+
|
|
177
|
+
1. `_headers` (within one dict, the last inserted case variant wins).
|
|
178
|
+
2. Explicit OpenAPI header parameters and generated `Content-Type` (or `_content_type`).
|
|
179
|
+
Generated `Accept` is added only when neither `_headers` nor explicit header
|
|
180
|
+
parameters contain an `Accept` case variant.
|
|
181
|
+
3. `ApiClient.default_headers` (including headers set with `set_default_header`).
|
|
182
|
+
4. The client's `cookie` setting, for `Cookie`.
|
|
183
|
+
5. Authentication headers. A non-empty `_request_auth` replaces configured
|
|
184
|
+
authentication for that call; `{}` retains configured authentication. Cookie
|
|
185
|
+
authentication appends to the selected `Cookie` value.
|
|
186
|
+
|
|
187
|
+
This retains the existing precedence for identically spelled names and extends it
|
|
188
|
+
to case variants. To override a generated content type, use `_content_type`;
|
|
189
|
+
client defaults still take precedence over it. The winning header's spelling and
|
|
190
|
+
value are retained for replacements. Cookie authentication uses the canonical
|
|
191
|
+
`Cookie` spelling and appends its value. Values containing legitimate
|
|
192
|
+
comma-separated lists are not split or deduplicated. This does not remove
|
|
193
|
+
duplicate values inside a header or change the handling of repeated fields
|
|
194
|
+
supplied directly to the transport.
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
# flake8: noqa
|
|
4
|
+
|
|
5
|
+
"""
|
|
6
|
+
Dockflow v3 API
|
|
7
|
+
|
|
8
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
9
|
+
|
|
10
|
+
The version of the OpenAPI document: 3.0.0
|
|
11
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
12
|
+
|
|
13
|
+
Do not edit the class manually.
|
|
14
|
+
""" # noqa: E501
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
__version__ = "0.3.0"
|
|
18
|
+
|
|
19
|
+
# Define package exports
|
|
20
|
+
__all__ = [
|
|
21
|
+
"DocumentsApi",
|
|
22
|
+
"TradeflowsApi",
|
|
23
|
+
"UpstreamApi",
|
|
24
|
+
"WidgetApi",
|
|
25
|
+
"ApiResponse",
|
|
26
|
+
"ApiClient",
|
|
27
|
+
"Configuration",
|
|
28
|
+
"OpenApiException",
|
|
29
|
+
"ApiTypeError",
|
|
30
|
+
"ApiValueError",
|
|
31
|
+
"ApiKeyError",
|
|
32
|
+
"ApiAttributeError",
|
|
33
|
+
"ApiException",
|
|
34
|
+
"ContainerReference",
|
|
35
|
+
"CreateTradeflows202Response",
|
|
36
|
+
"CreateTradeflows202ResponseTradeflowsInner",
|
|
37
|
+
"DocumentUpdate",
|
|
38
|
+
"DocumentUpload",
|
|
39
|
+
"DownstreamTradeflow",
|
|
40
|
+
"DownstreamTradeflowBillOfLadingReference",
|
|
41
|
+
"DownstreamTradeflowBookingReference",
|
|
42
|
+
"DownstreamTradeflowEventsInner",
|
|
43
|
+
"DownstreamTradeflowFreeTimeOverridesInner",
|
|
44
|
+
"DownstreamTradeflowMockTracking",
|
|
45
|
+
"DownstreamTradeflowPartnersInner",
|
|
46
|
+
"DownstreamTradeflowReferences",
|
|
47
|
+
"GetDocument200Response",
|
|
48
|
+
"GetDocument200ResponseDataInner",
|
|
49
|
+
"GetDocument200ResponseDataInnerDocumentType",
|
|
50
|
+
"GetUpstream200Response",
|
|
51
|
+
"GetUpstream400Response",
|
|
52
|
+
"InlineObject",
|
|
53
|
+
"ListDocumentTypes200ResponseInner",
|
|
54
|
+
"UploadDocument202Response",
|
|
55
|
+
"UploadDocument400Response",
|
|
56
|
+
"UpstreamRecord",
|
|
57
|
+
"UpstreamRecordAdditionalReferences",
|
|
58
|
+
"UpstreamRecordDataQuality",
|
|
59
|
+
"UpstreamRecordMetadata",
|
|
60
|
+
"WidgetContainer",
|
|
61
|
+
"WidgetCountry",
|
|
62
|
+
"WidgetLeg",
|
|
63
|
+
"WidgetLocation",
|
|
64
|
+
"WidgetMilestone",
|
|
65
|
+
"WidgetPoint",
|
|
66
|
+
"WidgetSearchResult",
|
|
67
|
+
"WidgetTrack",
|
|
68
|
+
"WidgetTrackReading",
|
|
69
|
+
]
|
|
70
|
+
|
|
71
|
+
# import apis into sdk package
|
|
72
|
+
from dockflow_sdk.api.documents_api import DocumentsApi as DocumentsApi
|
|
73
|
+
from dockflow_sdk.api.tradeflows_api import TradeflowsApi as TradeflowsApi
|
|
74
|
+
from dockflow_sdk.api.upstream_api import UpstreamApi as UpstreamApi
|
|
75
|
+
from dockflow_sdk.api.widget_api import WidgetApi as WidgetApi
|
|
76
|
+
|
|
77
|
+
# import ApiClient
|
|
78
|
+
from dockflow_sdk.api_response import ApiResponse as ApiResponse
|
|
79
|
+
from dockflow_sdk.api_client import ApiClient as ApiClient
|
|
80
|
+
from dockflow_sdk.configuration import Configuration as Configuration
|
|
81
|
+
from dockflow_sdk.exceptions import OpenApiException as OpenApiException
|
|
82
|
+
from dockflow_sdk.exceptions import ApiTypeError as ApiTypeError
|
|
83
|
+
from dockflow_sdk.exceptions import ApiValueError as ApiValueError
|
|
84
|
+
from dockflow_sdk.exceptions import ApiKeyError as ApiKeyError
|
|
85
|
+
from dockflow_sdk.exceptions import ApiAttributeError as ApiAttributeError
|
|
86
|
+
from dockflow_sdk.exceptions import ApiException as ApiException
|
|
87
|
+
|
|
88
|
+
# import models into sdk package
|
|
89
|
+
from dockflow_sdk.models.container_reference import ContainerReference as ContainerReference
|
|
90
|
+
from dockflow_sdk.models.create_tradeflows202_response import CreateTradeflows202Response as CreateTradeflows202Response
|
|
91
|
+
from dockflow_sdk.models.create_tradeflows202_response_tradeflows_inner import CreateTradeflows202ResponseTradeflowsInner as CreateTradeflows202ResponseTradeflowsInner
|
|
92
|
+
from dockflow_sdk.models.document_update import DocumentUpdate as DocumentUpdate
|
|
93
|
+
from dockflow_sdk.models.document_upload import DocumentUpload as DocumentUpload
|
|
94
|
+
from dockflow_sdk.models.downstream_tradeflow import DownstreamTradeflow as DownstreamTradeflow
|
|
95
|
+
from dockflow_sdk.models.downstream_tradeflow_bill_of_lading_reference import DownstreamTradeflowBillOfLadingReference as DownstreamTradeflowBillOfLadingReference
|
|
96
|
+
from dockflow_sdk.models.downstream_tradeflow_booking_reference import DownstreamTradeflowBookingReference as DownstreamTradeflowBookingReference
|
|
97
|
+
from dockflow_sdk.models.downstream_tradeflow_events_inner import DownstreamTradeflowEventsInner as DownstreamTradeflowEventsInner
|
|
98
|
+
from dockflow_sdk.models.downstream_tradeflow_free_time_overrides_inner import DownstreamTradeflowFreeTimeOverridesInner as DownstreamTradeflowFreeTimeOverridesInner
|
|
99
|
+
from dockflow_sdk.models.downstream_tradeflow_mock_tracking import DownstreamTradeflowMockTracking as DownstreamTradeflowMockTracking
|
|
100
|
+
from dockflow_sdk.models.downstream_tradeflow_partners_inner import DownstreamTradeflowPartnersInner as DownstreamTradeflowPartnersInner
|
|
101
|
+
from dockflow_sdk.models.downstream_tradeflow_references import DownstreamTradeflowReferences as DownstreamTradeflowReferences
|
|
102
|
+
from dockflow_sdk.models.get_document200_response import GetDocument200Response as GetDocument200Response
|
|
103
|
+
from dockflow_sdk.models.get_document200_response_data_inner import GetDocument200ResponseDataInner as GetDocument200ResponseDataInner
|
|
104
|
+
from dockflow_sdk.models.get_document200_response_data_inner_document_type import GetDocument200ResponseDataInnerDocumentType as GetDocument200ResponseDataInnerDocumentType
|
|
105
|
+
from dockflow_sdk.models.get_upstream200_response import GetUpstream200Response as GetUpstream200Response
|
|
106
|
+
from dockflow_sdk.models.get_upstream400_response import GetUpstream400Response as GetUpstream400Response
|
|
107
|
+
from dockflow_sdk.models.inline_object import InlineObject as InlineObject
|
|
108
|
+
from dockflow_sdk.models.list_document_types200_response_inner import ListDocumentTypes200ResponseInner as ListDocumentTypes200ResponseInner
|
|
109
|
+
from dockflow_sdk.models.upload_document202_response import UploadDocument202Response as UploadDocument202Response
|
|
110
|
+
from dockflow_sdk.models.upload_document400_response import UploadDocument400Response as UploadDocument400Response
|
|
111
|
+
from dockflow_sdk.models.upstream_record import UpstreamRecord as UpstreamRecord
|
|
112
|
+
from dockflow_sdk.models.upstream_record_additional_references import UpstreamRecordAdditionalReferences as UpstreamRecordAdditionalReferences
|
|
113
|
+
from dockflow_sdk.models.upstream_record_data_quality import UpstreamRecordDataQuality as UpstreamRecordDataQuality
|
|
114
|
+
from dockflow_sdk.models.upstream_record_metadata import UpstreamRecordMetadata as UpstreamRecordMetadata
|
|
115
|
+
from dockflow_sdk.models.widget_container import WidgetContainer as WidgetContainer
|
|
116
|
+
from dockflow_sdk.models.widget_country import WidgetCountry as WidgetCountry
|
|
117
|
+
from dockflow_sdk.models.widget_leg import WidgetLeg as WidgetLeg
|
|
118
|
+
from dockflow_sdk.models.widget_location import WidgetLocation as WidgetLocation
|
|
119
|
+
from dockflow_sdk.models.widget_milestone import WidgetMilestone as WidgetMilestone
|
|
120
|
+
from dockflow_sdk.models.widget_point import WidgetPoint as WidgetPoint
|
|
121
|
+
from dockflow_sdk.models.widget_search_result import WidgetSearchResult as WidgetSearchResult
|
|
122
|
+
from dockflow_sdk.models.widget_track import WidgetTrack as WidgetTrack
|
|
123
|
+
from dockflow_sdk.models.widget_track_reading import WidgetTrackReading as WidgetTrackReading
|
|
124
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# flake8: noqa
|
|
2
|
+
|
|
3
|
+
# import apis into api package
|
|
4
|
+
from dockflow_sdk.api.documents_api import DocumentsApi
|
|
5
|
+
from dockflow_sdk.api.tradeflows_api import TradeflowsApi
|
|
6
|
+
from dockflow_sdk.api.upstream_api import UpstreamApi
|
|
7
|
+
from dockflow_sdk.api.widget_api import WidgetApi
|
|
8
|
+
|