@dockflow/sdk 0.0.0-stage → 0.2.0

package/src/models/WidgetMilestone.ts

@@ -0,0 +1,93 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Dockflow v3 API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { WidgetLocation } from './WidgetLocation';
+import {
+    WidgetLocationFromJSON,
+    WidgetLocationFromJSONTyped,
+    WidgetLocationToJSON,
+    WidgetLocationToJSONTyped,
+} from './WidgetLocation';
+
+/**
+ * 
+ * @export
+ * @interface WidgetMilestone
+ */
+export interface WidgetMilestone {
+    /**
+     * 
+     */
+    status: string | null;
+    /**
+     * 
+     */
+    eventDate: string | null;
+    /**
+     * 
+     */
+    vesselName: string | null;
+    /**
+     * 
+     */
+    location: WidgetLocation | null;
+}
+
+/**
+ * Check if a given object implements the WidgetMilestone interface.
+ */
+export function instanceOfWidgetMilestone(value: object): value is WidgetMilestone {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if ((!('eventDate' in (value as Record<string, any>)) && !('event_date' in (value as Record<string, any>))) || ((value as Record<string, any>)['eventDate'] === undefined && (value as Record<string, any>)['event_date'] === undefined)) return false;
+    if ((!('vesselName' in (value as Record<string, any>)) && !('vessel_name' in (value as Record<string, any>))) || ((value as Record<string, any>)['vesselName'] === undefined && (value as Record<string, any>)['vessel_name'] === undefined)) return false;
+    if (!('location' in value) || value['location'] === undefined) return false;
+    return true;
+}
+
+export function WidgetMilestoneFromJSON(json: any): WidgetMilestone {
+    return WidgetMilestoneFromJSONTyped(json, false);
+}
+
+export function WidgetMilestoneFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetMilestone {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'eventDate': json['event_date'],
+        'vesselName': json['vessel_name'],
+        'location': WidgetLocationFromJSON(json['location']),
+    };
+}
+
+export function WidgetMilestoneToJSON(json: any): WidgetMilestone {
+    return WidgetMilestoneToJSONTyped(json, false);
+}
+
+export function WidgetMilestoneToJSONTyped(value?: WidgetMilestone | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'event_date': value['eventDate'],
+        'vessel_name': value['vesselName'],
+        'location': WidgetLocationToJSON(value['location']),
+    };
+}
+

package/src/models/WidgetPoint.ts

@@ -0,0 +1,71 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Dockflow v3 API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface WidgetPoint
+ */
+export interface WidgetPoint {
+    /**
+     * 
+     */
+    lat: number;
+    /**
+     * 
+     */
+    lng: number;
+}
+
+/**
+ * Check if a given object implements the WidgetPoint interface.
+ */
+export function instanceOfWidgetPoint(value: object): value is WidgetPoint {
+    if (!('lat' in value) || value['lat'] === undefined) return false;
+    if (!('lng' in value) || value['lng'] === undefined) return false;
+    return true;
+}
+
+export function WidgetPointFromJSON(json: any): WidgetPoint {
+    return WidgetPointFromJSONTyped(json, false);
+}
+
+export function WidgetPointFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetPoint {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'lat': json['lat'],
+        'lng': json['lng'],
+    };
+}
+
+export function WidgetPointToJSON(json: any): WidgetPoint {
+    return WidgetPointToJSONTyped(json, false);
+}
+
+export function WidgetPointToJSONTyped(value?: WidgetPoint | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'lat': value['lat'],
+        'lng': value['lng'],
+    };
+}
+

package/src/models/WidgetSearchResult.ts

