@dockflow/sdk 0.0.0-stage → 0.3.0

package/src/models/UpstreamRecordMetadata.ts

@@ -0,0 +1,81 @@
+/* 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, parseDate, parseDateTime, serializeDate, serializeDateTime } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface UpstreamRecordMetadata
+ */
+export interface UpstreamRecordMetadata {
+    /**
+     * Keep since unchanged while following next_cursor; after the last page, use the highest value as the next since.
+     */
+    lastUpdated?: Date;
+    /**
+     * 
+     */
+    carrierName?: string | null;
+    /**
+     * 
+     */
+    carrierScac?: string | null;
+    /**
+     * 
+     */
+    isActive?: boolean;
+}
+
+/**
+ * Check if a given object implements the UpstreamRecordMetadata interface.
+ */
+export function instanceOfUpstreamRecordMetadata(value: object): value is UpstreamRecordMetadata {
+    return true;
+}
+
+export function UpstreamRecordMetadataFromJSON(json: any): UpstreamRecordMetadata {
+    return UpstreamRecordMetadataFromJSONTyped(json, false);
+}
+
+export function UpstreamRecordMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpstreamRecordMetadata {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'lastUpdated': json['last_updated'] == null ? undefined : (parseDateTime(json['last_updated'])),
+        'carrierName': json['carrier_name'] === undefined ? undefined : json['carrier_name'] === null ? null : json['carrier_name'],
+        'carrierScac': json['carrier_scac'] === undefined ? undefined : json['carrier_scac'] === null ? null : json['carrier_scac'],
+        'isActive': json['is_active'] == null ? undefined : json['is_active'],
+    };
+}
+
+export function UpstreamRecordMetadataToJSON(json: any): UpstreamRecordMetadata {
+    return UpstreamRecordMetadataToJSONTyped(json, false);
+}
+
+export function UpstreamRecordMetadataToJSONTyped(value?: UpstreamRecordMetadata | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'last_updated': value['lastUpdated'] == null ? value['lastUpdated'] : serializeDateTime(value['lastUpdated']),
+        'carrier_name': value['carrierName'],
+        'carrier_scac': value['carrierScac'],
+        'is_active': value['isActive'],
+    };
+}
+

package/src/models/WidgetContainer.ts

@@ -0,0 +1,100 @@
+/* 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 { WidgetMilestone } from './WidgetMilestone';
+import {
+    WidgetMilestoneFromJSON,
+    WidgetMilestoneFromJSONTyped,
+    WidgetMilestoneToJSON,
+    WidgetMilestoneToJSONTyped,
+} from './WidgetMilestone';
+
+/**
+ * 
+ * @export
+ * @interface WidgetContainer
+ */
+export interface WidgetContainer {
+    /**
+     * 
+     */
+    reference: string;
+    /**
+     * 
+     */
+    typeCode: string | null;
+    /**
+     * 
+     */
+    typeGroup: string | null;
+    /**
+     * 
+     */
+    length: string | null;
+    /**
+     * 
+     */
+    latestActualMilestone: WidgetMilestone | null;
+}
+
+/**
+ * Check if a given object implements the WidgetContainer interface.
+ */
+export function instanceOfWidgetContainer(value: object): value is WidgetContainer {
+    if (!('reference' in value) || value['reference'] === undefined) return false;
+    if ((!('typeCode' in (value as Record<string, any>)) && !('type_code' in (value as Record<string, any>))) || ((value as Record<string, any>)['typeCode'] === undefined && (value as Record<string, any>)['type_code'] === undefined)) return false;
+    if ((!('typeGroup' in (value as Record<string, any>)) && !('type_group' in (value as Record<string, any>))) || ((value as Record<string, any>)['typeGroup'] === undefined && (value as Record<string, any>)['type_group'] === undefined)) return false;
+    if (!('length' in value) || value['length'] === undefined) return false;
+    if ((!('latestActualMilestone' in (value as Record<string, any>)) && !('latest_actual_milestone' in (value as Record<string, any>))) || ((value as Record<string, any>)['latestActualMilestone'] === undefined && (value as Record<string, any>)['latest_actual_milestone'] === undefined)) return false;
+    return true;
+}
+
+export function WidgetContainerFromJSON(json: any): WidgetContainer {
+    return WidgetContainerFromJSONTyped(json, false);
+}
+
+export function WidgetContainerFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetContainer {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reference': json['reference'],
+        'typeCode': json['type_code'],
+        'typeGroup': json['type_group'],
+        'length': json['length'],
+        'latestActualMilestone': WidgetMilestoneFromJSON(json['latest_actual_milestone']),
+    };
+}
+
+export function WidgetContainerToJSON(json: any): WidgetContainer {
+    return WidgetContainerToJSONTyped(json, false);
+}
+
+export function WidgetContainerToJSONTyped(value?: WidgetContainer | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'reference': value['reference'],
+        'type_code': value['typeCode'],
+        'type_group': value['typeGroup'],
+        'length': value['length'],
+        'latest_actual_milestone': WidgetMilestoneToJSON(value['latestActualMilestone']),
+    };
+}
+

