@dockflow/sdk 0.0.0-stage → 0.3.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/GetDocument200Response.ts

@@ -0,0 +1,86 @@
+/* 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 { GetDocument200ResponseDataInner } from './GetDocument200ResponseDataInner';
+import {
+    GetDocument200ResponseDataInnerFromJSON,
+    GetDocument200ResponseDataInnerFromJSONTyped,
+    GetDocument200ResponseDataInnerToJSON,
+    GetDocument200ResponseDataInnerToJSONTyped,
+} from './GetDocument200ResponseDataInner';
+
+/**
+ * 
+ * @export
+ * @interface GetDocument200Response
+ */
+export interface GetDocument200Response {
+    /**
+     * 
+     */
+    data: Array<GetDocument200ResponseDataInner>;
+    /**
+     * 
+     */
+    tradeflowReference: string;
+    /**
+     * 
+     */
+    count: number;
+}
+
+/**
+ * Check if a given object implements the GetDocument200Response interface.
+ */
+export function instanceOfGetDocument200Response(value: object): value is GetDocument200Response {
+    if (!('data' in value) || value['data'] === 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 (!('count' in value) || value['count'] === undefined) return false;
+    return true;
+}
+
+export function GetDocument200ResponseFromJSON(json: any): GetDocument200Response {
+    return GetDocument200ResponseFromJSONTyped(json, false);
+}
+
+export function GetDocument200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetDocument200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(GetDocument200ResponseDataInnerFromJSON)),
+        'tradeflowReference': json['tradeflow_reference'],
+        'count': json['count'],
+    };
+}
+
+export function GetDocument200ResponseToJSON(json: any): GetDocument200Response {
+    return GetDocument200ResponseToJSONTyped(json, false);
+}
+
+export function GetDocument200ResponseToJSONTyped(value?: GetDocument200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(GetDocument200ResponseDataInnerToJSON)),
+        'tradeflow_reference': value['tradeflowReference'],
+        'count': value['count'],
+    };
+}
+

package/src/models/GetDocument200ResponseDataInner.ts

