@dockflow/sdk 0.2.0 → 0.3.1

package/dist/apis/{V3DownstreamApi.js → TradeflowsApi.js}

@@ -3,7 +3,7 @@
 /* eslint-disable */
 /**
  * Dockflow v3 API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ * Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
  *
  * The version of the OpenAPI document: 3.0.0
  *
@@ -22,30 +22,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.V3DownstreamApi = void 0;
+exports.TradeflowsApi = void 0;
 const runtime = require("../runtime");
+const CreateTradeflows202Response_1 = require("../models/CreateTradeflows202Response");
 const DownstreamTradeflow_1 = require("../models/DownstreamTradeflow");
-const V3DownstreamPost202Response_1 = require("../models/V3DownstreamPost202Response");
 /**
  *
  */
-class V3DownstreamApi extends runtime.BaseAPI {
+class TradeflowsApi extends runtime.BaseAPI {
     /**
-     * Creates request options for v3DownstreamDelete without sending the request
+     * Creates request options for createTradeflows without sending the request
      */
-    v3DownstreamDeleteRequestOpts(requestParameters) {
+    createTradeflowsRequestOpts(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 v3DownstreamDelete().');
+            if (requestParameters['downstreamTradeflow'] == null) {
+                throw new runtime.RequiredError('downstreamTradeflow', 'Required parameter "downstreamTradeflow" was null or undefined when calling createTradeflows().');
             }
             const queryParameters = {};
-            if (requestParameters['confirm'] != null) {
-                queryParameters['confirm'] = requestParameters['confirm'];
-            }
-            if (requestParameters['hard'] != null) {
-                queryParameters['hard'] = requestParameters['hard'];
-            }
             const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
                 const tokenString = yield token("ApiKey", []);
@@ -53,51 +48,51 @@ class V3DownstreamApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            let urlPath = `/v3/downstream/tradeflows/{tradeflow_reference}`;
-            urlPath = urlPath.replace('{tradeflow_reference}', encodeURIComponent(String(requestParameters['tradeflowReference'])));
+            let urlPath = `/v3/downstream/tradeflows`;
             return {
                 path: urlPath,
-                method: 'DELETE',
+                method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
+                body: requestParameters['downstreamTradeflow'].map(DownstreamTradeflow_1.DownstreamTradeflowToJSON),
             };
         });
     }
     /**
-     * Delete a tradeflow
+     * Upsert tradeflows
      */
-    v3DownstreamDeleteRaw(requestParameters, initOverrides) {
+    createTradeflowsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.v3DownstreamDeleteRequestOpts(requestParameters);
+            const requestOptions = yield this.createTradeflowsRequestOpts(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);
-            }
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CreateTradeflows202Response_1.CreateTradeflows202ResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * Delete a tradeflow
+     * Upsert tradeflows
      */
-    v3DownstreamDelete(requestParameters, initOverrides) {
+    createTradeflows(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.v3DownstreamDeleteRaw(requestParameters, initOverrides);
+            const response = yield this.createTradeflowsRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * Creates request options for v3DownstreamPost without sending the request
+     * Creates request options for deleteTradeflow without sending the request
      */
-    v3DownstreamPostRequestOpts(requestParameters) {
+    deleteTradeflowRequestOpts(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 v3DownstreamPost().');
+            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 = {};
-            headerParameters['Content-Type'] = 'application/json';
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
                 const tokenString = yield token("ApiKey", []);
@@ -105,34 +100,39 @@ class V3DownstreamApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            let urlPath = `/v3/downstream/tradeflows`;
+            let urlPath = `/v3/downstream/tradeflows/{tradeflow_reference}`;
+            urlPath = urlPath.replace('{tradeflow_reference}', encodeURIComponent(String(requestParameters['tradeflowReference'])));
             return {
                 path: urlPath,
-                method: 'POST',
+                method: 'DELETE',
                 headers: headerParameters,
                 query: queryParameters,
-                body: requestParameters['downstreamTradeflow'].map(DownstreamTradeflow_1.DownstreamTradeflowToJSON),
             };
         });
     }
     /**
-     * Upsert tradeflows
+     * Delete a tradeflow
      */
-    v3DownstreamPostRaw(requestParameters, initOverrides) {
+    deleteTradeflowRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.v3DownstreamPostRequestOpts(requestParameters);
+            const requestOptions = yield this.deleteTradeflowRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, V3DownstreamPost202Response_1.V3DownstreamPost202ResponseFromJSON)(jsonValue));
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
         });
     }
     /**
-     * Upsert tradeflows
+     * Delete a tradeflow
      */
