@dockflow/sdk 0.0.0-stage → 0.2.0

package/src/models/V3DownstreamPost202Response.ts

@@ -0,0 +1,91 @@
+/* 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 { V3DownstreamPost202ResponseTradeflowsInner } from './V3DownstreamPost202ResponseTradeflowsInner';
+import {
+    V3DownstreamPost202ResponseTradeflowsInnerFromJSON,
+    V3DownstreamPost202ResponseTradeflowsInnerFromJSONTyped,
+    V3DownstreamPost202ResponseTradeflowsInnerToJSON,
+    V3DownstreamPost202ResponseTradeflowsInnerToJSONTyped,
+} from './V3DownstreamPost202ResponseTradeflowsInner';
+
+/**
+ * 
+ * @export
+ * @interface V3DownstreamPost202Response
+ */
+export interface V3DownstreamPost202Response {
+    /**
+     * 
+     */
+    status: V3DownstreamPost202ResponseStatusEnum;
+    /**
+     * 
+     */
+    tradeflows: Array<V3DownstreamPost202ResponseTradeflowsInner>;
+}
+
+
+/**
+ * @export
+ */
+export const V3DownstreamPost202ResponseStatusEnum = {
+    Queued: 'queued',
+} as const;
+export type V3DownstreamPost202ResponseStatusEnum = typeof V3DownstreamPost202ResponseStatusEnum[keyof typeof V3DownstreamPost202ResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the V3DownstreamPost202Response interface.
+ */
+export function instanceOfV3DownstreamPost202Response(value: object): value is V3DownstreamPost202Response {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (value['status'] !== 'queued') return false;
+    
+    if (!('tradeflows' in value) || value['tradeflows'] === undefined) return false;
+    return true;
+}
+
+export function V3DownstreamPost202ResponseFromJSON(json: any): V3DownstreamPost202Response {
+    return V3DownstreamPost202ResponseFromJSONTyped(json, false);
+}
+
+export function V3DownstreamPost202ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3DownstreamPost202Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'tradeflows': ((json['tradeflows'] as Array<any>).map(V3DownstreamPost202ResponseTradeflowsInnerFromJSON)),
+    };
+}
+
+export function V3DownstreamPost202ResponseToJSON(json: any): V3DownstreamPost202Response {
+    return V3DownstreamPost202ResponseToJSONTyped(json, false);
+}
+
+export function V3DownstreamPost202ResponseToJSONTyped(value?: V3DownstreamPost202Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'tradeflows': ((value['tradeflows'] as Array<any>).map(V3DownstreamPost202ResponseTradeflowsInnerToJSON)),
+    };
+}
+

package/src/models/V3DownstreamPost202ResponseTradeflowsInner.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 V3DownstreamPost202ResponseTradeflowsInner
+ */
+export interface V3DownstreamPost202ResponseTradeflowsInner {
+    /**
+     * 
+     */
+    tradeflowReference: string;
+    /**
+     * 
+     */
+    warnings: Array<string>;
+}
+
+/**
+ * Check if a given object implements the V3DownstreamPost202ResponseTradeflowsInner interface.
+ */
+export function instanceOfV3DownstreamPost202ResponseTradeflowsInner(value: object): value is V3DownstreamPost202ResponseTradeflowsInner {
+    if ((!('tradeflowReference' in (value as Record<string, any>)) && !('tradeflow_reference' in (value as Record<string, any>))) || ((value as Record<string, any>)['tradeflowReference'] === undefined && (value as Record<string, any>)['tradeflow_reference'] === undefined)) return false;
+    if (!('warnings' in value) || value['warnings'] === undefined) return false;
+    return true;
+}
+
+export function V3DownstreamPost202ResponseTradeflowsInnerFromJSON(json: any): V3DownstreamPost202ResponseTradeflowsInner {
+    return V3DownstreamPost202ResponseTradeflowsInnerFromJSONTyped(json, false);
+}
+
+export function V3DownstreamPost202ResponseTradeflowsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3DownstreamPost202ResponseTradeflowsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tradeflowReference': json['tradeflow_reference'],
+        'warnings': json['warnings'],
+    };
+}
+
+export function V3DownstreamPost202ResponseTradeflowsInnerToJSON(json: any): V3DownstreamPost202ResponseTradeflowsInner {
+    return V3DownstreamPost202ResponseTradeflowsInnerToJSONTyped(json, false);
+}
+
+export function V3DownstreamPost202ResponseTradeflowsInnerToJSONTyped(value?: V3DownstreamPost202ResponseTradeflowsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tradeflow_reference': value['tradeflowReference'],
+        'warnings': value['warnings'],
+    };
+}
+

package/src/models/V3UpstreamGet200Response.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 { UpstreamRecord } from './UpstreamRecord';
+import {
+    UpstreamRecordFromJSON,
+    UpstreamRecordFromJSONTyped,
+    UpstreamRecordToJSON,
+    UpstreamRecordToJSONTyped,
+} from './UpstreamRecord';
+
+/**
+ * 
+ * @export
+ * @interface V3UpstreamGet200Response
+ */
+export interface V3UpstreamGet200Response {
+    /**
+     * 
+     */
+    data: Array<UpstreamRecord>;
+    /**
+     * 
+     */
+    nextCursor: string | null;
+}
+
+/**
+ * Check if a given object implements the V3UpstreamGet200Response interface.
+ */
+export function instanceOfV3UpstreamGet200Response(value: object): value is V3UpstreamGet200Response {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if ((!('nextCursor' in (value as Record<string, any>)) && !('next_cursor' in (value as Record<string, any>))) || ((value as Record<string, any>)['nextCursor'] === undefined && (value as Record<string, any>)['next_cursor'] === undefined)) return false;
+    return true;
+}
+
+export function V3UpstreamGet200ResponseFromJSON(json: any): V3UpstreamGet200Response {
+    return V3UpstreamGet200ResponseFromJSONTyped(json, false);
+}
+
+export function V3UpstreamGet200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3UpstreamGet200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(UpstreamRecordFromJSON)),
+        'nextCursor': json['next_cursor'],
+    };
+}
+
+export function V3UpstreamGet200ResponseToJSON(json: any): V3UpstreamGet200Response {
+    return V3UpstreamGet200ResponseToJSONTyped(json, false);
+}
+
+export function V3UpstreamGet200ResponseToJSONTyped(value?: V3UpstreamGet200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(UpstreamRecordToJSON)),
+        'next_cursor': value['nextCursor'],
+    };
+}
+

package/src/models/V3UpstreamGet400Response.ts

@@ -0,0 +1,46 @@
+/* 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 V3UpstreamGet400Response
+ */
+export interface V3UpstreamGet400Response {
+}
+
+/**
+ * Check if a given object implements the V3UpstreamGet400Response interface.
+ */
+export function instanceOfV3UpstreamGet400Response(value: object): value is V3UpstreamGet400Response {
+    return true;
+}
+
+export function V3UpstreamGet400ResponseFromJSON(json: any): V3UpstreamGet400Response {
+    return V3UpstreamGet400ResponseFromJSONTyped(json, false);
+}
+
+export function V3UpstreamGet400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3UpstreamGet400Response {
+    return json;
+}
+
+export function V3UpstreamGet400ResponseToJSON(json: any): V3UpstreamGet400Response {
+    return V3UpstreamGet400ResponseToJSONTyped(json, false);
+}
+
+export function V3UpstreamGet400ResponseToJSONTyped(value?: V3UpstreamGet400Response | null, ignoreDiscriminator: boolean = false): any {
+    return value;
+}
+

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