@dockflow/sdk 0.0.0-stage → 0.2.0

package/dist/models/WidgetSearchResult.js

@@ -0,0 +1,85 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfWidgetSearchResult = instanceOfWidgetSearchResult;
+exports.WidgetSearchResultFromJSON = WidgetSearchResultFromJSON;
+exports.WidgetSearchResultFromJSONTyped = WidgetSearchResultFromJSONTyped;
+exports.WidgetSearchResultToJSON = WidgetSearchResultToJSON;
+exports.WidgetSearchResultToJSONTyped = WidgetSearchResultToJSONTyped;
+const WidgetContainer_1 = require("./WidgetContainer");
+const WidgetLeg_1 = require("./WidgetLeg");
+const WidgetTrack_1 = require("./WidgetTrack");
+/**
+ * Check if a given object implements the WidgetSearchResult interface.
+ */
+function instanceOfWidgetSearchResult(value) {
+    if (!('references' in value) || value['references'] === undefined)
+        return false;
+    if (!('carrier' in value) || value['carrier'] === undefined)
+        return false;
+    if ((!('bookingReference' in value) && !('booking_reference' in value)) || (value['bookingReference'] === undefined && value['booking_reference'] === undefined))
+        return false;
+    if ((!('billOfLadingReference' in value) && !('bill_of_lading_reference' in value)) || (value['billOfLadingReference'] === undefined && value['bill_of_lading_reference'] === undefined))
+        return false;
+    if (!('departure' in value) || value['departure'] === undefined)
+        return false;
+    if (!('arrival' in value) || value['arrival'] === undefined)
+        return false;
+    if (!('containers' in value) || value['containers'] === undefined)
+        return false;
+    if (!('tracks' in value) || value['tracks'] === undefined)
+        return false;
+    if ((!('detailsUrl' in value) && !('details_url' in value)) || (value['detailsUrl'] === undefined && value['details_url'] === undefined))
+        return false;
+    return true;
+}
+function WidgetSearchResultFromJSON(json) {
+    return WidgetSearchResultFromJSONTyped(json, false);
+}
+function WidgetSearchResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'references': json['references'],
+        'carrier': json['carrier'],
+        'bookingReference': json['booking_reference'],
+        'billOfLadingReference': json['bill_of_lading_reference'],
+        'departure': (0, WidgetLeg_1.WidgetLegFromJSON)(json['departure']),
+        'arrival': (0, WidgetLeg_1.WidgetLegFromJSON)(json['arrival']),
+        'containers': (json['containers'].map(WidgetContainer_1.WidgetContainerFromJSON)),
+        'tracks': (json['tracks'].map(WidgetTrack_1.WidgetTrackFromJSON)),
+        'detailsUrl': json['details_url'],
+    };
+}
+function WidgetSearchResultToJSON(json) {
+    return WidgetSearchResultToJSONTyped(json, false);
+}
+function WidgetSearchResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'references': value['references'],
+        'carrier': value['carrier'],
+        'booking_reference': value['bookingReference'],
+        'bill_of_lading_reference': value['billOfLadingReference'],
+        'departure': (0, WidgetLeg_1.WidgetLegToJSON)(value['departure']),
+        'arrival': (0, WidgetLeg_1.WidgetLegToJSON)(value['arrival']),
+        'containers': (value['containers'].map(WidgetContainer_1.WidgetContainerToJSON)),
+        'tracks': (value['tracks'].map(WidgetTrack_1.WidgetTrackToJSON)),
+        'details_url': value['detailsUrl'],
+    };
+}

package/dist/models/WidgetTrack.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { WidgetTrackReading } from './WidgetTrackReading';
+/**
+ *
+ * @export
+ * @interface WidgetTrack
+ */
+export interface WidgetTrack {
+    /**
+     *
+     */
+    deviceReference: string | null;
+    /**
+     *
+     */
+    readings: Array<WidgetTrackReading>;
+}
+/**
+ * Check if a given object implements the WidgetTrack interface.
+ */
+export declare function instanceOfWidgetTrack(value: object): value is WidgetTrack;
+export declare function WidgetTrackFromJSON(json: any): WidgetTrack;
+export declare function WidgetTrackFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetTrack;
+export declare function WidgetTrackToJSON(json: any): WidgetTrack;
+export declare function WidgetTrackToJSONTyped(value?: WidgetTrack | null, ignoreDiscriminator?: boolean): any;

package/dist/models/WidgetTrack.js

