@dockflow/sdk 0.0.0-stage → 0.3.0

package/dist/esm/models/UpstreamRecordMetadata.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfUpstreamRecordMetadata(value: object): value is UpstreamRecordMetadata;
+export declare function UpstreamRecordMetadataFromJSON(json: any): UpstreamRecordMetadata;
+export declare function UpstreamRecordMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpstreamRecordMetadata;
+export declare function UpstreamRecordMetadataToJSON(json: any): UpstreamRecordMetadata;
+export declare function UpstreamRecordMetadataToJSONTyped(value?: UpstreamRecordMetadata | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpstreamRecordMetadata.js

@@ -0,0 +1,48 @@
+/* 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 { parseDateTime, serializeDateTime } from '../runtime';
+/**
+ * Check if a given object implements the UpstreamRecordMetadata interface.
+ */
+export function instanceOfUpstreamRecordMetadata(value) {
+    return true;
+}
+export function UpstreamRecordMetadataFromJSON(json) {
+    return UpstreamRecordMetadataFromJSONTyped(json, false);
+}
+export function UpstreamRecordMetadataFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return UpstreamRecordMetadataToJSONTyped(json, false);
+}
+export function UpstreamRecordMetadataToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/WidgetContainer.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 type { WidgetMilestone } 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 declare function instanceOfWidgetContainer(value: object): value is WidgetContainer;
+export declare function WidgetContainerFromJSON(json: any): WidgetContainer;
+export declare function WidgetContainerFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetContainer;
+export declare function WidgetContainerToJSON(json: any): WidgetContainer;
+export declare function WidgetContainerToJSONTyped(value?: WidgetContainer | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WidgetContainer.js

@@ -0,0 +1,60 @@
+/* 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 { WidgetMilestoneFromJSON, WidgetMilestoneToJSON, } from './WidgetMilestone';
+/**
+ * Check if a given object implements the WidgetContainer interface.
+ */
+export function instanceOfWidgetContainer(value) {
+    if (!('reference' in value) || value['reference'] === undefined)
+        return false;
+    if ((!('typeCode' in value) && !('type_code' in value)) || (value['typeCode'] === undefined && value['type_code'] === undefined))
+        return false;
+    if ((!('typeGroup' in value) && !('type_group' in value)) || (value['typeGroup'] === undefined && value['type_group'] === undefined))
+        return false;
+    if (!('length' in value) || value['length'] === undefined)
+        return false;
+    if ((!('latestActualMilestone' in value) && !('latest_actual_milestone' in value)) || (value['latestActualMilestone'] === undefined && value['latest_actual_milestone'] === undefined))
+        return false;
+    return true;
+}
+export function WidgetContainerFromJSON(json) {
+    return WidgetContainerFromJSONTyped(json, false);
+}
+export function WidgetContainerFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return WidgetContainerToJSONTyped(json, false);
+}
+export function WidgetContainerToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/WidgetCountry.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface WidgetCountry
+ */
+export interface WidgetCountry {
+    /**
+     *
+     */
+    name: string | null;
+    /**
+     *
+     */
+    isoA2: string | null;
+}
+/**
+ * Check if a given object implements the WidgetCountry interface.
+ */
+export declare function instanceOfWidgetCountry(value: object): value is WidgetCountry;
+export declare function WidgetCountryFromJSON(json: any): WidgetCountry;
+export declare function WidgetCountryFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetCountry;
+export declare function WidgetCountryToJSON(json: any): WidgetCountry;
+export declare function WidgetCountryToJSONTyped(value?: WidgetCountry | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WidgetCountry.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the WidgetCountry interface.
+ */
+export function instanceOfWidgetCountry(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if ((!('isoA2' in value) && !('iso_a2' in value)) || (value['isoA2'] === undefined && value['iso_a2'] === undefined))
+        return false;
+    return true;
+}
+export function WidgetCountryFromJSON(json) {
+    return WidgetCountryFromJSONTyped(json, false);
+}
+export function WidgetCountryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'isoA2': json['iso_a2'],
+    };
+}
+export function WidgetCountryToJSON(json) {
+    return WidgetCountryToJSONTyped(json, false);
+}
+export function WidgetCountryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'iso_a2': value['isoA2'],
+    };
+}

