@dockflow/sdk 0.0.0-stage → 0.3.0

package/docs/DownstreamTradeflowReferences.md

@@ -0,0 +1,38 @@
+
+# DownstreamTradeflowReferences
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`houseBillOfLading` | string
+`deliveryLocation` | string
+`deliveryEventDate` | string
+
+## Example
+
+```typescript
+import type { DownstreamTradeflowReferences } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "houseBillOfLading": null,
+  "deliveryLocation": null,
+  "deliveryEventDate": null,
+} satisfies DownstreamTradeflowReferences
+
+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 DownstreamTradeflowReferences
+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/GetDocument200Response.md

@@ -0,0 +1,38 @@
+
+# GetDocument200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<GetDocument200ResponseDataInner>](GetDocument200ResponseDataInner.md)
+`tradeflowReference` | string
+`count` | number
+
+## Example
+
+```typescript
+import type { GetDocument200Response } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "tradeflowReference": null,
+  "count": null,
+} satisfies GetDocument200Response
+
+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 GetDocument200Response
+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/GetDocument200ResponseDataInner.md

@@ -0,0 +1,50 @@
+
+# GetDocument200ResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`filetype` | string
+`inputName` | string
+`version` | number
+`documentType` | [GetDocument200ResponseDataInnerDocumentType](GetDocument200ResponseDataInnerDocumentType.md)
+`metadata` | object
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { GetDocument200ResponseDataInner } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "filetype": null,
+  "inputName": null,
+  "version": null,
+  "documentType": null,
+  "metadata": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies GetDocument200ResponseDataInner
+
+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 GetDocument200ResponseDataInner
+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/GetDocument200ResponseDataInnerDocumentType.md

@@ -0,0 +1,36 @@
+
+# GetDocument200ResponseDataInnerDocumentType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { GetDocument200ResponseDataInnerDocumentType } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+} satisfies GetDocument200ResponseDataInnerDocumentType
+
+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 GetDocument200ResponseDataInnerDocumentType
+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/GetUpstream200Response.md

@@ -0,0 +1,36 @@
+
+# GetUpstream200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<UpstreamRecord>](UpstreamRecord.md)
+`nextCursor` | string
+
+## Example
+
+```typescript
+import type { GetUpstream200Response } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "nextCursor": null,
+} satisfies GetUpstream200Response
+
+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 GetUpstream200Response
+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/GetUpstream400Response.md

@@ -0,0 +1,32 @@
+
+# GetUpstream400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { GetUpstream400Response } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies GetUpstream400Response
+
+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 GetUpstream400Response
+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/InlineObject.md

@@ -0,0 +1,36 @@
+
+# InlineObject
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`errors` | { [key: string]: Array<string>; }
+
+## Example
+
+```typescript
+import type { InlineObject } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "errors": null,
+} satisfies InlineObject
+
+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 InlineObject
+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/ListDocumentTypes200ResponseInner.md

@@ -0,0 +1,36 @@
+
+# ListDocumentTypes200ResponseInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { ListDocumentTypes200ResponseInner } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "description": null,
+} satisfies ListDocumentTypes200ResponseInner
+
+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 ListDocumentTypes200ResponseInner
+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/TradeflowsApi.md

