@dockflow/sdk 0.0.0-stage → 0.3.0

package/dist/apis/TradeflowsApi.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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 CreateTradeflows202Response } from '../models/CreateTradeflows202Response';
+import { type DownstreamTradeflow } from '../models/DownstreamTradeflow';
+export interface CreateTradeflowsRequest {
+    /**
+     *
+     */
+    downstreamTradeflow: Array<DownstreamTradeflow>;
+}
+export interface DeleteTradeflowRequest {
+    /**
+     *
+     */
+    tradeflowReference: string;
+    /**
+     *
+     */
+    confirm?: string;
+    /**
+     * true deletes the tradeflow permanently. Default: it is deactivated.
+     */
+    hard?: boolean;
+}
+/**
+ *
+ */
+export declare class TradeflowsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createTradeflows without sending the request
+     */
+    createTradeflowsRequestOpts(requestParameters: CreateTradeflowsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upsert tradeflows
+     */
+    createTradeflowsRaw(requestParameters: CreateTradeflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateTradeflows202Response>>;
+    /**
+     * Upsert tradeflows
+     */
+    createTradeflows(requestParameters: CreateTradeflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateTradeflows202Response>;
+    /**
+     * Creates request options for deleteTradeflow without sending the request
+     */
+    deleteTradeflowRequestOpts(requestParameters: DeleteTradeflowRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a tradeflow
+     */
+    deleteTradeflowRaw(requestParameters: DeleteTradeflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Delete a tradeflow
+     */
+    deleteTradeflow(requestParameters: DeleteTradeflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+}

package/dist/apis/TradeflowsApi.js

@@ -0,0 +1,138 @@
+"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.TradeflowsApi = void 0;
+const runtime = require("../runtime");
+const CreateTradeflows202Response_1 = require("../models/CreateTradeflows202Response");
+const DownstreamTradeflow_1 = require("../models/DownstreamTradeflow");
+/**
+ *
+ */
+class TradeflowsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createTradeflows without sending the request
+     */
+    createTradeflowsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['downstreamTradeflow'] == null) {
+                throw new runtime.RequiredError('downstreamTradeflow', 'Required parameter "downstreamTradeflow" was null or undefined when calling createTradeflows().');
+            }
+            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/tradeflows`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['downstreamTradeflow'].map(DownstreamTradeflow_1.DownstreamTradeflowToJSON),
+            };
+        });
+    }
+    /**
+     * Upsert tradeflows
+     */
+    createTradeflowsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createTradeflowsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CreateTradeflows202Response_1.CreateTradeflows202ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Upsert tradeflows
+     */
+    createTradeflows(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createTradeflowsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteTradeflow without sending the request
+     */
+    deleteTradeflowRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['tradeflowReference'] == null) {
+                throw new runtime.RequiredError('tradeflowReference', 'Required parameter "tradeflowReference" was null or undefined when calling deleteTradeflow().');
+            }
+            const queryParameters = {};
+            if (requestParameters['confirm'] != null) {
+                queryParameters['confirm'] = requestParameters['confirm'];
+            }
+            if (requestParameters['hard'] != null) {
+                queryParameters['hard'] = requestParameters['hard'];
+            }
+            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/tradeflows/{tradeflow_reference}`;
+            urlPath = urlPath.replace('{tradeflow_reference}', encodeURIComponent(String(requestParameters['tradeflowReference'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Delete a tradeflow
+     */
+    deleteTradeflowRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteTradeflowRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Delete a tradeflow
+     */
+    deleteTradeflow(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteTradeflowRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.TradeflowsApi = TradeflowsApi;

package/dist/apis/UpstreamApi.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 GetUpstream200Response } from '../models/GetUpstream200Response';
+export interface GetUpstreamRequest {
+    /**
+     * Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.
+     */
+    since?: string;
+    /**
+     * Your tradeflow reference. Returns that tradeflow regardless of when it changed.
+     */
+    tradeflow?: string;
+    /**
+     * A container number. Returns its tradeflows regardless of when they changed.
+     */
+    container?: string;
+    /**
+     * Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.
+     */
+    category?: string;
+    /**
+     * 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.
+     */
+    code?: string;
+    /**
+     * next_cursor from the previous page. Keep since identical across the pages of one cycle.
+     */
+    cursor?: string;
+    /**
+     * true (active only), false, or both. Default: active plus recently deactivated.
+     */
+    active?: string;
+    /**
+     * Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.
+     */
+    fields?: string;
+    /**
+     * Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.
+     */
+    format?: GetUpstreamFormatEnum;
+    /**
+     * Tradeflows per page, 1 to 1000. Default 50.
+     */
+    perPage?: number;
+    /**
+     * Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.
+     */
+    failsafe?: GetUpstreamFailsafeEnum;
+}
+/**
+ *
+ */
+export declare class UpstreamApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getUpstream without sending the request
+     */
+    getUpstreamRequestOpts(requestParameters: GetUpstreamRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Poll upstream events
+     */
+    getUpstreamRaw(requestParameters: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUpstream200Response>>;
+    /**
+     * Poll upstream events
+     */
+    getUpstream(requestParameters?: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUpstream200Response>;
+}
+/**
+ * @export
+ */
+export declare const GetUpstreamFormatEnum: {
+    readonly V3: "v3";
+    readonly DcsaTnt22: "dcsa-tnt-2.2";
+};
+export type GetUpstreamFormatEnum = typeof GetUpstreamFormatEnum[keyof typeof GetUpstreamFormatEnum];
+/**
+ * @export
+ */
+export declare const GetUpstreamFailsafeEnum: {
+    readonly _0: "0";
+    readonly _1: "1";
+};
+export type GetUpstreamFailsafeEnum = typeof GetUpstreamFailsafeEnum[keyof typeof GetUpstreamFailsafeEnum];

package/dist/apis/UpstreamApi.js

@@ -0,0 +1,122 @@
+"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.GetUpstreamFailsafeEnum = exports.GetUpstreamFormatEnum = exports.UpstreamApi = void 0;
+const runtime = require("../runtime");
+const GetUpstream200Response_1 = require("../models/GetUpstream200Response");
+/**
+ *
+ */
+class UpstreamApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getUpstream without sending the request
+     */
+    getUpstreamRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['since'] != null) {
+                queryParameters['since'] = requestParameters['since'];
+            }
+            if (requestParameters['tradeflow'] != null) {
+                queryParameters['tradeflow'] = requestParameters['tradeflow'];
+            }
+            if (requestParameters['container'] != null) {
+                queryParameters['container'] = requestParameters['container'];
+            }
+            if (requestParameters['category'] != null) {
+                queryParameters['category'] = requestParameters['category'];
+            }
+            if (requestParameters['code'] != null) {
+                queryParameters['code'] = requestParameters['code'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['active'] != null) {
+                queryParameters['active'] = requestParameters['active'];
+            }
+            if (requestParameters['fields'] != null) {
+                queryParameters['fields'] = requestParameters['fields'];
+            }
+            if (requestParameters['format'] != null) {
+                queryParameters['format'] = requestParameters['format'];
+            }
+            if (requestParameters['perPage'] != null) {
+                queryParameters['per_page'] = requestParameters['perPage'];
+            }
+            if (requestParameters['failsafe'] != null) {
+                queryParameters['failsafe'] = requestParameters['failsafe'];
+            }
+            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/upstream`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Poll upstream events
+     */
+    getUpstreamRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getUpstreamRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetUpstream200Response_1.GetUpstream200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Poll upstream events
+     */
+    getUpstream() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getUpstreamRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.UpstreamApi = UpstreamApi;
+/**
+ * @export
+ */
+exports.GetUpstreamFormatEnum = {
+    V3: 'v3',
+    DcsaTnt22: 'dcsa-tnt-2.2',
+};
+/**
+ * @export
+ */
+exports.GetUpstreamFailsafeEnum = {
+    _0: '0',
+    _1: '1',
+};

package/dist/apis/WidgetApi.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 WidgetSearchResult } from '../models/WidgetSearchResult';
+export interface SearchWidgetRequest {
+    /**
+     * Container number, booking or bill of lading reference.
+     */
+    q: string;
+}
+/**
+ *
+ */
+export declare class WidgetApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for searchWidget without sending the request
+     */
+    searchWidgetRequestOpts(requestParameters: SearchWidgetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Matches a container number, booking or bill of lading within the token\'s entity and returns the best match.
+     * Search a shipment for the embeddable tracking widget
+     */
+    searchWidgetRaw(requestParameters: SearchWidgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WidgetSearchResult>>;
+    /**
+     * Matches a container number, booking or bill of lading within the token\'s entity and returns the best match.
+     * Search a shipment for the embeddable tracking widget
+     */
+    searchWidget(requestParameters: SearchWidgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WidgetSearchResult>;
+}

package/dist/apis/WidgetApi.js

@@ -0,0 +1,83 @@
+"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.WidgetApi = void 0;
+const runtime = require("../runtime");
+const WidgetSearchResult_1 = require("../models/WidgetSearchResult");
+/**
+ *
+ */
+class WidgetApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for searchWidget without sending the request
+     */
+    searchWidgetRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['q'] == null) {
+                throw new runtime.RequiredError('q', 'Required parameter "q" was null or undefined when calling searchWidget().');
+            }
+            const queryParameters = {};
+            if (requestParameters['q'] != null) {
+                queryParameters['q'] = requestParameters['q'];
+            }
+            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/widget/search`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Matches a container number, booking or bill of lading within the token\'s entity and returns the best match.
+     * Search a shipment for the embeddable tracking widget
+     */
+    searchWidgetRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.searchWidgetRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, WidgetSearchResult_1.WidgetSearchResultFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Matches a container number, booking or bill of lading within the token\'s entity and returns the best match.
+     * Search a shipment for the embeddable tracking widget
+     */
+    searchWidget(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.searchWidgetRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.WidgetApi = WidgetApi;

package/dist/apis/index.d.ts

@@ -0,0 +1,4 @@
+export * from './DocumentsApi';
+export * from './TradeflowsApi';
+export * from './UpstreamApi';
+export * from './WidgetApi';

package/dist/apis/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./DocumentsApi"), exports);
+__exportStar(require("./TradeflowsApi"), exports);
+__exportStar(require("./UpstreamApi"), exports);
+__exportStar(require("./WidgetApi"), exports);

package/dist/esm/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>;
+}