@indigina/myseko-api 0.0.26 → 0.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indigina/myseko-api",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "OpenAPI client for @indigina/myseko-api",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/types/indigina-myseko-api.d.ts

@@ -443,6 +443,268 @@ declare class DashboardService extends BaseService {
     static ɵprov: i0.ɵɵInjectableDeclaration<DashboardService>;
 }
 
+/**
+ * MySeko.API.Client
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+declare const DocumentCategoryType: {
+    readonly None: "None";
+    readonly Other: "Other";
+    readonly Sli: "SLI";
+    readonly TmsQuoteFinal: "TMSQuoteFinal";
+    readonly Bol: "BOL";
+    readonly Invoice: "Invoice";
+    readonly PackingList: "Packing_list";
+    readonly CertificateOfOrigin: "Certificate_of_Origin";
+    readonly FormA: "Form_A";
+    readonly T1: "T1";
+    readonly T2: "T2";
+    readonly DangerousGoods: "Dangerous_goods";
+    readonly ExportLicense: "Export_license";
+    readonly ImportLicense: "Import_license";
+    readonly ClearanceInvoice: "clearance_invoice";
+    readonly ShippingOrder: "Shipping_order";
+    readonly LoadingImage: "Loading_image";
+    readonly Bc: "BC";
+    readonly Lo: "LO";
+    readonly Sc: "SC";
+    readonly IsfReport: "ISF_report";
+    readonly BillingAdvice: "Billing_advice";
+    readonly Cph: "CPH";
+    readonly Cip: "CIP";
+    readonly Civ: "CIV";
+    readonly Coo: "COO";
+    readonly Dgf: "DGF";
+    readonly Fum: "FUM";
+    readonly Hbl: "HBL";
+    readonly Ins: "INS";
+    readonly Mdc: "MDC";
+    readonly Mcd: "MCD";
+    readonly Mfd: "MFD";
+    readonly Naf: "NAF";
+    readonly Obl: "OBL";
+    readonly Pkd: "PKD";
+    readonly Pkl: "PKL";
+    readonly Qrc: "QRC";
+    readonly Tlx: "TLX";
+    readonly Vgm: "VGM";
+    readonly Awb: "AWB";
+    readonly Ccc: "CCC";
+    readonly Cus: "CUS";
+    readonly Dor: "DOR";
+    readonly Epr: "EPR";
+    readonly Man: "MAN";
+    readonly Pod: "POD";
+    readonly Prl: "PRL";
+    readonly Wmr: "WMR";
+    readonly Ckl: "CKL";
+    readonly Pus: "PUS";
+    readonly Exinv: "EXINV";
+    readonly DeliveryImage: "Delivery_Image";
+    readonly Lbl: "LBL";
+    readonly Quote: "QUOTE";
+    readonly ProofOfPickup: "Proof_of_Pickup";
+    readonly PuSig: "PU_SIG";
+    readonly DelSig: "Del_SIG";
+};
+type DocumentCategoryType = typeof DocumentCategoryType[keyof typeof DocumentCategoryType];
+
+/**
+ * MySeko.API.Client
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface AddDocumentRequest {
+    fileName?: string | null;
+    fileContentType?: string | null;
+    description?: string | null;
+    fileBytes?: string | null;
+    categoryId?: DocumentCategoryType;
+}
+declare namespace AddDocumentRequest {
+}
+
+/**
+ * MySeko.API.Client
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface Document {
+    documentID: string;
+    createdBy?: string | null;
+    fileName?: string | null;
+    fileExt?: string | null;
+    fileMIMEType?: string | null;
+    fileSize: number;
+    docContent?: string | null;
+    category?: string | null;
+    created?: string | null;
+}
+
+/**
+ * MySeko.API.Client
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface DocumentCategory {
+    id: number;
+    enumValue?: string | null;
+    description?: string | null;
+}
+
+/**
+ * MySeko.API.Client
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface DocumentInfo {
+    documentID: string;
+    documentName?: string | null;
+    fileName?: string | null;
+    contentType?: string | null;
+    fileSize?: number | null;
+    category?: string | null;
+    createdBy?: string | null;
+    dateCreated?: string | null;
+}
+
+/**
+ * MySeko.API.Client
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface DocumentInfoList {
+    total: number;
+    data: Array<DocumentInfo> | null;
+}
+
+declare class DocumentService extends BaseService {
+    protected httpClient: HttpClient;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
+    /**
+     * Upload a document for a shipment
+     * @endpoint post /myseko/shipments/{ordOrderID}/documents
+     * @param ordOrderID
+     * @param addDocumentRequest
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     * @param options additional options
+     */
+    addShipmentDocument(ordOrderID: string, addDocumentRequest: AddDocumentRequest, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: undefined;
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<any>;
+    addShipmentDocument(ordOrderID: string, addDocumentRequest: AddDocumentRequest, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: undefined;
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<any>>;
+    addShipmentDocument(ordOrderID: string, addDocumentRequest: AddDocumentRequest, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: undefined;
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<any>>;
+    /**
+     * Get all document categories
+     * @endpoint get /myseko/documents/categories
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     * @param options additional options
+     */
+    getDocumentCategories(observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Array<DocumentCategory>>;
+    getDocumentCategories(observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Array<DocumentCategory>>>;
+    getDocumentCategories(observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Array<DocumentCategory>>>;
+    /**
+     * Get a specific document by ID
+     * @endpoint get /myseko/shipments/{ordOrderID}/documents/{documentID}
+     * @param ordOrderID
+     * @param documentID
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     * @param options additional options
+     */
+    getShipmentDocument(ordOrderID: string, documentID: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Document>;
+    getShipmentDocument(ordOrderID: string, documentID: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Document>>;
+    getShipmentDocument(ordOrderID: string, documentID: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Document>>;
+    /**
+     * Get documents for a shipment
+     * @endpoint get /myseko/shipments/{ordOrderID}/documents
+     * @param ordOrderID
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     * @param options additional options
+     */
+    getShipmentDocuments(ordOrderID: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<DocumentInfoList>;
+    getShipmentDocuments(ordOrderID: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<DocumentInfoList>>;
+    getShipmentDocuments(ordOrderID: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<DocumentInfoList>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DocumentService>;
+}
+
 declare class HealthService extends BaseService {
     protected httpClient: HttpClient;
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
@@ -1719,7 +1981,7 @@ declare class UsergroupService extends BaseService {
     static ɵprov: i0.ɵɵInjectableDeclaration<UsergroupService>;
 }
 
-declare const APIS: (typeof AuthService | typeof CalendarService | typeof DashboardService | typeof HealthService | typeof SettingsService | typeof ShipmentService | typeof UserService | typeof UsergroupService)[];
+declare const APIS: (typeof AuthService | typeof CalendarService | typeof DashboardService | typeof DocumentService | typeof HealthService | typeof SettingsService | typeof ShipmentService | typeof UserService | typeof UsergroupService)[];
 
 /**
  * MySeko.API.Client
@@ -1797,5 +2059,5 @@ declare class ApiModule {
 
 declare function provideApi(configOrBasePath: string | ConfigurationParameters): EnvironmentProviders;
 
-export { APIS, ApiModule, AuthService, BASE_PATH, COLLECTION_FORMATS, CalendarService, CalendarViewBy, Configuration, DashboardService, HealthService, SettingsService, ShipmentService, ShipmentStage, TimelineEvent, UserService, UsergroupService, provideApi };
-export type { ActiveShipment, Address, BaseShipmentSummary, ConfigurationParameters, Contact, CreateIssueRequest, CreateIssueResponse, DataFormat, DataType, DeliveriesToday, EntityList, IntlInnerPieceDetail, IntlOuterPieceDetail, IntlPackageDetails, IntlShipmentSummary, Issue, IssueLog, IssueLogEntry, Issues, ModelError, PackageDetails, Param, ParamLocation, ParamStyle, RegGroup, SekonaPackageDetails, SekonaPieceDetail, SekonaShipmentSummary, SettingValue, SettingView, Shipment, ShipmentCalendarDateGroup, ShipmentCalendarDates, ShipmentCalendarItem, ShipmentContainer, ShipmentParty, ShipmentPurchaseOrder, ShipmentPurchaseOrderDetails, ShipmentRouting, ShipmentSummary, ShipmentTimeline, Shipments, StandardDataFormat, StandardDataType, StandardParamStyle, UpdateIssueRequest, User, UserAccount };
+export { APIS, AddDocumentRequest, ApiModule, AuthService, BASE_PATH, COLLECTION_FORMATS, CalendarService, CalendarViewBy, Configuration, DashboardService, DocumentCategoryType, DocumentService, HealthService, SettingsService, ShipmentService, ShipmentStage, TimelineEvent, UserService, UsergroupService, provideApi };
+export type { ActiveShipment, Address, BaseShipmentSummary, ConfigurationParameters, Contact, CreateIssueRequest, CreateIssueResponse, DataFormat, DataType, DeliveriesToday, Document, DocumentCategory, DocumentInfo, DocumentInfoList, EntityList, IntlInnerPieceDetail, IntlOuterPieceDetail, IntlPackageDetails, IntlShipmentSummary, Issue, IssueLog, IssueLogEntry, Issues, ModelError, PackageDetails, Param, ParamLocation, ParamStyle, RegGroup, SekonaPackageDetails, SekonaPieceDetail, SekonaShipmentSummary, SettingValue, SettingView, Shipment, ShipmentCalendarDateGroup, ShipmentCalendarDates, ShipmentCalendarItem, ShipmentContainer, ShipmentParty, ShipmentPurchaseOrder, ShipmentPurchaseOrderDetails, ShipmentRouting, ShipmentSummary, ShipmentTimeline, Shipments, StandardDataFormat, StandardDataType, StandardParamStyle, UpdateIssueRequest, User, UserAccount };