@@ -0,0 +1,142 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Dockflow v3 API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { WidgetContainer } from './WidgetContainer';
+import {
+    WidgetContainerFromJSON,
+    WidgetContainerFromJSONTyped,
+    WidgetContainerToJSON,
+    WidgetContainerToJSONTyped,
+} from './WidgetContainer';
+import type { WidgetLeg } from './WidgetLeg';
+import {
+    WidgetLegFromJSON,
+    WidgetLegFromJSONTyped,
+    WidgetLegToJSON,
+    WidgetLegToJSONTyped,
+} from './WidgetLeg';
+import type { WidgetTrack } from './WidgetTrack';
+import {
+    WidgetTrackFromJSON,
+    WidgetTrackFromJSONTyped,
+    WidgetTrackToJSON,
+    WidgetTrackToJSONTyped,
+} from './WidgetTrack';
+
+/**
+ * 
+ * @export
+ * @interface WidgetSearchResult
+ */
+export interface WidgetSearchResult {
+    /**
+     * 
+     */
+    references: Array<string>;
+    /**
+     * 
+     */
+    carrier: string | null;
+    /**
+     * 
+     */
+    bookingReference: string | null;
+    /**
+     * 
+     */
+    billOfLadingReference: string | null;
+    /**
+     * 
+     */
+    departure: WidgetLeg | null;
+    /**
+     * 
+     */
+    arrival: WidgetLeg | null;
+    /**
+     * 
+     */
+    containers: Array<WidgetContainer>;
+    /**
+     * 
+     */
+    tracks: Array<WidgetTrack>;
+    /**
+     * The shipment in the entity's portal, on its blueprint's domain.
+     */
+    detailsUrl: string | null;
+}
+
+/**
+ * Check if a given object implements the WidgetSearchResult interface.
+ */
+export function instanceOfWidgetSearchResult(value: object): value is WidgetSearchResult {
+    if (!('references' in value) || value['references'] === undefined) return false;
+    if (!('carrier' in value) || value['carrier'] === undefined) return false;
+    if ((!('bookingReference' in (value as Record<string, any>)) && !('booking_reference' in (value as Record<string, any>))) || ((value as Record<string, any>)['bookingReference'] === undefined && (value as Record<string, any>)['booking_reference'] === undefined)) return false;
+    if ((!('billOfLadingReference' in (value as Record<string, any>)) && !('bill_of_lading_reference' in (value as Record<string, any>))) || ((value as Record<string, any>)['billOfLadingReference'] === undefined && (value as Record<string, any>)['bill_of_lading_reference'] === undefined)) return false;
+    if (!('departure' in value) || value['departure'] === undefined) return false;
+    if (!('arrival' in value) || value['arrival'] === undefined) return false;
+    if (!('containers' in value) || value['containers'] === undefined) return false;
+    if (!('tracks' in value) || value['tracks'] === undefined) return false;
+    if ((!('detailsUrl' in (value as Record<string, any>)) && !('details_url' in (value as Record<string, any>))) || ((value as Record<string, any>)['detailsUrl'] === undefined && (value as Record<string, any>)['details_url'] === undefined)) return false;
+    return true;
+}
+
+export function WidgetSearchResultFromJSON(json: any): WidgetSearchResult {
+    return WidgetSearchResultFromJSONTyped(json, false);
+}
+
+export function WidgetSearchResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetSearchResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'references': json['references'],
+        'carrier': json['carrier'],
+        'bookingReference': json['booking_reference'],
+        'billOfLadingReference': json['bill_of_lading_reference'],
+        'departure': WidgetLegFromJSON(json['departure']),
+        'arrival': WidgetLegFromJSON(json['arrival']),
+        'containers': ((json['containers'] as Array<any>).map(WidgetContainerFromJSON)),
+        'tracks': ((json['tracks'] as Array<any>).map(WidgetTrackFromJSON)),
+        'detailsUrl': json['details_url'],
+    };
+}
+
+export function WidgetSearchResultToJSON(json: any): WidgetSearchResult {
+    return WidgetSearchResultToJSONTyped(json, false);
+}
+
+export function WidgetSearchResultToJSONTyped(value?: WidgetSearchResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'references': value['references'],
+        'carrier': value['carrier'],
+        'booking_reference': value['bookingReference'],
+        'bill_of_lading_reference': value['billOfLadingReference'],
+        'departure': WidgetLegToJSON(value['departure']),
+        'arrival': WidgetLegToJSON(value['arrival']),
+        'containers': ((value['containers'] as Array<any>).map(WidgetContainerToJSON)),
+        'tracks': ((value['tracks'] as Array<any>).map(WidgetTrackToJSON)),
+        'details_url': value['detailsUrl'],
+    };
+}
+

package/src/models/WidgetTrack.ts

