dockflow-sdk 0.3.0__py3-none-any.whl

dockflow_sdk/api/upstream_api.py

@@ -0,0 +1,471 @@
+"""
+    Dockflow v3 API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 3.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictInt, StrictStr, field_validator
+from typing import Optional
+from typing_extensions import Annotated
+from dockflow_sdk.models.get_upstream200_response import GetUpstream200Response
+
+from dockflow_sdk.api_client import ApiClient, RequestSerialized
+from dockflow_sdk.api_response import ApiResponse
+from dockflow_sdk.rest import RESTResponseType
+
+
+class UpstreamApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_upstream(
+        self,
+        since: Annotated[Optional[StrictStr], Field(description="Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.")] = None,
+        tradeflow: Annotated[Optional[StrictStr], Field(description="Your tradeflow reference. Returns that tradeflow regardless of when it changed.")] = None,
+        container: Annotated[Optional[StrictStr], Field(description="A container number. Returns its tradeflows regardless of when they changed.")] = None,
+        category: Annotated[Optional[StrictStr], Field(description="Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.")] = None,
+        code: Annotated[Optional[StrictStr], Field(description="Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400.")] = None,
+        cursor: Annotated[Optional[StrictStr], Field(description="next_cursor from the previous page. Keep since identical across the pages of one cycle.")] = None,
+        active: Annotated[Optional[StrictStr], Field(description="true (active only), false, or both. Default: active plus recently deactivated.")] = None,
+        fields: Annotated[Optional[StrictStr], Field(description="Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.")] = None,
+        format: Annotated[Optional[StrictStr], Field(description="Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.")] = None,
+        per_page: Annotated[Optional[StrictInt], Field(description="Tradeflows per page, 1 to 1000. Default 50.")] = None,
+        failsafe: Annotated[Optional[StrictStr], Field(description="Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> GetUpstream200Response:
+        """Poll upstream events
+
+
+        :param since: Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.
+        :type since: str
+        :param tradeflow: Your tradeflow reference. Returns that tradeflow regardless of when it changed.
+        :type tradeflow: str
+        :param container: A container number. Returns its tradeflows regardless of when they changed.
+        :type container: str
+        :param category: Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.
+        :type category: str
+        :param code: Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400.
+        :type code: str
+        :param cursor: next_cursor from the previous page. Keep since identical across the pages of one cycle.
+        :type cursor: str
+        :param active: true (active only), false, or both. Default: active plus recently deactivated.
+        :type active: str
+        :param fields: Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.
+        :type fields: str
+        :param format: Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.
+        :type format: str
+        :param per_page: Tradeflows per page, 1 to 1000. Default 50.
+        :type per_page: int
+        :param failsafe: Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.
+        :type failsafe: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_upstream_serialize(
+            since=since,
+            tradeflow=tradeflow,
+            container=container,
+            category=category,
+            code=code,
+            cursor=cursor,
+            active=active,
+            fields=fields,
+            format=format,
+            per_page=per_page,
+            failsafe=failsafe,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetUpstream200Response",
+            '400': "GetUpstream400Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_upstream_with_http_info(
+        self,
+        since: Annotated[Optional[StrictStr], Field(description="Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.")] = None,
+        tradeflow: Annotated[Optional[StrictStr], Field(description="Your tradeflow reference. Returns that tradeflow regardless of when it changed.")] = None,
+        container: Annotated[Optional[StrictStr], Field(description="A container number. Returns its tradeflows regardless of when they changed.")] = None,
+        category: Annotated[Optional[StrictStr], Field(description="Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.")] = None,
+        code: Annotated[Optional[StrictStr], Field(description="Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400.")] = None,
+        cursor: Annotated[Optional[StrictStr], Field(description="next_cursor from the previous page. Keep since identical across the pages of one cycle.")] = None,
+        active: Annotated[Optional[StrictStr], Field(description="true (active only), false, or both. Default: active plus recently deactivated.")] = None,
+        fields: Annotated[Optional[StrictStr], Field(description="Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.")] = None,
+        format: Annotated[Optional[StrictStr], Field(description="Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.")] = None,
+        per_page: Annotated[Optional[StrictInt], Field(description="Tradeflows per page, 1 to 1000. Default 50.")] = None,
+        failsafe: Annotated[Optional[StrictStr], Field(description="Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[GetUpstream200Response]:
+        """Poll upstream events
+
+
+        :param since: Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.
+        :type since: str
+        :param tradeflow: Your tradeflow reference. Returns that tradeflow regardless of when it changed.
+        :type tradeflow: str
+        :param container: A container number. Returns its tradeflows regardless of when they changed.
+        :type container: str
+        :param category: Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.
+        :type category: str
+        :param code: Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400.
+        :type code: str
+        :param cursor: next_cursor from the previous page. Keep since identical across the pages of one cycle.
+        :type cursor: str
+        :param active: true (active only), false, or both. Default: active plus recently deactivated.
+        :type active: str
+        :param fields: Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.
+        :type fields: str
+        :param format: Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.
+        :type format: str
+        :param per_page: Tradeflows per page, 1 to 1000. Default 50.
+        :type per_page: int
+        :param failsafe: Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.
+        :type failsafe: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_upstream_serialize(
+            since=since,
+            tradeflow=tradeflow,
+            container=container,
+            category=category,
+            code=code,
+            cursor=cursor,
+            active=active,
+            fields=fields,
+            format=format,
+            per_page=per_page,
+            failsafe=failsafe,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetUpstream200Response",
+            '400': "GetUpstream400Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_upstream_without_preload_content(
+        self,
+        since: Annotated[Optional[StrictStr], Field(description="Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.")] = None,
+        tradeflow: Annotated[Optional[StrictStr], Field(description="Your tradeflow reference. Returns that tradeflow regardless of when it changed.")] = None,
+        container: Annotated[Optional[StrictStr], Field(description="A container number. Returns its tradeflows regardless of when they changed.")] = None,
+        category: Annotated[Optional[StrictStr], Field(description="Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.")] = None,
+        code: Annotated[Optional[StrictStr], Field(description="Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400.")] = None,
+        cursor: Annotated[Optional[StrictStr], Field(description="next_cursor from the previous page. Keep since identical across the pages of one cycle.")] = None,
+        active: Annotated[Optional[StrictStr], Field(description="true (active only), false, or both. Default: active plus recently deactivated.")] = None,
+        fields: Annotated[Optional[StrictStr], Field(description="Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.")] = None,
+        format: Annotated[Optional[StrictStr], Field(description="Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.")] = None,
+        per_page: Annotated[Optional[StrictInt], Field(description="Tradeflows per page, 1 to 1000. Default 50.")] = None,
+        failsafe: Annotated[Optional[StrictStr], Field(description="Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Poll upstream events
+
+
+        :param since: Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.
+        :type since: str
+        :param tradeflow: Your tradeflow reference. Returns that tradeflow regardless of when it changed.
+        :type tradeflow: str
+        :param container: A container number. Returns its tradeflows regardless of when they changed.
+        :type container: str
+        :param category: Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.
+        :type category: str
+        :param code: Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400.
+        :type code: str
+        :param cursor: next_cursor from the previous page. Keep since identical across the pages of one cycle.
+        :type cursor: str
+        :param active: true (active only), false, or both. Default: active plus recently deactivated.
+        :type active: str
+        :param fields: Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.
+        :type fields: str
+        :param format: Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.
+        :type format: str
+        :param per_page: Tradeflows per page, 1 to 1000. Default 50.
+        :type per_page: int
+        :param failsafe: Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.
+        :type failsafe: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_upstream_serialize(
+            since=since,
+            tradeflow=tradeflow,
+            container=container,
+            category=category,
+            code=code,
+            cursor=cursor,
+            active=active,
+            fields=fields,
+            format=format,
+            per_page=per_page,
+            failsafe=failsafe,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetUpstream200Response",
+            '400': "GetUpstream400Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_upstream_serialize(
+        self,
+        since,
+        tradeflow,
+        container,
+        category,
+        code,
+        cursor,
+        active,
+        fields,
+        format,
+        per_page,
+        failsafe,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers)
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if since is not None:
+            
+            _query_params.append(('since', since))
+            
+        if tradeflow is not None:
+            
+            _query_params.append(('tradeflow', tradeflow))
+            
+        if container is not None:
+            
+            _query_params.append(('container', container))
+            
+        if category is not None:
+            
+            _query_params.append(('category', category))
+            
+        if code is not None:
+            
+            _query_params.append(('code', code))
+            
+        if cursor is not None:
+            
+            _query_params.append(('cursor', cursor))
+            
+        if active is not None:
+            
+            _query_params.append(('active', active))
+            
+        if fields is not None:
+            
+            _query_params.append(('fields', fields))
+            
+        if format is not None:
+            
+            _query_params.append(('format', format))
+            
+        if per_page is not None:
+            
+            _query_params.append(('per_page', per_page))
+            
+        if failsafe is not None:
+            
+            _query_params.append(('failsafe', failsafe))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if not any(key.lower() == 'accept' for key in _header_params):
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'ApiKey'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v3/upstream',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+