@dockflow/sdk 0.0.0-stage → 0.2.0

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)
+
+

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/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/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)
+
+