@@ -0,0 +1,55 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfWidgetTrack = instanceOfWidgetTrack;
+exports.WidgetTrackFromJSON = WidgetTrackFromJSON;
+exports.WidgetTrackFromJSONTyped = WidgetTrackFromJSONTyped;
+exports.WidgetTrackToJSON = WidgetTrackToJSON;
+exports.WidgetTrackToJSONTyped = WidgetTrackToJSONTyped;
+const WidgetTrackReading_1 = require("./WidgetTrackReading");
+/**
+ * Check if a given object implements the WidgetTrack interface.
+ */
+function instanceOfWidgetTrack(value) {
+    if ((!('deviceReference' in value) && !('device_reference' in value)) || (value['deviceReference'] === undefined && value['device_reference'] === undefined))
+        return false;
+    if (!('readings' in value) || value['readings'] === undefined)
+        return false;
+    return true;
+}
+function WidgetTrackFromJSON(json) {
+    return WidgetTrackFromJSONTyped(json, false);
+}
+function WidgetTrackFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'deviceReference': json['device_reference'],
+        'readings': (json['readings'].map(WidgetTrackReading_1.WidgetTrackReadingFromJSON)),
+    };
+}
+function WidgetTrackToJSON(json) {
+    return WidgetTrackToJSONTyped(json, false);
+}
+function WidgetTrackToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'device_reference': value['deviceReference'],
+        'readings': (value['readings'].map(WidgetTrackReading_1.WidgetTrackReadingToJSON)),
+    };
+}

package/dist/models/WidgetTrackReading.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 WidgetTrackReading
+ */
+export interface WidgetTrackReading {
+    /**
+     *
+     */
+    eventDate: string;
+    /**
+     *
+     */
+    lat: number;
+    /**
+     *
+     */
+    lng: number;
+}
+/**
+ * Check if a given object implements the WidgetTrackReading interface.
+ */
+export declare function instanceOfWidgetTrackReading(value: object): value is WidgetTrackReading;
+export declare function WidgetTrackReadingFromJSON(json: any): WidgetTrackReading;
+export declare function WidgetTrackReadingFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetTrackReading;
+export declare function WidgetTrackReadingToJSON(json: any): WidgetTrackReading;
+export declare function WidgetTrackReadingToJSONTyped(value?: WidgetTrackReading | null, ignoreDiscriminator?: boolean): any;

package/dist/models/WidgetTrackReading.js

@@ -0,0 +1,58 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfWidgetTrackReading = instanceOfWidgetTrackReading;
+exports.WidgetTrackReadingFromJSON = WidgetTrackReadingFromJSON;
+exports.WidgetTrackReadingFromJSONTyped = WidgetTrackReadingFromJSONTyped;
+exports.WidgetTrackReadingToJSON = WidgetTrackReadingToJSON;
+exports.WidgetTrackReadingToJSONTyped = WidgetTrackReadingToJSONTyped;
+/**
+ * Check if a given object implements the WidgetTrackReading interface.
+ */
+function instanceOfWidgetTrackReading(value) {
+    if ((!('eventDate' in value) && !('event_date' in value)) || (value['eventDate'] === undefined && value['event_date'] === undefined))
+        return false;
+    if (!('lat' in value) || value['lat'] === undefined)
+        return false;
+    if (!('lng' in value) || value['lng'] === undefined)
+        return false;
+    return true;
+}
+function WidgetTrackReadingFromJSON(json) {
+    return WidgetTrackReadingFromJSONTyped(json, false);
+}
+function WidgetTrackReadingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'eventDate': json['event_date'],
+        'lat': json['lat'],
+        'lng': json['lng'],
+    };
+}
+function WidgetTrackReadingToJSON(json) {
+    return WidgetTrackReadingToJSONTyped(json, false);
+}
+function WidgetTrackReadingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'event_date': value['eventDate'],
+        'lat': value['lat'],
+        'lng': value['lng'],
+    };
+}

package/dist/models/index.d.ts

@@ -0,0 +1,35 @@
+export * from './ContainerReference';
+export * from './DocumentUpdate';
+export * from './DocumentUpload';
+export * from './DownstreamTradeflow';
+export * from './DownstreamTradeflowBillOfLadingReference';
+export * from './DownstreamTradeflowBookingReference';
+export * from './DownstreamTradeflowEventsInner';
+export * from './DownstreamTradeflowFreeTimeOverridesInner';
+export * from './DownstreamTradeflowMockTracking';
+export * from './DownstreamTradeflowPartnersInner';
+export * from './DownstreamTradeflowReferences';
+export * from './InlineObject';
+export * from './ListDocumentTypes200ResponseInner';
+export * from './UpstreamRecord';
+export * from './UpstreamRecordAdditionalReferences';
+export * from './UpstreamRecordDataQuality';
+export * from './UpstreamRecordMetadata';
+export * from './V3DocumentGet200Response';
+export * from './V3DocumentGet200ResponseDataInner';
+export * from './V3DocumentGet200ResponseDataInnerDocumentType';
+export * from './V3DocumentPost202Response';
+export * from './V3DocumentPost400Response';
+export * from './V3DownstreamPost202Response';
+export * from './V3DownstreamPost202ResponseTradeflowsInner';
+export * from './V3UpstreamGet200Response';
+export * from './V3UpstreamGet400Response';
+export * from './WidgetContainer';
+export * from './WidgetCountry';
+export * from './WidgetLeg';
+export * from './WidgetLocation';
+export * from './WidgetMilestone';
+export * from './WidgetPoint';
+export * from './WidgetSearchResult';
+export * from './WidgetTrack';
+export * from './WidgetTrackReading';

