@dockflow/sdk 0.0.0-stage → 0.2.0

package/src/models/DownstreamTradeflowFreeTimeOverridesInner.ts

@@ -0,0 +1,96 @@
+/* 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 DownstreamTradeflowFreeTimeOverridesInner
+ */
+export interface DownstreamTradeflowFreeTimeOverridesInner {
+    /**
+     * 
+     */
+    dwellType: DownstreamTradeflowFreeTimeOverridesInnerDwellTypeEnum;
+    /**
+     * Required unless cancelled is true.
+     */
+    freeDays?: number;
+    /**
+     * Scopes the override to one container. Absent means tradeflow-wide.
+     */
+    containerReference?: string;
+    /**
+     * 
+     */
+    cancelled?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const DownstreamTradeflowFreeTimeOverridesInnerDwellTypeEnum = {
+    EquipmentFreeTimeInPort: 'equipment_free_time_in_port',
+    EquipmentFreeTimeOutOfPort: 'equipment_free_time_out_of_port',
+    EquipmentFreeTimeCombined: 'equipment_free_time_combined',
+    StorageFreeTime: 'storage_free_time',
+    ElectricityFreeTime: 'electricity_free_time',
+} as const;
+export type DownstreamTradeflowFreeTimeOverridesInnerDwellTypeEnum = typeof DownstreamTradeflowFreeTimeOverridesInnerDwellTypeEnum[keyof typeof DownstreamTradeflowFreeTimeOverridesInnerDwellTypeEnum];
+
+
+/**
+ * Check if a given object implements the DownstreamTradeflowFreeTimeOverridesInner interface.
+ */
+export function instanceOfDownstreamTradeflowFreeTimeOverridesInner(value: object): value is DownstreamTradeflowFreeTimeOverridesInner {
+    if ((!('dwellType' in (value as Record<string, any>)) && !('dwell_type' in (value as Record<string, any>))) || ((value as Record<string, any>)['dwellType'] === undefined && (value as Record<string, any>)['dwell_type'] === undefined)) return false;
+    return true;
+}
+
+export function DownstreamTradeflowFreeTimeOverridesInnerFromJSON(json: any): DownstreamTradeflowFreeTimeOverridesInner {
+    return DownstreamTradeflowFreeTimeOverridesInnerFromJSONTyped(json, false);
+}
+
+export function DownstreamTradeflowFreeTimeOverridesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): DownstreamTradeflowFreeTimeOverridesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'dwellType': json['dwell_type'],
+        'freeDays': json['free_days'] == null ? undefined : json['free_days'],
+        'containerReference': json['container_reference'] == null ? undefined : json['container_reference'],
+        'cancelled': json['cancelled'] == null ? undefined : json['cancelled'],
+    };
+}
+
+export function DownstreamTradeflowFreeTimeOverridesInnerToJSON(json: any): DownstreamTradeflowFreeTimeOverridesInner {
+    return DownstreamTradeflowFreeTimeOverridesInnerToJSONTyped(json, false);
+}
+
+export function DownstreamTradeflowFreeTimeOverridesInnerToJSONTyped(value?: DownstreamTradeflowFreeTimeOverridesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'dwell_type': value['dwellType'],
+        'free_days': value['freeDays'],
+        'container_reference': value['containerReference'],
+        'cancelled': value['cancelled'],
+    };
+}
+

package/src/models/DownstreamTradeflowMockTracking.ts

@@ -0,0 +1,63 @@
+/* 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';
+/**
+ * UAT only: generates a synthetic journey. Ignored in production.
+ * @export
+ * @interface DownstreamTradeflowMockTracking
+ */
+export interface DownstreamTradeflowMockTracking {
+    /**
+     * 
+     */
+    scenario?: string;
+}
+
+/**
+ * Check if a given object implements the DownstreamTradeflowMockTracking interface.
+ */
+export function instanceOfDownstreamTradeflowMockTracking(value: object): value is DownstreamTradeflowMockTracking {
+    return true;
+}
+
+export function DownstreamTradeflowMockTrackingFromJSON(json: any): DownstreamTradeflowMockTracking {
+    return DownstreamTradeflowMockTrackingFromJSONTyped(json, false);
+}
+
+export function DownstreamTradeflowMockTrackingFromJSONTyped(json: any, ignoreDiscriminator: boolean): DownstreamTradeflowMockTracking {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scenario': json['scenario'] == null ? undefined : json['scenario'],
+    };
+}
+
+export function DownstreamTradeflowMockTrackingToJSON(json: any): DownstreamTradeflowMockTracking {
+    return DownstreamTradeflowMockTrackingToJSONTyped(json, false);
+}
+
+export function DownstreamTradeflowMockTrackingToJSONTyped(value?: DownstreamTradeflowMockTracking | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scenario': value['scenario'],
+    };
+}
+

