@dockflow/sdk 0.0.0-stage → 0.3.0

package/docs/UpstreamRecord.md

@@ -0,0 +1,57 @@
+
+# UpstreamRecord
+
+One record per shipment of a tradeflow. The locations, containers, vessels, shipment and events blocks are present when requested with fields.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`version` | string
+`tradeflowReference` | string
+`billOfLading` | string
+`booking` | string
+`additionalReferences` | [UpstreamRecordAdditionalReferences](UpstreamRecordAdditionalReferences.md)
+`dataQuality` | [UpstreamRecordDataQuality](UpstreamRecordDataQuality.md)
+`metadata` | [UpstreamRecordMetadata](UpstreamRecordMetadata.md)
+`locations` | Array<object>
+`containers` | Array<object>
+`vessels` | Array<object>
+`shipment` | object
+`events` | Array<object>
+
+## Example
+
+```typescript
+import type { UpstreamRecord } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "version": null,
+  "tradeflowReference": null,
+  "billOfLading": null,
+  "booking": null,
+  "additionalReferences": null,
+  "dataQuality": null,
+  "metadata": null,
+  "locations": null,
+  "containers": null,
+  "vessels": null,
+  "shipment": null,
+  "events": null,
+} satisfies UpstreamRecord
+
+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 UpstreamRecord
+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/UpstreamRecordAdditionalReferences.md

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

@@ -0,0 +1,42 @@
+
+# UpstreamRecordDataQuality
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`freshnessMin` | number
+`anomalies` | number
+`missedMilestones` | number
+`hasLiveData` | boolean
+`isSingularShipment` | boolean
+
+## Example
+
+```typescript
+import type { UpstreamRecordDataQuality } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "freshnessMin": null,
+  "anomalies": null,
+  "missedMilestones": null,
+  "hasLiveData": null,
+  "isSingularShipment": null,
+} satisfies UpstreamRecordDataQuality
+
+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 UpstreamRecordDataQuality
+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/UpstreamRecordMetadata.md

@@ -0,0 +1,40 @@
+
+# UpstreamRecordMetadata
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`lastUpdated` | Date
+`carrierName` | string
+`carrierScac` | string
+`isActive` | boolean
+
+## Example
+
+```typescript
+import type { UpstreamRecordMetadata } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "lastUpdated": null,
+  "carrierName": null,
+  "carrierScac": null,
+  "isActive": null,
+} satisfies UpstreamRecordMetadata
+
+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 UpstreamRecordMetadata
+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)
+
+

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.3.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"
+  }
+}