@@ -0,0 +1,158 @@
+# TradeflowsApi
+
+All URIs are relative to *https://api.dockflow.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createTradeflows**](TradeflowsApi.md#createtradeflows) | **POST** /v3/downstream/tradeflows | Upsert tradeflows |
+| [**deleteTradeflow**](TradeflowsApi.md#deletetradeflow) | **DELETE** /v3/downstream/tradeflows/{tradeflow_reference} | Delete a tradeflow |
+
+
+
+## createTradeflows
+
+> CreateTradeflows202Response createTradeflows(downstreamTradeflow)
+
+Upsert tradeflows
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TradeflowsApi,
+} from '@dockflow/sdk';
+import type { CreateTradeflowsRequest } 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 TradeflowsApi(config);
+
+  const body = {
+    // Array<DownstreamTradeflow>
+    downstreamTradeflow: ...,
+  } satisfies CreateTradeflowsRequest;
+
+  try {
+    const data = await api.createTradeflows(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **downstreamTradeflow** | `Array<DownstreamTradeflow>` |  | |
+
+### Return type
+
+[**CreateTradeflows202Response**](CreateTradeflows202Response.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 tradeflows passed validation and are queued for import. |  -  |
+| **400** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteTradeflow
+
+> string deleteTradeflow(tradeflowReference, confirm, hard)
+
+Delete a tradeflow
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TradeflowsApi,
+} from '@dockflow/sdk';
+import type { DeleteTradeflowRequest } 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 TradeflowsApi(config);
+
+  const body = {
+    // string
+    tradeflowReference: tradeflowReference_example,
+    // string (optional)
+    confirm: confirm_example,
+    // boolean | true deletes the tradeflow permanently. Default: it is deactivated. (optional)
+    hard: true,
+  } satisfies DeleteTradeflowRequest;
+
+  try {
+    const data = await api.deleteTradeflow(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tradeflowReference** | `string` |  | [Defaults to `undefined`] |
+| **confirm** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **hard** | `boolean` | true deletes the tradeflow permanently. Default: it is deactivated. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**string**
+
+### 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 tradeflow was deactivated, or deleted with &#x60;hard&#x3D;true&#x60;. The reference &#x60;*&#x60; targets every tradeflow and needs &#x60;confirm&#x3D;PRODUCTION&#x60; on production. |  -  |
+| **404** | No tradeflow with this reference belongs to the token\&#39;s entity. |  -  |
+| **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/UploadDocument202Response.md

@@ -0,0 +1,46 @@
+
+# UploadDocument202Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`tradeflowReference` | string
+`documentType` | string
+`filename` | string
+`filetype` | string
+`containerReference` | string
+`createdAt` | string
+
+## Example
+
+```typescript
+import type { UploadDocument202Response } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "tradeflowReference": null,
+  "documentType": null,
+  "filename": null,
+  "filetype": null,
+  "containerReference": null,
+  "createdAt": null,
+} satisfies UploadDocument202Response
+
+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 UploadDocument202Response
+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/UploadDocument400Response.md

@@ -0,0 +1,32 @@
+
+# UploadDocument400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { UploadDocument400Response } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies UploadDocument400Response
+
+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 UploadDocument400Response
+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/UpstreamApi.md

@@ -0,0 +1,109 @@
+# UpstreamApi
+
+All URIs are relative to *https://api.dockflow.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getUpstream**](UpstreamApi.md#getupstream) | **GET** /v3/upstream | Poll upstream events |
+
+
+
+## getUpstream
+
+> GetUpstream200Response getUpstream(since, tradeflow, container, category, code, cursor, active, fields, format, perPage, failsafe)
+
+Poll upstream events
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UpstreamApi,
+} from '@dockflow/sdk';
+import type { GetUpstreamRequest } 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 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)
+    since: since_example,
+    // string | Your tradeflow reference. Returns that tradeflow regardless of when it changed. (optional)
+    tradeflow: tradeflow_example,
+    // string | A container number. Returns its tradeflows regardless of when they changed. (optional)
+    container: container_example,
+    // string | Keep only events of this category: MILESTONE, SHIPMENT or LOCATION. (optional)
+    category: category_example,
+    // string | Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400. (optional)
+    code: code_example,
+    // string | next_cursor from the previous page. Keep since identical across the pages of one cycle. (optional)
+    cursor: cursor_example,
+    // string | true (active only), false, or both. Default: active plus recently deactivated. (optional)
+    active: active_example,
+    // string | Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels. (optional)
+    fields: fields_example,
+    // 'v3' | 'dcsa-tnt-2.2' | Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical. (optional)
+    format: format_example,
+    // number | Tradeflows per page, 1 to 1000. Default 50. (optional)
+    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 GetUpstreamRequest;
+
+  try {
+    const data = await api.getUpstream(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **since** | `string` | Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes. | [Optional] [Defaults to `undefined`] |
+| **tradeflow** | `string` | Your tradeflow reference. Returns that tradeflow regardless of when it changed. | [Optional] [Defaults to `undefined`] |
+| **container** | `string` | A container number. Returns its tradeflows regardless of when they changed. | [Optional] [Defaults to `undefined`] |
+| **category** | `string` | Keep only events of this category: MILESTONE, SHIPMENT or LOCATION. | [Optional] [Defaults to `undefined`] |
+| **code** | `string` | Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400. | [Optional] [Defaults to `undefined`] |
+| **cursor** | `string` | next_cursor from the previous page. Keep since identical across the pages of one cycle. | [Optional] [Defaults to `undefined`] |
+| **active** | `string` | true (active only), false, or both. Default: active plus recently deactivated. | [Optional] [Defaults to `undefined`] |
+| **fields** | `string` | Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels. | [Optional] [Defaults to `''`] |
+| **format** | `v3`, `dcsa-tnt-2.2` | Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical. | [Optional] [Defaults to `'v3'`] [Enum: v3, dcsa-tnt-2.2] |
+| **perPage** | `number` | Tradeflows per page, 1 to 1000. Default 50. | [Optional] [Defaults to `undefined`] |
+| **failsafe** | `0`, `1` | Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing. | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+
+### Return type
+
+[**GetUpstream200Response**](GetUpstream200Response.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** | A page of tradeflows matching the filters. Pass `next_cursor` back to read the next page; it is null on the last one. |  -  |
+| **400** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+