@dockflow/sdk 0.0.0-stage → 0.2.0

package/src/models/UpstreamRecordDataQuality.ts

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

package/src/models/UpstreamRecordMetadata.ts

@@ -0,0 +1,81 @@
+/* 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, parseDate, parseDateTime, serializeDate, serializeDateTime } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfUpstreamRecordMetadata(value: object): value is UpstreamRecordMetadata {
+    return true;
+}
+
+export function UpstreamRecordMetadataFromJSON(json: any): UpstreamRecordMetadata {
+    return UpstreamRecordMetadataFromJSONTyped(json, false);
+}
+
+export function UpstreamRecordMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpstreamRecordMetadata {
+    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: any): UpstreamRecordMetadata {
+    return UpstreamRecordMetadataToJSONTyped(json, false);
+}
+
+export function UpstreamRecordMetadataToJSONTyped(value?: UpstreamRecordMetadata | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/V3DocumentGet200Response.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 { V3DocumentGet200ResponseDataInner } from './V3DocumentGet200ResponseDataInner';
+import {
+    V3DocumentGet200ResponseDataInnerFromJSON,
+    V3DocumentGet200ResponseDataInnerFromJSONTyped,
+    V3DocumentGet200ResponseDataInnerToJSON,
+    V3DocumentGet200ResponseDataInnerToJSONTyped,
+} from './V3DocumentGet200ResponseDataInner';
+
+/**
+ * 
+ * @export
+ * @interface V3DocumentGet200Response
+ */
+export interface V3DocumentGet200Response {
+    /**
+     * 
+     */
+    data: Array<V3DocumentGet200ResponseDataInner>;
+    /**
+     * 
+     */
+    tradeflowReference: string;
+    /**
+     * 
+     */
+    count: number;
+}
+
+/**
+ * Check if a given object implements the V3DocumentGet200Response interface.
+ */
+export function instanceOfV3DocumentGet200Response(value: object): value is V3DocumentGet200Response {
+    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 V3DocumentGet200ResponseFromJSON(json: any): V3DocumentGet200Response {
+    return V3DocumentGet200ResponseFromJSONTyped(json, false);
+}
+
+export function V3DocumentGet200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3DocumentGet200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(V3DocumentGet200ResponseDataInnerFromJSON)),
+        'tradeflowReference': json['tradeflow_reference'],
+        'count': json['count'],
+    };
+}
+
+export function V3DocumentGet200ResponseToJSON(json: any): V3DocumentGet200Response {
+    return V3DocumentGet200ResponseToJSONTyped(json, false);
+}
+
+export function V3DocumentGet200ResponseToJSONTyped(value?: V3DocumentGet200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(V3DocumentGet200ResponseDataInnerToJSON)),
+        'tradeflow_reference': value['tradeflowReference'],
+        'count': value['count'],
+    };
+}
+