package/src/models/DownstreamTradeflowPartnersInner.ts

@@ -0,0 +1,82 @@
+/* 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 DownstreamTradeflowPartnersInner
+ */
+export interface DownstreamTradeflowPartnersInner {
+    /**
+     * 
+     */
+    name: string;
+    /**
+     * 
+     */
+    role?: string;
+    /**
+     * The partner's own reference for this tradeflow.
+     */
+    reference?: string;
+    /**
+     * Email or full name of an existing user at the partner.
+     */
+    leadContact?: string;
+}
+
+/**
+ * Check if a given object implements the DownstreamTradeflowPartnersInner interface.
+ */
+export function instanceOfDownstreamTradeflowPartnersInner(value: object): value is DownstreamTradeflowPartnersInner {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function DownstreamTradeflowPartnersInnerFromJSON(json: any): DownstreamTradeflowPartnersInner {
+    return DownstreamTradeflowPartnersInnerFromJSONTyped(json, false);
+}
+
+export function DownstreamTradeflowPartnersInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): DownstreamTradeflowPartnersInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'role': json['role'] == null ? undefined : json['role'],
+        'reference': json['reference'] == null ? undefined : json['reference'],
+        'leadContact': json['lead_contact'] == null ? undefined : json['lead_contact'],
+    };
+}
+
+export function DownstreamTradeflowPartnersInnerToJSON(json: any): DownstreamTradeflowPartnersInner {
+    return DownstreamTradeflowPartnersInnerToJSONTyped(json, false);
+}
+
+export function DownstreamTradeflowPartnersInnerToJSONTyped(value?: DownstreamTradeflowPartnersInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'role': value['role'],
+        'reference': value['reference'],
+        'lead_contact': value['leadContact'],
+    };
+}
+

package/src/models/DownstreamTradeflowReferences.ts

@@ -0,0 +1,75 @@
+/* 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 DownstreamTradeflowReferences
+ */
+export interface DownstreamTradeflowReferences {
+    /**
+     * 
+     */
+    houseBillOfLading?: string;
+    /**
+     * 
+     */
+    deliveryLocation?: string;
+    /**
+     * 
+     */
+    deliveryEventDate?: string;
+}
+
+/**
+ * Check if a given object implements the DownstreamTradeflowReferences interface.
+ */
+export function instanceOfDownstreamTradeflowReferences(value: object): value is DownstreamTradeflowReferences {
+    return true;
+}
+
+export function DownstreamTradeflowReferencesFromJSON(json: any): DownstreamTradeflowReferences {
+    return DownstreamTradeflowReferencesFromJSONTyped(json, false);
+}
+
+export function DownstreamTradeflowReferencesFromJSONTyped(json: any, ignoreDiscriminator: boolean): DownstreamTradeflowReferences {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'houseBillOfLading': json['house_bill_of_lading'] == null ? undefined : json['house_bill_of_lading'],
+        'deliveryLocation': json['delivery_location'] == null ? undefined : json['delivery_location'],
+        'deliveryEventDate': json['delivery_event_date'] == null ? undefined : json['delivery_event_date'],
+    };
+}
+
+export function DownstreamTradeflowReferencesToJSON(json: any): DownstreamTradeflowReferences {
+    return DownstreamTradeflowReferencesToJSONTyped(json, false);
+}
+
+export function DownstreamTradeflowReferencesToJSONTyped(value?: DownstreamTradeflowReferences | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'house_bill_of_lading': value['houseBillOfLading'],
+        'delivery_location': value['deliveryLocation'],
+        'delivery_event_date': value['deliveryEventDate'],
+    };
+}
+

