@indigina/dcm-api 0.0.116 → 0.0.118

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indigina/dcm-api",
-  "version": "0.0.116",
+  "version": "0.0.118",
   "description": "OpenAPI client for @indigina/dcm-api",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

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

@@ -2449,6 +2449,193 @@ declare class PermissionsService extends BaseService {
     static ɵprov: i0.ɵɵInjectableDeclaration<PermissionsService>;
 }
 
+/**
+ * Dcm.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 PoItemState: {
+    readonly Unbooked: "Unbooked";
+    readonly BookedAndAllocated: "BookedAndAllocated";
+    readonly Completed: "Completed";
+    readonly Deleted: "Deleted";
+    readonly IncompleteBooking: "IncompleteBooking";
+};
+type PoItemState = typeof PoItemState[keyof typeof PoItemState];
+
+/**
+ * Dcm.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 PoItemDetails {
+    id: string;
+    purchaseOrderId: string | null;
+    poNumber: string | null;
+    lineNo: number | null;
+    code: string;
+    state: PoItemState | null;
+    consigneeName: string | null;
+    supplierName: string | null;
+    description: string | null;
+    colour: string | null;
+    size: string | null;
+    estimatedCbm: number | null;
+    productCategory: string | null;
+    commodityCode: string | null;
+    ean: string | null;
+    season: string | null;
+    seasonYear: number | null;
+    attributes: string | null;
+    buyer: string | null;
+    departmentName: string | null;
+    countryOfOrigin: string | null;
+    dc: string | null;
+    dcCountryName: string | null;
+    currencyCode: string | null;
+    price: number | null;
+    shippingTerms: ShipmentTerm | null;
+    shippingTermLocation: string | null;
+    quantity: number;
+    bookedQuantity: number | null;
+    bookedPercentage: number;
+    shippedQuantity: number | null;
+    shippedPercentage: number;
+    createdDate: string | null;
+    bookingDueDate: string | null;
+    firstBookingSubmittedDate: string | null;
+    bookingDaysDifference: number | null;
+    exDate: string | null;
+    latestExDate: string | null;
+    deliveryDate: string | null;
+}
+declare namespace PoItemDetails {
+}
+
+/**
+ * Dcm.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 BookingStates: {
+    readonly Draft: "Draft";
+    readonly Confirmed: "Confirmed";
+    readonly CancellationRequested: "CancellationRequested";
+    readonly Cancelled: "Cancelled";
+    readonly DraftSi: "DraftSI";
+    readonly ConfirmedSi: "ConfirmedSI";
+};
+type BookingStates = typeof BookingStates[keyof typeof BookingStates];
+
+/**
+ * Dcm.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 RoutingLegType: {
+    readonly Flight1: "Flight1";
+    readonly Flight2: "Flight2";
+    readonly Flight3: "Flight3";
+    readonly LocalTransport: "LocalTransport";
+    readonly Main: "Main";
+    readonly OnForwarding: "OnForwarding";
+    readonly Other: "Other";
+    readonly PreCarriage: "PreCarriage";
+};
+type RoutingLegType = typeof RoutingLegType[keyof typeof RoutingLegType];
+
+/**
+ * Dcm.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 ShipmentRoutingSummaryLeg {
+    legNumber: number | null;
+    legType: RoutingLegType | null;
+    routingTransportMode: TransportMode | null;
+    originPortName: string | null;
+    destinationPortName: string | null;
+    departure: string | null;
+    arrival: string | null;
+}
+declare namespace ShipmentRoutingSummaryLeg {
+}
+
+/**
+ * Dcm.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 ShipmentRoutingSummary {
+    originPortName: string | null;
+    destinationPortName: string | null;
+    departure: string | null;
+    arrival: string | null;
+    shipmentTransportMode: TransportMode | null;
+    legs: Array<ShipmentRoutingSummaryLeg>;
+}
+declare namespace ShipmentRoutingSummary {
+}
+
+/**
+ * Dcm.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 PoItemShippingDetail {
+    id: string;
+    bookingId: string | null;
+    bookingReference: string | null;
+    bookingState: BookingStates | null;
+    shipmentId: string;
+    shipmentReference: string | null;
+    shipmentState: ShipmentState | null;
+    shippedQuantity: number;
+    bookedQuantity: number;
+    poQuantity: number;
+    transportMode: TransportMode | null;
+    shippedPoFulfillment: number | null;
+    approvalToleranceUnder: number;
+    approvalToleranceOver: number;
+    approvalToleranceFailValue: number | null;
+    approvalTolerancePass: boolean | null;
+    shipmentRouting: ShipmentRoutingSummary;
+}
+declare namespace PoItemShippingDetail {
+}
+
 /**
  * Dcm.API.Client
  *
@@ -2550,24 +2737,6 @@ interface PurchaseOrderProduct {
 declare namespace PurchaseOrderProduct {
 }
 
-/**
- * Dcm.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 PoItemState: {
-    readonly Unbooked: "Unbooked";
-    readonly BookedAndAllocated: "BookedAndAllocated";
-    readonly Completed: "Completed";
-    readonly Deleted: "Deleted";
-    readonly IncompleteBooking: "IncompleteBooking";
-};
-type PoItemState = typeof PoItemState[keyof typeof PoItemState];
-
 /**
  * Dcm.API.Client
  *
@@ -2691,6 +2860,52 @@ interface UnbookedProductCount {
 declare class PoItemsService extends BaseService {
     protected httpClient: HttpClient;
     constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
+    /**
+     * Getting po item details by id
+     * @endpoint get /poItems/{id}/details
+     * @param id
+     * @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
+     */
+    getPoItemDetails(id: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<PoItemDetails>;
+    getPoItemDetails(id: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<PoItemDetails>>;
+    getPoItemDetails(id: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<PoItemDetails>>;
+    /**
+     * Getting po item shipping details by id
+     * @endpoint get /poItems/{id}/shippingDetails
+     * @param id
+     * @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
+     */
+    getPoItemShippingDetails(id: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Array<PoItemShippingDetail>>;
+    getPoItemShippingDetails(id: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Array<PoItemShippingDetail>>>;
+    getPoItemShippingDetails(id: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Array<PoItemShippingDetail>>>;
     /**
      * Getting a po item summary  by id
      * @endpoint get /poItems/{id}/summary
@@ -3800,6 +4015,44 @@ interface ShipmentItems {
     data: Array<ShipmentItem>;
 }
 
+/**
+ * Dcm.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 LocationType: {
+    readonly OriginPort: "OriginPort";
+    readonly DestinationPort: "DestinationPort";
+    readonly TranshipmentPort: "TranshipmentPort";
+    readonly InlandPort: "InlandPort";
+};
+type LocationType = typeof LocationType[keyof typeof LocationType];
+
+/**
+ * Dcm.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 ShipmentLocation {
+    locationType: LocationType;
+    name: string | null;
+    code: string | null;
+    country: string | null;
+    latitude: number | null;
+    longitude: number | null;
+}
+declare namespace ShipmentLocation {
+}
+
 /**
  * Dcm.API.Client
  *
@@ -3888,27 +4141,6 @@ interface ShipmentProducts {
     data: Array<ShipmentProduct>;
 }
 
-/**
- * Dcm.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 RoutingLegType: {
-    readonly Flight1: "Flight1";
-    readonly Flight2: "Flight2";
-    readonly Flight3: "Flight3";
-    readonly LocalTransport: "LocalTransport";
-    readonly Main: "Main";
-    readonly OnForwarding: "OnForwarding";
-    readonly Other: "Other";
-    readonly PreCarriage: "PreCarriage";
-};
-type RoutingLegType = typeof RoutingLegType[keyof typeof RoutingLegType];
-
 /**
  * Dcm.API.Client
  *
@@ -4247,25 +4479,6 @@ declare namespace ShipmentTimelineItem {
  */
 type ShipmentTimelineInner = ApprovalShipmentTimelineItem | DeliveryShipmentTimelineItem | ShipmentTimelineItem | TransportationShipmentTimelineItem;
 
-/**
- * Dcm.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 BookingStates: {
-    readonly Draft: "Draft";
-    readonly Confirmed: "Confirmed";
-    readonly CancellationRequested: "CancellationRequested";
-    readonly Cancelled: "Cancelled";
-    readonly DraftSi: "DraftSI";
-    readonly ConfirmedSi: "ConfirmedSI";
-};
-type BookingStates = typeof BookingStates[keyof typeof BookingStates];
-
 /**
  * Dcm.API.Client
  *
@@ -4520,6 +4733,29 @@ declare class ShipmentsService extends BaseService {
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<HttpEvent<ShipmentItems>>;
+    /**
+     * Getting shipment map locations by shipmentId
+     * @endpoint get /shipments/{shipmentId}/locations
+     * @param shipmentId
+     * @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
+     */
+    getShipmentLocations(shipmentId: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<Array<ShipmentLocation>>;
+    getShipmentLocations(shipmentId: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<Array<ShipmentLocation>>>;
+    getShipmentLocations(shipmentId: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<Array<ShipmentLocation>>>;
     /**
      * Getting a shipment product totals
      * @endpoint get /shipments/{shipmentId}/productTotals
@@ -5373,5 +5609,5 @@ declare class ApiModule {
 
 declare function provideApi(configOrBasePath: string | ConfigurationParameters): EnvironmentProviders;
 
-export { APIS, AmendConfirmationTypes, ApiModule, ApprovalContainerInfo, ApprovalShipmentTimelineItem, ApprovalTypes, AuditLog, AuditLogsService, BASE_PATH, BookingStates, BookingTypes, BookingsService, COLLECTION_FORMATS, CompaniesService, ConfigService, Configuration, ContainerBookedState, ContainerDeliveryGridView, ContainerDeliveryItemGridView, ContainerDeliveryShipmentView, ContainerDeliverySummary, ContainerGridView, ContainerShipmentView, ContainerSize, ContainerType, ContainerView, ContainersService, CurrentUser, CwStates, DcClientDeliveryBooking, DcsService, DeliveryBookingContainerView, DeliveryBookingDcClientDeliveryBooking, DeliveryBookingDcsService, DeliveryBookingStates, DeliveryBookingsService, DeliveryShipmentTimelineItem, Document, DocumentType, DocumentsService, EmbedReportInfoModel, EntityState, HealthService, JourneySegmentType, Note, NoteCategory, NoteSourceType, NotesService, PendoService, PermissionsService, PoItemState, PoItemsService, PowerBiTenant, Product, ProductsShippingDetail, PurchaseOrderGridView, PurchaseOrderItem, PurchaseOrderProduct, PurchaseOrderState, PurchaseOrderSummary, PurchaseOrderView, PurchaseOrdersService, RecordTypes, ReportsService, RoutingLegType, SettingsService, Shipment, ShipmentAirRouting, ShipmentApproval, ShipmentApprovalType, ShipmentContainer, ShipmentItemSummary, ShipmentRoadRouting, ShipmentRouting, ShipmentSeaRouting, ShipmentState, ShipmentSummary, ShipmentTerm, ShipmentTimelineItem, ShipmentsService, SipmetItemsService, TimelineEventStates, TimelineEventTypes, TrackedVehicle, TransportMode, TransportationShipmentTimelineItem, UserCompanyType, UserService, VendorBooking, VendorBookingShipment, VendorBookingsService, WorkflowArtifacts, provideApi };
+export { APIS, AmendConfirmationTypes, ApiModule, ApprovalContainerInfo, ApprovalShipmentTimelineItem, ApprovalTypes, AuditLog, AuditLogsService, BASE_PATH, BookingStates, BookingTypes, BookingsService, COLLECTION_FORMATS, CompaniesService, ConfigService, Configuration, ContainerBookedState, ContainerDeliveryGridView, ContainerDeliveryItemGridView, ContainerDeliveryShipmentView, ContainerDeliverySummary, ContainerGridView, ContainerShipmentView, ContainerSize, ContainerType, ContainerView, ContainersService, CurrentUser, CwStates, DcClientDeliveryBooking, DcsService, DeliveryBookingContainerView, DeliveryBookingDcClientDeliveryBooking, DeliveryBookingDcsService, DeliveryBookingStates, DeliveryBookingsService, DeliveryShipmentTimelineItem, Document, DocumentType, DocumentsService, EmbedReportInfoModel, EntityState, HealthService, JourneySegmentType, LocationType, Note, NoteCategory, NoteSourceType, NotesService, PendoService, PermissionsService, PoItemDetails, PoItemShippingDetail, PoItemState, PoItemsService, PowerBiTenant, Product, ProductsShippingDetail, PurchaseOrderGridView, PurchaseOrderItem, PurchaseOrderProduct, PurchaseOrderState, PurchaseOrderSummary, PurchaseOrderView, PurchaseOrdersService, RecordTypes, ReportsService, RoutingLegType, SettingsService, Shipment, ShipmentAirRouting, ShipmentApproval, ShipmentApprovalType, ShipmentContainer, ShipmentItemSummary, ShipmentLocation, ShipmentRoadRouting, ShipmentRouting, ShipmentRoutingSummary, ShipmentRoutingSummaryLeg, ShipmentSeaRouting, ShipmentState, ShipmentSummary, ShipmentTerm, ShipmentTimelineItem, ShipmentsService, SipmetItemsService, TimelineEventStates, TimelineEventTypes, TrackedVehicle, TransportMode, TransportationShipmentTimelineItem, UserCompanyType, UserService, VendorBooking, VendorBookingShipment, VendorBookingsService, WorkflowArtifacts, provideApi };
 export type { AppConfig, ApprovalContainerRules, ApprovalItemRules, ApprovalRules, AuditLogs, BookingsCount, Column, CommandStatusResult, Companies, Company, ConfigurationParameters, Consignee, ContainerDeliveries, ContainerDeliveryItems, ContainerDeliverySummaries, ContainerItemView, ContainerItems, ContainerPoGridView, ContainerPos, Containers, ContainersCount, ContainersToDeliverCount, Country, CreateDcClientDeliveryBooking, DashboardReportGroup, DashboardReports, DataFormat, DataType, Dc, Dcs, DeliveryBookingDc, DeliveryBookingGridView, DeliveryBookingShipmentView, DeliveryBookings, DepartmentShipment, Documents, EmbedReport, EmbedTokenDto, EntityList, GeoCoordinate, ModelError, NoteView, Notes, Param, ParamLocation, ParamStyle, PaymentTerm, PendingMessagesCount, PoItemDc, PoItemSummary, PoItemTotals, Port, Products, ProductsShippingDetails, PurchaseOrderItems, PurchaseOrders, SetNewFeaturesVisibilityCommand, SettingValue, SettingView, ShipmentApprovals, ShipmentContainers, ShipmentGeoTracking, ShipmentItem, ShipmentItemSummaries, ShipmentItems, ShipmentProduct, ShipmentProductTotals, ShipmentProducts, ShipmentRoutingsInner, ShipmentTimelineInner, Shipments, ShipmentsApprovalCount, ShipmentsCount, ShipmentsInTransitCount, StandardDataFormat, StandardDataType, StandardParamStyle, SummaryDashboardReports, Supplier, TransportCarrier, TransportLocation, TransportPosition, UnbookedProductCount, User, UserApplication, UserApplications, UserCapabilitiesModel, UserPermissions, VendorBookings };