@dockflow/sdk 0.0.0-stage → 0.3.0

package/dist/esm/models/InlineObject.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 InlineObject interface.
+ */
+export function instanceOfInlineObject(value) {
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    if (!('errors' in value) || value['errors'] === undefined)
+        return false;
+    return true;
+}
+export function InlineObjectFromJSON(json) {
+    return InlineObjectFromJSONTyped(json, false);
+}
+export function InlineObjectFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'message': json['message'],
+        'errors': json['errors'],
+    };
+}
+export function InlineObjectToJSON(json) {
+    return InlineObjectToJSONTyped(json, false);
+}
+export function InlineObjectToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'message': value['message'],
+        'errors': value['errors'],
+    };
+}

package/dist/esm/models/ListDocumentTypes200ResponseInner.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 ListDocumentTypes200ResponseInner
+ */
+export interface ListDocumentTypes200ResponseInner {
+    /**
+     *
+     */
+    type: string;
+    /**
+     *
+     */
+    description: string;
+}
+/**
+ * Check if a given object implements the ListDocumentTypes200ResponseInner interface.
+ */
+export declare function instanceOfListDocumentTypes200ResponseInner(value: object): value is ListDocumentTypes200ResponseInner;
+export declare function ListDocumentTypes200ResponseInnerFromJSON(json: any): ListDocumentTypes200ResponseInner;
+export declare function ListDocumentTypes200ResponseInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListDocumentTypes200ResponseInner;
+export declare function ListDocumentTypes200ResponseInnerToJSON(json: any): ListDocumentTypes200ResponseInner;
+export declare function ListDocumentTypes200ResponseInnerToJSONTyped(value?: ListDocumentTypes200ResponseInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ListDocumentTypes200ResponseInner.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 ListDocumentTypes200ResponseInner interface.
+ */
+export function instanceOfListDocumentTypes200ResponseInner(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    return true;
+}
+export function ListDocumentTypes200ResponseInnerFromJSON(json) {
+    return ListDocumentTypes200ResponseInnerFromJSONTyped(json, false);
+}
+export function ListDocumentTypes200ResponseInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+        'description': json['description'],
+    };
+}
+export function ListDocumentTypes200ResponseInnerToJSON(json) {
+    return ListDocumentTypes200ResponseInnerToJSONTyped(json, false);
+}
+export function ListDocumentTypes200ResponseInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 UploadDocument202Response
+ */
+export interface UploadDocument202Response {
+    /**
+     *
+     */
+    id: number;
+    /**
+     *
+     */
+    tradeflowReference: string | null;
+    /**
+     *
+     */
+    documentType: string | null;
+    /**
+     *
+     */
+    filename: string;
+    /**
+     *
+     */
+    filetype: string;
+    /**
+     *
+     */
+    containerReference: string | null;
+    /**
+     *
+     */
+    createdAt: string | null;
+}
+/**
+ * Check if a given object implements the UploadDocument202Response interface.
+ */
+export declare function instanceOfUploadDocument202Response(value: object): value is UploadDocument202Response;
+export declare function UploadDocument202ResponseFromJSON(json: any): UploadDocument202Response;
+export declare function UploadDocument202ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadDocument202Response;
+export declare function UploadDocument202ResponseToJSON(json: any): UploadDocument202Response;
+export declare function UploadDocument202ResponseToJSONTyped(value?: UploadDocument202Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UploadDocument202Response.js

@@ -0,0 +1,67 @@
+/* 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 UploadDocument202Response interface.
+ */
+export function instanceOfUploadDocument202Response(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if ((!('tradeflowReference' in value) && !('tradeflow_reference' in value)) || (value['tradeflowReference'] === undefined && value['tradeflow_reference'] === undefined))
+        return false;
+    if ((!('documentType' in value) && !('document_type' in value)) || (value['documentType'] === undefined && value['document_type'] === undefined))
+        return false;
+    if (!('filename' in value) || value['filename'] === undefined)
+        return false;
+    if (!('filetype' in value) || value['filetype'] === undefined)
+        return false;
+    if ((!('containerReference' in value) && !('container_reference' in value)) || (value['containerReference'] === undefined && value['container_reference'] === undefined))
+        return false;
+    if ((!('createdAt' in value) && !('created_at' in value)) || (value['createdAt'] === undefined && value['created_at'] === undefined))
+        return false;
+    return true;
+}
+export function UploadDocument202ResponseFromJSON(json) {
+    return UploadDocument202ResponseFromJSONTyped(json, false);
+}
+export function UploadDocument202ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'tradeflowReference': json['tradeflow_reference'],
+        'documentType': json['document_type'],
+        'filename': json['filename'],
+        'filetype': json['filetype'],
+        'containerReference': json['container_reference'],
+        'createdAt': json['created_at'],
+    };
+}
+export function UploadDocument202ResponseToJSON(json) {
+    return UploadDocument202ResponseToJSONTyped(json, false);
+}
+export function UploadDocument202ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'tradeflow_reference': value['tradeflowReference'],
+        'document_type': value['documentType'],
+        'filename': value['filename'],
+        'filetype': value['filetype'],
+        'container_reference': value['containerReference'],
+        'created_at': value['createdAt'],
+    };
+}

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