package/dist/models/index.js

@@ -0,0 +1,53 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./ContainerReference"), exports);
+__exportStar(require("./DocumentUpdate"), exports);
+__exportStar(require("./DocumentUpload"), exports);
+__exportStar(require("./DownstreamTradeflow"), exports);
+__exportStar(require("./DownstreamTradeflowBillOfLadingReference"), exports);
+__exportStar(require("./DownstreamTradeflowBookingReference"), exports);
+__exportStar(require("./DownstreamTradeflowEventsInner"), exports);
+__exportStar(require("./DownstreamTradeflowFreeTimeOverridesInner"), exports);
+__exportStar(require("./DownstreamTradeflowMockTracking"), exports);
+__exportStar(require("./DownstreamTradeflowPartnersInner"), exports);
+__exportStar(require("./DownstreamTradeflowReferences"), exports);
+__exportStar(require("./InlineObject"), exports);
+__exportStar(require("./ListDocumentTypes200ResponseInner"), exports);
+__exportStar(require("./UpstreamRecord"), exports);
+__exportStar(require("./UpstreamRecordAdditionalReferences"), exports);
+__exportStar(require("./UpstreamRecordDataQuality"), exports);
+__exportStar(require("./UpstreamRecordMetadata"), exports);
+__exportStar(require("./V3DocumentGet200Response"), exports);
+__exportStar(require("./V3DocumentGet200ResponseDataInner"), exports);
+__exportStar(require("./V3DocumentGet200ResponseDataInnerDocumentType"), exports);
+__exportStar(require("./V3DocumentPost202Response"), exports);
+__exportStar(require("./V3DocumentPost400Response"), exports);
+__exportStar(require("./V3DownstreamPost202Response"), exports);
+__exportStar(require("./V3DownstreamPost202ResponseTradeflowsInner"), exports);
+__exportStar(require("./V3UpstreamGet200Response"), exports);
+__exportStar(require("./V3UpstreamGet400Response"), exports);
+__exportStar(require("./WidgetContainer"), exports);
+__exportStar(require("./WidgetCountry"), exports);
+__exportStar(require("./WidgetLeg"), exports);
+__exportStar(require("./WidgetLocation"), exports);
+__exportStar(require("./WidgetMilestone"), exports);
+__exportStar(require("./WidgetPoint"), exports);
+__exportStar(require("./WidgetSearchResult"), exports);
+__exportStar(require("./WidgetTrack"), exports);
+__exportStar(require("./WidgetTrackReading"), exports);

package/dist/runtime.d.ts

@@ -0,0 +1,217 @@
+/**
+ * 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 declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+/**
+ * Every generated date call site routes through these.
+ *
+ * `format: date` is a calendar date, with no time and no offset, so it is converted
+ * against the local calendar on both ends: they have to agree or the date shifts by
+ * a day. `format: date-time` is an instant and uses UTC.
+ */
+export declare function serializeDateTime(value: Date): string;
+export declare function serializeDate(value: Date): string;
+export declare function parseDate(value: Date | string): Date;
+export declare function parseDateTime(value: any): Date;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function anyToJSON(value: any): any;
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+/**
+ * A Blob carrying the file name the server advertised, empty when it did not send one. It is a File
+ * wherever one can be built, and the bare Blob given a name otherwise. Same name and shape as the
+ * `typescript` generator's browser HttpFile.
+ */
+export type HttpFile = Blob & {
+    readonly name: string;
+};
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    /**
+     * The body named after the Content-Disposition header, so that a download keeps the name the
+     * server gave it. A File is built from a native Blob; the Blob itself is named where there is no
+     * global File (Node.js before 20), where File cannot be constructed, or where the Blob is not the
+     * native one, as returned by an injected fetch implementation such as node-fetch, which a File
+     * would stringify instead of wrapping.
+     */
+    value(): Promise<HttpFile>;
+}
+/**
+ * The file name advertised by a Content-Disposition header (RFC 6266): the RFC 5987 encoded
+ * `filename*` parameter first, falling back to the plain `filename` when it is malformed, not UTF-8
+ * or has no usable name. Any directory part is dropped; undefined when no usable name is advertised.
+ */
+export declare function parseContentDispositionFilename(headers: Headers): string | undefined;
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}