@dockflow/sdk 0.0.0-stage → 0.2.0

package/docs/WidgetPoint.md

@@ -0,0 +1,36 @@
+
+# WidgetPoint
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`lat` | number
+`lng` | number
+
+## Example
+
+```typescript
+import type { WidgetPoint } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "lat": null,
+  "lng": null,
+} satisfies WidgetPoint
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WidgetPoint
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WidgetSearchResult.md

@@ -0,0 +1,50 @@
+
+# WidgetSearchResult
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`references` | Array<string>
+`carrier` | string
+`bookingReference` | string
+`billOfLadingReference` | string
+`departure` | [WidgetLeg](WidgetLeg.md)
+`arrival` | [WidgetLeg](WidgetLeg.md)
+`containers` | [Array<WidgetContainer>](WidgetContainer.md)
+`tracks` | [Array<WidgetTrack>](WidgetTrack.md)
+`detailsUrl` | string
+
+## Example
+
+```typescript
+import type { WidgetSearchResult } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "references": null,
+  "carrier": null,
+  "bookingReference": null,
+  "billOfLadingReference": null,
+  "departure": null,
+  "arrival": null,
+  "containers": null,
+  "tracks": null,
+  "detailsUrl": null,
+} satisfies WidgetSearchResult
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WidgetSearchResult
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WidgetTrack.md

@@ -0,0 +1,36 @@
+
+# WidgetTrack
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceReference` | string
+`readings` | [Array<WidgetTrackReading>](WidgetTrackReading.md)
+
+## Example
+
+```typescript
+import type { WidgetTrack } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceReference": null,
+  "readings": null,
+} satisfies WidgetTrack
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WidgetTrack
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WidgetTrackReading.md

@@ -0,0 +1,38 @@
+
+# WidgetTrackReading
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`eventDate` | string
+`lat` | number
+`lng` | number
+
+## Example
+
+```typescript
+import type { WidgetTrackReading } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "eventDate": null,
+  "lat": null,
+  "lng": null,
+} satisfies WidgetTrackReading
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WidgetTrackReading
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,22 @@
 {
   "name": "@dockflow/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "OpenAPI client for @dockflow/sdk",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Dockflow/dockflow-sdks.git"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  }
+}

package/src/apis/V3DocumentApi.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 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';
+import {
+    type V3DocumentPost400Response,
+    V3DocumentPost400ResponseFromJSON,
+    V3DocumentPost400ResponseToJSON,
+} from '../models/V3DocumentPost400Response';
+
+export interface V3DocumentDeleteRequest {
+    /**
+     * 
+     */
+    reference: string;
+}
+
+export interface V3DocumentGetRequest {
+    /**
+     * 
+     */
+    reference: string;
+}
+
+export interface V3DocumentPatchRequest {
+    /**
+     * 
+     */
+    reference: string;
+    /**
+     * 
+     */
+    documentUpdate: DocumentUpdate;
+}
+
+export interface V3DocumentPostRequest {
+    /**
+     * 
+     */
+    documentUpload: DocumentUpload;
+}
+
+/**
+ * 
+ */
+export class V3DocumentApi extends runtime.BaseAPI {
+
+    /**
+     * 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 v3DocumentDelete without sending the request
+     */
+    async v3DocumentDeleteRequestOpts(requestParameters: V3DocumentDeleteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reference'] == null) {
+            throw new runtime.RequiredError(
+                'reference',
+                'Required parameter "reference" was null or undefined when calling v3DocumentDelete().'
+            );
+        }
+
+        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 v3DocumentDeleteRaw(requestParameters: V3DocumentDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.v3DocumentDeleteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a document
+     */
+    async v3DocumentDelete(requestParameters: V3DocumentDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.v3DocumentDeleteRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for v3DocumentGet 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().'
+            );
+        }
+
+        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 v3DocumentGetRaw(requestParameters: V3DocumentGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentGet200Response>> {
+        const requestOptions = await this.v3DocumentGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => V3DocumentGet200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List the documents of a tradeflow
+     */
+    async v3DocumentGet(requestParameters: V3DocumentGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentGet200Response> {
+        const response = await this.v3DocumentGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v3DocumentPatch without sending the request
+     */
+    async v3DocumentPatchRequestOpts(requestParameters: V3DocumentPatchRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reference'] == null) {
+            throw new runtime.RequiredError(
+                'reference',
+                'Required parameter "reference" was null or undefined when calling v3DocumentPatch().'
+            );
+        }
+
+        if (requestParameters['documentUpdate'] == null) {
+            throw new runtime.RequiredError(
+                'documentUpdate',
+                'Required parameter "documentUpdate" was null or undefined when calling v3DocumentPatch().'
+            );
+        }
+
+        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 v3DocumentPatchRaw(requestParameters: V3DocumentPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentGet200ResponseDataInner>> {
+        const requestOptions = await this.v3DocumentPatchRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => V3DocumentGet200ResponseDataInnerFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a document
+     */
+    async v3DocumentPatch(requestParameters: V3DocumentPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentGet200ResponseDataInner> {
+        const response = await this.v3DocumentPatchRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v3DocumentPost without sending the request
+     */
+    async v3DocumentPostRequestOpts(requestParameters: V3DocumentPostRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['documentUpload'] == null) {
+            throw new runtime.RequiredError(
+                'documentUpload',
+                'Required parameter "documentUpload" was null or undefined when calling v3DocumentPost().'
+            );
+        }
+
+        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 v3DocumentPostRaw(requestParameters: V3DocumentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3DocumentPost202Response>> {
+        const requestOptions = await this.v3DocumentPostRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => V3DocumentPost202ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a document to a tradeflow
+     */
+    async v3DocumentPost(requestParameters: V3DocumentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3DocumentPost202Response> {
+        const response = await this.v3DocumentPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}