@dockflow/sdk 0.0.0-stage → 0.3.0

package/src/apis/DocumentsApi.ts

@@ -0,0 +1,357 @@
+/* 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.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type DocumentUpdate,
+    DocumentUpdateFromJSON,
+    DocumentUpdateToJSON,
+} from '../models/DocumentUpdate';
+import {
+    type DocumentUpload,
+    DocumentUploadFromJSON,
+    DocumentUploadToJSON,
+} from '../models/DocumentUpload';
+import {
+    type GetDocument200Response,
+    GetDocument200ResponseFromJSON,
+    GetDocument200ResponseToJSON,
+} from '../models/GetDocument200Response';
+import {
+    type GetDocument200ResponseDataInner,
+    GetDocument200ResponseDataInnerFromJSON,
+    GetDocument200ResponseDataInnerToJSON,
+} from '../models/GetDocument200ResponseDataInner';
+import {
+    type ListDocumentTypes200ResponseInner,
+    ListDocumentTypes200ResponseInnerFromJSON,
+    ListDocumentTypes200ResponseInnerToJSON,
+} from '../models/ListDocumentTypes200ResponseInner';
+import {
+    type UploadDocument202Response,
+    UploadDocument202ResponseFromJSON,
+    UploadDocument202ResponseToJSON,
+} from '../models/UploadDocument202Response';
+import {
+    type UploadDocument400Response,
+    UploadDocument400ResponseFromJSON,
+    UploadDocument400ResponseToJSON,
+} from '../models/UploadDocument400Response';
+
+export interface DeleteDocumentRequest {
+    /**
+     * 
+     */
+    reference: string;
+}
+
+export interface GetDocumentRequest {
+    /**
+     * 
+     */
+    reference: string;
+}
+
+export interface UpdateDocumentRequest {
+    /**
+     * 
+     */
+    reference: string;
+    /**
+     * 
+     */
+    documentUpdate: DocumentUpdate;
+}
+
+export interface UploadDocumentRequest {
+    /**
+     * 
+     */
+    documentUpload: DocumentUpload;
+}
+
+/**
+ * 
+ */
+export class DocumentsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for deleteDocument without sending the request
+     */
+    async deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reference'] == null) {
+            throw new runtime.RequiredError(
+                'reference',
+                'Required parameter "reference" was null or undefined when calling deleteDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await 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
+     */
+    async deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a document
+     */
+    async deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteDocumentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getDocument without sending the request
+     */
+    async getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reference'] == null) {
+            throw new runtime.RequiredError(
+                'reference',
+                'Required parameter "reference" was null or undefined when calling getDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await 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
+     */
+    async getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDocument200Response>> {
+        const requestOptions = await this.getDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetDocument200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List the documents of a tradeflow
+     */
+    async getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDocument200Response> {
+        const response = await this.getDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listDocumentTypes without sending the request
+     */
+    async listDocumentTypesRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await 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
+     */
+    async listDocumentTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ListDocumentTypes200ResponseInner>>> {
+        const requestOptions = await this.listDocumentTypesRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListDocumentTypes200ResponseInnerFromJSON));
+    }
+
+    /**
+     * List document types
+     */
+    async listDocumentTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListDocumentTypes200ResponseInner>> {
+        const response = await this.listDocumentTypesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateDocument without sending the request
+     */
+    async updateDocumentRequestOpts(requestParameters: UpdateDocumentRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await 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: DocumentUpdateToJSON(requestParameters['documentUpdate']),
+        };
+    }
+
+    /**
+     * Update a document
+     */
+    async updateDocumentRaw(requestParameters: UpdateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDocument200ResponseDataInner>> {
+        const requestOptions = await this.updateDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetDocument200ResponseDataInnerFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a document
+     */
+    async updateDocument(requestParameters: UpdateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDocument200ResponseDataInner> {
+        const response = await this.updateDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for uploadDocument without sending the request
+     */
+    async uploadDocumentRequestOpts(requestParameters: UploadDocumentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['documentUpload'] == null) {
+            throw new runtime.RequiredError(
+                'documentUpload',
+                'Required parameter "documentUpload" was null or undefined when calling uploadDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("ApiKey", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v3/downstream/documents`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DocumentUploadToJSON(requestParameters['documentUpload']),
+        };
+    }
+
+    /**
+     * Upload a document to a tradeflow
+     */
+    async uploadDocumentRaw(requestParameters: UploadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadDocument202Response>> {
+        const requestOptions = await this.uploadDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UploadDocument202ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a document to a tradeflow
+     */
+    async uploadDocument(requestParameters: UploadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadDocument202Response> {
+        const response = await this.uploadDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/TradeflowsApi.ts

@@ -0,0 +1,174 @@
+/* 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.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type CreateTradeflows202Response,
+    CreateTradeflows202ResponseFromJSON,
+    CreateTradeflows202ResponseToJSON,
+} from '../models/CreateTradeflows202Response';
+import {
+    type DownstreamTradeflow,
+    DownstreamTradeflowFromJSON,
+    DownstreamTradeflowToJSON,
+} 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 class TradeflowsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createTradeflows without sending the request
+     */
+    async createTradeflowsRequestOpts(requestParameters: CreateTradeflowsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['downstreamTradeflow'] == null) {
+            throw new runtime.RequiredError(
+                'downstreamTradeflow',
+                'Required parameter "downstreamTradeflow" was null or undefined when calling createTradeflows().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await 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(DownstreamTradeflowToJSON),
+        };
+    }
+
+    /**
+     * Upsert tradeflows
+     */
+    async createTradeflowsRaw(requestParameters: CreateTradeflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateTradeflows202Response>> {
+        const requestOptions = await this.createTradeflowsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateTradeflows202ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Upsert tradeflows
+     */
+    async createTradeflows(requestParameters: CreateTradeflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateTradeflows202Response> {
+        const response = await this.createTradeflowsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteTradeflow without sending the request
+     */
+    async deleteTradeflowRequestOpts(requestParameters: DeleteTradeflowRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['tradeflowReference'] == null) {
+            throw new runtime.RequiredError(
+                'tradeflowReference',
+                'Required parameter "tradeflowReference" was null or undefined when calling deleteTradeflow().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['confirm'] != null) {
+            queryParameters['confirm'] = requestParameters['confirm'];
+        }
+
+        if (requestParameters['hard'] != null) {
+            queryParameters['hard'] = requestParameters['hard'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await 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
+     */
+    async deleteTradeflowRaw(requestParameters: DeleteTradeflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        const requestOptions = await this.deleteTradeflowRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Delete a tradeflow
+     */
+    async deleteTradeflow(requestParameters: DeleteTradeflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.deleteTradeflowRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}