package/src/models/InlineObject.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 InlineObject
+ */
+export interface InlineObject {
+    /**
+     * Errors overview.
+     */
+    message: string;
+    /**
+     * A detailed description of each field that failed validation.
+     */
+    errors: { [key: string]: Array<string>; };
+}
+
+/**
+ * Check if a given object implements the InlineObject interface.
+ */
+export function instanceOfInlineObject(value: object): value is InlineObject {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('errors' in value) || value['errors'] === undefined) return false;
+    return true;
+}
+
+export function InlineObjectFromJSON(json: any): InlineObject {
+    return InlineObjectFromJSONTyped(json, false);
+}
+
+export function InlineObjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): InlineObject {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'errors': json['errors'],
+    };
+}
+
+export function InlineObjectToJSON(json: any): InlineObject {
+    return InlineObjectToJSONTyped(json, false);
+}
+
+export function InlineObjectToJSONTyped(value?: InlineObject | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'errors': value['errors'],
+    };
+}
+

package/src/models/ListDocumentTypes200ResponseInner.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 ListDocumentTypes200ResponseInner
+ */
+export interface ListDocumentTypes200ResponseInner {
+    /**
+     * 
+     */
+    type: string;
+    /**
+     * 
+     */
+    description: string;
+}
+
+/**
+ * Check if a given object implements the ListDocumentTypes200ResponseInner interface.
+ */
+export function instanceOfListDocumentTypes200ResponseInner(value: object): value is ListDocumentTypes200ResponseInner {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function ListDocumentTypes200ResponseInnerFromJSON(json: any): ListDocumentTypes200ResponseInner {
+    return ListDocumentTypes200ResponseInnerFromJSONTyped(json, false);
+}
+
+export function ListDocumentTypes200ResponseInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListDocumentTypes200ResponseInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'description': json['description'],
+    };
+}
+
+export function ListDocumentTypes200ResponseInnerToJSON(json: any): ListDocumentTypes200ResponseInner {
+    return ListDocumentTypes200ResponseInnerToJSONTyped(json, false);
+}
+
+export function ListDocumentTypes200ResponseInnerToJSONTyped(value?: ListDocumentTypes200ResponseInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'description': value['description'],
+    };
+}
+

package/src/models/UpstreamRecord.ts

