@dockflow/sdk 0.0.0-stage → 0.3.0

package/.openapi-generator/FILES

@@ -0,0 +1,89 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+docs/ContainerReference.md
+docs/CreateTradeflows202Response.md
+docs/CreateTradeflows202ResponseTradeflowsInner.md
+docs/DocumentUpdate.md
+docs/DocumentUpload.md
+docs/DocumentsApi.md
+docs/DownstreamTradeflow.md
+docs/DownstreamTradeflowBillOfLadingReference.md
+docs/DownstreamTradeflowBookingReference.md
+docs/DownstreamTradeflowEventsInner.md
+docs/DownstreamTradeflowFreeTimeOverridesInner.md
+docs/DownstreamTradeflowMockTracking.md
+docs/DownstreamTradeflowPartnersInner.md
+docs/DownstreamTradeflowReferences.md
+docs/GetDocument200Response.md
+docs/GetDocument200ResponseDataInner.md
+docs/GetDocument200ResponseDataInnerDocumentType.md
+docs/GetUpstream200Response.md
+docs/GetUpstream400Response.md
+docs/InlineObject.md
+docs/ListDocumentTypes200ResponseInner.md
+docs/TradeflowsApi.md
+docs/UploadDocument202Response.md
+docs/UploadDocument400Response.md
+docs/UpstreamApi.md
+docs/UpstreamRecord.md
+docs/UpstreamRecordAdditionalReferences.md
+docs/UpstreamRecordDataQuality.md
+docs/UpstreamRecordMetadata.md
+docs/WidgetApi.md
+docs/WidgetContainer.md
+docs/WidgetCountry.md
+docs/WidgetLeg.md
+docs/WidgetLocation.md
+docs/WidgetMilestone.md
+docs/WidgetPoint.md
+docs/WidgetSearchResult.md
+docs/WidgetTrack.md
+docs/WidgetTrackReading.md
+package.json
+src/apis/DocumentsApi.ts
+src/apis/TradeflowsApi.ts
+src/apis/UpstreamApi.ts
+src/apis/WidgetApi.ts
+src/apis/index.ts
+src/index.ts
+src/models/ContainerReference.ts
+src/models/CreateTradeflows202Response.ts
+src/models/CreateTradeflows202ResponseTradeflowsInner.ts
+src/models/DocumentUpdate.ts
+src/models/DocumentUpload.ts
+src/models/DownstreamTradeflow.ts
+src/models/DownstreamTradeflowBillOfLadingReference.ts
+src/models/DownstreamTradeflowBookingReference.ts
+src/models/DownstreamTradeflowEventsInner.ts
+src/models/DownstreamTradeflowFreeTimeOverridesInner.ts
+src/models/DownstreamTradeflowMockTracking.ts
+src/models/DownstreamTradeflowPartnersInner.ts
+src/models/DownstreamTradeflowReferences.ts
+src/models/GetDocument200Response.ts
+src/models/GetDocument200ResponseDataInner.ts
+src/models/GetDocument200ResponseDataInnerDocumentType.ts
+src/models/GetUpstream200Response.ts
+src/models/GetUpstream400Response.ts
+src/models/InlineObject.ts
+src/models/ListDocumentTypes200ResponseInner.ts
+src/models/UploadDocument202Response.ts
+src/models/UploadDocument400Response.ts
+src/models/UpstreamRecord.ts
+src/models/UpstreamRecordAdditionalReferences.ts
+src/models/UpstreamRecordDataQuality.ts
+src/models/UpstreamRecordMetadata.ts
+src/models/WidgetContainer.ts
+src/models/WidgetCountry.ts
+src/models/WidgetLeg.ts
+src/models/WidgetLocation.ts
+src/models/WidgetMilestone.ts
+src/models/WidgetPoint.ts
+src/models/WidgetSearchResult.ts
+src/models/WidgetTrack.ts
+src/models/WidgetTrackReading.ts
+src/models/index.ts
+src/runtime.ts
+tsconfig.esm.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.27.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -1,3 +1,163 @@
-# Temporary Holding Version
+# @dockflow/sdk@0.3.0
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A TypeScript SDK client for the api.dockflow.com API.
+
+## Usage
+
+First, install the SDK from npm.
+
+```bash
+npm install @dockflow/sdk --save
+```
+
+Next, try it out.
+
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '@dockflow/sdk';
+import type { DeleteDocumentRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DocumentsApi(config);
+
+  const body = {
+    // string
+    reference: reference_example,
+  } satisfies DeleteDocumentRequest;
+
+  try {
+    const data = await api.deleteDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+
+## Documentation
+
+### API Endpoints
+
+All URIs are relative to *https://api.dockflow.com*
+
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*DocumentsApi* | [**deleteDocument**](docs/DocumentsApi.md#deletedocument) | **DELETE** /v3/downstream/documents/{reference} | Delete a document
+*DocumentsApi* | [**getDocument**](docs/DocumentsApi.md#getdocument) | **GET** /v3/downstream/documents/{reference} | List the documents of a tradeflow
+*DocumentsApi* | [**listDocumentTypes**](docs/DocumentsApi.md#listdocumenttypes) | **GET** /v3/downstream/documents/types | List document types
+*DocumentsApi* | [**updateDocument**](docs/DocumentsApi.md#updatedocument) | **PATCH** /v3/downstream/documents/{reference} | Update a document
+*DocumentsApi* | [**uploadDocument**](docs/DocumentsApi.md#uploaddocument) | **POST** /v3/downstream/documents | Upload a document to a tradeflow
+*TradeflowsApi* | [**createTradeflows**](docs/TradeflowsApi.md#createtradeflows) | **POST** /v3/downstream/tradeflows | Upsert tradeflows
+*TradeflowsApi* | [**deleteTradeflow**](docs/TradeflowsApi.md#deletetradeflow) | **DELETE** /v3/downstream/tradeflows/{tradeflow_reference} | Delete a tradeflow
+*UpstreamApi* | [**getUpstream**](docs/UpstreamApi.md#getupstream) | **GET** /v3/upstream | Poll upstream events
+*WidgetApi* | [**searchWidget**](docs/WidgetApi.md#searchwidget) | **GET** /v3/widget/search | Search a shipment for the embeddable tracking widget
+
+
+### Models
+
+- [ContainerReference](docs/ContainerReference.md)
+- [CreateTradeflows202Response](docs/CreateTradeflows202Response.md)
+- [CreateTradeflows202ResponseTradeflowsInner](docs/CreateTradeflows202ResponseTradeflowsInner.md)
+- [DocumentUpdate](docs/DocumentUpdate.md)
+- [DocumentUpload](docs/DocumentUpload.md)
+- [DownstreamTradeflow](docs/DownstreamTradeflow.md)
+- [DownstreamTradeflowBillOfLadingReference](docs/DownstreamTradeflowBillOfLadingReference.md)
+- [DownstreamTradeflowBookingReference](docs/DownstreamTradeflowBookingReference.md)
+- [DownstreamTradeflowEventsInner](docs/DownstreamTradeflowEventsInner.md)
+- [DownstreamTradeflowFreeTimeOverridesInner](docs/DownstreamTradeflowFreeTimeOverridesInner.md)
+- [DownstreamTradeflowMockTracking](docs/DownstreamTradeflowMockTracking.md)
+- [DownstreamTradeflowPartnersInner](docs/DownstreamTradeflowPartnersInner.md)
+- [DownstreamTradeflowReferences](docs/DownstreamTradeflowReferences.md)
+- [GetDocument200Response](docs/GetDocument200Response.md)
+- [GetDocument200ResponseDataInner](docs/GetDocument200ResponseDataInner.md)
+- [GetDocument200ResponseDataInnerDocumentType](docs/GetDocument200ResponseDataInnerDocumentType.md)
+- [GetUpstream200Response](docs/GetUpstream200Response.md)
+- [GetUpstream400Response](docs/GetUpstream400Response.md)
+- [InlineObject](docs/InlineObject.md)
+- [ListDocumentTypes200ResponseInner](docs/ListDocumentTypes200ResponseInner.md)
+- [UploadDocument202Response](docs/UploadDocument202Response.md)
+- [UploadDocument400Response](docs/UploadDocument400Response.md)
+- [UpstreamRecord](docs/UpstreamRecord.md)
+- [UpstreamRecordAdditionalReferences](docs/UpstreamRecordAdditionalReferences.md)
+- [UpstreamRecordDataQuality](docs/UpstreamRecordDataQuality.md)
+- [UpstreamRecordMetadata](docs/UpstreamRecordMetadata.md)
+- [WidgetContainer](docs/WidgetContainer.md)
+- [WidgetCountry](docs/WidgetCountry.md)
+- [WidgetLeg](docs/WidgetLeg.md)
+- [WidgetLocation](docs/WidgetLocation.md)
+- [WidgetMilestone](docs/WidgetMilestone.md)
+- [WidgetPoint](docs/WidgetPoint.md)
+- [WidgetSearchResult](docs/WidgetSearchResult.md)
+- [WidgetTrack](docs/WidgetTrack.md)
+- [WidgetTrackReading](docs/WidgetTrackReading.md)
+
+### Authorization
+
+
+Authentication schemes defined for the API:
+<a id="ApiKey"></a>
+#### ApiKey
+
+
+- **Type**: HTTP Bearer Token authentication
+
+## About
+
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `3.0.0`
+- Package version: `0.3.0`
+- Generator version: `7.27.0`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
+```
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+[]()

package/dist/apis/DocumentsApi.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type DocumentUpdate } from '../models/DocumentUpdate';
+import { type DocumentUpload } from '../models/DocumentUpload';
+import { type GetDocument200Response } from '../models/GetDocument200Response';
+import { type GetDocument200ResponseDataInner } from '../models/GetDocument200ResponseDataInner';
+import { type ListDocumentTypes200ResponseInner } from '../models/ListDocumentTypes200ResponseInner';
+import { type UploadDocument202Response } from '../models/UploadDocument202Response';
+export interface DeleteDocumentRequest {
+    /**
+     *
+     */
+    reference: string;
+}
+export interface GetDocumentRequest {
+    /**
+     *
+     */
+    reference: string;
+}
+export interface UpdateDocumentRequest {
+    /**
+     *
+     */
+    reference: string;
+    /**
+     *
+     */
+    documentUpdate: DocumentUpdate;
+}
+export interface UploadDocumentRequest {
+    /**
+     *
+     */
+    documentUpload: DocumentUpload;
+}
+/**
+ *
+ */
+export declare class DocumentsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteDocument without sending the request
+     */
+    deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a document
+     */
+    deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a document
+     */
+    deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getDocument without sending the request
+     */
+    getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List the documents of a tradeflow
+     */
+    getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDocument200Response>>;
+    /**
+     * List the documents of a tradeflow
+     */
+    getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDocument200Response>;
+    /**
+     * Creates request options for listDocumentTypes without sending the request
+     */
+    listDocumentTypesRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List document types
+     */
+    listDocumentTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ListDocumentTypes200ResponseInner>>>;
+    /**
+     * List document types
+     */
+    listDocumentTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListDocumentTypes200ResponseInner>>;
+    /**
+     * Creates request options for updateDocument without sending the request
+     */
+    updateDocumentRequestOpts(requestParameters: UpdateDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a document
+     */
+    updateDocumentRaw(requestParameters: UpdateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDocument200ResponseDataInner>>;
+    /**
+     * Update a document
+     */
+    updateDocument(requestParameters: UpdateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDocument200ResponseDataInner>;
+    /**
+     * Creates request options for uploadDocument without sending the request
+     */
+    uploadDocumentRequestOpts(requestParameters: UploadDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a document to a tradeflow
+     */
+    uploadDocumentRaw(requestParameters: UploadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadDocument202Response>>;
+    /**
+     * Upload a document to a tradeflow
+     */
+    uploadDocument(requestParameters: UploadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadDocument202Response>;
+}

package/dist/apis/DocumentsApi.js

@@ -0,0 +1,269 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentsApi = void 0;
+const runtime = require("../runtime");
+const DocumentUpdate_1 = require("../models/DocumentUpdate");
+const DocumentUpload_1 = require("../models/DocumentUpload");
+const GetDocument200Response_1 = require("../models/GetDocument200Response");
+const GetDocument200ResponseDataInner_1 = require("../models/GetDocument200ResponseDataInner");
+const ListDocumentTypes200ResponseInner_1 = require("../models/ListDocumentTypes200ResponseInner");
+const UploadDocument202Response_1 = require("../models/UploadDocument202Response");
+/**
+ *
+ */
+class DocumentsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteDocument without sending the request
+     */
+    deleteDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['reference'] == null) {
+                throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling deleteDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("ApiKey", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v3/downstream/documents/{reference}`;
+            urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Delete a document
+     */
+    deleteDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a document
+     */
+    deleteDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteDocumentRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getDocument without sending the request
+     */
+    getDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['reference'] == null) {
+                throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling getDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("ApiKey", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v3/downstream/documents/{reference}`;
+            urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List the documents of a tradeflow
+     */
+    getDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetDocument200Response_1.GetDocument200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List the documents of a tradeflow
+     */
+    getDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listDocumentTypes without sending the request
+     */
+    listDocumentTypesRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("ApiKey", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v3/downstream/documents/types`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List document types
+     */
+    listDocumentTypesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listDocumentTypesRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListDocumentTypes200ResponseInner_1.ListDocumentTypes200ResponseInnerFromJSON));
+        });
+    }
+    /**
+     * List document types
+     */
+    listDocumentTypes(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listDocumentTypesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateDocument without sending the request
+     */
+    updateDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['reference'] == null) {
+                throw new runtime.RequiredError('reference', 'Required parameter "reference" was null or undefined when calling updateDocument().');
+            }
+            if (requestParameters['documentUpdate'] == null) {
+                throw new runtime.RequiredError('documentUpdate', 'Required parameter "documentUpdate" was null or undefined when calling updateDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("ApiKey", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v3/downstream/documents/{reference}`;
+            urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, DocumentUpdate_1.DocumentUpdateToJSON)(requestParameters['documentUpdate']),
+            };
+        });
+    }
+    /**
+     * Update a document
+     */
+    updateDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetDocument200ResponseDataInner_1.GetDocument200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Update a document
+     */
+    updateDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for uploadDocument without sending the request
+     */
+    uploadDocumentRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentUpload'] == null) {
+                throw new runtime.RequiredError('documentUpload', 'Required parameter "documentUpload" was null or undefined when calling uploadDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("ApiKey", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v3/downstream/documents`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, DocumentUpload_1.DocumentUploadToJSON)(requestParameters['documentUpload']),
+            };
+        });
+    }
+    /**
+     * Upload a document to a tradeflow
+     */
+    uploadDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.uploadDocumentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, UploadDocument202Response_1.UploadDocument202ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Upload a document to a tradeflow
+     */
+    uploadDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.uploadDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.DocumentsApi = DocumentsApi;