-    v3DownstreamPost(requestParameters, initOverrides) {
+    deleteTradeflow(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.v3DownstreamPostRaw(requestParameters, initOverrides);
+            const response = yield this.deleteTradeflowRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
 }
-exports.V3DownstreamApi = V3DownstreamApi;
+exports.TradeflowsApi = TradeflowsApi;

package/dist/apis/{V3UpstreamApi.d.ts → UpstreamApi.d.ts}

@@ -1,6 +1,6 @@
 /**
  * Dockflow v3 API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ * Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
  *
  * The version of the OpenAPI document: 3.0.0
  *
@@ -10,8 +10,8 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { type V3UpstreamGet200Response } from '../models/V3UpstreamGet200Response';
-export interface V3UpstreamGetRequest {
+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.
      */
@@ -47,7 +47,7 @@ export interface V3UpstreamGetRequest {
     /**
      * Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.
      */
-    format?: V3UpstreamGetFormatEnum;
+    format?: GetUpstreamFormatEnum;
     /**
      * Tradeflows per page, 1 to 1000. Default 50.
      */
@@ -55,38 +55,38 @@ export interface V3UpstreamGetRequest {
     /**
      * Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.
      */
-    failsafe?: V3UpstreamGetFailsafeEnum;
+    failsafe?: GetUpstreamFailsafeEnum;
 }
 /**
  *
  */
-export declare class V3UpstreamApi extends runtime.BaseAPI {
+export declare class UpstreamApi extends runtime.BaseAPI {
     /**
-     * Creates request options for v3UpstreamGet without sending the request
+     * Creates request options for getUpstream without sending the request
      */
-    v3UpstreamGetRequestOpts(requestParameters: V3UpstreamGetRequest): Promise<runtime.RequestOpts>;
+    getUpstreamRequestOpts(requestParameters: GetUpstreamRequest): Promise<runtime.RequestOpts>;
     /**
      * Poll upstream events
      */
-    v3UpstreamGetRaw(requestParameters: V3UpstreamGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3UpstreamGet200Response>>;
+    getUpstreamRaw(requestParameters: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUpstream200Response>>;
     /**
      * Poll upstream events
      */
-    v3UpstreamGet(requestParameters?: V3UpstreamGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3UpstreamGet200Response>;
+    getUpstream(requestParameters?: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUpstream200Response>;
 }
 /**
  * @export
  */
-export declare const V3UpstreamGetFormatEnum: {
+export declare const GetUpstreamFormatEnum: {
     readonly V3: "v3";
     readonly DcsaTnt22: "dcsa-tnt-2.2";
 };
-export type V3UpstreamGetFormatEnum = typeof V3UpstreamGetFormatEnum[keyof typeof V3UpstreamGetFormatEnum];
+export type GetUpstreamFormatEnum = typeof GetUpstreamFormatEnum[keyof typeof GetUpstreamFormatEnum];
 /**
  * @export
  */
-export declare const V3UpstreamGetFailsafeEnum: {
+export declare const GetUpstreamFailsafeEnum: {
     readonly _0: "0";
     readonly _1: "1";
 };
-export type V3UpstreamGetFailsafeEnum = typeof V3UpstreamGetFailsafeEnum[keyof typeof V3UpstreamGetFailsafeEnum];
+export type GetUpstreamFailsafeEnum = typeof GetUpstreamFailsafeEnum[keyof typeof GetUpstreamFailsafeEnum];

package/dist/apis/{V3UpstreamApi.js → UpstreamApi.js}

@@ -3,7 +3,7 @@
 /* eslint-disable */
 /**
  * Dockflow v3 API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ * Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
  *
  * The version of the OpenAPI document: 3.0.0
  *
@@ -22,17 +22,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.V3UpstreamGetFailsafeEnum = exports.V3UpstreamGetFormatEnum = exports.V3UpstreamApi = void 0;
+exports.GetUpstreamFailsafeEnum = exports.GetUpstreamFormatEnum = exports.UpstreamApi = void 0;
 const runtime = require("../runtime");
-const V3UpstreamGet200Response_1 = require("../models/V3UpstreamGet200Response");
+const GetUpstream200Response_1 = require("../models/GetUpstream200Response");
 /**
  *
  */
-class V3UpstreamApi extends runtime.BaseAPI {
+class UpstreamApi extends runtime.BaseAPI {
     /**
-     * Creates request options for v3UpstreamGet without sending the request
+     * Creates request options for getUpstream without sending the request
      */
-    v3UpstreamGetRequestOpts(requestParameters) {
+    getUpstreamRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['since'] != null) {
@@ -88,35 +88,35 @@ class V3UpstreamApi extends runtime.BaseAPI {
     /**
      * Poll upstream events
      */
-    v3UpstreamGetRaw(requestParameters, initOverrides) {
+    getUpstreamRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.v3UpstreamGetRequestOpts(requestParameters);
+            const requestOptions = yield this.getUpstreamRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, V3UpstreamGet200Response_1.V3UpstreamGet200ResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetUpstream200Response_1.GetUpstream200ResponseFromJSON)(jsonValue));
         });
     }
     /**
      * Poll upstream events
      */
-    v3UpstreamGet() {
+    getUpstream() {
         return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
-            const response = yield this.v3UpstreamGetRaw(requestParameters, initOverrides);
+            const response = yield this.getUpstreamRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
 }
-exports.V3UpstreamApi = V3UpstreamApi;
+exports.UpstreamApi = UpstreamApi;
 /**
  * @export
  */
-exports.V3UpstreamGetFormatEnum = {
+exports.GetUpstreamFormatEnum = {
     V3: 'v3',
     DcsaTnt22: 'dcsa-tnt-2.2',
 };
 /**
  * @export
  */
-exports.V3UpstreamGetFailsafeEnum = {
+exports.GetUpstreamFailsafeEnum = {
     _0: '0',
     _1: '1',
 };

package/dist/apis/WidgetApi.d.ts

@@ -1,6 +1,6 @@
 /**
  * Dockflow v3 API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ * Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
  *
  * The version of the OpenAPI document: 3.0.0
  *

package/dist/apis/WidgetApi.js

@@ -3,7 +3,7 @@
 /* eslint-disable */
 /**
  * Dockflow v3 API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ * Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
  *
  * The version of the OpenAPI document: 3.0.0
  *

package/dist/apis/index.d.ts

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

package/dist/apis/index.js

@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
-__exportStar(require("./V3DocumentApi"), exports);
-__exportStar(require("./V3DownstreamApi"), exports);
-__exportStar(require("./V3UpstreamApi"), exports);
+__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
+ * Client for the Dockflow API v3: upstream events, tradeflows, documents and the widget.
+ *
+ * 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>;
+}