@@ -0,0 +1,128 @@
+/* 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 { GetDocument200ResponseDataInnerDocumentType } from './GetDocument200ResponseDataInnerDocumentType';
+import {
+    GetDocument200ResponseDataInnerDocumentTypeFromJSON,
+    GetDocument200ResponseDataInnerDocumentTypeFromJSONTyped,
+    GetDocument200ResponseDataInnerDocumentTypeToJSON,
+    GetDocument200ResponseDataInnerDocumentTypeToJSONTyped,
+} from './GetDocument200ResponseDataInnerDocumentType';
+
+/**
+ * 
+ * @export
+ * @interface GetDocument200ResponseDataInner
+ */
+export interface GetDocument200ResponseDataInner {
+    /**
+     * 
+     */
+    id: number;
+    /**
+     * 
+     */
+    name: string;
+    /**
+     * 
+     */
+    filetype: string;
+    /**
+     * 
+     */
+    inputName: string | null;
+    /**
+     * 
+     */
+    version: number;
+    /**
+     * 
+     */
+    documentType: GetDocument200ResponseDataInnerDocumentType | null;
+    /**
+     * 
+     */
+    metadata: object | null;
+    /**
+     * 
+     */
+    createdAt: string | null;
+    /**
+     * 
+     */
+    updatedAt: string | null;
+}
+
+/**
+ * Check if a given object implements the GetDocument200ResponseDataInner interface.
+ */
+export function instanceOfGetDocument200ResponseDataInner(value: object): value is GetDocument200ResponseDataInner {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('filetype' in value) || value['filetype'] === undefined) return false;
+    if ((!('inputName' in (value as Record<string, any>)) && !('input_name' in (value as Record<string, any>))) || ((value as Record<string, any>)['inputName'] === undefined && (value as Record<string, any>)['input_name'] === undefined)) return false;
+    if (!('version' in value) || value['version'] === undefined) return false;
+    if ((!('documentType' in (value as Record<string, any>)) && !('document_type' in (value as Record<string, any>))) || ((value as Record<string, any>)['documentType'] === undefined && (value as Record<string, any>)['document_type'] === undefined)) return false;
+    if (!('metadata' in value) || value['metadata'] === undefined) return false;
+    if ((!('createdAt' in (value as Record<string, any>)) && !('created_at' in (value as Record<string, any>))) || ((value as Record<string, any>)['createdAt'] === undefined && (value as Record<string, any>)['created_at'] === undefined)) return false;
+    if ((!('updatedAt' in (value as Record<string, any>)) && !('updated_at' in (value as Record<string, any>))) || ((value as Record<string, any>)['updatedAt'] === undefined && (value as Record<string, any>)['updated_at'] === undefined)) return false;
+    return true;
+}
+
+export function GetDocument200ResponseDataInnerFromJSON(json: any): GetDocument200ResponseDataInner {
+    return GetDocument200ResponseDataInnerFromJSONTyped(json, false);
+}
+
+export function GetDocument200ResponseDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetDocument200ResponseDataInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'filetype': json['filetype'],
+        'inputName': json['input_name'],
+        'version': json['version'],
+        'documentType': GetDocument200ResponseDataInnerDocumentTypeFromJSON(json['document_type']),
+        'metadata': json['metadata'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function GetDocument200ResponseDataInnerToJSON(json: any): GetDocument200ResponseDataInner {
+    return GetDocument200ResponseDataInnerToJSONTyped(json, false);
+}
+
+export function GetDocument200ResponseDataInnerToJSONTyped(value?: GetDocument200ResponseDataInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'filetype': value['filetype'],
+        'input_name': value['inputName'],
+        'version': value['version'],
+        'document_type': GetDocument200ResponseDataInnerDocumentTypeToJSON(value['documentType']),
+        'metadata': value['metadata'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/GetDocument200ResponseDataInnerDocumentType.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 GetDocument200ResponseDataInnerDocumentType
+ */
+export interface GetDocument200ResponseDataInnerDocumentType {
+    /**
+     * 
+     */
+    name: string;
+    /**
+     * 
+     */
+    description: string;
+}
+
+/**
+ * Check if a given object implements the GetDocument200ResponseDataInnerDocumentType interface.
+ */
+export function instanceOfGetDocument200ResponseDataInnerDocumentType(value: object): value is GetDocument200ResponseDataInnerDocumentType {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function GetDocument200ResponseDataInnerDocumentTypeFromJSON(json: any): GetDocument200ResponseDataInnerDocumentType {
+    return GetDocument200ResponseDataInnerDocumentTypeFromJSONTyped(json, false);
+}
+
+export function GetDocument200ResponseDataInnerDocumentTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetDocument200ResponseDataInnerDocumentType {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'],
+    };
+}
+
+export function GetDocument200ResponseDataInnerDocumentTypeToJSON(json: any): GetDocument200ResponseDataInnerDocumentType {
+    return GetDocument200ResponseDataInnerDocumentTypeToJSONTyped(json, false);
+}
+
+export function GetDocument200ResponseDataInnerDocumentTypeToJSONTyped(value?: GetDocument200ResponseDataInnerDocumentType | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+    };
+}
+

package/src/models/GetUpstream200Response.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 GetUpstream200Response
+ */
+export interface GetUpstream200Response {
+    /**
+     * 
+     */
+    data: Array<UpstreamRecord>;
+    /**
+     * 
+     */
+    nextCursor: string | null;
+}
+
+/**
+ * Check if a given object implements the GetUpstream200Response interface.
+ */
+export function instanceOfGetUpstream200Response(value: object): value is GetUpstream200Response {
+    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 GetUpstream200ResponseFromJSON(json: any): GetUpstream200Response {
+    return GetUpstream200ResponseFromJSONTyped(json, false);
+}
+
+export function GetUpstream200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUpstream200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(UpstreamRecordFromJSON)),
+        'nextCursor': json['next_cursor'],
+    };
+}
+
+export function GetUpstream200ResponseToJSON(json: any): GetUpstream200Response {
+    return GetUpstream200ResponseToJSONTyped(json, false);
+}
+
+export function GetUpstream200ResponseToJSONTyped(value?: GetUpstream200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(UpstreamRecordToJSON)),
+        'next_cursor': value['nextCursor'],
+    };
+}
+