@dockflow/sdk 0.0.0-stage → 0.3.0

package/src/apis/UpstreamApi.ts

@@ -0,0 +1,185 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type GetUpstream200Response,
+    GetUpstream200ResponseFromJSON,
+    GetUpstream200ResponseToJSON,
+} from '../models/GetUpstream200Response';
+import {
+    type GetUpstream400Response,
+    GetUpstream400ResponseFromJSON,
+    GetUpstream400ResponseToJSON,
+} from '../models/GetUpstream400Response';
+
+export interface GetUpstreamRequest {
+    /**
+     * Only tradeflows changed after this ISO 8601 timestamp (exclusive), with an offset. Without since, cursor, tradeflow or container: the last 15 minutes.
+     */
+    since?: string;
+    /**
+     * Your tradeflow reference. Returns that tradeflow regardless of when it changed.
+     */
+    tradeflow?: string;
+    /**
+     * A container number. Returns its tradeflows regardless of when they changed.
+     */
+    container?: string;
+    /**
+     * Keep only events of this category: MILESTONE, SHIPMENT or LOCATION.
+     */
+    category?: string;
+    /**
+     * Keep only events whose code starts with this value. One of: GE, GN, AE, VD, VA, UV, GT, GD, GR, POS, A-BKD, A-RCS, A-DEP, A-ARR, A-RCF, A-NFD, A-DLV. Any other value returns 400.
+     */
+    code?: string;
+    /**
+     * next_cursor from the previous page. Keep since identical across the pages of one cycle.
+     */
+    cursor?: string;
+    /**
+     * true (active only), false, or both. Default: active plus recently deactivated.
+     */
+    active?: string;
+    /**
+     * Comma-separated blocks: events, locations, containers, shipment, vessels. Default: all but vessels.
+     */
+    fields?: string;
+    /**
+     * Shape of `events`: `v3` (Dockflow milestones) or `dcsa-tnt-2.2` (DCSA Track & Trace 2.2). The rest of the record is identical.
+     */
+    format?: GetUpstreamFormatEnum;
+    /**
+     * Tradeflows per page, 1 to 1000. Default 50.
+     */
+    perPage?: number;
+    /**
+     * Set to 1 and Dockflow keeps your position per API key and filter set, so repeated identical polls skip nothing.
+     */
+    failsafe?: GetUpstreamFailsafeEnum;
+}
+
+/**
+ * 
+ */
+export class UpstreamApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getUpstream without sending the request
+     */
+    async getUpstreamRequestOpts(requestParameters: GetUpstreamRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['since'] != null) {
+            queryParameters['since'] = requestParameters['since'];
+        }
+
+        if (requestParameters['tradeflow'] != null) {
+            queryParameters['tradeflow'] = requestParameters['tradeflow'];
+        }
+
+        if (requestParameters['container'] != null) {
+            queryParameters['container'] = requestParameters['container'];
+        }
+
+        if (requestParameters['category'] != null) {
+            queryParameters['category'] = requestParameters['category'];
+        }
+
+        if (requestParameters['code'] != null) {
+            queryParameters['code'] = requestParameters['code'];
+        }
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['active'] != null) {
+            queryParameters['active'] = requestParameters['active'];
+        }
+
+        if (requestParameters['fields'] != null) {
+            queryParameters['fields'] = requestParameters['fields'];
+        }
+
+        if (requestParameters['format'] != null) {
+            queryParameters['format'] = requestParameters['format'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['failsafe'] != null) {
+            queryParameters['failsafe'] = requestParameters['failsafe'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("ApiKey", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v3/upstream`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Poll upstream events
+     */
+    async getUpstreamRaw(requestParameters: GetUpstreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUpstream200Response>> {
+        const requestOptions = await this.getUpstreamRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetUpstream200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Poll upstream events
+     */
+    async getUpstream(requestParameters: GetUpstreamRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUpstream200Response> {
+        const response = await this.getUpstreamRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetUpstreamFormatEnum = {
+    V3: 'v3',
+    DcsaTnt22: 'dcsa-tnt-2.2',
+} as const;
+export type GetUpstreamFormatEnum = typeof GetUpstreamFormatEnum[keyof typeof GetUpstreamFormatEnum];
+/**
+ * @export
+ */
+export const GetUpstreamFailsafeEnum = {
+    _0: '0',
+    _1: '1',
+} as const;
+export type GetUpstreamFailsafeEnum = typeof GetUpstreamFailsafeEnum[keyof typeof GetUpstreamFailsafeEnum];

package/src/apis/WidgetApi.ts

@@ -0,0 +1,97 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type InlineObject,
+    InlineObjectFromJSON,
+    InlineObjectToJSON,
+} from '../models/InlineObject';
+import {
+    type WidgetSearchResult,
+    WidgetSearchResultFromJSON,
+    WidgetSearchResultToJSON,
+} from '../models/WidgetSearchResult';
+
+export interface SearchWidgetRequest {
+    /**
+     * Container number, booking or bill of lading reference.
+     */
+    q: string;
+}
+
+/**
+ * 
+ */
+export class WidgetApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for searchWidget without sending the request
+     */
+    async searchWidgetRequestOpts(requestParameters: SearchWidgetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['q'] == null) {
+            throw new runtime.RequiredError(
+                'q',
+                'Required parameter "q" was null or undefined when calling searchWidget().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['q'] != null) {
+            queryParameters['q'] = requestParameters['q'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("ApiKey", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v3/widget/search`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Matches a container number, booking or bill of lading within the token\'s entity and returns the best match.
+     * Search a shipment for the embeddable tracking widget
+     */
+    async searchWidgetRaw(requestParameters: SearchWidgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WidgetSearchResult>> {
+        const requestOptions = await this.searchWidgetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WidgetSearchResultFromJSON(jsonValue));
+    }
+
+    /**
+     * Matches a container number, booking or bill of lading within the token\'s entity and returns the best match.
+     * Search a shipment for the embeddable tracking widget
+     */
+    async searchWidget(requestParameters: SearchWidgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WidgetSearchResult> {
+        const response = await this.searchWidgetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,6 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './DocumentsApi';
+export * from './TradeflowsApi';
+export * from './UpstreamApi';
+export * from './WidgetApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/ContainerReference.ts

@@ -0,0 +1,70 @@
+/* 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 ContainerReference
+ */
+export interface ContainerReference {
+    /**
+     * 
+     */
+    reference: string;
+    /**
+     * Free-form key-value pairs stored on the container.
+     */
+    customProperties?: object;
+}
+
+/**
+ * Check if a given object implements the ContainerReference interface.
+ */
+export function instanceOfContainerReference(value: object): value is ContainerReference {
+    if (!('reference' in value) || value['reference'] === undefined) return false;
+    return true;
+}
+
+export function ContainerReferenceFromJSON(json: any): ContainerReference {
+    return ContainerReferenceFromJSONTyped(json, false);
+}
+
+export function ContainerReferenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContainerReference {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reference': json['reference'],
+        'customProperties': json['custom_properties'] == null ? undefined : json['custom_properties'],
+    };
+}
+
+export function ContainerReferenceToJSON(json: any): ContainerReference {
+    return ContainerReferenceToJSONTyped(json, false);
+}
+
+export function ContainerReferenceToJSONTyped(value?: ContainerReference | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'reference': value['reference'],
+        'custom_properties': value['customProperties'],
+    };
+}
+

package/src/models/CreateTradeflows202Response.ts

@@ -0,0 +1,91 @@
+/* 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 { CreateTradeflows202ResponseTradeflowsInner } from './CreateTradeflows202ResponseTradeflowsInner';
+import {
+    CreateTradeflows202ResponseTradeflowsInnerFromJSON,
+    CreateTradeflows202ResponseTradeflowsInnerFromJSONTyped,
+    CreateTradeflows202ResponseTradeflowsInnerToJSON,
+    CreateTradeflows202ResponseTradeflowsInnerToJSONTyped,
+} from './CreateTradeflows202ResponseTradeflowsInner';
+
+/**
+ * 
+ * @export
+ * @interface CreateTradeflows202Response
+ */
+export interface CreateTradeflows202Response {
+    /**
+     * 
+     */
+    status: CreateTradeflows202ResponseStatusEnum;
+    /**
+     * 
+     */
+    tradeflows: Array<CreateTradeflows202ResponseTradeflowsInner>;
+}
+
+
+/**
+ * @export
+ */
+export const CreateTradeflows202ResponseStatusEnum = {
+    Queued: 'queued',
+} as const;
+export type CreateTradeflows202ResponseStatusEnum = typeof CreateTradeflows202ResponseStatusEnum[keyof typeof CreateTradeflows202ResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the CreateTradeflows202Response interface.
+ */
+export function instanceOfCreateTradeflows202Response(value: object): value is CreateTradeflows202Response {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (value['status'] !== 'queued') return false;
+    
+    if (!('tradeflows' in value) || value['tradeflows'] === undefined) return false;
+    return true;
+}
+
+export function CreateTradeflows202ResponseFromJSON(json: any): CreateTradeflows202Response {
+    return CreateTradeflows202ResponseFromJSONTyped(json, false);
+}
+
+export function CreateTradeflows202ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateTradeflows202Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'tradeflows': ((json['tradeflows'] as Array<any>).map(CreateTradeflows202ResponseTradeflowsInnerFromJSON)),
+    };
+}
+
+export function CreateTradeflows202ResponseToJSON(json: any): CreateTradeflows202Response {
+    return CreateTradeflows202ResponseToJSONTyped(json, false);
+}
+
+export function CreateTradeflows202ResponseToJSONTyped(value?: CreateTradeflows202Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'tradeflows': ((value['tradeflows'] as Array<any>).map(CreateTradeflows202ResponseTradeflowsInnerToJSON)),
+    };
+}
+

package/src/models/CreateTradeflows202ResponseTradeflowsInner.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 CreateTradeflows202ResponseTradeflowsInner
+ */
+export interface CreateTradeflows202ResponseTradeflowsInner {
+    /**
+     * 
+     */
+    tradeflowReference: string;
+    /**
+     * 
+     */
+    warnings: Array<string>;
+}
+
+/**
+ * Check if a given object implements the CreateTradeflows202ResponseTradeflowsInner interface.
+ */
+export function instanceOfCreateTradeflows202ResponseTradeflowsInner(value: object): value is CreateTradeflows202ResponseTradeflowsInner {
+    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 (!('warnings' in value) || value['warnings'] === undefined) return false;
+    return true;
+}
+
+export function CreateTradeflows202ResponseTradeflowsInnerFromJSON(json: any): CreateTradeflows202ResponseTradeflowsInner {
+    return CreateTradeflows202ResponseTradeflowsInnerFromJSONTyped(json, false);
+}
+
+export function CreateTradeflows202ResponseTradeflowsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateTradeflows202ResponseTradeflowsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tradeflowReference': json['tradeflow_reference'],
+        'warnings': json['warnings'],
+    };
+}
+
+export function CreateTradeflows202ResponseTradeflowsInnerToJSON(json: any): CreateTradeflows202ResponseTradeflowsInner {
+    return CreateTradeflows202ResponseTradeflowsInnerToJSONTyped(json, false);
+}
+
+export function CreateTradeflows202ResponseTradeflowsInnerToJSONTyped(value?: CreateTradeflows202ResponseTradeflowsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tradeflow_reference': value['tradeflowReference'],
+        'warnings': value['warnings'],
+    };
+}
+

