@dockflow/sdk 0.2.0 → 0.3.0

package/docs/{V3DocumentPost202Response.md → UploadDocument202Response.md}

@@ -1,5 +1,5 @@
 
-# V3DocumentPost202Response
+# UploadDocument202Response
 
 
 ## Properties
@@ -17,7 +17,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { V3DocumentPost202Response } from '@dockflow/sdk'
+import type { UploadDocument202Response } from '@dockflow/sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -28,7 +28,7 @@ const example = {
   "filetype": null,
   "containerReference": null,
   "createdAt": null,
-} satisfies V3DocumentPost202Response
+} satisfies UploadDocument202Response
 
 console.log(example)
 
@@ -37,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as V3DocumentPost202Response
+const exampleParsed = JSON.parse(exampleJSON) as UploadDocument202Response
 console.log(exampleParsed)
 ```
 

package/docs/{V3DocumentPost400Response.md → UploadDocument400Response.md}

@@ -1,5 +1,5 @@
 
-# V3DocumentPost400Response
+# UploadDocument400Response
 
 
 ## Properties
@@ -10,11 +10,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { V3DocumentPost400Response } from '@dockflow/sdk'
+import type { UploadDocument400Response } from '@dockflow/sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies V3DocumentPost400Response
+} satisfies UploadDocument400Response
 
 console.log(example)
 
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as V3DocumentPost400Response
+const exampleParsed = JSON.parse(exampleJSON) as UploadDocument400Response
 console.log(exampleParsed)
 ```
 

package/docs/{V3UpstreamApi.md → UpstreamApi.md}

@@ -1,16 +1,16 @@
-# V3UpstreamApi
+# UpstreamApi
 
 All URIs are relative to *https://api.dockflow.com*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**v3UpstreamGet**](V3UpstreamApi.md#v3upstreamget) | **GET** /v3/upstream | Poll upstream events |