@@ -0,0 +1,26 @@
+/**
+ * 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 UploadDocument400Response
+ */
+export interface UploadDocument400Response {
+}
+/**
+ * Check if a given object implements the UploadDocument400Response interface.
+ */
+export declare function instanceOfUploadDocument400Response(value: object): value is UploadDocument400Response;
+export declare function UploadDocument400ResponseFromJSON(json: any): UploadDocument400Response;
+export declare function UploadDocument400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadDocument400Response;
+export declare function UploadDocument400ResponseToJSON(json: any): UploadDocument400Response;
+export declare function UploadDocument400ResponseToJSONTyped(value?: UploadDocument400Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UploadDocument400Response.js

@@ -0,0 +1,31 @@
+/* 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 UploadDocument400Response interface.
+ */
+export function instanceOfUploadDocument400Response(value) {
+    return true;
+}
+export function UploadDocument400ResponseFromJSON(json) {
+    return UploadDocument400ResponseFromJSONTyped(json, false);
+}
+export function UploadDocument400ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function UploadDocument400ResponseToJSON(json) {
+    return UploadDocument400ResponseToJSONTyped(json, false);
+}
+export function UploadDocument400ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    return value;
+}

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

@@ -0,0 +1,77 @@
+/**
+ * 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 { UpstreamRecordAdditionalReferences } from './UpstreamRecordAdditionalReferences';
+import type { UpstreamRecordDataQuality } from './UpstreamRecordDataQuality';
+import type { UpstreamRecordMetadata } 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 declare function instanceOfUpstreamRecord(value: object): value is UpstreamRecord;
+export declare function UpstreamRecordFromJSON(json: any): UpstreamRecord;
+export declare function UpstreamRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpstreamRecord;
+export declare function UpstreamRecordToJSON(json: any): UpstreamRecord;
+export declare function UpstreamRecordToJSONTyped(value?: UpstreamRecord | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpstreamRecord.js

@@ -0,0 +1,80 @@
+/* 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 { UpstreamRecordAdditionalReferencesFromJSON, UpstreamRecordAdditionalReferencesToJSON, } from './UpstreamRecordAdditionalReferences';
+import { UpstreamRecordDataQualityFromJSON, UpstreamRecordDataQualityToJSON, } from './UpstreamRecordDataQuality';
+import { UpstreamRecordMetadataFromJSON, UpstreamRecordMetadataToJSON, } from './UpstreamRecordMetadata';
+/**
+ * Check if a given object implements the UpstreamRecord interface.
+ */
+export function instanceOfUpstreamRecord(value) {
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if ((!('tradeflowReference' in value) && !('tradeflow_reference' in value)) || (value['tradeflowReference'] === undefined && value['tradeflow_reference'] === undefined))
+        return false;
+    if ((!('billOfLading' in value) && !('bill_of_lading' in value)) || (value['billOfLading'] === undefined && value['bill_of_lading'] === undefined))
+        return false;
+    if (!('booking' in value) || value['booking'] === undefined)
+        return false;
+    if ((!('additionalReferences' in value) && !('additional_references' in value)) || (value['additionalReferences'] === undefined && value['additional_references'] === undefined))
+        return false;
+    if ((!('dataQuality' in value) && !('data_quality' in value)) || (value['dataQuality'] === undefined && value['data_quality'] === undefined))
+        return false;
+    if (!('metadata' in value) || value['metadata'] === undefined)
+        return false;
+    return true;
+}
+export function UpstreamRecordFromJSON(json) {
+    return UpstreamRecordFromJSONTyped(json, false);
+}
+export function UpstreamRecordFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return UpstreamRecordToJSONTyped(json, false);
+}
+export function UpstreamRecordToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/UpstreamRecordAdditionalReferences.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 UpstreamRecordAdditionalReferences
+ */
+export interface UpstreamRecordAdditionalReferences {
+    /**
+     *
+     */
+    billOfLading?: Array<string>;
+    /**
+     *
+     */
+    booking?: Array<string>;
+}
+/**
+ * Check if a given object implements the UpstreamRecordAdditionalReferences interface.
+ */
+export declare function instanceOfUpstreamRecordAdditionalReferences(value: object): value is UpstreamRecordAdditionalReferences;
+export declare function UpstreamRecordAdditionalReferencesFromJSON(json: any): UpstreamRecordAdditionalReferences;
+export declare function UpstreamRecordAdditionalReferencesFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpstreamRecordAdditionalReferences;
+export declare function UpstreamRecordAdditionalReferencesToJSON(json: any): UpstreamRecordAdditionalReferences;
+export declare function UpstreamRecordAdditionalReferencesToJSONTyped(value?: UpstreamRecordAdditionalReferences | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpstreamRecordAdditionalReferences.js

@@ -0,0 +1,43 @@
+/* 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 UpstreamRecordAdditionalReferences interface.
+ */
+export function instanceOfUpstreamRecordAdditionalReferences(value) {
+    return true;
+}
+export function UpstreamRecordAdditionalReferencesFromJSON(json) {
+    return UpstreamRecordAdditionalReferencesFromJSONTyped(json, false);
+}
+export function UpstreamRecordAdditionalReferencesFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return UpstreamRecordAdditionalReferencesToJSONTyped(json, false);
+}
+export function UpstreamRecordAdditionalReferencesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'bill_of_lading': value['billOfLading'],
+        'booking': value['booking'],
+    };
+}

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

