@indigina/myseko-api 0.0.31 → 0.0.32

package/package.json

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

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

@@ -394,6 +394,28 @@ interface DeliveriesToday {
     deliveringThisWeek?: number;
 }
 
+/**
+ * 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 ShipmentExceptionStats {
+    total?: number;
+    transitDelay?: number;
+    arrivalOverdue?: number;
+    deliveryOverdue?: number;
+    deliveryAppointmentOverdue?: number;
+    lateDelivery?: number;
+    consigneeUnreachable?: number;
+    failedDelivery?: number;
+    partialDelivery?: number;
+    incompletePOD?: number;
+}
+
 declare class DashboardService extends BaseService {
     protected httpClient: HttpClient;
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
@@ -441,6 +463,28 @@ declare class DashboardService extends BaseService {
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<HttpEvent<DeliveriesToday>>;
+    /**
+     * Get shipment exceptions statistics
+     * @endpoint get /myseko/dashboard/shipments-exceptions
+     * @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
+     */
+    getShipmentExceptionStats(observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<ShipmentExceptionStats>;
+    getShipmentExceptionStats(observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<ShipmentExceptionStats>>;
+    getShipmentExceptionStats(observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<ShipmentExceptionStats>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<DashboardService, [null, { optional: true; }, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DashboardService>;
 }
@@ -717,20 +761,30 @@ declare class DocumentService extends BaseService {
  * Do not edit the class manually.
  */
 /**
- * Type of exception
+ * Grid row returned to the client by the Exception Management endpoint.
  */
-declare const ExceptionType: {
-    readonly TransitDelay: "TransitDelay";
-    readonly ArrivalOverdue: "ArrivalOverdue";
-    readonly DeliveryOverdue: "DeliveryOverdue";
-    readonly DeliveryAppointmentOverdue: "DeliveryAppointmentOverdue";
-    readonly LateDelivery: "LateDelivery";
-    readonly ConsigneeUnreachable: "ConsigneeUnreachable";
-    readonly FailedDelivery: "FailedDelivery";
-    readonly PartialDelivery: "PartialDelivery";
-    readonly IncompletePod: "IncompletePOD";
-};
-type ExceptionType = typeof ExceptionType[keyof typeof ExceptionType];
+interface ExceptionManagementRow {
+    exceptionLogID: number;
+    ordOrderID: string;
+    number?: string | null;
+    status?: string | null;
+    serviceLevel?: string | null;
+    origin?: string | null;
+    destination?: string | null;
+    shipName?: string | null;
+    consName?: string | null;
+    exceptionType?: string | null;
+    exceptionStatus?: string | null;
+    criticality?: string | null;
+    plannedDate?: string | null;
+    latestProjectedDate?: string | null;
+    actualDate?: string | null;
+    daysOfDelay?: number | null;
+    reason?: string | null;
+    reportedBy?: string | null;
+    createdDateUtc: string;
+    lastUpdatedUtc: string;
+}
 
 /**
  * MySeko.API.Client
@@ -741,33 +795,11 @@ type ExceptionType = typeof ExceptionType[keyof typeof ExceptionType];
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- * Status of exception
- */
-declare const ExceptionStatus: {
-    readonly Active: "Active";
-    readonly Closed: "Closed";
-};
-type ExceptionStatus = typeof ExceptionStatus[keyof typeof ExceptionStatus];
 
-/**
- * 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.
- */
-/**
- * Criticality level of exception
- */
-declare const Criticality: {
-    readonly Low: "Low";
-    readonly Medium: "Medium";
-    readonly High: "High";
-};
-type Criticality = typeof Criticality[keyof typeof Criticality];
+interface ExceptionManagementList {
+    total: number;
+    data: Array<ExceptionManagementRow> | null;
+}
 
 /**
  * MySeko.API.Client
@@ -778,86 +810,79 @@ type Criticality = typeof Criticality[keyof typeof Criticality];
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
-interface Exception {
-    id: number;
+interface ShipmentException {
+    exceptionLogID: number;
+    ordOrderID: string;
+    eventType?: string | null;
     sourceType?: string | null;
-    sourceId?: string | null;
-    exceptionType?: ExceptionType;
-    status?: ExceptionStatus;
-    criticality?: Criticality;
+    exceptionType?: string | null;
+    status?: string | null;
+    criticality?: string | null;
     reason?: string | null;
-}
-declare namespace Exception {
-}
-
-/**
- * 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 Exceptions {
-    total: number;
-    data: Array<Exception>;
+    createdDateUtc: string;
+    lastUpdatedUtc: string;
 }
 
 declare class ExceptionsService extends BaseService {
     protected httpClient: HttpClient;
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
-     * Get a specific exception by ID
-     * @endpoint get /exceptions/{id}
-     * @param id
+     * Get all shipment exceptions (exception management grid)
+     * @endpoint get /myseko/shipments/exceptions
+     * @param $skip
+     * @param $top
+     * @param $filter
+     * @param $orderby
+     * @param $select
+     * @param $expand
      * @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
      */
-    getException(id: number, observe?: 'body', reportProgress?: boolean, options?: {
+    getShipmentExceptionManagement($skip?: number, $top?: number, $filter?: string, $orderby?: string, $select?: string, $expand?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<Exception>;
-    getException(id: number, observe?: 'response', reportProgress?: boolean, options?: {
+    }): Observable<ExceptionManagementList>;
+    getShipmentExceptionManagement($skip?: number, $top?: number, $filter?: string, $orderby?: string, $select?: string, $expand?: string, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpResponse<Exception>>;
-    getException(id: number, observe?: 'events', reportProgress?: boolean, options?: {
+    }): Observable<HttpResponse<ExceptionManagementList>>;
+    getShipmentExceptionManagement($skip?: number, $top?: number, $filter?: string, $orderby?: string, $select?: string, $expand?: string, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpEvent<Exception>>;
+    }): Observable<HttpEvent<ExceptionManagementList>>;
     /**
-     * Get all exceptions
-     * @endpoint get /exceptions
+     * Get exceptions for a specific shipment
+     * @endpoint get /myseko/shipments/{ordOrderID}/exceptions
+     * @param ordOrderID
      * @param $skip
      * @param $top
-     * @param $orderby
      * @param $filter
+     * @param $orderby
+     * @param $select
+     * @param $expand
      * @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
      */
-    getExceptions($skip?: number, $top?: number, $orderby?: string, $filter?: string, observe?: 'body', reportProgress?: boolean, options?: {
+    getShipmentExceptions(ordOrderID: string, $skip?: number, $top?: number, $filter?: string, $orderby?: string, $select?: string, $expand?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<Exceptions>;
-    getExceptions($skip?: number, $top?: number, $orderby?: string, $filter?: string, observe?: 'response', reportProgress?: boolean, options?: {
+    }): Observable<Array<ShipmentException>>;
+    getShipmentExceptions(ordOrderID: string, $skip?: number, $top?: number, $filter?: string, $orderby?: string, $select?: string, $expand?: string, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpResponse<Exceptions>>;
-    getExceptions($skip?: number, $top?: number, $orderby?: string, $filter?: string, observe?: 'events', reportProgress?: boolean, options?: {
+    }): Observable<HttpResponse<Array<ShipmentException>>>;
+    getShipmentExceptions(ordOrderID: string, $skip?: number, $top?: number, $filter?: string, $orderby?: string, $select?: string, $expand?: string, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
-    }): Observable<HttpEvent<Exceptions>>;
+    }): Observable<HttpEvent<Array<ShipmentException>>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ExceptionsService, [null, { optional: true; }, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ExceptionsService>;
 }
@@ -1679,6 +1704,7 @@ interface Shipment {
     etd?: string | null;
     deliveryRequiredBy?: string | null;
     isActive?: boolean | null;
+    isException?: boolean | null;
 }
 
 /**
@@ -2221,5 +2247,5 @@ declare class ApiModule {
 
 declare function provideApi(configOrBasePath: string | ConfigurationParameters): EnvironmentProviders;
 
-export { APIS, AddDocumentRequest, ApiModule, AuthService, BASE_PATH, COLLECTION_FORMATS, CalendarService, CalendarViewBy, Configuration, Criticality, DashboardService, DocumentCategoryType, DocumentService, Exception, ExceptionStatus, ExceptionType, ExceptionsService, 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, Exceptions, 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, ExceptionsService, 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, ExceptionManagementList, ExceptionManagementRow, IntlInnerPieceDetail, IntlOuterPieceDetail, IntlPackageDetails, IntlShipmentSummary, Issue, IssueLog, IssueLogEntry, Issues, ModelError, PackageDetails, Param, ParamLocation, ParamStyle, RegGroup, SekonaPackageDetails, SekonaPieceDetail, SekonaShipmentSummary, SettingValue, SettingView, Shipment, ShipmentCalendarDateGroup, ShipmentCalendarDates, ShipmentCalendarItem, ShipmentContainer, ShipmentException, ShipmentExceptionStats, ShipmentParty, ShipmentPurchaseOrder, ShipmentPurchaseOrderDetails, ShipmentRouting, ShipmentSummary, ShipmentTimeline, Shipments, StandardDataFormat, StandardDataType, StandardParamStyle, UpdateIssueRequest, User, UserAccount };