+| [**getUpstream**](UpstreamApi.md#getupstream) | **GET** /v3/upstream | Poll upstream events |
 
 
 
-## v3UpstreamGet
+## getUpstream
 
-> V3UpstreamGet200Response v3UpstreamGet(since, tradeflow, container, category, code, cursor, active, fields, format, perPage, failsafe)
+> GetUpstream200Response getUpstream(since, tradeflow, container, category, code, cursor, active, fields, format, perPage, failsafe)
 
 Poll upstream events
 
@@ -19,9 +19,9 @@ Poll upstream events
 ```ts
 import {
   Configuration,
-  V3UpstreamApi,
+  UpstreamApi,
 } from '@dockflow/sdk';
-import type { V3UpstreamGetRequest } from '@dockflow/sdk';
+import type { GetUpstreamRequest } from '@dockflow/sdk';
 
 async function example() {
   console.log("🚀 Testing @dockflow/sdk SDK...");
@@ -29,7 +29,7 @@ async function example() {
     // Configure HTTP bearer authorization: ApiKey
     accessToken: "YOUR BEARER TOKEN",
   });
-  const api = new V3UpstreamApi(config);
+  const api = new UpstreamApi(config);
 
   const body = {
     // string | Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes. (optional)
@@ -54,10 +54,10 @@ async function example() {
     perPage: 56,
     // '0' | '1' | Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing. (optional)
     failsafe: failsafe_example,
-  } satisfies V3UpstreamGetRequest;
+  } satisfies GetUpstreamRequest;
 
   try {
-    const data = await api.v3UpstreamGet(body);
+    const data = await api.getUpstream(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -87,7 +87,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**V3UpstreamGet200Response**](V3UpstreamGet200Response.md)
+[**GetUpstream200Response**](GetUpstream200Response.md)
 
 ### Authorization
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dockflow/sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "OpenAPI client for @dockflow/sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/{V3DocumentApi.ts → DocumentsApi.ts}

@@ -23,47 +23,47 @@ import {
     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 V3DocumentGet200Response,
-    V3DocumentGet200ResponseFromJSON,
-    V3DocumentGet200ResponseToJSON,
-} from '../models/V3DocumentGet200Response';
-import {
-    type V3DocumentGet200ResponseDataInner,
-    V3DocumentGet200ResponseDataInnerFromJSON,
-    V3DocumentGet200ResponseDataInnerToJSON,
-} from '../models/V3DocumentGet200ResponseDataInner';
-import {
-    type V3DocumentPost202Response,
-    V3DocumentPost202ResponseFromJSON,
-    V3DocumentPost202ResponseToJSON,
-} from '../models/V3DocumentPost202Response';
+    type UploadDocument202Response,
+    UploadDocument202ResponseFromJSON,
+    UploadDocument202ResponseToJSON,
+} from '../models/UploadDocument202Response';
 import {
-    type V3DocumentPost400Response,
-    V3DocumentPost400ResponseFromJSON,
-    V3DocumentPost400ResponseToJSON,
-} from '../models/V3DocumentPost400Response';
+    type UploadDocument400Response,
+    UploadDocument400ResponseFromJSON,
+    UploadDocument400ResponseToJSON,
+} from '../models/UploadDocument400Response';
 
-export interface V3DocumentDeleteRequest {
+export interface DeleteDocumentRequest {
     /**
      * 
      */
     reference: string;
 }
 
-export interface V3DocumentGetRequest {
+export interface GetDocumentRequest {
     /**
      * 
      */
     reference: string;
 }
 
-export interface V3DocumentPatchRequest {
+export interface UpdateDocumentRequest {
     /**
      * 
      */
@@ -74,7 +74,7 @@ export interface V3DocumentPatchRequest {
     documentUpdate: DocumentUpdate;
 }
 
-export interface V3DocumentPostRequest {
+export interface UploadDocumentRequest {
     /**
      * 
      */
@@ -84,12 +84,19 @@ export interface V3DocumentPostRequest {
 /**
  * 
  */
-export class V3DocumentApi extends runtime.BaseAPI {
+export class DocumentsApi extends runtime.BaseAPI {
 
     /**
-     * Creates request options for listDocumentTypes without sending the request
+     * Creates request options for deleteDocument without sending the request
      */
-    async listDocumentTypesRequestOpts(): Promise<runtime.RequestOpts> {
+    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 = {};
@@ -103,42 +110,42 @@ export class V3DocumentApi extends runtime.BaseAPI {
             }
         }
 
-        let urlPath = `/v3/downstream/documents/types`;
+        let urlPath = `/v3/downstream/documents/{reference}`;
+        urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
 
         return {
             path: urlPath,
-            method: 'GET',
+            method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
         };
     }
 
     /**
-     * List document types
+     * Delete a document
      */
-    async listDocumentTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ListDocumentTypes200ResponseInner>>> {
-        const requestOptions = await this.listDocumentTypesRequestOpts();
+    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.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListDocumentTypes200ResponseInnerFromJSON));
+        return new runtime.VoidApiResponse(response);
     }
 
     /**
-     * List document types
+     * Delete a document
      */
-    async listDocumentTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListDocumentTypes200ResponseInner>> {
-        const response = await this.listDocumentTypesRaw(initOverrides);
-        return await response.value();
+    async deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteDocumentRaw(requestParameters, initOverrides);
     }
 
     /**
-     * Creates request options for v3DocumentDelete without sending the request
+     * Creates request options for getDocument without sending the request
      */
-    async v3DocumentDeleteRequestOpts(requestParameters: V3DocumentDeleteRequest): Promise<runtime.RequestOpts> {
+    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 v3DocumentDelete().'
+                'Required parameter "reference" was null or undefined when calling getDocument().'
             );
         }
 
@@ -160,40 +167,34 @@ export class V3DocumentApi extends runtime.BaseAPI {
 
         return {
             path: urlPath,
-            method: 'DELETE',
+            method: 'GET',
             headers: headerParameters,
             query: queryParameters,
         };
     }
 
     /**
-     * Delete a document
+     * List the documents of a tradeflow
      */
-    async v3DocumentDeleteRaw(requestParameters: V3DocumentDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
-        const requestOptions = await this.v3DocumentDeleteRequestOpts(requestParameters);
+    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.VoidApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetDocument200ResponseFromJSON(jsonValue));
     }
 
     /**
-     * Delete a document
+     * List the documents of a tradeflow
      */
-    async v3DocumentDelete(requestParameters: V3DocumentDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
-        await this.v3DocumentDeleteRaw(requestParameters, initOverrides);
+    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 v3DocumentGet without sending the request
+     * Creates request options for listDocumentTypes without sending the request
      */
-    async v3DocumentGetRequestOpts(requestParameters: V3DocumentGetRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['reference'] == null) {
-            throw new runtime.RequiredError(
-                'reference',
-                'Required parameter "reference" was null or undefined when calling v3DocumentGet().'
-            );
-        }
-
+    async listDocumentTypesRequestOpts(): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -207,8 +208,7 @@ export class V3DocumentApi extends runtime.BaseAPI {
             }
         }
 
-        let urlPath = `/v3/downstream/documents/{reference}`;
-        urlPath = urlPath.replace('{reference}', encodeURIComponent(String(requestParameters['reference'])));
+        let urlPath = `/v3/downstream/documents/types`;
 
         return {
             path: urlPath,
@@ -219,38 +219,38 @@ export class V3DocumentApi extends runtime.BaseAPI {
     }
 
     /**
-     * List the documents of a tradeflow
+     * List document types
      */
-    async v3DocumentGetRaw(requestParameters: V3DocumentGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentGet200Response>> {
-        const requestOptions = await this.v3DocumentGetRequestOpts(requestParameters);
+    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) => V3DocumentGet200ResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListDocumentTypes200ResponseInnerFromJSON));
     }
 
     /**
-     * List the documents of a tradeflow
+     * List document types
      */
-    async v3DocumentGet(requestParameters: V3DocumentGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentGet200Response> {
-        const response = await this.v3DocumentGetRaw(requestParameters, initOverrides);
+    async listDocumentTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListDocumentTypes200ResponseInner>> {
+        const response = await this.listDocumentTypesRaw(initOverrides);
         return await response.value();
     }
 
     /**
-     * Creates request options for v3DocumentPatch without sending the request
+     * Creates request options for updateDocument without sending the request
      */
-    async v3DocumentPatchRequestOpts(requestParameters: V3DocumentPatchRequest): Promise<runtime.RequestOpts> {
+    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 v3DocumentPatch().'
+                '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 v3DocumentPatch().'
+                'Required parameter "documentUpdate" was null or undefined when calling updateDocument().'
             );
         }
 
@@ -284,29 +284,29 @@ export class V3DocumentApi extends runtime.BaseAPI {
     /**
      * Update a document
      */
-    async v3DocumentPatchRaw(requestParameters: V3DocumentPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentGet200ResponseDataInner>> {
-        const requestOptions = await this.v3DocumentPatchRequestOpts(requestParameters);
+    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) => V3DocumentGet200ResponseDataInnerFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetDocument200ResponseDataInnerFromJSON(jsonValue));
     }
 
     /**
      * Update a document
      */
-    async v3DocumentPatch(requestParameters: V3DocumentPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentGet200ResponseDataInner> {
-        const response = await this.v3DocumentPatchRaw(requestParameters, initOverrides);
+    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 v3DocumentPost without sending the request
+     * Creates request options for uploadDocument without sending the request
      */
-    async v3DocumentPostRequestOpts(requestParameters: V3DocumentPostRequest): Promise<runtime.RequestOpts> {
+    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 v3DocumentPost().'
+                'Required parameter "documentUpload" was null or undefined when calling uploadDocument().'
             );
         }
 
@@ -339,18 +339,18 @@ export class V3DocumentApi extends runtime.BaseAPI {
     /**
      * Upload a document to a tradeflow
      */
-    async v3DocumentPostRaw(requestParameters: V3DocumentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentPost202Response>> {
-        const requestOptions = await this.v3DocumentPostRequestOpts(requestParameters);
+    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) => V3DocumentPost202ResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => UploadDocument202ResponseFromJSON(jsonValue));
     }
 
     /**
      * Upload a document to a tradeflow
      */
-    async v3DocumentPost(requestParameters: V3DocumentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentPost202Response> {
-        const response = await this.v3DocumentPostRaw(requestParameters, initOverrides);
+    async uploadDocument(requestParameters: UploadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadDocument202Response> {
+        const response = await this.uploadDocumentRaw(requestParameters, initOverrides);
         return await response.value();
     }