package/dist/esm/models/WidgetLeg.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 type { WidgetLocation } 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 declare function instanceOfWidgetLeg(value: object): value is WidgetLeg;
+export declare function WidgetLegFromJSON(json: any): WidgetLeg;
+export declare function WidgetLegFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetLeg;
+export declare function WidgetLegToJSON(json: any): WidgetLeg;
+export declare function WidgetLegToJSONTyped(value?: WidgetLeg | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WidgetLeg.js

@@ -0,0 +1,56 @@
+/* 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 { WidgetLocationFromJSON, WidgetLocationToJSON, } from './WidgetLocation';
+/**
+ * Check if a given object implements the WidgetLeg interface.
+ */
+export function instanceOfWidgetLeg(value) {
+    if ((!('vesselName' in value) && !('vessel_name' in value)) || (value['vesselName'] === undefined && value['vessel_name'] === undefined))
+        return false;
+    if ((!('eventDate' in value) && !('event_date' in value)) || (value['eventDate'] === undefined && value['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) {
+    return WidgetLegFromJSONTyped(json, false);
+}
+export function WidgetLegFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return WidgetLegToJSONTyped(json, false);
+}
+export function WidgetLegToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'vessel_name': value['vesselName'],
+        'event_date': value['eventDate'],
+        'actual': value['actual'],
+        'location': WidgetLocationToJSON(value['location']),
+    };
+}

package/dist/esm/models/WidgetLocation.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 type { WidgetPoint } from './WidgetPoint';
+import type { WidgetCountry } 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 declare function instanceOfWidgetLocation(value: object): value is WidgetLocation;
+export declare function WidgetLocationFromJSON(json: any): WidgetLocation;
+export declare function WidgetLocationFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetLocation;
+export declare function WidgetLocationToJSON(json: any): WidgetLocation;
+export declare function WidgetLocationToJSONTyped(value?: WidgetLocation | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WidgetLocation.js

@@ -0,0 +1,61 @@
+/* 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 { WidgetPointFromJSON, WidgetPointToJSON, } from './WidgetPoint';
+import { WidgetCountryFromJSON, WidgetCountryToJSON, } from './WidgetCountry';
+/**
+ * Check if a given object implements the WidgetLocation interface.
+ */
+export function instanceOfWidgetLocation(value) {
+    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) {
+    return WidgetLocationFromJSONTyped(json, false);
+}
+export function WidgetLocationFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return WidgetLocationToJSONTyped(json, false);
+}
+export function WidgetLocationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'unlocode': value['unlocode'],
+        'timezone': value['timezone'],
+        'country': WidgetCountryToJSON(value['country']),
+        'point': WidgetPointToJSON(value['point']),
+    };
+}

package/dist/esm/models/WidgetMilestone.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 type { WidgetLocation } 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 declare function instanceOfWidgetMilestone(value: object): value is WidgetMilestone;
+export declare function WidgetMilestoneFromJSON(json: any): WidgetMilestone;
+export declare function WidgetMilestoneFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetMilestone;
+export declare function WidgetMilestoneToJSON(json: any): WidgetMilestone;
+export declare function WidgetMilestoneToJSONTyped(value?: WidgetMilestone | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WidgetMilestone.js

@@ -0,0 +1,56 @@
+/* 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 { WidgetLocationFromJSON, WidgetLocationToJSON, } from './WidgetLocation';
+/**
+ * Check if a given object implements the WidgetMilestone interface.
+ */
+export function instanceOfWidgetMilestone(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if ((!('eventDate' in value) && !('event_date' in value)) || (value['eventDate'] === undefined && value['event_date'] === undefined))
+        return false;
+    if ((!('vesselName' in value) && !('vessel_name' in value)) || (value['vesselName'] === undefined && value['vessel_name'] === undefined))
+        return false;
+    if (!('location' in value) || value['location'] === undefined)
+        return false;
+    return true;
+}
+export function WidgetMilestoneFromJSON(json) {
+    return WidgetMilestoneFromJSONTyped(json, false);
+}
+export function WidgetMilestoneFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return WidgetMilestoneToJSONTyped(json, false);
+}
+export function WidgetMilestoneToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'event_date': value['eventDate'],
+        'vessel_name': value['vesselName'],
+        'location': WidgetLocationToJSON(value['location']),
+    };
+}

package/dist/esm/models/WidgetPoint.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface WidgetPoint
+ */
+export interface WidgetPoint {
+    /**
+     *
+     */
+    lat: number;
+    /**
+     *
+     */
+    lng: number;
+}
+/**
+ * Check if a given object implements the WidgetPoint interface.
+ */
+export declare function instanceOfWidgetPoint(value: object): value is WidgetPoint;
+export declare function WidgetPointFromJSON(json: any): WidgetPoint;
+export declare function WidgetPointFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetPoint;
+export declare function WidgetPointToJSON(json: any): WidgetPoint;
+export declare function WidgetPointToJSONTyped(value?: WidgetPoint | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WidgetPoint.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the WidgetPoint interface.
+ */
+export function instanceOfWidgetPoint(value) {
+    if (!('lat' in value) || value['lat'] === undefined)
+        return false;
+    if (!('lng' in value) || value['lng'] === undefined)
+        return false;
+    return true;
+}
+export function WidgetPointFromJSON(json) {
+    return WidgetPointFromJSONTyped(json, false);
+}
+export function WidgetPointFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'lat': json['lat'],
+        'lng': json['lng'],
+    };
+}
+export function WidgetPointToJSON(json) {
+    return WidgetPointToJSONTyped(json, false);
+}
+export function WidgetPointToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'lat': value['lat'],
+        'lng': value['lng'],
+    };
+}