package/src/models/V3DocumentGet200ResponseDataInner.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 { V3DocumentGet200ResponseDataInnerDocumentType } from './V3DocumentGet200ResponseDataInnerDocumentType';
+import {
+    V3DocumentGet200ResponseDataInnerDocumentTypeFromJSON,
+    V3DocumentGet200ResponseDataInnerDocumentTypeFromJSONTyped,
+    V3DocumentGet200ResponseDataInnerDocumentTypeToJSON,
+    V3DocumentGet200ResponseDataInnerDocumentTypeToJSONTyped,
+} from './V3DocumentGet200ResponseDataInnerDocumentType';
+
+/**
+ * 
+ * @export
+ * @interface V3DocumentGet200ResponseDataInner
+ */
+export interface V3DocumentGet200ResponseDataInner {
+    /**
+     * 
+     */
+    id: number;
+    /**
+     * 
+     */
+    name: string;
+    /**
+     * 
+     */
+    filetype: string;
+    /**
+     * 
+     */
+    inputName: string | null;
+    /**
+     * 
+     */
+    version: number;
+    /**
+     * 
+     */
+    documentType: V3DocumentGet200ResponseDataInnerDocumentType | null;
+    /**
+     * 
+     */
+    metadata: object | null;
+    /**
+     * 
+     */
+    createdAt: string | null;
+    /**
+     * 
+     */
+    updatedAt: string | null;
+}
+
+/**
+ * Check if a given object implements the V3DocumentGet200ResponseDataInner interface.
+ */
+export function instanceOfV3DocumentGet200ResponseDataInner(value: object): value is V3DocumentGet200ResponseDataInner {
+    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 V3DocumentGet200ResponseDataInnerFromJSON(json: any): V3DocumentGet200ResponseDataInner {
+    return V3DocumentGet200ResponseDataInnerFromJSONTyped(json, false);
+}
+
+export function V3DocumentGet200ResponseDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3DocumentGet200ResponseDataInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'filetype': json['filetype'],
+        'inputName': json['input_name'],
+        'version': json['version'],
+        'documentType': V3DocumentGet200ResponseDataInnerDocumentTypeFromJSON(json['document_type']),
+        'metadata': json['metadata'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function V3DocumentGet200ResponseDataInnerToJSON(json: any): V3DocumentGet200ResponseDataInner {
+    return V3DocumentGet200ResponseDataInnerToJSONTyped(json, false);
+}
+
+export function V3DocumentGet200ResponseDataInnerToJSONTyped(value?: V3DocumentGet200ResponseDataInner | 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': V3DocumentGet200ResponseDataInnerDocumentTypeToJSON(value['documentType']),
+        'metadata': value['metadata'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

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

package/src/models/V3DocumentPost202Response.ts

@@ -0,0 +1,106 @@
+/* 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 V3DocumentPost202Response
+ */
+export interface V3DocumentPost202Response {
+    /**
+     * 
+     */
+    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 V3DocumentPost202Response interface.
+ */
+export function instanceOfV3DocumentPost202Response(value: object): value is V3DocumentPost202Response {
+    if (!('id' in value) || value['id'] === 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 ((!('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 (!('filename' in value) || value['filename'] === undefined) return false;
+    if (!('filetype' in value) || value['filetype'] === undefined) return false;
+    if ((!('containerReference' in (value as Record<string, any>)) && !('container_reference' in (value as Record<string, any>))) || ((value as Record<string, any>)['containerReference'] === undefined && (value as Record<string, any>)['container_reference'] === 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;
+    return true;
+}
+
+export function V3DocumentPost202ResponseFromJSON(json: any): V3DocumentPost202Response {
+    return V3DocumentPost202ResponseFromJSONTyped(json, false);
+}
+
+export function V3DocumentPost202ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3DocumentPost202Response {
+    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 V3DocumentPost202ResponseToJSON(json: any): V3DocumentPost202Response {
+    return V3DocumentPost202ResponseToJSONTyped(json, false);
+}
+
+export function V3DocumentPost202ResponseToJSONTyped(value?: V3DocumentPost202Response | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/V3DocumentPost400Response.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 V3DocumentPost400Response
+ */
+export interface V3DocumentPost400Response {
+}
+
+/**
+ * Check if a given object implements the V3DocumentPost400Response interface.
+ */
+export function instanceOfV3DocumentPost400Response(value: object): value is V3DocumentPost400Response {
+    return true;
+}
+
+export function V3DocumentPost400ResponseFromJSON(json: any): V3DocumentPost400Response {
+    return V3DocumentPost400ResponseFromJSONTyped(json, false);
+}
+
+export function V3DocumentPost400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3DocumentPost400Response {
+    return json;
+}
+
+export function V3DocumentPost400ResponseToJSON(json: any): V3DocumentPost400Response {
+    return V3DocumentPost400ResponseToJSONTyped(json, false);
+}
+
+export function V3DocumentPost400ResponseToJSONTyped(value?: V3DocumentPost400Response | null, ignoreDiscriminator: boolean = false): any {
+    return value;
+}
+