@dockflow/sdk 0.0.0-stage → 0.3.0

package/docs/DocumentsApi.md

@@ -0,0 +1,361 @@
+# DocumentsApi
+
+All URIs are relative to *https://api.dockflow.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteDocument**](DocumentsApi.md#deletedocument) | **DELETE** /v3/downstream/documents/{reference} | Delete a document |
+| [**getDocument**](DocumentsApi.md#getdocument) | **GET** /v3/downstream/documents/{reference} | List the documents of a tradeflow |
+| [**listDocumentTypes**](DocumentsApi.md#listdocumenttypes) | **GET** /v3/downstream/documents/types | List document types |
+| [**updateDocument**](DocumentsApi.md#updatedocument) | **PATCH** /v3/downstream/documents/{reference} | Update a document |
+| [**uploadDocument**](DocumentsApi.md#uploaddocument) | **POST** /v3/downstream/documents | Upload a document to a tradeflow |
+
+
+
+## deleteDocument
+
+> deleteDocument(reference)
+
+Delete a document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '@dockflow/sdk';
+import type { DeleteDocumentRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DocumentsApi(config);
+
+  const body = {
+    // string
+    reference: reference_example,
+  } satisfies DeleteDocumentRequest;
+
+  try {
+    const data = await api.deleteDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reference** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **500** |  |  -  |
+| **204** | The document was deleted. |  -  |
+| **404** | No document with this id is visible to the token\'s entity. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDocument
+
+> GetDocument200Response getDocument(reference)
+
+List the documents of a tradeflow
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '@dockflow/sdk';
+import type { GetDocumentRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DocumentsApi(config);
+
+  const body = {
+    // string
+    reference: reference_example,
+  } satisfies GetDocumentRequest;
+
+  try {
+    const data = await api.getDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reference** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetDocument200Response**](GetDocument200Response.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The documents attached to the tradeflow. |  -  |
+| **404** | No tradeflow with this reference belongs to the token\'s entity. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listDocumentTypes
+
+> Array<ListDocumentTypes200ResponseInner> listDocumentTypes()
+
+List document types
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '@dockflow/sdk';
+import type { ListDocumentTypesRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DocumentsApi(config);
+
+  try {
+    const data = await api.listDocumentTypes();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<ListDocumentTypes200ResponseInner>**](ListDocumentTypes200ResponseInner.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The document types a document can be uploaded as. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateDocument
+
+> GetDocument200ResponseDataInner updateDocument(reference, documentUpdate)
+
+Update a document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '@dockflow/sdk';
+import type { UpdateDocumentRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DocumentsApi(config);
+
+  const body = {
+    // string
+    reference: reference_example,
+    // DocumentUpdate
+    documentUpdate: ...,
+  } satisfies UpdateDocumentRequest;
+
+  try {
+    const data = await api.updateDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reference** | `string` |  | [Defaults to `undefined`] |
+| **documentUpdate** | [DocumentUpdate](DocumentUpdate.md) |  | |
+
+### Return type
+
+[**GetDocument200ResponseDataInner**](GetDocument200ResponseDataInner.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **500** |  |  -  |
+| **200** | The updated document. |  -  |
+| **400** |  |  -  |
+| **404** | No document with this id is visible to the token\'s entity. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## uploadDocument
+
+> UploadDocument202Response uploadDocument(documentUpload)
+
+Upload a document to a tradeflow
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '@dockflow/sdk';
+import type { UploadDocumentRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DocumentsApi(config);
+
+  const body = {
+    // DocumentUpload
+    documentUpload: ...,
+  } satisfies UploadDocumentRequest;
+
+  try {
+    const data = await api.uploadDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **documentUpload** | [DocumentUpload](DocumentUpload.md) |  | |
+
+### Return type
+
+[**UploadDocument202Response**](UploadDocument202Response.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | The document was stored on the tradeflow. |  -  |
+| **500** |  |  -  |
+| **400** |  |  -  |
+
+[[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/DownstreamTradeflow.md

@@ -0,0 +1,91 @@
+
+# DownstreamTradeflow
+
+A tradeflow to create, or to update when its tradeflow_reference already exists.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tradeflowReference` | string
+`containerReference` | [Array<ContainerReference>](ContainerReference.md)
+`containerReferencesComplete` | boolean
+`billOfLadingReference` | [DownstreamTradeflowBillOfLadingReference](DownstreamTradeflowBillOfLadingReference.md)
+`billOfLadingReferencesComplete` | boolean
+`bookingReference` | [DownstreamTradeflowBookingReference](DownstreamTradeflowBookingReference.md)
+`bookingReferencesComplete` | boolean
+`active` | boolean
+`carrierName` | string
+`carrierScac` | string
+`customerName` | string
+`customerReference` | string
+`partners` | [Array<DownstreamTradeflowPartnersInner>](DownstreamTradeflowPartnersInner.md)
+`partnersComplete` | boolean
+`teamName` | string
+`leadContact` | string
+`portOfLoading` | string
+`portOfDischarge` | string
+`estimatedTimeOfDeparture` | Date
+`actualTimeOfDeparture` | Date
+`estimatedTimeOfArrival` | Date
+`actualTimeOfArrival` | Date
+`vessel` | string
+`incoterms` | string
+`references` | [DownstreamTradeflowReferences](DownstreamTradeflowReferences.md)
+`events` | [Array<DownstreamTradeflowEventsInner>](DownstreamTradeflowEventsInner.md)
+`freeTimeOverrides` | [Array<DownstreamTradeflowFreeTimeOverridesInner>](DownstreamTradeflowFreeTimeOverridesInner.md)
+`customReferences` | object
+`mockTracking` | [DownstreamTradeflowMockTracking](DownstreamTradeflowMockTracking.md)
+
+## Example
+
+```typescript
+import type { DownstreamTradeflow } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tradeflowReference": null,
+  "containerReference": null,
+  "containerReferencesComplete": null,
+  "billOfLadingReference": null,
+  "billOfLadingReferencesComplete": null,
+  "bookingReference": null,
+  "bookingReferencesComplete": null,
+  "active": null,
+  "carrierName": null,
+  "carrierScac": null,
+  "customerName": null,
+  "customerReference": null,
+  "partners": null,
+  "partnersComplete": null,
+  "teamName": null,
+  "leadContact": null,
+  "portOfLoading": null,
+  "portOfDischarge": null,
+  "estimatedTimeOfDeparture": null,
+  "actualTimeOfDeparture": null,
+  "estimatedTimeOfArrival": null,
+  "actualTimeOfArrival": null,
+  "vessel": null,
+  "incoterms": null,
+  "references": null,
+  "events": null,
+  "freeTimeOverrides": null,
+  "customReferences": null,
+  "mockTracking": null,
+} satisfies DownstreamTradeflow
+
+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 DownstreamTradeflow
+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/DownstreamTradeflowBillOfLadingReference.md

@@ -0,0 +1,33 @@
+
+# DownstreamTradeflowBillOfLadingReference
+
+Bill of lading number, with the carrier prefix, as a string or an array.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DownstreamTradeflowBillOfLadingReference } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DownstreamTradeflowBillOfLadingReference
+
+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 DownstreamTradeflowBillOfLadingReference
+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/DownstreamTradeflowBookingReference.md

@@ -0,0 +1,33 @@
+
+# DownstreamTradeflowBookingReference
+
+Booking number, as a string or an array.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DownstreamTradeflowBookingReference } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DownstreamTradeflowBookingReference
+
+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 DownstreamTradeflowBookingReference
+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/DownstreamTradeflowEventsInner.md

@@ -0,0 +1,42 @@
+
+# DownstreamTradeflowEventsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`containerReference` | string
+`locationName` | string
+`eventDate` | Date
+`actual` | boolean
+
+## Example
+
+```typescript
+import type { DownstreamTradeflowEventsInner } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "containerReference": null,
+  "locationName": null,
+  "eventDate": null,
+  "actual": null,
+} satisfies DownstreamTradeflowEventsInner
+
+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 DownstreamTradeflowEventsInner
+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/DownstreamTradeflowFreeTimeOverridesInner.md

@@ -0,0 +1,40 @@
+
+# DownstreamTradeflowFreeTimeOverridesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`dwellType` | string
+`freeDays` | number
+`containerReference` | string
+`cancelled` | boolean
+
+## Example
+
+```typescript
+import type { DownstreamTradeflowFreeTimeOverridesInner } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "dwellType": null,
+  "freeDays": null,
+  "containerReference": null,
+  "cancelled": null,
+} satisfies DownstreamTradeflowFreeTimeOverridesInner
+
+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 DownstreamTradeflowFreeTimeOverridesInner
+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/DownstreamTradeflowMockTracking.md

@@ -0,0 +1,35 @@
+
+# DownstreamTradeflowMockTracking
+
+UAT only: generates a synthetic journey. Ignored in production.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`scenario` | string
+
+## Example
+
+```typescript
+import type { DownstreamTradeflowMockTracking } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "scenario": null,
+} satisfies DownstreamTradeflowMockTracking
+
+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 DownstreamTradeflowMockTracking
+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/DownstreamTradeflowPartnersInner.md

@@ -0,0 +1,40 @@
+
+# DownstreamTradeflowPartnersInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`role` | string
+`reference` | string
+`leadContact` | string
+
+## Example
+
+```typescript
+import type { DownstreamTradeflowPartnersInner } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "role": null,
+  "reference": null,
+  "leadContact": null,
+} satisfies DownstreamTradeflowPartnersInner
+
+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 DownstreamTradeflowPartnersInner
+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)
+
+