@@ -0,0 +1,158 @@
+/* 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 { UpstreamRecordAdditionalReferences } from './UpstreamRecordAdditionalReferences';
+import {
+    UpstreamRecordAdditionalReferencesFromJSON,
+    UpstreamRecordAdditionalReferencesFromJSONTyped,
+    UpstreamRecordAdditionalReferencesToJSON,
+    UpstreamRecordAdditionalReferencesToJSONTyped,
+} from './UpstreamRecordAdditionalReferences';
+import type { UpstreamRecordDataQuality } from './UpstreamRecordDataQuality';
+import {
+    UpstreamRecordDataQualityFromJSON,
+    UpstreamRecordDataQualityFromJSONTyped,
+    UpstreamRecordDataQualityToJSON,
+    UpstreamRecordDataQualityToJSONTyped,
+} from './UpstreamRecordDataQuality';
+import type { UpstreamRecordMetadata } from './UpstreamRecordMetadata';
+import {
+    UpstreamRecordMetadataFromJSON,
+    UpstreamRecordMetadataFromJSONTyped,
+    UpstreamRecordMetadataToJSON,
+    UpstreamRecordMetadataToJSONTyped,
+} from './UpstreamRecordMetadata';
+
+/**
+ * One record per shipment of a tradeflow. The locations, containers, vessels, shipment and events blocks are present when requested with fields.
+ * @export
+ * @interface UpstreamRecord
+ */
+export interface UpstreamRecord {
+    /**
+     * 
+     */
+    version: string;
+    /**
+     * 
+     */
+    tradeflowReference: string;
+    /**
+     * 
+     */
+    billOfLading: string | null;
+    /**
+     * 
+     */
+    booking: string | null;
+    /**
+     * 
+     */
+    additionalReferences: UpstreamRecordAdditionalReferences;
+    /**
+     * 
+     */
+    dataQuality: UpstreamRecordDataQuality;
+    /**
+     * 
+     */
+    metadata: UpstreamRecordMetadata;
+    /**
+     * 
+     */
+    locations?: Array<object>;
+    /**
+     * 
+     */
+    containers?: Array<object>;
+    /**
+     * 
+     */
+    vessels?: Array<object>;
+    /**
+     * 
+     */
+    shipment?: object;
+    /**
+     * 
+     */
+    events?: Array<object>;
+}
+
+/**
+ * Check if a given object implements the UpstreamRecord interface.
+ */
+export function instanceOfUpstreamRecord(value: object): value is UpstreamRecord {
+    if (!('version' in value) || value['version'] === undefined) return false;
+    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 ((!('billOfLading' in (value as Record<string, any>)) && !('bill_of_lading' in (value as Record<string, any>))) || ((value as Record<string, any>)['billOfLading'] === undefined && (value as Record<string, any>)['bill_of_lading'] === undefined)) return false;
+    if (!('booking' in value) || value['booking'] === undefined) return false;
+    if ((!('additionalReferences' in (value as Record<string, any>)) && !('additional_references' in (value as Record<string, any>))) || ((value as Record<string, any>)['additionalReferences'] === undefined && (value as Record<string, any>)['additional_references'] === undefined)) return false;
+    if ((!('dataQuality' in (value as Record<string, any>)) && !('data_quality' in (value as Record<string, any>))) || ((value as Record<string, any>)['dataQuality'] === undefined && (value as Record<string, any>)['data_quality'] === undefined)) return false;
+    if (!('metadata' in value) || value['metadata'] === undefined) return false;
+    return true;
+}
+
+export function UpstreamRecordFromJSON(json: any): UpstreamRecord {
+    return UpstreamRecordFromJSONTyped(json, false);
+}
+
+export function UpstreamRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpstreamRecord {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'version': json['version'],
+        'tradeflowReference': json['tradeflow_reference'],
+        'billOfLading': json['bill_of_lading'],
+        'booking': json['booking'],
+        'additionalReferences': UpstreamRecordAdditionalReferencesFromJSON(json['additional_references']),
+        'dataQuality': UpstreamRecordDataQualityFromJSON(json['data_quality']),
+        'metadata': UpstreamRecordMetadataFromJSON(json['metadata']),
+        'locations': json['locations'] == null ? undefined : json['locations'],
+        'containers': json['containers'] == null ? undefined : json['containers'],
+        'vessels': json['vessels'] == null ? undefined : json['vessels'],
+        'shipment': json['shipment'] == null ? undefined : json['shipment'],
+        'events': json['events'] == null ? undefined : json['events'],
+    };
+}
+
+export function UpstreamRecordToJSON(json: any): UpstreamRecord {
+    return UpstreamRecordToJSONTyped(json, false);
+}
+
+export function UpstreamRecordToJSONTyped(value?: UpstreamRecord | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'version': value['version'],
+        'tradeflow_reference': value['tradeflowReference'],
+        'bill_of_lading': value['billOfLading'],
+        'booking': value['booking'],
+        'additional_references': UpstreamRecordAdditionalReferencesToJSON(value['additionalReferences']),
+        'data_quality': UpstreamRecordDataQualityToJSON(value['dataQuality']),
+        'metadata': UpstreamRecordMetadataToJSON(value['metadata']),
+        'locations': value['locations'],
+        'containers': value['containers'],
+        'vessels': value['vessels'],
+        'shipment': value['shipment'],
+        'events': value['events'],
+    };
+}
+

package/src/models/UpstreamRecordAdditionalReferences.ts

@@ -0,0 +1,69 @@
+/* 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 UpstreamRecordAdditionalReferences
+ */
+export interface UpstreamRecordAdditionalReferences {
+    /**
+     * 
+     */
+    billOfLading?: Array<string>;
+    /**
+     * 
+     */
+    booking?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the UpstreamRecordAdditionalReferences interface.
+ */
+export function instanceOfUpstreamRecordAdditionalReferences(value: object): value is UpstreamRecordAdditionalReferences {
+    return true;
+}
+
+export function UpstreamRecordAdditionalReferencesFromJSON(json: any): UpstreamRecordAdditionalReferences {
+    return UpstreamRecordAdditionalReferencesFromJSONTyped(json, false);
+}
+
+export function UpstreamRecordAdditionalReferencesFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpstreamRecordAdditionalReferences {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'billOfLading': json['bill_of_lading'] == null ? undefined : json['bill_of_lading'],
+        'booking': json['booking'] == null ? undefined : json['booking'],
+    };
+}
+
+export function UpstreamRecordAdditionalReferencesToJSON(json: any): UpstreamRecordAdditionalReferences {
+    return UpstreamRecordAdditionalReferencesToJSONTyped(json, false);
+}
+
+export function UpstreamRecordAdditionalReferencesToJSONTyped(value?: UpstreamRecordAdditionalReferences | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'bill_of_lading': value['billOfLading'],
+        'booking': value['booking'],
+    };
+}
+