package/src/models/DocumentUpdate.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';
+/**
+ * Only the fields sent are changed.
+ * @export
+ * @interface DocumentUpdate
+ */
+export interface DocumentUpdate {
+    /**
+     * 
+     */
+    documentFilename?: string;
+    /**
+     * A type name from GET /v3/downstream/documents/types. An unknown name leaves the type unchanged.
+     */
+    documentType?: string;
+    /**
+     * Links the document to this container; an unknown reference unlinks it.
+     */
+    containerReference?: string;
+}
+
+/**
+ * Check if a given object implements the DocumentUpdate interface.
+ */
+export function instanceOfDocumentUpdate(value: object): value is DocumentUpdate {
+    return true;
+}
+
+export function DocumentUpdateFromJSON(json: any): DocumentUpdate {
+    return DocumentUpdateFromJSONTyped(json, false);
+}
+
+export function DocumentUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'documentFilename': json['document_filename'] == null ? undefined : json['document_filename'],
+        'documentType': json['document_type'] == null ? undefined : json['document_type'],
+        'containerReference': json['container_reference'] == null ? undefined : json['container_reference'],
+    };
+}
+
+export function DocumentUpdateToJSON(json: any): DocumentUpdate {
+    return DocumentUpdateToJSONTyped(json, false);
+}
+
+export function DocumentUpdateToJSONTyped(value?: DocumentUpdate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'document_filename': value['documentFilename'],
+        'document_type': value['documentType'],
+        'container_reference': value['containerReference'],
+    };
+}
+