@dockflow/sdk 0.0.0-stage → 0.2.0

package/docs/V3DownstreamApi.md

@@ -0,0 +1,158 @@
+# V3DownstreamApi
+
+All URIs are relative to *https://api.dockflow.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v3DownstreamDelete**](V3DownstreamApi.md#v3downstreamdelete) | **DELETE** /v3/downstream/tradeflows/{tradeflow_reference} | Delete a tradeflow |
+| [**v3DownstreamPost**](V3DownstreamApi.md#v3downstreampost) | **POST** /v3/downstream/tradeflows | Upsert tradeflows |
+
+
+
+## v3DownstreamDelete
+
+> string v3DownstreamDelete(tradeflowReference, confirm, hard)
+
+Delete a tradeflow
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V3DownstreamApi,
+} from '@dockflow/sdk';
+import type { V3DownstreamDeleteRequest } 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 V3DownstreamApi(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 V3DownstreamDeleteRequest;
+
+  try {
+    const data = await api.v3DownstreamDelete(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 `hard=true`. The reference `*` targets every tradeflow and needs `confirm=PRODUCTION` on production. |  -  |
+| **404** | No tradeflow with this reference belongs to the token\'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)
+
+
+## v3DownstreamPost
+
+> V3DownstreamPost202Response v3DownstreamPost(downstreamTradeflow)
+
+Upsert tradeflows
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V3DownstreamApi,
+} from '@dockflow/sdk';
+import type { V3DownstreamPostRequest } 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 V3DownstreamApi(config);
+
+  const body = {
+    // Array<DownstreamTradeflow>
+    downstreamTradeflow: ...,
+  } satisfies V3DownstreamPostRequest;
+
+  try {
+    const data = await api.v3DownstreamPost(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
+
+[**V3DownstreamPost202Response**](V3DownstreamPost202Response.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)
+

package/docs/V3DownstreamPost202Response.md

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

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

@@ -0,0 +1,109 @@
+# V3UpstreamApi
+
+All URIs are relative to *https://api.dockflow.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v3UpstreamGet**](V3UpstreamApi.md#v3upstreamget) | **GET** /v3/upstream | Poll upstream events |
+
+
+
+## v3UpstreamGet
+
+> V3UpstreamGet200Response v3UpstreamGet(since, tradeflow, container, category, code, cursor, active, fields, format, perPage, failsafe)
+
+Poll upstream events
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V3UpstreamApi,
+} from '@dockflow/sdk';
+import type { V3UpstreamGetRequest } 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 V3UpstreamApi(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 V3UpstreamGetRequest;
+
+  try {
+    const data = await api.v3UpstreamGet(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
+
+[**V3UpstreamGet200Response**](V3UpstreamGet200Response.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)
+

package/docs/V3UpstreamGet200Response.md

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

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

@@ -0,0 +1,81 @@
+# WidgetApi
+
+All URIs are relative to *https://api.dockflow.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**searchWidget**](WidgetApi.md#searchwidget) | **GET** /v3/widget/search | Search a shipment for the embeddable tracking widget |
+
+
+
+## searchWidget
+
+> WidgetSearchResult searchWidget(q)
+
+Search a shipment for the embeddable tracking widget
+
+Matches a container number, booking or bill of lading within the token\'s entity and returns the best match.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WidgetApi,
+} from '@dockflow/sdk';
+import type { SearchWidgetRequest } 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 WidgetApi(config);
+
+  const body = {
+    // string | Container number, booking or bill of lading reference.
+    q: q_example,
+  } satisfies SearchWidgetRequest;
+
+  try {
+    const data = await api.searchWidget(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **q** | `string` | Container number, booking or bill of lading reference. | [Defaults to `undefined`] |
+
+### Return type
+
+[**WidgetSearchResult**](WidgetSearchResult.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 best match. Every field is null or empty when nothing matches. |  -  |
+| **422** | Validation error |  -  |
+
+[[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/WidgetContainer.md

@@ -0,0 +1,42 @@
+
+# WidgetContainer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reference` | string
+`typeCode` | string
+`typeGroup` | string
+`length` | string
+`latestActualMilestone` | [WidgetMilestone](WidgetMilestone.md)
+
+## Example
+
+```typescript
+import type { WidgetContainer } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reference": null,
+  "typeCode": null,
+  "typeGroup": null,
+  "length": null,
+  "latestActualMilestone": null,
+} satisfies WidgetContainer
+
+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 WidgetContainer
+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/WidgetCountry.md

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

@@ -0,0 +1,40 @@
+
+# WidgetLeg
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`vesselName` | string
+`eventDate` | string
+`actual` | boolean
+`location` | [WidgetLocation](WidgetLocation.md)
+
+## Example
+
+```typescript
+import type { WidgetLeg } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "vesselName": null,
+  "eventDate": null,
+  "actual": null,
+  "location": null,
+} satisfies WidgetLeg
+
+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 WidgetLeg
+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/WidgetLocation.md

@@ -0,0 +1,42 @@
+
+# WidgetLocation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`unlocode` | string
+`timezone` | string
+`country` | [WidgetCountry](WidgetCountry.md)
+`point` | [WidgetPoint](WidgetPoint.md)
+
+## Example
+
+```typescript
+import type { WidgetLocation } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "unlocode": null,
+  "timezone": null,
+  "country": null,
+  "point": null,
+} satisfies WidgetLocation
+
+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 WidgetLocation
+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/WidgetMilestone.md

@@ -0,0 +1,40 @@
+
+# WidgetMilestone
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`eventDate` | string
+`vesselName` | string
+`location` | [WidgetLocation](WidgetLocation.md)
+
+## Example
+
+```typescript
+import type { WidgetMilestone } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "eventDate": null,
+  "vesselName": null,
+  "location": null,
+} satisfies WidgetMilestone
+
+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 WidgetMilestone
+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)
+
+