package/src/models/WidgetCountry.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 WidgetCountry
+ */
+export interface WidgetCountry {
+    /**
+     * 
+     */
+    name: string | null;
+    /**
+     * 
+     */
+    isoA2: string | null;
+}
+
+/**
+ * Check if a given object implements the WidgetCountry interface.
+ */
+export function instanceOfWidgetCountry(value: object): value is WidgetCountry {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if ((!('isoA2' in (value as Record<string, any>)) && !('iso_a2' in (value as Record<string, any>))) || ((value as Record<string, any>)['isoA2'] === undefined && (value as Record<string, any>)['iso_a2'] === undefined)) return false;
+    return true;
+}
+
+export function WidgetCountryFromJSON(json: any): WidgetCountry {
+    return WidgetCountryFromJSONTyped(json, false);
+}
+
+export function WidgetCountryFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetCountry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'isoA2': json['iso_a2'],
+    };
+}
+
+export function WidgetCountryToJSON(json: any): WidgetCountry {
+    return WidgetCountryToJSONTyped(json, false);
+}
+
+export function WidgetCountryToJSONTyped(value?: WidgetCountry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'iso_a2': value['isoA2'],
+    };
+}
+

package/src/models/WidgetLeg.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 WidgetLeg
+ */
+export interface WidgetLeg {
+    /**
+     * 
+     */
+    vesselName: string | null;
+    /**
+     * 
+     */
+    eventDate: string | null;
+    /**
+     * 
+     */
+    actual: boolean;
+    /**
+     * 
+     */
+    location: WidgetLocation | null;
+}
+
+/**
+ * Check if a given object implements the WidgetLeg interface.
+ */
+export function instanceOfWidgetLeg(value: object): value is WidgetLeg {
+    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 ((!('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 (!('actual' in value) || value['actual'] === undefined) return false;
+    if (!('location' in value) || value['location'] === undefined) return false;
+    return true;
+}
+
+export function WidgetLegFromJSON(json: any): WidgetLeg {
+    return WidgetLegFromJSONTyped(json, false);
+}
+
+export function WidgetLegFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetLeg {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'vesselName': json['vessel_name'],
+        'eventDate': json['event_date'],
+        'actual': json['actual'],
+        'location': WidgetLocationFromJSON(json['location']),
+    };
+}
+
+export function WidgetLegToJSON(json: any): WidgetLeg {
+    return WidgetLegToJSONTyped(json, false);
+}
+
+export function WidgetLegToJSONTyped(value?: WidgetLeg | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'vessel_name': value['vesselName'],
+        'event_date': value['eventDate'],
+        'actual': value['actual'],
+        'location': WidgetLocationToJSON(value['location']),
+    };
+}
+

package/src/models/WidgetLocation.ts

@@ -0,0 +1,107 @@
+/* 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 { WidgetPoint } from './WidgetPoint';
+import {
+    WidgetPointFromJSON,
+    WidgetPointFromJSONTyped,
+    WidgetPointToJSON,
+    WidgetPointToJSONTyped,
+} from './WidgetPoint';
+import type { WidgetCountry } from './WidgetCountry';
+import {
+    WidgetCountryFromJSON,
+    WidgetCountryFromJSONTyped,
+    WidgetCountryToJSON,
+    WidgetCountryToJSONTyped,
+} from './WidgetCountry';
+
+/**
+ * 
+ * @export
+ * @interface WidgetLocation
+ */
+export interface WidgetLocation {
+    /**
+     * 
+     */
+    name: string | null;
+    /**
+     * 
+     */
+    unlocode: string | null;
+    /**
+     * 
+     */
+    timezone: string | null;
+    /**
+     * 
+     */
+    country: WidgetCountry | null;
+    /**
+     * 
+     */
+    point: WidgetPoint | null;
+}
+
+/**
+ * Check if a given object implements the WidgetLocation interface.
+ */
+export function instanceOfWidgetLocation(value: object): value is WidgetLocation {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('unlocode' in value) || value['unlocode'] === undefined) return false;
+    if (!('timezone' in value) || value['timezone'] === undefined) return false;
+    if (!('country' in value) || value['country'] === undefined) return false;
+    if (!('point' in value) || value['point'] === undefined) return false;
+    return true;
+}
+
+export function WidgetLocationFromJSON(json: any): WidgetLocation {
+    return WidgetLocationFromJSONTyped(json, false);
+}
+
+export function WidgetLocationFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetLocation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'unlocode': json['unlocode'],
+        'timezone': json['timezone'],
+        'country': WidgetCountryFromJSON(json['country']),
+        'point': WidgetPointFromJSON(json['point']),
+    };
+}
+
+export function WidgetLocationToJSON(json: any): WidgetLocation {
+    return WidgetLocationToJSONTyped(json, false);
+}
+
+export function WidgetLocationToJSONTyped(value?: WidgetLocation | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'unlocode': value['unlocode'],
+        'timezone': value['timezone'],
+        'country': WidgetCountryToJSON(value['country']),
+        'point': WidgetPointToJSON(value['point']),
+    };
+}
+

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'],
+    };
+}
+