@@ -0,0 +1,46 @@
+/**
+ * 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 UpstreamRecordDataQuality
+ */
+export interface UpstreamRecordDataQuality {
+    /**
+     *
+     */
+    freshnessMin?: number;
+    /**
+     *
+     */
+    anomalies?: number;
+    /**
+     *
+     */
+    missedMilestones?: number;
+    /**
+     *
+     */
+    hasLiveData?: boolean;
+    /**
+     *
+     */
+    isSingularShipment?: boolean;
+}
+/**
+ * Check if a given object implements the UpstreamRecordDataQuality interface.
+ */
+export declare function instanceOfUpstreamRecordDataQuality(value: object): value is UpstreamRecordDataQuality;
+export declare function UpstreamRecordDataQualityFromJSON(json: any): UpstreamRecordDataQuality;
+export declare function UpstreamRecordDataQualityFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpstreamRecordDataQuality;
+export declare function UpstreamRecordDataQualityToJSON(json: any): UpstreamRecordDataQuality;
+export declare function UpstreamRecordDataQualityToJSONTyped(value?: UpstreamRecordDataQuality | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpstreamRecordDataQuality.js

@@ -0,0 +1,49 @@
+/* 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 UpstreamRecordDataQuality interface.
+ */
+export function instanceOfUpstreamRecordDataQuality(value) {
+    return true;
+}
+export function UpstreamRecordDataQualityFromJSON(json) {
+    return UpstreamRecordDataQualityFromJSONTyped(json, false);
+}
+export function UpstreamRecordDataQualityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'freshnessMin': json['freshness_min'] == null ? undefined : json['freshness_min'],
+        'anomalies': json['anomalies'] == null ? undefined : json['anomalies'],
+        'missedMilestones': json['missed_milestones'] == null ? undefined : json['missed_milestones'],
+        'hasLiveData': json['has_live_data'] == null ? undefined : json['has_live_data'],
+        'isSingularShipment': json['is_singular_shipment'] == null ? undefined : json['is_singular_shipment'],
+    };
+}
+export function UpstreamRecordDataQualityToJSON(json) {
+    return UpstreamRecordDataQualityToJSONTyped(json, false);
+}
+export function UpstreamRecordDataQualityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'freshness_min': value['freshnessMin'],
+        'anomalies': value['anomalies'],
+        'missed_milestones': value['missedMilestones'],
+        'has_live_data': value['hasLiveData'],
+        'is_singular_shipment': value['isSingularShipment'],
+    };
+}