@@ -0,0 +1,79 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Dockflow v3 API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { WidgetTrackReading } from './WidgetTrackReading';
+import {
+    WidgetTrackReadingFromJSON,
+    WidgetTrackReadingFromJSONTyped,
+    WidgetTrackReadingToJSON,
+    WidgetTrackReadingToJSONTyped,
+} from './WidgetTrackReading';
+
+/**
+ * 
+ * @export
+ * @interface WidgetTrack
+ */
+export interface WidgetTrack {
+    /**
+     * 
+     */
+    deviceReference: string | null;
+    /**
+     * 
+     */
+    readings: Array<WidgetTrackReading>;
+}
+
+/**
+ * Check if a given object implements the WidgetTrack interface.
+ */
+export function instanceOfWidgetTrack(value: object): value is WidgetTrack {
+    if ((!('deviceReference' in (value as Record<string, any>)) && !('device_reference' in (value as Record<string, any>))) || ((value as Record<string, any>)['deviceReference'] === undefined && (value as Record<string, any>)['device_reference'] === undefined)) return false;
+    if (!('readings' in value) || value['readings'] === undefined) return false;
+    return true;
+}
+
+export function WidgetTrackFromJSON(json: any): WidgetTrack {
+    return WidgetTrackFromJSONTyped(json, false);
+}
+
+export function WidgetTrackFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetTrack {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'deviceReference': json['device_reference'],
+        'readings': ((json['readings'] as Array<any>).map(WidgetTrackReadingFromJSON)),
+    };
+}
+
+export function WidgetTrackToJSON(json: any): WidgetTrack {
+    return WidgetTrackToJSONTyped(json, false);
+}
+
+export function WidgetTrackToJSONTyped(value?: WidgetTrack | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'device_reference': value['deviceReference'],
+        'readings': ((value['readings'] as Array<any>).map(WidgetTrackReadingToJSON)),
+    };
+}
+

package/src/models/WidgetTrackReading.ts

@@ -0,0 +1,78 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Dockflow v3 API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface WidgetTrackReading
+ */
+export interface WidgetTrackReading {
+    /**
+     * 
+     */
+    eventDate: string;
+    /**
+     * 
+     */
+    lat: number;
+    /**
+     * 
+     */
+    lng: number;
+}
+
+/**
+ * Check if a given object implements the WidgetTrackReading interface.
+ */
+export function instanceOfWidgetTrackReading(value: object): value is WidgetTrackReading {
+    if ((!('eventDate' in (value as Record<string, any>)) && !('event_date' in (value as Record<string, any>))) || ((value as Record<string, any>)['eventDate'] === undefined && (value as Record<string, any>)['event_date'] === undefined)) return false;
+    if (!('lat' in value) || value['lat'] === undefined) return false;
+    if (!('lng' in value) || value['lng'] === undefined) return false;
+    return true;
+}
+
+export function WidgetTrackReadingFromJSON(json: any): WidgetTrackReading {
+    return WidgetTrackReadingFromJSONTyped(json, false);
+}
+
+export function WidgetTrackReadingFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetTrackReading {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'eventDate': json['event_date'],
+        'lat': json['lat'],
+        'lng': json['lng'],
+    };
+}
+
+export function WidgetTrackReadingToJSON(json: any): WidgetTrackReading {
+    return WidgetTrackReadingToJSONTyped(json, false);
+}
+
+export function WidgetTrackReadingToJSONTyped(value?: WidgetTrackReading | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'event_date': value['eventDate'],
+        'lat': value['lat'],
+        'lng': value['lng'],
+    };
+}
+

package/src/models/index.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ContainerReference';
+export * from './DocumentUpdate';
+export * from './DocumentUpload';
+export * from './DownstreamTradeflow';
+export * from './DownstreamTradeflowBillOfLadingReference';
+export * from './DownstreamTradeflowBookingReference';
+export * from './DownstreamTradeflowEventsInner';
+export * from './DownstreamTradeflowFreeTimeOverridesInner';
+export * from './DownstreamTradeflowMockTracking';
+export * from './DownstreamTradeflowPartnersInner';
+export * from './DownstreamTradeflowReferences';
+export * from './InlineObject';
+export * from './ListDocumentTypes200ResponseInner';
+export * from './UpstreamRecord';
+export * from './UpstreamRecordAdditionalReferences';
+export * from './UpstreamRecordDataQuality';
+export * from './UpstreamRecordMetadata';
+export * from './V3DocumentGet200Response';
+export * from './V3DocumentGet200ResponseDataInner';
+export * from './V3DocumentGet200ResponseDataInnerDocumentType';
+export * from './V3DocumentPost202Response';
+export * from './V3DocumentPost400Response';
+export * from './V3DownstreamPost202Response';
+export * from './V3DownstreamPost202ResponseTradeflowsInner';
+export * from './V3UpstreamGet200Response';
+export * from './V3UpstreamGet400Response';
+export * from './WidgetContainer';
+export * from './WidgetCountry';
+export * from './WidgetLeg';
+export * from './WidgetLocation';
+export * from './WidgetMilestone';
+export * from './WidgetPoint';
+export * from './WidgetSearchResult';
+export * from './WidgetTrack';
+export * from './WidgetTrackReading';